CallSetup command

The CallSetup command simply sets up a call between two telephone numbers. These telephone numbers have to be given as parameters to run the command properly.

Request parameters

Parameter name Example value Description Mandatory
Callee 101 PHone number of the callee. yes
Caller 102 Phone number of the caller, which will be displayed on the called side. yes
ErrorUrl http://yourapp.com/error.php This URL will be requested if any errors occur during the call. no
Username admin The username of the account. The username and password parameters are used to authenticate the user. yes
Password abc123 Specifies the password. The username and password parameters are used to authenticate the user. yes

Response parameters

Parameter name Example value Description Mandatory
Code 200 Returns the status code of the response. yes
Message Command successfully executed Returns the description of the response code. yes
NotificationName CallConnected Name of the notification request type. no

OzML example

The following example will set up a call between 101 and 102 by using the CallSetup command. 

<Response>
    <CallSetup Caller='101' Callee='102'/>
</Response>

Example request and response

URL request

http://127.0.0.1:9509/api?command=CallSetup&Caller=101&Callee=103&Username=HTTP_User_1&Password=qwe123

Response

<?xml version="1.0"?>
<Response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Code>200</Code>
  <Message>Command successfully executed</Message>
</Response>

More information