调用GetMessageToken获取长连接建连Token,客户端可以用此Token通过LWP协议和各个原子能力进行长连接通信。
接口说明
使用说明
先获取客户端 UserId、DeviceId、DeviceType 信息,然后传入到服务端,服务端使用该接口获取鉴权 Token,并返回给客户端。不同的用户需要使用不同的 UserId,不同的终端设备需要使用不同的 DeviceId。
QPS 限制
本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
live:GetMessageToken |
get |
*全部资源
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
AppId |
string |
是 |
互动消息应用 ID。 |
a494caec-***-695ef345db77 |
DeviceId |
string |
是 |
终端设备 ID,唯一代表一个用户终端设备,用户自定义。小写英文、数字、下划线(_)和短横线(-)组成,最大长度 64 个字符。不同终端设备需要使用不同的 DeviceId,建议从终端设备获取并传入给服务端。 |
a494caec-***-695ef345db77 |
DeviceType |
string |
是 |
终端设备类型,取值:
|
android |
UserId |
string |
是 |
用户 UserId,用户自定义,在 AppId 下单独唯一。小写英文、数字、下划线(_)和小数点(.)组成,最大长度 32 个字符。不同的用户需要使用不同的 UserId。 |
de1**a0 |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
Schema of Response |
||
RequestId |
string |
请求 ID。 |
16A96B9A-****-CB92E68F4CD8 |
Result |
object |
返回结果。 |
|
AccessToken |
string |
用于长连接建连的 Token。 |
oauth_cloud_key:***-b0YY5Gy6Q |
AccessTokenExpiredTime |
integer |
登录 Token 过期时间,单位:毫秒。 |
86400000 |
RefreshToken |
string |
更新 Token,若 AccessToken 过期,则可以使用 RefreshToken 再次获取新 Token。 |
oauth_cloud_key:****-Q62xggOTdgk3gw= |
示例
正常返回示例
JSON
格式
{
"RequestId": "16A96B9A-****-CB92E68F4CD8",
"Result": {
"AccessToken": "oauth_cloud_key:***-b0YY5Gy6Q",
"AccessTokenExpiredTime": 86400000,
"RefreshToken": "oauth_cloud_key:****-Q62xggOTdgk3gw="
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。