发送媒体消息模板
媒体模板在标准消息模板类型的基础上，扩展了允许向收信人发送的内容，其中包括媒体和使用 components 对象的标头。您可通过 components 对象指明消息的 type 和 parameters。
 |  |  |
第 1 步：向 /messages 发出 POST 请求
POST /v1/messages
{
"to": "recipient_wa_id",
"type": "template",
"template": {
"namespace": "your-namespace",
"language": {
"policy": "deterministic",
"code": "your-language-and-locale-code"
},
"name": "your-template-name",
"components": [
{
"type" : "header",
"parameters": [
# The following parameters code example includes several different possible header types,
# not all are required for a media message template API call.
{
"type": "text",
"text": "replacement_text"
}
# OR
{
"type": "document",
"document": {
"id": "your-media-id",
# filename is an optional parameter
"filename": "your-document-filename"
}
}
# OR
{
"type": "document",
"document": {
"link": "the-provider-name/protocol://the-url",
# provider and filename are optional parameters
"provider": {
"name" : "provider-name"
},
"filename": "your-document-filename"
}
}
# OR
{
"type": "video",
"video": {
"id": "your-media-id"
}
}
# OR
{
"type": "video",
"video": {
"link": "the-provider-name/protocol://the-url"
# provider is an optional parameter
"provider": {
"name" : "provider-name"
}
}
}
# OR
{
"type": "image",
"image": {
"link": "http(s)://the-url",
# provider is an optional parameter
"provider": {
"name" : "provider-name"
},
}
}
]
# end header
},
{
"type" : "body",
"parameters": [
{
"type": "text",
"text": "replacement_text"
},
{
"type": "currency",
"currency" : {
"fallback_value": "$100.99",
"code": "USD",
"amount_1000": 100990
}
},
{
"type": "date_time",
"date_time" : {
"fallback_value": "February 25, 1977",
"day_of_week": 5,
"day_of_month": 25,
"year": 1977,
"month": 2,
"hour": 15,
"minute": 33, #OR
"timestamp": 1485470276
}
},
{
...
# Any additional template parameters
}
]
# end body
},
]
}
}
参数
媒体格式推荐
- 宽高比大于 1.91:1 的图像将被裁成竖幅。为传达这些图像中的关键内容，请安排将最重要的信息呈现在图像的中心位置。
第 2 步：检查 API 响应情况
成功响应包含带有 id 的 messages 对象。
{
"messages": [{
"id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
}]
}
失败响应会包含错误对象，其中包含错误字符串、错误代码和其他信息。
如果您向无法接收模板的帐户发送模板，则系统会在错误对象中向已配置的 Webhooks 服务器发送 1026 (ReceiverIncapable) 错误。
关于错误的更多信息，请参阅错误和状态代码。
示例
这些示例会展示设置媒体消息模板的流程，包括在商务管理平台创建模板，以及通过向 messages 端点发出 API 调用来发送消息模板。
这些示例仅用于举例说明，不可用于实际用途。您必须创建自己的示例，并让其通过审核，以测试媒体消息模板的功能。
电影票示例
此示例会展示如何创建包含二维码图像的媒体消息模板。
1. 在您的商务管理平台中创建媒体消息模板。
商务管理平台消息模板创建流程
2. 在 messages API 调用中添加参数信息。
POST /v1/messages
{
"to": "your-test-recipient-wa-id",
"recipient_type": "individual",
"type": "template",
"template": {
"namespace": "88b39973_f0d5_54e1_29cf_e80f1e3da4f2",
"name": "movie_ticket_update",
"language": {
"code": "en",
"policy": "deterministic"
},
"components": [
{
"type": "header",
"parameters": [
{
"type": "image",
"image": {
"id": "your-image-id"
}
}
]
},
{
"type": "body",
"parameters": [
{
"type": "text",
"text": "Star Rangers"
},
{
"type": "date_time",
"date_time" : {
"fallback_value": "May 1st, 2019 8:45pm",
"day_of_month": 20,
"year": 2019,
"month": 9,
"hour": 20,
"minute": 45
}
},
{
"type": "text",
"text": "Carnival, Sangam"
},
{
"type": "text",
"text": "Silver"
},
{
"type": "text",
"text": "F6, F7, F8"
}
]
}
]
}
}
3. 您的客户收到他们的电影票消息。
电影票消息
机票示例
此示例会展示如何创建包含 PDF 文件的媒体消息模板。
1. 在您的商务管理平台中创建媒体消息模板。
商务管理平台消息模板创建流程
2. 在 messages API 调用中添加参数信息。
POST /v1/messages
{
"to": "your-test-recipient-wa-id",
"recipient_type": "individual",
"type": "template",
"template": {
"namespace": "88b39973_f0d5_54e1_29cf_e80f1e3da4f2",
"name": "flight_confirmation",
"language": {
"code": "en",
"policy": "deterministic"
},
"components": [
{
"type": "header",
"parameters": [
{
"type": "document",
"document": {
"filename": "MRRATH-CGK-KUL.pdf",
"link": "link-to-your-document"
}
}
]
},
{
"type": "body",
"parameters": [
{
"type": "text",
"text": "CGK (Jakarta)"
},
{
"type": "text",
"text": "KUL (Kuala Lumpur)"
},
{
"type": "date_time",
"date_time" : {
"fallback_value": "20th April 2019, 12:20pm",
"day_of_month": 20,
"year": 2019,
"month": 9,
"hour": 12,
"minute": 10
}
}
]
}
]
}
}
3. 您的客户收到 PDF 文件格式的登机牌。
机票消息