Send session message

The Send session message endpoint delivers messages to users with an open conversation on WhatsApp, Facebook, Instagram, or SMS.

Session messages only work inside the 24-hour active session window. To reach users outside that window, use Send template message.

Message types

Set message_type in the request body, then include the payload for that type. In most cases the payload field uses the same name as message_type (for example "message_type": "text" with a "text" string). Text

`message_type`	Payload	Description
`text`	`text` (string)	Plain text message body

Media — each type uses an object with mime_type and a public url

`message_type`	Formats
`image`	JPEG, PNG, and other image types
`document`	PDF, DOC, CSV, and other documents
`video`	MP4 and other supported video formats

Location

`message_type`	Payload	Description
`location`	`location` object	`latitude` and `longitude` as strings

Interactive (WhatsApp only)

`message_type`	Payload	Description
`quick_reply`	`quick_reply` object	Button-style replies
`list`	`list` object	List picker menu

Supported channel values: whatsapp, facebook, sms, instagram.

Sample requests

Text
Image
Document
Video
Location

{
  "from": "255701000000",
  "to": "255701000001",
  "channel": "whatsapp",
  "transaction_id": "4f6eec48-4140-4ce8-80c5-cef0e189578c",
  "message_type": "text",
  "text": "Hello there"
}

{
  "from": "255701000000",
  "to": "255701000001",
  "channel": "whatsapp",
  "transaction_id": "4f6eec48-4140-4ce8-80c5-cef0e189578c",
  "message_type": "image",
  "image": {
    "mime_type": "image/jpeg",
    "url": "https://www.example.com/photo.jpeg"
  }
}

{
  "from": "255701000000",
  "to": "255701000001",
  "channel": "whatsapp",
  "transaction_id": "4f6eec48-4140-4ce8-80c5-cef0e189578c",
  "message_type": "document",
  "document": {
    "mime_type": "application/pdf",
    "url": "https://www.example.com/invoice.pdf"
  }
}

{
  "from": "255701000000",
  "to": "255701000001",
  "channel": "whatsapp",
  "transaction_id": "4f6eec48-4140-4ce8-80c5-cef0e189578c",
  "message_type": "video",
  "video": {
    "mime_type": "video/mp4",
    "url": "https://www.example.com/clip.mp4"
  }
}

{
  "from": "255701000000",
  "to": "255701000001",
  "channel": "whatsapp",
  "transaction_id": "4f6eec48-4140-4ce8-80c5-cef0e189578c",
  "message_type": "location",
  "location": {
    "latitude": "-6.8178877",
    "longitude": "39.2858009"
  }
}

Optional fields

Field	Description
`transaction_id`	Client reference (UUID v4) for tracking
`callback_url`	HTTPS URL where inbound replies are POSTed

Response

On success the API returns:

{
  "message": "SUCCESS"
}

See the Send session message API reference for the interactive playground and full schema.

Getting Started

APIs

Send session message

Message types

Sample requests

Optional fields

Response

​Message types

​Sample requests

​Optional fields

​Response

Message types

Sample requests

Optional fields

Response