3.广播
3.1保存群推消息公共体接口
接口说明
同一条信息覆盖多个用户。此接口需与批量推送用户接口3.2配套使用,批量推送接口用此接口生成taskId批量发送用户。
使用场景:活动、系统升级提醒等。
限制:默认根据客户端SDK订阅数自动配置。
访问方式
URL | 编码方式 | 协议 | method | Content-Type |
/message/saveListPayload | 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/saveListPayload Request body e.g.: { "title":"标题1", "content":"内容1", "notifyType":1, "timeToLive":86400, "skipType":2, "skipContent":"http://www.vivo.com", "networkType":"1", "clientCustomMap":{ "key1":"vlaue1", "key2":"vlaue2" }, "requestId":"25509283-3767-4b9e-83fe-b6e55ac6b123" } Response body e.g.: http status 200: 业务成功: { "result": 0, "desc": "请求成功", "taskId": "342982232646905856" } 业务异常: { "result": xxx, "desc": "xxx不合法" } http status 500: Internet server error! |
接口定义
输入参数:
属性名字 | 类型 | 是否必填Y/N | 描述 |
notifyType | int | Y | 通知类型 1:无,2:响铃,3:振动,4:响铃和振动 |
title | string | Y | 通知标题(用于通知栏消息) 最大20个汉字(一个汉字等于两个英文字符,一个表情占一个字符,即最大不超过40个英文字符) |
content | string | Y | 通知内容(用于通知栏消息) 最大50个汉字(一个汉字等于两个英文字符,一个表情占一个字符,即最大不超过100个英文字符) |
timeToLive | int | N | 消息保留时长 单位:秒,取值至少900秒,最长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接入文档获取该键值对。 |
requestId | string | Y | 用户请求唯一标识 最大64字符 |
输出参数:
属性名字 | 类型 | 描述 |
result | int | 接口调用是否成功的状态码 0成功,非0失败 |
desc | string | 文字描述接口调用情况 |
taskId | string | 任务编号 |
业务异常码详解:
result | desc |
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个字符 |
10101 | 消息内容审核不通过 |
10252 | 批量发送消息体超出限制 |
10352 | requestId 不能为空 |
10353 | requestId 长度不能超过64个字符 |
10303 | requestId 已存在 |
10071 | 超出发送时间允许范围 |
10103 | 推送内容含敏感信息 |
10104 | 请发送正式信息,请检查title、content,不要发送测试内容,正式应用发送的title、content里面不能是纯数字,纯英文,纯符号,符号加数字,包含“测试”字样、大括号、中括号 |
10253 | 批量发送regId或alais超过总量限制 |
10070 | 发送量总量超出限制 |
10040 | 资源已达上限,稍后重试 |
10085 | title 或 content 不能为纯表情 |
3.2、批量推送用户接口
接口说明
批量发送用户。此接口与群推消息接口3.1配套使用,首先通过群推消息接口3.1返回taskId,然后此接口带上taskId批量发送用户,可以根据regIds或者aliases分批调用。每次调用时,regIds或者aliases的个数必须大于等于2,小于等于1000。
限制:根据客户端SDK订阅数自动配置,可发送的用户总量可以在开发者后台查看。
访问方式
URL | 编码方式 | 协议 | method | Content-Type |
/message/pushToList | 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/pushToList Request body e.g.: { "regIds":[ "12345678901234567890121", "12345678901234567890122" ], "taskId":"342982232646905856", "requestId":"25509283-3767-4b9e-83fe-b6e55ac6b123" } Response body e.g.: http status 200: 业务成功: { "requestId": "25509283-3767-4b9e-83fe-b6e55ac6b123", "result": 0, "desc": "请求成功", "invalidUsers": [ { "status": 1, "userid": "12345678901234567890122" }, { "status": 1, "userid": "15554239157791000000009" } ] } 请求成功,但是请求中的部分userid不合法无法送达 { "requestId": "25509283-3767-4b9e-83fe-b6e55ac6b123", "result": 0, "desc": "请求成功", "invalidUsers": [ { "status": 1, "userid": "15579140943441000000113" }, { "status": 1, "userid": "15613679456951000000074" } ] }
业务异常: { "result": xxx, "desc": "xxx不合法" } http status 500: Internet server error! |
接口定义
输入参数:
属性名字 | 类型 | 是否必填Y/N | 描述 |
regIds | string[] | N | regId列表 个数大于等于2,小于等于1000,regId长度23个字符(regIds,aliases 两者需一个不为空,两个不为空,取regIds) |
aliases | string[] | N | 别名列表个数大于等于2,小于等于1000,长度不超过40字符(regIds,aliases 两者需一个不为空,两个不为空,取regIds) |
taskId | string | Y | 公共消息任务号,取saveListPayload返回的taskId |
requestId | string | Y | 请求唯一标识,最大64字符 |
pushMode | int | N | 推送模式 0:正式推送;1:测试推送,不填默认为0(测试推送,只能给web界面录入的测试用户推送;审核中应用,只能用测试推送) |
输出参数:
属性名字 | 类型 | 描述 |
result | int | 接口调用是否成功的状态码 0成功,非0失败 |
desc | string | 文字描述接口调用情况 |
invalidUser | JSON Object | 非法用户信息,包括status和userid,userid为接入方传的regid或者alias,status有三种情况:1.userId不存在;2.卸载或者关闭了通知;3.七天不在线;4.非测试用户 |
业务异常码详解:
result | desc |
10150 | aliases 和 regIds 不能都为空 |
10154 | aliases 个数不在指定范围[2-1000] |
10301 | alias 长度不能超过40个字符 |
10153 | regIds 个数不在指定范围[2-1000] |
10302 | regId 不合法 |
10151 | taskId 不能为空 |
10152 | taskId 不合法 |
10253 | 批量发送regId或alais超过总量限制 |
10155 | 消息不存在或已过期 |
10352 | requestId 不能为空 |
10353 | requestId 长度不能超过64个字符 |
10303 | requestId 已存在 |
10070 | 发送量总量超出限制 |
10040 | 资源已达上限,稍后重试 |
广州的客户想要在vivo投放广告应该联系哪家代理商?目前在vivo推广开户的优势有哪些?如何使得广告展现在目标用户面前,您可以咨询巨宣网络,主要帮助广告主实现在产品的广告推广营销,广告变现,帮助广告主实现品效双赢!
- 2024-10-18
双11期间vivo广告大促攻略增长秘籍,请查收… - 2024-10-18
生态汇聚,融界启航—vivo广告营销打造终端… - 2024-09-25
新功能!vivo广告快生态神器—ROI出价强势… - 2024-09-21
vivo广告2024年8月25日-9月8日行业数据报告… - 2024-09-11
vivo广告2024年8月11日-8月25日行业数据报… - 2024-08-30
vivo广告2024年3月25日-4月7日行业数据报告… - 2024-08-24
vivo广告2024年7月28日-8月11日行业数据报… - 2024-08-22
下载CTR飙升近50%!vivo广告这个新功能转化… - 2024-08-17
vivo广告营销社交办公行业沙龙,纳西寻春,… - 2024-08-14
还在为无效线索头疼?这个新功能轻松拯救!…
管理员
该内容暂无评论