在线调试
更新移动端推送配置
更新时间: 2024/07/17 16:48:53
功能描述
该接口可以设置指定云信账号的移动端推送配置。即可配置当桌面端在线时,是否允许移动端推送。
只有当用户有设备登录记录时才支持设置,否则无法修改。
建议优先使用更新账号属性接口来设置移动端推送配置。
调用频率
单个应用默认最高调用频率请参考 频控说明。
请求
URL
PATCH https://open.yunxinapi.com/im/v2/accounts/{account_id}/actions/push_config
Header
请求 Header 的参数说明请参见请求 Header。
路径参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
account_id |
String | 必选 | 需要设置移动端推送配置的云信账号 ID。 |
请求体参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
push_enabled_when_desktop_online |
Boolean | 必选 | 桌面端在线时是否允许移动端推送,当设备有登录记录时才支持设置,否则无法修改。 |
请求体示例
json{
"push_enabled_when_desktop_online": false
}
响应
Header
响应 Header 的参数说明请参见响应 Header。
响应体参数
参数名称 | 类型 | 描述 | 是否必返回 |
---|---|---|---|
code |
Integer | 状态码,200 表示请求成功。 | 是 |
msg |
String | 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。 | 是 |
+
data |
Object | 返回的 JSON 数据对象,请求失败则返回空对象。 | 是 |
响应体示例
json{
"code": 200,
"msg": "success",
"data": {
"account_id": "123456",
"configuration": {
"enabled": false,
"p2p_chat_banned": false,
"team_chat_banned": false,
"chatroom_chat_banned": false,
"qchat_chat_banned": false,
"push_enabled_when_desktop_online": true
}
}
}
错误码
错误码 | 错误码描述 | 错误信息示例 |
---|---|---|
200 | 请求成功 | success |
414 | 参数错误 | parameter error |
102404 | 用户不存在 | account not exist |
102301 | 找不到设备登录记录push_enabled_when_desktop_online 时可能发生。 |
login record not found |
102449 | 账号请求需要重试 | account operation need retry |
500 | 服务器内部错误 | internal server error |
此文档是否对你有帮助?