中国联通增值业务鉴权中心接口规范 VAC与增值业务系统接口分册(V1.1) srcDeviceID String 1 发端设备ID 联通指定,可配置; userID userIDType String Integer 1 1 用户号码 0:MSISDN 业务类型,无本字段时查询所有业务定购关系 SP归属地域代码 ServiceType string 0…n SPAreaID string 0或1 取值见VAC与BSS规范附录A.2,无本字段时表示查询所有地域定购关系 SPID String 0..1 查询的企业代码,无此参数表示查询所有SP的定购关系 输出参数
参数名 streamingNo 类型 String 出现次数 1 注释 将调用的StreamingNo原样返回,保证调用/返回的同步 resultCode subInfo Integer SubInfo 1 0…n 参见附录D 定购关系列表 SubInfo 数据类型
参数名 类型 出现次数 注释 VACSub Integer 1 和产品信息中字段取值一致 是否可以从终端侧单独定购/退订 0 不可以单独定购/退定 1 可以单独定购/退定 2 后付费用户不可以单独定购/退定 3 后付费用户可以单独定购/退定 4 SCP用户不可以单独定购/退定 5 SCP用户可以单独定购/退定 SPID String 1 企业代码 21
中国联通增值业务鉴权中心接口规范 VAC与增值业务系统接口分册(V1.1) SP_ProductID SPEC_ProductID String String 1 1 所定购的产品的SP_ProductID,参见BSS接口规范 所定购的产品的SPEC _ProductID,参见BSS接口规范 ProductID status subscribeTime effectiveTime expireTime suspendTime resumeTime OA OAType DA String Integer Datetime Datetime Datetime Datetime Datetime String Integer String 1 1 1 1 1 0…1 0…1 1 1 1 所定购的产品的ProductID,参见BSS接口规范 0:正常 用户定购请求发起时间 定购关系生效时间 定购关系失效时间 保留字段,填空 保留字段,填空 定购方用户号码 0:MSISDN 使用方用户号码,默认与定购方相同,用户赠送时为受赠方号码 DAType FA FAType corpID Integer String Integer String 1 1 1 0...1 0:MSISDN 保留字段,填空 0:MSISDN 用户所属的集团ID,集团为集团成员定购时填写 Wsdl见附录E
4.4 查询用户信息接口 4.4.1 接口描述
通过此接口实时查询用户信息。
4.4.2 发起方系统
增值系统
4.4.3 接受方系统
VAC
4.4.4 接口协议
该接口采用Web Service方式。 4.4.5 接口内容
4.4.5.1 用户信息查询请求(UserIdRequest) 参数名 srcDeviceType srcDeviceID 类型 Integer string 大小 1 20 描述 发端设备类型,填写发端设备的具体类型,见附录B; 发端设备ID,联通指定,可配置; UserId string 36 用户手机号码或伪码 22
中国联通增值业务鉴权中心接口规范 VAC与增值业务系统接口分册(V1.1)
UserIdType填1 为手机号码 UserIdType填2 为伪码 UserIdType integer 4 用户ID类型 1: MSISDN 2: PsedoCode
4.4.5.2 用户信息查询响应(UserInfoResponse)
参数名 UserInfo ResultCode 类型 UserInfo integer 字节大小 UserInfo 4 用户信息 结果识别码 0:成功 1:失败 2:用户不存在 3:用户状态不正确(扩展,暂时未使用) 描述
4.4.5.3 用户信息结构
? 用户信息(UserInfo) 序号 1 参数名 UserId 说明 用户手机号码或伪码 UserIdType填1 为手机号码 UserIdType填2 为伪码 用户ID类型 1: MSISDN 2: PsedoCode MDN 伪码 IMSI 用户状态(VAC状态) 用户付费类型 0 后付费 1 预付费 参数类型 string integer 4 string string string integer integer 4 M 5 20 36 15 4 M O O M M 最大长度 36 M 是否必填 M 2 3 4 5 6 7 UserIdType Msisdn FakeId IMSI UserStat UserType 8 Userbrand 用户品牌,采用编码方式表示,string 具体编码取值对应的品牌由需要本字段的系统保存静态表,自行维护。 预用户付费SCP或OCS属性 0 SCP 1 OCS 用户归属的SCP/OCSID 用户服务类型,具体取值见VAC与BSS接口规范附录A.26 23 integer 4 string Integer 1 16 M 9 10 11 userSCPType UserPrepaidID userServiceType M M
中国联通增值业务鉴权中心接口规范 VAC与增值业务系统接口分册(V1.1)
4.5 用户信息同步接口 4.5.1 接口方式
接口协议:FTP
4.5.2 文件目录
VAC系统将用户信息存放到VAC中文件服务器的指定目录下,双方通过文件传输实现接口。文件服务器上设定具有对相应目录存取权限的用户。VAC为业务系统分配具有存取文件权限的用户。
? 存放批量请求文件工作目录:<根目录>/
? 存放正确批量回执文件工作目录:<根目录>/
统>/
? 存放全量正确回执文件工作目录:<根目录>/
统>/
? 存放文件级错误回执文件工作目录:<根目录>/
统>/
? 存放全量文件级错误回执文件工作目录:<根目录>/
统>/
? <根目录>/
? 其中/right和/bad目录下只有文件头,没有文件体;/semiwrong目录下既有文件头,也有文件
体,文件体表示错误记录。
4.5.3 文件格式
文件采用ASCII文本格式,联机命令文件体中每条记录的属性值按顺序排列,各属性间使用‘\\t’分隔,在生成记录时若相应的属性值为空,直接用分隔符隔开,分隔符之间无其他符号。
文件体中一行作为一条联机命令记录,各条记录之间用换行符作为分隔并在文件中连续书写,文件体不定长。
VAC系统于定期凌晨1:00进行增量同步,业务系统于定期凌晨2:00后可进行资料读取,全量同步时间及周期可调。
具体见VAC与BSS接口规范:5.4.2.3 文件格式。
4.6 用户号段同步接口 4.6.1 接口描述
用户号段信息由CRM统一配置,同步给VAC,并由VAC同步给需要的业务引擎。
VAC系统将本省用户号段信息存放到VAC中文件服务器的指定目录下,双方通过文件传输实现接口。文件服务器上设定具有对相应目录存取权限的用户。VAC为业务系统分配具有存取文件权限的用户。
文件采用ASCII文本格式,文件体中每条记录的属性值按顺序排列,各属性间使用‘\\t’分隔,在生成记录时若相应的属性值为空,直接用分隔符隔开,分隔符之间无其他符号。
文件体中一行作为一条记录,各条记录之间用换行符作为分隔并在文件中连续书写。 文件头定长,文件体不定长。 文件的维护由VAC系统负责。
VAC系统于定期凌晨1:00进行资料同步,业务系统于定期凌晨2:00后可进行资料读取,VAC系统定期(可设定)对已生成文件进行清除。 4.6.2 接口协议
FTP文件方式
24
中国联通增值业务鉴权中心接口规范 VAC与增值业务系统接口分册(V1.1)
4.6.3 接口内容
VAC系统将请求文件放到业务系统指定目录下,业务系统将执行结果放回自身相应目录下。
具体见VAC与BSS接口规范:5.3.5.1 文件目录、5.3.5.2 文件命名、5.3.5.3 请求文件头(定长)、5.3.5.4 回执文件头(定长)、5.3.5.5 请求文件体、5.3.5.6 回执文件体(变长)。
4.7 测试用户同步接口 4.7.1 接口描述
测试用户信息由VAC从CRM中获取,具体可以采用线下等方式。
VAC从CRM获取测试用户信息后,通过本接口传递给门户。门户获取测试用户信息,并针对测试用户组,SP测试用户可以看到SP的所有产品和套餐(包括测试业务),运营商测试用户可以看到所有产品和套餐(包括测试业务)。普通用户不能看到测试业务。
VAC系统将测试用户全量信息存放到VAC中文件服务器的指定目录下,双方通过文件传输实现接口。文件服务器上设定具有对相应目录存取权限的用户。VAC为门户分配具有存取文件权限的用户。
文件采用ASCII文本格式,文件体中每条记录的属性值按顺序排列,各属性间使用‘\\t’分隔,在生成记录时若相应的属性值为空,直接用分隔符隔开,分隔符之间无其他符号。
文件体中一行作为一条记录,各条记录之间用换行符作为分隔并在文件中连续书写。 文件头定长,文件体不定长。 文件的维护由VAC系统负责。
每次全量同步,VAC系统于定期凌晨1:00进行资料同步,门户于定期凌晨2:00后可进行资料读取。 4.7.2 接口协议
FTP文件方式 4.7.3 接口内容
(1) 文件目录
VAC系统将请求文件放到业务系统指定目录下,业务系统将执行结果放回自身相应目录下。 存放请求文件工作目录:<根目录>/
存放正确回执文件工作目录:<根目录>/
存放完全错误回执文件工作目录:<根目录>/
存放部分错误回执文件工作目录:<根目录>/
(2) 文件命名
批文件名按如下规则命名:TestUserGroupInfoyyyymmddhhmmxxxnnnn.ttt
yyyymmddhhmm为批文件产生的年月日时分。xxx为省分代码。nnnn 是4位序列号,每天从“0001”开始,到达”9999”后又从“0001”开始。ttt表示文件类型,req表示请求,res表示请求结果。每一个req文件都应该有一个res文件与其对应。
(3) 请求文件头(定长)
序号 1 2 3 4 5 6 属性名 文件序列号(流水号) 版本信息 文件产生时间 文件生成方系统代码 记录开始日期时间 记录结束日期时间 长度 CHAR(4) CHAR(5) CHAR(14) CHAR(3) CHAR(14) CHAR(14) 25
备注 0001开始,排满9999后重新循环 缺省:00000 Yyyymmddhhmmss 104 Yyyymmddhhmmss Yyyymmddhhmmss