WhatsApp templates
Queue an approved WhatsApp template
Requires whatsapp_templates:send. The response acknowledges queued work, not delivery.
POST
/
whatsapp-templates
/
{channelId}
/
send
Queue an approved WhatsApp template
curl --request POST \
--url https://platform-api.visitoai.com/m2m/v1/whatsapp-templates/{channelId}/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"to": "<string>",
"template": {
"name": "<string>",
"language": {
"code": "<string>"
},
"components": [
{}
]
}
}
'import requests
url = "https://platform-api.visitoai.com/m2m/v1/whatsapp-templates/{channelId}/send"
payload = {
"to": "<string>",
"template": {
"name": "<string>",
"language": { "code": "<string>" },
"components": [{}]
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
to: '<string>',
template: {name: '<string>', language: {code: '<string>'}, components: [{}]}
})
};
fetch('https://platform-api.visitoai.com/m2m/v1/whatsapp-templates/{channelId}/send', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform-api.visitoai.com/m2m/v1/whatsapp-templates/{channelId}/send",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'to' => '<string>',
'template' => [
'name' => '<string>',
'language' => [
'code' => '<string>'
],
'components' => [
[
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform-api.visitoai.com/m2m/v1/whatsapp-templates/{channelId}/send"
payload := strings.NewReader("{\n \"to\": \"<string>\",\n \"template\": {\n \"name\": \"<string>\",\n \"language\": {\n \"code\": \"<string>\"\n },\n \"components\": [\n {}\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform-api.visitoai.com/m2m/v1/whatsapp-templates/{channelId}/send")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": \"<string>\",\n \"template\": {\n \"name\": \"<string>\",\n \"language\": {\n \"code\": \"<string>\"\n },\n \"components\": [\n {}\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.visitoai.com/m2m/v1/whatsapp-templates/{channelId}/send")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": \"<string>\",\n \"template\": {\n \"name\": \"<string>\",\n \"language\": {\n \"code\": \"<string>\"\n },\n \"components\": [\n {}\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"accepted": true,
"replyId": "<string>",
"conversationId": "<string>",
"requestEventId": "<string>",
"correlationId": "<string>",
"status": "queued",
"acceptedAt": "2023-11-07T05:31:56Z",
"conversationKey": "<string>"
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}Authorizations
Server-side tenant-scoped credential created from Build > API Keys.
Headers
Stable key for one intended outbound operation. Reuse it only with an identical request.
Minimum string length:
1Path Parameters
Body
application/json
Response
Template send accepted and queued
⌘I
Queue an approved WhatsApp template
curl --request POST \
--url https://platform-api.visitoai.com/m2m/v1/whatsapp-templates/{channelId}/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"to": "<string>",
"template": {
"name": "<string>",
"language": {
"code": "<string>"
},
"components": [
{}
]
}
}
'import requests
url = "https://platform-api.visitoai.com/m2m/v1/whatsapp-templates/{channelId}/send"
payload = {
"to": "<string>",
"template": {
"name": "<string>",
"language": { "code": "<string>" },
"components": [{}]
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
to: '<string>',
template: {name: '<string>', language: {code: '<string>'}, components: [{}]}
})
};
fetch('https://platform-api.visitoai.com/m2m/v1/whatsapp-templates/{channelId}/send', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform-api.visitoai.com/m2m/v1/whatsapp-templates/{channelId}/send",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'to' => '<string>',
'template' => [
'name' => '<string>',
'language' => [
'code' => '<string>'
],
'components' => [
[
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform-api.visitoai.com/m2m/v1/whatsapp-templates/{channelId}/send"
payload := strings.NewReader("{\n \"to\": \"<string>\",\n \"template\": {\n \"name\": \"<string>\",\n \"language\": {\n \"code\": \"<string>\"\n },\n \"components\": [\n {}\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform-api.visitoai.com/m2m/v1/whatsapp-templates/{channelId}/send")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": \"<string>\",\n \"template\": {\n \"name\": \"<string>\",\n \"language\": {\n \"code\": \"<string>\"\n },\n \"components\": [\n {}\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.visitoai.com/m2m/v1/whatsapp-templates/{channelId}/send")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": \"<string>\",\n \"template\": {\n \"name\": \"<string>\",\n \"language\": {\n \"code\": \"<string>\"\n },\n \"components\": [\n {}\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"accepted": true,
"replyId": "<string>",
"conversationId": "<string>",
"requestEventId": "<string>",
"correlationId": "<string>",
"status": "queued",
"acceptedAt": "2023-11-07T05:31:56Z",
"conversationKey": "<string>"
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}