Outbound SMS - Submitted

Be notified when a message has been accepted for processing by Webex Interact

Event

Event NameDescription
SubmittedTriggered when a message has been accepted for processing by Webex Interact.

Payload Sample

//Sample response for a message submitted to operator
{
  "specversion": "1.0",
  "type": "com.interact.messages.sms.status",
  "source": "https://api.webexinteract.com/v1/sms",
  "id": "evt_2z01l2qZ8MRVmFZSUQHHfIjVvje",
  "time": "2025-06-25T12:08:43Z",
  "datacontenttype": "application/json",
  "data": {
    "status": "submitted",
    "channel": "sms",
    "code": "1003",
    "phone_number": "+447810000001",
    "from": "Name",
    "message_body": "This is your message",
    "message_parts": "1",
    "scheduled_at": "2025-06-30T12:08:43Z",
    "list_id": "LST_30pMyhWlE2KM55MCNJPh6CAIxvX",    
    "campaign_name": "My campaign",
    "campaign_id": "cmp_219r8u4981u498"
  },
  "correlation_id": "anexternallyassignedreference",
  "transaction_id": "tid_35T5b3cQmfqTu6jcedrdVcSmNHr"
}

Field Definitions

ParameterShow/HideDescription
typeAlways shownSpecifies the event type.
sourceAlways shownIndicates the event's origin, such as the API URL..
idAlways shownUnique webhook event identifier.
timeAlways shownTimestamp (ISO 8601 format) of the event.
datacontenttypeAlways shownSpecifies the data format, typically "application/json".
→ statusAlways shownSMS message status (submitted, delivered, failed, clicked).
→ channelAlways shownSpecifies channel used to send the message
→ codeAlways shownStatus code providing information about the message state.
→fromAlways shownRecipient phone number.
→message_bodyAlways shownThe message to be sent to the recipient.
→message_partsAlways shownThe number of SMS being sent in the message.
→scheduled_atShown if message was scheduledThe date time that the message is scheduled for.
→list_idShown if the recipient was part of a target listThe list_id of the targeted list.
→campaign_nameShown if message was sent as part of a CampaignIf the message was requested as part of a campaign then the campaign name is provided.
→campaign_idShown if message was sent as part of a CampaignIf the message was requested as part of a campaign then the campaign ID is provided.
correlation_idAPI: Shown if provided on SMS request

Campaigns: Always shown
API SMS Requests: A reference that was set on the request.

Campaigns: Automatically generated.
transaction_idAlways shownA unique identifier internally generated for the associated SMS request.