OPPO开放平台OPPO消息推送标签管理

OPPO开放平台OPPO消息推送标签管理

OPPO开放平台OPPO消息推送标签管理

标签管理

添加标签

接口

环境HTTPS请求地址备注
生产环境https://api-device.push.heytapmobi.com/设备API
沙箱环境暂无
描述内容
接口功能新增标签
请求方法POST
Content-Typeapplication/json
请求编码UTF-8
请求路径/server/v1/device/add_tags

请求参数

名称类型必须默认描述
nameString标签名称,字符长度50字符
descString标签描述,字符长度200字符

响应参数(JSON)

名称类型必须描述
codeInt返回码,请参考公共返回码与接口返回码
messageString错误详细信息,不存在则不填
dataString返回值,JSON类型,包含响应结构体

响应示例

{
    "code": 0,
    "message": "success"
}

添加标签组

接口

描述内容
接口功能新增标签,app全局最多可新增1000个标签组
请求方法POST
Content-Typeapplication/json
请求编码UTF-8
请求路径/server/v1/device/add_tag_group

请求参数

名称类型必须默认描述
groupString标签组名称
tagsString标签列表,单个标签组最多可设置50个标签;多个标签之间使用英文分号分隔
descString标签描述

响应参数(JSON)

名称类型必须描述
codeInt返回码,请参考公共返回码与接口返回码
messageString错误详细信息,不存在则不填
dataString返回值,JSON类型,包含响应结构体

响应示例

{
    "code": 0,
    "message": "success"
}

标签订阅接口

接口

描述内容
接口功能为指定设备绑定标签
请求方法POST
Content-Typeapplication/json
请求编码UTF-8
请求路径/server/v1/device/subscribe_tags

请求参数

名称类型必须默认描述
registration_idStringNull注册ID
tagsStringNull标签内容,多个标签之间使用英文分号分隔,单个标签字节长度50字符; 限制:单次调用接口可设置50个标签;单个用户总量上限也是50个标签 这个接口可重复调用,多次调用不会清理原来设置的标签

响应参数(JSON)

名称类型必须描述
codeInt 是返回码,请参考公共返回码与接口返回码
messageString错误详细信息,不存在则不填
dataString返回值,JSON类型,包含响应结构体

响应示例

{
    "code": 0,
    "message": "success",
}

取消标签订阅接口

接口

描述内容
接口功能取消订阅标签
请求方法POST
Content-Typeapplication/json
请求编码UTF-8
请求路径/server/v1/device/unsubscribe_tags

请求参数

名称类型必须默认描述
registration_idStringNull注册ID
tagsStringNull标签内容,多个标签之间使用分号分隔 限制:单次调用接口可删除50个标签

响应参数(JSON)

名称类型必须描述
codeInt返回码,请参考公共返回码与接口返回码
messageString 否错误详细信息,不存在则不填
dataString返回值,JSON类型,包含响应结构体

响应示例

{
    "code": 0,
    "message": "success"
}

查询所有标签

接口

描述内容
接口功能查询该设备所有标签
请求方法POST
Content-Typeapplication/json
请求编码UTF-8
请求路径/server/v1/device/get_all_tags

请求参数

名称类型必须默认描述
registration_idStringNull注册ID

响应参数(JSON)

名称类型必须描述
codeInt返回码,请参考公共返回码与接口返回码
messageString错误详细信息,不存在则不填
dataString返回值,JSON类型,包含响应结构体

响应示例

{
    "code": 0,
    "message": "success",
    "data": {
        "registrationId": "58ad47319e8d725350a5afd5",
        "tags": [
            {
                "tag": "深圳"
            },
            {
                "tag": "广州"
            }
        ]
    }
}

编辑:yimen,如若转载,请注明出处:https://www.yimenapp.com/kb-yimen/11089/

部分内容来自网络投稿,如有侵权联系立删

(0)
上一篇 2022年11月18日 下午2:54
下一篇 2022年11月18日 下午2:57

相关推荐