{
"event": "message.phone.ussd",
"data": {
"user_id": "9f8b7c6d-2222-4a2b-8c3d-4e5f6a7b8c9d",
"phone_id": "9f8b7c6d-1111-4a2b-8c3d-4e5f6a7b8c9d",
"id": "9f8b7c6d-3333-4a2b-8c3d-4e5f6a7b8c9d",
"request_id": "order-1042-otp",
"message_thread_id": "9f8b7c6d-4444-4a2b-8c3d-4e5f6a7b8c9d",
"from_phone_number": "+12025550101",
"to_phone_number": "+12025550147",
"content": "Acme code: 482913",
"tags": [],
"send_duration": null,
"schedule_on_phone_at": "2026-11-19 10:00:01",
"sent_at": "2026-11-19 10:00:04",
"last_attempted_at": "2026-11-19 10:00:01",
"delivered_at": null,
"received_at": null,
"expired_at": null,
"schedule_send_at": null,
"failed_at": null,
"send_attempt_count": 1,
"max_send_attempts": 3,
"failure_reason": null,
"ussd_message": "Your balance is 10.00. Valid until 2026-12-31.",
"message_expiration_seconds": 600,
"timezone": "UTC",
"sim": "SIM1",
"status": "sent",
"type": "sent_to_mobile",
"created_at": "2026-11-19 10:00:00",
"updated_at": "2026-11-19 10:00:07"
}
}Message USSD
Sent when the phone gets a USSD or flash reply for a message you sent.
WEBHOOK
message-ussd
{
"event": "message.phone.ussd",
"data": {
"user_id": "9f8b7c6d-2222-4a2b-8c3d-4e5f6a7b8c9d",
"phone_id": "9f8b7c6d-1111-4a2b-8c3d-4e5f6a7b8c9d",
"id": "9f8b7c6d-3333-4a2b-8c3d-4e5f6a7b8c9d",
"request_id": "order-1042-otp",
"message_thread_id": "9f8b7c6d-4444-4a2b-8c3d-4e5f6a7b8c9d",
"from_phone_number": "+12025550101",
"to_phone_number": "+12025550147",
"content": "Acme code: 482913",
"tags": [],
"send_duration": null,
"schedule_on_phone_at": "2026-11-19 10:00:01",
"sent_at": "2026-11-19 10:00:04",
"last_attempted_at": "2026-11-19 10:00:01",
"delivered_at": null,
"received_at": null,
"expired_at": null,
"schedule_send_at": null,
"failed_at": null,
"send_attempt_count": 1,
"max_send_attempts": 3,
"failure_reason": null,
"ussd_message": "Your balance is 10.00. Valid until 2026-12-31.",
"message_expiration_seconds": 600,
"timezone": "UTC",
"sim": "SIM1",
"status": "sent",
"type": "sent_to_mobile",
"created_at": "2026-11-19 10:00:00",
"updated_at": "2026-11-19 10:00:07"
}
}Event:
message.phone.ussd
Sent when the phone gets a USSD or flash reply linked to a message you sent, for example a balance notice from the carrier. The reply text is in ussd_message. The message keeps its current status.Headers
Body
application/json
Response
200
Return any 2xx status to acknowledge the event.
Last modified on November 20, 2026