傳送媒體訊息範本
媒體訊息範本讓您可向傳送對象傳送更多內容；您將可向他們傳送標準訊息範本類型之外的內容，其中包括使用 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"
}]
}
不成功的回應會包含錯誤物件，當中含有錯誤字串、錯誤代碼和其他資訊。
如果您向無法接收範本的帳戶傳送範本，則系統會向已配置 Webhook 伺服器的錯誤物件傳送 1026 (ReceiverIncapable) 錯誤。
如需更多有關錯誤的資訊，請參閱錯誤和狀態代碼。
範例
這些範例將會示範設定媒體訊息範本的過程，包括在企業管理平台建立範本，以及使用 API 呼叫向 messages 端點傳送訊息範本。
這些範例僅用於舉例說明，實際上不可使用。您必須建立自己的範例並讓範例通過相關審查，以便測試媒體訊息範本的功能。
電影門票範例
此範例會示範如何建立含有 QR Code 圖像的媒體訊息範本。
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 文件形式的登機證。
機票訊息