中国电信家校翼通专用终端平台接口规范.docx
《中国电信家校翼通专用终端平台接口规范.docx》由会员分享,可在线阅读,更多相关《中国电信家校翼通专用终端平台接口规范.docx(63页珍藏版)》请在冰豆网上搜索。
中国电信家校翼通专用终端平台接口规范
中国电信家校翼通专用终端
平台接口规范
(讨论稿)
中国电信集团公司
2011年3月
目录
1缩略语5
2协议描述6
3数据类型和格式定义7
3.1数据类型定义7
3.2包格式概述7
3.3包格式布局7
3.4包内容常见数据说明7
3.5包的最大长度8
4考勤机参数配置接口包格式定义9
4.1报警信息处理操作9
4.1.1上传报警信息语法(由考勤机发给Server端)[03]9
4.1.2上传报警信息应答语法(由Server发给考勤机)[03]9
4.2报警信息发送时间间隔下载10
4.2.1报警信息发送时间间隔语法(由server端发给考勤机)[09]10
4.2.2报警信息发送时间间隔下载应答语法(由考勤机发给server端)[09]10
4.3修改服务器IP地址端口号操作11
4.3.1修改服务器IP地址端口号语法(由server发给考勤机端)[04]11
4.3.2修改服务器IP地址端口号应答语法(由考勤机发给服务器端)[04]12
4.4心跳包12
4.4.1心跳包语法(由考勤机发给server端)[10]12
4.4.2心跳包应答语法(由server端发给考勤机)[10]13
4.5查询考勤机状态13
4.5.1查询考勤机状态语法(由server端发给考勤机)[0A]13
4.5.2查询考勤机状态回应语法(由考勤机发给server端)[0A]13
4.6时间校验14
4.6.1时间校验语法(由考勤机发给server端)[0C]14
4.6.2时间校验语法(由server端发给考勤机)[0C]14
5考勤机平安短信接口包格式定义15
5.1上传进出校信息操作15
5.1.1上传进出校信息语法(由考勤机发给server端)[08]15
5.1.2上传进出校信息应答语法(由server端发给考勤机)[08]15
6考勤机扩展功能接口包格式定义(可选)16
6.1请求更新本机参数操作16
6.1.1下传更新本机参数请求语法(由考勤机发给server端)[17]16
6.1.2下传更新本机参数应答语法(由server端发给考勤机)[17]16
6.2请求班级列表操作17
6.2.1下传班级列表请求语法(由考勤机发给server端)[18]17
6.2.2下传班级列表应答语法(由server端发给考勤机)[18]17
6.3上传考勤机数量和状态18
6.3.1上传考勤机数量和状态请求语法(由考勤机发给server端)[21]18
6.3.2上传考勤机数量和状态应答语法(由server端发给考勤机)[21]18
6.4终端参数配置下发19
6.4.1终端参数配置下发语法(由server端发给考勤机)[22]19
6.4.2终端参数配置下发语法(由考勤机发给server端)[22]21
6.5终端软件升级程序下载22
6.5.1终端软件升级程序下载语法(由server端发给考勤机)[1F]22
6.5.2终端软件升级程序下载语法应答(由考勤机发给server端)[1F]22
7考勤机亲情电话接口包格式定义(可选)24
7.1学生卡老师卡请求时长短信条数操作24
7.1.1学生卡老师卡请求时长短信条数语法(由考勤机发给Server端)[01]24
7.1.2学生卡老师卡请求时长短信条数应答语法(由Server发给考勤机)[01]25
7.2上传话单操作26
7.2.1上传话单语法(由考勤机发给Server端)[05]26
7.2.2上传话单应答语法(由server端发给考勤机)[05]26
7.3上学时段下发27
7.3.1上学时段下发语法(由server端发给考勤机)[0F]27
7.3.2上学时段下发语法(由考勤机发给server端)[0F]27
7.3.3考勤时段下发语法(由考勤机发给server端)[20]28
7.4卡亲情信息更新数据发送[11]28
7.4.1卡亲情信息更新数据发送请求语法(由Server发给考勤机)28
7.4.2卡亲情信息更新数据发送应答语法(由考勤机发给Server)29
7.5卡亲情信息删除(全部删除)[12]30
7.5.1卡信息删除请求语法(由Server发给考勤机)30
7.5.2卡信息删除应答语法(由考勤机发给Server)30
7.6卡属性应答操作30
7.6.1上传卡属性请求语法(由考勤机发给server端)[14]30
7.6.2上传卡属性应答语法(由server端发给考勤机)[14]31
7.7学号登录31
7.7.1学号登录语法(由考勤机发给server端)[0D]31
7.7.2学号登录应答语法(由server端发给考勤机)[0D]32
7.8请求学生列表操作32
7.8.1下传学生列表请求语法(由考勤机发给server端)[19]32
7.8.2下传学生列表应答语法(由server端发给考勤机)[19]33
7.9考勤时段下发34
7.9.1考勤时段下发语法(由server端发给考勤机)[20]34
7.10下传免费电话号码信息35
7.10.1下传免费电话号码请求语法(由server端发给考勤机)[1D]35
7.11下传离线老师所在班级列表操作36
7.11.1下传离线老师所在班级列表请求语法(由server端发给考勤机)[1A]36
7.11.2下传离线班级列表请求语法(由考勤机发给server端)[1A]36
7.12下传删除离线老师所在班级列表操作37
7.12.1下传删除离线老师所在班级列表请求语法(由server端发给考勤机)[1B]37
7.12.2下传删除离线老师所在班级列表请求语法(由考勤机发给server端)[1B]38
7.12.3下传免费电话号码应答语法(由考勤机发给server端)[1D]38
8考勤机短信留言接口包格式定义(可选)40
8.1学生卡读取短信留言操作40
8.1.1学生卡读取留言请求语法(由考勤机发给Server端)[02]40
8.1.2学生卡读取留言请求应答语法(由Server端发给考勤机)[02]41
8.2常用短语内容下载操作41
8.2.1短信常用短语内容下载语法(由Server发给考勤机端)[06]41
8.2.2短信常用短语内容下载应答语法(由考勤机发给服务器端)[06]42
8.3常用短语类名下载操作43
8.3.1短信常用短语类名下载语法(由server端发给考勤机)[07]43
8.3.2常用短语类名下载应答语法(由考勤机发给server端)[07]44
8.4考勤机发短信44
8.4.1考勤机发短信语法(由考勤机发给server端)[0B]44
8.4.2考勤机发短信回应语法(由server端发给考勤机)[0B]44
8.5下载公告45
8.5.1下载公告信息语法(由server端发给考勤机)[1E]45
8.5.2下载公告信息应答语法(由考勤机发给server端)[1E]46
9功能号总表47
1缩略语
●SC(ServiceCenter):
服务中心
●CCST(Child-caringSystemTeminal):
考勤机终端,又称家校翼通终端
●CCS(Child-caringSystem):
平安短信系统,又称家校翼通平台
●CCSCP(Child-caringSystem:
CommunicationProtocol):
平安短信系统通讯协议,又称家校翼通平台通讯协议
●SRFC(StudentRFCard):
学生、老师等专用的RF卡
2协议描述
●平安短信系统接口采用1X协议与电信SC进行数据通讯。
本质上是基于TCP/IP协议之上的应用层协议,以TCP协议进行数据传输,采用请求/应答的同步通讯模型实现。
●SC使用公网地址,在某个端口侦听考勤机连接,使用认证方式建立连接。
注:
数据包包由终端发出后未收到响应,或终端发送不成功,终端应该间阁T秒后重发,重新发送N-1次后放弃,建议T=30,N=3。
3数据类型和格式定义
3.1数据类型定义
类型
说明
String
仅限于0~9和大写的A~Z
3.2包格式概述
包格式
头
体
较验和
同步帧
序号
机器号
包长度
功能号
包内容
(功能号+包内容)
3
4
18
4
2
N
2
3.3包格式布局
下面是一个完整包格式的布局:
包格式域
长度
类型
说明
头
同步帧
3
String
1、CCST上传:
同步帧=TPJ
2、SC下传:
同步帧=JTP
序号
4
String
此域表示一个序列号,使用在异步通信模式下,由消息发起者设定,应答者对应给回此序列号。
序列号范围:
0000-ffff,循环使用。
同步方式下该域保留。
体
机器号
18
String
考勤机终端ID
包长度
4
String
2+N(ASCII表示的16进制数例2+N=10L=000A)
功能号
2
String
包内容
N
String
较验和
(功能号+包内容)
2
String
功能号+包内容的和取低位两个字节(ASCII表示的16进制数)
3.4包内容常见数据说明
数据名称
数据类型
数据长度
说明
可通话时长
String
6
HH’MM’SS’ASCII表示的16进制数
电话号码
String
16
TELNUM每个号码为16字节,不足16字节用空格(0x20)补足
日期
String
6
YYMMDD
时间
String
6
HHMMSS
汉字编码
String
N
规定长度为N,不足N字节用0X20(空格)补足
常用语编号
String
6
BBSSNNBB表示大类(00~09)SS表示小类(00~09)
NN表示N个常用语(00~09)
例生日祝福BB
老师类SS
老师您辛苦了祝您生日快乐!
NN
3.5包的最大长度
最大包长:
发送一包信息的最大长度小于1024字节
位数不足的情况:
左对齐,用空格(0X20)补足。
4考勤机参数配置接口包格式定义
4.1报警信息处理操作
4.1.1上传报警信息语法(由考勤机发给Server端)[03]
序号
域名
长度
类型
描述
1
同步帧
3
String
TPJ
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
03传报警信息
6
包
内
容
SIM卡卡号
16
TELNUM
第1类警情
2
机门打开有警情时发85
无警情时发55
第2类警情
2
手柄断开有警情时发85
无警情时发55
第3类警情
2
读卡头读卡失败
有警情时发85
无警情时发55
第4类警情
2
供电状态
外电供电85
电池供电55
电池电压底00
第5类警情
2
预留
7
较验和
2
功能号+包内容的和取最后两个字节
4.1.2上传报警信息应答语法(由Server发给考勤机)[03]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
03请求读取短信留言
6
包内容
2/5
OK/ERROR
7
较验和
2
4.2报警信息发送时间间隔下载
4.2.1报警信息发送时间间隔语法(由server端发给考勤机)[09]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
09下载时间间隔
6
包内容
4
单位分钟,16进制表示的ASC例:
0x000A即10分钟上传一次报警信息
7
较验和
2
功能号+包内容的和取最后两个字节
4.2.2报警信息发送时间间隔下载应答语法(由考勤机发给server端)[09]
序号
域名
长度
类型
描述
1
同步帧
3
String
TPJ
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
09时间间隔应答
6
包内容
2/5
OK/ERROR
7
较验和
2
4.3修改服务器IP地址端口号操作
4.3.1修改服务器IP地址端口号语法(由server发给考勤机端)[04]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
04修改IP地址和端口号信息
6
包
内
容
DATE
6
YYMMDD
起始日期(从此日期后开始使用新的IP地址和端口号)
IP地址
N
例218.17.104.80
逗号
1
端口号
N
例2020
逗号
1
备用IP地址
N
例121.9.230.130
逗号
1
备用端口号
N
例2020
逗号
1
备用激活标志
1
0:
不激活1:
激活
7
较验和
2
功能号+包内容的和取最后两个字节
注意:
没有IP及端口时需要填写000.000.000.000,0000
4.3.2修改服务器IP地址端口号应答语法(由考勤机发给服务器端)[04]
序号
域名
长度
类型
描述
1
同步帧
3
String
TPJ
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
04修改IP地址和端口号应答信息
6
包内容
2/5
OK/ERROR
7
较验和
2
4.4心跳包
4.4.1心跳包语法(由考勤机发给server端)[10]
序号
域名
长度
类型
描述
1
同步帧
3
String
TPJ
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
10心跳包
6
包内容
0
无包内容
7
较验和
2
功能号+包内容的和取最后两个字节
心跳包每30秒发送一次
4.4.2心跳包应答语法(由server端发给考勤机)[10]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
10心跳包
6
包内容
0
无包内容
7
较验和
2
功能号+包内容的和取最后两个字节
4.5查询考勤机状态
4.5.1查询考勤机状态语法(由server端发给考勤机)[0A]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
0A查询考勤机状态
6
包内容
6
STRING”STATUS”
7
较验和
2
功能号+包内容的和取最后两个字节
4.5.2查询考勤机状态回应语法(由考勤机发给server端)[0A]
回复内容同:
告警上报。
4.6时间校验
4.6.1时间校验语法(由考勤机发给server端)[0C]
序号
域名
长度
类型
描述
1
同步帧
3
String
TPJ
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
0C时间校验
6
包内容
0
7
较验和
2
功能号+包内容的和取最后两个字节
4.6.2时间校验语法(由server端发给考勤机)[0C]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
0C时间校验
6
包内容
14
yyyyMMddHHmmss
7
较验和
2
功能号+包内容的和取最后两个字节
5考勤机平安短信接口包格式定义
5.1上传进出校信息操作
5.1.1上传进出校信息语法(由考勤机发给server端)[08]
序号
域名
长度
类型
描述
1
同步帧
3
String
TPJ
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
08上传考勤信息
6
考勤记录总条数
2
最多30条
7
包
内
容
卡号
20
日期
6
YYMMDD
时间
6
HHMMSS
进出校
1
1进校2出校3危险区域
状态
2
学生状态(0E确定内容)(保留)
状态时间
4
HHMM(保留)
8
较验和
2
功能号+包内容的和取最后两个字节
5.1.2上传进出校信息应答语法(由server端发给考勤机)[08]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
08上传考勤信息应答
6
包内容
状态
2/5
OK/ERROR
7
较验和
2
6考勤机扩展功能接口包格式定义(可选)
6.1请求更新本机参数操作
6.1.1下传更新本机参数请求语法(由考勤机发给server端)[17]
序号
域名
长度
类型
描述
1
同步帧
3
String
TPJ
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
17下传更新本机参数请求信息
6
较验和
2
功能号+包内容的和取最后两个字节
说明:
平台收到此消息,代表本机是新机或者进行了默认设置,需要下载终端的设置参数。
6.1.2下传更新本机参数应答语法(由server端发给考勤机)[17]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
17下传更新本机参数应答
6
包内容
状态
2/5
OK/ERROR
7
较验和
2
注:
当Server收到更新本机参数请求时,下传本机基本设置的参数。
6.2请求班级列表操作
6.2.1下传班级列表请求语法(由考勤机发给server端)[18]
序号
域名
长度
类型
描述
1
同步帧
3
String
TPJ
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
18下传班级列表请求信息
6
包内容
卡号
20
卡号
7
较验和
2
功能号+包内容的和取最后两个字节
6.2.2下传班级列表应答语法(由server端发给考勤机)[18]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
18请求班级列表信息应答
6
包内容
数量
2
最多10个班级
7
编号
8
班级编号
8
内容
10
班级名称(5个汉字)
9
重复6~7
10
较验和
2
注:
只下传本老师卡所在的班级列表。
6.3上传考勤机数量和状态
6.3.1上传考勤机数量和状态请求语法(由考勤机发给server端)[21]
序号
域名
长度
类型
描述
1
同步帧
3
String
TPJ
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
21考勤机数量和状态请求
6
内容
数量
1
当前考勤机数量(0~F)
7
编号
1
考勤机编号(0~F)
8
状态
1
0:
正常1:
异常
9
重复6~7
状态
10
较验和
2
JXT123456002C20210219
JXT头
123456机器号
001B长度码=(命令字+内容)=2+1+8
20命令字(2字节)
2数量
1编号
0状态
2编号
1状态
89校验和
6.3.2上传考勤机数量和状态应答语法(由server端发给考勤机)[21]
序号
域名
长度
类型
描述
1
同步帧
3
String
TPJ
2
序号
4
流水号
3
机器号
18
考勤机ID
4
包长度
4
5
功能号
2
21考勤机数量和状态应答信息
6
包内容
状态
2/5
OK/ERROR
7
较验和
2
功能号+包内容的和取最后两个字节
TPJ123456000A20OK25
TPJ头
123456机器号
0004长度码=(命令字+内容)=2+2=4=0x0004
20命令字(2字节)
OK/ERROR内容:
状态
25校验和
6.4终端参数配置下发
6.4.1终端参数配置下发语法(由server端发给考勤机)[22]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18