QB-GF-003-2003 providerServiceID string userID ?
M 能力提供者业务平台标识 调用用户标识 user_id_schema M
ServiceIOPDeactivateResp 字段名 类型 是否必选 功能设置结果: Result Integer 必选 0:互通取消成功 1:用户未定购对端业务平台提供的业务 2:未设置互通 描述
5.3.3 VGOP-R2.1-03:互通设置信息同步接口 1. 功能描述
VGOP向业务平台发起的用户互通设置同步。
2. 接口消息
消息名 IOPConfSyncReq IOPConfSyncResp 消息类型 Request Response 消息描述 互通设置请求接口消息 互通设置应答接口消息 消息方向 VGOP ?业务平台 业务平台? VGOP
3. 消息体定义
?
IOPConfSyncReq 字段名 callerServiceID providerServiceID userID sync_Type expireTime string string user_id_schema String String 类型 是否必选 M M M 必选 可选 描述 能力调用者业务平台标识 能力提供者业务平台标识 调用用户标识 同步操作类型: Add:设置 Remove:取消设置 失效时间,从1970年1月1日0时开始的毫秒数 8
QB-GF-003-2003 expireAction String 可选 过期后行为: Cancel 到过期时间,取消互通设置 Alert 提醒。提醒后到期还是取消 expireAlertDays timeAction integer time_action_list_schema ?
IOPConfSyncResp 字段名 类型 Result
Integer 是否必选 必选 功能设置结果, 0:同步成功 1:用户未定购对端业务平台提供的业务 描述 可选 可选 到了过期时间前提醒的天数 每天某个时间段进行某动作 5.4 能力互通控制类接口定义
5.4.1 VGOP-R2.2-01:互通调用鉴权接口 1. 功能描述
平台互通时,向VGOP发送互通调用鉴权请求,并获得互通调用令牌(token)的接口。
2. 接口消息
消息名 ServiceIOPAuthReq 消息类型 Request 消息描述 业务调用方向VGOP发起互通调用鉴权请求 ServiceIOPAuthResp Response 业务调用方向VGOP发起互通调用鉴权应答 VGOP?飞信平台 消息方向 飞信平台?VGOP
3. 消息体定义
?
ServiceIOPAuthReq
9
QB-GF-003-2003 字段名称 (空) ?
ServiceIOPAuthResp 字段名 Result IFURL Token
类型 Integer String 是否必选 功能设置结果, 必选 M 0:鉴权通过 其他值:鉴权未通过,错误代码 调用的接口URL 返回调用token,具体内容待定义 描述 字段类型 是否必选 字段描述 token_schema 必选 5.5 平台能力调用类接口描述
能力平台调用类接口为能力调用者平台向VGOP发送能力调用请求并获得能力调用结果的接口,对应VGOP的R2.3参考点。当需要进行能力互通调用时,能力调用者业务平台将通过本类接口向VGOP发起互通调用请求。
VGOP接口规范对本类接口的框架,包括接口形式、协议、命名规则、通用消息头等进行规范。本类接口应遵循本章节所定义接口框架,消息体内具体字段定义由能力调用者业务平台的接口规范定义。
附录B中以飞信调用手机邮箱为例,给出该类接口具体形式的参考建议。
5.6 平台能力提供类接口描述
平台能力提供类接口为能力提供者平台向VGOP开放能力使用的接口,对应VGOP的R2.4参考点。在有能力互通调用请求的情况下,VGOP向能力提供者平台发起能力调用请求的接口。也可以是能力提供者平台主动向VGOP发起能力提供的消息(数据通知类)。
VGOP接口规范对本类接口的框架,包括接口形式、协议、命名规则、通用消息头等进行规范。本类接口应遵循本章节所定义接口框架,消息体内具体字段定义由能力调用者业务平台的接口规范定义。
附录B中以飞信调用手机邮箱为例,给出该类接口具体形式的参考建议。
5.7 能力互通访问类接口描述
能力互通访问接口为能力调用者业务平台直接调用能力提供者业务平台业的接口。当能力调用者平台需要调用其他业务平台的业务能力(互通访问)时,将通过VGOP互通调用鉴权接口向VGOP进行鉴权请求,获得调用令牌后,直接通过本类接口访问能力提供者业务平台。
本类接口为业务平台间调用接口,VGOP不对该接口的框架或具体内容进行规范。
附录B中以飞信调用手机邮箱为例,给出该类接口具体形式的参考建议。
10
QB-GF-003-2003 5.8 返回值定义
通用返回码
错误代码 说明 100 无效的XML 200 版本号错误 201 接口类型编号错误 202 接口消息名称错误 221 能力调用者业务平台标识错误 222 能力提供者业务能力标识错误 223 用户未定购对端业务平台提供的能力 224 用户定购对端业务 241 操作权限错误 242 手机号码格式不正确 别名格式不正确 800 错误请求 801 通讯失败 999 未知错误
VGOP相关返回码
错误代码 说明 401 鉴权未通过-被调用能力标识不存在 402 鉴权未通过-被调用能力权限错误 403 鉴权未通过-业务调用用户权限错误 404 用户互通设置:已经存在本互通设置
业务平台相关返回码
错误代码 说明 601 Token标识非法 602 Token标识过期 603 操作权限错误,试图操作不属于本邮箱节点的用户
5.9 Schema定义
? user_id_schema(用户标识) 字段名称 字段类型 字段描述 11
QB-GF-003-2003 UserIDType integer 用户标识类型 1:用手机号标识 2:用伪码标识 3:两者同时标识 MSISDN PseudoCode ? token _schema:令牌结构
数据类型 说明 String 被调用的能力编码 String String String String 时间戳,从1970年1月1日0时开始的毫秒数,时区为东八区 用户的唯一标识 失效时间,从1970年1月1日0时开始的毫秒数 用户在该能力的授权信息?? 认证结果。 几个主要的相关取值列举如下: Result Int 0: 用户认证通过 -1:用户错误 -2:参数错误
string binary 用户手机号 用户伪码 名称 providerEnablerID timeStamp userID expireTime userProfile Token的生成算法如下:
Digest = Base64(SHA1 (Result + “$” + UserID + “$” + TimeStamp + “$” + ExpireTime + “$” + UserProfile))
其中,Hash算法采用SHA-1。 Token = URLEncoding(CapID + “$”+ Base64(Encrypt (Result + “$” + UserID + “$”+ TimeStamp + “$” + ExpireTime + “$” + UserProfile + “$”+ Digest)))
其中,加密算法采用3DES,Key=ServiceSecret,ServiceSecret是VGOP颁发给该业务平台的密钥。 ? ? address_info_schema user_id_list_schema 字段类型 user_id_schema [] 字段描述 多个UserID 字段名称 userID ? unread_mail_num_list_schema 字段类型 字段描述 字段名称 12