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