回复
MobPush 标签别名 API
MobService
发布于 2024-7-23 11:54
浏览
0收藏
调用验证
详情参见 REST API 概述的 鉴权方式 说明。
频率控制
详情参见推送限制策略的 接口限制 说明。
查询设备信息
根据RegistrationId
调用地址
推送对象
参数 | 类型 | 必须 | 说明 |
registrationId | string | 是 | 设备的registrationId |
请求示例
curl --location --request GET 'http://api.push.mob.com/device-v3/getById/65l0soev0d0b4lc' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'key: 2e08782eb311b' \
--header 'sign: 9f1bb16df0167c733eb83875dfe445db'响应示例
- 请求成功
{
"status": 200,
"res": {
"registrationId": "65l0soev0d0b4lc",
"tags": [
"TestTag2",
"TestTag1"
],
"alias": "TestAlias",
"mobile": null,
"openPush": 1,
"status": 1,
"customParam": {
"person": "ax"
}
},
"error": null
}- 请求失败
{
"status": 5801,
"res": null,
"error": "数据校验失败"
}- 响应参数
参数
类型
说明
status
number
返回码
res
object
消息体
res.registrationId
string
客户端获取的registrationId
res.tags
string []
设备标签数组
res.alias
string
设备别名
res.mobile
string
手机号码（ 用于短信补量等功能）
res.openPush
number
是否开启推送
1：开启
0：关闭
res.status
number
设备状态
1：正常
3：卸载
0：删除（卸载统计未开通）
error
string
返回码描述
根据别名
调用地址
推送对象
参数 | 类型 | 必须 | 说明 |
alias | string | 是 | 设备设置的别名 |
请求示例
curl --location --request GET 'http://api.push.mob.com/device-v3/getByAlias/TestAlias' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'key: 2e08782eb311b' \
--header 'sign: 9f1bb16df0167c733eb83875dfe445db'响应示例
- 请求成功
{
"status": 200,
"res": {
"registrationId": "65l0soev0d0b4lc",
"tags": [
"TestTag2",
"TestTag1"
],
"alias": "TestAlias",
"mobile": null,
"openPush": 1,
"status": 1
},
"error": null
}- 请求失败
{
"status": 5801,
"res": null,
"error": "数据校验失败"
}- 响应参数
参数 | 类型 | 说明 |
status | number | 返回码 |
res | object | 消息体 |
res.registrationId | string | 客户端获取的registrationId |
res.tags | string [] | 设备标签数组 |
res.alias | string | 设备别名 |
res.mobile | string | 手机号码（ 用于短信补量等功能） |
res.openPush | number | 是否开启推送 1：开启 0：关闭 |
res.status | number | 设备状态 1：正常 3：卸载 0：删除（卸载统计未开通） |
error | string | 返回码描述 |
根据标签
目前该接口只返回1000条设备相关信息
调用地址
推送对象
- 以 JSON 格式表达，表示一条推送相关的所有信息
参数 | 类型 | 必须 | 说明 |
appkey | string | 是 | Mob后台的MobAppKey |
tags | string [] | 是 | 标签数组，交集查询，需要与rid下的tags全部匹配 |
请求示例
curl --location --request POST 'http://api.push.mob.com/device-v3/queryByTags' \
--header 'key: 2e08782eb311b' \
--header 'sign: adf46949ac9ba0732e966d2fb43eebf3' \
--header 'Content-Type: application/json' \
--data-raw '{"appkey":"2e08782eb311b","tags":["TestTag2"]}'返回示例
- 请求成功
{
"status": 200,
"res": [
{
"registrationId": "65l0soev0d0b4lc",
"tags": [
"TestTag2",
"TestTag1"
],
"alias": "TestAlias",
"mobile": null,
"openPush": 1,
"status": 1
}
],
"error": null
}- 请求失败
{
"status": 5801,
"res": null,
"error": "数据校验失败"
}- 响应参数
参数 | 类型 | 说明 |
status | number | 返回码 |
res | object | 消息体 |
res.registrationId | string | 客户端获取的registrationId |
res.tags | string [] | 设备标签数组 |
res.alias | string | 设备别名 |
res.mobile | string | 手机号码（ 用于短信补量等功能） |
res.openPush | number | 是否开启推送 1：开启 0：关闭 |
res.status | number | 设备状态 1：正常 3：卸载 0：删除（卸载统计未开通） |
error | string | 返回码描述 |
更新标签
调用地址
推送对象
- 以 JSON 格式表达，表示一条推送相关的所有信息
参数 | 类型 | 必须 | 说明 |
appkey | string | 是 | Mob后台的MobAppKey |
registrationId | string | 是 | 用户客户端口获取的registrationId |
opType | number | 否 | 操作类型 1：新增标签 2：删除标签 3：清空标签 |
tags | string [] | 否 | 标签数组（opType类型为3时候不用传入） |
请求示例
curl --location --request POST 'http://api.push.mob.com/device-v3/updateTags' \
--header 'key: 2e08782eb311b' \
--header 'sign: 5abb496fcc0da0de1df3c377791fb1f1' \
--header 'Content-Type: application/json' \
--data-raw '{
"appkey":"2e08782eb311b",
"registrationId":"65l0soev0d0b4lc",
"opType":"1",
"tags":["TestTag3","TestTag4"]
}'返回示例
- 请求成功
{
"status": 200,
"res": null,
"error": null
}- 请求失败
{
"status": 5801,
"res": null,
"error": "数据校验失败"
}- 响应参数
参数 | 类型 | 说明 |
status | number | 返回码 |
res | object | 暂时返回为null |
error | string | 返回码描述 |
更新别名
调用地址
推送对象
- 以 JSON 格式表达，表示一条推送相关的所有信息
参数 | 类型 | 必须 | 说明 |
appkey | string | 否 | Mob后台的MobAppKey |
registrationId | string | 是 | 用户客户端口获取的registrationId |
alias | string | 否 | 需要设置的别名 |
请求示例
curl --location --request POST 'http://api.push.mob.com/device-v3/updateAlias' \
--header 'key: 2e08782eb311b' \
--header 'sign: 5' \
--header 'Content-Type: application/json' \
--data-raw '{
"appkey":"2e08782eb311b",
"registrationId":"65l0soev0d0b4lc",
"alias":"gxdaoxinsj"
}'返回示例
- 请求成功
{
"status": 200,
"res": null,
"error": null
}- 请求失败
{
"status": 5801,
"res": null,
"error": "数据校验失败"
}- 响应参数
参数 | 类型 | 说明 |
status | number | 返回码 |
res | object | 暂时返回null |
error | string | 返回码描述 |
赞
收藏
回复
相关推荐
