WhatsApp Send Messages

Send a WhatsApp message

post

Body

tostringRequiredExample: 1234567890

typestring · enumRequiredExample: textPossible values:

Responses

200

Message sent successfully

No content

400

Bad request

post

/api/whatsapp/send-message

POST /api/whatsapp/send-message HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1350

{
  "to": "1234567890",
  "type": "text",
  "text": {
    "preview_url": false,
    "body": "Hello, World!"
  },
  "reaction": {
    "message_id": "wamid.HBgLM...",
    "emoji": "\\uD83D\\uDE00"
  },
  "image": {
    "id": "MEDIA-OBJECT-ID"
  },
  "location": {
    "longitude": -122.4194,
    "latitude": 37.7749,
    "name": "San Francisco",
    "address": "123 Main St, San Francisco, CA"
  },
  "contacts": [
    {
      "addresses": [
        {
          "street": "STREET",
          "city": "CITY",
          "state": "STATE",
          "zip": "ZIP",
          "country": "COUNTRY",
          "country_code": "COUNTRY_CODE",
          "type": "HOME"
        }
      ],
      "birthday": "YEAR_MONTH_DAY",
      "emails": [
        {
          "email": "EMAIL",
          "type": "WORK"
        }
      ],
      "name": {
        "formatted_name": "NAME",
        "first_name": "FIRST_NAME",
        "last_name": "LAST_NAME",
        "middle_name": "MIDDLE_NAME",
        "suffix": "SUFFIX",
        "prefix": "PREFIX"
      },
      "org": {
        "company": "COMPANY",
        "department": "DEPARTMENT",
        "title": "TITLE"
      },
      "phones": [
        {
          "phone": "PHONE_NUMBER",
          "type": "HOME",
          "wa_id": "PHONE_OR_WA_ID"
        }
      ],
      "urls": [
        {
          "url": "URL",
          "type": "WORK"
        }
      ]
    }
  ],
  "interactive": {
    "type": "button",
    "body": {
      "text": "optional body text"
    },
    "footer": {
      "text": "optional footer text"
    },
    "action": {
      "catalog_id": "CATALOG_ID",
      "product_retailer_id": "ID_TEST_ITEM_1",
      "sections": [
        {
          "title": "Section Title",
          "rows": [
            {
              "id": "section-1-item-1",
              "title": "Section Item Title",
              "description": "Section Item Description"
            }
          ]
        }
      ]
    }
  },
  "template": {
    "name": "template_name",
    "language": {
      "code": "language_code"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "parameter_value"
          }
        ]
      }
    ]
  }
}

No content

Send a WhatsApp template message

post

Body

template_idstringRequiredExample: 1191689335202610

tostringRequiredExample: {{Recipient-Phone-Number}}

Responses

200

Template message sent successfully

No content

400

Bad request

500

Internal server error

post

/api/whatsapp/send-template-message

POST /api/whatsapp/send-template-message HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 219

{
  "template_id": "1191689335202610",
  "to": "{{Recipient-Phone-Number}}",
  "components": [
    {
      "type": "body",
      "parameters": [
        {
          "type": "text",
          "text": "Hello",
          "currency": {
            "fallback_value": "$100.99",
            "code": "USD",
            "amount_1000": 100990
          }
        }
      ]
    }
  ]
}

No content

Send a WhatsApp text message

post

Sends a WhatsApp text message to a specified recipient.

Body

fromstringOptional

The ID of the WhatsApp phone number

Example: 108427225641466

tostringOptional

The recipient's WhatsApp phone number

Example: +1234567890

Responses

200

Text Message Sent Successfully

application/json

401

Unauthorized

application/json

422

Validation Error(s)

application/json

post

/api/whatsapp/send-text-message

POST /api/whatsapp/send-text-message HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "from": "108427225641466",
  "to": "+1234567890",
  "text": {
    "body": "Hey, it's me",
    "preview_url": true
  }
}

{
  "success": true,
  "message": "Text Message Sent Successfully",
  "data": {
    "id": "wamid.HBgMMjAxMTI2MjIwODA2FQIAERgSQ0U3MzEyQTQyMUY0OTRGMjVEAA==",
    "whatsapp_phone_number_id": 108427225641466,
    "sender_type": "App\\\\Models\\\\WhatsappPhoneNumber",
    "sender_id": 108427225641466,
    "recipient_type": "App\\\\Models\\\\WhatsappConsumerPhoneNumber",
    "recipient_id": 1,
    "sender_role": "BUSINESS",
    "type": "text",
    "direction": "SENT",
    "status": "initiated",
    "whatsapp_conversation_id": "text",
    "created_at": "2024-09-25T14:26:02.000000Z",
    "updated_at": "2024-09-25T14:26:02.000000Z",
    "messageable_id": 15,
    "messageable_type": "App\\\\Models\\\\WhatsappTextMessage",
    "statuses": [
      {
        "id": 11,
        "whatsapp_message_id": "wamid.HBgMMjAxMTI2MjIwODA2FQIAERgSQ0U3MzEyQTQyMUY0OTRGMjVEAA==",
        "status": "initiated",
        "timestamp": 1727274362,
        "created_at": "2024-09-25T14:26:02.000000Z",
        "updated_at": "2024-09-25T14:26:02.000000Z"
      }
    ],
    "messageable": {
      "id": 15,
      "whatsapp_message_id": "wamid.HBgMMjAxMTI2MjIwODA2FQIAERgSQ0U3MzEyQTQyMUY0OTRGMjVEAA==",
      "body": "Hey, it's me",
      "preview_url": null,
      "created_at": "2024-09-25T14:26:02.000000Z",
      "updated_at": "2024-09-25T14:26:02.000000Z"
    }
  }
}

Send a WhatsApp image message

post

Sends an image message to a specified WhatsApp recipient.

Body

fromstringOptional

The ID of the WhatsApp phone number

Example: 108427225641466

tostringOptional

The recipient's WhatsApp phone number

Example: +1234567890

Responses

200

Image Message Sent Successfully

application/json

401

Unauthorized

application/json

422

Validation Error(s)

application/json

post

/api/whatsapp/send-image-message

POST /api/whatsapp/send-image-message HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "from": "108427225641466",
  "to": "+1234567890",
  "image": {
    "link": "https://example.com/images/image.jpg",
    "caption": "Check out this cool image"
  }
}

{
  "success": true,
  "message": "Image Message Sent Successfully",
  "data": {
    "id": "wamid.HBgMMjAxMTI2MjIwODA2FQIAERgSQ0U3MzEyQTQyMUY0OTRGMjVEAA==",
    "whatsapp_phone_number_id": 108427225641466,
    "sender_type": "App\\\\Models\\\\WhatsappPhoneNumber",
    "sender_id": 108427225641466,
    "recipient_type": "App\\\\Models\\\\WhatsappConsumerPhoneNumber",
    "recipient_id": 1,
    "sender_role": "BUSINESS",
    "type": "image",
    "direction": "SENT",
    "status": "initiated",
    "created_at": "2024-09-30T14:26:02.000000Z",
    "updated_at": "2024-09-30T14:26:02.000000Z",
    "messageable_id": 15,
    "messageable_type": "App\\\\Models\\\\WhatsappImageMessage",
    "statuses": [
      {
        "id": 11,
        "whatsapp_message_id": "wamid.HBgMMjAxMTI2MjIwODA2FQIAERgSQ0U3MzEyQTQyMUY0OTRGMjVEAA==",
        "status": "initiated",
        "timestamp": 1727274362,
        "created_at": "2024-09-30T14:26:02.000000Z",
        "updated_at": "2024-09-30T14:26:02.000000Z"
      }
    ],
    "messageable": {
      "id": 15,
      "whatsapp_message_id": "wamid.HBgMMjAxMTI2MjIwODA2FQIAERgSQ0U3MzEyQTQyMUY0OTRGMjVEAA==",
      "link": "https://example.com/images/image.jpg",
      "caption": "Check out this cool image",
      "created_at": "2024-09-30T14:26:02.000000Z",
      "updated_at": "2024-09-30T14:26:02.000000Z"
    }
  }
}

Send a WhatsApp video message

post

Sends a video message to a specified WhatsApp recipient.

Body

fromstringOptional

The ID of the WhatsApp phone number

Example: 108427225641466

tostringOptional

The recipient's WhatsApp phone number

Example: +1234567890

Responses

200

Video Message Sent Successfully

application/json

401

Unauthorized

application/json

422

Validation Error(s)

application/json

post

/api/whatsapp/send-video-message

POST /api/whatsapp/send-video-message HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "from": "108427225641466",
  "to": "+1234567890",
  "video": {
    "id": "1166846181421424",
    "link": "https://example.com/videos/video.mp4",
    "caption": "Check out this cool video"
  }
}

{
  "success": true,
  "message": "Video Message Sent Successfully",
  "data": {
    "id": "wamid.HBgMMjAxMTI2MjIwODA2FQIAERgSQ0U3MzEyQTQyMUY0OTRGMjVEAA==",
    "whatsapp_phone_number_id": 108427225641466,
    "sender_type": "App\\\\Models\\\\WhatsappPhoneNumber",
    "sender_id": 108427225641466,
    "recipient_type": "App\\\\Models\\\\WhatsappConsumerPhoneNumber",
    "recipient_id": 1,
    "sender_role": "BUSINESS",
    "type": "video",
    "direction": "SENT",
    "status": "initiated",
    "created_at": "2024-09-30T14:26:02.000000Z",
    "updated_at": "2024-09-30T14:26:02.000000Z",
    "messageable_id": 15,
    "messageable_type": "App\\\\Models\\\\WhatsappVideoMessage",
    "statuses": [
      {
        "id": 11,
        "whatsapp_message_id": "wamid.HBgMMjAxMTI2MjIwODA2FQIAERgSQ0U3MzEyQTQyMUY0OTRGMjVEAA==",
        "status": "initiated",
        "timestamp": 1727274362,
        "created_at": "2024-09-30T14:26:02.000000Z",
        "updated_at": "2024-09-30T14:26:02.000000Z"
      }
    ],
    "messageable": {
      "id": 15,
      "whatsapp_message_id": "wamid.HBgMMjAxMTI2MjIwODA2FQIAERgSQ0U3MzEyQTQyMUY0OTRGMjVEAA==",
      "media_id": "1166846181421424",
      "link": "https://example.com/videos/video.mp4",
      "caption": "Check out this cool video",
      "created_at": "2024-09-30T14:26:02.000000Z",
      "updated_at": "2024-09-30T14:26:02.000000Z"
    }
  }
}

Send a WhatsApp audio message

post

Sends an audio message to a specified WhatsApp recipient.

Body

fromstringOptional

The ID of the WhatsApp phone number

Example: 108427225641466

tostringOptional

The recipient's WhatsApp phone number

Example: +1234567890

Responses

200

Audio Message Sent Successfully

application/json

401

Unauthorized

application/json

422

Validation Error(s)

application/json

post

/api/whatsapp/send-audio-message

POST /api/whatsapp/send-audio-message HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "from": "108427225641466",
  "to": "+1234567890",
  "audio": {
    "id": "3674626312780147",
    "link": "https://example.com/audio/audio.mp3"
  }
}

{
  "success": true,
  "message": "Audio Message Sent Successfully",
  "data": {
    "id": "wamid.HBgMMjAxMTI2MjIwODA2FQIAERgSQ0U3MzEyQTQyMUY0OTRGMjVEAA==",
    "whatsapp_phone_number_id": 108427225641466,
    "sender_type": "App\\\\Models\\\\WhatsappPhoneNumber",
    "sender_id": 108427225641466,
    "recipient_type": "App\\\\Models\\\\WhatsappConsumerPhoneNumber",
    "recipient_id": 1,
    "sender_role": "BUSINESS",
    "type": "audio",
    "direction": "SENT",
    "status": "initiated",
    "created_at": "2024-09-30T14:26:02.000000Z",
    "updated_at": "2024-09-30T14:26:02.000000Z",
    "messageable_id": 15,
    "messageable_type": "App\\\\Models\\\\WhatsappAudioMessage",
    "statuses": [
      {
        "id": 11,
        "whatsapp_message_id": "wamid.HBgMMjAxMTI2MjIwODA2FQIAERgSQ0U3MzEyQTQyMUY0OTRGMjVEAA==",
        "status": "initiated",
        "timestamp": 1727274362,
        "created_at": "2024-09-30T14:26:02.000000Z",
        "updated_at": "2024-09-30T14:26:02.000000Z"
      }
    ],
    "messageable": {
      "id": 15,
      "whatsapp_message_id": "wamid.HBgMMjAxMTI2MjIwODA2FQIAERgSQ0U3MzEyQTQyMUY0OTRGMjVEAA==",
      "media_id": "3674626312780147",
      "link": "https://example.com/audio/audio.mp3",
      "created_at": "2024-09-30T14:26:02.000000Z",
      "updated_at": "2024-09-30T14:26:02.000000Z"
    }
  }
}

PreviousWhatsApp Media NextWhatsApp Analytics

Last updated 5 months ago