WhatsApp API

WhatsApp endpoints exposed by the Devotel CPaaS API Base path: /api/v1/whatsapp Endpoint count: 5

Get conversational-automation config

GET /api/v1/whatsapp/conversational-automation

Read the WhatsApp conversational-automation configuration for the organization’s default connection — the ice breakers, slash commands, and welcome-message toggle shown when a customer first opens the chat. Mirrors WhatsApp’s conversational_automation settings for the phone number.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

Test-account analytics KPIs

GET /api/v1/whatsapp/test-account/analytics

Pre-aggregated KPI counts plus a 30-day daily-volume series for the test-account analytics card, scoped to the tenant’s OTP-verified recipient. Read-only aggregate — no provider or billing side-effect.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/test-account/analytics" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/test-account/analytics', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/test-account/analytics", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/test-account/analytics", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/test-account/analytics')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/test-account/analytics');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

Send WhatsApp marketing message

POST /api/v1/whatsapp/marketing-messages/send

Send a MARKETING-category template via Meta’s Marketing Messages API (MM Lite) for send-time/creative optimization. Reuses the tenant’s connected WABA token. tracking_id correlates status webhooks back to a campaign/journey.

string

required

Recipient E.164 phone number.

string

required

Approved marketing template name.

string

required

Template language code (e.g. en_US).

object[]

Meta template components (header/body/buttons).

string

Echoed on status webhooks for campaign/CTR correlation.

string

Optional WABA selector for multi-WABA tenants.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/marketing-messages/send" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "string",
  "template_name": "string",
  "language_code": "string"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/marketing-messages/send', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "to": "string",
  "template_name": "string",
  "language_code": "string"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/whatsapp/marketing-messages/send", headers=headers, json={
  "to": "string",
  "template_name": "string",
  "language_code": "string"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/whatsapp/marketing-messages/send", bytes.NewBuffer([]byte(`{
  "to": "string",
  "template_name": "string",
  "language_code": "string"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/marketing-messages/send')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "to": "string",
  "template_name": "string",
  "language_code": "string"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/marketing-messages/send');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "to": "string",
  "template_name": "string",
  "language_code": "string"
}
JSON);
echo curl_exec($ch);

Send WhatsApp interactive message

POST /api/v1/whatsapp/messages/send-interactive

Send an interactive WhatsApp message (reply-buttons or list-menu) inside the 24h customer-service window — no template review required. The recipient’s tap returns as button_reply/list_reply on the inbound webhook. action is either (max 3 reply buttons) or (list menu, max 10 sections × 10 rows).

string

required

Recipient E.164 phone number OR WhatsApp Business Solution UID.

string

Optional short header text (max 60 chars).

string

required

Message body text (1-1024 chars).

string

Optional footer text (max 60 chars).

object

required

Reply-buttons () OR list-menu ().

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-interactive" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "string",
  "body": "string",
  "action": {}
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-interactive', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "to": "string",
  "body": "string",
  "action": {}
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-interactive", headers=headers, json={
  "to": "string",
  "body": "string",
  "action": {}
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-interactive", bytes.NewBuffer([]byte(`{
  "to": "string",
  "body": "string",
  "action": {}
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-interactive')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "to": "string",
  "body": "string",
  "action": {}
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-interactive');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "to": "string",
  "body": "string",
  "action": {}
}
JSON);
echo curl_exec($ch);

Update conversational-automation config

PUT /api/v1/whatsapp/conversational-automation

Replace the WhatsApp conversational-automation configuration for the organization’s default connection. WhatsApp replaces each field present on the write, so send the complete desired state — the welcome-message flag plus all ice breakers and commands — to avoid clearing a sibling field. Restricted to owners and admins.

boolean

Toggle WhatsApp’s automatic welcome message on first open.

string[]

Ice breakers — up to four tappable prompts shown when a customer first opens the chat.

object[]

Slash commands surfaced in the chat command menu (up to 30).

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.put("https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("PUT", "https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation')
req = Net::HTTP::Put.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

API Reference

All Endpoints

WhatsApp API

WhatsApp API

Get conversational-automation config

Test-account analytics KPIs

Send WhatsApp marketing message

Send WhatsApp interactive message

Update conversational-automation config

​WhatsApp API

​Get conversational-automation config

​Test-account analytics KPIs

​Send WhatsApp marketing message

​Send WhatsApp interactive message

​Update conversational-automation config

WhatsApp API

Get conversational-automation config

Test-account analytics KPIs

Send WhatsApp marketing message

Send WhatsApp interactive message

Update conversational-automation config