send

提示

  • 本接口在服务器端调用
  • 目前只有今日头条支持,抖音和 lite 接入中

发送模版消息

接口地址

POST https://developer.toutiao.com/api/apps/game/template/send

输入

以下参数均在 JSON body 中。

名称类型必填含义
access_tokenString服务端 API 调用标识,获取方法
touserString要发送给用户的 open id, open id 的获取请参考登录
template_idString在开发者平台配置消息模版后获得的模版 id
pageString点击消息卡片之后打开的小程序页面地址,空则无跳转
form_idString可以通过<form />组件获得 form_id, 获取方法
datadict<String, SubData>模板中填充着的数据,key 必须是 keyword 为前缀

SubData

SubData 也是 dict,结构如下:

名称类型是否必填
valueString

输出

接口响应时一个 JSON body。结构如下:

名称类型含义
errcodeNumber错误码
errmsgString成功为"success", 错误为具体 message

errcode

code含义
0成功
-1发生系统内部错误
40001http 包体无法解析
40002access_token 无效
40014参数无效
40037错误的模版 id
40038小程序被禁止发送消息通知
40039form_id 不正确,或者过期
40040form_id 已经被使用
40041错误的页面地址

示例

请求:

POST /api/apps/game/template/send HTTP/1.1
Host: developer.toutiao.com
Content-Type: application/json

{"access_token": "YOUR_ACCESS_TOKEN", "app_id": "YOUR_APP_ID", "data": {"keyword1": {"value": "v1"}, "keyword2": {"value": "v2"}}, "page": "pages/index", "form_id": "YOUR_FORM_ID", "touser": "USER_OPEN_ID", "template_id": "YOUR_TPL_ID"}

响应:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"errcode":0,"errmsg":"success"}
点击纠错