校讯通软件接口规范.docx
《校讯通软件接口规范.docx》由会员分享，可在线阅读，更多相关《校讯通软件接口规范.docx（26页珍藏版）》请在冰豆网上搜索。
校讯通软件接口规范
校讯通公话软件接口规范
（V1.4）
目录
1介绍6
1.1目的6
1.2适用范围6
1.3缩略语6
2接口协议概述7
2.1GPRS协议7
2.2接口分类7
2.2.1普通公话接口7
2.2.2校园数据库接口7
2.2.3公话管理接口7
3数据类型和格式定义8
3.1数据类型定义8
3.2PDU格式概述8
3.3UASPPDU布局8
4公话PDU接口定义10
4.1“PHONE_AUTHEN”公话认证10
4.1.1公话认证（由公话发给Server端）10
4.1.2公话认证应答（由Server发给公话）10
4.2“STDT_CARD_LOGIN”学生卡登录操作10
4.2.1学生卡登录请求语法（由公话发给Server端）10
4.2.2学生卡登录应答语法（由Server发给公话）10
4.3“STDT_NO_LOGIN”学号登录操作11
4.3.1学号登录请求语法（由公话发给Server端）11
4.3.2学号登录应答语法（由Server发给公话端）11
4.4“STDT_READ_MSG”学生卡读取留言操作11
4.4.1学生卡读取留言请求语法（由公话发给Server端）11
4.4.2学生卡读取留言应答语法（由Server发给公话）12
4.5“CALL_BILLING”通话话单操作12
4.5.1通话话单请求语法（由公话发给Server端）12
4.5.2通话话单应答语法（由Server发给公话）12
4.6“STDT_SIGN_RECS”学生签到记录13
4.6.1学生签到记录请求语法（由公话发给Server端）13
4.6.2学生签到记录应答语法（由Server发给公话）13
4.7“CONNECT_STATUS”网络连接状态查询13
4.7.1网络连接状态查询语法（由公话发给Server端）13
4.7.2网络连接状态查询应答语法（由Server发给公话）13
5公话管理接口定义14
5.1“ABT_STATUS”公话状态查询14
5.1.1公话状态查询语法（由Server端发给公话）14
5.1.2公话状态查询应答语法（由公话发给Server）14
5.2“EDIT_ABT_SET”修改终端设置14
5.2.1修改终端参数请求语法（由Server发给公话）14
5.2.2修改终端参数应答语法（由公话发给Server）15
5.3“SET_ABT_RESET”设置终端重启15
5.3.1设置终端重启请求语法（由Server发给公话）15
5.3.2设置终端重启应答语法（由公话发给Server）15
5.4“UPDATE_NOTICE”程序更新通知15
5.4.1程序更新通知语法（由Server端发给公话）15
5.4.2程序更新通知应答语法（由公话发给Server）15
5.5“UPDATE_PROGRAM”程序更新16
5.5.1程序更新语法（由Server端发给公话）16
5.5.2程序更新应答语法（由公话发给Server）16
5.6“SYNC_ID_UPDATE”亲情号码更新同步16
5.6.1亲情号码更新同步请求语法（由Server发给公话）16
5.6.2亲情号码更新同步应答语法（由公话发给Server）16
5.7“SEND_ID_UPDATE”亲情号码更新数据发送17
5.7.1亲情号码更新数据发送请求语法（由Server发给公话）17
5.7.2亲情号码更新数据发送应答语法（由公话发给Server）17
5.8“ID_DELETE_ALL”亲情号码删除（全部删除）17
5.8.1亲情号码删除请求语法（由Server发给公话）17
5.8.2亲情号码删除应答语法（由公话发给Server）17
5.9“ID_DELETE_ONE”亲情号码删除卡信息（删除某个卡的卡信息）18
5.9.1亲情号码删除卡信息请求语法（由Server发给公话）18
5.9.2亲情号码删除卡信息应答语法（由公话发给Server）18
5.10“SET_TALK_DURATION”设置单次通话时长18
5.10.1设置单次通话时长请求语法（由Server发给公话）18
5.10.2设置单次通话时长应答语法（由公话发给Server）18
5.11“CLASS_LIST”班级列表18
5.11.1班级列表请求语法（由公话发给Server）18
5.11.2班级列表应答语法（由Server发给公话）19
5.12“STUDENT_LIST”学生列表19
5.12.1学生列表请求语法（由公话发给Server）19
5.12.2学生列表应答语法（由Server发给公话）19
5.13“TEACHER_CALL_BILLING”教师通话话单操作19
5.13.1教师通话话单请求语法（由公话发给Server）19
5.13.2教师通话话单应答语法（由Server发给公话）20
5.14“ME_STATUS_UPDATE”终端状态上报20
5.14.1终端状态上报请求语法（由公话发给Server）20
5.14.2终端状态上报应答语法（由Server发给公话）20
5.15“STDT_BUS_SIGN”学生校车签到。
21
5.15.1学生签到记录请求语法（由公话发给Server端）21
5.15.2学生签到记录应答语法（由Server发给公话）21
6参数取值定义22
6.1功能号（func_no）取值22
1介绍
1.1目的
中国移动校讯通业务可允许用户在学校使用公话享受移动服务。
校讯通公话接口协议定义了校讯通业务中校园公话与校讯通公话服务器之间的接口协议及公话与读卡器的通讯协议。
校讯通公话接口采用GPRS或有线的通讯方式。
1.2适用范围
本文定义了校讯通公话接口协议，规定了请求应答的会话方式、报文格式和语法，适用于外部实体开发商利用校讯通公话接口访问校讯通公话服务时参考。
1.3缩略语
●SC（ServiceCenter）：
数据采集中心
●ABT（Child-caringSystemTeminal）：
校讯通公话终端
●SRFC（StudentRFCard）：
学生专用的RF卡
2接口协议概述
2.1GPRS协议
●校讯通公话接口采用GPRS协议与移动SC进行数据通讯。
本质上是基于TCP/IP协议之上的应用层协议，以TCP协议进行数据传输，采用请求/应答的同步通讯模型实现。
●SC使用公网地址，在某个端口侦听校讯通公话连接，可以使用认证方式建立连接。
2.2接口分类
公话接口分为以下几类：
2.2.1普通公话接口
提供普通公话服务。
如校讯通卡登录，读取留言，通话话单上传等。
2.2.2校园数据库接口
校园学校签到/刷卡设备使用。
2.2.3公话管理接口
提供公话设备的系统管理接口。
包括更新通知，程序更新，公话状态查询等。
3数据类型和格式定义
3.1数据类型定义
类型
说明
String
字节串。
如无特别说明则左齐右补空格（ASCII码32），字节串的最后一字符不可为空格。
VST
变化的字符串。
字符串的最大长度由协议给出。
字符串的具体长度根据PDU包头的length字段给出。
因此VST必须放在每个包的最后一个。
Integer
定长String,它由一系列的10进制字符组成（‘0’---‘9’），右齐左补‘0’（ASCII码48）。
注意：
当此类型字段字符值超过‘4294967295’时（32位无符号整数的最大值），若将其转换为32位无符号整数会产生溢出，程序员需要进行特别处理。
Date
8位定长String，格式:
YYYYMMDD
DateTime
14位定长String，格式:
YYYYMMDDHHMISS
n[DataType]
某种数据类型的列表。
前面的n用2位Integer表示。
Binary
二进制数据
3.2PDU格式概述
一个典型的信息格式如下表所示：
UASPPDU
头
体
length
func_no
seq_no
Body
4
2
4
=（length值–10）
4
=（length值–4）
3.3UASPPDU布局
下面是一个完整PDU的布局：
BOSS.UASPDU域
长度
类型
说明
头
command_length
4
Integer
此域表示消息包的长度，UASPPDU的最大包体长度为9999字节
func_no
2
String
操作码，取值参照第6.1节
seq_no
4
Integer
此域表示一个序列号，使用在异步通信模式下，由消息发起者设定，应答者对应给回此序列号。
序列号范围：
0000－9999，循环使用。
同步方式下该域保留。
体
必需参数
Mixed
PDU里必须包含的参数
注：
seq_no字段在同步中也可以使用，使用该字段作为请求包和响应包的对应字段。
任何交易发起时，由client端产生seq_no，server收到请求后在响应包头中填入此字段内容，client端收到响应后，同发送包的该字段内容进行校验，以确认是该发送包的响应，然后继续处理。
4公话PDU接口定义
4.1“PHONE_AUTHEN”公话认证
4.1.1公话认证（由公话发给Server端）
序号
域名
长度
类型
描述
1
DeviceId
18
String
公话ID
2
Reserved
8
String
保留
4.1.2公话认证应答（由Server发给公话）
序号
域名
长度
类型
描述
1
valid_flag
1
Integer
1:
认证成功
0:
认证失败
注：
1.终端在连上服务器时要进行一次终端认证,而且要接收到认证成功后才可继续进行其他的交互动作。
2.如果终端在未认证时连接进来,SEVER端要发送认证失败的包给公话,然后再断开连接（可防止未知设备连到服务器）。
4.2“STDT_CARD_LOGIN”学生卡登录操作
4.2.1学生卡登录请求语法（由公话发给Server端）
序号
域名
长度
类型
描述
1
Device_msisdn
15
String
公话手机号
2
Device_id
18
String
公话ID
3
card_id
18
String
学生卡号
4
student_id
18
String
学生ID
5
request_time
14
DateTime
请求时间
注：
1.学生卡号以十六进制上传。
2学生ID字段和公话手机号字段暂时保留，服务器收到这两个字段暂时不处理
4.2.2学生卡登录应答语法（由Server发给公话）
序号
域名
长度
类型
描述
1
valid_flag
1
Integer
学生卡是否有效
0无效（>0有效）
1为学生卡
2为教师卡
2
Family_num
2
Integer
亲情号码个数
3
Family_msisdn
15
n[String]
亲情号
升级会员 