GenerateWebSocketSign - 生成MessageBox通道签名_智能联络中心(AICCS)-阿里云帮助中心

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

接口说明

您可以通过此接口生成消息通道访问签名，返回参数的 Data 即为 MessageBox 消息通道签名码。
调用前建议您确认 AICCS 实例 ID，请参考请求参数描述中的指引获取。

QPS 限制

单用户调用频率：不限流。
API 频率：100 次/秒。

说明如果多个用户的总调用超过 API 频率也会触发流控。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	客户请求唯一 ID。用于幂等校验，可以用 UUID 生成。	46c1341e-2648-447a-****-70b6a298d94d
InstanceId	string	是	AICCS 实例 ID。您可以在智能联络中心控制台左侧导航栏的实例管理中获取。	ccc_xp_pre-cn-***
AccountName	string	是	坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。	username@example.com

返回参数

名称	类型	描述	示例值
	object	返回数据。
Message	string	状态码描述。	OK
RequestId	string	请求 ID。	EE338D98-9BD3-4413-B165
Data	string	MessageBox 消息通道签名码。	dnthF_oinHg7JMJDmKqex3UxDD7
Code	string	状态码。返回 Success 表示请求成功。	Success
Success	boolean	调用接口是否成功。取值： true：成功。 false：失败。	true
HttpStatusCode	long	HTTP 状态码。	200

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
500	NoAgentFound	The specified agent does not exist.	没有找到指定坐席
500	NoTenantFound	The specified tenant does not exist.	没有发现租户实例
500	SystemError	A system error occurred. Please contact the administrator.	系统错误，请联系管理员！

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