实时话单通知接口说明

1. 实时话单通知

与呼叫鉴权功能相同,用于客户实时获取话单记录,在电话回拨中的hangupCdrUrl参数自定义回调地址。

1.1 实时话单主叫话单

请求包头

属性 类型 约束 描述 举例
Method String 必选 HTTP方法 POST
URL String 必选 地址URL /{path}
Host String 必选 服务器地址 <ip>:<port>
Content-Type String 必选 类型 text/plain
Content-Length String 必选 消息体的长度

请求包体参数

属性 类型 约束 描述 取值
appId
String 必选 应用ID
32位字符串
callSid
String 必选 回拨接口请求后响应返回的callSid参数,一路呼叫的唯一标识。
32位字符串
userData string
可选 第三方私有数据
subId String 可选 云通讯平台子帐号
caller String 必选 主叫号码,对应回拨接口中from参数
called String 必选 被叫号码,对应回拨接口中to参数
starttime String 必选 开始时间,如果被叫接听则是被叫摘机时间,否则是主叫摘机时间,如果主叫未接听则为空。 YYYYMMDDHH24MISS
endtime String
必选 结束时间,如果被叫接听则是被叫挂机时间,否则是主叫挂机时间,如果主叫未接听则为空。 YYYYMMDDHH24MISS
duration String 必选 通话时长,如果被叫接听则是被叫通话时长,否则是主叫通话时长,如果主叫未接听则为0 单位秒
beginCallTime String
必选 开始呼叫主叫时间 YYYYMMDDHH24MISS
ringingBeginTime String 必选 主叫开始振铃时间 YYYYMMDDHH24MISS
ringingEndTime String
必选 主叫结束振铃时间,也是主叫摘机时间,等于starttime YYYYMMDDHH24MISS
byetype String 必选 挂机类型
recordurl String
可选 通话录音下载地址,当回拨接口中needRecord参数设置录音且主叫摘机才会有下载地址,否则没有此参数。注:因为录音文件需要时间同步到下载服务器,建议在获取到录音下载地址10秒后再进行下载。 http方式

请求示例

POST /{path} HTTP/1.1 
Host: <ip>:<port>
Content-Type: text/plain
Content-Length: <Len>

<?xml version="1.0" encoding="UTF-8"?>
<CDR>
  <appId>ff8080813f84717a013f847540ef1111</appId>
  <callSid>14080711103332060001000200000003</callSid>
  <userData>66666666</userData>
  <subId>ff8080813f855ff9013f8568fa310001</subId>
  <caller>07175322232</caller>
  <called>18701696245</called>
  <starttime>20150327145921</starttime>
  <endtime>20150327145941</endtime>
  <duration>20</duration>
  <beginCallTime>20150327145858</beginCallTime>
  <ringingBeginTime>20150327145906</ringingBeginTime>
  <ringingEndTime>20150327145921</ringingEndTime>
  <byetype>3</byetype>
  <recordurl>http://192.168.111.23:80/downloadurl/20150327145912.wav</recordurl>
</CDR>

					

1.2 实时话单主被叫话单

请求包头

属性 类型 约束 描述 举例
Method String 必选 HTTP方法 POST
URL String 必选 地址URL /{path}
Host String 必选 服务器地址 <ip>:<port>
Content-Type String 必选 类型 text/plain
Content-Length String 必选 消息体的长度

请求包体参数

属性 类型 约束 描述 取值
CallerCdr String
必选 主叫话单节点 xml节点
appId
String 必选 应用ID
32位字符串
callSid
String 必选 回拨接口请求后响应返回的callSid参数,一路呼叫的唯一标识。
32位字符串
userData string
可选 第三方私有数据
subId String 可选 云通讯平台子帐号
caller String 必选 主叫显号号码,回拨中fromSerNum参数设置有效时的号码,否则为云通讯平台默认值的号码。
called String 必选 主叫号码,对应回拨接口中from参数
starttime String 必选 开始时间,主叫摘机时间,如果主叫未接听则为空。 YYYYMMDDHH24MISS
endtime String
必选 结束时间,主叫挂机时间,如果主叫未接听则为空。 YYYYMMDDHH24MISS
duration String 必选 主叫通话时长,如果主叫未接听则为0 单位秒
beginCallTime String
必选 开始呼叫主叫时间 YYYYMMDDHH24MISS
ringingBeginTime String 必选 主叫开始振铃时间 YYYYMMDDHH24MISS
ringingEndTime String
必选 主叫结束振铃时间,也是主叫摘机时间,等于starttime YYYYMMDDHH24MISS
byetype String 必选 挂机类型
CalledCdr String
必选 被叫话单节点 xml节点
appId
String 必选 应用ID
32位字符串
callSid
String 必选 回拨接口请求后响应返回的callSid参数,一路呼叫的唯一标识。
32位字符串
userData string
可选 第三方私有数据
subId String 可选 云通讯平台子帐号
caller String 必选 主叫号码,对应回拨接口中from参数
called String 必选 被叫号码,对应回拨接口中to参数
starttime String 必选 开始时间,被叫摘机时间,如果被叫未接听则为空。 YYYYMMDDHH24MISS
endtime String
必选 结束时间,被叫挂机时间,如果被叫未接听则为空。 YYYYMMDDHH24MISS
duration String 必选 通话时长,被叫通话时长,如果被叫未接听则为0 单位秒
beginCallTime String
必选 开始呼叫被叫时间 YYYYMMDDHH24MISS
ringingBeginTime String 必选 被叫开始振铃时间 YYYYMMDDHH24MISS
ringingEndTime String
必选 被叫结束振铃时间,也是被叫摘机时间,等于starttime YYYYMMDDHH24MISS
recordurl String 必选 通话录音下载地址,当回拨接口中needRecord参数设置录音且主叫摘机才会有下载地址,否则没有此参数。注:因为录音文件需要时间同步到下载服务器,建议在获取到录音下载地址10秒后再进行下载。 http方式

请求示例

POST /{path} HTTP/1.1 
Host: <ip>:<port>
Content-Type: text/plain
Content-Length: <Len>

<?xml version="1.0" encoding="UTF-8"?>
<CDR>
<CallerCdr>
  <appId>ff8080813f84717a013f847540ef1111</appId>
  <callSid>14080711103332060001000200000003</callSid>
  <userData>66666666</userData>
  <subId>ff8080813f855ff9013f8568fa310001</subId>
  <caller>07175322232</caller>
  <called>18701696245</called>
  <starttime>20150327145921</starttime>
  <endtime>20150327145941</endtime>
  <duration>20</duration>
  <beginCallTime>20150327145858</beginCallTime>
  <ringingBeginTime>20150327145906</ringingBeginTime>
  <ringingEndTime>20150327145921</ringingEndTime>
  <byetype>3</byetype>
</CallerCdr>
<CalledCdr>
  <appId>ff8080813f84717a013f847540ef1111</appId>
  <callSid>14080711103332060001000200000003</callSid>
  <userData>66666666</userData>
  <subId>ff8080813f855ff9013f8568fa310001</subId>
  <caller>18701696245</caller>
  <called>18603592345</called>
  <starttime>20150327173112</starttime>
  <endtime>20150327173115</endtime>
  <duration>3</duration>
  <beginCallTime>20150327173105</beginCallTime>
  <ringingBeginTime>20150327173109</ringingBeginTime>
  <ringingEndTime>20150327173112</ringingEndTime>
</CalledCdr>
<recordurl>http://192.168.111.23:80/downloadurl/20150327145912.wav</recordurl>
</CDR>
					

2. 响应消息

响应包体

属性
类型 约束 描述
取值
statuscode String 必选 响应状态码
 取值000000(成功)

响应示例

HTTP/1.1 200 ok
Date:Wed Nov 9 16:08:57 2011
Content-Length: <len> 

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <statuscode>000000</statuscode>
</Response>
					

文档更新时间:2016年8月11日