Jump to: navigation, search

ClearCall

This operation is part of the Voice API section of the Web Services API.

Overview

Ends the conference call for all parties. This can be performed by any agent participating the conference.

Request URL /api/v2/me/calls/{id}
HTTP method POST
Required features api-voice

Parameters

Parameter Value
operationName ClearCall

Sample

Request

POST api/v2/me/calls/128ff83e-b474-47e6-b64e-0e63cd707004
{
  "operationName": "ClearCall"
}

HTTP response

{  
   "statusCode":0
}

CometD notification

{  
   "notificationType":"StatusChange",
   "call":{  
      "id":"00BVD9GLQGB8P27CNC4GK2LAES00000A",
      "state":"Released",
      "callUuid":"00BVD9GLQGB8P27CNC4GK2LAES00000A",
      "connId":"007102786d53400a",
      "deviceUri":"http://127.0.0.1:8080/api/v2/devices/128ff83e-b474-47e6-b64e-0e63cd707004",
      "participants":[  
         {  
            "e164Number":"",
            "formattedPhoneNumber":"15002",
            "phoneNumber":"15002",
            "digits":"15002"
         },
         {  
            "e164Number":"",
            "formattedPhoneNumber":"15001",
            "phoneNumber":"15001",
            "digits":"15001"
         }
      ],
      "dnis":"15001",
      "callType":"Internal",
      "capabilities":[  
 
      ],
      "userData":{  
         "FirstConferencePartyDN":"15000"
      },
      "duration":"68",
      "mute":"Off",
      "uri":"http://127.0.0.1:8080/api/v2/me/calls/00BVD9GLQGB8P27CNC4GK2LAES00000A",
      "path":"/calls/00BVD9GLQGB8P27CNC4GK2LAES00000A"
   },
   "phoneNumber":"15000",
   "extensions":{  
      "BusinessCall":1
   },
   "messageType":"CallStateChangeMessage"
}

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on March 28, 2016, at 05:27.