Send message with the WhatsApp API
Sends a message from a business phone number and returns its id in messages[0].id. Free-form types (text, image, video, document, audio) only reach someone who wrote to the number in the last 24 hours; to start a conversation, send type template with an approved template from List message templates. Meta bills messages to the account according to its WhatsApp pricing.
- Identifier
- whatsapp_send_message
The request
POST https://connect.reportei.com/api/tools/whatsapp_send_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"phone_number_id": "<phone_number_id>",
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "<recipient_number_with_country_code>",
"type": "text",
"text": {
"body": "Hello! This is an example message.",
"preview_url": false
}
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Illustrative example. Replace the tokens, connection UUID and destination values with your own. This page does not execute the request.
Before executing
- For type=text, include text.body. The recipient number must contain the country code and digits only. Use the connected business account's phone_number_id.
- Free-form text is for conversations within 24 hours of the user's message. To start a conversation outside that window, use type=template with an approved template, language and its required parameters.
- The returned ID identifies a message accepted by the API; it does not confirm delivery. Inspect api_error.body for provider HTTP errors.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | Yes | Id of the business phone number that sends, from List phone numbers. |
| messaging_product | string | Yes | Always whatsapp.Values: whatsapp |
| recipient_type | string | Yes | individual for a person, group for a WhatsApp group of the number.Values: individual, group |
| to | string | Yes | Phone number of the person with country code, digits only, for example 5511987654321, or the id of the group. |
| type | string | Yes | Kind of message. Send the object with the same name, such as text or template.Values: text, template, image, video, document, audio |
| text | object | Yes, if type=text | For type text. |
| template | object | Yes, if type=template | For type template. |
| image | object | Yes, if type=image | For type image: a JPEG or PNG at a public URL. |
| video | object | Yes, if type=video | For type video: an MP4 or 3GP at a public URL. |
| document | object | Yes, if type=document | For type document: a file at a public URL, such as a PDF. |
| audio | object | Yes, if type=audio | For type audio: an audio file at a public URL. |
Supported connections
Your customer connects their WhatsApp account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Illustrative success format
{
"messaging_product": "whatsapp",
"messages": [
{
"id": "wamid.EXAMPLE"
}
]
}The content below is an example, not a recorded execution. Save X-Toolkit-Execution-Id when returned to look up the execution. Connect provides no retries or idempotency: repeating a POST may send the message again.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/whatsapp_send_message. It becomes your agent's tool definition with no conversion.
Other WhatsApp tools
- List business accountsGETLists the WhatsApp Business accounts the system user can reach, with id and name. That id is the waba_id of the other tools, which Meta now also calls the Messaging account id. The response has data and paging.cursors.after: pass it as after to read the next page.
- Get business accountGETReturns a WhatsApp Business account with the fields asked for, which can be account data or analytics. Without fields only id and name come back.
- List phone numbersGETLists the business phone numbers of a WhatsApp Business account with id, display_phone_number, verified_name and quality_rating. That id is the phone_number_id of the message and profile tools. The response has data and paging.cursors.after: pass it as after to read the next page.
- List message templatesGETLists the message templates of a WhatsApp Business account with id, name, language, status, category and components. The response has data and paging.cursors.after: pass it as after to read the next page.
- Create message templatePOSTCreates a message template and submits it to Meta review, returning id, status and category. It can be sent once the status is APPROVED, which can take up to 24 hours. Variables are {{1}}, {{2}} in the POSITIONAL format or {{first_name}} in the NAMED format, and each one needs an example. An image, video or document header needs a file handle from an upload, which this connection does not do.
- Update message templatePOSTEdits a template and sends it to review again. Only templates in APPROVED, REJECTED or PAUSED status can be edited, and only their category and components; components replaces all the parts. An approved template takes up to 10 edits in 30 days and 1 in 24 hours, and its category cannot change.
- Delete message templateDELETEDeletes a template by name, in all its languages, or only the language version whose id is hsm_id. The name of a deleted approved template cannot be used again for 30 days.
- Get business profileGETReturns the business profile people see on a phone number: about, address, description, email, websites, vertical and profile_picture_url.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
