调用GenerateWebSocketSign生成消息通道访问签名。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GenerateWebSocketSign

系统规定参数。取值:GenerateWebSocketSign

ClientToken String 46c1341e-2648-447a-9b11-70b6a298d94d

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

InstanceId String ccc_xp_pre-cn-***

AICCS实例ID。可在智能联络中心控制台上获取。

AccountName String 123@123.com

坐席账号名称(坐席登录名)。

返回数据

名称 类型 示例值 描述
Message String xxxx

状态码描述。

RequestId String EE338D98-9BD3-4413-B165

请求ID。

Data String dnthF_oinHg7JMJDmKqex3UxDD7

MessageBox消息通道签名码。

Code String Success

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

Success Boolean true

接口调用是否成功。

示例

请求示例

http(s)://aiccs.aliyuncs.com/?Action=GenerateWebSocketSign
&ClientToken=46c1341e-2648-447a-9b11-70b6a298d94d
&InstanceId=ccc_xp_pre-cn-***
&AccountName=123@123.com
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GenerateWebSocketSignResponse>
<Message>xxxx</Message>
<RequestId>EE338D98-9BD3-4413-B165</RequestId>
<Data>dnthF_oinHg7JMJDmKqex3UxDD7</Data>
<Code>Success</Code>
<Success>true</Success>
</GenerateWebSocketSignResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
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. 系统错误,请联系管理员!

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