回调函数

回调函数

回调函数事件是为了用户扩展更多玩法的方式。之前想要自定义回复内容，必须通过修改源码的方式，可能比较不友好。现在提供 了函数回调的方式，可以实现关键词返回内容的自定义，比固定素材和内容更加灵活，而且更具有通用性。

使用方式

触发关键词

输入用户触发回调的关键词，可以设置多个

匹配规则

  • 精确匹配：必须和关键词一样才会触发回调
  • 模糊匹配：用户发送的内容中包含关键词的内容就会触发回调

回调类型

  • 平台内置接口：平台内置的一些对话接口，可以直接选择使用，后期会不断扩展，也会接入更多的天行接口
  • 自定义接口：用户输入自己的回调地址

回调地址

你的接口地址，客户端会向这个地址发送POST请求

自定义参数

通常情况下，接口都会有鉴权机制，所以这里允许自定义配置一些必传参数，例如必须传固定的token值，那么在配置以后，客户端 在请求的时候会放到post的body之中，如果需要query携带参数，直接在回调地址上输入即可

上报参数说明

客户端上报采用的是POST请求，所以下面的参数需要从body中获取

参数名 必填 类型 说明 默认值
uid 是 string 用来描述用户身份信息唯一ID 无
uname 是 string 用户昵称，提问用户的昵称 无
roomId 否 string 如果是群里触发的，会有这个群id 无
roomName 否 string 如果是群里触发的，会有这个群名 无
word 是 string 用户的提问，比如 上海天气怎么样 无
自定义参数 否 string 用户的自定义参数 无

返回数据说明

需要注意你的数据返回格式必须和下方要求的保持一致，否则会无法展示返回内容

参数名 必填 类型 说明 默认值
code 是 number 状态码，成功为200，失败会取msg的值返回给用户 200
msg 是 string 返回的状态信息，成功为success，失败为失败原因 success
data 是 array 回复的内容，可以支持多个回复，所以为数组，数据内格式参见下方 无

data 内具体格式

参数名 必填 类型 说明 默认值
type 是 number 消息类型：1 文字 2 文件cdn地址 3 base64图片 4 url卡片链接 5小程序 1
content 否 string 消息内容，如果type为1必填，内容换行使用\n 无
url 否 string type 为2必填，图片cdn地址，或者文件cdn地址，例如png,jpg或者zip，excel都可以。type为3时，这个值为base64内容。type为4时为链接跳转地址 无
description 否 string type 为4，5必填，卡片或小程序的描述 无
thumbUrl 否 string type 为4必填，卡片链接的缩略图，网络图片地址 无
title 否 string type 为4，5必填，卡片或小程序标题内容 无
appid 否 string type 为5必填，小程序appid，建议先转发小程序给支持的助手，解析获得参数 无
iconUrl 否 string type 为5必填，小程序logo地址，建议先转发小程序给支持的助手，解析获得参数 无
pagePath 否 string type 为5必填，小程序打开页面路径，建议先转发小程序给支持的助手，解析获得参数 无
shareId 否 string type 为5必填，小程序分享的id，建议先转发小程序给支持的助手，解析获得参数 无
thumbKey 否 string type 为5必填，默认undefined undefined
thumbUrl 否 string type 为5必填，小程序图片，cdn图片地址 推荐在 200K 以内，比例 5：4，宽度不大于 1080px 无
username 否 string type 为5必填，用户，建议先转发小程序给支持的助手，解析获得参数 无

返回文字

发送文字，换行使用\n或\r，表情可以使用输入法的表情，或者 [红包] 这种替代

{
  "code": 200,
  "msg": "success",
  "data": [
    {
      "type": 1,
      "content": "发送的内容\n内容[红包]😊"
    }
  ]
}

返回图片或者文件

{
  "code": 200,
  "msg": "success",
  "data": [
    {
      "type": 2,
      "url": "https://img.aibotk.com/aibotk/public/yq3wWdBL0BnJV4Z1_sh.jpeg"
    },
    {
      "type": 3,
      "url": "base64图片内容"
    },
    {
      "type": 2,
      "url": "https://img.aibotk.com/aibotk/public/kbap8w56GBZWqjYd_test.docx"
    }
  ]
}

返回h5卡片链接

web协议不支持发送h5卡片形式的链接，默认以文字的形式展示，如果是支持的协议会以卡片的形式发送

{
  "code": 200,
  "msg": "success",
  "data": [
    {
      "type": 4,
      "url": "https://wechat.aibotk.com",
      "description": "描述内容",
      "thumbUrl": "https://img.aibotk.com/aibotk/public/yq3wWdBL0BnJV4Z1_sh.jpeg",
      "title": "卡片标题"
    }
  ]
}

返回小程序

web协议不支持发送h5卡片形式的链接，默认以文字的形式展示，如果是支持的协议会以卡片的形式发送

{
  "code": 200,
  "msg": "success",
  "data": [
    {
      "type": 5,
      "appid": "wx363a...",
      "description": "贝壳找房 - 真房源",
      "title": "美国白宫，10室8厅9卫，99999刀/月",
      "iconUrl": "http://mmbiz.qpic.cn/mmbiz_png/.../640?wx_fmt=png&wxfrom=200",
      "pagePath": "pages/home/home.html...",
      "shareId": "0_wx363afd5a1384b770_..._1615104758_0",
      "thumbKey": "undefined",
      "thumbUrl": "https://.../thumb.jpeg",
      "username": "gh_8a51...@app"
    }
  ]
}