Skip to content

MCP Tools Reference

Send a WhatsApp template message to a contact.

ParameterTypeRequiredDescription
api_keystringYesTenant API key
phonestringYesPhone number (E.164)
template_namestringYesApproved template name
paramsobjectNoTemplate parameter values ({"1": "value"})
language_codestringNoLanguage code (default: en)

Example:

send_template(
api_key="sk-xxx",
phone="+1234567890",
template_name="order_shipped",
params={"1": "John", "2": "ORD-123"}
)

Send a plain text message via any channel.

ParameterTypeRequiredDescription
api_keystringYesTenant API key
phonestringYesPhone number (E.164)
textstringYesMessage text
channelstringNoWHATSAPP, TELEGRAM, SMS, RCS (default: WHATSAPP)

Send an RCS message with optional quick-reply suggestions. Automatically falls back to SMS if RCS delivery fails.

ParameterTypeRequiredDescription
api_keystringYesTenant API key
phonestringYesPhone number (E.164)
textstringYesMessage text
suggestionsarrayNoQuick-reply suggestions ([{"type": "reply", "text": "Yes"}])

Get the delivery status of a WhatsApp message.

ParameterTypeRequiredDescription
api_keystringYesTenant API key
message_idstringYesMessage UUID

Returns: Status (PENDING, SENT, DELIVERED, READ, FAILED), timestamps.


List WhatsApp message templates.

ParameterTypeRequiredDescription
api_keystringYesTenant API key
statusstringNoFilter by status (APPROVED, PENDING, etc.)

Search contacts by phone number, name, or tag.

ParameterTypeRequiredDescription
api_keystringYesTenant API key
querystringNoSearch term (phone, name)
tagstringNoFilter by tag name
limitintegerNoMax results (default: 10)

Create a new contact.

ParameterTypeRequiredDescription
api_keystringYesTenant API key
phonestringYesPhone number (E.164)
first_namestringYesFirst name
last_namestringNoLast name
tagstringNoTag name

Update an existing contact by phone number.

ParameterTypeRequiredDescription
api_keystringYesTenant API key
phonestringYesPhone number (E.164)
first_namestringNoUpdated first name
last_namestringNoUpdated last name
tagstringNoUpdated tag

Create and send a broadcast campaign.

ParameterTypeRequiredDescription
api_keystringYesTenant API key
namestringYesCampaign name
template_namestringYesTemplate to use
phone_numbersarrayYesList of recipient phones
language_codestringNoLanguage code
channelstringNoWHATSAPP, TELEGRAM, SMS

Get delivery statistics for a broadcast.

ParameterTypeRequiredDescription
api_keystringYesTenant API key
broadcast_idstringYesBroadcast UUID

Returns: Status, sent/delivered/failed counts, recipient details.


List broadcast campaigns.

ParameterTypeRequiredDescription
api_keystringYesTenant API key
statusstringNoFilter by status
limitintegerNoMax results

List configured WhatsApp Business Solution Providers.

ParameterTypeRequiredDescription
api_keystringYesTenant API key

Returns: List of BSPs with names and active status.


Check BSP delivery health over the last 24 hours.

ParameterTypeRequiredDescription
api_keystringYesTenant API key

Returns: Delivery rate, success/failure counts, average latency per provider.


Switch the active BSP for WhatsApp messaging.

ParameterTypeRequiredDescription
api_keystringYesTenant API key
bspstringYesBSP identifier (META, GUPSHUP)

Returns: Confirmation of provider switch.