《飞书必达统一消息推送平台对外接口规范.docx》由会员分享,可在线阅读,更多相关《飞书必达统一消息推送平台对外接口规范.docx(9页珍藏版)》请在课桌文档上搜索。
1、飞书必达统一消息推送平台对外接口规范文档版本号:V1.2.9文档编号:1产品名:飞书必达统一消息推送平台最后修订日期:2020-09-17变更记录日期版本变更说明介与者2020-11-04VLO1总体说明1.1 统一推送平台接口规范说明1.1.1 介绍本接口为第三方系统,调用统一推送服务,完成信息推送。1.1.2 通信承载协议协议采用HnP协议+JSON格式,本文档中的接口均采用POST方式。1.1.3 编码要求接口通讯编码均要求统一使用UTF-8进行编码。1.1.4 接口加密说明除appkey外,所有body参数需转化为Json字符串,再由AES方式加密后传输。密钥通过线下交换与app_id
2、绑定,加密算法请参照如下文件。口AESjavaLL5接口调用限制说明1、调用消息发送接口,发送频率:每分钟发送次数,对于单播(仅对一个用户发生消息)目前没有限制。对于任务(非单播),每分钟不能超过5次。2、如调用接口超时没有返回正确的结果报文,由调用方重新调用接口进行重发。1.1.6接口调用地址灰度地址飞书必达运营人员提供地址生产地址飞书必达运营人员提供地址测试地址飞书必达运营人员提供地址2APP消息推送接口2.1 APP单发接口产品对外接口使用HTTP协议,产品外系统作为发起方使用HTTP发送请求报文。报文使用JSON格式,UTF-8编码。初期最大并发量不超过500/so2.1.1 APP消
3、息单发接口接口说明第三方平台将推送的任务发送到消息推送平台,消息推送平台返回此批次的推送任务id后,消息推送平台根据制定的发送时间,将消息发送给用户。请求地址飞书必达运营人员提供地址请求方式post请求参数:参数类型必填描述CncryptDataString是body参数详解转化为Json字符串,再用AES加密后的字符串body参数详解:参数类型长度是否必填默认值描述app_idstring5是无由飞书必达平台颁发的app_idmsg_locationstring3是无消息展示位置,见附录1:字典定义-消息展示位置msg_typestring50是无消息类型,见附录1:字典定义消息类型(子类型
4、使用T分割)send_typeint1是0发送类型,默认是立即发送,见附录1:字典定义-发送类型(单推不支持定时发送)endpoint_idString1是下行appidpush_arrangeSiring1否推送安排:1单推、2融合、3分级,默认为1Push_momsg参数详解参数父节点长度类型是否必填默认值描述titlemsg50string是无设置在通知栏展示的通知的标题,不允许全是空白字符,长度小于50,一个中英文字符均计算为1(通知栏消息必填)describemsg128string是无设置在通知栏展示的通知描述,不允许全是空白字符,长度小于128,一个中英文字符均计算为1(通知栏消
5、息必填)typemsg1int是无目标地址,取值为1(代表html5)或者2(代表native)targetmsg500string是无如果为type为htm15则为短地址,type为native在为functionidloginmsg1int是无是否强制登录,取值为1(代表是)或者2(代表否)imamsg150string否无图片地址,图片是在通知栏展示的消息体中的图片,如果没有则不展示。图片地址必须是能够外网访问地址,如:图片要求为24*24dp的图标,或24*24px放在注意四周各留1个dp的空白像素extmsg2800jsonobjeCt否无预留字段,可填写自定义消息字段。返回参数参数
6、类型描述codeint平台收到消息是否成功的标识,OoOoO成功,失败返回具体失败码,J为未知原因。msgString平台收到消息失败的原因dataSting平台收到消息成功后会返回32位taskJd,用于取消消息推送任务请求参数实例endpoint_idn:cmcclzpush_typen:Onx,msg-location,:,1rmsg-type302,expire-time,00,device_tokensM:,msg,:(ima:,r,title*:充值到账通知”,“describe:您好,您已成功进行话费充值,183*3145手机号交费IOo.00元”,target:*BF01401
7、M,login,!2,type:2),send-type,t,Ozuser_account:用户手机号码”,description:充值成功”,start_time:,app-id,jjk551,push_level:l,filter:M2.2 附录1:字典定义字典类型字典值字典描述消息展示位置(msg_location)0其他1通知2跑马灯3消息中心消息类型(msgype)0其他1营销类2移动公告3提醒类3|01流量提醒类301()l流量剩余提醒类3O1O2流量用完提醒类3O1O3日流量使用超IG提醒(H租卡)3|02充值提醒类3|03卡券到账提醒类3|04卡券使用提醒类3|05卡券到期提醒
8、类3|06卡券开抢提醒类3|07卡券转赠提醒类3|08话费提醒类30801话费余额不足提醒30802欠费提醒类30803停机提醒类30804充值话费到账提醒类309语音提醒类30901月通话分钟数提醒-套内语音30902月通话分钟数提醒-套内无语音310订购套餐类31001更换套餐提醒311订购业务类3ll0l已开通业务提醒(数据业务)3ll02新办通用流量到账3ll03新办定向流量到账3ll04关/开数据业务提醒3ll05退订业务提醒312账单提醒类31201每月账单提醒313订单提醒类314积分提醒类发送类型(send_type)0立即发送I定时发送发送优先级(PUShevel)1高级2中
9、级3低级消息推送类型(PUSh_type)0单播(仅对一个用户发生消息)1列播(批量发送,要求不超过IOOO个,USeJaCCOUIn或deviceOken)消息推送模式(push_model)0单通道推送1多通道同时推送2多通道协同分级推送推送通道(push_channel)appAPP推送WX微信公众号推送sms短信推送2.3 附录2:错误信息代码类型代码错误信息业务代码40001参数不合法,必填字段为空等业务代码40002非法请求,如Sign校验失败业务代码50001服务器端异常业务代码40033不合法的请求字符,不能包含uxxxx格式的字符HTTP状态码400接口请求方式错误,应检查接口地址及请求方式HTTP状态码4()4接口地址不存在,应检查接口地址及请求方式HTTP状态504接口后台服务超时