Bothub.AI 用户手册简体中文版
Primary version
Primary version
  • 概览
  • 介绍
    • 什么是 Messenger Bot 🤔
  • 快速入门
    • 5分钟创建一个机器人
  • BotHub 基础知识
    • Messenger 机器人的基本功能
    • 多用户管理功能
    • 数据分析
      • 内容分析
      • 流量来源
    • 内容管理
      • 内容结构介绍
      • 文本、图片和视频卡片
      • 菜单卡片及各类按钮
      • 橱窗卡片以及快捷回复
      • 列表卡片
      • 系统设置介绍
      • 标签化内容
      • 广告消息
    • 受众人群
      • 查看历史消息
      • 推送事件
    • 消息群发
      • 广播消息
      • 订阅消息
      • 多时区支持
      • 问卷调研
    • Handover Protocol
    • 人工智能
      • 对话管理
      • 识别优先级
  • BotHub高级工具
    • 高级插件
      • Messenger 网页插件
      • RSS Feed插件
      • 用户输入插件
      • Google搜索插件
      • 订阅管理插件
      • 订阅插件“加入受众”和“移出受众”
      • 商品选取插件
      • 商品搜索插件
      • 购物车展示插件
      • Json Api组件
      • 条件跳转插件
      • 属性设置插件
      • 随机回复插件
      • Typing插件
      • 计数器
      • 语境跳转插件
    • 数据集成
      • 知识库-自动获取Gitbook的文档数据
    • API介绍
      • 开始使用API
      • 关联账号
      • Messenger内的登录按钮
      • 交易信息通知
      • 发送消息API
      • 发送模板消息
      • 生成优惠券的接口的写法
      • 发送知识库条目
      • 参数设置API
      • 呼叫人工
      • whatsapp消息入口
      • 发送whatsapp消息
      • 发送liveChat请求
    • 推广
      • 推广工具
      • 广告管理
      • 再营销SDK的集成
      • 评论回复功能
      • 砍价免费拿
      • Messenger 广告
    • 电商机器人
      • 电商机器人功能介绍
      • 配置你的电商机器人
      • 顾客查询
      • 商家推送
      • 场景应用:顾客查询订单 & 包裹
      • 场景应用:推送订单回执
      • 场景应用:推送订单回执(旧版SDK)
      • 场景应用:包裹更新提醒
      • 场景应用:购物车召回配置
      • 场景应用:购物车召回配置(旧版SDK)
    • 商品管理
      • 商品Feed-Facebook商品数据集成
      • 自定义商品-手动创建活动商品
  • WhatsApp相关说明
    • whatsapp消息入口
    • 发送Whatsapp消息
    • 发送liveChat请求
  • FAQ常见问题
    • Bot 配置常见问题
    • Bot 操作流程问题
      • 如何授权新的FB Page 至Bot平台
      • 首次登录 messenger.bothub.ai 邮箱验证流程
      • 设置仅工作时间段人工客服有效
    • Facebook平台政策问题
      • FB 平台政策
      • Messenger page禁封影响&解封流程
      • 24小时窗口期与24+1 政策解读
Powered by GitBook
On this page
  • 发送请求
  • 请求样例
  • 错误码列表
  • 消息格式
  1. BotHub高级工具
  2. API介绍

发送知识库条目

Previous生成优惠券的接口的写法Next参数设置API

Last updated 6 years ago

此API提供了发送Bothub后台中预定义的消息模板,但是对每个用户可以以自定义变量替换消息中占位符,以达到定制化的效果。 例如,我们在Bothub后台定义如下文本消息: "您的目前积分为" 而我们在发送信息时可以为每个用户指定参数为他的实际积分数。这样我们就实现了发送用户积分数量的功能。如果我们希望更改文字,或是使用除纯文字之外的模板,直接在Bothub后台修改模板即可,完全不需要任何代码级的修改。

发送请求

您可以用任意一个已经启用的API Key() 向Bothub发起请求,向一个手机号或一个官网账号发送一条消息。这个请求的说明如下:

请求属性

属性名

说明

地址

请求方式

POST

Header

APIKEY

您的API KEY

Form Data

request.method

需要调用的api。此处设置为send_block

Form Data

request.id

用来唯一标识此发送请求的id。由调用方生成

Form Data

request.sync

为true或false。若为true,Bothub会等待发送完所有消息后再返回请求。若为false,则会立即返回,等到发送完消息后再发一个请求给api调用方

Form Data

request.meta

预留字段

Form Data

recipient

要发送消息的用户信息,只能指定一个用户

Form Data

message

要发送的消息。形式会在下方详述。

Form Data

params

要替换的参数。形式会在下方详述。

请求样例

{
    "recipient": {
        "id": "7819201"
    },
    "message": {
        "knowledge_base_name": "MyKB1", 
        "knowledge_base_item_name: "#kb_item1#"
    },
    "request": {
        "method": "send_block",
        "id" : "F4js0Za1",
        "sync": true,
        "meta": ""
    }
}

同步方式请求返回值以及异步式调用回调内容

错误码列表

返回值

内容

10000

内部错误

10001

未指定API KEY

10002

无效的API KEY

10003

未指定Request id

10004

未指定调用API的种类

10005

无效的API种类

10005

无效的API种类

10006

Bot不存在或者已经被删除

10007

未指定recipient字段

10008

recipient结构不正确

10009

无效的用户指定方式

10010

用户不存在

10011

Request id与之前的重复

10100

参数无效

18000

内部错误

19000

回调超时

20001

未定义Message字段

20002

未定义交易通知地址

20004

Message字段结构错误

  • 如果指定的用户是手机号,并且发送成功了,那么会返回用户信息,包含用户id,姓名。以后指定该用户就可以使用id。

  • 如果选择的是异步方式,那么返回值会作为参数发送到商户指定的回调地址处。

消息格式

样例格式如下

"message": {
    "knowledge_base_name": "MyKB",
    "knowledge_base_item_name": "#kb-item-1.md#"
}

在发送知识库条目之前,需要确保知识库已经导入到Bothub的后台中.

knowledge_base_name为必填,为创建知识库时输入的知识库名称(如下图的Bothub)

knowledge_base_item_name 为必填,为知识库条目的名称,为知识库条目链接下方显示的以##包含的字符串。可以点击右方的copy to clipboard进行拷贝。

请详见

怎样申请APIKey
请求返回值
https://api.bothub.ai/api