QB-GF-003-2003 4. 总体技术要求
4.1 消息类
4.1.1 协议 4.1.2 命名规则 4.1.3 接口双方责任
4.2 文件类
4.2.1 协议 4.2.2 命名规则 4.2.3 接口双方责任
4.3 数据库类
4.3.1 协议 4.3.2 命名规则 4.3.3 接口双方责任
3
QB-GF-003-2003 5. VGOP能力互通调用接口
5.1 接口技术要求
5.1.1 接口传输方式/接口协议
VGOP能力互通调用接口均为消息类接口，采用HTTP+XML协议，即基于HTTP的XML协议。接口传输采用基于HTTP的接口调用方式，要求HTTP的版本为1.1以上。接口内容信息采用XML进行描述。
消息发起的平台应支持超时重发机制，若业务平台在超时时间内未收到互通设置应答信息，则应重发互通设置请求。重发次数和重发间隔可配置。
平台在发送消息请求后但收到HTTP错误响应，则应根据应答消息的HTTP错误代码做异常处理。
5.1.2 接口消息说明
命名规则在本章节中保持统一。
接口消息名必须以动词或动词短语命名，单词间直接连接，每个单词首字母大写，缩略语全部大写。 消息内容定义中，消息字段（元素）参数名必须以名词或名词短语命名，单词间直接连接，第一个单词小写，以后每个单词首字母大写，缩略语全部大写。对用Schema定义的字段，在单词间加’_’连接符。
字段类型说明如下： ? int： 十进制的整数型； ? ? ? ?
u_int： 十进制的无符号整数型； string： 由char组成的字符串；
binary： 由byte组成的字符串，由于XML不能直接承载二进制数据，所以对该类型的数据采用BASE64编码； _schema：结构体类型。
5.1.3 消息结构
本章中所有接口的消息协议数据单元（PDU）由消息头（header）和消息体（body）组成。 消息头和消息体在xml中的表现形式如下：
< Element1>消息头元素一
< Element2>消息头元素二 < Element3>消息头元素三
4
QB-GF-003-2003
< Element1>消息体元素一 < Element2>消息体元素二 < Element3>消息体元素三
5.1.4 通用消息头
本小节定义本章节中所有接口消息所需遵循的通用消息头（header）。除非特殊说明，否则在本章节各接口均适用本小节定义的通用消息头。在本章节定义的接口中，各接口请求消息的消息头中包含的字段定义如下：
字段名称 version transactionID callerServiceID providerServiceID providerEnablerName providerInterfaceName operation userID timestamp
响应通用消息头定义： version transactionID
integer string M M 版本号，长度4字节 操作交易序列号，长度16字节 字段类型 integer string string string string string string user_id_schema string 是否必选 M M M M M M M M M 字段描述 版本号，长度4字节 操作交易序列号，长度16字节 能力调用者业务平台标识 能力提供者业务平台标识 能力提供者业务能力名称 能力提供者业务接口名称 操作消息名定义，具体参见接口定义 调用用户标识 时间戳 5.2 接口列表
接口类 接口名称 接口描述 接口协议 发起方/提供方 落地方 5
QB-GF-003-2003 用户互通VGOP-R2.1-01：用户设置类 互通设置接口 VGOP-R2.1-02：取消用户互通设置接口 VGOP-R2.1-03：互通设置信息同步接口 能力互通VGOP-R2.2-01：互通控制类 调用鉴权接口 业务平台向VGOP发起用户互通设置 业务平台向VGOP取消用户互通设置 VGOP向业务平台同步用户互通设置信息 业务平台向VGOP发起互通调用鉴权 HTTP+XML 业务平台 ? VGOP HTTP+XML 业务平台 ? VGOP HTTP+XML VGOP ? 业务平台 HTTP+XML 业务平台 ? VGOP HTTP+XML 业务平台 ? VGOP 能力调用对应VGOP参考点R2.3 接口类 业务平台通过VGOP发起能力互通调用的接口 能力提供对应VGOP参考点R2.4 接口类 业务平台向VGOP进行能力提供的接口类 HTTP+XML VGOP ? 业务平台 业务平台 ? VGOP 业务平台 ? 业务平台 能力互通业务平台间相互调用的接口类 访问接口
5.3 用户互通设置类接口定义
5.3.1 VGOP-R2.1-01：用户互通设置接口 1. 功能描述
此接口用于用户在业务平台上向VGOP发起能力互通设置。
2. 接口消息
消息名 ServiceIOPActivateReq ServiceIOPActivateResp 消息类型 Request Response 消息描述 互通设置请求接口消息 互通设置应答接口消息 消息方向 业务平台?VGOP VGOP?业务平台
3. 消息体定义
?
ServiceIOPActivateReq 字段名 类型 是否必选 描述 6
QB-GF-003-2003 callerServiceID string M M M O O 能力调用者业务平台标识 能力提供者业务平台标识 调用用户标识 过期时间 过期后行为 Cancel 到过期时间，取消互通设置 Alert 提醒。提醒后到期还是取消 expireAlertDays timeAction ?
integer O 到了过期时间前提醒的天数 每天某个时间段进行某动作 providerServiceID string userID expireTime expireAction user_id_schema String String time_action_list_schema O
ServiceIOPActivateResp 字段名 类型 Result Integer 是否必选 返回值：0成功 M 描述 111 用户订购的资费不够支持此能力互通 其他参考5.8返回值定义
5.3.2 VGOP-R2.1-02：用户互通设置取消接口 1. 功能描述
此接口用于用户通过业务平台向VGOP发起取消业务互通设置的请求。
2. 接口消息
消息名 ServiceIOPDeactivateReq ServiceIOPDeactivateResp 消息类型 Request Response 消息描述 取消互通设置请求接口消息 取消互通设置请求接口消息 消息方向 业务平台?VGOP VGOP?业务平台
3. 消息体定义
?
ServiceIOPDeactivateReq 字段名 类型 callerServiceID string 是否必选 M 能力调用者业务平台标识 描述 7