VGOP接口规范-能力互通接口（合）-v0.71

中国移动通信企业标准

QB- - -

VGOP 接口规范

Platform Interface Specification

版本号：

发布 实施

中国移动通信集团公司 发布

QB-GF-003-2003

目 录

1. 适用范围 ......................................................................................................................................1 2. 引用标准 ......................................................................................................................................2 3. 接口总体视图 ...............................................................................................................................2 4. 总体技术要求 ...............................................................................................................................3

4.1 消息类............................................................................................................................3

4.1.1 协议 ........................................................................................................................3

4.1.2

命名规则 .................................................................................................................3

4.1.3 接口双方责任 ..........................................................................................................3 4.2 文件类............................................................................................................................3

4.2.1

4.2.2 4.2.3 4.3

4.3.1 4.3.2 4.3.3

协议 ........................................................................................................................3 命名规则 .................................................................................................................3 接口双方责任 ..........................................................................................................3 协议 ........................................................................................................................3 命名规则 .................................................................................................................3 接口双方责任 ..........................................................................................................3

数据库类 ........................................................................................................................3

5. VGOP能力互通调用接口..............................................................................................................4

5.1 接口技术要求 .................................................................................................................4

5.1.1

通用技术要求 ............................................................................错误！未定义书签。

5.1.2 通用消息头................................................................................错误！未定义书签。 5.2 接口列表 ........................................................................................................................5 5.3

用户互通设置类接口定义................................................................................................6

5.3.1 VGOP-R2.1-01：用户互通设置接口..........................................................................6

5.3.2 VGOP-R2.1-02：用户互通设置接口..........................................................................7 5.3.3 VGOP-R2.1-03：互通设置信息同步接口...................................................................8 5.4 能力互通控制类接口定义................................................................................................9

5.4.1 VGOP-R2.2-01：互通调用鉴权接口..........................................................................9 5.5 5.6 5.7 5.8 5.9

平台能力调用类接口描述.............................................................................................. 10 平台能力提供类接口描述.............................................................................................. 10 能力互通访问类接口描述.............................................................................................. 10 返回值定义................................................................................................................... 11 Schema定义 ................................................................................................................. 11

6. 附录A. 飞信和手机邮箱能力互通相关接口参考............................................................................1

6.1 飞信-手机邮箱平台能力调用类接口参考建议 ..................................................................1

6.1.1

6.1.2 6.1.3 6.1.4 6.1.5

FETION-VGOP-R2.3-01：飞信平台到VGOP查询未读邮件数接口............................2 FETION-VGOP-R2.3-02：订阅未读邮件数通知接口 .................................................3 FETION-VGOP-R2.3-03：取消订阅未读邮件数通知接口 ..........................................5 FETION-VGOP-R2.3-04：通知未读邮件数接口 ........................................................4 FETION-VGOP-R2.5-05：手机邮箱别名更新接口 .......................错误！未定义书签。

I

QB-GF-003-2003 6.2

飞信-手机邮箱平台能力提供类接口参考建议 ..................................................................1

6.2.1 MEM-VGOP-R2.4-01：手机邮箱提供未读邮件数接口 ................错误！未定义书签。 6.2.2 MEM-VGOP-R2.4-02：手机邮箱别名查询接口 .........................................................2 6.3 飞信-手机邮箱能力互通访问类接口参考建议 ..................................................................2

6.3.1 FETION-MEM-R2.301：飞信平台到手机邮箱未读邮件数查询接口 ...........................6 7. 附录B. 业务流程参考 ................................................................................................................ 10 7.1 用户设置互通流程 ........................................................................................................ 10

7.1.1

7.1.2 7.2

7.2.1 7.2.2 7.2.3 7.2.4 7.3

用户互通设置流程 ................................................................................................. 10 用户取消互通设置流程 .......................................................................................... 12 方案A：控制流和业务流分离查询方案（推荐方案）............................................. 12 方案B：控制流和业务流不分离查询方案 .............................................................. 13 方案C：控制流和业务流分离订阅方案 .................................................................. 17 方案D：控制流和业务流不分离订阅方案 .............................................................. 19

查询未读邮件数流程..................................................................................................... 12

手机邮箱用户别名更新通知流程 ................................................................................... 14 7.3.1 方案A：控制流和业务流分离别名更新通知（推荐方案）..........错误！未定义书签。

7.3.2 方案B：控制流和业务流不分离方案 .........................................错误！未定义书签。 7.4 SSO登录流程 ............................................................................................................... 16

7.4.1 飞信SSO登录手机邮箱流程 .................................................................................. 16

II

QB-GF-003-2003 1. 适用范围

本规范规定了中国移动数据增值业务运营平台与各个业务网关以及应用平台之间的接口，以保证系统的互连互通及业务的实现。

本规范主要适用于中国移动数据增值业务运营平台，提供平台和业务平台、业务网关之间的连接的规范和技术实现规范。

本规范描述的是数据业务在运营过程中涉及到的业务接口，有关网管、系统管理的接口不在本规范的描述范围之内，具体请参见设备规范。

1

QB-GF-003-2003

2. 引用标准

下列标准所包含的条文，通过在本标准中引用而成为本标准的条文。本标准出版时，所示版本均为有效。所有标准都会被修订，使用本标准的各方应探讨使用下列标准最新版本的可能性。

3. 接口总体视图

参见技术规范中相关内容（写明章节）

2

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中的表现形式如下：

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

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

QB-GF-003-2003 userIDList user_id_list_schema 多个UserID mailNumList Integer[] 多个未读邮件数 ? time_action_list_schema (时段动作) 字段名称 字段类型 字段描述 timeAction time_action_schema[] ? time_action_ schema (时段动作) 字段名称 字段类型 字段描述 startTime String 失效时间，从1970年1月1日0时开始的毫秒数 endTime String 失效时间，从1970年1月1日0时开始的毫秒数 action String 时间段动作

13

QB-GF-003-2003 附录A 飞信和手机邮箱能力互通相关接口参考

本附录针对第5章“VGOP能力互通调用接口”，对平台能力调用类接口、平台能力提供类接口和能力互通访问类接口的具体字段定义以飞信和手机邮箱互通为例，给出参考性建议。最终接口具体字段定义请参阅飞信平台或手机邮箱平台的接口规范。

A.1 平台能力调用类接口参考建议

本节描述飞信调用手机邮箱，通过VGOP平台发起调用的接口类。该接口类对应VGOP参考点R2.3，各接口必须遵循VGOP能力互通调用接口定义的框架。

本节定义的接口类中可能包含如下接口：

?

FETION-VGOP-01：飞信平台到VGOP查询未读邮件数接口

该接口用于飞信平台向VGOP查询用户的未读邮件数量，VGOP返回应答。一次请求中查询数量可配置。 ?

FETION-VGOP-02：订阅未读邮件数通知接口

此接口用于飞信客户端需要查询手机邮箱的未读邮件数量，飞信平台向VGOP订阅未读邮件数通知。订阅了后，VGOP将根据一定的策略通知飞信平台最新的未读邮件数量。 ? ?

FETION-VGOP-03：取消订阅未读邮件数通知接口

此接口用于飞信平台向VGOP取消订阅未读邮件数通知。

FETION-VGOP-04：通知未读邮件数接口

某用户通过飞信平台向VGOP订阅了未读邮件数后，当有未读邮件有更新时，VGOP通知飞信FETION-VGOP-05：绑定查询邮箱别名接口

此接口用于飞信平台向VGOP查询手机邮箱别名。 MEM-VGOP-06：更新未读邮件接口

此接口用于手机邮箱向VGOP更新未读邮件数。 MEM-VGOP-07：更新手机邮箱别名接口 此接口用于手机邮箱向VGOP更新别名。

平台最新的未读邮件数量。 ? ? ?

A.2 平台能力提供类接口参考建议

本节描述飞信与手机邮箱互通中，手机邮箱业务能力向VGOP平台提供被飞信平台调用的的接口类。该接口类对应VGOP参考点R2.4，各接口必须遵循VGOP能力互通调用接口定义的框架。 本节定义的接口中可能包含如下接口：

? ?

VGOP-MEM-01：绑定查询手机邮箱别名接口

此接口用于飞信平台通过VGOP向手机邮箱查询别名。 VGOP-FETION-02：更新手机邮箱别名接口

此接口用于VGOP向飞信平台更新手机邮箱别名。

1

QB-GF-003-2003 A.2.1 FETION-MEM-R2.4-01：绑定查询手机邮箱别名接口 1. 接口含义

用户在飞信上进行手机邮箱能力绑定时，先在VGOP上进行互通设置后，然后从飞信平台向手机邮箱平台发起查询邮箱别名的请求。此操作执行时，VGOP需要进行互通鉴权与路由。手机邮箱接收到查询请求后，检查用户是否有别名设置，如果没有，则根据传过来的飞信号参数，默认把别名设置为飞信号，并返回别名。

2. 接口消息

消息名 BindingQueryAliasReq BindingQueryAliasResp 消息类型 Request Response 消息描述 更改别名请求 更改别名响应 消息方向 FETION ?MEM MEM?FETION 3. 接口字段定义：

?

BindingQueryAliasReq 请求消息字段： 字段名 类型 是否必选 User_ID Fetion_ID ?

user_id_schema 必选 必须 integer 用户标识 用户飞信号 描述

BindingQueryAliasResp 应答消息字段： 字段名 类型 是否必选 Result Alias Integer String 必选 必须 描述 返回值：0成功 其他参考5.8返回值定义 邮箱别名

A.2.2 FETION-MEM-R2.4-02：查询未读邮件数接口 1. 接口描述

该接口用于飞信平台向手机邮箱平台查询用户的未读邮件数量。此接口支持批量查询，一次请求中查询数量可配置。执行此查询接口时，需要经过VGOP进行互通鉴权与路由。

2. 接口消息

2

QB-GF-003-2003 消息名 QueryUnreadMailNumReq QueryUnreadMailNumResp

消息类型 Request Response 消息描述 用户未读邮件数量查询请求 用户未读邮件数量查询响应 消息方向 FETION?MEM MEM?FETION 3. 消息字段定义

?

QueryUnreadMailNumReq 字段名 类型 Batch_Count UserID_list ?

QueryUnreadMailNumResp 字段名 类型 ResultCode Batch_Count Unread_Mail_Num

Integer Integer unread_mail_num_list_schema 是否必选 必须 必选 必选 返回值：0成功 其他参考5.8返回值定义 应答中包括的用户数 对应每个用户的未读邮件数 描述 Integer user_id_ list_schema 是否必选 必选 必选 查询用户数 待查询的多个用户标识 描述 A.2.3 FETION-MEM-R2.4-03：订阅未读邮件数通知接口 1. 接口描述

此接口用于飞信客户端需要查询手机邮箱的未读邮件数量，飞信平台先向手机邮箱平台订阅未读邮件数通知。订阅了后，手机邮箱平台将根据一定的策略通知飞信平台最新的未读邮件数量。订阅与通知都需要经过VGOP进行互通鉴权与路由。

2. 接口消息

消息名 SubscribeUnreadMailNumReq 消息类型 Request 消息描述 订阅未读邮件数通知请求 订阅未读邮件数通知响应 消息方向 FETION?MEM MEM?FETION SubscribeUnreadMailNumResp Response

3. 消息字段定义

?

SubscribeUnreadMailNumReq

3

QB-GF-003-2003 字段名 类型 是否必选 订阅的过期时间。 Auto_Unsubscribe_ Timeout Integer 必须 以秒为单位的32位无符号整数；需要在订阅过期之前进行续订。 续订同样也使用此接口。 ?

SubscribeUnreadMailNumResp 字段名 类型 ResultCode

Integer 描述 是否必选 必须 返回值：0成功 描述 其他参考5.8返回值定义 A.2.4 MEM-FETION-R2.4-04：通知未读邮件数接口 1. 接口描述

某用户通过飞信平台向手机邮箱平台订阅了未读邮件数通知后，当未读邮件数有更新时，手机邮箱平台通知飞信平台最新的未读邮件数量。此接口执行时需要通过VGOP进行互通鉴权与路由。

2. 接口消息

消息名 NotifyUnreadMailNumReq 消息类型 Request 消息描述 通知未读邮件数 通知未读邮件数响应 消息方向 MEM?FETION FETION?MEM NotifyUnreadMailNumResp Response

3. 消息字段定义

?

NotifyUnreadMailNumReq 字段名 类型 Unread_Email_Num ?

NotifyUnreadMailNumResp 字段名 类型 ResultCode

Integer 是否必选 必须 描述 返回值：0成功 其他参考5.8返回值定义 Integer 是否必选 必须 未读邮件数量 描述 4

QB-GF-003-2003 A.2.5 FETION-MEM-R2.4-05：取消订阅未读邮件数通知接口 1. 接口描述

此接口用于飞信平台向手机邮箱平台取消订阅未读邮件数通知。

2. 接口消息

消息名 UnsubscribeUnreadMailNumReq UnsubscribeUnreadMailNumResp

消息类型 Request Response 消息描述 消息方向 取消订阅未读邮件数通知请求 飞信?VGOP 取消订阅未读邮件数通知响应 VGOP?飞信 3. 消息字段定义

?

UnsubscribeUnreadMailNumReq 字段名 类型 是否必选 （空） ?

UnsubscribeUnreadMailNumResp 字段名 类型 ResultCode

Integer 描述 是否必选 必须 返回值：0成功 描述 其他参考5.8返回值定义 A.2.6 MEM-FETION-R2.4-06：PUSH别名更新接口 1. 接口含义

手机邮箱平台向VGOP PUSH别名更新。所有手机邮箱用户别名更新后，都向飞信PUSH更新的别名。

2. 接口消息

消息名 PushAliasUpdateReq PushAliasUpdateResp 消息类型 Request Response 消息描述 PUSH别名更新请求 PUSH别名更新响应 消息方向 邮箱平台?飞信平台 飞信平台?邮箱平台 3. 接口字段定义

5

QB-GF-003-2003 ?

PushAliasUpdateReq消息字段描述 字段名 Alias 重要性 必须 String 类型 说明 更新的别名 ? PushAliasUpdateResp消息字段描述 字段名 ResultCode 重要性 必须 integer 类型 说明 返回值：0成功 其他参考5.8返回值定义

A.3 能力互通访问类接口参考建议

本节描述飞信与手机邮箱互通中，飞信与手机邮箱平台直接相互访问的接口类。

此类接口主要用户控制流与业务流分离情况下，业务平台之间先通过VGOP进行相对独立的控制，之后进行直接访问。

A.3.1 FETION-MEM-R2.5-01：查询未读邮件数接口 1. 接口含义

此接口用于飞信平台查询用户未读邮件数量。飞信平台通过该接口直接向手机邮箱平台进行查询请求。

2. 接口消息

消息名 QueryUnreadMailNumReq QueryUnreadMailNumResp 消息类型 Request Response 消息描述 用户未读邮件数查询请求 用户未读邮件数查询响应 消息方向 飞信平台?邮箱平台 邮箱平台?飞信平台 3. 接口字段定义

?

QueryUnreadMailNumReq消息字段描述 字段名 User_ID Token 重要性 必须 必须 类型 user_id_schema String 说明 用户标识 ? QueryUnreadMailNumResp消息字段描述

6

QB-GF-003-2003 字段名 ResultCode 重要性 必须 integer 类型 说明 返回值：0成功 其他参考5.8返回值定义 Unread_Mail_Num 必须 integer 未读邮件数量

A.3.2 FETION-MEM-R2.5-02：订阅未读邮件数通知接口 1. 接口描述

手机邮箱提供未读邮件数能力。飞信平台可直接向手机邮箱通过此接口订阅未读邮件数更新通知。这样当手机邮箱平台检测到未读邮件数有更新时，可以向飞信平台通知更新的未读邮件数量。

2. 接口消息

消息名 SubscribeUnreadMailNumReq SubscribeUnreadMailNumResp

消息类型 Request Response 消息描述 订阅未读邮件数通知请求 订阅未读邮件数通知响应 消息方向 FETION?MEM MEM?FETION 3. 消息字段定义

?

SubscribeUnreadMailNumReq 字段名 类型 是否必选 订阅的过期时间。 Auto_Unsubscribe_ Timeout Integer 必须 以秒为单位的32位无符号整数；需要在订阅过期之前进行续订。 续订也使用这个接口。 ?

SubscribeUnreadMailNumResp 字段名 类型 ResultCode

Integer 描述 是否必选 必须 返回值：0成功 描述 其他参考5.8返回值定义 7

QB-GF-003-2003 A.3.3 FETION-MEM-R2.5-03：取消订阅未读邮件数通知接口 1. 接口描述

此接口用于飞信平台向手机邮箱平台取消订阅未读邮件数通知。

2. 接口消息

消息名 UnsubscribeUnreadMailNumReq 消息类型 Request 消息描述 消息方向 取消订阅未读邮件数通知请求 FETION?MEM 取消订阅未读邮件数通知响应 MEM?FETION UnsubscribeUnreadMailNumResp Response

3. 消息字段定义

?

UnsubscribeUnreadMailNumReq 字段名 类型 （空） ?

UnsubscribeUnreadMailNumResp 字段名 类型 ResultCode

Integer 是否必选 必须 描述 返回值：0成功 其他参考5.8返回值定义 是否必选 描述 A.3.4 MEM-FETION-R2.5-04：通知未读邮件数接口 1. 接口描述

飞信平台向手机邮箱平台订阅了未读邮件数更新通知接口后，当手机邮箱平台检测到某用户的未读邮件数更新时，向飞信平台发起通知。

2. 接口消息

消息名 NotifyUnreadMailNumReq 消息类型 Request 消息描述 通知未读邮件数 通知未读邮件数响应 消息方向 MEM?FETION FETION?MEM NotifyUnreadMailNumResp Response

8

QB-GF-003-2003 3. 消息字段定义

? NotifyUnreadMailNumReq 字段名 类型 是否必选 必须 未读邮件数量 描述 Unread_Email_Num integer ? NotifyUnreadMailNumResp 字段名 类型 Integer 是否必选 必须 描述 返回值：0成功 其他参考5.8返回值定义 ResultCode

A.3.5 MEM-FETION-R2.5-05：PUSH别名更新接口 1. 接口含义

手机邮箱平台向VGOP PUSH别名更新。所有手机邮箱用户别名更新后，都向飞信PUSH更新的别名。

2. 接口消息

消息名 PushAliasUpdateReq PushAliasUpdateResp 消息类型 Request Response 消息描述 PUSH别名更新请求 PUSH别名更新响应 消息方向 邮箱平台?飞信平台 飞信平台?邮箱平台 3. 接口字段定义

?

PushAliasUpdateReq消息字段描述 字段名 Alias 重要性 必须 String 类型 说明 更新的别名 ? PushAliasUpdateResp消息字段描述 字段名 ResultCode 重要性 必须 integer 类型 说明 返回值：0成功 其他参考5.8返回值定义

A.3.6 FETION-MEM-R2.5-08：飞信客户端单点登录手机邮箱SSO接口 1. 接口含义

9

QB-GF-003-2003 飞信客户端URL单点登录访问手机邮箱页面

2. 接口消息

消息名 SSOLoginMailReq SSOLoginMailResp 消息类型 Request Response 消息描述 单点登录手机邮箱URL 手机邮箱URL访问响应 消息方向 飞信客户端?邮箱平台 邮箱平台? 飞信客户端 3. 接口字段定义：

SSOLoginMailReq消息字段描述：

字段名 Token 重要性 必须 类型 说明 String SSOLoginMailResp消息字段描述：

字段名 ResultCode 重要性 必须 integer 类型 说明 返回值：0成功 其他参考5.8返回值定义

附录B 业务流程参考

为读者能够更好的理解本规范定义的VGOP能力互通调用类接口所涉及的流程和数据，本附录以飞信平台和手机邮箱互通场景为例，描述了飞信和手机邮箱之间的互通流程，以及流程中涉及的接口。这些接口在“VGOP能力互通调用接口”章节中和“附录A、飞信和手机邮箱能力互通相关接口参考”中有描述。

B.1 用户设置互通流程

B.1.1 用户互通设置流程

流程概述：用户由飞信平台发起互通设置请求，由VGOP和手机邮箱完成互通设置后，再通过飞信返回给用户互通设置结果。

10

QB-GF-003-2003 手手手手VGOP手手手手1 手手手手手手手手2 手手手手手手手手3 手手手手手手手手手手4 手手手手手手手手手VGOP-R2.1-015 手手手手手手手手6. 手手手手手手手手手手8 手手手手手手手手手手手手手手手手7. 手手手手手手手手VGOP-R2.1-039 手手手手手手手手10 手手手手手手手手手手手手手手手手11 手手手手手手手手手手12. 手手手手手手手手手手13 手手手手手手手手FETION-MEM-R2.4-01

流程说明：

1. 用户在飞信上发起飞信与手机邮箱的互通设置请求，并带飞信号作为参数； 2. 飞信平台向VGOP转发互通设置请求；

3. VGOP进行互通设置鉴权，检查用户是否具有飞信与手机邮箱二个平台的订购关系，以及检查订购

关系是否支持此互通设置； 4. VGOP生成互通设置；

5. VGOP向手机邮箱同步互通设置； 6. 手机邮箱保存用户的互通设置信息； 7. 手机邮箱返回互通设置同步结果；

8. VGOP向飞信平台返回互通设置结果，并同步设置信息；

9. 飞信平台向手机邮箱发送绑定查询邮箱别名请求；

10. 手机邮箱检查用户是否设置别名，如果有则直接返回别名，否则把传过来的飞信号设置为默认的别名；

11. 手机邮箱向飞信平台返回绑定查询别名结果 12. 飞信平台保存互通设置信息；

13. 飞信平台向用户返回互通设置结果

11

QB-GF-003-2003 B.1.2 用户取消互通设置流程

流程概述：用户由飞信平台发起解除绑定请求，由VGOP和手机邮箱完成不能绑定关系解除后，再通过飞信返回给用户解除绑定结果。

手手手手VGOP手手手手1 手手手手手手手手手手2 手手手手手手手手3 手手手手手手5 手手手手手手手手VGOP-R2.1-024 手手手手手手手手6 手手手手手手手手7 手手手手手手手手8 手手手手手手手手9 手手手手手手手手VGOP-R2.1-03

流程说明：

1. 用户在飞信上发起取消互通设置请求； 2. 飞信平台转发取消互通设置请求； 3. VGOP执行取消互通设置；

4. VGOP同步互通设置信息给手机邮箱； 5. 手机邮箱保存新的互通设置信息；

6. 手机邮箱返回同步互通设置结果；

7. VGOP向飞信平台返回取消互通设置应答结果； 8. 飞信平台保存新的互通设置信息；

9. 飞信平台返回取消互通设置应答结果给用户；

B.2 查询未读邮件数流程

B.2.1 方案A：控制流和业务流分离查询方案（推荐方案）

流程概述：飞信平台通过VGOP的能力互通鉴权后拿到token，飞信客户端携带token直接向手机邮箱平台查询未读邮件数。遵循VGOP控制流和业务流分离原则。

12

QB-GF-003-2003 手手手手A.1 手手手手手手手手VGOP手手手手A.2 手手手手手手VGOP-R2.2-01A.3 手手手手手手A.4 手手tokenA.5 手手手手手手手A.6 手手手手手手FETION-MEM-R2.5-01

流程说明：

A.1. 飞信平台向VGOP发送能力互通鉴权请求

A.2. VGOP进行业务互通鉴权，确定飞信平台和手机邮箱之间的互通关系； A.3. VGOP进行用户互通鉴权，确定该用户使用飞信和邮箱互通业务； A.4. VGOP向飞信平台返回应答，携带token

A.5. 飞信平台向手机邮箱平台发起查询请求，携带token； A.6. 手机邮箱平台根据用户标识和token返回查询应答结果

B.2.2 方案B：控制流和业务流不分离查询方案

流程概述：飞信平台向手机邮箱平台发起查询未读邮件数请求，执行此动作过程中VGOP进行互通鉴权。

13

QB-GF-003-2003 手手手手B.1 手手手手手手手手手VGOP手手手手B.2 手手手手手手FETION-MEM-R2.4-02B.3 手手手手手手B.4 手手手手手手手B.5 手手手手手手手手手B.6 手手手手手手手手手

流程说明：

B.1. 飞信平台向VGOP发送查询邮箱未读邮件数请求；

B.2. VGOP进行能力互通鉴权 B.3. VGOP完成用户使用互通能力的鉴权 B.4. VGOP向手机邮箱平台转发查询未读邮件数请求 B.5. 手机邮箱平台向VGOP返回查询未读邮件数应答 B.6. VGOP向飞信平台转发查询未读邮件数应答

B.3 手机邮箱用户别名更新通知流程

B.3.1 方案A：控制流和业务流分离Push方案（推荐方案）

流程概述：手机邮箱平台向飞信平台推送更新的别名。在执行此动作之前，手机邮箱平台需要先到VGOP进行互通鉴权与路由，然后携带token与路由信息直接向飞信平台发起请求。

14

QB-GF-003-2003 D.5. VGOP向飞信平台返回订阅成功，或者失败； D.6. 手机邮箱向VGOP发送未读邮件数通知； D.7. VGOP向手机邮箱返回响应；

D.8. VGOP向飞信平台发送未读邮件数通知； D.9. 飞信平台向VGOP返回通知响应；

D.10. 飞信平台向VGOP发送取消订阅未读邮件通知请求； D.11. VGOP删除订阅关系； D.12. VGOP向飞信平台返回取消订阅应答；

20

本文来源：https://www.bwwdw.com/article/ee03.html