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