傳送媒體訊息範本
媒體訊息範本將可向收件者發送的內容擴展為不限標準訊息範本類型，以包含使用 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"
}]
}
不成功的回應則會包含一個錯誤物件，其中包含錯誤字串、錯誤代碼以及其他資訊。
如果將範本發送到無法接收該範本的帳號，系統會將 1026 (ReceiverIncapable) 錯誤以錯誤物件的方式發送到已設定的 Webhook 伺服器。
如需有關錯誤的詳細資訊，請參閱錯誤和狀態代碼。
範例
這些範例說明設定媒體訊息範本的程序，從在企業管理平台中建立範本開始，並透過 API 呼叫將訊息範本發送到 messages 端點。
這些範例僅供闡述說明，無法使用。您必須建立自己的範例並讓範例獲得核准，以測試媒體訊息範本功能。
電影票範例
此範例說明如何建立含有 QR 碼圖像的媒體訊息範本。
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 文件格式的登機證。
飛機票訊息