Met de Klik en Bel module kan geautomatiseerd een gesprek opgezet worden. Wij bieden Klik en Bel aan in de vorm van een json api. Je kunt hier zelf iets tegen aanbouwen of gebruik maken van onze firefox plugin.

Algemene werking

De api is te vinden op https://client.voipgrid.nl/api/. Om met de api te kunne praten dienen de juiste HTTP-requests gebruikt te worden. Objecten opvragen gaat via de GET method, nieuwe toevoegen gaat met een POST, updaten met PUT en verwijderen met DELETE. Let erop de juiste Content-type en Accept headers mee te sturen ('Content-type': 'application/json', 'Accept': 'application/json'). Later komen wellicht ook andere content-types beschikbaar binnen de api.

Activatie

Binnen het clientsysteem kun je onder het kopje 'Web links' het Klik en Bel icoontje vinden. Nadat je hierop hebt geklikt kun je Klik en Bel activeren waarna de te gebruiken hash verschijnt. Voor de Klik en Bel functionaliteit is slechts 1 hash noodzakelijk.

Api methodes

/api/clicktodial/ (POST)

Hiermee kun je het gesprek starten. De volgende parameters zijn van belang:

• hash: jouw hash uit het clientsysteem
• a_number: het gewenste telefoonnummer of extensie van de beller (vaak een extensie uit je account)
• b_number: het te bellen telefoonnummer of extensie
• a_cli (niet verplicht): kan drie waarden bevatten: "a_number", "b_number" of "suppressed". Deze waarde geeft aan welk CLI naar de A-zijde van het gesprek wordt meegestuurd
• b_cli (niet verplicht): De mee te sturen CLI naar de B-zijde van het gesprek. Het meegegeven nummer moet vallen binnen de range van de bijbehorende client.
• auto_answer (niet verplicht, true/false, standaard false): Bij true wordt bij de A-zijde meteen opgenomen. Dit is nuttig in het geval van een aangesloten koptelefoon.

Wanneer de functie met succes is uitgevoerd wordt het clicktodial call object geretourneerd.

Voorbeeld

https://client.voipgrid.nl/api/clicktodial/ met de volgende body: {"hash":"7a69fc3f2572342334f4058adsffffb96b12e460", "a_number": "201", "b_number": "0508009900", "b_cli":"0507009999", "auto_answer": true}

/api/clicktodial/3asdf804...../ (GET)

Hiermee kan de status van een clicktodial call opgevraagd worden. De volgende parameter is vereist:

• call_id

Wanneer het call_id bestaat wordt de status geretourneerd. De volgende succesvolle statussen zijn mogelijk:

• dialing_a
• dialing_b
• connected
• disconnected

De volgende statussen geven een fout aan:

• failed_a
• failed_b

Voorbeeld

https://client.voipgrid.nl/api/clicktodial/3asdf804d8d225db16a343347e8b4c3ce355c/