Skip to main content

Click-To-Call Hangup

The Click-To-Call hangup API is used to disconnect the call, between TeleCMI softphone and phone number. After getting the user login token and ongoing call cmiuuid, make a POST request to the below base URL to hangup the Click-To-Call.

Base URL​

Send your POST method request with valid parameters, to the following base URL.

https://rest.telecmi.com/v2/c2c/hangup

Required Parameters​

These are the required POST method parameters with description

Parameter NameTypeDescription
tokenstringYour user token
cmiuuidstringA unique identifier of Leg A call
Note
All the above parameters ares mandatory.

Sample JSON Request​

Below is the following sample JSON POST method request

{
"token": "xxxx-xxxx-xxxx-xxxx",
"cmiuuid": "ccd826f9-67a4-4467-acfb-a53093ff5c9d"
}

Sample Response​

If the provided information is valid, your web server will get a sample response from TeleCMI Platform as given below

{
"code": 200,
"msg": "call ended"
}

Properties​

These are the list of properties and its description

PropertyTypeDescription
msgstringThe call ended

HTTP status codes​

TeleCMI API platform represents the following status code to identity the errors.

Status codeStatus TypeDescription
200OKWe received the request
404ErrorFailed to authenticate token, cmiuuid not found