其他接口

其他接口

1. 鉴权

1.1 说明

用户身份验证通过获得auth_token权限令牌,后面的请求都需要带上auth_token

1.2 实例

curl -H "Content-Type: application/json" \
https://restapi.getui.com/v1/CKWfvgBDRF9aSnGrvD7IJ4/auth_sign \
-XPOST -d '{ "sign":"c44dcb4626e76cbbbec6615d837865c8162049af4c70c0bd8a3a101a15417dd7",
"timestamp":"1451207094490",
"appkey":"pMEgGQ9bgz5LVAPX8q8WH4"
}'
返回:
{"result":"ok", "auth_token":"xxxxx"}

1.3 接口说明

属性 类型 是否必传 说明
sign String sha256(appkey+timestamp+mastersecret)
mastersecret为注册应用时生成
timestamp String 时间戳,毫秒级别
appkey String 注册应用生成的appkey
  • 响应数据
属性 类型 说明
result String ok 鉴权成功,见详情
auth_token String 权限令牌,推送消息时,需要提供
auth_token有效期默认为1天,过期后无法使用

2. 关闭鉴权

2.1 说明

将auth_token设为无效,以防止auth_token被其他人恶意使用

2.2 实例

请求:

curl -H "authtoken: xxxxx" \
https://restapi.getui.com/v1/CKWfvgBDRF9aSnGrvD7IJ4/auth_close \
-XPOST

响应:

{"result":"ok"}

2.3 接口说明

属性 类型 是否必传 说明
appid String 应用标识id,在请求url中
  • 响应数据
属性 类型 说明
result String ok 鉴权成功,见详情

3. 别名功能

3.1 cid绑定别名

3.1.1 说明

一个ClientID只能绑定一个别名,若已绑定过别名的ClientID再次绑定新别名,则认为与前一个别名自动解绑,绑定新别名
允许将多个ClientID和一个别名绑定,如用户使用多终端,则可将多终端对应的ClientID绑定为一个别名,目前一个别名最多支持绑定10个ClientID

3.1.2 实例

请求:

curl -H "Content-Type: application/json"  \
     -H "authtoken:eef0742e8bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b88586" \
     https://restapi.getui.com/v1/CKWfvgBDRF8aSnGrvD7IJ4/bind_alias \
     -XPOST -d '{
                "alias_list" : [{"cid":"xxxxx", "alias":"别名"}]
                 }'

响应:

"result":"ok"

3.1.3 接口说明

属性 类型 是否必传 说明
alias_list List
cid String 需要绑定别名的cid列表
alias String 需要绑定的别名
  • 响应数据
属性 类型 说明
result String 操作结果,见详情
desc String 错误信息描述

3.2 别名查询cid

3.2.1 说明

通过传入的别名查询对应的cid信息

3.2.2 实例

请求:

curl -H "Content-Type: application/json"
-H "authtoken:eef0742e8bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b88586"
https://restapi.getui.com/v1/CKWfvgBDRF8aSnGrvD7IJ4/query_cid/别名
-XGET

响应:

{"result":"ok", "cid":["cid1xxxxx", "cid2xxxx"]}

3.2.3 接口说明

属性 类型 说明
result String 操作结果 成功返回ok 见详情
cid List 返回和别名绑定的所有cid
desc String 错误信息描述

3.3 cid查询别名

3.3.1 说明

通过传入的cid查询对应的别名

3.3.2 实例

请求:

curl -H "Content-Type: application/json"  \
     -H "authtoken:eef0742e8bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b88586" \
     https://restapi.getui.com/v1/CKWfvgBDRF8aSnGrvD7IJ4/query_alias/cidxxxxxx \
     -XGET

响应:

{"result":"ok", "alias":"xxxx"}

3.3.3 接口说明

属性 类型 说明
result String 操作结果 成功返回ok 见详情
alias String 返回cid绑定别名
desc String 错误信息描述

3.4 单个cid和别名解绑

3.4.1 实例

请求:

curl -H "Content-Type: application/json"  \
     -H "authtoken:eef0742e8bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b88586" \
     https://restapi.getui.com/v1/CKWfvgBDRF8aSnGrvD7IJ4/unbind_alias  \
     -XPOST -d '{
                "cid":"xxxxx", "alias":"别名"
                 }'

响应:

{"result":"ok"}

3.4.2 接口说明

属性 类型 是否必传 说明
cid String 需要和别名解绑的cid
alias String 需要解绑的别名
  • 响应数据
属性 类型 说明
result String 操作结果 成功返回ok 见详情
desc String 错误信息描述

3.5 解绑别名所有cid

3.5.1 实例

请求:

curl -H "Content-Type: application/json"  \
     -H "authtoken:eef0742e8bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b88586" \
     https://restapi.getui.com/v1/CKWfvgBDRF8aSnGrvD7IJ4/unbind_alias_all  \
     -XPOST -d '{
                 "alias":"别名"
                 }'

响应:

{"result":"ok"}

3.5.2接口说明

属性 类型 是否必传 说明
alias String 需要解绑对应所有cid的别名
  • 响应数据
属性 类型 说明
result String 操作结果 成功返回ok 见详情
desc String 错误信息描述

4. 标签管理

4.1 说明

通过标签(tag)方式实现用户分组,将消息发给指定标签用户,更进一步筛选了用户,实现精细化运营

4.2 对指定用户设置tag属性

4.2.1 实例

请求:

curl -H "Content-Type: application/json"  \
     -H "authtoken:eef0742e8bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b88586" \
     https://restapi.getui.com/v1/CKWfvgBDRF8aSnGrvD7IJ4/set_tags  \
     -XPOST -d '{
                 "cid":"483aa7bcde360c77702c45cb59262c20", "tag_list":["tag1", "tag2"] }'

响应:

{"result":"ok"}

4.2.2 接口说明

属性 类型 是否必传 说明
cid String 指定需要设置标签的用户id
tag_list List 用户需要设置的标签列表
  • 响应数据
属性 类型 说明
result String 操作结果 成功返回ok 见详情
desc String 错误信息描述

注:此接口有频次控制,申请修改请联系邮箱:kegf@getui.com

4.3 查询指定用户tag属性

4.3.1 实例

请求:

curl -H "Content-Type: application/json" \
     -H "authtoken:eef0742e9bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b98586" \
     https://restapi.getui.com/v1/CKWfvgBDRF9aSnGrvD7IJ4/get_tags/cid1 \
     -XGET

响应:

{"result":"ok", "cid":"cid1", "tags":"tagxxxx"}

4.3.2接口说明

属性 类型 说明
result String 操作结果 成功返回ok 见详情
cid String 设置tag属性的用户
tags String 返回指定用户的tag属性列表

5. 黑名单用户管理

5.1 说明

将指定cid列表中的用户加入/移除黑名单,对于黑名单用户在推送过程中会被过滤掉的,不会给黑名单用户推送消息

5.2 添加黑名单用户

5.2.1 实例

请求:

curl -H "Content-Type: application/json" \
     -H "authtoken:eef0742e9bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b98586" \
     https://restapi.getui.com/v1/CKWfvgBDRF9aSnGrvD7IJ4/user_blk_list  \
     -XPOST -d '{
                 "cid":["493aa7bcde360c77702c45cb59262c20"]
                 }'

响应:

{"result":"ok"}

5.2.2 接口说明

属性 类型 是否必传 说明
cid List 需要添加到用户黑名单的用户列表
  • 响应数据
属性 类型 说明
result String 操作结果 成功返回ok 见详情
desc String 错误信息描述

5.3 移除黑名单用户

5.3.1 实例

请求:

curl -H "Content-Type: application/json"  \
     -H "authtoken:eef0742e9bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b98586" \
     https://restapi.getui.com/v1/CKWfvgBDRF9aSnGrvD7IJ4/user_blk_list  \
     -XDELETE -d '{
                 "cid":["493aa7bcde360c77702c45cb59262c20"]
                 }'

响应:

{"result":"ok"}

5.3.2 接口说明

属性 类型 是否必传 说明
cid List 需要从用户黑名单中移除的用户列表
  • 响应数据
属性 类型 说明
result String 操作结果 成功返回ok 见详情
desc String 错误信息描述

6. 查询接口

6.1 查询用户状态

6.1.1 说明

调用此接口可获取用户状态,如在线不在线

6.1.2 实例

请求:

curl -H "Content-Type: application/json" \
-H "authtoken:eef0742e9bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b98586" \
https://restapi.getui.com/v1/CKWfvgBDRF9aSnGrvD7IJ4/user_status/493aa7bcde360c77702c45cb59262c20  \
-XGET

响应:

{"result":"ok", "lastlogin":"1484018265935", "cid":"a8b4f7eb2f79b53843290d93fe3496e", "status":"offline"}

6.1.3接口说明

属性 类型 说明
result String 操作结果 无效用户返回no_user,见详情
cid String 查询状态的用户cid
status String 用户状态 online在线 offline离线
lastlogin String sdk上次登陆时间戳

6.2 获取推送结果接口

6.2.1 说明

调用此接口查询推送数据,可查询消息有效可下发总数,消息回执总数和用户点击数等结果。

6.2.2 实例

请求:

curl -H "Content-Type: application/json" \
-H "authtoken:eef0742e9bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b98586" \
https://restapi.getui.com/v1/CKWfvgBDRF9aSnGrvD7IJ4/push_result \
-XPOST -d '{"taskIdList":["taskid1", "taskid2"]}'

响应:

{result=ok, data=[{taskId=xxxx, msgTotal=5, msgProcess=2, clickNum=0, pushNum=2,APN={"displayed":0,"result":"ok","feedback":-1,"clicked":0, "sent":0},GT={"feedback":2,"displayed":0,"result":"ok","sent":2,"clicked":0}}]}

6.2.3 接口说明

属性 类型 是否必传 说明
taskidlist List 查询的任务结果列表
  • 响应数据
属性 类型 说明
result String 操作结果 成功返回ok 见详情
data List 查询数据对象
taskid String 任务号
msgTotal long 有效可下发总数
msgProcess long 消息回执总数
clickNum long 用户点击数
pushNum long im下发总量
GT object 个推推送结果数据
sent 成功下发数
feedback 回执数
clicked 点击数
displayed 展示数
APN object iOS推送结果数据,详细字段参考GT

6.3 获取单日用户数据接口

6.3.1 说明

调用此接口查询推送数据,可查询消息有效可下发总数,消息回执总数和用户点击数等结果。

6.3.2 实例

请求:

curl -H "Content-Type: application/json" \
-H "authtoken:eef0742e9bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b98586" \
https://restapi.getui.com/v1/CKWfvgBDRF9aSnGrvD7IJ4/query_app_user/2016-04-04 \
-XGET

响应:

{"result":"ok","data":{"appId":"appidxxx","date":"20160404","newRegistCount":2,"registTotalCount":9,"activeCount":5,"onlineCount":2}}

6.3.3 接口说明

属性 类型 说明
result String 操作结果 成功返回ok 见详情
data - 查询数据对象
appId String 请求的AppId
date String 查询的日期(格式:yyyy-MM-dd)
newRegistCount long 新注册用户数
registTotalCount long 累计注册用户数
activeCount long 活跃用户数
onlineCount long 在线用户数使用方法

6.4 获取单日推送数据接口

6.4.1 说明

调用此接口可以获取某个应用单日的推送数据(推送数据包括:发送总数,在线发送数,接收数,展示数,点击数)

6.4.2 实例

请求:

curl -H "Content-Type: application/json" \
-H "authtoken:eef0742e9bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b98586" \
https://restapi.getui.com/v1/CKWfvgBDRF9aSnGrvD7IJ4/query_app_push/20160404 \
-XGET

响应:

{"result":"ok", "data":{"appId":"nBc9CjUjHp9kU0XU5cAZQ7", "date":"2016-12-15", "sendCount":5, "sendOnlineCount":2, "receiveCount":2, "showCount"0, "clickCount":0}, "GT":{"sent":2,"feedback":2,"displayed":0,"clicked":0}}

6.4.3 接口说明

属性 类型 说明
result String 操作结果 成功返回ok 见详情
data - 查询数据对象
appId String 请求的AppId
date String 查询的日期(格式:yyyy-MM-dd)
sendCount long 发送总数
sendOnlineCount long 在线发送数
receiveCount long 接收数
showCount long 展示数
clickCount long 点击数

6.5 应用角标设置接口(仅iOS)

6.5.1 说明

设置iOS用户应用icon上显示的数字

6.5.2 实例

请求:

curl -H "Content-Type: application/json" \
-H "authtoken:eef0742e9bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b98586" \
https://restapi.getui.com/v1/CKWfvgBDRF9aSnGrvD7IJ4/set_badge \
-XPOST -d '{
"badge":-8,"cid_list":["1fa0795a57c863ecc9a9ea6437b8924f","2dw0795a57c8sd3ecc9a9ea643adsfasdd"],
"devicetoken_list":["3ec222e1570436b803bf99f7faeeeb6e515cb906673aa33b9c2ec3205de55849",
"221fdb444d1aa2f1f9abaf2812b178260e1fdb444d1aa2f1f9abaf2812b17826"]
}'

响应:

{"result":"ok"}

6.5.3 接口说明

属性 类型 说明
appid String 请求的AppId
msgid String 请求的msgid
badge int 应用icon上显示的数字
cid_list List cid列表
devicetoken_list List deviceToken列表
  • 响应数据
属性 类型 说明
result String 操作结果 成功返回ok 见详情
desc String 详情

6.6 根据任务组名获取推送结果数据

6.6.1 说明

根据任务组名查询推送结果,返回结果包括百日内联网用户数(活跃用户数)、实际下发数、到达数、展示数、点击数。

6.6.2 实例

请求:

curl -H "Content-Type: application/json" \
-H "authtoken:eef0742e9bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b98586" \
https://restapi.getui.com/v1/CKWfvgBDRF9aSnGrvD7IJ4/get_push_result_by_group_name/taskName_toApp \
-XGET

响应:

{"result":"ok","msgTotal":9,"onlineNum":8,"msgProcess":8,"showNum":2,"clickNum":3}

6.6.3 接口说明

属性 类型 说明
appid String 请求的AppId
groupName String 任务组名
  • 响应数据
属性 类型 说明
result String 操作结果 成功返回ok 见详情
msgTotal long 百日内活跃用户数
onlineNum long 消息实际下发数
msgProcess long 消息接收数
showNum long 消息展示数
clickNum long 消息点击数
desc String 错误详情

6.7 获取24小时在线用户数

6.7.1 说明

通过接口查询当前时间一天内的在线数(十分钟一个点,一小时六个点)

6.7.2 实例

请求:

curl -H "Content-Type: application/json" \
-H "authtoken:eef0742e9bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b98586" \
https://restapi.getui.com/v1/CKWfvgBDRF9aSnGrvD7IJ4/get_last_24hours_online_User_statistics \
-XGET

响应:

{"result":"ok", "onlineStatics":{}}

6.7.3 接口说明

属性 类型 说明
appId String 请求的AppId
  • 响应数据
属性 类型 说明
result String 操作结果 成功返回ok 见详情
onlineStatics Map 24小时用户在线数统计,Map(key时间点,value在线数)
desc String 错误详情

6.8 按条件查询用户数

6.8.1 说明

通过指定查询条件来查询满足条件的用户数量

6.8.2 实例

请求:

curl -H "Content-Type: application/json" \
-H "authtoken:eef0742e9bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b98586" \
https://restapi.getui.com/v1/CKWfvgBDRF9aSnGrvD7IJ4/query_user_count \
-XPOST -d
'{ "condition":[{ "key":"phonetype", "values":["ANDROID"], "opt_type":0 }]}'

响应:

{"result":"ok", "user_count":90}

6.8.3 接口说明

属性 类型 说明
appid String 请求的AppId
condition array 查询条件
  • 响应数据
属性 类型 说明
result String 操作结果 成功返回ok,见详情
user_count Integer 满足条件的用户数

6.9 获取可用bi标签

6.9.1 说明

查询应用可用的bi标签列表

6.9.2 实例

请求:

curl -H "Content-Type: application/json" \
-H "authtoken:eef0742e9bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b98586" \
    https://restapi.getui.com/v1/CKWfvgBDRF9aSnGrvD7IJ4/query_bi_tags \
–XGET

响应:

{"result":"ok", "tags":[]}

6.9.3 接口说明

属性 类型 说明
appid String 请求的AppId
  • 响应数据
属性 类型 说明
result String 操作结果 成功返回ok,见详情
tags List 可用bi标签列表

6.10 获取回执的用户列表

6.10.1 说明

查询有回执的用户列表

6.10.2 实例

请求:

curl -H "Content-Type: application/json" \
-H "authtoken:eef0742e9bb7aa52bd1ede66a0a20c68057208656e5f558c020fb24aa5b98586" \
https://restapi.getui.com/v1/CKWfvgBDRF9aSnGrvD7IJ4/get_feedback_users \
-XPOST -d '{ "data":[{ "taskId":"taskid", "cids":["cid1"]} ] }'

响应:

{"result":"ok", "hasfb":{"taskId":"xxx", "cids":[{"cid":"xxx", "actionIds":["xxx", "aaa"]}]}}

6.10.3 接口说明

属性 类型 说明
appid String 请求的AppId
taskId String 任务Id
cids List cid列表
  • 响应数据
属性 类型 说明
result String 操作结果 成功返回ok,见详情
info String 错误信息
hasfb List 有回执的用户列表
nofb List 无回执的用户列表
taskId String 任务Id
cids List cid列表
cid String cid
actionIds List action列表
通知
2018.10.09 Android SDK 4.3.2.0

新增通知覆盖、撤回 适配Android 9.0

......
2018.09.27 PYTHON SDK 4.1.0.0

添加python新加接口功能文档说明

......
2018.09.27 PHP SDK 4.1.0.0

修改新鉴权方式 支持iOS语音播报 iOS透传消息模版支持副标题

......
2018.09.06 JAVA SDK 4.1.0.0

修改新鉴权方式 支持iOS语音播报 支持消息撤回和覆盖

......
2018.08.30 Android SDK 2.12.5.0

新增通知覆盖、撤回功能 兼容Android9.0

......

文档中心搜索