vivo广告推广平台：服务端API接口文档《NO.3》

当前位置：首页 > 疑难解答

疑难解答

vivo广告推广平台：服务端API接口文档《NO.3》

发布时间：2021-09-15浏览次数：272

2、单播

2、1单推接口

接口说明

接入方携带消息内容以及用户regId（或alias）进行通知消息推送。针对每个用户发送不同的通知。

使用场景：如物流、订单状态、游戏预约状态、行程状态、聊天（如微信、评论）等。

限制：根据客户端SDK订阅数自动配置，可发送的用户总量可以在开发者后台查看。

访问方式

URL

编码方式

协议

method

Content-Type

/message/send

Utf-8

https

POST

application/json

Curl e.g.：

curl -X POST -H 'authToken:${your_auth_token}' -H 'Content-Type:application/json' -d '${your_request_body}' https://api-push.vivo.com.cn/message/send

Request body e.g.:

{

"regId":"12345678901234567890123",

"notifyType":1,

"title":"标题1",

"content":"内容1",

"timeToLive":86400,

"skipType":2,

"skipContent":"http://www.vivo.com",

"networkType":"1",

"clientCustomMap":{

"key1":"vlaue1",

"key2":"vlaue2"

"extra":{

"callback":"http://www.vivo.com",

"callback.param":"vivo"

"requestId":"25509283-3767-4b9e-83fe-b6e55ac6b123"

}

Response body e.g.:

http status 200:

业务成功：

{

"result": 0,

"desc": "请求成功",

"taskId": "121397329"

}

推送使用的regid或alias不合法，无法送达：

{

"result": 10302,

"desc": "regId 不合法",

"invalidUser": {

"status": 1,

"userid": "15638535410301000000001"

}

业务异常：

{

"result": xxx,

"desc": "xxx不合法"

}

http status 500：

Internet server error!

接口定义

输入参数：

intent uri

属性名字	类型	是否必填Y/N	描述
regId	string	N	应用订阅PUSH服务器得到的id 长度23个字符（regId，alias 两者需一个不为空，当两个不为空时，取regId）
alias	string	N	别名长度不超过40字符（regId，alias两者需一个不为空，当两个不为空时，取regId）
notifyType	int	Y	通知类型 1:无，2:响铃，3:振动，4:响铃和振动注意：只对Android 8.0及以下系统有效
title	string	Y	通知标题（用于通知栏消息）最大20个汉字（一个汉字等于两个英文字符，一个表情占一个字符，即最大不超过40个英文字符）
content	string	Y	通知内容（用于通知栏消息）最大50个汉字（一个汉字等于两个英文字符，一个表情占一个字符，即最大不超过100个英文字符）
timeToLive	int	N	消息保留时长单位：秒，取值至少60秒，最长7天。当值为空时，默认一天
skipType	int	Y	点击跳转类型 1：打开APP首页 2：打开链接 3：自定义 4:打开app内指定页面
skipContent	string	N	跳转内容跳转类型为2时，跳转内容最大1000个字符，跳转类型为3或4时，跳转内容最大1024个字符，skipType传3需要在onNotificationMessageClicked回调函数中自己写处理逻辑。关于skipContent的内容可以参考【vivo推送常见问题汇总】 pushSDK版本号：480以上，不在支持skipType=3，自定义跳转统一使用skipType=4，详见【vivo推送常见问题汇总】中API接入问题的Q11中的intent uri示例。
networkType	int	N	网络方式 -1：不限，1：wifi下发送，不填默认为-1
classification	int	N	消息类型 0：运营类消息，1：系统类消息。不填默认为0
clientCustomMap	JSON Object	N	客户端自定义键值对自定义key和Value键值对个数不能超过10个，且长度不能超过1024字符, key和Value键值对总长度不能超过1024字符。app可以按照客户端SDK接入文档获取该键值对
extra	JSON Object	N	高级特性（详见目录：一.公共——5.高级特性 extra）
requestId	string	Y	用户请求唯一标识最大64字符
pushMode	int	N	推送模式 0：正式推送；1：测试推送，不填默认为0 备注： 1.测试推送，只能给web界面录入的测试用户推送；审核中应用，只能用测试推送 2.若未设置pushMode=1进行测试，文案相同时，将被当做重复推送的运营消息被去重

输出参数：

属性名字	类型	描述
result	int	接口调用是否成功的状态码 0成功，非0失败
desc	string	文字描述接口调用情况
taskId	string	任务编号
invalidUser	JSON Object	非法用户信息，包括status和userid，userid为接入方传的regid或者alias，status有三种情况：1.userId不存在；2.卸载或者关闭了通知；3.七天不在线；4.非测试用户

业务异常码详解：

result	desc
10050	alias和regId 不能都为空
10051	暂不支持该消息类型
10054	notifyType 不合法
10055	title 不能为空
10056	title 长度不能超过40个字符
10057	content 不能为空
10058	content 长度不能超过100个字符
10059	timeToLive 不合法
10060	skipType 不合法
10061	skipType = 2, skipContent 不能为空
10062	skipType = 2, skipContent 不能超过1000个字符
10063	skipType = 3, skipContent 不能为空
10064	skipType = 3, skipContent 不能超过1024个字符
10065	networkType 不合法
10066	自定义key和Value键值对个数不能超过10个
10067	自定义key和value键值对不合法
10068	skipType = 4, skipContent 不能为空
10069	skipType = 4, skipContent 不能超过1024个字符
10070	发送量总量超出限制
10072	推送速度过快，请稍后再试
10301	alias 长度不能超过40个字符
10302	regId 不合法, regId为无效的regId, regId可能已经失效
10352	requestId 不能为空
10353	requestId 长度不能超过64个字符
10303	requestId 已存在
10304	extra 包含不支持的key
10305	extra callback长度不能超过128个字符
10306	extra callback.param长度不能超过64个字符
10307	alias不合法，alias为无效的alias, alias可能已经失效
10103	推送内容含敏感信息（目前单推没有同步返回审计信息）
10104	请发送正式信息，请检查title、content，不要发送测试内容，正式应用发送的title、content里面不能是纯数字，纯英文，纯符号，符号加数字，包含“测试”字样、大括号、中括号
10040	资源已达上限，稍后重试
10085	title 或 content 不能为纯表情
10073	系统消息发送量总量超出限制
10082	系统消息开关未打开