爱贝通公话软件接口规范Word文件下载.docx
- 文档编号:21022520
- 上传时间:2023-01-27
- 格式:DOCX
- 页数:25
- 大小:40.23KB
爱贝通公话软件接口规范Word文件下载.docx
《爱贝通公话软件接口规范Word文件下载.docx》由会员分享,可在线阅读,更多相关《爱贝通公话软件接口规范Word文件下载.docx(25页珍藏版)》请在冰豆网上搜索。
校园学校签到/刷卡设备使用。
公话管理接口
提供公话设备的系统管理接口。
包括更新通知,程序更新,公话状态查询等。
2.3终端开机基本流程
校讯通开机上电后,会自动用GPRS登陆校讯通平台,登陆平台后终端首先会发送“公话认证[取值:
10]”消息给服务器,服务器回应“公话认证[取值:
10]”消息并自动往终端下发“公话状态查询[取值:
82]”消息给终端,终端回应“公话状态查询[取值:
82]”给服务器完成双方握手。
如果双方握手不成功,终端会自动断开与服务器的连接并自动重连。
完成以上动作后校讯通就可正常工作,终端会在空闲时每3分钟主动发送心跳包(“网络连接状态查询[取值:
05]”消息)给服务器,服务器需回应心跳包。
服务器依靠心跳包判断终端是否在线。
3数据类型和格式定义
3.1数据类型定义
类型
String
字节串。
如无特别说明则左齐右补空格(ASCII码32),字节串的最后一字符不可为空格。
VST
变化的字符串。
字符串的最大长度由协议给出。
字符串的具体长度根据PDU包头的length字段给出。
因此VST必须放在每个包的最后一个。
Integer
定长String,它由一系列的10进制字符组成(‘0’---‘9’),右齐左补‘0’(ASCII码48)。
注意:
当此类型字段字符值超过‘4294967295’时(32位无符号整数的最大值),若将其转换为32位无符号整数会产生溢出,程序员需要进行特别处理。
Date
8位定长String,格式:
YYYYMMDD
DateTime
14位定长String,格式:
YYYYMMDDHHMISS
n[DataType]
某种数据类型的列表。
前面的n用2位Integer表示。
Binary
二进制数据
3.2PDU格式概述
一个典型的信息格式如下表所示:
UASPPDU
头
体
length
func_no
seq_no
body
4
2
=(length值–10)
=(length值–4)
3.3UASPPDU布局
下面是一个完整PDU的布局:
BOSS.UASPDU域
长度
command_length
此域表示消息包的长度,UASPPDU的最大包体长度为9999字节
操作码,取值参照第6.1节
此域表示一个序列号,使用在异步通信模式下,由消息发起者设定,应答者对应给回此序列号。
序列号范围:
0000-9999,循环使用。
同步方式下该域保留。
必需参数
Mixed
PDU里必须包含的参数
seq_no字段在同步中也可以使用,使用该字段作为请求包和响应包的对应字段。
任何交易发起时,由client端产生seq_no,server收到请求后在响应包头中填入此字段内容,client端收到响应后,同发送包的该字段内容进行校验,以确认是该发送包的响应,然后继续处理。
4
公话接口定义
4.1公话认证[取值:
10]
公话认证(由公话发给Server端)
序号
域名
描述
1
DeviceId
18
公话ID
Reserved
8
保留
公话认证应答(由Server发给公话)
valid_flag
1:
认证成功
0:
认证失败
1.终端在连上服务器时要进行一次终端认证,而且要接收到认证成功后才可继续进行其他的交互动作。
2.如果终端在未认证时连接进来,SEVER端要发送认证失败的包给公话,然后再断开连接(可防止未知设备连到服务器)。
4.2“STDT_CARD_LOGIN”学生卡登录[取值:
01]
“STDT_CARD_LOGIN”学生卡登录请求语法(公话发给服务器)
Device_msisdn
15
公话手机号
Device_id
3
card_id
学生卡号
student_id
学生ID
5
request_time
14
请求时间
“STDT_CARD_LOGIN”学生卡登录应答语法
学生卡是否有效
0无效(>
0有效)
1为学生卡
2为教师卡
Family_num
亲情号码个数
Family_msisdn
n[String]
亲情号码列表
Family_relation
亲情号码关系
(汉字形式)
message_num
留言数目
6
System_time
系统时间
如果亲情号码个数为0,则亲情号码列表和关系不用发送,n=0。
4.3“STDT_READ_MSG”学生卡读取留言[取值:
02]
“STDT_READ_MSG”学生卡读取留言请求语法
“STDT_READ_MSG”学生卡读取留言应答语法
Message_len
留言长度
Message
留言内容
重复(1,2)message_num-1次(message_num的定义见4.1.2的)
4.4“CALL_BILLING”通话话单[取值:
03]
“CALL_BILLING”通话话单请求语法
device_msisdn
device_id
Call_times
话单个数
start_time
开始呼叫时间
7
called_duration
通话时长
other_party
24
被叫号码
9
重复(6,7,8)Call_times-1次
“CALL_BILLING”通话话单应答语法
0无效1有效
4.5“STDT_SIGN_RECS”学生签到记录[取值:
04]
学生签到记录请求语法
签到时间
学生签到记录应答语法
为加快考勤上报速度,终端采用滑动窗口方式进行考勤上报,一次最多能同时
上报7条考勤记录。
4.6“CONNECT_STATUS”网络连接状态查询[取值:
05]
网络连接状态查询语法(由公话发给Server端)
网络连接状态查询应答语法(由Server发给公话)
4.7“STDT_NO_LOGIN”学号登录操作[取值:
07]
“STDT_NO_LOGIN”学号登录请求语法
“STDT_NO_LOGIN”学号登录应答语法
学号是否有效
5
公话管理接口定义
5.1“UPDATE_NOTICE”程序更新通知[取值:
80]
“UPDATE_NOTICE”程序更新通知语法(由Server端发给公话)
Version
要更新的版本号
Length
更新程序的长度
“UPDATE_NOTICE”程序更新通知应答语法(由公话发给Server)
目前版本情况
0目前版本和要更新的版本不一致,要进行更新
1目前版本和要更新的版本一致,无需再更新
目前公话的版本号
5.2“UPDATE_PROGRAM”程序更新[取值:
81]
“UPDATE_PROGRAM”程序更新语法(由Server端发给公话)
Data
1024
要更新的程序数据
seq_no字段表示程序更新数据包的序号,从0开始,依次递增
“UPDATE_PROGRAM”程序更新应答语法(由公话发给Server)
数据接收错误
数据接收正确
seq_no字段表示程序更新数据包的序号
5.3“ABT_STATUS”公话状态查询[取值:
82]
“ABT_STATUS”公话状态查询语法(由Server端发给公话)
Cur_time
Server端的当前时间
“ABT_STATUS”公话状态查询应答语法(由公话发给Server)
设备ID
VersionInfo
版本信息
MinitorInfo
72
预留监控信息
注:
版本信息的格式为VERx.xxYYYY/MM/DD例如(VER1.002004/05/10)
MinitorInfo前3个字节分别代表市电状态、手柄线状态、外壳门状态
第1个字节代表市电状态:
1为外电,2为电池供电,3为电池电压低
第2个字节代表手柄线状态:
1为正常状态,2为继线状态
第3个字节代表外壳门状态:
1为关闭状态,2为打开状态
第55个字节到第72个字节(后18个字节)为短消息版本信息,格式为:
VERx.xxYYYY/MM/DD例如(VER1.002004/05/10)
5.4“GET_ADMIN_PWD”读取管理员密码[取值:
92]
读取管理员密码请求语法(由Server发给公话)
读取管理员密码应答语法(由公话发给Server)
Valid_flag
0-设备号无效
1-设备号有效
Pwd
10
密码内容
5.5“SET_ADMIN_PWD”设置管理员密码[取值:
93]
设置管理员密码请求语法(由Server发给公话)
新密码内容
设置管理员密码应答语法(由公话发给Server)
0-设置失败1-设置成功
5.6“EDIT_ABT_SET”修改终端设置[取值:
94]
修改终端参数请求语法(由Server发给公话)
edit_flag
是否修改对应的参数
1修改
0不修改
第1个字节对应IP
第2个字节对应PORT
第3个字节对应ID
sc_ip
20
SCIP地址
sc_port
Sting
SC端口号
终端ID号
修改终端参数应答语法(由公话发给Server)
0-接收失败1-接收成功
5.7“SET_ABT_RESET”设置终端重启[取值:
95]
设置终端重启请求语法(由Server发给公话)
终端号
设置终端重启应答语法(由公话发给Server)
5.8亲情号码更新同步[取值:
83]
亲情号码更新同步请求语法(由Server发给公话)
每次亲情号码更新前,需先进行同步请求,有应答才发更新数据。
亲情号码更新同步应答语法(由公话发给Server)
0-未就绪1-就绪
5.9亲情号码更新数据发送[取值:
84]
亲情号码更新数据发送请求语法(由Server发给公话)
Data_nums
更新数据的条数
type
数据的处理方式
0-删除1-增加
卡号
card_type
卡属性
0-学生1-教师
亲情号码
重复(2,3,4,5,6)Data_nums-1次
如果要传输的数据量较大,则进行分次传输。
一次传输的数据条数不大于20条(数据包大小控制在1K内)。
亲情号码更新数据发送应答语法(由公话发给Server)
5.10亲情号码删除(全部删除)[取值:
85]
亲情号码删除请求语法(由Server发给公话)
Card_type
卡属性为0时,删除所有学生的卡信息,卡属性为1时,删除所有教师的卡信息
亲情号码删除应答语法(由公话发给Server)
0-删除失败1-删除成功
5.11亲情号码删除卡信息(删除某个卡信息)[取值:
86]
亲情号码删除卡信息请求语法(由Server发给公话)
卡属性为0时,删除指定学生的卡ID信息,卡属性为1,删除指定教师的卡ID信息
亲情号码删除卡信息应答语法(由公话发给Server)
5.12发送短消息[取值:
06]
发送短消息请求语法(由公话发给Server端)
目标手机号
Request_time
Sms_Asicc_Cont
140
短消息(Asicc编码)
发送短消息应答语法(由Server发给公话端)
0-发送失败
1-发送成功
5.13更新短消息类型[取值:
89]
更新短消息类型请求语法(由Server发给公话)
Sms_type
短消息类型号
Type
1-更新(增加)2-删除
Sms_type_text
12
短消息类型提示内容
更新短消息类型应答语法(由公话发给Server)
0-更新失败1-更新成功
5.14更新短消息[取值:
90]
更新短消息请求语法(由Server发给公话)
Sms_id
短消息索引号
Sms_Text_Cont
短消息内容(asicc字符)
Sms_Unicode_Cont
短消息内容(unicode编码)
更新短消息应答语法(由公话发给Server)
3
5.15更新短消息版本[取值:
91]
更新短消息版本请求语法(由Server发给公话)
短消息版本号
更新短消息版本应答语法(由公话发给Server)
5.16巡检注册与修改手机号[取值:
62]
巡检注册与修改手机号请求语法(由公话发给Server)
Dev_IMEI
IMEI
TeleNum
11
巡检员手机号码
巡检注册与修改手机号应答语法(由Server发给公话)
Intege
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 爱贝通 公话 软件 接口 规范