一卡通接口规范
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
客服接口协议
一、 应用服务方式实现
通讯协议采用TCP/IP 标准协议,客服系统中的业务功能作为Client 向Server 发送请求,Server 为运行于营业系统的应用程序,用于实时监听客服系统的业务请求并响应,根据请求包头中的业务类型代码,访问不同业务系统的数据库,提供客服系统所需的数据。 接口数据有两种形式:
1. 请求包:由客户端发出的业务请求,以请求包的形式传送至服务端,其中包括该项业务
所需要的参数信息。
2. 应答包:服务端处理相应的业务请求后返回的处理结果数据。
数据包由包头和包体构成,包头内容主要包括各种数据包的共同的基本信息,包体内容主要包括各种数据包的特有信息。请求包和应答包的结构如下:
注: Ax 为包头的组成元素。B 为包体。
二、 包头定义
包头数据内容为一定长ASCII 字符串(80位),具体内容如下:
● A0版本号信息(2位):标识当前使用的协议版本号。如1。0,1。1。
● A1数据包大小(5位):以字节为单位,不足补空格。如大小为256个bytes ,应为:256__。 ● A2流水号(20位):业务流水号,标志每笔具体交易。数据校验包可无流水号。 ● A3标志(1位):1 表示成功 0 表示失败,仅适用于响应包。 ● A4服务类型(12位):见服务类型字段
015
●A5业务号码(20位):移动电话号码、IP Phone帐号、市话电话号码、长话帐号、寻
呼号、165帐号。
●A6业务号码类型(1位):1电话号码;2帐号;3其他。
●A7营业点 (6位): 业务受理地点。
●A8营业员 (8位): 业务受理人。
●A9包编号(5位):标志该笔流水的第几包数据。
●A10最后一包标志(1位):在进行多包发送的情况下,该标志用以标明是否为最后一数
据包。 1 最后一包数据,无后续包,0 非最后一包数据,有后续包。连接错误,I/O 错误等。
●A11错误码(5位):在标志为失败时需检查该错误码。错误码包括系统操作错误和业务
处理错误。
三、包体定义
一个数据包总长度不可大于20k。
对存在多条返回纪录的业务,一个数据包可含多条记录。长度如超过20K,应以多包数据发送。
每个字段之间用“TAB键0x09”分隔,每个记录之间用“回车键0x0d,0x0a”分隔,包结束符用“0x1a”。
对于不同的服务类型,其请求包和应答包的包体具有不同的内容。
四、错误编码
错误编码00000-00499为固定编码,不做变动,错误代码表也存在。
错误编码00500-99999为非固定编码,需通过错误代码表提取错误信息。
固定编码中00400-00499为系统错误。如网络连接错误,I/O错误等。
下表列出了常见的错误及对应编码:
说明:接口必须处理各种错误,在此对业务类型的错误处理方式不做规定。但对系统错误作出处理规定,当发生系统错误时,连续发送3次连接请求,如不成功提示告警信息。
五、具体实现
下面是对各种应用服务的请求包和应答包的具体定义:
1.特服档案修改(自动业务受理): 服务类型103000181000
请求包体:
注:虽然各字段之间采用TAB键进行分隔,严格上说无需规定各字段的长度, 但由于数据库字段长度限制, 因此建议受理点和受理人字段不要超过表格中指定的长度.
应答包体:
无。