Message Received

{}

POST

message-received

{}

This webhook is triggered when a new sms message is received on the connected phone.

Headers

x-userId

string

required

User UUID associated with the connected WhatsApp instance.

x-instanceId

string

required

Instance UUID of the connected WhatsApp instance.

Body

application/json

event

enum<string>

required

Available options:

message.phone.received

data

object

required

Show child attributes

data.id

string

data.request_id

string

data.message_thread_id

string

data.phone_id

string

data.from_phone_number

string

data.to_phone_number

string

data.content

string

data.send_duration

null

data.schedule_on_phone_at

string

data.sent_at

string

data.last_attempted_at

string

data.delivered_at

string

data.received_at

null

data.expired_at

null

data.schedule_send_at

null

data.failed_at

null

data.send_attempt_count

integer

data.max_send_attempts

integer

data.failure_reason

null

data.message_expiration_seconds

integer

data.timezone

string

data.sim

string

data.status

string

data.type

string

data.created_at

string

data.updated_at

string

Response

200

Successfully received the message. The server acknowledged.

Message Failed Message Scheduled

⌘I

Overview

SMS API

SMS Webhooks

Headers

Body

Response