OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
touser | String | Required | 接收者(用户)的 openid | ||
template_id | String | Required | 下发的模板消息的id | ||
page | String | Optaion | 点击模板卡片后的跳转页面,仅限本小程序内的页面。支持带参数,(示例index?foo=bar)。该字段不填则模板无跳转。 | ||
form_id | String | Required | 表单提交场景下,为 submit 事件带上的 formId;支付场景下,为本次支付的 prepay_id | ||
data | ArrayJSON Format | Optaion | 模板内容,不填则下发空模板。具体格式请参考示例。需要JSON编码后传递JSON在线解析及格式化验证 | ||
emphasis_keyword | String | Optaion | 模板需要放大的关键词,不填则默认无放大 | ||
appname | String | Optaion | 小白开放平台配置的应用名称,如果是默认配置,此字段则可不传 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
touser | *Required | |
template_id | *Required | |
page | Option | |
form_id | *Required | |
data | Option | |
emphasis_keyword | Option | |
appname | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0发送成功,40037 template_id不正确,41028 form_id不正确,或者过期,41029form_id已被使用,41030page不正确,45009 接口调用超过限额(目前默认每个帐号日调用限额为100万) |
err_msg | String | 操作失败的结果 |
HTTP Response Code
HTTP Status Code | Description |
---|---|
Http Status = 200 | Success |
Http Status = 400 | Illegal-Params |
Http Status = 401 | Illegal-Token |
Http Status = 402 | IP-Banned |
Http Status = 404 | API-NOT-Exsits |
Http Status = 406 | Illegal-APPKEY |
Http Status = 407 | APPKEY-Expired-Out |
Http Status = 408 | APPKEY-Busy |
Http Status = 409 | Illegal-Sign |
Http Status = 413 | API-Traffic-NOT-Enough |
Http Status = 415 | API-LOCKED |
Http Status = 500 | Internal-Server-Error |