功能描述

网易云信 IM 服务端支持刷新 Token。

• 不指定 Token，随机刷新。可通过本文介绍的接口对 Token 进行随机刷新。
• 指定 Token 刷新。如果需要更新成指定的 Token，则可以调用 更新账号属性 接口，修改为指定的 Token。

本接口可以刷新指定云信账号的 Token（由云信服务器随机生成）。更新后，需要同时更新自身服务器上维护的 Token，此外也要确保客户端再次登录时携带的 Token 是最新的。

调用频率

单个应用默认最高调用频率请参考 频控说明。

请求

URL

PATCH https://open.yunxinapi.com/im/v2/accounts/{account_id}/actions/refresh_token

Header

请求 Header 的参数说明请参考 请求 Header。

路径参数

参数名称	类型	是否必选	描述
account_id	String	必选	需要刷新 Token 的云信账号 ID。

响应

Header

响应 Header 的参数说明请参考 响应 Header。

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
account_id	String	云信账号 ID。	否
token	String	刷新后的登录密钥。	否
- configuration	Object	用户账号配置项。	否
enabled	Boolean	云信账号的是否可用。禁用后账号无法登录（仍计入应用账号总数），且该账号不能进行任何云信账号相关操作，调用相关接口会报错。	否
p2p_chat_banned	Boolean	单聊禁言标记。true：禁言。	否
team_chat_banned	Boolean	群聊禁言标记。true：禁言。	否
chatroom_chat_banned	Boolean	聊天室禁言标记。true：禁言。	否
qchat_chat_banned	Boolean	圈组禁言标记。true：禁言。	否
push_enabled_when_desktop_online	Boolean	桌面端在线时是否允许移动端推送（默认为 true），当设备有登录记录时才支持设置，否则无法修改。	否

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "account_id": "123456",
        "token": "abcdef",
        "configration": {
            "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
102449	账号请求需要重试	account operation need retry
500	服务器内部错误	internal server error