甘肃万维家校通终端接口规范.docx
《甘肃万维家校通终端接口规范.docx》由会员分享,可在线阅读,更多相关《甘肃万维家校通终端接口规范.docx(23页珍藏版)》请在冰豆网上搜索。
甘肃万维家校通终端接口规范
电信家校通终端接口规
CDMA家校通
万维信息技术
2012-3
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端)[01]
序号
域名
长度
类型
描述
1
同步帧
3
String
TPJ
2
序号
4
流水号
3
机器号
18
公话ID
4
包长度
4
5
功能号
2
01请求通话时长和短信条数
6
包容
20
卡号
7
较验和
2
4.1.2学生卡老师卡请求时长短信条数应答语法(由Server发给公话)[01]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18
公话ID
4
包长度
4
5
功能号
2
01请求通话时长和短信条数以及亲情
6
包
容
卡是否有效
1
0无效(>0有效)
1、学生卡2、教师卡
3、家长卡4、园长卡
9、巡检卡
时长
6
HH’MM’SS’
留言条数
2
亲情称呼
10*6
如”爸爸”5个汉字
亲情
16*6
TELNUM
7
较验和
2
功能号+包容的和取最后两个字节
说明:
没有老师卡亲情和亲情称呼,填空格补齐
4.2学生卡读取短信留言操作
4.2.1学生卡读取留言请求语法(由公话发给Server端)[02]
序号
域名
长度
类型
描述
1
同步帧
3
String
TPJ
2
序号
4
流水号
3
机器号
18
公话ID
4
包长度
4
5
功能号
2
02请求读取留言
6
包容
20
卡号
7
较验和
2
4.2.2学生卡读取留言请求应答语法(由Server端发给公话)[02]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18
公话ID
4
包长度
4
5
功能号
2
02读取留言
6
包
容
短信条数
2
每次下传的短信条数不大于10条,每条最多70个汉字。
第i条短信的长度码
2
i.len=(2+16+12+N),len为ASCII表示十六进制数
第i条短信的发信人
16
TELNUM
第i条短信的发信日期时间
12
YYMMDDHHMMSS
第i条短信的容
N
短信容为ASCII表示的码
第i+1条短信的长度码
.
.
.
第…….容
7
较验和
2
功能号+包容的和取最后两个字节
4.3报警信息处理操作
4.3.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.3.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.4修改服务器IP地址端口号操作
4.4.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.168.80
逗号
1
备用端口号
N
例2020
逗号
1
备用激活标志
1
0:
不激活1:
激活
7
较验和
2
功能号+包容的和取最后两个字节
注意:
没有IP及端口时需要填写000.000.000.000,0000
4.4.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.5上传话单操作
4.5.1上传话单语法(由公话发给Server端)[05]
序号
域名
长度
类型
描述
1
同步帧
3
String
TPJ
2
序号
4
流水号
3
机器号
18
公话ID
4
包长度
4
5
功能号
2
05上传话单
6
包
容
卡号
20
日期
6
YYMMDD
时间
6
HHMMSS
通话时长
6
HH’MM’SS’
16
TELNUM
7
较验和
2
功能号+包容的和取最后两个字节
4.5.2上传话单应答语法(由server端发给公话)[05]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18
公话ID
4
包长度
4
5
功能号
2
05上传话单回应
6
包容
2/5
OK/ERROR
7
较验和
2
4.6上传进出校信息操作
4.6.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出校
状态
2
学生状态(0E确定容)(保留)
状态时间
4
HHMM(保留)
8
较验和
2
功能号+包容的和取最后两个字节
附:
关于包容-状态值的说明:
协议兼容幼教通版本,家校通版本此状态(学生状态)值可随意填写。
幼教通版本说明:
学生进出校用家长卡。
其他教师卡、园长卡等用于考勤。
家长卡:
状态值:
01:
健康(正常)02:
加餐03:
吃药
进校:
不按状态或者按确认键,状态值为01,进出校值为1,此时需要发送短信(根据不同的状态值发短信给家长和老师)。
进出校值为1,状态值为2或者3时,有加餐和吃药时间。
上学时可以输入多个状态或者状态时间(分几条消息上报)。
需要定时发短信给老师提醒。
当输