Skip to main content
WEBHOOK
message-received
{
  "event": "message.phone.received",
  "data": {
    "id": "9e08197f-2481-4b4e-b034-b0eeefee580e",
    "request_id": "9e08197f-24f7-4550-b9f5-c1fd4d53b3a2",
    "phone": {
      "id": "9defcf1e-552c-4bef-a843-872edec576ef",
      "user_id": "9cbff1d0-6c37-4612-a8bb-6db042991361",
      "phone_number": "+201498274892",
      "name": "john doe",
      "sim": "SIM1",
      "max_send_attempts": 10,
      "message_expiration_seconds": 259200,
      "missed_call_auto_reply_message": null,
      "is_online": true,
      "last_online_at": "2025-01-21 20:50:26",
      "last_offline_at": "2025-01-21 19:48:04",
      "last_message_at": "2025-01-22 19:51:23",
      "last_missed_call_at": null,
      "last_heartbeat_at": "2025-01-22 20:03:31",
      "heartbeat_enabled_at": "2025-01-21 20:50:26",
      "timezone": "GMT+2",
      "created_at": "2025-01-10 18:16:16",
      "updated_at": "2025-01-22 20:03:31"
    },
    "message_thread_id": "9e081888-2fdb-424a-ac39-df5168d9553c",
    "phone_id": "9defcf1e-552c-4bef-a843-872edec576ef",
    "from_phone_number": "+201422904893",
    "to_phone_number": "+201133929839",
    "content": "test message received",
    "send_duration": null,
    "schedule_on_phone_at": null,
    "sent_at": null,
    "last_attempted_at": null,
    "delivered_at": null,
    "received_at": "2025-01-22 20:04:04",
    "expired_at": null,
    "schedule_send_at": null,
    "failed_at": null,
    "send_attempt_count": null,
    "max_send_attempts": 10,
    "failure_reason": null,
    "message_expiration_seconds": 259200,
    "timezone": "GMT+2",
    "sim": "SIM1",
    "status": "received",
    "type": "received_from_mobile",
    "created_at": "2025-01-22 20:04:06",
    "updated_at": "2025-01-22 20:04:06"
  }
}
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

Response

200

Successfully received the message. The server acknowledged.

I