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

甘肃电信家校通终端接口规范CDMA家校通甘肃万维信息技术有限公司-3目录CDMA家校通11缩略语42合同描述53数据类型和格式定义63.1数据类型定义63.2包格式概述63.3包格式布局63.4包内容常用数据阐明63.5包最大长度74公话通信接口包格式定义84.1学生卡教师卡祈求时长短信条数操作84.1.1学生卡教师卡祈求时长短信条数语法(由公话发给Server端) 0184.1.2学生卡教师卡祈求时长短信条数应答语法(由Server发给公话) 0194.2学生卡读取短信留言操作94.2.1学生卡读取留言祈求语法(由公话发给Server端) 0294.2.2学生卡读取留言祈求应答语法(由Server端发给公话) 02104.3报警信息解决操作114.3.1传报警信息语法(由公话发给Server端) 03114.3.2传报警信息应答语法(由Server发给公话) 03114.4修改服务器IP地址端标语操作124.4.1修改服务器IP地址端标语语法(由server发给公话端) 04124.4.2修改服务器IP地址端标语应答语法(由公话发给服务器端) 04134.5上传话单操作144.5.1上传话单语法(由公话发给Server端) 05144.5.2上传话单应答语法(由server端发给公话) 05144.6上传进出校信息操作154.6.1上传进出校信息语法(由公话发给server端) 08154.6.2上传进出校信息应答语法(由server端发给公话) 08164.7报警信息发送时间间隔下载164.7.1报警信息发送时间间隔语法(由server端发给终端) 09164.7.2报警信息发送时间间隔下载应答语法(由公话发给server端) 09174.8查询终端话机状态174.8.1查询终端话机状态语法(由server端发给终端) 0A174.8.2查询终端话机状态回应语法(由公话发给server端) 0A174.9时间校验184.9.1时间校验语法(由公话发给server端) 0C184.9.2时间校验语法(由server端发给公话) 0C184.10学号登录194.10.1学号登录语法(由公话发给server端) 0D194.10.2学号登录应答语法(由server端发给公话) 0D194.11心跳包204.11.1心跳包语法(由公话发给server端)10204.11.2心跳包应答语法(由server端发给公话)10205功能号总表211 缩略语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仅限于09 和大写AZ3.2 包格式概述包格式头体较验和同步帧序号机器号包长度功能号包内容(功能号+包内容)341842N23.3 包格式布局下面是一种完整包格式布局：包格式 域长度类型阐明头同步帧3String1、 CCST上传：同步帧=TPJ2、 SC下传： 同步帧=JTP序号4String此域表达一种序列号，使用在异步通信模式下，由消息发起者设定，应答者相应给回此序列号。序列号范畴：0000ffff，循环使用。同步方式下该域保存。体机器号18String亲情电话公话终端ID包长度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 BB表达大类 (0009) SS 表达小类(0009)NN 表达N个惯用语(0009)例 生日祝愿 BB 教师类 SS 教师您辛苦了祝您生日高兴！NN 3.5 包最大长度最大包长：发送一包信息最大长度不大于1024字节位数局限性状况：左对齐，用空格（0X20）补足。4 公话通信接口包格式定义4.1 学生卡教师卡祈求时长短信条数操作4.1.1 学生卡教师卡祈求时长短信条数语法(由公话发给Server端) 01序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18公话ID4包长度45功能号201祈求通话时长和短信条数6包内容20卡号7较验和24.1.2 学生卡教师卡祈求时长短信条数应答语法(由Server发给公话) 01序号域名长度类型描述1同步帧3StringJTP2序号4流水号3机器号18公话ID4包长度45功能号201祈求通话时长和短信条数以及亲情号码6包内容卡与否有效10 无效 (0 有效)1、学生卡2、教师卡3、家长卡4、园长卡9、巡检卡时长6HHMMSS留言条数2亲情称呼10*6如”爸爸”5个中文亲情号码16*6TELNUM7较验和2功能号+包内容和取最后两个字节阐明：没有教师卡亲情号码和亲情称呼，填空格补齐4.2 学生卡读取短信留言操作4.2.1 学生卡读取留言祈求语法(由公话发给Server端) 02序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18公话ID4包长度45功能号202祈求读取留言6包内容20卡号7较验和24.2.2 学生卡读取留言祈求应答语法(由Server端发给公话) 02 序号域名长度类型描述1同步帧3StringJTP2序号4流水号3机器号18公话ID4包长度45功能号202读取留言6包内容短信条数2每次下传短信条数不不不大于10条，每条最多70个中文。第i条短信长度码2i.len=(2+16+12+N)，len为ASCII表达十六进制数第i条短信发信人电话号码16TELNUM第i条短信发信日期时间12YYMMDDHHMMSS第i条短信内容N短信内容为ASCII表达内码第i+1条短信长度码.第.内容7较验和2功能号+包内容和取最后两个字节 4.3 报警信息解决操作4.3.1 传报警信息语法(由公话发给Server端) 03序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18公话ID4包长度45功能号203传报警信息6包内容SIM 卡卡号16TELNUM第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同步帧3StringJTP2序号4流水号3机器号18公话ID4包长度45功能号203祈求读取短信留言6包内容2/5OK / ERROR7较验和2 4.4 修改服务器IP地址端标语操作4.4.1 修改服务器IP地址端标语语法(由server发给公话端) 04序号域名长度类型描述1同步帧3StringJTP2序号4流水号3机器号18公话ID4包长度45功能号204修改IP地址和端标语信息6包内容DATE6YYMMDD起始日期 (从此日期后开始使用新IP地址和端标语)IP地址N例 218.17.104.80逗号1,端标语N例 逗号1,备用IP地址N例 121.9.168.80逗号1,备用端标语N例 逗号1,备用激活标志10:不激活 1:激活7较验和2功能号+包内容和取最后两个字节 注意：没有I及端口时需要填写000.000.000.000,0000 4.4.2 修改服务器IP地址端标语应答语法(由公话发给服务器端) 04序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18公话ID4包长度45功能号204修改IP地址和端标语应答信息6包内容2/5OK / ERROR7较验和24.5 上传话单操作4.5.1 上传话单语法(由公话发给Server端) 05序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18公话ID4包长度45功能号205上传话单6包内容卡号20日期6YYMMDD时间6HHMMSS通话时长6HHMMSS号码16TELNUM7较验和2功能号+包内容和取最后两个字节4.5.2 上传话单应答语法(由server端发给公话) 05序号域名长度类型描述1同步帧3StringJTP2序号4流水号3机器号18公话ID4包长度45功能号205 上传话单回应6包内容2/5OK / ERROR7较验和24.6 上传进出校信息操作4.6.1 上传进出校信息语法(由公话发给server端) 08序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18公话ID4包长度45功能号208上传考勤信息6考勤记录总条数2最多30条7包内容卡号20日期6YYMMDD时间6HHMMSS进出校11进校 2出校状态2学生状态（0E拟定内容）（保存）状态时间4HHMM（保存）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同步帧3StringJTP2序号4流水号3机器号18公话ID4包长度45功能号208上传考勤信息应答6包内容状态2/5OK / ERROR7较验和24.7 报警信息发送时间间隔下载4.7.1 报警信息发送时间间隔语法(由server端发给终端) 09序号域名长度类型描述1同步帧3StringJTP2序号4流水号3机器号18公话ID4包长度45功能号209下载时间间隔6包内容4单位分钟 ,16进制表达ASC 例:0x000A 即10分钟上传一次报警信息7较验和2功能号+包内容和取最后两个字节4.7.2 报警信息发送时间间隔下载应答语法(由公话发给server端) 09序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18公话ID4包长度45功能号209时间间隔应答6包内容2/5OK / ERROR7较验和24.8 查询终端话机状态4.8.1 查询终端话机状态语法(由server端发给终端) 0A序号域名长度类型描述1同步帧3StringJTP2序号4流水号3机器号18公话ID4包长度45功能号20A查询终端话机状态6包内容6STRING”STATUS”7较验和2功能号+包内容和取最后两个字节4.8.2 查询终端话机状态回应语法(由公话发给server端) 0A回答内容同：告警上报。4.9 时间校验4.9.1 时间校验语法(由公话发给server端) 0C序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18公话ID4包长度45功能号20C时间校验6包内容07较验和2功能号+包内容和取最后两个字节4.9.2 时间校验语法(由server端发给公话) 0C序号域名长度类型描述1同步帧3StringJTP2序号4流水号3机器号18公话ID4包长度45功能号20C 时间校验6包内容14yyyyMMddHHmmss7较验和2功能号+包内容和取最后两个字节4.10 学号登录4.10.1 学号登录语法(由公话发给server端) 0D序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18公话ID4包长度45功能号20D学号登录6包内容8学生ID7较验和2功能号+包内容和取最后两个字节注意：学生ID用10进制数字表达，不满8位在右边用“F”补齐。4.10.2 学号登录应答语法(由server端发给公话) 0D序号域名长度类型描述1同步帧3StringJTP2序号4流水号3机器号18公话ID4包长度45功能号20D祈求通话时长和短信条数以及亲情号码6包内容时长6HHMMSS亲情称呼10*6如”爸爸”，5个中文亲情号码16*6TELNUM7较验和2功能号+包内容和取最后两个字节学号登录：是在教师刷卡后，终端收到平台返回卡属性2后来，提示教师输入学生学号获取学生家长亲情号码。4.11 心跳包4.11.1 心跳包语法(由公话发给server端)10序号域名长度类型描述1同步帧3StringTPJ2序号4流水号3机器号18公话ID4包长度45功能号210心跳包6包内容0无包内容7较验和2功能号+包内容和取最后两个字节心跳包每30秒发送一次4.11.2 心跳包应答语法(由server端发给公话)10序号域名长度类型描述1同步帧3StringJTP2序号4流水号3机器号18公话ID4包长度45功能号210心跳包6包内容0无包内容7较验和2功能号+包内容和取最后两个字节5 功能号总表序号功能号描述备注101祈求通话时长和短信条数202祈求读取留言303传报警信息404修改IP地址、端标语和终端ID信息505上传话单606下载惯用短语707下载惯用短语类名808上传考勤信息909下载告警信息上传时间间隔100A查询终端话机状态110B发短信息120C时间校验130D学号登录140E学生状态下发幼教特有150F上学时段下发1610心跳包1711卡亲情信息更新数据1812卡亲情信息删除1913上传学生身份验证幼教特有2014 上传卡属性祈求信息2115祈求家长布置任务信息幼教特有2216完毕家长布置任务信息幼教特有2317 下传更新本机参数祈求信息2418下传班级列表祈求信息2519祈求学生列表信息应答261A离线教师所在班级列表信息祈求271B删除离线教师所在班级列表信息祈求281C下传任务终端语音提示应答信息291D下载免费号码301E公示内容显示311F终端升级程序下栽先不做3220考勤时段下发3321上传考勤机数量和状态新增(幼教已经增长)3422终端参数配备新增阐明：在本来版本基本上增长了合同。用总表中用红色表达。