短信中心与CRM的接口规范-摘自联通集团规范(SMC,SACP均可参考).doc

SMSC与BSS用户状态同步接口1 TCP协议接口1.1 连接方式BSS与SMSC之间采用长连接方式，BSS作为客户端，SMSC作为服务器端，由客户端主动发起建立连接并通过连接保持消息包，维护连接。当客户端要发送命令时，主动向服务器端建立连接，然后向服务器端发送命令，并接收应答；服务器端从客户端接收命令，返回应答。客户端可以同时向服务器端建立多个连接（暂定8条，可配置）；命令及其应答之间的时间间隔最大不能超过3秒（默认，可配置），超时需要重发（重发3次，可配置）；双方在没有消息传递时发送消息维持包保持通讯状态。1.2 包头流水号规则BSS与SMSC之间传输的每一条命令都有一个流水号，流水号由发起方产生并唯一标记一条命令；也就是说，BSS与SMSC中任何两个命令的流水号都不相同。需要注意的是，一条命令在发送过程中重试的不同副本，应视为一条命令，使用相同的流水号。流水号由0开始，循环进位，直到进位满了之后再清零，重新开始计数。接收方在返回应答时，应答的流水号必须和相对应的命令的流水号相同。1.3 消息定义项目说明消息头消息头部分消息体消息体部分1.4 数据类型类型说明Integer 无符号整数Text定长字符串，左对齐存储，空余位置补“0”1.5 消息头字段类型长度（字节）定长说明Message LengthInteger4消息的总长度(字节)Command IDInteger4命令IDSequence NumberInteger4流水号1.6 Command ID定义Command ID名称Command ID取值Bind0x00000001Bind_Resp0x80000001Unbind0x00000002Unbind_Resp0x80000002User_Info0x00000003User_Info_Resp0x80000003Keep_Alive0x00000004Keep_Alive_Resp0x800000041.7 消息体说明一个数据包总长度不可大于10k。对存在多条返回记录的业务，一数据包可含多条记录。长度如超过10K，应以多包数据发送。1.8 Bind操作Bind操作用于在客户端和服务器之间建立连接。Bind操作由Bind命令和Bind_Resp应答组成。客户端首先发送Bind命令，服务器端收到Bind命令后，对命令发送方进行验证，然后返回Bind_Resp应答。1.8.1 Bind命令的语法字段类型长度（字节）说明Login NameText16服务器端给客户端分配的登录名Login PasswordText16服务器端和Login Name对应的密码ReserveText8保留，扩展用1.8.2 Bind_Resp应答的语法字段类型长度（字节）说明ResultInteger1Bind执行命令是否成功。0：执行成功执行失败时填写错误代码（详见 附录A）ReserveText8保留，扩展用1.9 Unbind操作Unbind操作由Unbind命令和Unbind_Resp应答组成。通信连接建立以后，客户端如果要停止通信，需要发送Unbind命令；服务器端收到Unbind命令后，向客户端发送Unbind_Resp相应，然后双方断开连接。1.9.1 Unbind命令的语法Unbind命令没有消息体。1.9.2 Unbind_Resp应答的语法Unbind_Resp应答没有消息体。1.10 User_Info操作User_Info操作由User_Info命令和User_Info_Resp应答组成。通信连接建立以后，User_Info命令用于BSS向SMSC系统传送用户状态有新变化的记录，可以1次传送多条记录；SMSC系统服务器收到User_Info命令数据后，进行用户数据处理，处理完成后，向客户端发送User_Info_Resp信息，包含记录处理结果和出错原因代码信息。1.10.1 User_Info语法字段说明字段类型长度（字节）备注Count记录数Integer4保留，取值固定1。SequenceId记录流水号Integer4命令内流水号MessageID工单号Text18SMSC不处理SubscrbStat用户状态操作Text5用户状态改变类型：91001-新建用户，91002-改号要求CRM按下面次序执行:先退定旧号码定购关系再发改号消息再发新号码定购，91003-销户，91004-预约销户，91005-取消预约销户，91009-开机，91010-营业停机，91011-欠费停机,91020-过户,91030-修改用户信息,91090-其他，备用除91001和91003、91030外，其他SMC不处理OptrAreaID营业员地域编码Text8SMSC不处理OptrID营业员工号Text20SMSC不处理AcptSiteID受理点代码Text20SMSC不处理ChangeTime用户状态改变时间Text14SMSC不处理MDNMDNText21用户号码IMSIIMSIText15用户IMSI号码Old_MDN旧MDNText21SMSC不处理Old_SubscrbStat用户原有状态Text2SMSC不处理UserStat用户状态Text2SMSC不处理UserType用户付费类型Text1用户付费类型0 后付费1 预付费Userbrand用户品牌Text5SMSC不处理UserSCPTypeSCP或OCS用户Text1预用户付费SCP或OCS属性0 SCP1 OCSUserPrepaidID用户归属的SCP/OCSIDText16用户归属的OCSID/SCPID。OCSID和SCPID由谁提供？-OCSuserServiceType用户服务类型Integer10：3G用户1：2G用户2：PSTN用户3：宽带用户4：NGN（软交换）用户5：PHS用户6：大灵通用户7：IPTV用户其他预留.SMSC只支持取值为0、1的情况。Reserve1保留Text40保留，扩展用Reserve2保留Text40保留，扩展用1.10.2 User_Info_Resp语法User_Info_Resp消息体包含n条记录(n=0)字段说明字段类型长度（字节）备注Count记录数Integer4保留，取值1。SequenceId记录流水号Integer4命令内流水State_Flag记录处理状态Integer1十进制数字，0成功，1失败Error_Reason错误代码Integer3State_Flag=1时有效，填写错误代码（详见 附录A）Reserve保留字段Text8保留，扩展用1.11 链路检测包KeepAlive与KeepAlive _Resp按照本接口规定，客户端主动向服务器端成功建立连接之后，如果服务器端检测出连接长时间空闲(默认60秒，可配置)，可以主动断开该连接。因此，客户端如果在60秒之内没有数据发送，可以发送keepalive包，服务器端收到keepalive包后返回相应的keepalive响应包，从而维持了连接。KeepAlive与KeepAlive_Resp只有包头，没有包体。2 文件接口协议2.1 文件目录BSS将请求文件放到SMSC的指定目录下，SMSC接收文件并处理后，根据处理情况将回执放到SMSC相应回执目录下由BSS获取。 存放批量请求文件工作目录：/request/add 存放全量核对文件工作目录：/request/all 存放正确回执文件工作目录：/response/right/add 存放全量正确回执文件工作目录：/response/right/all 存放文件级错误回执文件工作目录：/response/bad/add 存放全量文件级错误回执文件工作目录：/response/bad/all 存放记录级错误回执文件工作目录：/response/semiwrong其中/right和/bad目录下只有文件头，没有文件体；/semiwrong目录下既有文件头，也有文件体，文件体表示错误记录。2.2 文件命名批量文件名按如下规则命名：useryyyymmddhhmmxxxnnnn.ttt，useryyyymmddhhmmxxxnnnn.endyyyymmddhhmm为文件产生的年月日时分。xxx为省分代码。nnnn 是4位序列号，每天从和VAC不一致，用文件名后缀标示文件操作（是否可读）状态“0001”开始，到达“9999”后又从“0001”开始。ttt表示文件类型，req表示请求，res表示请求结果。每一个req文件都应该有一个res文件与其对应。res类型的文件中包含与req类型文件中每一个请求对应的联机指令的执行结果。useryyyymmddhhmmxxxnnnn.end表示批量文件对应的结束文件，SMSC检测到结束文件后再处理对应的批量文件。这样做是为了避免出现SMSC检测到了批量文件，但是文件还在传输过程中，SMSC此时处理文件的话，可能会造成错误。结束文件与批量文件仅后缀不同。例：user2009031200001230001.req对应的结束文件为user2009031200001230001.end。全量文件名按如下规则命名：all_useryyyymmddhhmmxxxnnnn.ttt，all_useryyyymmddhhmmxxxnnnn.end2.3 文件格式文件采用ASCII文本格式，联机命令文件体中每条记录的属性值按顺序排列，各属性间使用t分隔，在生成记录时若相应的属性值为空，直接用分隔符隔开，分隔符之间无其他符号。文件体中一行作为一条联机命令记录，各条记录之间用换行符作为分隔并在文件中连续书写，文件体不定长。文件的删除与备份由SMSC负责。u 请求文件头序号属性名长度备注1文件序列号CHAR(4)从0001开始，排满9999后重新循环。2版本信息CHAR(5)缺省：000003文件产生时间CHAR (14)yyyymmddhhmmss4文件生成方系统代码CHAR(3)1045文件采集方系统代码CHAR(3)9026用户归属地代码CHAR(3)省分代码7总记录数CHAR(10)右对齐，左补08备用CHAR(40)9换行CHAR(1)nu 回执文件头序号属性名长度备注1文件序列号CHAR(4)回执所对应的请求文件的序列号2版本信息CHAR(5)缺省：000003文件产生时间CHAR (14)yyyymmddhhmmss4文件生成方系统代码CHAR(3)9025文件采集方系统代码CHAR(3)1046用户归属地代码CHAR(3)省分代码7总记录数CHAR(10)右对齐，左补08错误记录数CHAR(10)文件级错误填全0。记录级错误填错误记录数，右对齐，左补09反馈结果代码CHAR(3)文件级错误填错误代码（详见 附录A），记录级错误填全010正确记录数CHAR(10)右对齐，左补011备用CHAR(40)12换行CHAR(1)nu 请求文件体序号参数名说明参数类型最大长度必填1SequenceId流水号CHAR12M2MDN用户MDN号，加86CHAR20M3IMSI用户IMSI号CHAR15M4UserType用户类型0 后付费1 预付费CHAR1M5UserStat用户状态CHAR2M6Userbrand用户品牌CHAR5M7UserSCPType预用户付费SCP或OCS属性:0 SCP1 OCS如果是预付费用户，则该字段必填。CHAR1O8UserPrepaidID用户归属的SCP/OCS IDCHAR20O9UpdateDate营帐最后更新时间CHAR14M10userServiceType用户服务类型，0：3G用户1：2G用户2：PSTN用户3：宽带用户4：NGN（软交换）用户5：PHS用户6：大灵通用户7：IPTV用户其他预留Integer1M11backup备用CHAR40O12n换行CHAR1Mu 回执文件体对于完全正确的文件和有文件级错误的回执文件，只有文件头没有文件体；对于记录级错误的回执文件，在文件体中列出错误的请求流水号及反馈结果代码。序号参数名说明参数类型最大长度备注1SequenceId记录流水号CHAR12与请求文件体中对应记录的流水号相同2SubscrbStat反馈结果代码CHAR3记录级错误代码(详见3.2)3Enter换行CHAR1n3 BSS与SMSC接口协议错误码3.1 文件级错误代码定义错误代码说明100文件名错误。101文件序列号错误。102文件名中分公司代码错误。103文件格式错误。104文件版本号非“00000”。105文件产生日期不符合年/月/日的规定。106文件生成方系统代码错误107文件采集方系统代码错误108用户归属地代码错误109通话总记录数总记录数与详细记录数不符。110其他错误3.2 记录级错误代码定义错误代码说明100记录流水号异常105用户状态改变时间异常110SubscrbStat字段超出取值范围120MDN错误130OLD_MDN错误140Old_SubscrbStat超出取值范围150和SubscrbStat字段一致160UserStat超出取值范围161UserType超出取值范围1