发送消息 (send)

描述

发送渠道消息，包括连接，发送输入状态，会话，转人工，断连多种类型消息

接口方法

POST

接口URI

https://域名/apiaccess/ccmessaging/send，例如域名是https://service.besclouds.com

请求说明

响应说明

• 响应状态码: 200

  表4 senMsgRsp参数结构

  序号	名称	参数类型	是否必选	说明
  1.1	resultDesc	string	False	返回结果码描述 根据不同的场景，返回描述不一样： CONNECT连接座席 如果resultCode返回0：成功 如果resultCode返回11：Queuing... 如果resultCode返回12：The current time is not within the working time of the service agents 如果resultCode返回13：No ccucs address available!或connect failed, none channel config found. 其他非零错误请参见《CCUCS接口开发指南》中的错误码参考。 CONNECT连接机器人 如果resultCode返回0：connect to robot successfully或process robot multi message successfully。 如果resultCode返回11：Queuing... 如果resultCode返回13：Failed to disconnect robot或No ccucs address available!或fail to initialize robot.或connect failed, none channel config found. DISCONNECT断连座席 如果resultCode返回0：disconnect successfully 如果resultCode返回11：Queuing... 如果resultCode返回13：disconnect failed.或disconnect failed, none channel config found.或disconnect failed, session keep touch failed. DISCONNECT断连机器人 如果resultCode返回0：Disconnect robot successfully 如果resultCode返回11：Queuing... 如果resultCode返回13：Failed to disconnect robot.或disconnect failed, none channel config found.或disconnect failed, session keep touch failed. CHAT座席场景 如果resultCode返回0：sendUserMessage successfully. 如果resultCode返回3：Incorrect JSON format或content can not be empty或the content Json String must contains mediaFileId or redirectUrl或the content Json String must contains title或Incorrect mediaFileType. 如果resultCode返回11：Queuing... 如果resultCode返回13：sendUserMessage failed.或Chat failed because the content is empty.或chat failed, none channel config found.或chat failed, send too quick or session keep touch failed. CHAT机器人场景 如果resultCode返回0：Failed to disconnect robot 或Send message to robot successfully 或process robot multi message successfully 如果resultCode返回3：Incorrect JSON format或content can not be empty或the content Json String must contains mediaFileId or redirectUrl或the content Json String must contains title或Incorrect mediaFileType 如果resultCode返回11：Queuing... 如果resultCode返回13：connect failed或Chat failed because the content is empty.或chat failed, none channel config found.或chat failed, send too quick or session keep touch failed. TRANS2AGENT场景 如果resultCode返回13：转人工失败，找不到渠道配置transfer to agent failed, none channel config found. 如果resultCode返回13：转人工失败，会话已失效。fail to transfer from robot to agent,session keep touch failed. 如果resultCode返回13：转人工失败,当前已经是人工服务。fail to transfer from robot to agent,it has been agent service. 如果resultCode返回11：Queuing... 如果resultCode返回12：当前非座席工作时间！The current time is not within the working time of the service agents. 如果resultCode返回13：转人工失败, 无法连接CCUCS。fail to transfer from robot to agent,connect to ccucs failed. 如果resultCode返回13：断开机器人连接失败。Failed to disconnect robot. 如果resultCode返回13：当前无可用座席。No agents available currently. 如果resultCode返回0：transfer from robot to agent success. INPUT场景 如果resultCode返回0：sendUserMessage successfully. 如果resultCode返回11：Queuing... 如果resultCode返回13：发送输入状态失败，找不到渠道配置。send inputStatus failed, none channel config found. 如果resultCode返回13：现在是机器人服务，此条消息无法发送！This is robot service,this message is prevented! 如果resultCode返回13：发送用户消息失败！sendUserMessage failed 如果resultCode返回13: Queuing... 如果resultCode返回3：发送网页卡片消息成功，但是跳转地址未添加到白名单，座席无法跳转。 The redirection address is not in the trust list, contact operation staff to add it.
  1.2	resultCode	string	True	接口返回码，成功为0，非0失败
  1.3	offlineMsg	object	False	如果离线开关打开，则该值将为true。如果离线开关关闭，AICC将不会返回此对象。
  1.3.1	isOfflineStatus	boolean	False	用于客户端判断连接失败后用户是否可以发送消息。 在以下场景中， 1.用户发送失败（controlType=CONNECT）， 2.用户发送（controlType=CHAT）失败，没有会话， 3.用户在技能队列中等待时发送(controlType=DISCONNECT)
  1.3.2	tipText	string	False	当isOfflineStatus为true时，即触发离线模式，消息将被保存。

• 响应状态码: 400

  错误的请求：请检查请求路径及参数。

• 响应状态码: 401

  未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。

• 响应状态码: 404

  请求的内容未找到：请检查请求的路径。

• 响应状态码: 500

  业务失败：请依次确认您请求中各参数的取值。

错误码

无。

报文样例

• 场景描述：连接机器人

请求参数:

{
  "content": "",
  "controlType": "CONNECT",
  "from": "session_1619573111751_user_1619573111751",
  "mediaType": "TEXT",
  "senderNickname": "user_1619573111751",
  "sourceType": "CUSTOMER",
  "timestamp": "1619573122352",
  "to": "1011577355744904195",
  "userAgent": null,
  "senderAvatar": null,
  "channel": "WEB"
}

响应参数:

{
    "resultCode": "0",
    "resultDesc": "connect to robot successfully."
}

• 场景描述：与机器人交谈请求

请求参数:

{
  "content": "版本",
  "controlType": "CHAT",
  "from": "session_1619573111751_user_1619573111751",
  "mediaType": "TEXT",
  "senderNickname": "user_1619573111751",
  "sourceType": "CUSTOMER",
  "timestamp": "1619573123199",
  "to": "1011577355744904195",
  "userAgent": null,
  "senderAvatar": null,
  "channel": "WEB"
}

响应参数:

{
    "resultCode": "0",
    "resultDesc": "Send message to robot successfully"
}

• 场景描述：机器人转人工请求

请求参数:

{
  "content": "",
  "controlType": "TRANS2AGENT",
  "from": "session_1619573111751_user_1619573111751",
  "mediaType": "TEXT",
  "senderNickname": "user_1619573111751",
  "sourceType": "CUSTOMER",
  "timestamp": "1619573129953",
  "to": "1011577355744904195",
  "userAgent": null,
  "senderAvatar": null,
  "channel": "WEB"
}

响应参数:

{
    "resultCode": "0",
    "resultDesc": "transfer from robot to agent success."
}

请求参数:

{
  "content": "{\"title\":\"测试title 测试title 测试title\",\"description\":\"测试描述 测试描述 测试描述 测试描述\",\"mediaFileId\":\"xxxx-xxxx-xxxx-xxxx-2e171ac78313\",\"mediaFileType\":\"img\",\"redirectUrl\":\"https://www.****.com\"}",
  "controlType": "CHAT",
  "from": "session_1619573111751_user_1619573111751",
  "mediaType": "WEBCARD",
  "senderNickname": "user_1619573111751",
  "sourceType": "CUSTOMER",
  "timestamp": "1619573129953",
  "to": "1011577355744904195",
  "userAgent": null,
  "senderAvatar": null,
  "channel": "WEB"
}

响应参数:

{
    "resultCode": "0",
    "resultDesc": "sendUserMessage successfully."
}
或
{
    "resultCode": "3",
    "resultDesc": "The redirection address is not in the trust list， contact operation staff to add it."
}

• 场景描述：断连请求

请求参数:

{
  "content": "",
  "controlType": "DISCONNECT",
  "from": "session_1619573842490_user_1619573842490",
  "mediaType": "TEXT",
  "senderNickname": "user_1619573842490",
  "sourceType": "CUSTOMER",
  "timestamp": "1619573854156",
  "to": "1011577355744904195",
  "userAgent": null,
  "senderAvatar": null,
  "channel": "WEB"
}

响应参数:

{
    "resultCode": "0",
    "resultDesc": "Disconnect robot successfully"
}