AAA接口子系统规范--普通宽带用户自动工单分册

1、 江西电信AAA系统接口规范版本修订内容时间作者备注1.0改密码操作中密码节点名称改为User_password修改改速率命名错误2012-3-22邱刚所有操作的user_info节点下面增加区县代码sub_city_no2012-3-22邱刚增加AE互改操作2012-3-23邱刚增加纯IPTV开户2012-3-23邱刚开户、资料修改增加WLAN三操作时，业务密码的3个属性2012-3-23邱刚主要用于WLAN动态密码时，其它情况可以不管开户操作4.2.3、4.2.14用户资料综合修改增加用户接入方式节点，以区分FTTH和普通ADSL，以太网2012-6-14邱刚增加wifi短信通知和动态密码

2、开户设置和取消功能 (4.2.37 4.2.40)2013-4-22毛轲增加开户操作对短信通知标志位、动态密码标识位的处理（4.2.3）2013-6-5毛轲增加用户业务状态变更的处理4.2.412013-6-24毛轲删除4.2.37和4.2.39中的短信通知号码字段，修正4.2.3中接入密码字段出现次数为0.12013-6-26毛轲修改4.2.3和4.2.13、4.2.16、4.2.17、4.2.19，增加上行带宽字段Up_Band_width2013-7-22毛轲修改4.2.14，增加上行带宽字段Up_Band_width修改4.2.3和4.2.13、4.2.16、4.2.17、4.2.19

3、，修改上行带宽字段Up_Band_width出现次数2013-7-26毛轲修改4.2.24和4.2.32、4.2.33、4.2.34、4.2.36，增加上行带宽字段Up_Band_width2013-7-29毛轲修改4.2.12，增加上行带宽字段Up_Band_width修改4.2.3和4.2.12、4.2.13、4.2.16、4.2.17、4.2.19、4.2.14、4.2.24和4.2.32、4.2.33、4.2.34、4.2.36，增加产品类型字段Product_Type（0：标准宽带；1：光速宽带；2：商务宽带；3：互联网专线）2013-8-05毛轲江西电信AAA系统普通宽带用户电子工

4、单接口规范湖南创发科技有限公司2012年02月14日目录1引言 51.1概述 51.2适用范围 61.3预期读者 61.4参考文献 61.5术语和缩略语 62接口协议 62.1接口环境 62.2接口功能 62.3接口方法与参数 72.4接口原则 72.5接口安全 72.5.1客户端口令验证 72.5.2双方通信内容采用MD5验证 72.5.3客户端IP地址登记与验证 73交互流程 84接口模型 84.1报文结构描述 84.2工单数据结构描述 94.2.1工单总体结构 94.2.2返回消息结构 104.2.3普通宽带用户开户工单 104.2.4普通宽带用户销户工单 134.2.5普通宽带用户暂停

5、冻结帐号工单 134.2.6普通宽带用户恢复开通工单 144.2.7普通宽带用户修改地址工单 144.2.8普通宽带用户改名工单 154.2.9普通宽带用户改密码工单（总的接入密码） 154.2.10普通宽带用户删除 154.2.11普通宽带用户改收费电话 164.2.12普通宽带用户改帐号工单 164.2.13普通宽带用户改速率工单 174.2.14普通宽带用户基本资料综合修改工单 184.2.15普通宽带用户加全球眼帐号工单 194.2.16普通宽带用户开户立即冻结工单（专线用户） 204.2.17普通宽带用户开户同时开全球眼帐号工单 214.2.18普通宽带用户帐号全球眼帐号双停工单 2

6、24.2.19普通宽带用户有固网接入业务增加WLAN业务工单 224.2.20普通宽带用户修改WLAN漫游权限工单 234.2.21普通宽带用户取消WLAN业务工单 244.2.22普通宽带用户开通绿色上网标志 244.2.23普通宽带用户取消绿色上网工单 254.2.24普通宽带用户增加IPTV帐号工单（IPTV新开） 254.2.25普通宽带用户移机时端口绑定2个工单 264.2.26普通宽带用户移机完成端口绑定单个工单 264.2.27普通宽带用户开通家校通工单 264.2.28普通宽带用户取消家校通工单 274.2.29普通宽带用户开通短信通知业务工单 274.2.30普通宽带用户取消

7、短信通知业务工单 284.2.31普通宽带用户修改短信通知号码业务 284.2.32普通宽带用户PPPOE接入方式改IPOE接入方式 284.2.33普通宽带用户IPOE接入方式改PPPOE接入 294.2.34普通宽带用户增加IPTV时指定IPTV为IPOE接入 294.2.35普通宽带用户ADSL&ETHERNET互改 304.2.36纯IPTV用户开户 304.2.37普通宽带用户开通WIFI短信通知业务工单 314.2.38普通宽带用户取消WIFI短信通知业务工单 324.2.39普通宽带用户开通动态密码业务工单 324.2.40普通宽带用户取消动态密码业务工单 324.2.4

8、1普通宽带用户业务状态变更工单 331 引言1.1 概述本接口规范描述了如下信息：接口协议、交互流程、接口模型以及接口模型所需静态数据。1.2 适用范围本接口规范可供江西电信的需要访问AAA系统的外系统所使用。1.3 预期读者本规范作为江西电信AAA系统与电子工单及CRM交互的接口说明，预期的读者为：CRM开发人员、IOM系统相关设计、开发人员，用户相应负责人。1.4 参考文献列出参考资料，如：1.5 术语和缩略语解释描述协议文档中用到的相关术语，包括中国电信业务术语和开发实现技术术语。如：SOAPSimple Object Access Protocol简单对象访问协议XMLeXtensib

9、le Markup Language可扩展标记语言2 接口协议描述双方交互实现的开发技术s双方采用WEBSERVICE接口实现方式。 2.1 接口环境描述双方接口运行软硬件环境。应用服务器版本、网络环境、接口开发语言（JAVA），数据库版本，JDK版本，测试联调环境地址等。2.2 接口功能描述接口实现功能，需求要求，应用目标。此接口文档描述了AAA统一接口子系统做为服务方与电子工单系统之间交互协议。2.3 接口方法与参数 方法：AAAUserWorkorderDeal输入：workorder_dispatch_request输出：Workorder_dispatch_response aaaU

10、serWorkorder方法由电子工单系统向AAA系统提交工单请求，返回工单提交情况消息；workorder_dispatch_request为需要AAA系统处理的用户工单，工单内容为XML文本，相关定义见数据结构描叙；Workorder_dispatch_response为接口服务端AAA系统收到工单后，返回的参数，工单处理情况处理结果为Workorder_dispatch_response内嵌的XML文本，具体格式见数据结构描叙，表明该工单已经通过AAA处理，如果返回接口服务异常，则工单提交失败，失败原因见失败代码表。2.4 接口原则2.5 接口安全2.5.1 客户端口令验证为保证安全，客

11、户端发送的工单请求中含有客户端名称即口令，采用明文方式发送2.5.2 双方通信内容采用MD5验证为防止通过工具抓取网络包分析，并构造工单对系统进行安全攻击，采用MD5摘要进行工单的防篡改与发送方合法保护。digest的生成与验证方式为，将整个工单内容字符串（不包括digest）尾部连接约定密钥后，作为整体进行MD5摘要计算，得到16字节的16进制ASCII字符串，填入到工单的digest段。密钥不可泄露。2.5.3 客户端IP地址登记与验证只允许登记的客户端IP地址访问本接口。未登记的IP地址访问本WEBSERVICE时，会得到失败应答。3 交互流程4 接口模型4.1 报文结构描述报文层次结构

12、HTTPSOAPSOAPHTTP工单XML处理结果XML客户端服务端客户端请求报文：<soapenv:Envelope xmlns:soapenv="/soap/envelope/" xmlns:exc=" <soapenv:Header/> <soapenv:Body> <exc:workorder_dispatch_request> <!CDATA 工单XML > </exc:workorder_dispatch_request> </so

13、apenv:Body></soapenv:Envelope><soapenv:Envelope xmlns:soapenv="/soap/envelope/" xmlns:exc=" <soapenv:Header/> <soapenv:Body> <exc:workorder_dispatch_response> <!CDATA 返回XML > </exc:workorder_dispatch_response> </soa

14、penv:Body></soapenv:Envelope>4.2 工单数据结构描述4.2.1 工单总体结构<work_order><header> <exchange_id>201104252012110000</exchange_id><client_id>客户端编码</client_id> <client_password>口令</client_password></header><data_body> <!- 工单内容 -> <num

15、_id> 111</num_id> <operation>xxxx</operation> <user_info> . <business_info> </business_info> <user_info></data_body><digest>16字节的16进制ASCII字符串</ digest ></work_order>说明：标识名首字符大写l Exchange_id 格式 4位年+2位月份+2位日期+2位小时24小时制+2位分钟+2位秒+4位序列号

16、，由客户端生成，同一台客户端不同次的调用，该exchange_id不能相同。l 为防止通过工具抓取网络包分析，并构造工单对系统进行安全攻击，采用MD5摘要进行工单的防篡改与发送方合法保护。digest的生成与验证方式为，将整个原始工单内容字符串（不包括digest）尾部连接约定密钥后，作为整体进行MD5摘要计算，得到16字节的16进制ASCII字符串，填入到工单的digest段。4.2.2 返回消息结构<response><code>0</code><describe>成功</describe></response>4.2

17、.3 普通宽带用户开户工单序号节点名称父节点节点标识数据类型长度出现次数说明工单属性1工单序号Data_bodyNum_idString1012工单操作码Data_bodyOperationString101NewAccount用户基本资料3用户帐号User_infoUser_accountString1614接入密码User_infoUser_passwordString80.15姓名User_infoNameString 6416接入县局User_infoSub_city_noString517最大在线数User_infoMax_usernumber40.1缺省1一线8收费电话User_i

18、nfoCharge_phoneString150.1缺省8位09接入端口User_infoPort_noString320.110地址User_infoAddressString640.111身份证号User_infoUser_idcardString 200.112联系人User_infoRela_manString320.113联系电话User_infoRela_phoneString150.114开通绿网User_infoGreen_netString10.115开家校通User_infoHome_schoolString10.116短信号码User_infoSmsg_phoneStri

19、ng120.117套餐大类User_infoBusi_package_typeString50.118用户物理接入方式User_infoPhysical_AccessString100.1ISDNADSLMODEMETHERNETCABLEWIRELESSCDMAEVDOWLANxDSLFTTH未指定时缺省值ADSL19短信通知控制标识位User_infoWifi_SMSString10.1送Y时和不送时，启用该功能；送N时，不启用该功能20动态密码控制标识位User_infoDyn_pwdString10.1送Y时，启用该功能；送N时和不送时，不启用该功能产品类型User_infoProdu

20、ct_TypeNumber10.1（不送或0：标准宽带；1：光速宽带；2：商务宽带；3：互联网专线）用户业务属性18业务接入模式Business_infoAccess_modeString1119接入带宽Business_infoBand_widthNumber100.126接入上行带宽Business_infoUp_Band_widthNumber100.120拨号终端Business_infoTerminal_flagNumber20.121业务最大在线数Business_infoBusi_max_usernumber10.122业务漫游限制Business_infoBusi_roamnu

21、mber10.123密码类型Business_infoPassword_typeString10.10 静态密码1 动态密码缺省为024业务密码Business_infoBusi_passwordString80.1如果类型为动态，则需要用户定期修改25密码有效性Business_infoPwd_choseString10.10 使用用户密码，不使用业务密码1 使用业务密码不使用用户密码3 二者任意缺省 为0说明1. 工单操作码，开户为new_account2. 接入县局：为江西电信通常约定的县区编码，前3位为电话区号去首位0，后两位为电信内部区县代码如： 791023. 接入端口port_n

22、o：宽带接入时，楼道交换机上物理端口的编号4. 用户地址address：64位字节长度，中文最长32位，否则会出现截断现象5. 绿色上网green net：Y开通，N 不开通，缺省为空，不开通6. 家校通标志home_school：Y 开通，N 不开通 缺省空时不开通7. 短信通知号码smsg_phone：有效的手机号码，填入时认为开通短信通知功能，不填则认为不开通8. 套餐大类busi_package_type：E8 E8宽带客户 E8-2 E8-2宽带客户E9 E9宽带客户ZQ 政企宽带客户 PT 普通宽带客户 JS 计时宽带客户9. 接入模式ACCESS_MODE D：窄带接入，B：宽带

23、接入，W：WLAN接入10. 接入带宽band_width 缺省未指定时为1M合法数值 合法名称-1 无限制524288 512K1572864 1.5M131072 128K1048576 1M2097152 2M3145728 3M4194304 4M5242880 5M6291456 6M8388608 8M10485760 10M20971520 20M41943040 40M52428800 50M104857600 100M11. TERMINAL_FLAG：绑定拨号终端，一共十位，每两位字符表示一种拨号终端，最多可以指定5种拨号终端。每两位字符的第一个字符表示拨号终端类型，定义如

24、下：n 0 普通拨号软件；n 1 星空极速软件；n 2 信利拨号软件；（江西特有）n 3 商企助手软件；（湖南特有）n 4 天翼LIVE软件；第二个字符表示拨号终端的版本，如果为“0”表示所有版本。目前已知的拨号终端版本如下： 类型版本0 普通拨号软件1 星空极速2 信利3 商企助手4 天翼LIVE1无意义3.1版之前1.01.01.02无意义3.1及3.22.0无意义无意义3无意义3.33.0无意义无意义49保留例如，要绑定星空极速3.3版以及信利2.0版，此字段内容为：“1322”；要绑定天翼live的所有版本以及信利所有版本，此字段内容为：“2040”；如果此内容为空，表示不绑定任何拨号

25、终端。12. Busi_max_user本业务的同时允许在线数目，0为无限制（但不会超过用户基本资料user_info节点的子节点max_user里最大在线数限制）9为有限制情况下最大上限13. Busi_roam 漫游区域限制 0 禁止漫游；1地市内漫游；2省内漫游； 3国内漫游；4国际漫游；所有接入模式皆可指定漫游，根据现有业务情况，宽带业务默认为禁止漫游，窄带默认为国内漫游，wlan默认为国内漫游，CDMA1.x和EVDO均默认为国内漫游。4.2.4 普通宽带用户销户工单序号节点名称父节点节点标识数据类型长度出现次数说明工单属性1工单序号Data_bodyNum_idString1012

26、工单操作码Data_bodyOperationString101CloseAccount用户基本资料3用户帐号User_infoUser_accountString1614区县代码User_infoSub_city_noString 51用户业务属性18业务接入模式Business_infoAccess_modeString10.1说明：business_info没指定接入模式或接入模式为固网宽带B的情况下，将指定的帐号销户 Business_info 指定具体的接入模式WLAN,IPOE时，帐号不销户，删除相应接入模式的业务。4.2.5 普通宽带用户暂停冻结帐号工单序号节点名称父节点节点标识

27、数据类型长度出现次数说明工单属性1工单序号Data_bodyNum_idString1012工单操作码Data_bodyOperationString101PauseAccount用户基本资料3用户帐号User_infoUser_accountString1614区县代码User_infoSub_city_noString 51用户业务属性18业务接入模式Business_infoAccess_modeString10.1说明：business_info没指定接入模式或接入模式为固网宽带B的情况下，将指定的帐号暂停 Business_info 指定具体的接入模式WLAN,IPOE时，帐号不暂停

28、，暂停相应接入模式的业务。4.2.6 普通宽带用户恢复开通工单序号节点名称父节点节点标识数据类型长度出现次数说明工单属性1工单序号Data_bodyNum_idString1012工单操作码Data_bodyOperationString101ReopenAccount用户基本资料3用户帐号User_infoUser_accountString1614区县代码User_infoSub_city_noString 51用户业务属性18业务接入模式Business_infoAccess_modeString10.1说明：business_info没指定接入模式时，将指定的帐号恢复，返回成功，帐号为

29、销户状态，或停机保号状态返回错误代码。 Business_info 指定具体的接入模式WLAN,IPOE，固网B时，帐号为暂停则恢复，指定业务为暂停，则恢复，其它业务仍然保留原状态，返回成功；但帐号为销户状态，或停机保号状态返回错误代码。4.2.7 普通宽带用户修改地址工单序号节点名称父节点节点标识数据类型长度出现次数说明工单属性1工单序号Data_bodyNum_idString1012工单操作码Data_bodyOperationString101ModiAddress用户基本资料3用户帐号User_infoUser_accountString1614用户地址User_infoAddres

30、sString6415区县代码User_infoSub_city_noString 514.2.8 普通宽带用户改名工单序号节点名称父节点节点标识数据类型长度出现次数说明工单属性1工单序号Data_bodyNum_idString1012工单操作码Data_bodyOperationString101ModiName用户基本资料3用户帐号User_infoUser_accountString1614用户名User_infoNameString6415区县代码User_infoSub_city_noString 514.2.9 普通宽带用户改密码工单（总的接入密码）序号节点名称父节点节点标识数据

31、类型长度出现次数说明工单属性1工单序号Data_bodyNum_idString1012工单操作码Data_bodyOperationString101ModiPassword用户基本资料3用户帐号User_infoUser_accountString1614接入密码User_infoUser_passwordString815区县代码User_infoSub_city_noString 514.2.10 普通宽带用户删除序号节点名称父节点节点标识数据类型长度出现次数说明工单属性1工单序号Data_bodyNum_idString1012工单操作码Data_bodyOperationStrin

32、g101delete用户基本资料3用户帐号User_infoUser_accountString1614区县代码User_infoSub_city_noString 51说明：删除用户帐号，危险操作，尽量使用销户，由系统数据库触发删除操作，销户删除会保留用户资料备份，直接删除则不会。4.2.11 普通宽带用户改收费电话序号节点名称父节点节点标识数据类型长度出现次数说明工单属性1工单序号Data_bodyNum_idString1012工单操作码Data_bodyOperationString101ModiChargePhone用户基本资料3用户帐号User_infoUser_accountSt

33、ring1614收费电话User_infoCharge_phoneString151帐户电话号码5区县代码User_infoSub_city_noString 514.2.12 普通宽带用户改帐号工单序号节点名称父节点节点标识数据类型长度出现次数说明工单属性1工单序号Data_bodyNum_idString1012工单操作码Data_bodyOperationString101ModifyAccount用户基本资料3用户新帐号User_infoUser_accountString1614接入密码User_infoUser_passwordString80.15最大在线数User_infoMa

34、x_usernumber40.1缺省1一线6接入端口User_infoPort_noString320.17老帐号User_infoOld_account8区县代码User_infoSub_city_noString 51产品类型User_infoProduct_TypeNumber10.1（不送或0：标准宽带；1：光速宽带；2：商务宽带；3：互联网专线）用户业务属性18业务接入模式Business_infoAccess_modeString1119接入带宽Business_infoBand_widthNumber100.1接入上行带宽Business_infoUp_Band_widthNum

35、ber100.120拨号终端Business_infoTerminal_flagNumber20.121业务最大在线数Business_infoBusi_max_usernumber10.122业务漫游限制Business_infoBusi_roamnumber10.1说明：将Old_account帐号资料复制到新帐号user_account，如果指定了新的密码，最大在线用户数，端口，则将新值赋予新帐号，没有指定时，按沿用老帐号设置；如果指定了业务属性，则新帐号的业务属性按新指定的设置，没有指定业务属性，全部沿用老帐号的业务。4.2.13 普通宽带用户改速率工单序号节点名称父节点节点标识数据类

36、型长度出现次数说明工单属性1工单序号Data_bodyNum_idString1012工单操作码Data_bodyOperationString101ModiBandWidth用户基本资料3用户新帐号User_infoUser_accountString1614区县代码User_infoSub_city_noString 51产品类型User_infoProduct_TypeNumber10.1（不送或0：标准宽带；1：光速宽带；2：商务宽带；3：互联网专线）用户业务属性5业务接入模式Business_infoAccess_modeString116接入带宽Business_infoBand_

37、widthNumber1017接入上行带宽Business_infoUp_Band_widthNumber100.1修改指定接入模式的速率4.2.14 普通宽带用户基本资料综合修改工单序号节点名称父节点节点标识数据类型长度出现次数说明工单属性1工单序号Data_bodyNum_idString1012工单操作码Data_bodyOperationString101ModiUserinfo用户基本资料3用户帐号User_infoUser_accountString1614接入密码User_infoUser_passwordString815姓名User_infoNameString 6416接入

38、县局User_infoSub_city_noString517最大在线数User_infoMax_usernumber40.1缺省1一线8收费电话User_infoCharge_phoneString150.1缺省8位09接入端口User_infoPort_noString320.110地址User_infoAddressString640.111身份证号User_infoUser_idcardString 200.112联系人User_infoRela_manString320.113联系电话User_infoRela_phoneString150.114开通绿网User_infoGreen

39、_netString10.115开家校通User_infoHome_schoolString10.116短信号码User_infoSmsg_phoneString120.117套餐大类User_infoBusi_package_typeString50.118用户物理接入方式User_infoPhysical_AccessString100.1ISDNADSLMODEMETHERNETCABLEWIRELESSCDMAEVDOWLANxDSLFTTH未指定时不会修改产品类型User_infoProduct_TypeNumber10.1（不送或0：标准宽带；1：光速宽带；2：商务宽带；3：互联网

40、专线）用户业务属性18业务接入模式Business_infoAccess_modeString1119接入带宽Business_infoBand_widthNumber100.1接入上行带宽Business_infoUp_Band_widthNumber100.120拨号终端Business_infoTerminal_flagNumber20.121业务最大在线数Business_infoBusi_max_usernumber10.122业务漫游限制Business_infoBusi_roamnumber10.123密码类型Business_infoPassword_typeString10.

41、10 静态密码1 动态密码缺省为024业务密码Business_infoBusi_passwordString80.1如果类型为动态，则需要用户定期修改25密码有效性Business_infoPwd_choseString10.10 使用用户密码，不使用业务密码1 使用业务密码不使用用户密码3 二者任意缺省 为0工单中送达的字段名称，速率，接入密码等都修改，没有送的保留原值，各字段解释见开户工单。4.2.15 普通宽带用户加全球眼帐号工单序号节点名称父节点节点标识数据类型长度出现次数说明工单属性1工单序号Data_bodyNum_idString1012工单操作码Data_bodyOperat

42、ionString101AddQQY用户基本资料3全球眼帐号User_infoUser_accountString1614接入密码User_infoUser_passwordString80.15基本帐号User_infoBase_accountString1616区县代码User_infoSub_city_noString 51在固网基本帐号Base_account上加装一个全球眼帐号，如果指定密码，密码按新指定设置，如果没有指定密码，密码按基础帐号设置4.2.16 普通宽带用户开户立即冻结工单（专线用户）专线用户仅在AAA登记信息，不通过AAA认证计费序号节点名称父节点节点标识数据类型长度

43、出现次数说明工单属性1工单序号Data_bodyNum_idString1012工单操作码Data_bodyOperationString101NewAccountPause用户基本资料3用户帐号User_infoUser_accountString1614接入密码User_infoUser_passwordString815姓名User_infoNameString 6416接入县局User_infoSub_city_noString517最大在线数User_infoMax_usernumber40.1缺省1一线8收费电话User_infoCharge_phoneString150.1缺省8

44、位09接入端口User_infoPort_noString320.110地址User_infoAddressString640.111身份证号User_infoUser_idcardString 200.112联系人User_infoRela_manString320.113联系电话User_infoRela_phoneString150.114开通绿网User_infoGreen_netString10.115开家校通User_infoHome_schoolString10.116短信号码User_infoSmsg_phoneString120.117套餐大类User_infoBusi_pa

45、ckage_typeString50.1产品类型User_infoProduct_TypeNumber10.1（不送或0：标准宽带；1：光速宽带；2：商务宽带；3：互联网专线）用户业务属性18业务接入模式Business_infoAccess_modeString1119接入带宽Business_infoBand_widthNumber100.1接入上行带宽Business_infoUp_Band_widthNumber10120拨号终端Business_infoTerminal_flagNumber20.121业务最大在线数Business_infoBusi_max_usernumber10.122业务漫游限制Business_infoBusi_roamnumber10.1原接口版本中该操作目的好像是用于C网数据卡或是企业用户或是某种卡式用户的资料管理，在固网AAA系统并不运行，只做资料保存，所以开户即冻结，请业务部门确认。4.2.17 普通宽带用户开户同时开全球眼帐号工单序号节点名称父节点节点标识数据类型长度出现次数说明工单属性1工单序号Data_bodyNum_idString1012工单操作码Data_bodyOperationString101NewQQY用户基本资料3用户帐号User_infoUser_accountString161全球眼帐号U