如何通过HTTP请求与Botpress机器人对话（含Postman调用）

1. 前置准备 #

• 获取核心参数：
  • Botpress实例地址：你的机器人部署地址（如http://localhost:3000或线上域名）
  • Bot ID：在Botpress后台进入目标机器人，从URL或机器人设置页获取
  • API Token：在Botpress后台个人设置页生成管理员级别的API密钥
• Postman配置基础请求头：
  • Content-Type: application/json
  • Authorization: Bearer <你的API Token>

2. 发送用户消息到机器人 #

使用POST请求触发对话，步骤如下：

• 请求方法：POST
• 请求URL：http://<你的Botpress地址>/api/v1/bots/<Bot ID>/conversations/<会话ID>/messages
  • 会话ID可自定义（如user_001_conv），若该ID不存在，Botpress会自动创建新会话
• 请求体（JSON格式）：

{
  "type": "text",
  "text": "你好，我想咨询订单问题",
  "userId": "user_001"
}

• type：消息类型，常用text（文本），支持carousel、card等
• text：用户发送的具体内容
• userId：用户唯一标识，需保持会话内一致

3. 解析机器人响应 #

发送请求后，Botpress会返回包含回复消息的JSON响应，示例：

{
  "messages": [
    {
      "id": "msg_678",
      "type": "text",
      "text": "您好，请问您的订单编号是多少？",
      "userId": "bot",
      "conversationId": "user_001_conv"
    }
  ],
  "status": "success"
}

• messages数组：包含机器人的所有回复内容，若有多种消息类型（如文本+卡片），会按顺序列出
• 若需维持会话，后续请求需使用相同的conversationId和userId

4. 常见问题处理 #

• 权限错误：检查API Token是否为管理员级别，以及请求头中Authorization格式是否正确（Bearer后加空格）
• 会话丢失：确保每次请求使用相同的conversationId和userId
• 消息类型不支持：若发送非文本消息，需匹配Botpress对应消息类型的JSON结构（如卡片消息需包含title、buttons等字段）

内容的提问来源于stack exchange，提问作者James Chong