AICC - 在线客服机器人网关智能体对接指南

POST /livechat/third_part_bot_register

{
  "name": "智能体机器人名称",                         // 智能体机器人名称
  "domain": "https://www.test.com",                 // 网关推送智能体接口域名
  "authEnabled": true,                              // 网关推送智能体接口是否需要鉴权
  "authentication":{                                // 网关推送智能体接口的鉴权配置
    "type": "TOKEN",                                // 网关推送智能体接口的鉴权类型
    "token": "ezliex48sp494ljx9xd"                  // 网关推送智能体接口的鉴权token
  },
  "pushConfigList": [                               // 网关推送智能体接口配置
    {
      "uri": "/api/robot/chat",                     // 网关推送智能体接口
      "httpMethod": "POST",                         // 网关推送智能体接口请求方式
      "type": "Message"                             // 网关推送智能体接口类型
    }],
  "platform": "Default",                           // 智能体平台类型
  "pushType": "Default",                           // 网关推送给智能体的推送方式类型
  "responseType": "Default"                        // 智能体给网关响应的响应方式类型
}

{
    "requestId": "str",
    "robotId": "str"
}

Authorization: Bearer {TOKEN}

{
  "robotId": "58656d16-b8b3-4722-83cd-37953f1ad566",         // 智能体完成注册后网关生成的智能体机器人ID
  "data": [
    {
      "messageType": 100,                                    // 网关推送消息类型
      "message": {
        "content": "你能做什么，请用500字回复？"                // 网关推送文本消息内容
      }
    }
  ],
  "visitorId": "1k49d8clec9e4ydoe4i",                        // 访客ID
  "sender":"1k49d8clec9e4ydoe4i",                             // 消息发送人ID
  "conversationId": "b88022da-55c9-487b-9894-9afbe2e47cc2",  // 智能体机器人会话ID
  "inputs": {},                                              // 随路参数，会话相关信息
  "responseMode":"blocking"                                  // 响应模式
}

{
  "robotId": "58656d16-b8b3-4722-83cd-37953f1ad566",        // 智能体完成注册后网关生成的智能体机器人ID
  "data": [
    {
      "messageType": 105,                                   // 网关推送消息类型
      "message": {
        "fileUrl": "https://resource-test.aliyuncs.com",    // 图片链接
        "fileName": "图片.png"                              // 图片名称
      }
    }
  ],
  "visitorId": "1k49d8clec9e4ydoe4i",                       // 访客ID
  "sender":"1k49d8clec9e4ydoe4i",                            // 消息发送人ID
  "conversationId": "b88022da-55c9-487b-9894-9afbe2e47cc2", // 智能体机器人会话ID
  "inputs": {},                                             // 随路参数， 会话相关信息
  "responseMode":"blocking"                                 // 响应模式
}

{
  "status": 200,                                               // 响应状态
  "code": "success",                                           // 响应编码
  "data": {
    "conversationId": "45701982-8118-4bc5-8e9b-64562b4555f2",  // 机器人会话ID
    "answers": [                                               // 响应内容
     {
        "answerType": "action",                                // 响应类型
        "answerContent":{
            "actionType":"TRANSFER_HUMAN",                     // 指令类型
            "actionData":{                                     // 指令数据
        }
      }
     }
    ],
    "metadata":{
    }
  }
}

{
  "status": 200,                                               // 响应状态
  "code": "success",                                           // 响应编码
  "data": {
    "conversationId": "45701982-8118-4bc5-8e9b-64562b4555f2",  // 机器人会话ID
    "answers": [                                               // 响应内容
     {
        "answerType": "action",                                // 响应类型
        "answerContent":{
            "actionType":"TRANSFER_HUMAN",                     // 指令类型
            "actionData":{                                     // 指令数据
              "qno": "1111"
        }
      }
     }
    ],
    "metadata":{
    }
  }
}

{
  "status": 200,                                                // 响应状态
  "code": "success",                                            // 响应编码
  "data": {
    "conversationId": "45701982-8118-4bc5-8e9b-64562b4555f2",   // 机器人会话ID
    "answers": [                                                // 响应内容
      {
        "answerType": "message",                                // 响应类型
        "answerContent": {                                      // 响应内容
          "content": {                                          // 响应消息对象
            "content": "这里是文本消息回复内容。"                  // 文本消息内容
           },
          "type":100                                     // 消息类型
        }
    }
    ],
    "metadata":{                                                // 随路信息
    }
  }
}

{
  "status": 200,                                                // 响应状态
  "code": "success",                                            // 响应编码
  "data": {
    "conversationId": "45701982-8118-4bc5-8e9b-64562b4555f2",   // 机器人会话ID
    "answers": [                                                // 响应内容
      {
        "answerType": "message",                                // 响应类型
        "answerContent": {                                      // 消息实体
          "content": {
            "content": "这里是富文本消息回复内容。<img src=\"https://www.baidu.com/2.png\"/>"
            },
          "type":101
         }
    }
    ],
    "metadata":{
    }
  }
}

{
  "status": 200,                                                // 响应状态
  "code": "success",                                            // 响应编码
  "data": {
    "conversationId": "45701982-8118-4bc5-8e9b-64562b4555f2",   // 机器人会话ID
    "answers": [                                                // 响应内容
      {
        "answerType": "message",                                // 响应类型
        "answerContent": {                                      // 消息实体
          "content":{
            "subtype": 10201,                                   // 子消息类型
            "cards": [{
                  "url": "https://ha.baidu.com/qifdge/detail",  // 跳转的链接地址
                  "cover": "https://img0.baidu.com/it/u=2191",  // 封面图片链接地址
                  "summary": "主要内容",                         // 主要内容
                  "title": "标题"                               // 标题
                }
              ]
          },
          "type":102                                 // 消息类型
        }
    }
    ],
    "metadata":{                                                 // 随路信息
    }
  }
}

{
  "status": 200,                                                // 响应状态
  "code": "success",                                            // 响应编码
  "data": {
    "conversationId": "45701982-8118-4bc5-8e9b-64562b4555f2",   // 机器人会话ID
    "answers": [                                                // 响应内容
      {
        "answerType": "message",                                // 响应类型
        "answerContent": {                                      // 消息实体
          "content": {
            "subtype": 10301,                                   // 子消息类型
            "content": "您可能想问以下问题：",                   // 选项标头内容
            "background": "https://www.baidu.com/1.png",        // 背景图片
            "options": [
              {
                "content": "1.今天星期几"                       // 选项内容
              },
               {
                "content": "2.今天天气怎么样"
              }
            ]
           },
          "type":103
        }
    }
    ],
    "metadata":{                                                 // 随路信息
    }
  }
}

{
  "status": 200,                                                // 响应状态
  "code": "success",                                            // 响应编码
  "data": {
    "conversationId": "45701982-8118-4bc5-8e9b-64562b4555f2",   // 机器人会话ID
    "answers": [                                                // 响应内容
      {
        "answerType": "message",                                // 响应类型
        "answerContent": {                                      // 消息实体
          "content": {
            "subtype": 10302,                                   // 子消息类型
            "content": "您可能想问以下问题：",                   // 选项标头内容
            "background": "https://www.baidu.com/1.png",        // 背景图片
            "style": "Horizontal",                              // 展示样式
            "options": [
              {
                "categoryName": "分类名称1",                     // 分类名称
                "options": [
                  {
                    "content": "1.今天星期几"                       // 选项内容
                  },
                 {
                    "content": "2.今天天气怎么样"                  // 选项内容
                  }
                ]
              },
                {
                "categoryName": "分类名称2",                     // 分类名称
                "options": [
                  {
                    "content": "1.今天星期几"                       // 选项内容
                  },
                 {
                    "content": "2.今天天气怎么样"                  // 选项内容
                  }
                ]
              }
            ]
           },
          "type":103
        }
    }
    ],
    "metadata":{                                                 // 随路信息
    }
  }
}

{
  "status": 200,                                                // 响应状态
  "code": "success",                                            // 响应编码
  "data": {
    "conversationId": "45701982-8118-4bc5-8e9b-64562b4555f2",   // 机器人会话ID
    "answers": [                                                // 响应内容
      {
        "answerType": "message",                                // 响应类型
        "answerContent": {                                      // 消息实体
          "content": {
            "subtype": 10303,                                   // 子消息类型
            "background": "https://www.baidu.com/1.png"        // 背景图片
            "options": [
              {
                "icon": "https://www.baidu.com/2.png",         // 主题图标
                "content": "主题1",                                 // 主题标题
                "categories":[
                   {
                    "categoryName": "分类名称1",                     // 分类名称
                    "options": [
                      {
                        "content": "1.今天星期几"                       // 选项内容
                      },
                     {
                        "content": "2.今天天气怎么样"                  // 选项内容
                      }
                    ]
                  },
                    {
                    "categoryName": "分类名称2",                     // 分类名称
                    "options": [
                      {
                        "content": "1.今天星期几"                       // 选项内容
                      },
                     {
                        "content": "2.今天天气怎么样"                  // 选项内容
                      }
                    ]
                  }
                ]
              }, {
                "icon": "https://www.baidu.com/2.png",             // 主题图标
                "content": "主题2",                                 // 主题标题
                "categories":[
                   {
                    "categoryName": "分类名称1",                     // 分类名称
                    "options": [
                      {
                        "content": "1.今天星期几"                   // 选项内容
                      },
                     {
                        "content": "2.今天天气怎么样"               // 选项内容
                      }
                    ]
                  },
                    {
                    "categoryName": "分类名称2",                     // 分类名称
                    "options": [
                      {
                        "content": "1.今天星期几"                       // 选项内容
                      },
                     {
                        "content": "2.今天天气怎么样"                  // 选项内容
                      }
                    ]
                  }
                ]
              }
            ]
           },
          "type":103
        }
    }
    ],
    "metadata":{                                                 // 随路信息
    }
  }
}

{
  "status": 200,                                                // 响应状态
  "code": "success",                                            // 响应编码
  "data": {
    "conversationId": "45701982-8118-4bc5-8e9b-64562b4555f2",   // 机器人会话ID
    "answers": [                                                // 响应内容
      {
        "answerType": "message",                                // 响应类型
        "answerContent": {                                      // 消息实体
          "content": {
            "fileUrl": "http://www.baidu.com/1.txt",           // 文件链接
            "fileName": "1.txt",                               // 文件名称
            "fileSize": 123456                                 // 文件大小
           },
          "type":104
        }
    }
    ],
    "metadata":{                                                 // 随路信息
    }
  }
}

{
  "status": 200,                                                // 响应状态
  "code": "success",                                            // 响应编码
  "data": {
    "conversationId": "45701982-8118-4bc5-8e9b-64562b4555f2",   // 机器人会话ID
    "answers": [                                                // 响应内容
      {
        "answerType": "message",                                // 响应类型
        "answerContent": {                                      // 消息实体
          "content": {
            "fileUrl": "http://www.baidu.com/1.png",           // 图片链接
            "fileName": "1.png",                               // 图片名称
            "fileSize": 123456                                 // 图片大小
           },
          "type":105
        }
    }
    ],
    "metadata":{                                                 // 随路信息
    }
  }
}

{
  "status": 200,                                                // 响应状态
  "code": "success",                                            // 响应编码
  "data": {
    "conversationId": "45701982-8118-4bc5-8e9b-64562b4555f2",   // 机器人会话ID
    "answers": [                                                // 响应内容
      {
        "answerType": "message",                                // 响应类型
        "answerContent": {                                      // 消息实体
          "content": {
            "content": "这里是markdown文本消息回复内容。"
           },
          "type":109
        }
    }
    ],
    "metadata":{                                                 // 随路信息
    }
  }
}

{
  "status": 200,                                                // 响应状态
  "code": "success",                                            // 响应编码
  "data": {
    "conversationId": "45701982-8118-4bc5-8e9b-64562b4555f2",   // 机器人会话ID
    "answers": [                                                // 响应内容
      {
        "answerType": "message",                                // 响应类型
        "answerContent": {                                      // 消息实体
          "content": {
            "combinationList": [{
              "type": 100,
              "content":  {
                "content": "这里是文本消息回复内容。"                  // 文本消息内容
               }
            }, {
              "type": 105,
              "content":  {
                  "fileUrl": "http://www.baidu.com/1.png",           // 图片链接
                  "fileName": "1.png",                               // 图片名称
                  "fileSize": 123456                                 // 图片大小
                 }
             }
            ]
           },
          "type":111
        }
    }
    ],
    "metadata":{                                                 // 随路信息
    }
  }
}