云通訊平臺為開發者提供了呼叫狀態查詢接口,以便開發者通過此REST API對當前一路通話的狀態進行實時查詢。
REST API:呼叫狀態查詢
通過HTTPS POST方式提交請求,云通訊平臺收到請求后,返回操作結果。
1、請求
1.1 請求地址
/{SoftVersion}/Accounts/{accountSid}/ivr/call
1.2 請求包頭
請參閱:Rest 介紹》統一請求包頭,使用主賬戶進行驗證
1.3 請求包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
Appid | String | 必選 | 應用Id |
callid | String | 必選 | 呼叫Id |
action | String | 可選 | 查詢結果通知的回調url地址 |
1.4 XML請求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/call?sig=155EAA68C5DFB6B762A42D88F406ABCD&callid= 13421304281638380001000000000001 HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version="1.0" encoding="UTF-8"?> <Request> <Appid>ff8081813fc747ee013fc12345678</Appid> <QueryCallState callid ="13421304281638380001000000000001"/> </Request>
1.5 JSON請求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/call?sig=155EAA68C5DFB6B762A42D88F406ABCD&callid= 13421304281638380001000000000001 HTTP/1.1 Accept:application/json; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= {"Appid":"ff8081813fc747ee013fc12345678","QueryCallState":{"callid":"14092410343310310001000400000047"}}
2、響應
2.1 響應包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
statusCode | String | 必選 | 請求狀態碼,取值000000(成功),可參考Rest 錯誤代碼。 |
callSid | String | 必選 | 呼叫Id |
state | String | 必選 | 呼叫狀態 0:通話結束, 1:通話中 |
2.2 XML請求示例
HTTP/1.1 200 OK Content-Length:586 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> <callSid>029340934823840303948889933</callSid> <state>0</state> </Response>
2.3 JSON請求示例
HTTP/1.1 200 OK Content-Length:586 {"statusCode":"000000","state":"1","callSid":"14092410343310310001000400000047"}
文檔更新時間:2016年8月11日