BSS与AHR接口说明书1119(1)

更新时间：2023-12-26 12:24:01 阅读量：教育文库文档下载

说明：文章内容仅供预览，部分内容可能不全。下载后的文档，内容与下面显示的完全一致。下载之前请确认下面内容是否您想要的，是否完整无缺。

BSS与BSA是什么意思推荐度：
相关推荐

内部公开

BSS与AHR接口说明书

第1页, 共29页

内部公开

修订记录

日期 2009-7-7 2009-7-19 修订版本 1.0 原始创建增加3.8APID号修改修订一些字段的填写规则（必选、可选）修订错误定义湖北联通业务发放新增接口描述余滔余滔作者 2009-11-19 余滔

第2页, 共29页

内部公开

1 2

简介........................................................................................................................................... 4 约束........................................................................................................................................... 5 2.1 接口值域的约束 ....................................................................................................... 5 2.2 手机号到IMSI 号的转换功能 ................................................................................ 5 2.3 通信传输方式 ........................................................................................................... 5 2.4 同步文件的传输 ....................................................................................................... 5 2.5 对手机号的限制 ....................................................................................................... 5 2.6 对准入列表中手机绑定个数的限制 ....................................................................... 5 2.7 修改准入列表 ........................................................................................................... 5 2.8 AP 区域名(可选) ..................................................................................................... 5 2.9 SOAP报文需采用UTF-8编码形式 .......................................................................... 6 2.10 错误码定义 ............................................................................................................... 6 2.11 性能规格 ................................................................................................................... 6 AHR提供的基本接口参数 ...................................................................................................... 6 3.1 增加AP用户 .............................................................................................................. 6

3.1.1 请求参数 ........................................................................................................... 7 3.1.2 APID ................................................................................................................. 8 3.1.3 UEPermission的参数 ........................................................................................ 8 3.1.4 响应参数 ......................................................................................................... 10 3.2 AP销户.................................................................................................................... 10

3.2.1 请求参数 ......................................................................................................... 11 3.2.2 响应参数 ......................................................................................................... 11 3.3 修改准入列表 ......................................................................................................... 12

3.3.1 请求参数 ......................................................................................................... 13 3.3.2 响应参数 ......................................................................................................... 14 3.4 AP挂起.................................................................................................................... 15

3.4.1 请求参数 ......................................................................................................... 15 3.4.2 响应参数 ......................................................................................................... 16 3.5 AP激活.................................................................................................................... 16

3.5.1 请求参数 ......................................................................................................... 17 3.5.2 响应参数 ......................................................................................................... 18 3.6 BOSS 开户数据和AHR 数据的核对 .................................................................. 18 3.7 IMSI 号修改（IMSI认证方式使用） .................................................................. 18

3.7.1 请求参数 ......................................................................................................... 19 3.7.2 响应参数 ......................................................................................................... 20 3.8 APID号修改（证书认证方式使用） .................................................................... 20

3.8.1 请求参数 ......................................................................................................... 21 3.8.2 响应参数 ......................................................................................................... 22 3.9 资费套餐配置 ......................................................................................................... 22

3.9.1 请求参数 ......................................................................................................... 23

第3页, 共29页

内部公开

3.9.2 响应参数 ......................................................................................................... 24 3.10 位置信息变更 ......................................................................................................... 25

3.10.1 请求参数 ......................................................................................................... 25 3.10.2 响应参数 ......................................................................................................... 26 3.11 位置指示信息配置 ................................................................................................. 26

3.11.1 请求参数 ......................................................................................................... 27 3.11.2 响应参数 ......................................................................................................... 28 常见错误码定义 ..................................................................................................................... 28

缩略语：

AHR：AP home register AP：Access Point

1 简介

AHR，AP Home Register，AP归属服务器，位于营运商管理的内部网络intranet内，用于提供AP开户信息、位置信息、UE接入控制列表等信息。

第4页, 共29页

内部公开

BSS与AHR的接口采用的是SOAP格式的报文并承载于Http协议。AHR提供了SSL 和TCP 两种连接方式，并需开放一个端口（默认是34995）和BSS 的连接。

2 约束

2.1 接口值域的约束

BSS系统需要具备对输入的参数进行基本校验的功能，以保证接口参数的值域符合接口中要求的值域范围。

2.2 手机号到IMSI 号的转换功能

用户到营业厅开户、或是申请修改绑定的手机号时，BSS 系统录入的是用户的手机号，此时BSS 系统需要将手机号转化为其对应的IMSI 后再下发给AHR。

2.3 通信传输方式

从安全性上考虑，BSS 和AHR 之间的通讯最好采用SSL 这种安全加密的传输方式。若采用此种传输方式，BSS 需要支持此方式的通讯并提供加密的认证证书给AHR。否则只能采用TCP 的方式进行通讯传输。

2.4 同步文件的传输

目前暂不实现。

2.5 对手机号的限制

目前一个手机号只允许绑定到一个AP 中，BSS 系统需要确保一个手机号只加入到了一个AP 中。此约束由BSS控制。

2.6 对准入列表中手机绑定个数的限制

目前一个AP 只允许绑定最多4个手机，BSS 系统需要确保下发的准入列表中IMSI号的个数不超过4。此约束由BSS控制。

2.7 修改准入列表

修改AHR 上某个AP 的用户的准入列表时，准入列表的每条记录都必须携带时间戳（格式为：YYYY-MM-DD HH:MM:SS），同时准入列表里的记录必须包含该AP 用户上设置的所有准入记录。

2.8 AP 区域名(可选)

AP 区域是在AHR 上规划好的，用于给AP 进行网元参数批量配置。BOSS 系统中需

第5页, 共29页

内部公开

要维护一个区域名列表，该列表里面的区域名需要和AHR 上规划好的一致，在AP 开户时，从该区域列表中设置一个AP 归属的区域，并下发给AHR。

2.9 SOAP报文需采用UTF-8编码形式

要求所有BSS接口的SOAP报文采用UTF-8编码方式。每个节点名必须与第3节函数参数表中参数名一致。

2.10 错误码定义

错误码以双方协商的形式进行定义，常见错误码定义表中定义了基本的错误码，所有错误码其值为无符号整数。

2.11 性能规格

BSS操作增加AP用户删除AP用户修改准入列表数量响应时间 1000 30秒 1000 30秒 1000 10秒 3 AHR提供的基本接口参数

3.1 增加AP用户

通过设定一些必要信息，在AHR 上增加一个新的AP 用户。其中对于需要绑定的手机号必须转化为对应的IMSI 号进行设置。

第6页, 共29页

内部公开

3.1.1 请求参数

参数名称是否必须提供(M是，O为可选) M 参数类型值范围参数描述 interfaceVersion Unsigned char 协商确定 Unsigned int APID enum 协商确定 3.1.2 -1 ~ 2 默认 0 可以作为版本号提供接口兼容性消息序列号 AP标志准入模式 -1 无效模式； 0 ，封闭(Clsoe)模式； 1 ，开放(Open)模式； 2 ，组(Group)模式 AP位置检测模式默认为 0，不做位置检测； 2，2G宏小区检测模式； 3，3G宏小区检测模式； 4，2G&3G共用检测模式最大准入用户数 UE准入列表家庭电话号码身份标识邮政编码用户名 AP区域名第7页, 共29页

serialNo APIdentity EPermissionMode M M M locationDetectMode O enum -1~7 默认 4 maxUEUserCount phone cardID zipCode userName APZoneName

M Unsigned int UEPermission Unsigned char[16] Unsigned char[32] Unsigned char[10] Unsigned char[32] Unsigned

0 ~16 默认 4 3.1.3 UEPermissionList M O O O O O

内部公开

char[128] mobile rateLevel

O O Unsigned char[16] Unsigned int 移动电话资费套餐ID值 3.1.2 APID

证书认证方式：必填项为APEI（Femto serial number） IMSI认证方式：IMSI必填两项必选其一。

参数名称是否必须提供(M是，O为可选) M 参数类型值范围参数描述 APEI Unsigned char[21] 1 ~ 21 AP ID号，APEI为AP 用户唯一标识时，必填 IMSI号，IMSI为AP 用户唯一标识时，必填 IMSI M Unsigned char[15] 6 ~ 15 3.1.3 UEPermission的参数

参数名称是否必须提供(M是，O为可选) M O 参数类型值范围参数描述 IMSI MSISDN Unsigned char[15] Unsigned char[18] 6 ~ 15 2 ~ 18 必须提供选填

Soap消息举例：

第8页, 共29页

内部公开

1 12 12345678998765432112 45345345346 0 4 16 100001 213123213213213 100002 324234324324 海淀区

第9页, 共29页

内部公开

3.1.4 响应参数

参数名称是否必须提供(M是，O为可选) M 参数类型值范围参数描述 interfaceVersion Unsigned char 可以作为版本号提供接口兼容性消息序列号 0表示成功，其它表示失败 AP唯一标识 serialNo returnCode APIdentity M M M Unsigned int Unsigned int APID

Soap消息举例：

1 12 0 111111111111111 111111111111111

3.2 AP销户

通过AP 的唯一标识来删除AHR 上一个指定的AP 用户。

第10页, 共29页

内部公开

3.2.1 请求参数

参数名称是否必须提供(M是，O为可选) M 参数类型值范围参数描述 interfaceVersion Unsigned char 可以作为版本号提供接口兼容性消息序列号 AP唯一标识 serialNo APIdentity M M Unsigned int APID

Soap消息举例：

1 13 12345678998765432112 111111111

3.2.2 响应参数

Soap消息举例：

第11页, 共29页

内部公开

1 13 0 22222222222222 3333333333333

3.3 修改准入列表

通过AP 的唯一标识来修改AHR 上指定的一个AP 用户的准入列表内容。修改消息需要携带时间戳，其值是BOSS 系统的业务受理时间。

第12页, 共29页

内部公开

3.3.1 请求参数

参数名称是否必须提供(M是，O为可选) M 参数类型值范围参数描述 interfaceVersion Unsigned char 可以作为版本号提供接口兼容性消息序列号 AP唯一标识准入模式 0 : close 1 : open 2 : group 最大用户数准入列表的个数记录BOSS 业务受理时间 serialNo APIdentity permissionMode M M M Unsigned int APID enum 3.1.2 -1 ~ 2 默认 0 maxUEUserCount UEPermissionListSize M M M UINT32 UINT32 Unsigned char[19] 0 ~16 默认 4 0 ~ 32 时间格式的字符串，其格式为YYYY-MM-DD HH24:MI:SS 3.1.3 time UEPermissionList M UEPermission UE准入列表

Soap消息举例：

1 1 12345678998765432112 111111111 0 12

第13页, 共29页

内部公开

1 2009-12-12 09:12:12 344654645 577587687

3.3.2 响应参数

Soap消息举例：

1 23 0 324234324234 23432432423432

第14页, 共29页

内部公开

3.4 AP挂起

通过AP 的唯一标识，将AHR 上的指定AP 用户进行挂起，挂起的AP 用户将无法适用AP 提供的业务。

3.4.1 请求参数

Soap消息举例：

1 2 12345678998765432112 111111111

第15页, 共29页

内部公开

3.4.2 响应参数

Soap消息举例：

1 323 324234324324 234234324234 0

3.5 AP激活

通过AP 的唯一标识，将AHR 上的指定AP 用户（已挂起的）进行激活，使该用户的AP 手动复位后，能够正常上电并提供业务。

第16页, 共29页

内部公开

3.5.1 请求参数

Soap消息举例：

1 2 12345678998765432112 111111111

第17页, 共29页

内部公开

3.5.2 响应参数

Soap消息举例：

1 2 324324324 4324324324

3.6 BOSS 开户数据和AHR 数据的核对

本接口不做为8月20日联调接口，暂不实现。

3.7 IMSI 号修改（IMSI认证方式使用）

当标识一个AP 用户的IMSI 号需要变更时，BOSS 系统将旧的IMSI 号和新的IMSI 号一同发给AHR，AHR 进行IMSI 号的更新。

第18页, 共29页

内部公开

3.7.1 请求参数

参数名称是否必须提供(M是，O为可选) M 参数类型值范围参数描述 interfaceVersion Unsigned char 可以作为版本号提供接口兼容性消息序列号 AP 原有的IMSI号 AP 现有的IMSI号 serialNo oldIMSI newIMSI M M M Unsigned int Unsigned char[15] Unsigned char[15] 6 ~ 15 6 ~ 15

Soap消息举例：

1 2 123456789 111111111

第19页, 共29页

内部公开

3.7.2 响应参数

参数名称是否必须提供(M是，O为可选) M 参数类型值范围参数描述 interfaceVersion Unsigned char 可以作为版本号提供接口兼容性消息序列号 0表示成功，其它表示失败 AP 原有的IMSI号 serialNo returnCode oldIMSI M M M Unsigned int Unsigned int Unsigned char[15] 6 ~ 15

Soap消息举例：

1 2 0 123456789

3.8 APID号修改（证书认证方式使用）

当标识一个AP 用户的APID 需要变更时，BOSS 系统将旧的APID 和新的APID 号一同发给AHR，AHR 进行APID 的更新。

第20页, 共29页

内部公开

3.8.1 请求参数

参数名称是否必须提供(M是，O为可选) M 参数类型值范围参数描述 interfaceVersion Unsigned char 可以作为版本号提供接口兼容性消息序列号 AP 原有的APID AP 现有的APID serialNo oldAPEI newAPEI M M M Unsigned int Unsigned char[21] Unsigned char[21] 1 ~ 21 1 ~ 21

Soap消息举例：

1 2 123456789 111111111

第21页, 共29页

内部公开

3.8.2 响应参数

参数名称是否必须提供(M是，O为可选) M 参数类型值范围参数描述 interfaceVersion Unsigned char 可以作为版本号提供接口兼容性消息序列号 0表示成功，其它表示失败 AP 原有的APID serialNo returnCode oldAPEI M M M Unsigned int Unsigned int Unsigned char[21] 1 ~ 21

Soap消息举例：

1 2 0 123456789

3.9 资费套餐配置

通过AP用户的唯一标识，修改该用户的位置绑定模式、套餐类型。

第22页, 共29页

内部公开

3.9.1 请求参数

参数名称是否必须提供(M是，O为可选) M 参数类型值范围参数描述 interfaceVersion Unsigned char 可以作为版本号提供接口兼容性消息序列号 AP唯一标识 AP位置检测模式 0，不做位置检测； 2，2G宏小区检测模式； 3，3G宏小区检测模式； 4，2G&3G共用检测模式资费套餐ID值 AP区域名 AP Group名准入模式 0 : close 1 : open 2 : group serialNo APIdentity locationDetectMode M M M Unsigned int APID enum -1~7 默认 0 rateLevel APZoneName APGroupName permissionMode M M O M Unsigned int Unsigned char[128] Unsigned char[128] enum -1 ~ 2 默认 0

Soap消息举例：

1 2 12345678998765432112 111111111

第23页, 共29页

内部公开

0 0

test

3.9.2 响应参数

Soap消息举例：

1 2 12345678998765432112 111111111

第24页, 共29页

内部公开

3.10 位置信息变更

通过AP用户的唯一标识，清空该用户的位置绑定信息，同时，若该用户的AP区域名发生变更了，AHR将会对该AP用户做搬迁处理。

3.10.1 请求参数

参数名称是否必须提供(M是，O为可选) M 参数类型值范围参数描述 interfaceVersion Unsigned char 可以作为版本号提供接口兼容性消息序列号 AP唯一标识 AP区域名 serialNo APIdentity APZoneName M M M Unsigned int APID Unsigned char[128]

Soap消息举例：

1 2 12345678998765432112 111111111

第25页, 共29页

内部公开

3.10.2 响应参数

Soap消息举例：

1 2 12345678998765432112 111111111

3.11 位置指示信息配置

通过AP用户的唯一标识，配置该AP用户的位置指示信息（目前只提供闪信设置）。

第26页, 共29页

内部公开

3.11.1 请求参数

参数名称是否必须提供(M是，O为可选) M 参数类型值范围参数描述 interfaceVersion Unsigned char 可以作为版本号提供接口兼容性消息序列号 AP唯一标识闪信信息 serialNo APIdentity SMSInfo M M O Unsigned int APID Unsigned char[70]

Soap消息举例：

1 2 12345678998765432112 111111111

第27页, 共29页

内部公开

3.11.2 响应参数

Soap消息举例：

1 2 12345678998765432112 111111111

4 常见错误码定义

错误码值 24019 24121 24145 24027 24148 24130

错误码描述无效的IMSI号，IMSI必须是6~15位数字准入UE 的IMSI不在合法号段内该AP 区域中可添加的AP 已达到上限同时接入UE总量已超过License允许的上限 AP用户数量已超过License允许的上限 license不支持第28页, 共29页

内部公开

40014 24028 24126 AP 的IMSI 号在系统中已存在重复开户无效的AP IMSI号，IMSI在系统中不存在以上定义的只是基本的常见错误类别，在实际调测中会不断扩充错误类别。