中国电信家校翼通专用终端平台接口规范.docx

1、中国电信家校翼通专用终端平台接口规范中国电信家校翼通专用终端平台接口规范(讨论稿)中国电信集团公司2011年3月目 录1 缩略语 52 协议描述 63 数据类型和格式定义 73.1 数据类型定义 73.2 包格式概述 73.3 包格式布局 73.4 包内容常见数据说明 73.5 包的最大长度 84 考勤机参数配置接口包格式定义 94.1 报警信息处理操作 94.1.1 上传报警信息语法(由考勤机发给Server端) 03 94.1.2 上传报警信息应答语法(由Server发给考勤机) 03 94.2 报警信息发送时间间隔下载 104.2.1 报警信息发送时间间隔语法(由server端发给考勤机

2、) 09 104.2.2 报警信息发送时间间隔下载应答语法(由考勤机发给server端) 09 104.3 修改服务器IP地址端口号操作 114.3.1 修改服务器IP地址端口号语法(由server发给考勤机端) 04 114.3.2 修改服务器IP地址端口号应答语法(由考勤机发给服务器端) 04 124.4 心跳包 124.4.1 心跳包语法(由考勤机发给server端)10 124.4.2 心跳包应答语法(由server端发给考勤机)10 134.5 查询考勤机状态 134.5.1 查询考勤机状态语法(由server端发给考勤机) 0A 134.5.2 查询考勤机状态回应语法(由考勤机发给

3、server端) 0A 134.6 时间校验 144.6.1 时间校验语法(由考勤机发给server端) 0C 144.6.2 时间校验语法(由server端发给考勤机) 0C 145 考勤机平安短信接口包格式定义 155.1 上传进出校信息操作 155.1.1 上传进出校信息语法(由考勤机发给server端) 08 155.1.2 上传进出校信息应答语法(由server端发给考勤机) 08 156 考勤机扩展功能接口包格式定义（可选） 166.1 请求更新本机参数操作 166.1.1 下传更新本机参数请求语法(由考勤机发给server端) 17 166.1.2 下传更新本机参数应答语法(由s

4、erver端发给考勤机) 17 166.2 请求班级列表操作 176.2.1 下传班级列表请求语法(由考勤机发给server端) 18 176.2.2 下传班级列表应答语法(由server端发给考勤机) 18 176.3 上传考勤机数量和状态 186.3.1 上传考勤机数量和状态请求语法(由考勤机发给server端) 21 186.3.2 上传考勤机数量和状态应答语法(由server端发给考勤机) 21 186.4 终端参数配置下发 196.4.1 终端参数配置下发语法(由server端发给考勤机) 22 196.4.2 终端参数配置下发语法(由考勤机发给server端) 22 216.5 终

5、端软件升级程序下载 226.5.1 终端软件升级程序下载语法(由server端发给考勤机) 1F 226.5.2 终端软件升级程序下载语法应答(由考勤机发给server端) 1F 227 考勤机亲情电话接口包格式定义（可选） 247.1 学生卡老师卡请求时长短信条数操作 247.1.1 学生卡老师卡请求时长短信条数语法(由考勤机发给Server端) 01 247.1.2 学生卡老师卡请求时长短信条数应答语法(由Server发给考勤机) 01 257.2 上传话单操作 267.2.1 上传话单语法(由考勤机发给Server端) 05 267.2.2 上传话单应答语法(由server端发给考勤机)

6、 05 267.3 上学时段下发 277.3.1 上学时段下发语法(由server端发给考勤机) 0F 277.3.2 上学时段下发语法(由考勤机发给server端) 0F 277.3.3 考勤时段下发语法(由考勤机发给server端) 20 287.4 卡亲情信息更新数据发送11 287.4.1 卡亲情信息更新数据发送请求语法(由Server发给考勤机) 287.4.2 卡亲情信息更新数据发送应答语法(由考勤机发给Server) 297.5 卡亲情信息删除（全部删除）12 307.5.1 卡信息删除请求语法(由Server发给考勤机) 307.5.2 卡信息删除应答语法(由考勤机发给Serv

7、er) 307.6 卡属性应答操作 307.6.1 上传卡属性请求语法(由考勤机发给server端) 14 307.6.2 上传卡属性应答语法(由server端发给考勤机) 14 317.7 学号登录 317.7.1 学号登录语法(由考勤机发给server端) 0D 317.7.2 学号登录应答语法(由server端发给考勤机) 0D 327.8 请求学生列表操作 327.8.1 下传学生列表请求语法(由考勤机发给server端) 19 327.8.2 下传学生列表应答语法(由server端发给考勤机) 19 337.9 考勤时段下发 347.9.1 考勤时段下发语法(由server端发给考勤

8、机) 20 347.10 下传免费电话号码信息 357.10.1 下传免费电话号码请求语法(由server端发给考勤机) 1D 357.11 下传离线老师所在班级列表操作 367.11.1 下传离线老师所在班级列表请求语法(由server端发给考勤机) 1A 367.11.2 下传离线班级列表请求语法(由考勤机发给server端) 1A 367.12 下传删除离线老师所在班级列表操作 377.12.1 下传删除离线老师所在班级列表请求语法(由server端发给考勤机) 1B 377.12.2 下传删除离线老师所在班级列表请求语法(由考勤机发给server端) 1B 387.12.3 下传免费电

9、话号码应答语法(由考勤机发给server端) 1D 388 考勤机短信留言接口包格式定义（可选） 408.1 学生卡读取短信留言操作 408.1.1 学生卡读取留言请求语法(由考勤机发给Server端) 02 408.1.2 学生卡读取留言请求应答语法(由Server端发给考勤机) 02 418.2 常用短语内容下载操作 418.2.1 短信常用短语内容下载语法(由Server发给考勤机端) 06 418.2.2 短信常用短语内容下载应答语法(由考勤机发给服务器端) 06 428.3 常用短语类名下载操作 438.3.1 短信常用短语类名下载语法(由server端发给考勤机) 07 438.3

10、.2 常用短语类名下载应答语法(由考勤机发给server端) 07 448.4 考勤机发短信 448.4.1 考勤机发短信语法(由考勤机发给server端) 0B 448.4.2 考勤机发短信回应语法(由server端发给考勤机) 0B 448.5 下载公告 458.5.1 下载公告信息语法(由server端发给考勤机)1E 458.5.2 下载公告信息应答语法(由考勤机发给server端)1E 469 功能号总表 471 缩略语 SC (Service Center)：服务中心 CCST (Child-caring System Teminal)：考勤机终端，又称家校翼通终端 CCS（Chi

11、ld-caring System）：平安短信系统，又称家校翼通平台 CCSCP（Child-caring System: Communication Protocol）：平安短信系统通讯协议，又称家校翼通平台通讯协议 SRFC (Student RF Card)：学生、老师等专用的RF卡2 协议描述 平安短信系统接口采用1X协议与电信SC进行数据通讯。本质上是基于TCP/IP协议之上的应用层协议，以TCP协议进行数据传输，采用请求/应答的同步通讯模型实现。 SC使用公网地址，在某个端口侦听考勤机连接，使用认证方式建立连接。注：数据包包由终端发出后未收到响应，或终端发送不成功，终端应该间阁T秒后

12、重发，重新发送N-1次后放弃，建议T=30，N=3。3 数据类型和格式定义3.1 数据类型定义类型说明String仅限于09 和大写的AZ3.2 包格式概述包格式头体较验和同步帧序号机器号包长度功能号包内容(功能号+包内容)341842N23.3 包格式布局下面是一个完整包格式的布局：包格式 域长度类型说明头同步帧3String1、 CCST上传：同步帧=TPJ2、 SC下传： 同步帧=JTP序号4String此域表示一个序列号，使用在异步通信模式下，由消息发起者设定，应答者对应给回此序列号。序列号范围：0000ffff，循环使用。同步方式下该域保留。体机器号18String考勤机终端ID包长

13、度4String2N （ASCII表示的16进制数 例 2+N=10 L=000A）功能号2String包内容NString较验和(功能号+包内容)2String功能号+包内容的和取低位两个字节(ASCII表示的16进制数)3.4 包内容常见数据说明数据名称数据类型数据长度说明可通话时长 String6HHMMSS ASCII表示的16进制数电话号码String16TELNUM每个号码为16字节,不足16字节用空格(0x20)补足日期String6YYMMDD 时间String6HHMMSS汉字编码StringN规定长度为N,不足N字节用0X20（空格）补足常用语编号String6BBSSNN

14、 BB表示大类 (0009) SS 表示小类(0009)NN 表示N个常用语(0009)例 生日祝福 BB 老师类 SS 老师您辛苦了祝您生日快乐! NN 3.5 包的最大长度最大包长：发送一包信息的最大长度小于1024字节位数不足的情况：左对齐，用空格（0X20）补足。4 考勤机参数配置接口包格式定义4.1 报警信息处理操作4.1.1 上传报警信息语法(由考勤机发给Server端) 03序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18考勤机ID4包长度45功能号203传报警信息6包内容SIM 卡卡号16TELNUM第1类警情2机门打开 有警情时发85无警情时发55第

15、2类警情2手柄断开 有警情时发85无警情时发55第3类警情2读卡头读卡失败有警情时发85无警情时发55第4类警情2供电状态外电供电85电池供电55电池电压底00第5类警情2预留7较验和2功能号+包内容的和取最后两个字节4.1.2 上传报警信息应答语法(由Server发给考勤机) 03序号域名长度类型描述1同步帧3StringJTP2序号4流水号3机器号18考勤机ID4包长度45功能号203请求读取短信留言6包内容2/5OK / ERROR7较验和24.2 报警信息发送时间间隔下载4.2.1 报警信息发送时间间隔语法(由server端发给考勤机) 09序号域名长度类型描述1同步帧3StringJ

16、TP2序号4流水号3机器号18考勤机ID4包长度45功能号209下载时间间隔6包内容4单位分钟 ,16进制表示的ASC 例:0x000A 即10分钟上传一次报警信息7较验和2功能号+包内容的和取最后两个字节4.2.2 报警信息发送时间间隔下载应答语法(由考勤机发给server端) 09序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18考勤机ID4包长度45功能号209时间间隔应答6包内容2/5OK / ERROR7较验和24.3 修改服务器IP地址端口号操作4.3.1 修改服务器IP地址端口号语法(由server发给考勤机端) 04序号域名长度类型描述1同步帧3Stri

17、ngJTP2序号4流水号3机器号18考勤机ID4包长度45功能号204修改IP地址和端口号信息6包内容DATE6YYMMDD起始日期 (从此日期后开始使用新的IP地址和端口号)IP地址N例 218.17.104.80逗号1,端口号N例 2020逗号1,备用IP地址N例 121.9.230.130逗号1,备用端口号N例 2020逗号1,备用激活标志10:不激活 1:激活7较验和2功能号+包内容的和取最后两个字节注意：没有I及端口时需要填写000.000.000.000,0000 4.3.2 修改服务器IP地址端口号应答语法(由考勤机发给服务器端) 04序号域名长度类型描述1同步帧3StringT

18、PJ2序号4流水号3机器号18考勤机ID4包长度45功能号204修改IP地址和端口号应答信息6包内容2/5OK / ERROR7较验和24.4 心跳包4.4.1 心跳包语法(由考勤机发给server端)10序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18考勤机ID4包长度45功能号210心跳包6包内容0无包内容7较验和2功能号+包内容的和取最后两个字节心跳包每30秒发送一次4.4.2 心跳包应答语法(由server端发给考勤机)10序号域名长度类型描述1同步帧3StringJTP2序号4流水号3机器号18考勤机ID4包长度45功能号210心跳包6包内容0无包内容7较验

19、和2功能号+包内容的和取最后两个字节4.5 查询考勤机状态4.5.1 查询考勤机状态语法(由server端发给考勤机) 0A序号域名长度类型描述1同步帧3StringJTP2序号4流水号3机器号18考勤机ID4包长度45功能号20A查询考勤机状态6包内容6STRING”STATUS”7较验和2功能号+包内容的和取最后两个字节4.5.2 查询考勤机状态回应语法(由考勤机发给server端) 0A回复内容同：告警上报。4.6 时间校验4.6.1 时间校验语法(由考勤机发给server端) 0C序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18考勤机ID4包长度45功能号20

20、C时间校验6包内容07较验和2功能号+包内容的和取最后两个字节4.6.2 时间校验语法(由server端发给考勤机) 0C序号域名长度类型描述1同步帧3StringJTP2序号4流水号3机器号18考勤机ID4包长度45功能号20C 时间校验6包内容14yyyyMMddHHmmss7较验和2功能号+包内容的和取最后两个字节5 考勤机平安短信接口包格式定义5.1 上传进出校信息操作5.1.1 上传进出校信息语法(由考勤机发给server端) 08序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18考勤机ID4包长度45功能号208上传考勤信息6考勤记录总条数2最多30条7包内

21、容卡号20日期6YYMMDD时间6HHMMSS进出校11进校 2出校 3危险区域状态2学生状态（0E确定内容）（保留）状态时间4HHMM（保留）8较验和2功能号+包内容的和取最后两个字节 5.1.2 上传进出校信息应答语法(由server端发给考勤机) 08序号域名长度类型描述1同步帧3StringJTP2序号4流水号3机器号18考勤机ID4包长度45功能号208上传考勤信息应答6包内容状态2/5OK / ERROR7较验和26 考勤机扩展功能接口包格式定义（可选）6.1 请求更新本机参数操作6.1.1 下传更新本机参数请求语法(由考勤机发给server端) 17序号域名长度类型描述1同步帧3

22、StringTPJ2序号4流水号3机器号18考勤机ID4包长度45功能号217下传更新本机参数请求信息6较验和2功能号+包内容的和取最后两个字节说明：平台收到此消息，代表本机是新机或者进行了默认设置，需要下载终端的设置参数。6.1.2 下传更新本机参数应答语法(由server端发给考勤机) 17序号域名长度类型描述1同步帧3StringJTP2序号4流水号3机器号18考勤机ID4包长度45功能号217下传更新本机参数应答6包内容状态2/5OK/ERROR7较验和2注：当Server收到更新本机参数请求时，下传本机基本设置的参数。6.2 请求班级列表操作6.2.1 下传班级列表请求语法(由考勤机

23、发给server端) 18序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18考勤机ID4包长度45功能号218下传班级列表请求信息6包内容卡号20卡号7较验和2功能号+包内容的和取最后两个字节6.2.2 下传班级列表应答语法(由server端发给考勤机) 18序号域名长度类型描述1同步帧3StringJTP2序号4流水号3机器号18考勤机ID4包长度45功能号218请求班级列表信息应答6包内容数量2最多10个班级7编号8班级编号8内容10班级名称（5个汉字）9重复6710较验和2注：只下传本老师卡所在的班级列表。6.3 上传考勤机数量和状态6.3.1 上传考勤机数量和状

24、态请求语法(由考勤机发给server端) 21序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18考勤机ID4包长度45功能号221考勤机数量和状态请求6内容数量1当前考勤机数量（0F）7编号1考勤机编号（0F）8状态10：正常 1:异常9重复67状态10较验和2JXT123456002C20210219JXT 头123456 机器号001B 长度码=(命令字+内容)=2+1+8 20 命令字 (2字节)2 数量1 编号0 状态2 编号1 状态89 校验和6.3.2 上传考勤机数量和状态应答语法(由server端发给考勤机) 21序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18考勤机ID4包长度45功能号221考勤机数量和状态应答信息6包内容状态2/5OK/ERROR7较验和2功能号+包内容的和取最后两个字节TPJ123456000A20OK25 TPJ 头123456 机器号0004 长度码=(命令字+内容)=2+2=4=0x0004 20 命令字 (2字节)OK/ERROR 内容:状态25 校验和6.4 终端参数配置下发6.4.1 终端参数配置下发语法(由server端发给考勤机) 22序号域名长度类型描述1同步帧3StringJTP2序号4流水号3机器号18