启通宝业务数据接口通信协议new.docVIP

启通宝业务数据接口通信协议 北京讯鸟软件有限公司 1、通信协议 采用HTTP协议的POST或者GET方式传输数据。 2、通信过程 启通宝向需要与启通宝通信的主体颁发一个的8位通信密钥(下文简称key）和身份标识（如客户编号ID），与启通宝通信时，用该密钥对通信数据生成签名后，将身份标识、签名和数据一起发送给启通宝，启通宝对签名认证成功后处理数据，否则不接受通信请求。 2.1、生成签名 使用md5方式生成签名，例如需要向启通宝POST的数据为： Username：用户名 Password：密码 Nickname：昵称 那么签名为： 签名 = md5(nickname=昵称password=密码username=用户名timestamp=时间戳key=通信密钥) 需要特别注意的是，除了key和timestamp之外的参与签名的参数必须按照字典顺序升序排列，key必须是参与签名数据的最后一项，时间戳为倒数第二项。 2.2、发送数据 据上面的示例，向启通宝发送的数据为： nickname=昵称password=密码username=用户名sign=签名timestamp=时间戳encode=编码方式ID=客户编号 其中encode参数指明在所发送的数据的编码，一般为utf8或者gbk，不传默认为utf8。 2.3、数据验证 启通宝接受到请求后，首先会验证时间戳，签名的生命周期是30秒，如果生成签名时的时间与启通宝接收到请求的时间超过30秒，该请求被视为无效请求。 启通宝将数据按照2.1小节签名之后与接收到的签名对比，如果两者不一致该请求被视为无效请求。 2.4、数据返回 数据返回为如下格式的字符串： status=状态码description=状态描述result=结果 status：请求结果的状态标识，除900、901、902、903为保留状态外码，其他状态由各个接口自行定义。 description：对请求结果的文字描述 result：json的格式的返回数据，返回的数据编码为UTF8。如果没有返回数据，该项为空字符串 保留状态码 状态码 状态描述 900 内部错误 901 请求超时 902 签名错误 903 服务暂停 3、数据接口 3.1、同步用户信息 （待补充） 3.2、根据通话编号（invokeid）取通话信息 url：http://.../ external/index/ gettimepoint 接收参数：invokeId 返回数据：status=状态码description=状态描述result=结果 结果： beginTime通话开始时间， AnswerCallTime 应答时间， beginTime 转接通话开始时间， TransCallTime 转接时间， endTime通话结束时间。 3.3、根据通话编号（invokeid）取录音地址 url：http://.../ external/index/getrecurl 接收参数：invokeId 返回数据：status=状态码description=状态描述result=结果 结果： 录音地址(url) 伪代码示例： $invokeId=8965231933derf3234 $passkey = ; $id = ‘8888888’; $time = time(); $sign = md5(“invokeId=$invokeIdtimestamp=$timekey=$passkey”); $url = “/external/index/getrecurl?invokeId=$invokeIdtimestamp=$timesign=$signID=$id”； HTTP::request($url); 3.4、根据通话编号（invokeId）取通话的url和通话转移后的录音的url。 url：http://.../ external/index/getrecurlarray 接收参数：invokeId 返回数据：status=状态码description=状态描述result=结果 result字段内容为 array( master = 初始通话录音的url, slave = 被转移后通话的录音的url ) 3.5、登录接口 url：http://.../ external/index/login 接收参数： agentname 要登录的座席名 backurl 登录成功后跳转url 返回数据： 结果：登录成功后导向backurl，失败提示信息