云通訊平臺呼叫類API被調用后(除IVR外呼、外呼通知、語音驗證碼接口),會通過開發者在網站后臺配置的應用鑒權回調地址向第三方應用服務器發起鑒權請求,第三方應用服務器收到請求后應進行相應處理并按照接口要求應答云通訊平臺,云通訊平臺則根據第三方應用服務器的返回進行下一步處理。
注意:如果鑒權請求到達第三方服務器后不按照接口響應進行處理或者超時無響應,本次呼叫將被取消。
網站上配置的URL格式:協議類型://服務器地址:端口號/路徑/文件名,如:https://{ip/域名}:{port}/{path}
a、第三方應用服務器URL中協議類型可以是HTTPS或HTTP;
b、第三方應用服務器URL中服務器地址可以是IP或域名;
c、 端口是必填項,默認的也需要填寫,如HTTPS默認的443端口;
1、呼叫鑒權接口
此接口用于云通訊平臺向第三方應用服務器做呼叫鑒權。該接口支持URL rewrite,請參考回調地址說明。
(1)云通訊平臺請求
a、請求包頭
屬性 | 類型 | 約束 | 描述 | 舉例 |
---|---|---|---|---|
Method | String | 必選 | HTTP方法 | POST |
URL | String | 必選 | 地址URL | /{path} |
Host | String | 必選 | 服務器地址 | |
Content-Type | String | 必選 | 類型 | application/xml |
Content-Length | String | 必選 | 消息體的長度 | ? |
b、請求包體
屬性 | 類型 | 約束 | 描述 | 取值 |
---|---|---|---|---|
action | String | 必選 | 請求類型 | CallAuth |
orderid | String | 必選 | 訂單Id | CM6000220140220161222104945 |
type | int | 必選 | 呼叫類型 | 0:網絡直撥電話;1:雙向回撥;2:互聯網語音通話 |
subid | String | 必選 | 子賬號Id | type取值為1時,即雙向回撥時提供 |
caller | String | 必選 | 主叫號碼 | type取值為0或2時,主叫號碼為通訊賬號;type取值為1時,主叫號碼為電話號碼 |
called | String | 必選 | 被叫號碼 | type取值為0時,被叫號碼為電話號碼;type取值為1時,被叫號碼為電話號碼;type取值為2時,被叫號碼為通訊賬號; |
subtype |
String | 必選 | 外呼顯號標示 |
0:不顯號 1:一方顯號 2:雙方均顯號(取值為2僅雙向回撥時存在) |
callSid |
String | 必選 | 一路呼叫的唯一標示 | 32位字符串 |
userData | String | 可選 | 第三方私有數據,在type取值為1時,也就是回撥時可通過回撥接口傳入此參數。 | 1111 |
c、請求示例
POST /{path} HTTP/1.1 Host:: Content-Type: text/plain Content-Length: CallAuth 1 CM6000220140220161222104945 ff8080813ba7d87c013bbd0146680973 1512345678 01052823627 1 aaf98f894b00309b014b05b468c2abcd 私有數據
(2)第三方應用服務器響應
a、響應包頭
屬性 | 類型 | 約束 | 描述 | 舉例 |
---|---|---|---|---|
Status-Code | String | 必選 | 應答狀態碼,全部為200 | HTTP/1.1 200 OK |
Date | String | 可選 | 服務器時間 | Wed Nov 9 16:08:57 2011 |
Content-Length | String | 必選 | 消息體的長度 | |
b、響應包體
屬性 | 類型 | 約束 | 描述 | 取值 |
---|---|---|---|---|
statuscode | String | 必選 | 認證授權結果 | ?0000 成功 |
statusmsg | String | 可選 | 認證結果描述 | ? |
record | String | 可選 | 是否錄音 | 是否錄音:0表示不錄音;1表示錄音;默認值0。實時下載錄音文件在鑒權通知(Hangup)中獲取錄音下載地址,非實時可以第二天在官網打包進行下載。注:因為錄音文件需要時間同步到下載服務器,建議在獲取到錄音下載地址10秒后再進行下載。 |
recordPoint | String | 可選 | 此次通話時長單位為秒 | 開始錄音的時間節點。當直撥時:0表示被叫振鈴開始錄音;1表示被叫接聽開始錄音。當回撥時:0表示主叫接聽開始錄音;1表示被叫接聽開始錄音。默認值0。 |
sessiontime | String | 可選 | 此次通話時長單位為秒 | 默認不限時(如果小于等于0,則默認不限時) |
disnumber | String | 可選 | 用戶方的顯號號碼,根據平臺側顯號規則控制 | 有顯號需求請聯系云通訊商務,不在平臺規則內或空則顯示云通訊平臺默認號碼。如果通過接口傳參和鑒權響應傳參同時設置鑒權優先級更高 |
c、響應示例
HTTP/1.1 200 ok Date:Wed Nov 9 16:08:57 2011 Content-Length:0000 statuscode > 狀態描述信息 1
2、呼叫建立通知接口
此接口用于云通訊平臺呼叫建立的時候通知第三方應用服務器。該接口支持URL rewrite。
(1)云通訊平臺請求
a、請求包頭
屬性 | 類型 | 約束 | 描述 | 舉例 |
---|---|---|---|---|
Method | String | 必選 | HTTP方法 | POST |
URL | String | 必選 | 地址URL | /{path} |
Host | String | 必選 | 服務器地址 | |
Content-Type |
String | 必選 | 類型 | application/xml |
Content-Length | String | 必選 | 消息體的長度 | ? |
b、請求包體
屬性 | 類型 | 約束 | 描述 | 取值 |
---|---|---|---|---|
action | String | 必選 | 請求類型 | CallEstablish |
orderid | String | 必選 | 訂單id | CM6000220140220161222104945 |
type | int | 必選 | 呼叫類型 | 0:網絡直撥電話;1:雙向回撥;2:互聯網語音通話 |
subid | String | 必選 | 子賬號id | type取值為1時,即雙向回撥時提供 |
caller | String | 必選 | 主叫號碼 | type取值為0或2時,主叫號碼為通訊賬號;type取值為1時,主叫號碼為電話號碼 |
called | String | 必選 | 被叫號碼 | type取值為0時,被叫號碼為電話號碼;type取值為1時,被叫號碼為電話號碼;type取值為2時,被叫號碼為通訊賬號; |
subtype |
String | 必選 | 外呼顯號標示 |
0:不顯號 1:一方顯號 2:雙方均顯號(取值為2僅雙向回撥時存在) |
callSid |
String | 必選 | 一路呼叫的唯一標示 | 32位字符串 |
c、請求示例
POST /{path} HTTP/1.1 Host:: Content-Type: text/plain Content-Length: CallEstablish 1 CM6000220140220161802104974 ff8080813ba7d87c013bbd0144fb0972 00861312345678 008613512345678 1 aaf98f894b00309b014b05b468c2abcd
(2)第三方應用服務器響應
a、響應包頭
屬性 | 類型 | 約束 | 描述 | 舉例 |
---|---|---|---|---|
Status-Code | String | 必選 | 應答狀態碼,全部為200 | HTTP/1.1 200 OK |
Date | String | 可選 | 服務器時間 | Wed Nov 9 16:08:57 2011 |
Content-Length | String | 必選 | 消息體的長度 | 140 |
b、響應包體
屬性 | 類型 | 約束 | 描述 | 取值 |
---|---|---|---|---|
statuscode | String | 必選 | 認證授權結果 | ?0000 成功 |
statusmsg | String | 可選 | 認證結果描述 | ? |
billdata | String | 必選 | 呼叫的計費私有數據,掛機時原樣傳回給第三方 | billdata |
sessiontime |
String | 必選 | ?此次通話時長單位為秒,如鑒權接口返回通話時長以鑒權接口返回為準。 |
?默認不限時(如果小于等于0,則默認不限時) |
c、響應示例
HTTP/1.1 200 ok Date:Wed Nov 9 16:08:57 2011 Content-Length:0000 CallEstablish success 3600 billdata
3、呼叫掛機計費接口
此接口用于云通訊平臺掛機的時候通知第三方應用服務器。該接口支持URL rewrite。
(1)云通訊平臺請求
a、請求包頭
屬性 | 類型 | 約束 | 描述 | 舉例 |
---|---|---|---|---|
Method | String | 必選 | HTTP方法 | POST |
URL | String | 必選 | 地址URL | /{path} |
Host | String | 必選 | 服務器地址 | |
Content-Type | String | 必選 | 類型 | application/xml |
Content-Length | String | 必選 | 消息體的長度 | ? |
b、請求包體
屬性 | 類型 | 約束 | 描述 | 取值 |
---|---|---|---|---|
action | String | 必選 | 請求類型 | Hangup |
orderid | String | 必選 | 訂單id | ?CM6000220140220161802104974 |
type | int | 必選 | 呼叫類型 | 0:網絡直撥電話;1:雙向回撥;2:互聯網語音通話 |
subid | String | 必選 | 子賬號id | type取值為1時,即雙向回撥時提供 |
caller | String | 必選 | 主叫號碼 | type取值為0或2時,主叫號碼為通訊賬號;type取值為1時,主叫號碼為電話號碼 |
called | String | 必選 | 被叫號碼 | type取值為0時,被叫號碼為電話號碼;type取值為1時,被叫號碼為電話號碼;type取值為2時,被叫號碼為通訊賬號; |
starttime | String | 必選 | 通話開始時間,當type為1 也就是回撥時,如果被叫未接聽,則為主叫摘機時間;如果被叫接聽,則為被叫摘機時間 | YYYYMMDDHH24MISS |
endtime | String | 必選 | 通話結束時間 | YYYYMMDDHH24MISS |
billdata | String | 必選 | 呼叫的計費私有數據 | ?billdata |
subtype |
String | 可選 | 外呼顯號標示 |
0:不顯號 1:一方顯號 2:雙方均顯號(取值為2僅雙向回撥時存在) |
callSid |
String | 可選 | 一路呼叫的唯一標示 | 32位字符串 |
recordurl |
String | 可選 | 通話錄音完整下載地址 |
默認空 |
talkDuration |
String | 可選 | 通話時長;注:回撥時,如果被叫未接聽,則此參數值為0 | 單位秒 |
alertingDuration |
String | 可選 | 振鈴時長 |
單位秒 |
noAnswerEndtime |
String | 可選 | 未摘機時長:從收到呼叫到外呼到掛機的時長 |
單位秒 |
byetype |
String | 可選 | 通話掛機類型 |
掛機類型 |
c、請求示例
POST /{path} HTTP/1.1 Host:: Content-Type: text/plain Content-Length: Hangup CM6000220140220161802104974 1 ff8080813ba7d87c013bbd0146680973 1 008615212345678 0086042910086 20130212000256 20130212000344 billdata 1 aaf98f894b00309b014b05b468c2abcd http://192.168.111.23:80/downloadurl
(2)第三方應用服務器響應
a、響應包頭
屬性 | 類型 | 約束 | 描述 | 舉例 |
---|---|---|---|---|
Status-Code | String | 必選 | 應答狀態碼,全部為200 | HTTP/1.1 200 OK |
Date | String | 可選 | 服務器時間 | Wed Nov 9 16:08:57 2011 |
Content-Length | String | 必選 | 消息體的長度 | 40 |
b、響應包體
屬性 | 類型 | 約束 | 描述 | 取值 |
---|---|---|---|---|
statuscode | String | 必選 | 認證授權結果 | ?0000 成功 |
statusmsg | String | 可選 | 認證結果描述 | ? |
totalfee | double | 可選 | 本次通話消費 | 單位:元 |
c、響應示例
HTTP/1.1 200 ok Date:Wed Nov 9 16:08:57 2011 Content-Length:0000 Bill success 0.120000
文檔更新時間:2017年1月20日