文档

InitIMConnect - 初始化im连接

更新时间:

通过渠道后台配置生成的from值,自定义初始化im连接信息,初始化时支持传递用户鉴权token。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Fromstring

B 端渠道配置中生成的 From 值

8XNBzDucJv
UserAccessTokenstring

通过 GenerateUserAccessToken 接口获取的用户 token 数据,不填时默认访客接入;

QUM4SndaY3VPMjhkQldDZUNOR0ZaTmZ5R3NBY0FKWHJ4OGc4dERZbEJzcjNIKzFiS1RyTjhXRUpBYmVpQlpsakprNDRFVkdxcy9HWVk2RXZvalU3bHhxRkJlc1NBUXZwdHFKOTE2UTNwamQ4b1U4N3dEbmhyRjc4R2hOQStvMnMrYkV2dlVpSHNvWC96SEVNZWRqMjBuMXdjNklpamJzaDNWYllnUldDZGhJPQ==
AgentKeystring

业务空间 key,不设置则访问默认业务空间,key 值在主账号业务管理页面获取

ac627989eb4f8a98ed05fd098bbae5_p_beebot_public

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

E6988CE6-41CF-1103-9BEC-2B20D26C0B52
Successboolean

是否成功

true
Codestring

返回编码

200
Messagestring

异常信息

Parameter.Invalid
Datastring

im 连接信息

{ "imDomain": "im.alimebot.com", "appKey": "WDg2VfNv", "token": "QUM4SndaY3VPMjhkQldDZUNOR0ZaTmZ5R3NBY0FKWHJ4OGc4dERZbEJzcjNIKzFiS1RyTjhXRUpBYmVpQlpsakprNDRFVkdxcy9HWVk2RXZvalU3bHhxRkJlc1NBUXZwdHFKOTE2UTNwamQ4b1U4N3dEbmhyRjc4R2hOQStvMnMrYkV2dlVpSHNvWC96SEVNZWRqMjBuMXdjNklpamJzaDNWYllnUldDZGhJPQ==" }

imDomain: im 连接域名, appKey: im 认证 key, token: im 连接 token。

示例

正常返回示例

JSON格式

{
  "RequestId": "E6988CE6-41CF-1103-9BEC-2B20D26C0B52",
  "Success": true,
  "Code": "200",
  "Message": "Parameter.Invalid",
  "Data": "{     \"imDomain\": \"im.alimebot.com\",     \"appKey\": \"WDg2VfNv\",     \"token\": \"QUM4SndaY3VPMjhkQldDZUNOR0ZaTmZ5R3NBY0FKWHJ4OGc4dERZbEJzcjNIKzFiS1RyTjhXRUpBYmVpQlpsakprNDRFVkdxcy9HWVk2RXZvalU3bHhxRkJlc1NBUXZwdHFKOTE2UTNwamQ4b1U4N3dEbmhyRjc4R2hOQStvMnMrYkV2dlVpSHNvWC96SEVNZWRqMjBuMXdjNklpamJzaDNWYllnUldDZGhJPQ==\"   }"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史