StartChat - 发起聊天_云联络中心(Cloud Contact Center)-阿里云帮助中心

调用StartChat发起聊天。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	否	实例 ID。	ccc-test
UserList	array<object>	是	聊天成员信息。
	object	是
UserId	string	否	成员 ID。	fcd020fe-d8e4-40e5-8c77-1a272a174a7d
UserType	string	否	成员类型。 AGENT : 坐席 CUSTOMER : 访客	CUSTOMER
AvatarUrl	string	否	成员头像链接。	http://xxx.com/image
Nickname	string	否	成员昵称。	访客-1a272a174a7d
Token	string	否	网络业务的渠道 Token。	9XYGTGWtq2wFi_Bpg7aUnIoYi_vG_rO3bjEn0YtsxbHRHrYHlz1LDBLJAyZcLxieRQR4h_6AnWvTjJeNU5jg************Hwej7WgWrmA=
AccessChannelId	string	否	网络业务渠道 ID。	cf584733-*-*-9699-cb77aa3b7aa6

返回参数

名称	类型	描述	示例值
	object
Code	string	响应码。	OK
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	响应信息。	无
RequestId	string	请求 ID。	EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Data	object	响应数据。
ChatConversationId	string	聊天会话 ID。	$23086709$EAUNIT
JobId	string	话务 ID。	chat-525523618219921408

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Data": {
    "ChatConversationId": "$23086709$EAUNIT",
    "JobId": "chat-525523618219921408"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Parameter.Blank	The parameter %s must not be null.	-
400	Parameter.Empty	The parameter %s must not be null or empty.	-
400	Parameter.Format	The format of parameter %s is invalid.	-
400	Parameter.Null	The parameter %s must not be null.	-
404	NotExists.InstanceId	The specified instance %s does not exist.	指定的呼叫中心实例不存在。
409	AlreadyExists.SkillGroup	The skill group %s already exists in instance %s.	-

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