Inbound SMS Events

Events

Event	Description
Inbound message received	Triggered when a message has been received on your Webex Interact inbox.

Payload Samples


{
  "specversion": "1.0",
  "type": "com.interact.messages.sms.status",
  "source": "https://api.webexinteract.com/v1/sms",
  "id": "evt_2z01rKkdxq3oKzf013lxmn127v8",
  "time": "2025-06-25T12:09:33Z",
  "datacontenttype": "application/json",
  "data": {
    "status": "inbound",
    "channel": "sms",
    "message": "I'd like to SUBSCRIBE to your EVENTS newsletters",
    "phone_number": "+447838970000",
    "inbound_number": "+447860000000",
    "inbound_number_id": "num_2yuxhMhvveEjsqYuHm68rslycA8",
    "opt_ins": [
      {
        "opt_in": "Newsletter Signup",
        "keyword": "SUBSCRIBE",
        "target_lists": [
          "Monthly Newsletter",
          "Promotions"
        ]
      },
      {
        "opt_in": "Event Alerts",
        "keyword": "EVENTS",
        "target_lists": [
          "Local Events"
        ]
      }
    ]
  },
  "correlation_id": "cid_2z01rLJP7wm5KhVPuvvUj0TfvwT"

Field Definitions

Parameter	Description
type	Specifies the event type.
source	Indicates the event's origin, such as the API URL..
id	Unique webhook event identifier.
time	Timestamp (ISO 8601 format) of the event.
datacontenttype	Specifies the data format, typically "application/json".
→ status	SMS message status "inbound".
→ channel	Specifies channel that the message was received on.
→message	Message body received.
→phone_number	The senders phone number.
→inbound_number	Your Webex Interact phone number that the message was received on.
→inbound_number_id	The UID of the Webex Interact phone number that the message was received on.
→opt_ins	An instance for each Opt-In that the message was received via. Not provided if the message did not match any Opt-In conditions.
→→keyword	The keyword that met the condition for the Opt-In.
→→target_lists	The target lists that the inbound number was added to as a result of meeting the Opt-In condition.
correlation_id	A unique identifier assigned to each request for tracking and reference. It can be included in API requests as per your preference. If not, Interact will assign automatically.