# 终止呼叫场景API - TerminateCall #### 典型场景 SP通过请求响应或者呼叫状态和话单通知API获取到sessionid后，若需要终止呼叫，可调用"终止呼叫场景API"。 #### 接口功能 开发者在开发应用时，通过调用终止呼叫场景API，可以实现终止呼叫的功能。 如果业务已经执行完毕，终止呼叫API会返回失败。 图1终止呼叫体验流程 ![](https://support.huaweicloud.com/api-VoiceCall/figure/zh-cn_image_0000001261601052.png "点击放大") 终止呼叫体验描述： 1. 用户A、B正在通话，SP调用终止呼叫API。 2. 语音通话平台将用户A挂机。 3. 语音通话平台将用户B挂机。 4. 用户A、B通话终止。 #### 使用说明 - 前提条件 1. 已通过"[应用管理](https://console.huaweicloud.com/voicecall/#/appManagement)"页面获取应用的APP_Key，APP_Secret和APP接入地址。 2. 已获取sessionid。 - 注意事项 无。 - 使用限制 无。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限管理](https://support.huaweicloud.com/productdesc-VoiceCall/rtc_03_0011.html)。 #### URI POST /rest/httpsessions/callStop/v2.0 #### 请求参数 表1请求Headers参数说明 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | Content-Type | 是 | String | **参数解释：** 消息体的类型（格式）。 **约束限制：** 不涉及。 **取值范围：** 固定填写为application/json;charset=UTF-8。 **默认取值：** 不涉及。 | | Authorization | 是 | String | 固定填写为AKSK realm="SDP",profile="UsernameToken",type="Appkey"。 | | X-AKSK | 是 | String | 取值为UsernameToken Username="APP_Key的值", PasswordDigest="PasswordDigest的值", Nonce="随机数", Created="随机数生成时间"。 - PasswordDigest：根据PasswordDigest = Base64 (HMAC-SHA256 (Password，Nonce + Created))生成。其中，Password为APP_Secret的值。Nonce、Created、Password直接进行字符串拼接即可，无需包含+号和空格。 - Nonce：客户发送请求时生成的一个随机数，长度为1\~128位，可包含数字和大小写字母。例如：66C92B11FF8A425FB8D4CCFE0ED9ED1F。 - Created：随机数生成时间。采用UTC+8(北京时间)格式，例如：2018-02-12T15:30:20Z。不同编程语言中将UTC时间戳转换为普通时间时使用的格式不同，部分语言可参考[表2]。 | 表2不同编程语言的时间格式 | 编程语言 | 时间格式 | |:---|:---| | Java | yyyy-MM-dd'T'HH:mm:ss'Z' | | PHP | Y-m-d\\TH:i:s\\Z | | Python | %Y-%m-%dT%H:%M:%SZ | | C# | yyyy-MM-ddTHH:mm:ssZ | | Node.js | toISOString().replace(/.\[0-9\]+\\Z/, 'Z') 注：Node.js中，使用toISOString()转换后的时间格式去除毫秒后即为本接口要求的时间格式。 | 表3请求Body参数说明 | 参数名称 | 是否必选 | 参数类型 | 默认值 | 说明 | |:---|:---|:---|:---|:---| | sessionid | 是 | String(1-256) | 无 | 该参数用于唯一标识一路通话。 | | signal | 是 | String(1-128) | 无 | 该参数值指定终止呼叫的方式，目前signal的取值仅固定为"call_stop"，表示主被叫都拆线。 | #### 响应参数 表4响应消息参数说明 | 参数名称 | 是否必选 | 参数类型 | 默认值 | 说明 | |:---|:---|:---|:---|:---| | resultcode | 是 | String(1-32) | 无 | 请求返回的结果码。 | | resultdesc | 是 | String(1-128) | 无 | 请求返回的结果描述。 | #### 结果码 请根据以下结果码进行调测，如果有疑问，可联系管理员进行确认。 表5结果码说明 | 响应码 | 结果码 | 英文描述 | 中文描述 | 处理方法 | |:---|:---|:---|:---|:---| | 200 | 0 | Success. | 成功。 | 无需处理。 | | 400 | 1023006 | Authorization not contained in the HTTP header. | 鉴权失败，请检查鉴权请求正确性。 | 请检查消息头中是否携带了Authorization，PasswordDigest字段填写是否正确，携带的app_key填写是否正确，且生成随机数的时间与发送请求时的本地时间不能相差太大。 | | 400 | 1023007 | realm not contained in Authorization. | Authorization字段中未找到realm属性。 | 请检查Authorization字段中的是否携带了realm属性。 | | 400 | 1023008 | profile not contained in Authorization. | Authorization字段中未找到profile属性。 | 请检查Authorization字段中的是否携带了profile属性。 | | 400 | 1023009 | The value of realm in Authorization must be SDP. | Authorization中realm属性值应该为"SDP"。 | 请检查Authorization字段中的realm属性值是否为"SDP"。 | | 400 | 1023010 | The value of profile in Authorization must be UsernameToken. | Authorization中profile属性值应该为"UsernameToken"。 | 请检查Authorization字段中的profile属性值是否为"UsernameToken"。 | | 400 | 1023011 | The value of type in Authorization must be app_key. | Authorization中type属性值应该为"Appkey"。 | 请检查Authorization字段中的type属性值是否为"Appkey"。 | | 400 | 1023012 | type not contained in Authorization. | Authorization字段中未找到type属性。 | 请检查Authorization字段中是否携带了type属性。 | | 400 | 1023033 | HTTP header not found X-AKSK field. | HTTP头未找到X-AKSK字段。 | 请检查HTTP消息头中是否携带了X-AKSK字段。 | | 400 | 1023034 | UserName not contained in X-AKSK. | X-AKSK字段中未找到UserName属性。 | 请检查X-AKSK字段中的是否携带了Username属性。 | | 400 | 1023035 | Nonce not contained in X-AKSK. | X-AKSK字段中未找到Nonce属性。 | 请检查X-AKSK字段中的是否携带了Nonce属性。 | | 400 | 1023036 | Created not contained in X-AKSK. | X-AKSK字段中未找到Created属性。 | 请检查X-AKSK字段中的是否携带了Created属性。 | | 400 | 1023037 | PasswordDigest not contained in X-AKSK. | X-AKSK字段中未找到PasswordDigest属性。 | 请检查X-AKSK字段中的是否携带了PasswordDigest属性。 | | 400 | 1023038 | UsernameToken not contained in X-AKSK. | X-AKSK中没有携带UsernameToken。 | 请检查X-AKSK字段中的是否携带了UsernameToken属性。 | | 401 | 1010010 | Invalid digest. | PasswordDigest校验失败。 | 请检查PasswordDigest字段填写是否正确。 | | 401 | 1010013 | Time out limit. | 时间超出限制。 | 请确认X-AKSK鉴权时，生成随机数的时间与发送请求时的本地时间不能相差太大（具体差值请与管理员确认）。 | | 403 | 1010002 | Invalid request. | 非法请求。 | 检查请求携带的参数格式是否都合法。 | | 403 | 1010003 | Invalid app_key. | 无效的app_key。 | 检查请求携带的app_key是否填写正确，app_key从[应用管理](https://console.huaweicloud.com/voicecall/#/appManagement)页面获取，若填写正确，请在[应用管理](https://console.huaweicloud.com/voicecall/#/appManagement)页面检查请求携带的app_key所属应用状态是否正常。 | | 403 | 1010006 | Invalid Rest API. | 无效的Rest API。 | 检查请求方法填写是否正确。 | | 403 | 1010008 | The status of the app_key is unavailable. | app_key被暂停使用。 | 请在[应用管理](https://console.huaweicloud.com/voicecall/#/appManagement)页面检查请求携带的app_key所属应用状态是否正常。 | | 403 | 1010009 | No more APIs can be invoked. | API达到调用上限。 | 请稍等一分钟后再试，并联系管理员申请更高的应用使用配额。 | | 403 | 1010010 | The flow control upper limit is reached on the platform. | 平台达到系统流控上限。 | 请稍等一分钟后再试。 | | 403 | 1010011 | The app is not allowed to access a commercial address. | APP没有访问商用地址的权限。 | 请在[应用管理](https://console.huaweicloud.com/voicecall/#/appManagement)页面检查请求携带的app_key所属应用状态是否正常。 | | 403 | 1020166 | The app client ip is not in ip white list. | 请求发送方app IP不在白名单列表中。 | 联系管理员检查IP白名单是否配置正确。 | | 403 | 1020176 | Authentication failed, try again later | 鉴权失败，稍后重试 | IP因鉴权失败次数过多导致被拉黑，请30分钟后重试，或联系管理员放通该IP。 | | 500 | 1010001 | Internal system error. | 系统错误。 | 请联系管理员处理。 | | 500 | 1020001 | Parameter error. | 参数错误。 | 检查请求携带的参数格式是否都合法。 | | 500 | 1020002 | Internal error. | 内部错误。 | 请联系管理员处理。 | | 500 | 1020150 | The app_key is invalid. | appKey无效。 | 检查请求携带的app_key是否填写正确，app_key从[应用管理](https://console.huaweicloud.com/voicecall/#/appManagement)页面获取，若填写正确，请在[应用管理](https://console.huaweicloud.com/voicecall/#/appManagement)页面检查请求携带的app_key所属应用状态是否正常。 | | 500 | 1020152 | Invalid sessionid. | sessionid无效。 | 检查请求携带的sessionid是否填写正确。语音回呼的sessionid是调用"语音回呼场景API"的成功响应消息的sessionid参数值，也可通过呼叫状态和话单通知API获取。 | | 500 | 1023001 | Internal error. | 内部错误。 | 请联系管理员处理。 | | 500 | 1023002 | Response timeout. | 响应超时。 | 重新发送一次请求，若依然返回响应超时，请联系管理员处理。 | #### 接口示例 - 请求示例 ``` POST /rest/httpsessions/callStop/v2.0 HTTP/1.1 content-type: application/json;charset=UTF-8 authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey" x-aksk: UsernameToken Username="ZRBRz4bAXoFgEH7o4Ew308eXc1RA",PasswordDigest="****",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z" content-length:xx { "sessionid":"1200_366_0_20161228102743@callenabler.home1.com", "signal":"call_stop" } ``` - 响应示例 ``` HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 { "resultcode":"0", "resultdesc":"Success" } ```