Messenger参数设置API

存储变量API

此API可以为用户存储环境变量,以供发送模板消息API使用。

发送请求

您可以用任意一个已经启用的API Key向Meetbot发起请求,向一个手机号或一个官网账号发送一条消息。
这个请求的说明如下:
请求属性属性名说明
地址https://api.bothub.ai/api
请求方式POST
HeaderAPIKEY您的API KEY
Form Datarequest.method需要调用的api。此处设置为set_params
Form Datarequest.id用来唯一标识此发送请求的id。由调用方生成
Form Datarequest.meta预留字段
Form Datarecipient要发送消息的用户信息,只能指定一个用户
Form Datasettings.params要替换的参数。形式会在下方详述。

请求样例

{ "recipient":{ "id":"7819201" }, "settings":{ "params":[ { "key":"points", "value":"20000" }, { "key":"prize", "value":"Gold Medal" } ] }, "request":{ "method":"set_params", "id":"F4js0Za1", "meta":"" } }

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

错误码列表

返回值内容
10000内部错误
10001未指定API KEY
10002无效的API KEY
10003未指定Request id
10004未指定调用API的种类
10005无效的API种类
10006Bot不存在或者已经被删除
10007未指定recipient字段
10008recipient结构不正确
10009无效的用户指定方式
10010用户不存在
10011Request id与之前的重复
10100参数无效
18000内部错误
19000回调超时
21001未定义Params字段
21002Params结构错误

用户指定

  • 用不同的方式(比如id和email)指定的是同一个用户,参数都是设置在同一个用户上的。
  • 当根据手机号发送用户,返回用户id之后,此手机号和用户被视为同一个用户,想更新此用户的参数,此API可以指定手机号或者id,效果相同。

参数格式

params用于指定需要更新的用户变量,可以指定多个。 样例格式如下:1"params":[2{3"key":"points",4"value":"20000"5},6{7"key":"prize",8"value":"Gold Medal"9}10]Copied!
  • 可以指定多个参数。
  • 如果要设置的参数已存在,会覆盖之前的设置。
  • 若value为空串,相当于设置此值为空串(使用发送模板消息时,这个参数会被替换为空串,而不是被认为是未设置)。
2024-05-14
0