VGOP接口规范能力互通接口合v071Word下载.docx
- 文档编号:18196234
- 上传时间:2022-12-14
- 格式:DOCX
- 页数:40
- 大小:264.12KB
VGOP接口规范能力互通接口合v071Word下载.docx
《VGOP接口规范能力互通接口合v071Word下载.docx》由会员分享,可在线阅读,更多相关《VGOP接口规范能力互通接口合v071Word下载.docx(40页珍藏版)》请在冰豆网上搜索。
5.9Schema定义9
6.附录A.飞信和手机邮箱能力互通相关接口参考11
6.1飞信-手机邮箱平台能力调用类接口参考建议11
6.1.1FETION-VGOP-R2.3-01:
飞信平台到VGOP查询未读邮件数接口11
6.1.2FETION-VGOP-R2.3-02:
订阅未读邮件数通知接口12
6.1.3FETION-VGOP-R2.3-03:
取消订阅未读邮件数通知接口13
6.1.4FETION-VGOP-R2.3-04:
通知未读邮件数接口13
6.1.5FETION-VGOP-R2.5-05:
手机邮箱别名更新接口14
6.2飞信-手机邮箱平台能力提供类接口参考建议15
6.2.1MEM-VGOP-R2.4-01:
手机邮箱提供未读邮件数接口15
6.2.2MEM-VGOP-R2.4-02:
手机邮箱别名查询接口15
6.3飞信-手机邮箱能力互通访问类接口参考建议16
6.3.1FETION-MEM-R2.301:
飞信平台到手机邮箱未读邮件数查询接口16
7.附录B.业务流程参考18
7.1用户设置互通流程19
7.1.1用户互通设置流程19
7.1.2用户取消互通设置流程19
7.2查询未读邮件数流程20
7.2.1方案A:
控制流和业务流分离查询方案(推荐方案)20
7.2.2方案B:
控制流和业务流不分离查询方案22
7.2.3方案C:
控制流和业务流分离订阅方案22
7.2.4方案D:
控制流和业务流不分离订阅方案23
7.3手机邮箱用户别名更新通知流程24
7.3.1方案A:
控制流和业务流分离别名更新通知(推荐方案)24
7.3.2方案B:
控制流和业务流不分离方案25
7.4SSO登录流程26
7.4.1飞信SSO登录手机邮箱流程26
1.适用范围
本规范规定了中国移动数据增值业务运营平台与各个业务网关以及应用平台之间的接口,以保证系统的互连互通及业务的实现。
本规范主要适用于中国移动数据增值业务运营平台,提供平台和业务平台、业务网关之间的连接的规范和技术实现规范。
本规范描述的是数据业务在运营过程中涉及到的业务接口,有关网管、系统管理的接口不在本规范的描述范围之内,具体请参见设备规范。
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中的表现形式如下:
<
?
xmlversion=”1.0”encoding=”UTF-8”?
>
header>
Element1>
消息头元素一<
/Element1>
Element2>
消息头元素二<
/Element2>
Element3>
消息头元素三<
/Element3>
/header>
body>
消息体元素一<
消息体元素二<
消息体元素三<
/body>
5.1.4通用消息头
本小节定义本章节中所有接口消息所需遵循的通用消息头(header)。
除非特殊说明,否则在本章节各接口均适用本小节定义的通用消息头。
在本章节定义的接口中,各接口请求消息的消息头中包含的字段定义如下:
字段名称
字段类型
是否必选
字段描述
version
integer
M
版本号,长度4字节
transactionID
string
操作交易序列号,长度16字节
callerServiceID
能力调用者业务平台标识
providerServiceID
能力提供者业务平台标识
providerEnablerName
能力提供者业务能力名称
providerInterfaceName
能力提供者业务接口名称
operation
操作消息名定义,具体参见接口定义
userID
user_id_schema
调用用户标识
timestamp
时间戳
响应通用消息头定义:
5.2接口列表
接口类
接口名称
接口描述
接口协议
发起方/提供方
落地方
用户互通设置类
VGOP-R2.1-01:
用户互通设置接口
业务平台向VGOP发起用户互通设置
HTTP+XML
业务平台VGOP
VGOP-R2.1-02:
取消用户互通设置接口
业务平台向VGOP取消用户互通设置
VGOP-R2.1-03:
互通设置信息同步接口
VGOP向业务平台同步用户互通设置信息
VGOP业务平台
能力互通控制类
VGOP-R2.2-01:
互通调用鉴权接口
业务平台向VGOP发起互通调用鉴权
能力调用接口类
对应VGOP参考点R2.3
业务平台通过VGOP发起能力互通调用的接口
能力提供接口类
对应VGOP参考点R2.4
业务平台向VGOP进行能力提供的接口类
能力互通访问接口
业务平台间相互调用的接口类
业务平台业务平台
5.3用户互通设置类接口定义
1.功能描述
此接口用于用户在业务平台上向VGOP发起能力互通设置。
2.接口消息
消息名
消息类型
消息描述
消息方向
ServiceIOPActivateReq
Request
互通设置请求接口消息
业务平台VGOP
ServiceIOPActivateResp
Response
互通设置应答接口消息
VGOP业务平台
3.消息体定义
●ServiceIOPActivateReq
字段名
类型
描述
expireTime
String
O
过期时间
expireAction
过期后行为
Cancel到过期时间,取消互通设置
Alert提醒。
提醒后到期还是取消
expireAlertDays
到了过期时间前提醒的天数
timeAction
time_action_list_schema
每天某个时间段进行某动作
●ServiceIOPActivateResp
Result
Integer
返回值:
0成功
111用户订购的资费不够支持此能力互通
其他参考5.8返回值定义
用户互通设置取消接口
此接口用于用户通过业务平台向VGOP发起取消业务互通设置的请求。
ServiceIOPDeactivateReq
取消互通设置请求接口消息
ServiceIOPDeactivateResp
●ServiceIOPDeactivateReq
●ServiceIOPDeactivateResp
必选
功能设置结果:
0:
互通取消成功
1:
用户未定购对端业务平台提供的业务
2:
未设置互通
VGOP向业务平台发起的用户互通设置同步。
IOPConfSyncReq
VGOP业务平台
IOPConfSyncResp
业务平台VGOP
●IOPConfSyncReq
sync_Type
同步操作类型:
Add:
设置
Remove:
取消设置
可选
失效时间,从1970年1月1日0时开始的毫秒数
过期后行为:
●IOPConfSyncResp
功能设置结果,
同步成功
5.4能力互通控制类接口定义
平台互通时,向VGOP发送互通调用鉴权请求,并获得互通调用令牌(token)的接口。
ServiceIOPAuthReq
业务调用方向VGOP发起互通调用鉴权请求
飞信平台VGOP
ServiceIOPAuthResp
业务调用方向VGOP发起互通调用鉴权应答
VGOP飞信平台
●ServiceIOPAuthReq
(空)
●ServiceIOPAuthResp
鉴权通过
其他值:
鉴权未通过,错误代码
IFURL
调用的接口URL
Token
token_schema
返回调用token,具体内容待定义
5.5平台能力调用类接口描述
能力平台调用类接口为能力调用者平台向VGOP发送能力调用请求并获得能力调用结果的接口,对应VGOP的R2.3参考点。
当需要进行能力互通调用时,能力调用者业务平台将通过本类接口向VGOP发起互通调用请求。
VGOP接口规范对本类接口的框架,包括接口形式、协议、命名规则、通用消息头等进行规范。
本类接口应遵循本章节所定义接口框架,消息体内具体字段定义由能力调用者业务平台的接口规范定义。
附录B中以飞信调用手机邮箱为例,给出该类接口具体形式的参考建议。
5.6平台能力提供类接口描述
平台能力提供类接口为能力提供者平台向VGOP开放能力使用的接口,对应VGOP的R2.4参考点。
在有能力互通调用请求的情况下,VGOP向能力提供者平台发起能力调用请求的接口。
也可以是能力提供者平台主动向VGOP发起能力提供的消息(数据通知类)。
5.7能力互通访问类接口描述
能力互通访问接口为能力调用者业务平台直接调用能力提供者业务平台业的接口。
当能力调用者平台需要调用其他业务平台的业务能力(互通访问)时,将通过VGOP互通调用鉴权接口向VGOP进行鉴权请求,获得调用令牌后,直接通过本类接口访问能力提供者业务平台。
本类接口为业务平台间调用接口,VGOP不对该接口的框架或具体内容进行规范。
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.9Schema定义
●user_id_schema(用户标识)
UserIDType
用户标识类型
用手机号标识
用伪码标识
3:
两者同时标识
MSISDN
用户手机号
PseudoCode
binary
用户伪码
●token_schema:
令牌结构
名称
数据类型
providerEnablerID
被调用的能力编码
timeStamp
时间戳,从1970年1月1日0时开始的毫秒数,时区为东八区
用户的唯一标识
userProfile
用户在该能力的授权信息?
?
Int
认证结果。
几个主要的相关取值列举如下:
用户认证通过
-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颁发给该业务平台的密钥。
●address_info_schema
●user_id_list_schema
user_id_schema[]
多个UserID
●unread_mail_num_list_schema
userIDList
user_id_list_schema
mailNumList
Integer[]
多个未读邮件数
●time_action_list_schema(时段动作)
time_action_schema[]
●time_action_schema(时段动作)
startTime
endTime
action
时间段动作
附录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向飞信平台更新手机邮箱别名。
A.2.1F
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- VGOP 接口 规范 能力 互通 v071