Send-Message

http://whatsapp.local

POST

/messages

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://whatsapp.local/messages' \
--header 'Content-Type: application/json' \
--data-raw '{
    "recipient_type": "individual",
    "text": {
        "body": "<Message Text>"
    },
    "to": "{{Recipient-WA-ID}}",
    "type": "text"
}'

Response Example

{
    "messages": [
        {
            "id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
        }
    ]
}

Request

Body Params application/json

audio

Audio

optional

The media object containing audio

One of

AudioById

AudioByProvider

Example:

{"id":"<Media Id, from Media API>"}

string

required

contacts

array[object (Contact) {8}]

optional

addresses

array[object (Address) {7}]

optional

Full contact address(es)

birthday

string

optional

YYYY-MM-DD formatted string

emails

array[object (Email) {2}]

optional

Contact email address(es)

ims

array[string]

optional

name

object (Name)

optional

Full contact name

Example:

{"first_name":"John","formatted_name":"John Smith","last_name":"Smith"}

org

object (Org)

optional

Contact organization information

Example:

{"company":"WhatsApp","department":"Design","title":"Manager"}

phones

array[object (Phone) {3}]

optional

Contact phone number(s)

urls

array[object (Root Type for Url) {2}]

optional

Contact URL(s)

document

Document

optional

The media object containing a document

One of

Document

Document1

Example:

{"caption":"<Message Caption>","filename":"<Filename>","id":"<Media Id, from Media API>"}

caption

string

required

filename

string

required

string

required

hsm

object (Hsm)

optional

The containing element for the message content — Indicates that the message is highly structured. Parameters contained within provide the structure.

Example:

{"element_name":"hello_world","language":{"code":"en","policy":"deterministic"},"localizable_params":[{"default":"1234"}],"namespace":"business_a_namespace"}

element_name

string

required

The element name that indicates which template to use within the namespace

language

object (Language)

required

Example:

{"code":"en","policy":"deterministic"}

localizable_params

array[object (LocalizableParam) {3}]

required

This field is an array of values to apply to variables in the template

namespace

string

required

The namespace that will be used

image

Image

optional

The media object containing an image

One of

ImageById

ImageByProvider

Example:

{"caption":"<Message Caption>","id":"<Media Id, from Media API>"}

caption

string

required

string

required

location

object (Location)

optional

Example:

{"address":"<Location's Address>","latitude":"<Latitude>","longitude":"<Longitude>","name":"<Location Name>"}

address

string

required

Address of the location. Only displayed if name is present.

latitude

string

required

Latitude of the location

longitude

string

required

Longitude of the location

name

string

required

Name of the location

preview_url

boolean

optional

Specifying preview_url in the request is optional when not including a URL in your message.
To include a URL preview, set preview_url to true in the message body and make sure the URL begins with http:// or https://. For more information, see the Sending URLs in Text Messages section.

recipient_type

enum<string>

optional

Determines whether the recipient is an individual or a group
Specifying recipient_type in the request is optional when the value is individual.
However, recipient_type is required when using group. If sending a text message to a group, see the Sending Group Messages documentation.

Allowed values:

individualgroup

Default:

individual

text

object (Text)

optional

Example:

{"body":"<Message Text>"}

body

string

required

string

required

When recipient_type is individual, this field is the WhatsApp ID (phone number) returned from contacts endpoint. When recipient_type is group, this field is the WhatsApp group ID.

ttl

object

optional

type

enum<string>

optional

type of the message

Allowed values:

audiocontactsdocumenthsmimagelocationtextvideovoiceunknown

Default:

text

video

Video

optional

The media object containing a video

One of

VideoById

ByProvider

Example:

{"caption":"<Message Caption>","id":"<Media Id, from Media API>"}

caption

string

required

string

required

Examples

Responses

🟢200Success

application/json

Body

errors

array[object (Error) {4}]

optional

Only returned with a failed request. Contains an array of error objects that are present when there is an error.

code

integer <int32>

optional

See the https://developers.facebook.com/docs/whatsapp/api/errors for more information.

details

string

optional

error detail

href

string

optional

location for error detail

title

string

optional

error title