Outbound SMS Events

Events

Event	Description
Submitted	Triggered when a message has been accepted for processing by Webex Interact.
Delivered	Triggered when Webex Interact has been notified of successful delivery by the Operator.
Failed	Triggered when the message has failed to be processed/delivered.
Clicked	Triggered when a Webex Interact generated shortlink included within the message has been clicked.

Payload Samples

//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": "Mattco",
    "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"
}

//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_2z01qjadl6TAWfvlPmMGbarsJf5",
  "time": "2025-06-25T12:09:28Z",
  "datacontenttype": "application/json",
  "data": {
    "status": "delivered",
    "channel": "sms",
    "phone_number": "+447810000001",
    "from": "Name",
    "message_body": "This is your message",
    "message_parts": "1",
    "scheduled_at": "2025-06-30T12:08:43Z",
    "list_id": "18920476",
    "campaign_name": "Some campaign",
    "campaign_id": "cmp_214r8u4981u498"
  },
  "correlation_id": "anexternallyassignedreference",
  "transaction_id": "tid_35T5b3cQmfqTu6jcedrdVcSmNHr"

//Sample response for a failed message
{
  "specversion": "1.0",
  "type": "com.interact.messages.sms.status",
  "source": "https://api.webexinteract.com/v1/sms",
  "id": "evt_2z020YIp98J0ow5egHEVQJQd2Sx",
  "time": "2025-06-25T12:10:47Z",
  "datacontenttype": "application/json",
  "data": {
    "status": "failed",
    "channel": "sms",
    "phone_number": "+447810000001",
    "from": "Name",
    "message_body": "This is your message",
    "message_parts": "1",
    "scheduled_at": "2025-06-30T12:08:43Z",
    "list_id": "18920476",
    "custom_id": "123",
    "campaign_name": "Some campaign",
    "campaign_id": "cmp_214r8u4981u498"

  },

 "correlation_id": "anexternallyassignedreference",
 "transaction_id": "tid_35T5b3cQmfqTu6jcedrdVcSmNHr"

//Sample response when a user clicks on a shortlink in the sent SMS
{
  "specversion": "1.0",
  "type": "com.interact.messages.sms.status",
  "source": "https://api.webexinteract.com/v1/sms",
  "id": "evt_2z01l2qQ8MRVmFZSUQHHxIjVvje",
  "time": "2025-06-25T12:08:43Z",
  "datacontenttype": "application/json",
  "data": {
    "status": "clicked",
    "channel": "sms",
    "phone_number": "+447810000001",
    "from": "senderA",
    "short_link": "https://intr.cc/D0vRZp",
    "type": "LINK", 
    "url": "https://www.cisco.com/c/r/team-development/career-and-learning/learning-subscriptions.html",
    "short_link_id": "shl_30rdc2Mie8PXOG4taeBqTxlnZrH", 
    "short_link_name": "Learning link",
    "device": "PC",
    "browser": "CHROME",
    "os": "MAC_OS",
    "campaign_id": "cmp_2yzyPKOKFjbycNEYSwkjk85ceqX"
  },
  "tracking_id": "30recwEuHHhrQtggF3E5vUMkH9C"
}

Field Definitions

Parameter	Event	Show/Hide	Description
type	All	Always shown	Specifies the event type.
source	All	Always shown	Indicates the event's origin, such as the API URL..
id	All	Always shown	Unique webhook event identifier.
time	All	Always shown	Timestamp (ISO 8601 format) of the event.
datacontenttype	All	Always shown	Specifies the data format, typically "application/json".
→ status	All	Always shown	SMS message status (submitted, delivered, failed, clicked).
→ channel	All	Always shown	Specifies channel used to send the message
→ code	Submitted	Always shown	Status code providing information about the message state.
→from	All	Always shown	Recipient phone number.
→message_body	Submitted/Delivered/Failed	Always shown	The message to be sent to the recipient.
→message_parts	Submitted/Delivered/Failed	Always shown	The number of SMS being sent in the message.
→scheduled_at	Submitted/Delivered/Failed	Shown if message was scheduled	The date time that the message is scheduled for.
→short_link	Clicked	Always shown	The short link that was clicked.
→type	Clicked	Always shown	Shortlink or Attachment link.
→short_link_id	Clicked	Always shown	The UID of the clicked shortlink.
→url	Clicked	Shown for type Shortlink only	The original/target URL.
→short_link_name	Clicked	Always shown	The name of the shortlink.
→device	Clicked	Always shown	The type of device used to access the shortlink (e.g., mobile, tablet, desktop).
→browser	Clicked	Always shown	The web browser application used to open the shortlink (e.g., Chrome, Safari, Firefox).
→os	Clicked	Always shown	The operating system running on the user's device at the time of the click (e.g., Windows, iOS, Android).
tracking_id	Clicked	Always shown	A unique ID for the click.
→list_id	Submitted/Delivered/Failed -	Shown if the receipient was part of a target list	The list_id of the targeted list.
→campaign_name	Submitted/Delivered/Failed	Shown if message was sent as part of a Campaign	If the message was requested as part of a campaign then the campaign name is provided.
→campaign_id	All	Shown if message was sent as part of a Campaign	If the message was requested as part of a campaign then the campaign ID is provided.
correlation_id	Submitted/Delivered/Failed	API: Shown if provided on SMS request Campaigns: Always shown	API SMS Requests: A reference that was set on the request. Campaigns: Automatically generated.
transaction _id	Submitted/Delivered/Failed	Always shown	A unique identifier internally generated for the associated SMS request.