本地SP接口协议all20100621.doc

本地本地 SP 二次确认外部接口协议二次确认外部接口协议 (V1.0) 2010 年 6 月 ESOP 接口规范 中国移动通信公司 i 文档变更记录文档变更记录 序号变更内容说明版本号版本日期作者 1初稿 1.0.02010-6-11 王建伟 ESOP 接口规范 中国移动通信公司 ii 目 录 文档变更记录文档变更记录 .I 1. 概述概述.1 1.1. 文档概述.1 1.2. 接口列表.1 2. 接口数据格式接口数据格式.1 2.1. 数据描述约定.1 2.1.1. 约束符号1 2.2. 数据文件格式定义.1 2.2.1. 数据文件命名规则1 2.2.2. 数据文件内容格式2 3. 订购订购信息信息.3 3.1. 文件接口.3 3.1.1. 个人订购本地 SP 信息3 3.1.2. 个人订购本地 SP 信息确认3 3.1.3. CRM 侧本地 SP 业务订购取消同步接口（预留）4 3.1.4. CRM 侧本地 SP 业务订购取消同步接口确认（预留）5 4. 数据一致性数据一致性.6 4.1. 按天同步接口.6 5. 附件附件.7 5.1. 附件 1 字典编码列表7 ESOP 接口协议 中国移动通信公司 1 1. 概述概述 1.1. 文档概述文档概述 该协议作为甘肃 BOSS 系统与本地 SP 的外部接口规范，后继开发和联调以该接口约定为 准。 本文的后续部分将分别描述这些接口的功能、流程、属性和接口报文格式。 1.2. 接口列表接口列表 章节章节接口名称接口名称接口类型接口类型对端系统对端系统 3.1.1 订购信息同步本地 SP 2. 接口数据格式接口数据格式 2.1. 数据描述约定数据描述约定 2.1.1. 约束符号约束符号 在本文档中以表格的形式表示 XML 格式，以下为表格中对元素约束（出现次数）的表示方法的描述： 符号含义 ?01，可选项 *0n，可以没有，也可以有多项 +1n，至少有 1 项，也可以有多项 1数字 1，代表必须且只能填 1 项 另外，在报文格式的宽度中，“F”指固定长度，“V”表示可变长度。 2.2. 数据文件格式定义数据文件格式定义 2.2.1. 数据文件命名规则数据文件命名规则 除了后缀以”.”为以外,其他字段之间以”_”连接. ESOP 接口协议 中国移动通信公司 2 文件名称全用大写，扩展名为小写。 字段名称字段名称字段长度字段长度(字符字符)字段说明字段说明取值说明取值说明 方向3描述方向C2L：CRM 至本地 SP L2C：本地 SP 至 CRM 业务4描述本数据文件是针对什 么业务的 业务人员自己商量确定, 要明确清晰表明。默认为 SP 代码，固定为 6 位。 日期14文件产生的时间格式:yyyymmddhhmiss 序号3每天的文件从 0000 开始从 0001 到 9999，请求文 件与响应文件的序号不要 求完成一致。 后缀3描述文件类型req 请求,res 响应 最终的文件名称如下: 请求文件: 方向业务日期序号.req，如：L2C_六位 SP 代码_20100611233001_0103.req 响应文件: 方向业务日期序号.res，如：L2C_六位 SP 代码_20100611233511_0103.res 建议: 请求文件和响应文件除了后缀不一样以外,其他完全一样. 2.2.2. 数据文件内容格式数据文件内容格式 业务人员根据业务需求自行确定. 在业务接口里体现. ESOP 接口协议 中国移动通信公司 3 3. 订购订购信息信息 3.1. 文件接口文件接口 3.1.1. 个人订购本地个人订购本地 SP 信息信息 文件生成频次：5 分钟生成一个 传送方向：从 SP 平台到 CRM 系统 文件生成粒度：一次同步生成一个文件 文件名格式约定：(参见 2。2.1) 文件名举例： L2C_六位 SP 代码_20100611233001_0103.req 文件内容格式约定： 文件头：无 文件体：每行数据内容如下：分割符号：竖线“|” ，首字段前和尾字段后无需分割符号，每行换行使用回车 换行符，第行只显示一条订购信息，若同一用户订购多项业务，需分行列出。 元素名称约束类型宽度参数描述备注 id1stringV16编号唯一标识，在同一天的文件中不允许 重复。若有重复，则认为为同一订购， 覆盖前面的记录。 Oper_type1stringF2操作类型01：订购 03：取消 phone1stringV20手机号码必填 Sp_code1stringV32企业代码必填，可为 0 Serv_code1stringV64业务代码必填，可为 0 Apply_type1stringF2订购渠道长度不足左填 0，默认为 01 Busi_type1stringF4业务类型：默认为 9999 Bill_flagstringF2收费标识，默认为 02 Service_idstringV64服务代码，默认为 0 Order_date1stringF14yyyymmddhh24miss用户订购时间如:20100611171412 Send_date1stringF14yyyymmddhh24miss接口传送时间如 20100601171412 Ext_hold11stringV64预留字段，可不填 Ext_hold21stringV64预留字段，可不填 3.1.2. 个人订购本地个人订购本地 SP 信息确认信息确认 文件生成频次：5 分钟生成一个 传送方向：从 CRM 系统到各 SP 平台 文件生成粒度：一次同步生成一个文件 文件名格式约定：(参见 2。2.1) 文件名举例： C2L_六位 SP 代码_20100611233001_0103.res 文件内容格式约定： 文件头：无 文件体：每行数据内容如下：分割符号：竖线“|” ，首字段前和尾字段后无需分割符号，每行换行使用 回车换行符，第行只显示一条订购信息，若同一用户订购多项业务，需分行列出 ESOP 接口协议 中国移动通信公司 4 元素名称约束类型宽度参数描述备注 id1stringV16编号回复标识，SP 平台可根据编号匹配成 功能记录。 Oper_type1stringF2操作类型01：订购 03：取消 Rtn_type1stringF2返回值00：成功 01：用户未进行二次确认 Rtn_desc1stringV512确认描述如：SUCCESS； NO phone1stringV20手机号码 Sp_code1stringV32企业代码 Serv_code1stringV64业务代码 Apply_type1stringF2订购渠道长度不足左填 0，默认为 Busi_type1stringF4业务类型：默认为 9999 Bill_flag收费标识，可不填 Service_id服务代码 Order_date1stringF14yyyymmddhh24miss用户确认时间如:20100611171412 Send_date1stringF14yyyymmddhh24miss接口传送时间如 20100601171412 Ext_hold11stringV64预留字段，可不填 Ext_hold21stringV64预留字段，可不填 3.1.3. CRM 侧本地侧本地 SP 业务订购取消同步业务订购取消同步 接口（预留）接口（预留） 说明：除了 SP 侧的同步信息之外，预留通过 CRM 侧统一查询退订接口进行取消或订购的本地 Sp 业务接 口。从 CRM 发起订购或取消，通过文件接口同步到 SP。 文件生成频次：5 分钟生成一个 传送方向：从 CRM 系统到各 SP 平台 文件生成粒度：一次同步生成一个文件 文件名格式约定：(参见 2。2.1) 文件名举例： C2L_KLSF_20100611233001_0103.req 文件内容格式约定： 文件头：无 文件体：每行数据内容如下：分割符号：竖线“|” ，首字段前和尾字段后无需分割符号，每行换行使用回车 换行符，第行只显示一条订购信息，若同一用户订购多项业务，需分行列出 元素名称约束类型宽度参数描述备注 id1stringV16编号唯一标识，在同一天的文件中不允许 重复。若有重复，则认为为同一订购， 覆盖前面的记录。 Oper_type1stringF2操作类型01：订购 03：取消 phone1stringV20手机号码必填 Sp_code1stringV32企业代码必填，可为 0 Serv_code1stringV64业务代码必填，可为 0 Apply_type1stringF2订购渠道长度不足左填 0，默认为 01 Busi_type1stringF4业务类型：默认为 9999 ESOP 接口协议 中国移动通信公司 5 Bill_flagstringF2收费标识，默认为 02 Service_idstringV64服务代码，默认为 0 Order_date1stringF14yyyymmddhh24miss用户办理时间如:20100611171412 Send_date1stringF14yyyymmddhh24miss接口传送时间如 20100601171412 Ext_hold11stringV64预留字段，可不填 Ext_hold21stringV64预留字段，可不填 3.1.4. CRM 侧本地侧本地 SP 业务订购取消同步业务订购取消同步 接口确认（预留）接口确认（预留） 说明：除了 SP 侧的同步信息之外，预留通过 CRM 侧统一查询退订接口进行取消或订购的本地 Sp 业务接 口。从 CRM 发起订购或取消，通过文件接口同步到 SP。SP 订购成功能后，返回给 CRM 文件生成频次：5 分钟生成一个 传送方向：从 SP 到各 CRM 文件生成粒度：一次同步生成一个文件 文件名格式约定：(参见 2。2.1) 文件名举例： C2L_KLSF_20100611233001_0103.res 文件内容格式约定： 文件头：无 文件体：每行数据内容如下：分割符号：竖线“|” ，首字段前和尾字段后无需分割符号，每行换行使用回车 换行符，第行只显示一条订购信息，若同一用户订购多项业务，需分行列出 元素名称约束类型宽度参数描述备注 id1stringV16编号回复标识，SP 平台可根据编号匹配成 功能记录。 Oper_type1stringF2操作类型01：订购 03：取消 Rtn_type1stringF2返回值00：成功 01：用户未进行二次确认 Rtn_desc1stringV512确认描述如：SUCCESS； NO phone1stringV20手机号码 Sp_code1stringV32企业代码 Serv_code1stringV64业务代码 Apply_type1stringF2订购渠道可填 0 Busi_type1stringF4业务类型：默认为 9999 Bill_flag收费标识，可不填 Service_id服务代码，可不填 Order_date1stringF14yyyymmddhh24miss用户办理时间如:20100611171412 Send_date1stringF14yyyymmddhh24miss接口传送时间如 20100601171412 Ext_hold11stringV64预留字段，可不填 Ext_hold21stringV64预留字段，可不填 ESOP 接口协议 中国移动通信公司 6 4. 数据一致性数据一致性 4.1. 按天同步接口按天同步接口 为保证双方数据一致，增加按天同步接口，对当天订购和取消的用户进行进行全量稽核，每个用户单一业务的 订购和取消只允许有一条记录，若当天多次订购或取消，全量核对时取一条数据。 文件生成频次：每天 0 点生成当日全量核对文件。全量文件应包括当日所有订购取消内容。 传送方向：从 CRM 系统到各 SP 平台。数据以 CRM 系统为准，平台侧根据全量文件取消或生成订购。 文件生成粒度：一次同步生成一个文件 文件名格式约定：(参见 2。2.1)。文件编号固定为：9999 不需要确认回复。 文件名举例： C2L_六位 SP 代码_20100611000101_9999.res 文件内容格式约定： 文件头：无 文件体：每行数据内容如下：分割符号：竖线“|” ，首字段前和尾字段后无需分割符号，每行换行使用 回车换行符，第行只显示一条订购信息，若同一用户订购多项业务，需分行列出 元素名称约束类型宽度参数描述备注 phone1stringV20手机号码 Oper_type1stringF2操作类型01：订购 03：取消 S