SiteGPT
    SiteGPT
    • 入门
    • 获取所有聊天机器人
      GET
    • 创建聊天机器人
      POST
    • 获取聊天机器人
      GET
    • 删除聊天机器人
      DELETE
    • 更新聊天机器人外观
      PATCH
    • 修改聊天机器人自定义内容
      POST
    • 获取所有后续提示
      GET
    • 添加跟进提示
      POST
    • 获取后续提示
      GET
    • 删除后续提示
      DELETE
    • 更新跟进提示
      PATCH
    • 更新聊天机器人图标
      POST
    • 删除聊天机器人图标
      DELETE
    • 获取链接
      GET
    • 添加聊天机器人链接
      POST
    • 发信息
      POST
    • 更新消息
      PATCH
    • 添加聊天机器人提示
      POST
    • 删除聊天机器人提示
      DELETE
    • 更新聊天机器人提示
      PATCH
    • 获取所有快速提示
      GET
    • 添加快速提示
      POST
    • 获取快速提示
      GET
    • 删除快速提示
      DELETE
    • 更新快速提示
      PATCH
    • 更新聊天机器人设置 - 高级
      PATCH
    • 更新聊天机器人设置 - 聊天模式
      PATCH
    • 更新聊天机器人设置 - 常规
      PATCH
    • 更新聊天机器人设置 - 本地化
      PATCH
    • 更新聊天机器人设置 - 用户数据
      PATCH
    • 获取所有线程
      GET
    • 获取线程
      GET
    • 更新主题
      PATCH
    • 升级对话
      POST
    • 获取白标品牌
      GET
    • 获取白标品牌
      GET
    • 添加白标用户
      POST
    • 更新白标用户
      PATCH

      发信息

      开发环境
      开发环境
      POST
      /api/v0/chatbots/{chatbotId}/message
      向特定线程发送消息或启动新线程
      请求示例请求示例
      Shell
      JavaScript
      Java
      Swift
      curl --location --request POST 'http://dev-cn.your-api-server.com/api/v0/chatbots//message' \
      --header 'Authorization: Bearer <token>' \
      --header 'Content-Type: application/json' \
      --data-raw '{
        "message": "What can you do ?",
        "from": "USER"
      }'
      响应示例响应示例
      200 - 成功示例
      {
        "success": true,
        "message": "Sent the message successfully",
        "data": {
          "message": {
            "id": "376290410396385873",
            "question": {
              "text": "This is user!!",
              "timestamp": "2023-08-03T11:43:52.037718Z"
            },
            "answer": {
              "text": "This is agent!!",
              "timestamp": "2023-08-03T11:19:19.041469Z"
            },
            "sources": [],
            "gptModel": "gpt-3.5-turbo",
            "reaction": "NEUTRAL",
            "threadId": "06b3b43c-5651-49a2-b618-d7f24667c1b6",
            "messageType": "AGENT_MESSAGE",
            "iconUrl": "https://avatars.githubusercontent.com/u/17903466?s=48&v=4",
            "agentName": "Test Agent",
            "prompts": [
              {
                "id": "17e23880-386e-492f-960c-4394baec2977",
                "title": "Prompt 1",
                "description": "This is the prompt1 description"
              },
              {
                "id": "ab0ba301-90c9-4ef2-8ca8-fa579a104386",
                "title": "Prompt 2",
                "description": "This is the prompt2 description"
              }
            ],
            "smartPrompts": [
              "First smart prompt",
              "Second smart prompt",
              "Third smart prompt"
            ],
            "chatbotId": "365062873485935184"
          }
        }
      }

      请求参数

      Path 参数
      chatbotId
      string 
      必需
      聊天机器人的 ID
      Header 参数
      Authorization
      string 
      必需
      示例值:
      Bearer <token>
      Content-Type
      string 
      必需
      示例值:
      application/json
      Body 参数application/json
      message
      string 
      包含消息的实际文本
      必需
      from
      string 
      必需
      示例

      返回响应

      🟢200成功
      application/json
      Body
      success
      boolean 
      必需
      指示这是成功响应还是错误响应
      message
      string 
      必需
      有关所执行操作的总体消息
      data
      object 
      从服务器返回的数据
      必需
      message
      object 
      消息对象
      必需
      🟠400请求有误
      🟠401没有权限
      🟠403禁止访问
      🟠404记录不存在
      🔴500服务器错误
      修改于 2024-03-28 07:49:47
      上一页
      添加聊天机器人链接
      下一页
      更新消息
      Built with