四川移动接口文档综述

1、回拨电话业务接口定义V 1.1北京讯众通信技术股份有限公司2015-12-03目录目录1. 简介 22. 接口描述 22.1 接口清单 22.2 接口协议 22.3 接口定义 32.3.1 拨打电话 32.3.2 取消拨打 52.3.3 话单获取接口(增量方式) 72.3.4 呼叫状态推送 81. 简介本文当旨在对第三方服务器和讯众通信开放能力平台之间的接口规范进行说明。2. 接口描述2.1 接口清单呼叫接入服务器和通信能力服务器之间有以下接口：1) 拨打电话2) 取消通话3) 通话账单4) 通话状态推送2.2 接口协议1. 目前方案接口以 Http+JSON2.3 接口定义2.3.1 拨打电

2、话拨打电话业务体验描述：用户 A 要和用户 B 通话；1、用户 A 向 平台发送点击拨号业务请求；2、平台呼叫用户 A ；3、用户 A 接听；4、平台呼叫用户 B；5、用户 B 接听；6、用户 A 和用户 B 通话；7、用户 A 的可通话时间结束，用户 A 和用户 B 被挂断；1) 拨打电话请求说明通信协议http请求方法Post/GetContent-Typeapplication/x-www-form-urlencoded; charset=UTF-8访问 URI商用环境 call.ashx2) Request body 请求参数拨打电话 request url 参数说明 ，默认都使用 u

3、tf-8 编码参数名称是否必选参数类型默认值说明loginid是StringNA用户编号loginpwd是StringNA用户密码 MD5 加密src是StringNull主叫号码，我们支持号码。例子或 者 1371234567801052084192|071352084192dst是StringNull被叫号码，格式与主叫号码相同credit是Int0单位为分钟。允许的最大通话分 钟数，这是指这次通话最多能进行多参数名称是 必选否参数类型默认 值说明长时间的通话。通话时间的计算是从 被叫接通的时刻开始计算。该值被设置为 0 的时候说明不限 通话时长，通信服务器将根据

4、客户账 户余额进行通话控制。我们允许可控 的最大通话时长为 8 小时，超过 8 小 时的将不发起呼叫，请第三方服务器 务必保证这个通话时长的准确性。statusNotifyUrl否StringNull状态推送接收地址，如果为空，我们 将不会向外推送状态。要求用 https。languageType否Int0播放 TTS 语音的语音。3) 请求示例POST /call.ashx HTTP/1.1Content-Type: application/x-www-form-urlencoded; charset=UTF-8” loginid ” : ” 4006056868 ”,” loginpwd

5、” : ” d3c551ed984268fe7f5b4c0f720bca”,” src ”86:1”8810207016 ”,” dst ”86:1”8513728895 ”,” credit ” : ” 50 ”,” statusNotifyUrl” : ” 34:8001/StatusNotify.aspx” languageType 0” : ”4) 响应结果参数拨打电话响应消息参数说明参数名称是否必选参数类型默认 值说明callId是StringNA请求参数携带 CallIderrMsg否StringNA执行结果描述errCode否IntNA执行结

6、果返回码5) 结果码返回响应结果码说明结果码说明0成功1010001系统错误1010002主叫或被叫不能为空1010003剩余分钟不足1010004用户名密码错误1010005提交的电话号码格式错误1010006API 达到调用上线响应结果示例HTTP/1.1 200 OKContent-Type: application/json;charset=UTF-8 errCode :0, callId :40d4711a801c7fb105ca06eb5f215e20, “errMsg ”:”Success ”2.3.2 取消拨打拨打电话业务体验描述：用户 A 要和用户 B 通话；1、用户 A 向

7、 平台发送点击拨号业务请求；2、用户 A 取消拨打；3、平台取消呼叫；6) 拨打电话请求说明通信协议http请求方法Post/GetContent-Typeapplication/x-www-form-urlencoded; charset=UTF-8访问 URI商用环境 cancel.ashx7) Request body 请求参数拨打电话 request url 参数说明 ，默认都使用 utf-8 编码参数名称是否必 选参数类 型默认值说明callId是StringNA本路通话的唯一标识 id ，这个唯 一的标识由拨打电话是报文返回的 callId ，并且与账单唯一对应。caller是St

8、ringNull主叫号码callee是StringNull被叫号码8) 请求示例POST /cancel.ashx HTTP/1.1Content-Type: application/x-www-form-urlencoded; charset=UTF-8 callId:867551091144411111111111111201, caller:8613866882006,callee:8613866882007, access_token:fabf92c95c5b7f2133aff7afb823a0, app_key:_xRDQgnR6GFJu2fE7Xv4TpDY qNIa9) 响应结果

9、参数拨打电话响应消息参数说明参数名称是否必选参数类型默认值说明callId是StringNA请求参数携带 CallIderrMsg否StringNA执行结果描述errCode否IntNA执行结果返回码10) 结果码返回响应结果码说明结果码 说明结果码说明0成功1010001系统错误1010002主叫或被叫不能为空1010003用户名密码错误1010004电话号码格式错误1010006API 达到调用上线响应结果示例HTTP/1.1 200 OKContent-Type: application/json;charset=UTF-8 errCode :0, callId :40d4711a801

10、c7fb105ca06eb5f215e20,“errMsg ”:”Success ”2.3.3 话单获取接口（增量方式）调用方法： POST/Get例：34:8001/callTicket.ashx?loginid=860300025&loginpwd=e10adc3949ba59a bbe56e057f20f883e&lastendid=1100&limit=1011）Request body 请求参数数名要求备注loginid必选企业编号loginpwd必选管理员密码 MD5 加密lastendid必选此处为当前已获取话单的最大序列号， 每条话单有自 增

11、长的序列号， 可从此最大序列号的下个序列号开始 拉取话单。limit可选如果 limit=0 ，表示获取 ID= lastendid 的一条话单 如果 limit0 ，表示获取 ID lastendid 的 limit 个话单 如果 limit 参数不存在，表示获取 lastEndId 的所有 话单12）请求示例13）响应结果参数变量名类型说明idString回呼流水号requestidString呼叫请求里携带的标识srcString访客号码dstString商家号码：如果接通了，返回接通的号码；如果没接通，设为空ctimeString呼叫开始时间（发起第一次呼叫的时间）stimeStrin

12、g第一个摘机时间，如果未摘机，则为空atimeString第二个摘机时间，也就是通话开始时间如果为空字符串，说明未接通etimeString呼叫结束时间（如接通，返回挂机时间；如未接通，返回呼叫 停止的时间）feeString本次呼叫，供应商需要扣除的费用，可以为0；provString访客省份cityString访客城市rnameString录音 URL 地址cltimeString在话单表生成该话单的时间返回结果正常情况返回一个通话详单的 json 串 errCode :0,result: 通话详单 ,cdr: , 异常情况下返回一个包含错误信息的 json 串 errCode :1010

13、001,result: 没有找到相应的话单 ! errCode :1010002,result: 参数错误 ! errCode :1010003,result: 用户名密码错误 ! 日期时间的格式： yyyy-MM-dd HH:mm:ss2.3.4 呼叫状态推送14）送请求说明通信协议https请求方法PostContent-Type访问 URI由拨打电话参数携带过来（ statusNotifyUrl ）15) response body 参数默认都使用 utf-8 编码，为 json 格式的参数参数名称是否必选参数类型默认值说明event是intNA事件类型0:STATUS_INVITE（ 发起 ）_ 1:STATUS_ANSWER （应答） 2:STATUS_RINGING （响铃） 3:STATUS_DISCONNECT （中断） 4:STATUS_ERROR （终止） -欠费 /用户名密码错误的原因造成callid是StringN