甘肃万维家校通终端接口标准规范.doc

甘肃电信家校通终端接口规范

CDMA家校通

甘肃万维信息技术有限公司
-3

目录
CDMA家校通 1
1 缩略语 4
2 合同描述 5
3 数据类型和格式定义 6
3.1 数据类型定义 6
3.2 包格式概述 6
3.3 包格式布局 6
3.4 包内容常用数据阐明 6
3.5 包最大长度 7
4 公话通信接口包格式定义 8
4.1 学生卡教师卡祈求时长短信条数操作 8
4.1.1 学生卡教师卡祈求时长短信条数语法(由公话发给Server端) [01] 8
4.1.2 学生卡教师卡祈求时长短信条数应答语法(由Server发给公话) [01] 9
4.2 学生卡读取短信留言操作 9
4.2.1 学生卡读取留言祈求语法(由公话发给Server端) [02] 9
4.2.2 学生卡读取留言祈求应答语法(由Server端发给公话) [02] 10
4.3 报警信息解决操作 11
4.3.1 传报警信息语法(由公话发给Server端) [03] 11
4.3.2 传报警信息应答语法(由Server发给公话) [03] 11
4.4 修改服务器IP地址端标语操作 12
4.4.1 修改服务器IP地址端标语语法(由server发给公话端) [04] 12
4.4.2 修改服务器IP地址端标语应答语法(由公话发给服务器端) [04] 13
4.5 上传话单操作 14
4.5.1 上传话单语法(由公话发给Server端) [05] 14
4.5.2 上传话单应答语法(由server端发给公话) [05] 14
4.6 上传进出校信息操作 15
4.6.1 上传进出校信息语法(由公话发给server端) [08] 15
4.6.2 上传进出校信息应答语法(由server端发给公话) [08] 16
4.7 报警信息发送时间间隔下载 16
4.7.1 报警信息发送时间间隔语法(由server端发给终端) [09] 16
4.7.2 报警信息发送时间间隔下载应答语法(由公话发给server端) [09] 17
4.8 查询终端话机状态 17
4.8.1 查询终端话机状态语法(由server端发给终端) [0A] 17
4.8.2 查询终端话机状态回应语法(由公话发给server端) [0A] 17
4.9 时间校验 18
4.9.1 时间校验语法(由公话发给server端) [0C] 18
4.9.2 时间校验语法(由server端发给公话) [0C] 18
4.10 学号登录 19
4.10.1 学号登录语法(由公话发给server端) [0D] 19
4.10.2 学号登录应答语法(由server端发给公话) [0D] 19
4.11 心跳包 20
4.11.1 心跳包语法(由公话发给server端)[10] 20
4.11.2 心跳包应答语法(由server端发给公话)[10] 20
5 功能号总表 21
1 缩略语
l SC (Service Center)：服务中心
l CCST (Child-caring System Teminal)：亲情电话公话终端，又称家校通终端
l CCS（Child-caring System）：亲情电话系统，又称家校通平台
l CCSCP（Child-caring System：Communication Protocol）：亲情电话系统通讯合同，又称家校通平台通讯合同
l SRFC (Student RF Card)：学生、教师等专用RF卡

2 合同描述
l 亲情电话公话接口采用1X合同与电信SC进行数据通讯。本质上是基于TCP/IP合同之上应用层合同，以TCP合同进行数据传播，采用祈求/应答同步通讯模型实现。
l 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=10 L=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
BBSSNN BB表达大类 (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
例
逗号
1
,
备用IP地址
N
例 121.9.168.80
逗号
1
,
备用端标语
N
例
逗号
1
,
备用激活标志
1
0:不激活 1:激活
7
较验和
2
功能号+包内容和取最后两个字节

注意：没有IＰ及端口时需要填写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时，有加餐和吃药时间。上学时可以输入各种状态或者状态时间（分几条消息上报）。需要定期发短信给教师提示。当输入结束后，终端发状态值01到平台，做考勤数据。
出校： 1、当身份得到验证成功，直接按确认键，状态值为01，进出校值为2，此时需要发送短信；
2、当身份得到验证失败，直接按取消键，状态值为99，进出校值为2，此时不需要发送短信（小孩不可以被接出校，也可以平台设立与否发短信）；
教师卡：教师刷卡输入状态值。状态值:06 ：考勤上班07 ：调体 08 ：公出

4.6.2 上传进出校信息应答语法(由server端发给公话) [08]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18
公话ID
4
包长度
4

5
功能号
2
08上传考勤信息应答
6
包内容
状态
2/5
OK / ERROR
7
较验和
2

4.7 报警信息发送时间间隔下载
4.7.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.7.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.8 查询终端话机状态
4.8.1 查询终端话机状态语法(由server端发给终端) [0A]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18
公话ID
4
包长度
4

5
功能号
2
0A查询终端话机状态
6
包内容
6
STRING”STATUS”
7
较验和
2
功能号+包内容和取最后两个字节

4.8.2 查询终端话机状态回应语法(由公话发给server端) [0A]
回答内容同：告警上报。

4.9 时间校验
4.9.1 时间校验语法(由公话发给server端) [0C]
序号
域名
长度
类型
描述
1
同步帧
3
String
TPJ
2
序号
4
流水号
3
机器号
18
公话ID
4
包长度
4

5
功能号
2
0C时间校验
6
包内容
0

7
较验和
2
功能号+包内容和取最后两个字节

4.9.2 时间校验语法(由server端发给公话) [0C]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18
公话ID
4
包长度
4

5
功能号
2
0C 时间校验
6
包内容
14
yyyyMMddHHmmss
7
较验和
2
功能号+包内容和取最后两个字节

4.10 学号登录
4.10.1 学号登录语法(由公话发给server端) [0D]
序号
域名
长度
类型
描述
1
同步帧
3
String
TPJ
2
序号
4
流水号
3
机器号
18
公话ID
4
包长度
4

5
功能号
2
0D学号登录
6
包内容
8
学生ID
7
较验和
2
功能号+包内容和取最后两个字节

注意：学生ID用10进制数字表达，不满8位在右边用“F”补齐。

4.10.2 学号登录应答语法(由server端发给公话) [0D]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18
公话ID
4
包长度
4

5
功能号
2
0D祈求通话时长和短信条数以及亲情号码
6
包
内
容
时长
6
HH’MM’SS’
亲情称呼
10*6
如”爸爸”，5个中文
亲情号码
16*6
TELNUM
7
较验和
2
功能号+包内容和取最后两个字节

学号登录：是在教师刷卡后，终端收到平台返回卡属性2后来，提示教师输入学生学号获取学生家长亲情号码。

4.11 心跳包
4.11.1 心跳包语法(由公话发给server端)[10]
序号
域名
长度
类型
描述
1
同步帧
3
String
TPJ
2
序号
4
流水号
3
机器号
18
公话ID
4
包长度
4

5
功能号
2
10心跳包
6
包内容
0
无包内容
7
较验和
2

功能号+包内容和取最后两个字节

心跳包每30秒发送一次
4.11.2 心跳包应答语法(由server端发给公话)[10]
序号
域名
长度
类型
描述
1
同步帧
3
String
JTP
2
序号
4
流水号
3
机器号
18
公话ID
4
包长度
4

5
功能号
2
10心跳包
6
包内容
0
无包内容
7
较验和
2

功能号+包内容和取最后两个字节

5 功能号总表

序号
功能号
描述
备注
1
01
祈求通话时长和短信条数

2
02
祈求读取留言

3
03
传报警信息

4
04
修改IP地址、端标语和终端ID信息

5
05
上传话单

6
06
下载惯用短语

7
07
下载惯用短语类名

8
08
上传考勤信息

9
09
下载告警信息上传时间间隔

10
0A
查询终端话机状态

11
0B
发短信息

12
0C
时间校验

13
0D
学号登录

14
0E
学生状态下发
幼教特有
15
0F
上学时段下发

16
10
心跳包

17
11
卡亲情信息更新数据

18
12
卡亲情信息删除

19
13
上传学生身份验证
幼教特有
20
14
上传卡属性祈求信息

21
15
祈求家长布置任务信息
幼教特有
22
16
完毕家长布置任务信息
幼教特有
23
17
下传更新本机参数祈求信息

24
18
下传班级列表祈求信息

25
19
祈求学生列表信息应答

26
1A
离线教师所在班级列表信息祈求

27
1B
删除离线教师所在班级列表信息祈求

28
1C
下传任务终端语音提示应答信息

29
1D
下载免费号码

30
1E
公示内容显示

31
1F
终端升级程序下栽
先不做
32
20
考勤时段下发

33
21
上传考勤机数量和状态
新增(幼教已经增长)
34
22
终端参数配备
新增

阐明：在本来版本基本上增长了合同。用总表中用红色表达。