文档

GenerateWebSocketSign - 生成MessageBox通道签名

根据AICCS实例ID和坐席账号名称,生成消息通道访问签名。

接口说明

  • 您可以通过此接口生成消息通道访问签名,返回参数的 Data 即为 MessageBox 消息通道签名码。

  • 调用前建议您确认 AICCS 实例 ID,请参考请求参数描述中的指引获取。

QPS 限制

  • 单用户调用频率:不限流。
  • API 频率:100 次/秒。
说明 如果多个用户的总调用超过 API 频率也会触发流控。

调试

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

授权信息

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

请求参数

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

客户请求唯一 ID。用于幂等校验,可以用 UUID 生成。

46c1341e-2648-447a-****-70b6a298d94d
InstanceIdstring

AICCS 实例 ID。 您可以在智能联络中心控制台左侧导航栏的实例管理中获取。

ccc_xp_pre-cn-***
AccountNamestring

坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。

username@example.com

返回参数

名称类型描述示例值
object

返回数据。

Messagestring

状态码描述。

OK
RequestIdstring

请求 ID。

EE338D98-9BD3-4413-B165
Datastring

MessageBox 消息通道签名码。

dnthF_oinHg7JMJDmKqex3UxDD7
Codestring

状态码。返回 Success 表示请求成功。

Success
Successboolean

调用接口是否成功。取值:

  • true:成功。
  • false:失败。
true
HttpStatusCodelong

HTTP 状态码。

200

示例

正常返回示例

JSON格式

{
  "Message": "OK",
  "RequestId": "EE338D98-9BD3-4413-B165",
  "Data": "dnthF_oinHg7JMJDmKqex3UxDD7",
  "Code": "Success",
  "Success": true,
  "HttpStatusCode": 200
}

错误码

HTTP status code错误码错误信息描述
500NoAgentFoundThe specified agent does not exist.没有找到指定坐席
500NoTenantFoundThe specified tenant does not exist.没有发现租户实例
500SystemErrorA system error occurred. Please contact the administrator.系统错误,请联系管理员!

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

  • 本页导读 (1)