VGOP接口规范-能力互通接口(合)-v0.7.docVIP

中国移动通信集团公司 发布QB- - - 中国移动通信企业标准VGOP接口规范Platform Interface Specification 版本号： 实施 发布目 录1.适用范围12.引用标准23.接口总体视图24.总体技术要求34.1消息类34.1.1协议34.1.2命名规则34.1.3接口双方责任34.2文件类34.2.1协议34.2.2命名规则34.2.3接口双方责任34.3数据库类34.3.1协议34.3.2命名规则34.3.3接口双方责任35.VGOP能力互通调用接口45.1接口技术要求45.1.1通用技术要求45.1.2通用消息头45.2接口列表55.3用户互通设置类接口定义65.3.1VGOP-R2.1-01：用户互通设置接口65.3.2VGOP-R2.1-02：用户互通设置接口65.3.3VGOP-R2.1-03：互通设置信息同步接口75.4能力互通控制类接口定义85.4.1VGOP-R2.2-01：互通调用鉴权接口85.5平台能力调用类接口描述95.6平台能力提供类接口描述95.7能力互通访问类接口描述95.8返回值定义95.9Schema定义96.附录A. 飞信和手机邮箱能力互通相关接口参考116.1飞信-手机邮箱平台能力调用类接口参考建议116.1.1FETION-VGOP-R2.3-01：飞信平台到VGOP查询未读邮件数接口116.1.2FETION-VGOP-R2.3-02：订阅未读邮件数通知接口126.1.3FETION-VGOP-R2.3-03：取消订阅未读邮件数通知接口136.1.4FETION-VGOP-R2.3-04：通知未读邮件数接口136.1.5FETION-VGOP-R2.5-05：手机邮箱别名更新接口146.2飞信-手机邮箱平台能力提供类接口参考建议156.2.1MEM-VGOP-R2.4-01：手机邮箱提供未读邮件数接口156.2.2MEM-VGOP-R2.4-02：手机邮箱别名查询接口156.3飞信-手机邮箱能力互通访问类接口参考建议166.3.1FETION-MEM-R2.301：飞信平台到手机邮箱未读邮件数查询接口167.附录B. 业务流程参考187.1用户设置互通流程197.1.1用户互通设置流程197.1.2用户取消互通设置流程197.2查询未读邮件数流程207.2.1方案A：控制流和业务流分离查询方案（推荐方案）207.2.2方案B：控制流和业务流不分离查询方案227.2.3方案C：控制流和业务流分离订阅方案227.2.4方案D：控制流和业务流不分离订阅方案237.3手机邮箱用户别名更新通知流程247.3.1方案A：控制流和业务流分离别名更新通知（推荐方案）247.3.2方案B：控制流和业务流不分离方案257.4SSO登录流程267.4.1飞信SSO登录手机邮箱流程261. 适用范围本规范规定了中国移动数据增值业务运营平台与各个业务网关以及应用平台之间的接口，以保证系统的互连互通及业务的实现。 本规范主要适用于中国移动数据增值业务运营平台，提供平台和业务平台、业务网关之间的连接的规范和技术实现规范。本规范描述的是数据业务在运营过程中涉及到的业务接口，有关网管、系统管理的接口不在本规范的描述范围之内，具体请参见设备规范。2. 引用标准下列标准所包含的条文，通过在本标准中引用而成为本标准的条文。本标准出版时，所示版本均为有效。所有标准都会被修订，使用本标准的各方应探讨使用下列标准最新版本的可能性。3. 接口总体视图参见技术规范中相关内容（写明章节）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 接口双方责任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中的表现形式如下： 消息头元素一 消息头元素二 消息头元素三 消息体元素一 消息体元素二 消息体元素三 5.1.4 通用消息头本小节定义本章节中所有接口消息所需遵循的通用消息头（header）。除非特殊说明，否则在本章节各接口均适用本小节定义的通用消息头。在本章节定义的接口中，各接口请求消息的消息头中包含的字段定义如下：字段名称字段类型是否必选字段描述versionintegerM版本号，长度4字节transactionIDstringM操作交易序列号，长度16字节callerServiceIDstringM能力调用者业务平台标识providerServiceIDstringM能力提供者业务平台标识providerEnablerNamestringM能力提供者业务能力名称providerInterfaceNamestringM能力提供者业务接口名称operationstringM操作消息名定义，具体参见接口定义userIDuser_id_schemaM调用用户标识timestampstringM时间戳响应通用消息头定义：versionintegerM版本号，长度4字节transactionIDstringM操作交易序列号，长度16字节5.2 接口列表接口类接口名称接口描述接口协议发起方/提供方落地方用户互通设置类VGOP-R2.1-01：用户互通设置接口业务平台向VGOP发起用户互通设置HTTP+XML业务平台 VGOPVGOP-R2.1-02：取消用户互通设置接口业务平台向VGOP取消用户互通设置HTTP+XML业务平台 VGOPVGOP-R2.1-03：互通设置信息同步接口VGOP向业务平台同步用户互通设置信息HTTP+XMLVGOP 业务平台能力互通控制类VGOP-R2.2-01：互通调用鉴权接口业务平台向VGOP发起互通调用鉴权HTTP+XML业务平台 VGOP能力调用接口类对应VGOP参考点R2.3业务平台通过VGOP发起能力互通调用的接口HTTP+XML业务平台 VGOP能力提供接口类对应VGOP参考点R2.4业务平台向VGOP进行能力提供的接口类HTTP+XMLVGOP 业务平台业务平台 VGOP能力互通访问接口业务平台间相互调用的接口类业务平台 业务平台5.3 用户互通设置类接口定义5.3.1 VGOP-R2.1-01：用户互通设置接口1. 功能描述此接口用于用户在业务平台上向VGOP发起能力互通设置。2. 接口消息消息名消息类型消息描述消息方向ServiceIOPActivateReqRequest互通设置请求接口消息业务平台VGOPServiceIOPActivateRespResponse互通设置应答接口消息VGOP业务平台3. 消息体定义l ServiceIOPActivateReq 字段名类型是否必选描述callerServiceIDstringM能力调用者业务平台标识providerServiceIDstringM能力提供者业务平台标识userIDuser_id_schemaM调用用户标识expireTimeStringO过期时间expireActionStringO过期后行为Cancel 到过期时间，取消互通设置Alert 提醒。提醒后到期还是取消expireAlertDaysintegerO到了过期时间前提醒的天数timeActiontime_action_list_schemaO每天某个时间段进行某动作l ServiceIOPActivateResp字段名类型是否必选描述ResultIntegerM返回值：0成功111 用户订购的资费不够支持此能力互通其他参考5.8返回值定义5.3.2 VGOP-R2.1-02：用户互通设置取消接口1. 功能描述此接口用于用户通过业务平台向VGOP发起取消业务互通设置的请求。2. 接口消息消息名消息类型消息描述消息方向ServiceIOPDeactivateReqRequest取消互通设置请求接口消息业务平台VGOPServiceIOPDeactivateRespResponse取消互通设置请求接口消息VGOP业务平台3. 消息体定义l ServiceIOPDeactivateReq字段名类型是否必选描述callerServiceIDstringM能力调用者业务平台标识providerServiceIDstringM能力提供者业务平台标识userIDuser_id_schemaM调用用户标识l ServiceIOPDeactivateResp字段名类型是否必选描述ResultInteger必选功能设置结果：0：互通取消成功1：用户未定购对端业务平台提供的业务2：未设置互通5.3.3 VGOP-R2.1-03：互通设置信息同步接口1. 功能描述VGOP向业务平台发起的用户互通设置同步。2. 接口消息消息名消息类型消息描述消息方向IOPConfSyncReqRequest互通设置请求接口消息VGOP 业务平台IOPConfSyncRespResponse互通设置应答接口消息业务平台 VGOP3. 消息体定义l IOPConfSyncReq 字段名类型是否必选描述callerServiceIDstringM能力调用者业务平台标识providerServiceIDstringM能力提供者业务平台标识userIDuser_id_schemaM调用用户标识sync_TypeString必选同步操作类型：Add：设置Remove：取消设置expireTimeString可选失效时间，从1970年1月1日0时开始的毫秒数expireActionString可选过期后行为：Cancel 到过期时间，取消互通设置Alert 提醒。提醒后到期还是取消expireAlertDaysinteger可选到了过期时间前提醒的天数timeActiontime_action_list_schema可选每天某个时间段进行某动作l IOPConfSyncResp字段名类型是否必选描述ResultInteger必选功能设置结果，0：同步成功1：用户未定购对端业务平台提供的业务5.4 能力互通控制类接口定义5.4.1 VGOP-R2.2-01：互通调用鉴权接口1. 功能描述平台互通时，向VGOP发送互通调用鉴权请求，并获得互通调用令牌（token）的接口。2. 接口消息消息名消息类型消息描述消息方向ServiceIOPAuthReqRequest业务调用方向VGOP发起互通调用鉴权请求飞信平台VGOPServiceIOPAuthRespResponse业务调用方向VGOP发起互通调用鉴权应答VGOP飞信平台3. 消息体定义l ServiceIOPAuthReq字段名称字段类型是否必选字段描述（空）l ServiceIOPAuthResp字段名类型是否必选描述ResultInteger必选功能设置结果，0：鉴权通过 其他值：鉴权未通过，错误代码IFURLStringM调用的接口URLTokentoken_schema必选返回调用token，具体内容待定义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中以飞信调用手机邮箱为例，给出该类接口具体形式的参考建议。5.8 返回值定义通用返回码错误代码说明100无效的XML 200版本号错误201接口类型编号错误202接口消息名称错误221能力调用者业务平台标识错误222能力提供者业务能力标识错误223用户未定购对端业务平台提供的能力224用户定购对端业务241操作权限错误242手机号码格式不正确别名格式不正确800错误请求801通讯失败999未知错误 VGOP相关返回码错误代码说明401鉴权未通过-被调用能力标识不存在402鉴权未通过-被调用能力权限错误403鉴权未通过-业务调用用户权限错误404用户互通设置：已经存在本互通设置业务平台相关返回码错误代码说明601Token标识非法602Token标识过期603操作权限错误，试图操作不属于本邮箱节点的用户5.9 Schema定义l user_id_schema(用户标识)字段名称字段类型字段描述UserIDTypeinteger用户标识类型1：用手机号标识2：用伪码标识3：两者同时标识MSISDNstring用户手机号PseudoCodebinary用户伪码l token _schema：令牌结构名称数据类型说明providerEnablerIDString被调用的能力编码timeStampString时间戳，从1970年1月1日0时开始的毫秒数,时区为东八区userIDString用户的唯一标识expireTimeString失效时间，从1970年1月1日0时开始的毫秒数userProfileString用户在该能力的授权信息？ResultInt认证结果。几个主要的相关取值列举如下：0： 用户认证通过-1：用户错误-2：参数错误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颁发给该业务平台的密钥。l address_info_schemal user_id_list_schema字段名称字段类型字段描述userIDuser_id_schema 多个UserIDl unread_mail_num_list_schema字段名称字段类型字段描述userIDListuser_id_list_schema多个UserIDmailNumListInteger多个未读邮件数l time_action_list_schema (时段动作)字段名称字段类型字段描述timeActiontime_action_schemal time_action_ schema (时段动作)字段名称字段类型字段描述startTimeString失效时间，从1970年1月1日0时开始的毫秒数endTimeString失效时间，从1970年1月1日0时开始的毫秒数actionString时间段动作附录A 飞信和手机邮箱能力互通相关接口参考本附录针对第5章“VGOP能力互通调用接口”，对平台能力调用类接口、平台能力提供类接口和能力互通访问类接口的具体字段定义以飞信和手机邮箱互通为例，给出参考性建议。最终接口具体字段定义请参阅飞信平台或手机邮箱平台的接口规范。A.1 平台能力调用类接口参考建议本节描述飞信调用手机邮箱，通过VGOP平台发起调用的接口类。该接口类对应VGOP参考点R2.3，各接口必须遵循VGOP能力互通调用接口定义的框架。本节定义的接口类中可能包含如下接口：n FETION-VGOP-01：飞信平台到VGOP查询未读邮件数接口该接口用于飞信平台向VGOP查询用户的未读邮件数量，VGOP返回应答。一次请求中查询数量可配置。n FETION-VGOP-02：订阅未读邮件数通知接口此接口用于飞信客户端需要查询手机邮箱的未读邮件数量，飞信平台向VGOP订阅未读邮件数通知。订阅了后，VGOP将根据一定的策略通知飞信平台最新的未读邮件数量。n FETION-VGOP-03：取消订阅未读邮件数通知接口此接口用于飞信平台向VGOP取消订阅未读邮件数通知。n FETION-VGOP-04：通知未读邮件数接口某用户通过飞信平台向VGOP订阅了未读邮件数后，当有未读邮件有更新时，VGOP通知飞信平台最新的未读邮件数量。n FETION-VGOP-05：绑定查询邮箱别名接口此接口用于飞信平台向VGOP查询手机邮箱别名。n MEM-VGOP-06：更新未读邮件接口此接口用于手机邮箱向VGOP更新未读邮件数。n MEM-VGOP-07：更新手机邮箱别名接口此接口用于手机邮箱向VGOP更新别名。A.2 平台能力提供类接口参考建议本节描述飞信与手机邮箱互通中，手机邮箱业务能力向VGOP平台提供被飞信平台调用的的接口类。该接口类对应VGOP参考点R2.4，各接口必须遵循VGOP能力互通调用接口定义的框架。本节定义的接口中可能包含如下接口：n VGOP-MEM-01：绑定查询手机邮箱别名接口此接口用于飞信平台通过VGOP向手机邮箱查询别名。n VGOP-FETION-02：更新手机邮箱别名接口此接口用于VGOP向飞信平台更新手机邮箱别名。A.2.1 FETION-MEM-R2.4-01：绑定查询手机邮箱别名接口1. 接口含义用户在飞信上进行手机邮箱能力绑定时，先在VGOP上进行互通设置后，然后从飞信平台向手机邮箱平台发起查询邮箱别名的请求。此操作执行时，VGOP需要进行互通鉴权与路由。手机邮箱接收到查询请求后，检查用户是否有别名设置，如果没有，则根据传过来的飞信号参数，默认把别名设置为飞信号，并返回别名。2. 接口消息消息名消息类型消息描述消息方向BindingQueryAliasReqRequest更改别名请求FETION MEMBindingQueryAliasRespResponse更改别名响应MEMFETION3. 接口字段定义：l BindingQueryAliasReq 请求消息字段：字段名类型是否必选描述User_IDuser_id_schema必选用户标识Fetion_IDinteger必须用户飞信号l BindingQueryAliasResp 应答消息字段：字段名类型是否必选描述ResultInteger必选返回值：0成功其他参考5.8返回值定义AliasString必须邮箱别名A.2.2 FETION-MEM-R2.4-02：查询未读邮件数接口1. 接口描述该接口用于飞信平台向手机邮箱平台查询用户的未读邮件数量。此接口支持批量查询，一次请求中查询数量可配置。执行此查询接口时，需要经过VGOP进行互通鉴权与路由。2. 接口消息消息名消息类型消息描述消息方向QueryUnreadMailNumReqRequest用户未读邮件数量查询请求FETIONMEMQueryUnreadMailNumRespResponse用户未读邮件数量查询响应MEMFETION 3. 消息字段定义l QueryUnreadMailNumReq 字段名类型是否必选描述Batch_CountInteger必选查询用户数UserID_listuser_id_list_schema必选待查询的多个用户标识l QueryUnreadMailNumResp字段名类型是否必选描述ResultCodeInteger必须返回值：0成功其他参考5.8返回值定义Batch_CountInteger必选应答中包括的用户数Unread_Mail_Numunread_mail_num_list_schema必选对应每个用户的未读邮件数A.2.3 FETION-MEM-R2.4-03：订阅未读邮件数通知接口1. 接口描述此接口用于飞信客户端需要查询手机邮箱的未读邮件数量，飞信平台先向手机邮箱平台订阅未读邮件数通知。订阅了后，手机邮箱平台将根据一定的策略通知飞信平台最新的未读邮件数量。订阅与通知都需要经过VGOP进行互通鉴权与路由。2. 接口消息消息名消息类型消息描述消息方向SubscribeUnreadMailNumReqRequest订阅未读邮件数通知请求FETIONMEMSubscribeUnreadMailNumRespResponse订阅未读邮件数通知响应MEMFETION 3. 消息字段定义l SubscribeUnreadMailNumReq 字段名类型是否必选描述Auto_Unsubscribe_TimeoutInteger必须订阅的过期时间。以秒为单位的32位无符号整数；需要在订阅过期之前进行续订。续订同样也使用此接口。l SubscribeUnreadMailNumResp字段名类型是否必选描述ResultCodeInteger必须返回值：0成功其他参考5.8返回值定义A.2.4 MEM-FETION-R2.4-04：通知未读邮件数接口1. 接口描述某用户通过飞信平台向手机邮箱平台订阅了未读邮件数通知后，当未读邮件数有更新时，手机邮箱平台通知飞信平台最新的未读邮件数量。此接口执行时需要通过VGOP进行互通鉴权与路由。2. 接口消息消息名消息类型消息描述消息方向NotifyUnreadMailNumReqRequest通知未读邮件数MEMFETIONNotifyUnreadMailNumRespResponse通知未读邮件数响应FETIONMEM 3. 消息字段定义l NotifyUnreadMailNumReq 字段名类型是否必选描述Unread_Email_NumInteger必须未读邮件数量l NotifyUnreadMailNumResp字段名类型是否必选描述ResultCodeInteger必须返回值：0成功其他参考5.8返回值定义A.2.5 FETION-MEM-R2.4-05：取消订阅未读邮件数通知接口1. 接口描述此接口用于飞信平台向手机邮箱平台取消订阅未读邮件数通知。2. 接口消息消息名消息类型消息描述消息方向UnsubscribeUnreadMailNumReqRequest取消订阅未读邮件数通知请求飞信VGOPUnsubscribeUnreadMailNumRespResponse取消订阅未读邮件数通知响应VGOP飞信 3. 消息字段定义l UnsubscribeUnreadMailNumReq 字段名类型是否必选描述（空）l UnsubscribeUnreadMailNumResp字段名类型是否必选描述ResultCodeInteger必须返回值：0成功其他参考5.8返回值定义A.2.6 MEM-FETION-R2.4-06：PUSH别名更新接口1. 接口含义手机邮箱平台向VGOP PUSH别名更新。所有手机邮箱用户别名更新后，都向飞信PUSH更新的别名。2. 接口消息消息名消息类型消息描述消息方向PushAliasUpdateReqRequestPUSH别名更新请求邮箱平台飞信平台PushAliasUpdateRespResponsePUSH别名更新响应飞信平台邮箱平台3. 接口字段定义l PushAliasUpdateReq消息字段描述字段名重要性类型说明Alias必须String更新的别名l PushAliasUpdateResp消息字段描述字段名重要性类型说明ResultCode必须integer返回值：0成功其他参考5.8返回值定义A.3 能力互通访问类接口参考建议本节描述飞信与手机邮箱互通中，飞信与手机邮箱平台直接相互访问的接口类。此类接口主要用户控制流与业务流分离情况下，业务平台之间先通过VGOP进行相对独立的控制，之后进行直接访问。A.3.1 FETION-MEM-R2.5-01：查询未读邮件数接口1. 接口含义此接口用于飞信平台查询用户未读邮件数量。飞信平台通过该接口直接向手机邮箱平台进行查询请求。2. 接口消息消息名消息类型消息描述消息方向QueryUnreadMailNumReqRequest用户未读邮件数查询请求飞信平台邮箱平台QueryUnreadMailNumRespResponse用户未读邮件数查询响应邮箱平台飞信平台3. 接口字段定义l QueryUnreadMailNumReq消息字段描述字段名重要性类型说明User_ID必须user_id_schema用户标识Token必须Stringl QueryUnreadMailNumResp消息字段描述字段名重要性类型说明ResultCode必须integer返回值：0成功其他参考5.8返回值定义Unread_Mail_Num必须integer未读邮件数量A.3.2 FETION-MEM-R2.5-02：订阅未读邮件数通知接口1. 接口描述手机邮箱提供未读邮件数能力。飞信平台可直接向手机邮箱通过此接口订阅未读邮件数更新通知。这样当手机邮箱平台检测到未读邮件数有更新时，可以向飞信平台通知更新的未读邮件数量。2. 接口消息消息名消息类型消息描述消息方向SubscribeUnreadMailNumReqRequest订阅未读邮件数通知请求FETIONMEMSubscribeUnreadMailNumRespResponse订阅未读邮件数通知响应MEMFETION 3. 消息字段定义l SubscribeUnreadMailNumReq 字段名类型是否必选描述Auto_Unsubscribe_TimeoutInteger必须订阅的过期时间。以秒为单位的32位无符号整数；需要在订阅过期之前进行续订。续订也使用这个接口。l SubscribeUnreadMailNumResp字段名类型是否必选描述ResultCodeInteger必须返回值：0成功其他参考5.8返回值定义A.3.3 FETION-MEM-R2.5-03：取消订阅未读邮件数通知接口1. 接口描述此接口用于飞信平台向手机邮箱平台取消订阅未读邮件数通知。2. 接口消息消息名消息类型消息描述消息方向UnsubscribeUnreadMailNumReqRequest取消订阅未读邮件数通知请求FETIONMEMUnsubscribeUnreadMailNumRespResponse取消订阅未读邮件数通知响应MEMFETION 3. 消息字段定义l UnsubscribeUnreadMailNumReq字段名类型是否必选描述（空）l UnsubscribeUnreadMailNumResp字段名类型是否必选描述ResultCodeInteger必须返回值：0成功其他参考5.8返回值定义A.3.4 MEM-FETION-R2.5-04：通知未读邮件数接口1. 接口描述飞信平台向手机邮箱平台订阅了未读邮件数更新通知接口后，当手机邮箱平台检测到某用户的未读邮件数更新时，向飞信平台发起通知。2. 接口消息消息名消息类型消息描述消息方向NotifyUnreadMailNumReqRequest通知未读邮件数MEMFETIONNotifyUnreadMailNumRespResponse通知未读邮件数响应FETIONMEM 3. 消息字段定义n NotifyUnreadMailNumReq 字段名类型是否必选描述Unread_Email_Numinteger必须未读邮件数量n NotifyUnreadMailNumResp字段名类型是否必选描述ResultCodeInteger必须返回值：0成功其他参考5.8返回值定义A.3.5 MEM-FETION-R2.5-05：PUSH别名更新接口1. 接口含义手机邮箱平台向VGOP PUSH别名更新。所有手机邮箱用户别名更新后，都向飞信PUSH更新的别名。2. 接口消息消息名消息类型消息描述消息方向PushAliasUpdateReqRequestPUSH别名更新请求邮箱平台飞信平台PushAliasUpdateRespResponsePUSH别名更新响应飞信平台邮箱平台3. 接口字段定义l PushAliasUpdateReq消息字段描述字段名重要性类型说明Alias必须String更新的别名l PushAliasUpdateResp消息字段描述字段名重要性类型说明ResultCode必须integer返回值：0成功其他参考5.8返回值定义A.3.6 FETION-MEM-R2.5-08：飞信客户端单点登录手机邮箱SSO接口1. 接口含义飞信客户端URL单点登录访问手机邮箱页面2. 接口消息消息名消息类型消息描述消息方向SSOLoginMailReqRequest单点登录手机邮箱URL飞信客户端邮箱平台 SSOLoginMailRespResponse手机邮箱URL访问响应邮箱平台 飞信客户端3. 接口字段定义：SSOLoginMailReq消息字段描述：字段名重要性类型说明Token必须StringSSOLoginMailResp消息字段描述：字段名重要性类型说明ResultCode必须integer返回值：0成功其他参考5.8返回值定义附录B 业务流程参考为读者能够更好的理解本规范定义的VGOP能力互通调用类接口所涉及的流程和数据，本附录以飞信平台和手机邮箱互通场景为例，描述了飞信和手机邮箱之间的互通流程，以及流程中涉及的接口。这些接口在“VGOP能力互通调用接口”章节中和“附录A、飞信和手机邮箱能力互通相关接口参考”中有描述。B.1 用户设置互通流程B.1.1 用户互通设置流程流程概述：用户由飞信平台发起互通设置请求，由VGOP和手机邮箱完成互通设置后，再通过飞信返回给用户互通设置结果。流程说明：1. 用户在飞信上发起飞信与手机邮箱的互通设置请求，并带飞信号作为参数；2. 飞信平台向VGOP转发互通设置请求；3. VGOP进行互通设置鉴权，检查用户是否具有飞信与手机邮箱二个平台的订购关系，以及检查订购关系是否支持此互通设置；4. VGOP生成互通设置；5. VGOP向手机邮箱同步互通设置；6. 手机邮箱保存用户的互通设置信息；7. 手机邮箱返回互通设置同步结果；8. VGOP向飞信平台返回互通设置结果，并同步设置信息；9. 飞信平台向手机邮箱发送绑定查询邮箱别名请求；10. 手机邮箱检查用户是否设置别名，如果有则直接返回别名，否则把传过来的飞信号设置为默认的别名；11. 手机邮箱向飞信平台返回绑定查询别名结果12. 飞信平台保存互通设置信息；13. 飞信平台向用户返回互通设置结果B.1.2 用户取消互通设置流程流程概述：用户由飞信平台发起解除绑定请求，由VGOP和手机邮箱完成不能绑定关系解除后，再通过飞信返回给用户解除绑定结果。流程说明：1. 用户在飞信上发起取消互通设置请求；2. 飞信平台转发取消互通设置请求；3. VGOP执行取消互通设置；4. VGOP同步互通设置信息给手机邮箱；5. 手机邮箱保存新的互通设置信息；6. 手机邮箱返回同步互通设置结果；7. VGOP向飞信平台返回取消互通设置应答结果；8. 飞信平台保存新的互通设置信息；9. 飞信平台返回取消互通设置应答结果给用户；B.2 查询未读邮件数流程B.2.1 方案A：控制流和业务流分离查询方案（推荐方案）流程概述：飞信平台通过VGOP的能力互通鉴权后拿到token，飞信客户端携带token直接向手机邮箱平台查询未读邮件数。遵循VGOP控制流和业务流分离原则。流程说明：A.1. 飞信平台向VGOP发送能力互通鉴权请求A.2. VGOP进行业务互通鉴权，确定飞信平台和手机邮箱之间的互通关系；A.3. VGOP进行用户互通鉴权，确定该用户使用飞信和邮箱互通业务；A.4. VGOP向飞信平台返回应答，携带tokenA.5. 飞信平台向手机邮箱平台发起查询请求，携带token；A.6. 手机邮箱平台根据用户标识和token返回查询应答结果B.2.2 方案B：控制流和业务流不分离查询方案流程概述：飞信平台向手机邮箱平台发起查询未读邮件数请求，执行此动作过程中VGOP进行互通鉴权。流程说明：B.1. 飞信平台向VGOP发送查询邮箱未读邮件数请求；B.2. VGOP进行能力互通鉴权B.3. VGOP完成用户使用互通能力的鉴权B.4. VGOP向手机邮箱平台转发查询未读邮件数请求B.5. 手机邮箱平台向VGOP返回查询未读邮件数应答B.6. VGOP向飞信平台转发查询未读邮件数应答B.3 手机邮箱用户别名更新通知流程B.3.1