WebDialer SOAP "Hello World"
To get started with using WebDialer SOAP, let’s look at the makeCallSoap API request.
This API request consists of three mandatory parameters: credential, destination, and profile. The credentials consist of the calling party’s userID and password. The destination is the number the party is attempting to call. The profile is the calling party’s phone or line information.
To invoke the makeCallSoap operation, the application will send the SOAP request to the following URL: https://<CUCM_Server>/webdialer/services/WebdialerSoapService70 where <CUCM_Server> specifies the IP address of the Cisco Unified CM node where WebDialer is configured.
Below is an example of the makeCallSoap request and response:
Request
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
<soapenv:Envelope
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:WD70"><soapenv:Header/><soapenv:Body><in0
xsi:type="urn:Credential"><userID
xsi:type="xsd:string">Bob</userID><password xsi:type="xsd:string">55555</password></in0>
<in2
xsi:type="urn:UserProfile"><user
xsi:type="xsd:string">Bob</user><deviceName xsi:type="xsd:string">SEP123456789</deviceName><lineNumber xsi:type="xsd:string">1234</lineNumber><supportEM xsi:type="xsd:boolean">false</supportEM><locale
xsi:type="xsd:string">English</locale><dontAutoClose xsi:type="xsd:boolean">false</dontAutoClose><dontShowCallConf
xsi:type="xsd:boolean">true</dontShowCallConf></in2>
</urn:makeCallSoap></soapenv:Body></soapenv:Envelope>
|
Response
|
1
2
3
4
5
6
7
8
9
10
11
12
|
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><ns1:makeCallSoapResponse
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:ns1="urn:WD70"><makeCallSoapReturn
href="#id0"/></ns1:makeCallSoapResponse><multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xsi:type="ns2:CallResponse" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:ns2="urn:WD70"><responseCode href="#id1"/>
<responseDescription
xsi:type="xsd:string">Success</responseDescription></multiRef><multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiRef></soapenv:Body></soapenv:Envelope>
|
WebDialer HTML "Hello World"
To get started with using WebDialer HTML, let’s look at the makeCall API request.
This API request consists of one mandatory parameter: destination. The destination is the number the party is attempting to call.
To invoke the makeCall operation, enter the following URL in your browser: https://<CUCM_Server>/webdialer/Webdialer where <CUCM_Server> specifies the IP address of the Cisco Unified CM node where WebDialer is configured. You will then be prompted to login with your end user credentials.
For this example we will use the existing interface in Cisco Unified CM to make this request. Below is an example of the makeCall request and response:
Request
Enter the destination number and click Dial.
Response
You will now see a message indicating a success or error.
