Send Message

POST

/wab

const url = 'https://api.contacta.mx/wab';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <credentials>', 'Content-Type': 'application/json'},
  body: '{"type":"template","agent":"5215589427963","number":"525510101234","templateName":"ejemplo_nota_1","language":"es","templateData":{"body":{"placeholders":["2024-01-01","John Doe","My Business","$ 1500"]},"header":{"type":"DOCUMENT","mediaUrl":"https://www.buildquickbots.com/whatsapp/media/sample/pdf/sample01.pdf","filename":"document.pdf"}}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.contacta.mx/wab \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "type": "template", "agent": "5215589427963", "number": "525510101234", "templateName": "ejemplo_nota_1", "language": "es", "templateData": { "body": { "placeholders": [ "2024-01-01", "John Doe", "My Business", "$ 1500" ] }, "header": { "type": "DOCUMENT", "mediaUrl": "https://www.buildquickbots.com/whatsapp/media/sample/pdf/sample01.pdf", "filename": "document.pdf" } } }'

Sends a WhatsApp message to a recipient number through the specified agent.

The type field in the request body determines the message variant. See the request body examples for all supported types.

Authorizations

BasicAuth

Request Body^required

Message payload. The type field determines which additional fields are required.

`type`	Required fields
`template`	`templateName`, `templateData`, `language`
`text`	`message`
`image`	`url` — `caption` optional
`file`	`url`, `filename`
`audio`	`url`
`video`	`url`
`location`	`longitude`, `latitude` — `name`, `address` optional
`sticker`	`url`
`contacts`	`contact`

application/json

One of: discriminator: type

Template

Send a pre-approved WhatsApp template message.

Templates must be approved by Meta before use. Use templateData to fill in the dynamic placeholders defined in your template.

object

agent

required

WhatsApp Business phone number of the sending agent (E.164 without +)

string

number

required

Destination WhatsApp phone number (E.164 without +)

string

type

required

Message type — determines which additional fields are required

string

Allowed values: template text image file audio video location sticker contacts

type

required

string

Allowed values: template

language

required

Template language code

string

Allowed values: en es fr de it pt

templateName

required

Exact name of the approved template

string

templateData

required

object

body

object

placeholders

Values to fill in the body {{1}}, {{2}}, … variables in order

Array<string>

header

Required when the template header contains a media or document component

object

type

Header media type

string

Allowed values: IMAGE VIDEO DOCUMENT

mediaUrl

Publicly accessible URL of the header media

string format: uri

filename

File name displayed to the recipient (required when type is DOCUMENT)

string

placeholders

Values for header text variables (max 1 item for text headers)

Array<string>

<= 1 items

Text

Send a plain text message.

object

agent

required

WhatsApp Business phone number of the sending agent (E.164 without +)

string

number

required

Destination WhatsApp phone number (E.164 without +)

string

type

required

Message type — determines which additional fields are required

string

Allowed values: template text image file audio video location sticker contacts

type

required

string

Allowed values: text

message

required

Text content of the message

string

Image

Send an image with an optional caption.

object

agent

required

WhatsApp Business phone number of the sending agent (E.164 without +)

string

number

required

Destination WhatsApp phone number (E.164 without +)

string

type

required

Message type — determines which additional fields are required

string

Allowed values: template text image file audio video location sticker contacts

type

required

string

Allowed values: image

url

required

Publicly accessible URL of the image (JPG, PNG, WebP)

string format: uri

caption

Optional caption displayed below the image

string

File

Send a document or file attachment (PDF, DOCX, etc.).

object

agent

required

WhatsApp Business phone number of the sending agent (E.164 without +)

string

number

required

Destination WhatsApp phone number (E.164 without +)

string

type

required

Message type — determines which additional fields are required

string

Allowed values: template text image file audio video location sticker contacts

type

required

string

Allowed values: file

url

required

Publicly accessible URL of the file

string format: uri

filename

required

File name displayed to the recipient

string

Audio

Send an audio file (MP3, OGG, etc.).

object

agent

required

WhatsApp Business phone number of the sending agent (E.164 without +)

string

number

required

Destination WhatsApp phone number (E.164 without +)

string

type

required

Message type — determines which additional fields are required

string

Allowed values: template text image file audio video location sticker contacts

type

required

string

Allowed values: audio

url

required

Publicly accessible URL of the audio file

string format: uri

Video

Send a video file (MP4).

object

agent

required

WhatsApp Business phone number of the sending agent (E.164 without +)

string

number

required

Destination WhatsApp phone number (E.164 without +)

string

type

required

Message type — determines which additional fields are required

string

Allowed values: template text image file audio video location sticker contacts

type

required

string

Allowed values: video

url

required

Publicly accessible URL of the video file (MP4)

string format: uri

Location

Send a location pin with name and address.

object

agent

required

WhatsApp Business phone number of the sending agent (E.164 without +)

string

number

required

Destination WhatsApp phone number (E.164 without +)

string

type

required

Message type — determines which additional fields are required

string

Allowed values: template text image file audio video location sticker contacts

type

required

string

Allowed values: location

longitude

required

Longitude coordinate

number format: float

latitude

required

Latitude coordinate

number format: float

name

Location name displayed to the recipient

string

address

Address displayed below the location name

string

Sticker

Send a sticker (WebP format).

object

agent

required

WhatsApp Business phone number of the sending agent (E.164 without +)

string

number

required

Destination WhatsApp phone number (E.164 without +)

string

type

required

Message type — determines which additional fields are required

string

Allowed values: template text image file audio video location sticker contacts

type

required

string

Allowed values: sticker

url

required

Publicly accessible URL of the sticker file (WebP)

string format: uri

Contacts

Send a contact card with name, phones, emails, addresses, and more.

object

agent

required

WhatsApp Business phone number of the sending agent (E.164 without +)

string

number

required

Destination WhatsApp phone number (E.164 without +)

string

type

required

Message type — determines which additional fields are required

string

Allowed values: template text image file audio video location sticker contacts

type

required

string

Allowed values: contacts

contact

required

object

name

required

object

first_name

string

last_name

string

formatted_name

required

Full display name shown on the contact card

string

phones

Array<object>

object

phone

string

type

string

Allowed values: HOME WORK CELL MAIN IPHONE OTHER

wa_id

WhatsApp ID if this phone is registered on WhatsApp

string

emails

Array<object>

object

email

string format: email

type

string

Allowed values: HOME WORK OTHER

addresses

Array<object>

object

street

string

city

string

state

string

zip

string

country

string

country_code

string

type

string

Allowed values: HOME WORK OTHER

birthday

Birthday in YYYY-MM-DD format

string format: date

org

object

company

string

department

string

title

string

urls

Array<object>

object

url

string format: uri

type

string

Allowed values: HOME WORK OTHER

Examples

Template with document header

{
  "type": "template",
  "agent": "5215589427963",
  "number": "525510101234",
  "templateName": "ejemplo_nota_1",
  "language": "es",
  "templateData": {
    "body": {
      "placeholders": [
        "2024-01-01",
        "John Doe",
        "My Business",
        "$ 1500"
      ]
    },
    "header": {
      "type": "DOCUMENT",
      "mediaUrl": "https://www.buildquickbots.com/whatsapp/media/sample/pdf/sample01.pdf",
      "filename": "document.pdf"
    }
  }
}

Text message

{
  "type": "text",
  "agent": "5215628341366",
  "number": "525510101234",
  "message": "Hola, este es un mensaje de prueba."
}

Image with caption

{
  "type": "image",
  "agent": "5215628341366",
  "number": "525510101234",
  "url": "https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg",
  "caption": "Sample image"
}

PDF file

{
  "type": "file",
  "agent": "5215628341366",
  "number": "525510101234",
  "url": "https://www.buildquickbots.com/whatsapp/media/sample/pdf/sample01.pdf",
  "filename": "sample01.pdf"
}

Audio file

{
  "type": "audio",
  "agent": "5215628341366",
  "number": "525510101234",
  "url": "https://www.buildquickbots.com/whatsapp/media/sample/audio/sample02.mp3"
}

Video file

{
  "type": "video",
  "agent": "5215628341366",
  "number": "525510101234",
  "url": "https://www.buildquickbots.com/whatsapp/media/sample/video/sample01.mp4"
}

Location pin

{
  "type": "location",
  "agent": "5215628341366",
  "number": "525510101234",
  "longitude": 72.877655,
  "latitude": 19.075983,
  "name": "Mumbai",
  "address": "Mumbai, Maharashtra"
}

Sticker

{
  "type": "sticker",
  "agent": "5215628341366",
  "number": "525510101234",
  "url": "http://www.buildquickbots.com/whatsapp/stickers/SampleSticker01.webp"
}

Contact card

{
  "type": "contacts",
  "agent": "5215628341366",
  "number": "525510101234",
  "contact": {
    "name": {
      "first_name": "John",
      "last_name": "Wick",
      "formatted_name": "John Wick"
    },
    "phones": [
      {
        "phone": "+1 (650) 555-1234",
        "type": "WORK",
        "wa_id": "16505551234"
      }
    ],
    "emails": [
      {
        "email": "john@example.com",
        "type": "WORK"
      }
    ],
    "org": {
      "company": "Acme Corp",
      "title": "Manager"
    }
  }
}

Responses

200

Message successfully enqueued

application/json

object

error

boolean

code

integer

message

string

Example

{
  "error": false,
  "code": 200,
  "message": "Message enqueued successfully"
}

304

Agent field must be specified

application/json

object

error

boolean

code

HTTP-style error code returned by the API

integer

message

Human-readable error description

string

Example

{
  "error": true,
  "code": 304,
  "message": "Agent field must be specified to send WAB message"
}

305

Number field must be specified

application/json

object

error

boolean

code

HTTP-style error code returned by the API

integer

message

Human-readable error description

string

Example

{
  "error": true,
  "code": 305,
  "message": "Number field must be specified to send WAB message"
}

306

Phone number must be in E.164 format

application/json

object

error

boolean

code

HTTP-style error code returned by the API

integer

message

Human-readable error description

string

Example

{
  "error": true,
  "code": 306,
  "message": "Please use number in E.164 format"
}

307

Type field must be specified

application/json

object

error

boolean

code

HTTP-style error code returned by the API

integer

message

Human-readable error description

string

Example

{
  "error": true,
  "code": 307,
  "message": "Type field must be specified to send WAB message"
}

400

Agent or user are invalid

application/json

object

error

boolean

code

HTTP-style error code returned by the API

integer

message

Human-readable error description

string

Example

{
  "error": true,
  "code": 400,
  "message": "Agent or User are invalid"
}

404

WhatsApp agent not found or invalid

application/json

object

error

boolean

code

HTTP-style error code returned by the API

integer

message

Human-readable error description

string

Example

{
  "error": true,
  "code": 404,
  "message": "Whatsapp agent isn't valid or not found"
}

500

Internal error enqueuing message

application/json

object

error

boolean

code

HTTP-style error code returned by the API

integer

message

Human-readable error description

string

Example

{
  "error": true,
  "code": 500,
  "message": "Error enqueuing message"
}

Send Message

Authorizations

Request Bodyrequired

Examples

Responses

200

Example

304

Example

305

Example

306

Example

307

Example

400

Example

404

Example

500

Example

Request Body^required