Message with parameter and attachment Estimated reading: 3 minutes 79 views Description:Send a template message with dynamic text parameters and an image attachment in the header.Endpoint:http://{{your_domain}}/api/v1.0/{{phone_number_id}}/{{key}}/messagesReplace placeholders:{{key}}: Your API key for authentication.How to create key{{your_domain}}: Your domain URL where the API is hosted.{{phone_number_id}}: The unique identifier of the phone number used for sending messages.Example:{ "messaging_product": "whatsapp", "recipient_type": "individual", "to": "91xxxxxxxxxx", "type": "template", "template": { "name": "utility_variables_attachment", "language": { "code": "en" }, "components": [ { "type": "body", "parameters": [ { "type": "text", "text": "12345" } ] }, { "type": "header", "parameters": [ { "type": "image", "image": { "link": "https://chat.pingtochat.com/template_media/1736424548.png" } } ] } ] } }Field DescriptionsGeneral Fieldsmessaging_product: (string) Always whatsapp. recipient_type: (string) Set to individual for one-to-one messages. to: (string) The recipient’s phone number in E.164 format (e.g., 91xxxxxxxxxx). type: (string) Always template.Template Objectname: (string) The name of the pre-approved template (e.g., utility_variables_attachment). language: (object) Specifies the language for the template.code: (string) The language code (e.g., en for English).Components ArrayHeader:type: (string) Always header for attachments. parameters: (array) Holds the media or placeholders for the header.type: (string) Always image for images. image: (object) Contains the image details.link: (string) URL of the image (e.g., https://chat.pingtochat.com/template_media/1736424548.png). Body:type: (string) Always body for the main text content. parameters: (array) Holds the placeholders to populate the template.type: (string) Always text. text: (string) The value to replace placeholders (e.g.,"12345").ResponseA successful request will return an HTTP status code of 200 OK along with the following response structure:{ "messaging_product": "whatsapp", "contacts": [ { "input": "91xxxxxxxxxx", "wa_id": "91xxxxxxxxxx", "status_id": "NTg0MTc=" } ], "messages": [ { "id": "M2s4da2y4P", "message_status": "accepted" } ] } Field Descriptionsmessaging_product:Type: String Description: Indicates the messaging platform. Always returns whatsapp for messages sent via the WhatsApp Business API. contacts:Type: Array Description: Contains information about the message recipient(s). Fields:input:Type: String Description: The phone number input used in the API request (e.g., 91xxxxxxxxxx). wa_id:Type: String Description: The WhatsApp ID associated with the input phone number. status_id:Type: String Description: A unique identifier for the status of the message. messages:Type: Array Description: Contains details about the sent message. Fields:id:Type: String Description: A unique identifier for the message sent (e.g., M2s4da2y4P). message_status:Type: String Description: The status of the message at the time of the response. Example values include:accepted: The message was successfully accepted by the system. Sample codes CURL PHP Java Ruby Python C# Node JS curl –location ‘https://example.com/api/v1.0/phone_number_id/key/messages’ \ –header ‘authToken: xxxxxxxxxxxx…………….’ \ –header ‘Content-Type: application/json’ \ –header ‘Authorization: Bearer xxxxxxxxxxxx…………….’ \ –data ‘{ “messaging_product”: “whatsapp”, “recipient_type”: “individual”, “to”: “91xxxxxxxxxx”, “type”: “template”, “template”: { “name”: “utility_variables_attachment”, “language”: { “code”: “en” }, “components”: [ { “type”: “body”, “parameters”: [ { “type”: “text”, “text”: “12345” } ] }, { “type”: “header”, “parameters”: [ { “type”: “image”, “image”: { “link”: “https://chat.pingtochat.com/template_media/1736424548.png” } } ] } ] } } ‘ ‘<'+'?'+'php'+ ` $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => ‘https://example.com/api/v1.0/phone_number_id/key/messages’, CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => ”, CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => ‘POST’, CURLOPT_POSTFIELDS =>'{ “messaging_product”: “whatsapp”, “recipient_type”: “individual”, “to”: “91xxxxxxxxxx”, “type”: “template”, “template”: { “name”: “utility_variables_attachment”, “language”: { “code”: “en” }, “components”: [ { “type”: “body”, “parameters”: [ { “type”: “text”, “text”: “12345” } ] }, { “type”: “header”, “parameters”: [ { “type”: “image”, “image”: { “link”: “https://chat.pingtochat.com/template_media/1736424548.png” } } ] } ] } } ‘, CURLOPT_HTTPHEADER => array( ‘authToken: xxxxxxxxxxxx…………….’, ‘: ‘, ‘Content-Type: application/json’, ‘Authorization: Bearer xxxxxxxxxxxx…………….’ ), )); $response = curl_exec($curl); curl_close($curl); echo $response; ?>;`; OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse(“application/json”); RequestBody body = RequestBody.create(mediaType, “{\r\n \”messaging_product\”: \”whatsapp\”,\r\n \”recipient_type\”: \”individual\”,\r\n \”to\”: \”91xxxxxxxxxx\”,\r\n \”type\”: \”template\”,\r\n \”template\”: {\r\n \”name\”: \”utility_b\”,\r\n \”language\”: {\r\n \”code\”: \”en_us\”\r\n },\r\n \”components\”: [\r\n {\r\n \”type\”: \”body\”,\r\n \”parameters\”: [\r\n {\r\n \”type\”: \”text\”,\r\n \”text\”: \”12CR007\”\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n}\r\n”); Request request = new Request.Builder() .url(“https://example.com/api/v1.0/phone_number_id/key/messages”) .method(“POST”, body) .addHeader(“Content-Type”, “application/json”) .addHeader(“Authorization”, “Bearer xxxxxxx……….”) .build(); Response response = client.newCall(request).execute(); require “uri” require “json” require “net/http” url = URI(“https://example.com/api/v1.0/phone_number_id/key/messages”) https = Net::HTTP.new(url.host, url.port) https.use_ssl = true request = Net::HTTP::Post.new(url) request[“authToken”] = “xxxxxxxxxxxx…………….” request[“”] = “” request[“Content-Type”] = “application/json” request[“Authorization”] = “Bearer xxxxxxxxxxxx…………….” request.body = JSON.dump({ “messaging_product”: “whatsapp”, “recipient_type”: “individual”, “to”: “91xxxxxxxxxx”, “type”: “template”, “template”: { “name”: “utility_variables_attachment”, “language”: { “code”: “en” }, “components”: [ { “type”: “body”, “parameters”: [ { “type”: “text”, “text”: “12345” } ] }, { “type”: “header”, “parameters”: [ { “type”: “image”, “image”: { “link”: “https://chat.pingtochat.com/template_media/1736424548.png” } } ] } ] } }) response = https.request(request) puts response.read_body import requests import json url = “https://example.com/api/v1.0/phone_number_id/key/messages” payload = json.dumps({ “messaging_product”: “whatsapp”, “recipient_type”: “individual”, “to”: “91xxxxxxxxxx”, “type”: “template”, “template”: { “name”: “utility_variables_attachment”, “language”: { “code”: “en” }, “components”: [ { “type”: “body”, “parameters”: [ { “type”: “text”, “text”: “12345” } ] }, { “type”: “header”, “parameters”: [ { “type”: “image”, “image”: { “link”: “https://chat.pingtochat.com/template_media/1736424548.png” } } ] } ] } }) headers = { ‘authToken’: ‘xxxxxxxxxxxx…………….’, ”: ”, ‘Content-Type’: ‘application/json’, ‘Authorization’: ‘Bearer xxxxxxxxxxxx…………….’ } response = requests.request(“POST”, url, headers=headers, data=payload) print(response.text) var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, “https://example.com/api/v1.0/phone_number_id/key/messages”); request.Headers.Add(“authToken”, “xxxxxxxxxxxx…………….”); request.Headers.Add(“”, “”); request.Headers.Add(“Authorization”, “Bearer xxxxxxxxxxxx…………….”); var content = new StringContent(“{\r\n \”messaging_product\”: \”whatsapp\”,\r\n \”recipient_type\”: \”individual\”,\r\n \”to\”: \”91xxxxxxxxxx\”,\r\n \”type\”: \”template\”,\r\n \”template\”: {\r\n \”name\”: \”utility_variables_attachment\”,\r\n \”language\”: {\r\n \”code\”: \”en\”\r\n },\r\n \”components\”: [\r\n {\r\n \”type\”: \”body\”,\r\n \”parameters\”: [\r\n {\r\n \”type\”: \”text\”,\r\n \”text\”: \”12345\”\r\n }\r\n \r\n ]\r\n },\r\n {\r\n \”type\”: \”header\”,\r\n \”parameters\”: [\r\n {\r\n \”type\”: \”image\”,\r\n \”image\”: {\r\n \”link\”: \”https://chat.pingtochat.com/template_media/1736424548.png\”\r\n }\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n}\r\n”, null, “application/json”); request.Content = content; var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync()); var request = require(‘request’); var options = { ‘method’: ‘POST’, ‘url’: ‘https://example.com/api/v1.0/phone_number_id/key/messages’, ‘headers’: { ‘authToken’: ‘xxxxxxxxxxxx…………….’, ”: ”, ‘Content-Type’: ‘application/json’, ‘Authorization’: ‘Bearer xxxxxxxxxxxx…………….’ }, body: JSON.stringify({ “messaging_product”: “whatsapp”, “recipient_type”: “individual”, “to”: “91xxxxxxxxxx”, “type”: “template”, “template”: { “name”: “utility_variables_attachment”, “language”: { “code”: “en” }, “components”: [ { “type”: “body”, “parameters”: [ { “type”: “text”, “text”: “12345” } ] }, { “type”: “header”, “parameters”: [ { “type”: “image”, “image”: { “link”: “https://chat.pingtochat.com/template_media/1736424548.png” } } ] } ] } }) }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); });
