推送消息（pushMsg）

场景描述

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

仅WEB渠道开启消息推送，且认证方式为OAuth时，可以使用该接口。

接口方法

POST

接口URI

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

HTTPS采用TLS1.2及以上版本，确保web应用的敏感数据在传输过程中不被非法截获

请求说明

响应说明

• 响应状态码: 200

  表4 响应体参数

  序号	名称	参数类型	说明
  1	resultCode	String	0表示成功，如果返回的响应状态码不是200或resultCode不为0，则表示推送消息失败。
  2	resultDesc	String	开发人员自定义

• 响应状态码: 400

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

• 响应状态码: 401

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

• 响应状态码: 404

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

• 响应状态码: 500

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

错误码

无。

报文样例

• 请求头：

  Authorization:Bearer e******************************e
  x-app-key:e******************************0
  Content-Type:application/json

• 请求参数：

  //1connected
  {
      "timestamp": 1625898453913,
      "messages": [{
          "from": "202105284494222653",
          "channel": "WEB",
          "to": "44444444",
          "controlType": "CHAT",
          "mediaType": "TEXT",
          "content": "The call is connected to an agent.",
          "simQuestions": null,
          "senderNickname": "SYSTEM",
          "timestamp": 1625898453913,
          "sourceType": "SYSTEM",
          "callId": null,
          "messageCode": null
      }]
  }
  //queuing
  {
          "from": "202105284494222653",
          "channel": "WEB",
          "to": "44444444",
          "controlType": "CHAT",
          "mediaType": "TEXT",
          "content": "Queuing...",
          "simQuestions": null,
          "senderNickname": "SYSTEM",
          "timestamp": 1625898453913,
          "sourceType": "SYSTEM", 
          "messageCode": null
      }
  //disconnect because of agent
  {
          "from": "202105284494222653",
          "channel": "WEB",
          "to": "44444444",
          "controlType": "DISCONNECT",
          "mediaType": null,
          "content": null,
          "simQuestions": null,
          "senderNickname": null,
          "timestamp": 1625898871961,
          "sourceType": "AGENT",
          "messageCode": null   
      }
  //disconnect because of timeout, and async switch is off
  {
          "from": "202105284494222653",
          "channel": "WEB",
          "to": "44444444",
          "controlType": "DISCONNECT",
          "mediaType": null,
          "content": null,
          "simQuestions": null,
          "senderNickname": null,
          "timestamp": 1625898871961,
          "sourceType": "SYSTEM",
          "messageCode": null    
      }
  //disconnect because of timeout, and async switch is on
  {
          "from": "202105284494222653",
          "channel": "WEB",
          "to": "44444444",
          "controlType": "DISCONNECT",
            "isOfflineStatus":true,
          "mediaType": "TEXT",
          "content": "{TIPS}",
          "simQuestions": null,
          "senderNickname": null,
          "timestamp": 1625898871961,
          "sourceType": "SYSTEM",
          "messageCode": null    
      }
  //read
  {
          "from": "202105284494222653",
          "channel": "WEB",
          "to": "44444444",
          "controlType": "READ",
          "mediaType": null,
          "content": "messageId1,messageId2",
          "simQuestions": null,
          "senderNickname": null,
          "timestamp": 1625898871961,
          "sourceType": "AGENT",
          "messageCode": null   
      }

• 响应参数：

  {
      "resultCode": "0",
      "resultDesc": "success."
  }