首页 > 帮助文档首页 > 云服务 > 云推送 > API列表 >

API列表

<sidebar>sidebar:push_menu</sidebar>

概述

云推送服务使用的是 REST API,分为服务端API和客户端API两种类型。

目前,为方便开发者灵活开发使用Push服务,已开放了服务端 REST API供开发者使用。

服务端 API 从使用上又分为以下两类:

  • 基础 API:开发者调用此类API即可实现开发使用Push服务的基本功能。
  • 高级 API:调用此类API可实现更多Push服务的高级功能。

基础API

query_bindlist

功能
查询设备、应用、用户与百度Channel的绑定关系。
HTTP请求方式
GET | POST
URL
http[s]://channel.api.duapp.com/rest/2.0/channel/{channel_id}
注意:
如果查询的绑定关系与channel_id无关,则{channel_id}部分直接填写channel即可。
请求参数
参数名称 类型 是否必需 描述
method string 方法名,必须存在:query_bindlist
apikey string 访问令牌,明文AK,可从此值获得App的信息,配合sign中的sk做合法性身份认证
user_id string 用户标识,不超过256字节
device_type string 百度Channel支持多种设备,各种设备的类型编号如下:

1:浏览器设备;
2:PC设备;
3:Andriod设备;
4:iOS设备;
5:Windows Phone设备;
如果存在此字段,则只返回该设备类型的绑定关系 默认不区分设备类型

start uint 查询起始页码,默认为0
limit uint 一次查询条数,默认为10
timestamp uint 用户发起请求时的unix时间戳。本次请求签名的有效时间为该时间戳+10分钟
sign string 调用参数签名值,与apikey成对出现

详细用法,请参考:签名计算算法

expires uint 用户指定本次请求签名的失效时间。格式为unix时间戳形式
v uint API版本号,默认使用最高版本
返回参数
参数名称 类型 描述
request_id uint 该字段的值由Webserver生成,返回给用户方便问题追查与定位
response_params string response_params属性是一个二级json,由n个包含key和value属性的对象组成。表示API返回的数据内容

response_params中包含以下字段:

字段 类型 描述
total_num uint 绑定数据总数
amount uint 本次查询绑定数量
channel_id uint 通道标识,系统返回的channel_id
user_id string channel绑定的user标识
device_id uint channel绑定的设备编号
device_type uint channel绑定的设备类型
device_name string channel绑定的设备描述
bind_name string channel绑定名称
bind_time string channel绑定时间
info string channel绑定附加信息
bind_status uint 绑定状态,绑定在线:0 ,绑定离线:1
online_status string 应用在线状态,在线:on ;离线:off
online_timestamp uint 连接创建时间,仅在在线状态时返回
online_expires uint 连接超时时,仅在在线状态时返回
示例

返回示例:

{
   “request_id”:12394838223,
   “response_params”:
   {
      “total_num”:10,
      “amount”:2,
      “binds”:
      {
        {
          “channel_id”:34r3fsdafsadf2f,
          “user_id”:34r3454y6578,
          “device_id”:3452345345,
          “device_type”:2,
          “device_name”:”移动手机milestone1”,
          “bind_name”:XXXXXX,
          “bind_time”:12345656,
          “info”:”xxxxxx”,
          “bind_status”:0,
          “online_status”:on,
          “online_timestamp”:123473434,
          “online_expires”:124583423,
         }
        {
         “channel_id”:45dfsf4asf4as,
         “user_id”:34r3454y6578,
         “device_id”:456gsdfgxfy,
         “device_type”:2,
         “device_name”:”移动手机milestone2”,
         “bind_name”:XXXXXX,
         “bind_time”:12345656,
         “info”:”xxxxxx”,
         “bind_status”:0,
         “online_status”:off
         “online_timestamp”:123473434,
         “online_expires”:124583423,
        }
      }
   }
}

push_msg

功能
推送消息,该接口可用于推送单个人、一群人、所有人以及固定设备的使用场景。
HTTP请求方式
POST
URL
http[s]://channel.api.duapp.com/rest/2.0/channel/channel
请求参数
参数名称 类型 是否必需 描述
method string 方法名,必须存在:push_msg。
apikey string 访问令牌,明文AK,可从此值获得App的信息,配合sign中的sk做合法性身份认证。
user_id string 用户标识,在Android里,channel_id + userid指定某一个特定client。不超过256字节,如果存在此字段,则只推送给此用户。
push_type uint 推送类型,取值范围为:1~3

1:单个人,必须指定user_id 和 channel_id (指定用户的指定设备)或者user_id(指定用户的所有设备)

2:一群人,必须指定 tag

3:所有人,无需指定tag、user_id、channel_id

channel_id uint 通道标识
tag string 标签名称,不超过128字节
device_type uint 设备类型,取值范围为:1~5

云推送支持多种设备,各种设备的类型编号如下:

1:浏览器设备;

2:PC设备;

3:Andriod设备;

4:iOS设备;

5:Windows Phone设备;

如果存在此字段,则向指定的设备类型推送消息。 默认为android设备类型。

message_type uint 消息类型

0:消息(透传给应用的消息体)

1:通知(对应设备上的消息通知)

默认值为0。

messages string 指定消息内容,单个消息为单独字符串。如果有二进制的消息内容,请先做 BASE64 的编码。

当message_type为1 (通知类型),请按以下格式指定消息内容。
通知消息格式及默认值:

{
//android必选,ios可选
"title" : "hello" ,   
“description: "hello world" 

//android特有字段,可选
"notification_builder_id": 0,
"notification_basic_style": 7,
"open_type":0,
"net_support" : 1,
"user_confirm": 0,
"url": "http://developer.baidu.com",
"pkg_content":"",
"pkg_name" : "com.baidu.bccsclient",
"pkg_version":"0.1",

//android自定义字段
"custom_content": {
	"key1":"value1", 
	"key2":"value2"
	},  

//ios特有字段,可选
"aps": {
	"alert":"Message From Baidu Push",
	"sound":"",
	"badge":0
	},

//ios的自定义字段
"key1":"value1", 
"key2":"value2"
}

注意:

  • 当description与alert同时存在时,ios推送以alert内容作为通知内容
  • 当custom_content与 ios的自定义字段"key" :"value"同时存在时,ios推送的自定义字段内容会将以上两个内容合并,但推送内容整体长度不能大于256B,否则有被截断的风险。
  • 此格式兼容Android和ios原生通知格式的推送。
  • 如果通过Server SDK推送成功,Android端却收不到通知,解决方案请参考该:问题
msg_keys string 消息标识。

指定消息标识,必须和messages一一对应。相同消息标识的消息会自动覆盖。特别提醒:该功能只支持android、browser、pc三种设备类型。

message_expires uint 指定消息的过期时间,默认为86400秒。必须和messages一一对应。
deploy_status uint 部署状态。指定应用当前的部署状态,可取值:

1:开发状态

2:生产状态

若不指定,则默认设置为生产状态。特别提醒:该功能只支持ios设备类型。

timestamp uint 用户发起请求时的unix时间戳。本次请求签名的有效时间为该时间戳+10分钟。
sign string 调用参数签名值,与apikey成对出现。

详细用法,请参考:签名计算算法

expires uint 用户指定本次请求签名的失效时间。格式为unix时间戳形式。
v uint API版本号,默认使用最高版本。
返回参数
参数名称 类型 描述
request_id uint 该字段的值由Webserver生成,返回给用户方便问题追查与定位。
示例

请求示例:

1. 推送指定用户的指定设备单条消息请求示例
Android:

http[s]://channel.api.duapp.com/rest/2.0/channel/channel?method=push_msg&apikey=Ljc710pzAa99GULCo8y48NvB&sign=8777F555E8C16715EBA5C85341684C58&timestamp=12344543232&expires=1238747373&v=1&push_type=1&device_type=3&channel_id=98765432123456789&user_id=12345678987654321&message_type=1&messages="{\"title\":\"\",\"description\":\"test\"}"&msg_keys="testkey"

iOS:

http[s]://channel.api.duapp.com/rest/2.0/channel/channel?method=push_msg&apikey=Ljc710pzAa99GULCo8y48NvB&sign=8777F555E8C16715EBA5C85341684C58&timestamp=12344543232&expires=1238747373&v=1&device_type=4&push_type=1&channel_id=98765432123456789&user_id=12345678987654321&message_type=1&messages="{\"aps\":{\"alert\":\"test\"}}"
2. 推送指定用户所有终端消息请求示例
Android:

http[s]://channel.api.duapp.com/rest/2.0/channel/channel?method=push_msg&apikey=Ljc710pzAa99GULCo8y48NvB&sign=8777F555E8C16715EBA5C85341684C58&timestamp=12344543232&expires=1238747373&v=1&device_type=3&push_type=1&user_id=12345678987654321&message_type=1&messages="{\"title\":\"\",\"description\":\"test\"}""&msg_keys="testkey"

iOS:

http[s]://channel.api.duapp.com/rest/2.0/channel/channel?method=push_msg&apikey=Ljc710pzAa99GULCo8y48NvB&sign=8777F555E8C16715EBA5C85341684C58&timestamp=12344543232&expires=1238747373&v=1&device_type=4&push_type=1&user_id=12345678987654321&message_type=1&messages="{\"aps\":{\"alert\":\"test\"}}" 
3. 推送指定一群人请求示例
Android:

http[s]://channel.api.duapp.com/rest/2.0/channel/channel?method=push_msg&apikey=Ljc710pzAa99GULCo8y48NvB&sign=8777F555E8C16715EBA5C85341684C58&timestamp=12344543232&expires=1238747373&v=1&device_type=3&push_type=2&tag=superstar&message_type=1&messages="{\"title\":\"\",\"description\":\"test\"}"&msg_keys="testkey"

iOS:

http[s]://channel.api.duapp.com/rest/2.0/channel/channel?method=push_msg&apikey=Ljc710pzAa99GULCo8y48NvB&sign=8777F555E8C16715EBA5C85341684C58&timestamp=12344543232&expires=1238747373&v=1&device_type=4&push_type=2&tag=superstar&message_type=1&messages="{\"aps\":{\"alert\":\"test\"}}"
4. 推送指定所有人请求示例
Android:

http[s]://channel.api.duapp.com/rest/2.0/channel/channel?method=push_msg&apikey=Ljc710pzAa99GULCo8y48NvB&sign=8777F555E8C16715EBA5C85341684C58&timestamp=12344543232&expires=1238747373&v=1&device_type=3&push_type=3&message_type=1&messages="{\"title\":\"\",\"description\":\"test\"}"&msg_keys="testkey"

iOS:

http[s]://channel.api.duapp.com/rest/2.0/channel/channel?method=push_msg&apikey=Ljc710pzAa99GULCo8y48NvB&sign=8777F555E8C16715EBA5C85341684C58&timestamp=12344543232&expires=1238747373&v=1&device_type=4&push_type=3&message_type=1&messages="{\"aps\":{\"alert\":\"test\"}}"

返回示例:(JSON)

1. 推送指定用户所有终端Response json 示例
{
   “request_id”:12394838223,
   “response_params”:
    {
       success_amount:2, //表示推送成功的消息数量,若其值为0表示没有推送成功
    }
}
2. 其余场景下Response json 示例
{
   “request_id”:12394838223,
}

init_app_ioscert

功能
上传iOS apns证书,使channel系统支持apns服务。
HTTP请求方式
POST
URL
https://channel.api.duapp.com/rest/2.0/channel/{channel_id}
请求参数
参数名称 类型 是否必需 描述
method string 方法名,必须存在:init_app_ioscert。
apikey string 访问令牌,明文AK,可从此值获得App的信息,配合sign中的sk做合法性身份认证。
name string 证书名称,最长128字节。
description string 证书描述,最长256字节。
release_cert string 正式版证书内容。
dev_cert string 开发版证书内容。
timestamp uint 用户发起请求时的unix时间戳。本次请求签名的有效时间为该时间戳+10分钟。
sign string 调用参数签名值,与apikey成对出现。

详细用法,请参考:签名计算算法

expires uint 用户指定本次请求签名的失效时间。格式为unix时间戳形式。
v uint API版本号,默认使用最高版本。
返回参数
参数名称 类型 描述
request_id uint 该字段的值由Webserver生成,返回给用户方便问题追查与定位。
示例

返回示例:

{ 
    “request_id”:12394838223,
}

update_app_ioscert

功能
更新iOS设备的推送证书相关内容。
HTTP请求方式
POST
URL
https://channel.api.duapp.com/rest/2.0/channel/{channel_id}
请求参数
参数名称 类型 是否必需 描述
method string 方法名,必须存在:update_app_ioscert。
apikey string 访问令牌,明文AK,可从此值获得App的信息,配合sign中的sk做合法性身份认证。
name string 证书名称,最长128字节。
description string 证书描述,最长256字节。
release_cert string 正式版证书内容。
dev_cert string 开发版证书内容。
timestamp uint 用户发起请求时的unix时间戳。本次请求签名的有效时间为该时间戳+10分钟。
sign string 调用参数签名值,与apikey成对出现。

详细用法,请参考:签名计算算法

expires uint 用户指定本次请求签名的失效时间。格式为unix时间戳形式。
v uint API版本号,默认使用最高版本。
返回参数
参数名称 类型 描述
request_id uint 该字段的值由Webserver生成,返回给用户方便问题追查与定位。
示例

返回示例:

{ 
    “request_id”:12394838223,
}

delete_app_ioscert

功能
删除iOS设备的推送证书,使得App server不再支持apns服务。
HTTP请求方式
POST
URL
https://channel.api.duapp.com/rest/2.0/channel/{channel_id}
请求参数
参数名称 类型 是否必需 描述
method string 方法名,必须存在:delete_app_ioscert。
apikey string 访问令牌,明文AK,可从此值获得App的信息,配合sign中的sk做合法性身份认证。
timestamp uint 用户发起请求时的unix时间戳。本次请求签名的有效时间为该时间戳+10分钟。
sign string 调用参数签名值,与apikey成对出现。

详细用法,请参考:签名计算算法

expires uint 用户指定本次请求签名的失效时间。格式为unix时间戳形式。
v uint API版本号,默认使用最高版本。
返回参数
参数名称 类型 描述
request_id uint 该字段的值由Webserver生成,返回给用户方便问题追查与定位。
示例

返回示例:

{ 
    “request_id”:12394838223,
}

query_app_ioscert

功能
查询该App server对应的iOS证书。
HTTP请求方式
POST
URL
https://channel.api.duapp.com/rest/2.0/channel/{channel_id}
请求参数
参数名称 类型 是否必需 描述
method string 方法名,必须存在:query_app_ioscert。
apikey string 访问令牌,明文AK,可从此值获得App的信息,配合sign中的sk做合法性身份认证。
timestamp uint 用户发起请求时的unix时间戳。本次请求签名的有效时间为该时间戳+10分钟。
sign string 调用参数签名值,与apikey成对出现。

详细用法,请参考:签名计算算法

expires uint 用户指定本次请求签名的失效时间。格式为unix时间戳形式。
v uint API版本号,默认使用最高版本。
返回值:
参数名称 类型 描述
request_id uint 该字段的值由Webserver生成,返回给用户方便问题追查与定位。
response_params string response_params属性是一个二级json,由n个包含key和value属性的对象组成。表示API返回的数据内容。

response_params包含以下字段:

字段 类型 描述
name string 证书名称
description string 证书描述。
release_cert string 正式版证书内容。
dev_cert string 开发版证书内容。
示例

返回示例:

{
   “request_id”:12394838223,
   “response_params”:
   {
    “name” : “cert_name”,
    “description” : “cert_description”,
    “release_cert” : “the content of cert after base64 ”,
    “dev_cert” : “the content of cert after base64 ”,
   }
}

高级API

verify_bind

功能
判断设备、应用、用户与Channel的绑定关系是否存在。
HTTP请求方式
GET | POST
URL
https://channel.api.duapp.com/rest/2.0/channel/{channel_id}
注意:

如果查询的绑定关系与channel_id无关,则{channel_id}部分直接填写channel即可。

请求参数
参数名称 类型 是否必需 描述
method string 方法名,必须存在:verify_bind。
apikey string 访问令牌,明文AK,可从此值获得App的信息,配合sign中的sk做合法性身份认证。
user_id string 用户标识。不超过256字节。
device_type string 百度Channel支持多种设备,各种设备的类型编号如下:

1:浏览器设备;
2:PC设备;
3:Andriod设备;
4:iOS设备;
5:Windows Phone设备;
如果存在此字段,则只返回该设备类型的绑定关系。 默认不区分设备类型。

timestamp uint 用户发起请求时的unix时间戳。本次请求签名的有效时间为该时间戳+10分钟。
sign string 调用参数签名值,与apikey成对出现。

详细用法,请参考:签名计算算法

expires uint 用户指定本次请求签名的失效时间。格式为unix时间戳形式。
v uint API版本号,默认使用最高版本。
返回参数
参数名称 类型 描述
request_id uint 该字段的值由Webserver生成,返回给用户方便问题追查与定位。
示例

返回示例:

{ 
  “request_id”:12394838223,
}

fetch_msg

功能
查询离线消息。
HTTP请求方式
GET | POST
URL
https://channel.api.duapp.com/rest/2.0/channel/{channel_id}
注意:

如果查询的绑定关系与channel_id无关,则{channel_id}部分直接填写channel即可。

请求参数
参数名称 类型 是否必需 描述
method string 方法名,必须存在:fetch_msg。
apikey string 访问令牌,明文AK,可从此值获得App的信息,配合sign中的sk做合法性身份认证。
user_id string 用户标识。不超过256字节。
start uint 查询起始页码,默认为0。
limit uint 一次查询条数,默认为10。
timestamp uint 用户发起请求时的unix时间戳。本次请求签名的有效时间为该时间戳+10分钟。
sign string 调用参数签名值,与apikey成对出现。

详细用法,请参考:签名计算算法

expires uint 用户指定本次请求签名的失效时间。格式为unix时间戳形式。
v uint API版本号,默认使用最高版本。
返回参数
参数名称 类型 描述
request_id uint 该字段的值由Webserver生成,返回给用户方便问题追查与定位。
response_params string response_params属性是一个二级json,由n个包含key和value属性的对象组成。表示API返回的数据内容。

response_params中包含以下字段:

字段 类型 描述
total_num uint 系统返回的消息个数。
channel_id uint 通道标识。
msg_id uint 系统返回的消息id。
msg_key string 消息标识,用于覆盖消息内容。
message string 消息内容。
mssage_length uint 系统返回的消息长度。
message_type uint 消息类型。
message_expires uint 消息过期时间。
示例

返回示例:

{
   “request_id”:12394838223,
   “response_params”:
   {
    “total_num”:2,
    “messages”:
   {
     {
        “channel_id”:982ehdfewqf,
        “msg_id”:2011,
        “msg_key”,”key”,
        “message”:this is bms test,
        “message_length”:16,
        “message_type”:0,
        “message_expires”:123948382,
     }
     {
        “channel_id”:982ehdfewqf,
        “msg_id”:2012,
        “msg_key”,”key”,
        “message”:this is bms test,
        “message_length”:16,
        “message_type”:0,
        “message_expires”:123948382,
     }
}
}

fetch_msgcount

功能
查询离线消息的个数。
HTTP请求方式
GET | POST
URL
https://channel.api.duapp.com/rest/2.0/channel/{channel_id}
注意:

如果查询的绑定关系与channel_id无关,则{channel_id}部分直接填写channel即可。

请求参数
参数名称 类型 是否必需 描述
method string 方法名,必须存在:fetch_msgcount。
apikey string 访问令牌,明文AK,可从此值获得App的信息,配合sign中的sk做合法性身份认证。
user_id string 用户标识。不超过256字节。
timestamp uint 用户发起请求时的unix时间戳。本次请求签名的有效时间为该时间戳+10分钟。
sign string 调用参数签名值,与apikey成对出现。

详细用法,请参考:签名计算算法

expires uint 用户指定本次请求签名的失效时间。格式为unix时间戳形式。
v uint API版本号,默认使用最高版本。
返回参数
参数名称 类型 描述
request_id uint 该字段的值由Webserver生成,返回给用户方便问题追查与定位。
response_params string response_params属性是一个二级json,由n个包含key和value属性的对象组成。表示API返回的数据内容。

response_params中包含以下字段:

字段 类型 描述
total_num uint 系统返回的消息总数。
示例

返回示例:

{ 
    “request_id”:12394838223,
    “response_params”:
    {
        “total_num”:2,
    }
}

delete_msg

功能
删除离线消息。
HTTP请求方式
POST
URL
https://channel.api.duapp.com/rest/2.0/channel/{channel_id}
注意:
如果查询的绑定关系与channel_id无关,则{channel_id}部分直接填写channel即可。
请求参数:
参数名称 类型 是否必需 描述
method string 方法名,必须存在:delete_msg。
apikey string 访问令牌,明文AK,可从此值获得App的信息,配合sign中的sk做合法性身份认证。
user_id string 用户标识。不超过256字节。
msg_ids string 删除的消息id列表,由一个或多个msg_id组成,多个用json数组表示。如:123 或 [123, 456]。
timestamp uint 用户发起请求时的unix时间戳。本次请求签名的有效时间为该时间戳+10分钟。
sign string 调用参数签名值,与apikey成对出现。

详细用法,请参考:签名计算算法

expires uint 用户指定本次请求签名的失效时间。格式为unix时间戳形式。
v uint API版本号,默认使用最高版本。
返回参数
参数名称 类型 描述
request_id uint 该字段的值由Webserver生成,返回给用户方便问题追查与定位。
response_params string response_params属性是一个二级json,由n个包含key和value属性的对象组成。表示API返回的数据内容。

response_params中的字段定义及描述如下:

字段 类型 描述
success_amount uint 成功删除条数。
msg_id uint 删除消息ID。
result uint 消息删除结果,有以下两个值:

0:成功

1:失败

示例

返回示例:

{
   “request_id”:12394838223,
   “response_params”:
   {
     success_amount:2,
     details:
     {
       “msg_id”:2,
       “result”:0,
     }
     {
       “msg_id”:3,
       “result”:1,
      }
    }
}

set_tag

功能
服务器端设置用户标签。当该标签不存在时,服务端将会创建该标签。特别地,当user_id被提交时,服务端将会完成用户和tag的绑定操作。
HTTP请求方式
POST
URL
https://channel.api.duapp.com/rest/2.0/channel/channel
请求参数
参数名称 类型 是否必需 描述
method string 方法名,必须存在:set_tag。
apikey string 访问令牌,明文AK,可从此值获得App的信息,配合sign中的sk做合法性身份认证。
tag string 标签名,最长128字节。
user_id string 用户标识,最长256字节。
timestamp uint 用户发起请求时的unix时间戳。本次请求签名的有效时间为该时间戳+10分钟。
sign string 调用参数签名值,与apikey成对出现。

详细用法,请参考:签名计算算法

expires uint 用户指定本次请求签名的失效时间。格式为unix时间戳形式。
v uint API版本号,默认使用最高版本。
返回参数
参数名称 类型 描述
request_id uint 该字段的值由Webserver生成,返回给用户方便问题追查与定位。
示例

返回示例:

{
   “request_id”:12394838223,
}

fetch_tag

功能
App Server查询应用标签。
HTTP请求方式
POST
URL
https://channel.api.duapp.com/rest/2.0/channel/channel
请求参数
参数名称 类型 是否必需 描述
method string 方法名,必须存在:fetch_tag。
apikey string 访问令牌,明文AK,可从此值获得App的信息,配合sign中的sk做合法性身份认证。
tag sring 标签名称。
start uint 查询页码,默认为0。
limit uint 一次查询条数,默认为10。
timestamp uint 用户发起请求时的unix时间戳。本次请求签名的有效时间为该时间戳+10分钟。
sign string 调用参数签名值,与apikey成对出现。

详细用法,请参考:签名计算算法

expires uint 用户指定本次请求签名的失效时间。格式为unix时间戳形式。
v uint API版本号,默认使用最高版本。

说明:

name若被指定,则获取该标签的详细信息;否则,获取按页获取应用的所有标签。

返回参数
参数名称 类型 描述
request_id uint 该字段的值由Webserver生成,返回给用户方便问题追查与定位。
response_params string response_params属性是一个二级json,由n个包含key和value属性的对象组成。表示API返回的数据内容。

response_params包含以下字段:

字段 类型 描述
total_num uint 系统返回的消息总数。
amount uint 本次查询绑定数量。
tags string 标签数组,其中包含:

tid:标签ID

name:标签名称

info:标签信息

type:标签类型

create_time:标签创建时间

示例

返回示例:

{
   “request_id”:12394838223,
   “response_params”:
   {
    “total_num”:10,
    “amount”:2,
    “tags”:
    {
     {
       “tid”: 123,
       “name”:”xxxx”,
       “info”:”XXXXX”,
       “type”:1,
       “create_time”:12345678,
     }
    {
       “tid”: 1234,
       “name”:”xxxx”,
       “info”:”XXXXX”,
       “type”:1,
       “create_time”:12345678,
      }
}
   }
}

delete_tag

功能
服务端删除用户标签。特别地,当user_id被提交时,服务端将只会完成解除该用户与tag绑定关系的操作。
注意:该操作不可恢复,请谨慎使用。
HTTP请求方式
POST
URL
https://channel.api.duapp.com/rest/2.0/channel/channel
请求参数
参数名称 类型 是否必需 描述
method string 方法名,必须存在:delete_tag。
apikey string 访问令牌,明文AK,可从此值获得App的信息,配合sign中的sk做合法性身份认证。
tag string 标签名,最长128字节。
user_id string 用户标识,最长256字节。
timestamp uint 用户发起请求时的unix时间戳。本次请求签名的有效时间为该时间戳+10分钟。
sign string 调用参数签名值,与apikey成对出现。

详细用法,请参考:签名计算算法

expires uint 用户指定本次请求签名的失效时间。格式为unix时间戳形式。
v uint API版本号,默认使用最高版本。
返回参数
参数名称 类型 描述
request_id uint 该字段的值由Webserver生成,返回给用户方便问题追查与定位。
示例

返回示例:

{
   “request_id”:12394838223,
}

query_user_tags

功能
App Server查询用户所属的标签列表。
HTTP请求方式
POST
URL
https://channel.api.duapp.com/rest/2.0/channel/channel
请求参数
参数名称 类型 是否必需 描述
method string 方法名,必须存在:query_user_tags。
apikey string 访问令牌,明文AK,可从此值获得App的信息,配合sign中的sk做合法性身份认证。
user_id string 用户标识,不超过256字节。
timestamp uint 用户发起请求时的unix时间戳。本次请求签名的有效时间为该时间戳+10分钟。
sign string 调用参数签名值,与apikey成对出现。

详细用法,请参考:签名计算算法

expires uint 用户指定本次请求签名的失效时间。格式为unix时间戳形式。
v uint API版本号,默认使用最高版本。
返回参数
参数名称 类型 描述
request_id uint 该字段的值由Webserver生成,返回给用户方便问题追查与定位。
response_params string response_params属性是一个二级json,由n个包含key和value属性的对象组成。表示API返回的数据内容。

response_params包含以下字段:

字段 类型 描述
tag_num uint 标签数
tags string 标签数组,其中包含:

tid:标签ID

name:标签名称

info:标签信息

type:标签类型

create_time:标签创建时间

示例

返回示例:

{
   “request_id”:12394838223,
   “response_params”:
   {
    “tag_num”: 2
    “tags”:
    {
     {
        “tid”: 123,
        “name”:”xxxx”,
        “info”:”XXXXX”,
        “type”:1,
        “create_time”:12345678,
      }
     {
        “tid”: 124,
        “name”:”xxxx”,
        “info”:”XXXXX”,
        “type”:1,
        “create_time”:12345678,
     }
   }
}
}

query_device_type

功能
根据channel_id查询设备类型。
HTTP请求方式
POST
URL
https://channel.api.duapp.com/rest/2.0/channel/{channel_id}
请求参数
参数名称 类型 是否必需 描述
method string 方法名,必须存在:query_device_type。
apikey string 访问令牌,明文AK,可从此值获得App的信息,配合sign中的sk做合法性身份认证。
timestamp uint 用户发起请求时的unix时间戳。本次请求签名的有效时间为该时间戳+10分钟。
sign string 调用参数签名值,与apikey成对出现。

详细用法,请参考:签名计算算法

expires uint 用户指定本次请求签名的失效时间。格式为unix时间戳形式。
v uint API版本号,默认使用最高版本。
返回参数
参数名称 类型 描述
request_id uint 该字段的值由Webserver生成,返回给用户方便问题追查与定位。
response_params string response_params属性是一个二级json,由n个包含key和value属性的对象组成。表示API返回的数据内容。

response_params包含以下字段:

字段 类型 描述
device_type uint 设备的类型,其值有以下五种:

1:浏览器设备;
2:PC设备;
3:Andriod设备;
4:iOS设备;
5:Windows Phone设备;

示例

返回示例:

{
   “request_id”:12394838223
   “response_params”:
   {
    “device_type” : 1,
   }
}