Sign in

v24

latestSwagger 2.0AGPL-3.0raw.githubusercontent.com2026-08-015163191.7 KB
Messages

Upsert an event for a message on the mobile phone

Use this endpoint to send events for a message when it is failed, sent or delivered by the mobile phone.

post/messages/{messageID}/events

Path parameters

messageIDstring required

ID of the message

Request body

event_namestring required

EventName is the type of event

  • SENT: is emitted when a message is sent by the mobile phone
  • FAILED: is event is emitted when the message could not be sent by the mobile phone
  • DELIVERED: is event is emitted when a delivery report has been received by the mobile phone
reasonstring required

Reason is the exact error message in case the event is an error

timestampstring required

Timestamp is the time when the event was emitted, Please send the timestamp in UTC with as much precision as possible

Example request

{
  "event_name": "SENT",
  "timestamp": "2022-06-05T14:26:09.527976+03:00"
}

Response

OK

messagestring required
statusstring required

Example response

{
  "data": {
    "attachments": [
      "https://example.com/image.jpg",
      "https://example.com/video.mp4"
    ],
    "contact": "+18005550100",
    "content": "This is a sample text message",
    "created_at": "2022-06-05T14:26:02.302718+03:00",
    "delivered_at": "2022-06-05T14:26:09.527976+03:00",
    "expired_at": "2022-06-05T14:26:09.527976+03:00",
    "failed_at": "2022-06-05T14:26:09.527976+03:00",
    "failure_reason": "UNKNOWN",
    "id": "32343a19-da5e-4b1b-a767-3298a73703cb",
    "last_attempted_at": "2022-06-05T14:26:09.527976+03:00",
    "max_send_attempts": 1,
    "order_timestamp": "2022-06-05T14:26:09.527976+03:00",
    "owner": "+18005550199",
    "received_at": "2022-06-05T14:26:09.527976+03:00",
    "request_id": "153554b5-ae44-44a0-8f4f-7bbac5657ad4",
    "request_received_at": "2022-06-05T14:26:01.520828+03:00",
    "scheduled_at": "2022-06-05T14:26:09.527976+03:00",
    "scheduled_send_time": "2022-06-05T14:26:09.527976+03:00",
    "send_time": 133414,
    "sent_at": "2022-06-05T14:26:09.527976+03:00",
    "status": "pending",
    "type": "mobile-terminated",
    "updated_at": "2022-06-05T14:26:10.303278+03:00",
    "user_id": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
  },
  "message": "Request handled successfully",
  "status": "success"
}