- 支付
- 私域
- 公域
- 营销
- 资金
- 会员
- 信用
- 安全
- 其他
消息模板申领接口
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
/v3/alipay/open/mini/message/template/apply
错误码#
公共错误码#
业务错误码#
状态码 | 错误码 | 错误描述 | 解决方案 |
---|---|---|---|
400 | TEMPLATE_KEYWORDS_LIMIT_ERROR | 模版的关键字段个数为2-5个 | 确认请求参数符合关键词个数要求 |
400 | TEMPLATE_OVER_LIMIT | 已领取的模版不能超过50个 | 删除部分子版后再领取 |
400 | ILLEGAL_ARGUMENT_PARAMS | 无效的参数 | 请仔细阅读文档传参,确认入参结构是否正确,模板库code以及对应的关键字段是否存在等 |
400 | TEMPLATE_LIB_NOT_EXIST | 消息母板不存在 | 确认传入的母板lib_code可用 |
400 | TEMPLATE_KEYWORD_NOT_EXIST | 消息模版关键字段不存在 | 确认申领的关键字段是存在的 |
400 | SYSTEM_ERROR | 系统繁忙 | 请检查输入参数是否正确,或者稍后重试 |
400 | RULE_SELECT_ERROR | 订阅规则选择有误 | 请确认接口传入的订阅规则是否正确,需要与消息母板的订阅规则保持一致。如母板为一次性订阅,则本接口需要传入一次性订阅规则。 |
400 | MSG_TEMPLATE_APPLY_ACCESS_FAIL | 消息模板申领准入规则校验失败 | 联系运营处理 |
400 | MSG_TEMPLATE_LIB_NOT_SELECTABLE | 所选母板暂不可选 | 请检查所选母版是否可选,如还有疑问则联系运营处理 |
请 求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/open/mini/message/template/apply' \
--header 'authorization: ALIPAY-SHA256withRSA app_id=$appid,timestamp=$now,nonce=$uuid,expired_seconds=600,sign=$sign' \
--header 'alipay-request-id: $requestid' \
--header 'Content-Type: application/json' \
--data-raw '{
"lib_code":"TMba10b7c396674479b116f955919f631c",
"keyword_list":[
{
"name":"消息时间"
}
],
"scene_rule":"one_time_subscribe"
}'
响应示例响应示例
200 - 成功示例
{
"template_id": "7c866fab64464afaa956223c74ce6cbc"
}
请求参数
Header 参数
authorization
string
必需
示例值:
ALIPAY-SHA256withRSA app_id=$appid,timestamp=$now,nonce=$uuid,expired_seconds=600,sign=$sign
alipay-request-id
string
必需
示例值:
$requestid
Content-Type
string
必需
示例值:
application/json
Body 参数application/json
lib_code
string
消息母板code
keyword_list
array [object {1}]
必需
name
string
模板关键字名称
scene_rule
string
必需
示例
返回响应
🟢200成功
application/json
Body
template_id
string
消息模板id
🟠400请求有误