取消回拨
取消回拨是云通讯平台提供给客户用于任意时间段结束双向回拨呼叫的能力接口。通过此REST API可以实现对误操作外呼的取消功能。
REST API:取消回拨
通过HTTPS POST方式提交请求，云通讯平台收到请求后，取消双向回拨通话。
1、请求
1.1 请求地址
/{SoftVersion}/SubAccounts/{subAccountSid}/Calls/CallCancel
1.2 请求包头
请参阅：Rest 介绍》统一请求包头，使用子账户鉴权
1.3 请求包体
| 属性 | 类型 | 约束 | 说明 |
|---|---|---|---|
| appId | String | 必选 | 云通讯平台的应用ID，通过云通讯的官网登录后创建应用产生的唯一标识。 |
| callSid | String | 必选 | 一个由32个字符组成的通话唯一标识符，通过云通讯双向回拨的接口请求成功后产生。 |
| type | String | 可选 | 0： 任意时间都可以挂断电话；1 ：被叫应答前可以挂断电话，其他时段返回错误代码；2： 主叫应答前可以挂断电话，其他时段返回错误代码；默认值为0。 |
1.4 XML请求示例
POST /2013-12-26/SubAccounts/abcdefghijklmnopqrstuvwxyz123456/Calls/CallCancel?sig=3504A2F48AB6328BF33AC70302C4A0C0 HTTP/1.1 Host:192.168.0.1:8883 content-length: 139 Accept:application/xml; Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTAABCD= <?xml version='1.0' encoding='utf-8'?> <CallCancel> <appId>ff0vc9u0shfsdof89sfshfdsfudos</appId> <callSid>129089w8e9jd9989232313812345678</callSid> <type>2</type> </CallCancel>
1.5 JSON请求示例
POST /2013-12-26/SubAccounts/abcdefghijklmnopqrstuvwxyz123456/Calls/CallCancel?sig=3504A2F48AB6328BF33AC70302C4A0C0 HTTP/1.1
Host:192.168.0.1:8883
content-length: 139
Accept:application/json;
Content-Type:application/json;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTAABCD=
{"appId":"ff0vc9u0shfsdof89sfshfdsfudos","callSid":"129089w8e9jd9989232313812345678","type":"2"}
2、响应
2.1 响应包体
| 属性 | 类型 | 约束 | 说明 |
|---|---|---|---|
| statusCode | String | 必选 | 请求状态码，000000为成功，其他错误码则为失败，错误码可参考Rest 错误代码 |
2.2 XML请求示例
HTTP/1.1 200 OK Content-Length: 574 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> </Response>
2.3 JSON请求示例
HTTP/1.1 200 OK
Content-Length: 574
{"statusCode":"000000"}
文档更新时间：2016年8月11日