Connect Call API


Connect Call API

De Connect Call API stelt ontwikkelaars in staat om gesprekken rechtstreeks vanuit een browser of eigen applicatie op te zetten.

De standaard URL voor deze API is:
https://portal.business-isp.nl/api/

Wanneer er een custom API voor u is aangemaakt dan dient u deze te gebruiken.

Opzetten van een login sessie en (eerste) gesprek

Hierbij wordt het eerste gesprek direct opgezet en wordt er een GUID afgegeven voor deze sessie. Voor alle URL variabelen zie tabel: Parameters onder aan deze pagina.

Request:

connectcall.aspx?login=xx&password=xx&dest=xx&source=xx&type=x

Response:
<response>
   <code>103</code>
   <message>5ae2a5rw47w</message>
</response>

De GUID kan gebruikt worden voor verschillende acties:
- Beindigen van een gesprek.
- Opzetten van een nieuw gesprek binnen dezelfde sessie.
- Beindigen van de login sessie.
- Ophalen van de status.

Voor alle beschikbare commando's zie tabel: Commands onder aan deze pagina.

Beindigen van een gesprek:

Het gesprek kan worden beëindigd, de login sessie blijft nog actief en dient separaat te worden beindigd.

Request:
connectcall.aspx?guid=5ae2a5rw47w&cmd=hangUp

Response:

<response>
   <code>100</code>
   <message>OK</message>
</response>

Beëindigd altijd het gesprek voor er een nieuw gesprek opgezet wordt.
Voor response codes zie tabel: Response codes onder aan deze pagina.

Opzetten nieuw gesprek binnen dezelfde sessie:

Zolang de login sessie nog actief is, kan de GUID gebruikt worden voor het opzetten van nieuwe gesprekken.

Request:
connectcall.aspx?guid=5ae2a5rw47w&cmd=connect&source=xx&dest=xx&type=x

Response:
<response>
   <code>100</code>
   <message>OK</message>
</response>

Voor response codes zie tabel: Response codes onder aan deze pagina.

Beindigen van de login sessie:

Commando om de gehele login sessie te beindigen en uit te loggen van de server. Hierna zal er een nieuwe login sessie opgezet te worden om nieuwe gesprekken te starten.

Request:
connectcall.aspx?guid=5ae2a5rw47w&cmd=end

Response:
<response>
   <code>100</code>
   <message>OK</message>
</response>

Voor response codes zie tabel: Response codes onder aan deze pagina.

Ophalen van status:

De status kan worden opgehaald met bijvoorbeeld een frequentie van 1 seconde.

Request:
connectcall.aspx?guid=5ae2a5rw47w&cmd=getStatus

Response:
<response>
   <code>27</code>
   <message>Source is alerting</message>
</response>

Voor overige statussen zie onderstaande tabel Status Codes.

Status codes

Code     Desciption

3             Unknown

4             Hang Up

5             Account State

7             Call ended because of insufficient funds

9             Clients connected

10           Busy

11           No answer

12           Call has been rejected

16           Insufficient funds

24           Wrong source number

25           Wrong destination number

26           Destination is alerting
27          
Source is alerting

28           Source number connected

29           Destination number connected              

30           Destination number ended the call

31           Source number ended the call

32           Source number has insufficient funds

33           Destination number has insufficient funds



Commands

Name                   Description

getStatus            The actual status.

hangUp                End connection

connect               Connect again. If client has already received GUID

end                       Removes client session (GUID) from server.

 

 

Parameters

Name                   Desciption

login                    Account username

password           Account password

dest                     Destination leg number

source                 Source leg number

type                     Connection type: 1 - Source first, 2 - Both simultaneously

cmd                      Commando s

guid                      GUID - Session ID, unique for each client session

 

 

Response codes

Name                   Message

100                        OK

101                        Failed

102                        AutorizationFailed

103                        LoginSucess

104                        WrongParameters

105                        NoChanges

 

 

 

 

 

Laatst bijgewerkt:
10-05-2016 13:10
Auteur:
Guido Martens
Revisie:
1.6
Gemiddelde beoordeling:0 (0 Stemmen)

U kunt deze vraag niet becommentariëren

Chuck Norris has counted to infinity. Twice.