校讯通软件接口规范.docx

1、校讯通软件接口规范 校讯通公话软件接口规范（V1.4）目录1 介绍 61.1 目的 61.2 适用范围 61.3 缩略语 62 接口协议概述 72.1 GPRS协议 72.2 接口分类 72.2.1 普通公话接口 72.2.2 校园数据库接口 72.2.3 公话管理接口 73 数据类型和格式定义 83.1 数据类型定义 83.2 PDU格式概述 83.3 UASP PDU布局 84 公话PDU接口定义 104.1 “PHONE_AUTHEN”公话认证 104.1.1 公话认证(由公话发给Server端) 104.1.2 公话认证应答(由Server发给公话) 104.2 “STDT_CARD_

2、LOGIN”学生卡登录操作 104.2.1 学生卡登录请求语法(由公话发给Server端) 104.2.2 学生卡登录应答语法(由Server发给公话) 104.3 “STDT_NO_LOGIN”学号登录操作 114.3.1 学号登录请求语法(由公话发给Server端) 114.3.2 学号登录应答语法(由Server发给公话端) 114.4 “STDT_READ_MSG”学生卡读取留言操作 114.4.1 学生卡读取留言请求语法(由公话发给Server端) 114.4.2 学生卡读取留言应答语法(由Server发给公话) 124.5 “CALL_BILLING”通话话单操作 124.5.1

3、通话话单请求语法(由公话发给Server端) 124.5.2 通话话单应答语法(由Server发给公话) 124.6 “STDT_SIGN_RECS”学生签到记录 134.6.1 学生签到记录请求语法(由公话发给Server端) 134.6.2 学生签到记录应答语法(由Server发给公话) 134.7 “CONNECT_STATUS”网络连接状态查询 134.7.1 网络连接状态查询语法(由公话发给Server端) 134.7.2 网络连接状态查询应答语法(由Server发给公话) 135 公话管理接口定义 145.1 “ABT_STATUS”公话状态查询 145.1.1 公话状态查询语法(

4、由Server端发给公话) 145.1.2 公话状态查询应答语法(由公话发给Server) 145.2 “EDIT_ABT_SET”修改终端设置 145.2.1 修改终端参数请求语法(由Server发给公话) 145.2.2 修改终端参数应答语法(由公话发给Server) 155.3 “SET_ABT_RESET”设置终端重启 155.3.1 设置终端重启请求语法(由Server发给公话) 155.3.2 设置终端重启应答语法(由公话发给Server) 155.4 “UPDATE_NOTICE”程序更新通知 155.4.1 程序更新通知语法(由Server端发给公话) 155.4.2 程序更新

5、通知应答语法(由公话发给Server) 155.5 “UPDATE_PROGRAM”程序更新 165.5.1 程序更新语法(由Server端发给公话) 165.5.2 程序更新应答语法(由公话发给Server) 165.6 “SYNC_ID_UPDATE”亲情号码更新同步 165.6.1 亲情号码更新同步请求语法(由Server发给公话) 165.6.2 亲情号码更新同步应答语法(由公话发给Server) 165.7 “SEND_ID_UPDATE”亲情号码更新数据发送 175.7.1 亲情号码更新数据发送请求语法(由Server发给公话) 175.7.2 亲情号码更新数据发送应答语法(由公话

6、发给Server) 175.8 “ID_DELETE_ALL”亲情号码删除（全部删除） 175.8.1 亲情号码删除请求语法(由Server发给公话) 175.8.2 亲情号码删除应答语法(由公话发给Server) 175.9 “ID_DELETE_ONE”亲情号码删除卡信息（删除某个卡的卡信息） 185.9.1 亲情号码删除卡信息请求语法(由Server发给公话) 185.9.2 亲情号码删除卡信息应答语法(由公话发给Server) 185.10 “SET_TALK_DURATION”设置单次通话时长 185.10.1 设置单次通话时长请求语法(由Server发给公话) 185.10.2 设

7、置单次通话时长应答语法(由公话发给Server) 185.11 “CLASS_LIST” 班级列表 185.11.1 班级列表请求语法(由公话发给Server) 185.11.2 班级列表应答语法(由Server发给公话) 195.12 “STUDENT_LIST” 学生列表 195.12.1 学生列表请求语法(由公话发给Server) 195.12.2 学生列表应答语法(由Server发给公话) 195.13 “TEACHER_CALL_BILLING”教师通话话单操作 195.13.1 教师通话话单请求语法(由公话发给Server) 195.13.2 教师通话话单应答语法(由Server发

8、给公话) 205.14 “ME_STATUS_UPDATE”终端状态上报 205.14.1 终端状态上报请求语法(由公话发给Server) 205.14.2 终端状态上报应答语法(由Server发给公话) 205.15 “STDT_BUS_SIGN”学生校车签到。 215.15.1 学生签到记录请求语法(由公话发给Server端) 215.15.2 学生签到记录应答语法(由Server发给公话) 216 参数取值定义 226.1 功能号（func_no）取值 221 介绍1.1 目的中国移动校讯通业务可允许用户在学校使用公话享受移动服务。校讯通公话接口协议定义了校讯通业务中校园公话与校讯通公话

9、服务器之间的接口协议及公话与读卡器的通讯协议。校讯通公话接口采用GPRS或有线的通讯方式。1.2 适用范围本文定义了校讯通公话接口协议，规定了请求应答的会话方式、报文格式和语法，适用于外部实体开发商利用校讯通公话接口访问校讯通公话服务时参考。1.3 缩略语 SC (Service Center)：数据采集中心 ABT (Child-caring System Teminal)：校讯通公话终端 SRFC (Student RF Card)：学生专用的RF卡2 接口协议概述2.1 GPRS协议 校讯通公话接口采用GPRS协议与移动SC进行数据通讯。本质上是基于TCP/IP协议之上的应用层协议，以T

10、CP协议进行数据传输，采用请求/应答的同步通讯模型实现。 SC使用公网地址，在某个端口侦听校讯通公话连接，可以使用认证方式建立连接。2.2 接口分类公话接口分为以下几类：2.2.1 普通公话接口提供普通公话服务。如校讯通卡登录，读取留言，通话话单上传等。2.2.2 校园数据库接口校园学校签到/刷卡设备使用。2.2.3 公话管理接口提供公话设备的系统管理接口。包括更新通知，程序更新，公话状态查询等。3 数据类型和格式定义3.1 数据类型定义类型说明String字节串。如无特别说明则左齐右补空格（ASCII码32），字节串的最后一字符不可为空格。VST变化的字符串。字符串的最大长度由协议给出。字符

11、串的具体长度根据PDU包头的length字段给出。因此VST必须放在每个包的最后一个。Integer定长String, 它由一系列的10进制字符组成（0-9），右齐左补0（ASCII码48）。注意：当此类型字段字符值超过4294967295时（32位无符号整数的最大值），若将其转换为32位无符号整数会产生溢出，程序员需要进行特别处理。Date8位定长String，格式:YYYYMMDDDateTime14位定长String，格式:YYYYMMDDHHMISSnDataType某种数据类型的列表。前面的n用2位Integer表示。Binary二进制数据3.2 PDU格式概述一个典型的信息格式如下

12、表所示：UASP PDU头体lengthfunc_noseq_noBody424=(length值 10)4=(length值 4)3.3 UASP PDU布局下面是一个完整PDU的布局：BOSS.UAS PDU 域长度类型说明头command_length4Integer此域表示消息包的长度，UASP PDU的最大包体长度为9999字节func_no2String操作码，取值参照第6.1节seq_no4Integer此域表示一个序列号，使用在异步通信模式下，由消息发起者设定，应答者对应给回此序列号。序列号范围：00009999，循环使用。同步方式下该域保留。体必需参数MixedPDU里必须包

13、含的参数注：seq_no字段在同步中也可以使用，使用该字段作为请求包和响应包的对应字段。任何交易发起时，由client端产生seq_no，server收到请求后在响应包头中填入此字段内容，client端收到响应后，同发送包的该字段内容进行校验，以确认是该发送包的响应，然后继续处理。4 公话PDU接口定义4.1 “PHONE_AUTHEN”公话认证4.1.1 公话认证(由公话发给Server端)序号域名长度类型描述1DeviceId18String公话ID2Reserved8String保留4.1.2 公话认证应答(由Server发给公话)序号域名长度类型描述1valid_flag1Intege

14、r1:认证成功0:认证失败注：1.终端在连上服务器时要进行一次终端认证,而且要接收到认证成功后才可继续进行其他的交互动作。2.如果终端在未认证时连接进来,SEVER端要发送认证失败的包给公话,然后再断开连接（可防止未知设备连到服务器）。4.2 “STDT_CARD_LOGIN”学生卡登录操作4.2.1 学生卡登录请求语法(由公话发给Server端)序号域名长度类型描述1Device_msisdn15String公话手机号2Device_id18String公话ID3card_id18String学生卡号4student_id18String学生ID5request_time14DateTime请求时间注：1.学生卡号以十六进制上传。2学生ID字段和公话手机号字段暂时保留，服务器收到这两个字段暂时不处理4.2.2 学生卡登录应答语法(由Server发给公话)序号域名长度类型描述1valid_flag1Integer学生卡是否有效0 无效 (0 有效)1为学生卡2为教师卡2Family_num2Integer亲情号码个数3Family_msisdn15nString亲情号