Skip to main content
WEBHOOK
message-delivered
{
  "event": "message.phone.delivered",
  "data": {
    "id": "9e0818ff-a1ce-435a-b17b-6205cd8dd6c3",
    "request_id": "133554b5-ae44-44a0-8f4f-7bbac5657a11",
    "message_thread_id": "9e08187b-10e5-4de9-b9d2-ee9303d5eae0",
    "phone_id": "9dedf71e-97bf-47eb-8df5-3088a7865603",
    "from_phone_number": "+201490428909",
    "to_phone_number": "+201328497823",
    "content": "test message delivered",
    "send_duration": null,
    "schedule_on_phone_at": "2025-01-22 20:04:01",
    "sent_at": "2025-01-22 20:04:03",
    "last_attempted_at": "2025-01-22 20:04:01",
    "delivered_at": "2025-01-22 20:04:06",
    "received_at": null,
    "expired_at": null,
    "schedule_send_at": "2025-01-22 20:04:00",
    "failed_at": null,
    "send_attempt_count": 1,
    "max_send_attempts": 10,
    "failure_reason": null,
    "message_expiration_seconds": 259200,
    "timezone": "GMT+2",
    "sim": "SIM1",
    "status": "delivered",
    "type": "sent_to_mobile",
    "created_at": "2025-01-22 20:02:43",
    "updated_at": "2025-01-22 20:04:07"
  }
}
This webhook is triggered when the phone has successfully delivered the message to the recipient.

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.delivered
​
data
object
required

Response

200

Successfully delivered the message. The server acknowledged.

⌘I