Bandwidth · AsyncAPI Specification

Bandwidth Messaging Events

Version 2.0

Bandwidth Messaging API sends webhooks to your application for real-time message delivery notifications and inbound message alerts. Callbacks are sent via HTTP POST to the callback URL configured on the Bandwidth application associated with the message. You MUST respond with an HTTP 2xx status code for every callback. Bandwidth will retry callbacks over the next 24 hours until a 2xx response is received.

View Spec View on GitHub CommunicationsCPaaSVoiceMessagingTelephonySMSMFAAsyncAPIWebhooksEvents

Channels

/messaging/inbound

publish onInboundMessage

Inbound message received

Inbound message webhook sent when a message is received by one of your Bandwidth phone numbers. Provides the full message content, sender, and recipient information.

/messaging/status

publish onMessageStatus

Message delivery status update

Message delivery status webhook sent for outbound messages. You will receive either a Message Delivered or Message Failed event for each outbound message, but never both.

Messages

✉

InboundMessageCallback

Inbound Message Callback

Sent when an inbound message is received by a Bandwidth number

✉

MessageDeliveredCallback

Message Delivered Callback

Sent when an outbound message is successfully delivered

✉

MessageFailedCallback

Message Failed Callback

Sent when an outbound message fails to deliver

✉

MessageSendingCallback

Message Sending Callback

Sent when an outbound message is being sent to the carrier

Servers

https

production {callbackUrl}

Your application's webhook endpoint. The URL is configured on the Bandwidth application associated with the message.