新用户指南 SDK文档 Rest API IVR API 云通讯首页

∨  接入指南

新手指引

开发流程

第三方呼叫鉴权

鉴权接口

鉴权挂机类型

❀ 云通讯首页>>开发者中心>>新用户指南>>接入指南

鉴权接口说明

云通讯平台呼叫类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
    状态描述信息
    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日

© Copyright 云通讯平台 All Rights Reserved 北京容联易通信息技术有限公司

增值电信业务经营许可证：B2-20090494 电信与信息服务营业经营许可证：京ICP证130398号