v2

latestOpenAPI 3.1.02026-08-01302833.9 KB
Unified Agent APIs

Unified Send Message

Unified messaging.

Send a message via SMS or WhatsApp. Default channel is 'auto', which sends via SMS. Set channel='whatsapp' to use WhatsApp explicitly.

WhatsApp opt-in requirement: WhatsApp Business API only delivers free-form messages to recipients who have messaged your Business number within the last 24 hours. Without prior opt-in, Meta accepts the API call and returns a message ID, but silently drops the message. SMS has no such restriction and delivers reliably.

post/v1/messages/send

Request body

tostring required
messagestring required
channelstring nullable
from_numberstring nullable

Response

Successful Response

{"stackTrail":"paths:/v1/messages/send:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}