The Subscribe method allows you to monitor extension for events such as:
...
The method will return as soon as any events occurs on one of the target extensions or when the timeout occurs.
Note:
To guarantee that you don't miss any events between calls to subscribe you use the 'seq' data returned by a call to subscribe as the value of lastSequenceNumber in the next call to subscribe.
...
| Code Block | ||
|---|---|---|
| ||
https://<server host>/servicemanager/rest/CallManagementAPI/subscribe |
HTTP Method: POST
Content Type: application/x-www-form-urlencoded
Parameters (case sensitive):
...
Sample response when two calls are received from 400 at extension 410. The first call arrives and the API returns, then the second call arrives and the API returns the information about the second call only. Both of the calls are rejected simultaneously and the final response contains a Data resource with a collection of Extension resources (e.g. 400 in the sampe below). Each Extension resource contains an array of CallData resources. The associated uniqueCallId is used to answer a call (see below).
| Code Block | ||
|---|---|---|
| ||
https://<server hostname>/servicemanager/rest/CallManagementAPI/subscribe?timeOut=60& apiKey=f863246a-973e-11e6-8784-08002718f5b5&lastSequenceNumber=28&instanceId=1&exten=400,410,410 |
...
To answer the first call listed in the sample above use the uniqueCallId and pass it in as the uniqueId to the answer method:
| Code Block | ||
|---|---|---|
| ||
answer?answerString=...&apiKey=....&exten=101&uniqueId=1403148776.566 |
...
| Code Block | ||
|---|---|---|
| ||
{"Data":{
"410": [{"CallData":{
"canAnswer":false,
"callerId":"400",
"uniqueCallId":"1412749510.488",
"callStartTime":"2014/10/08 17:25:18",
"isQueueCall":false,
"isClickToDialCall":false,
"inbound":true,
"status":"Hungup"},"CallID":2,"Code":0}],
"400": [{"CallData":{
"canAnswer":false,
"callerId":"410",
"uniqueCallId":"1412749517.489",
"callStartTime":"2014/10/08 17:25:18",
"isQueueCall":false,
"isClickToDialCall":false,
"inbound":false,
"status":"Hungup"},"CallID":1,"Code":0}]},"seq":10,"Code":0} |
Call 2: Extension 400 dials extension 410, 410 is busy.
| Code Block | ||
|---|---|---|
| ||
https://<server hostname>/servicemanager/rest/CallManagementAPI/subscribe?timeOut=60& apiKey=f863246a-973e-11e6-8784-08002718f5b5&lastSequenceNumber=10&instanceId=1&exten=400,410,410 |
...