SMS Opt Out Received

Events

Event Name	Description
Opted out	Triggered when an opt out keyword or an opt out webform submission has been revieved and the number has been added to the Opt Out List. Note that this is not triggered when numbers have been imported into an Opt Out List.

Payload Samples


{
  "specversion": "1.0",
  "type": "com.interact.messages.sms.opt.out",
  "source": "https://api.webexinteract.com/v1/sms",
  "id": "evt_36Ko1hKxBAQ7X9VrGoBxPoK7Om0",
  "time": "2025-12-03T12:20:10Z",
  "datacontenttype": "application/json",
  "data": {
    "status": "opt_out",
    "channel": "sms",
    "message": "STOP",
    "type": "keyword",
    "phone_number": "+447807127129",
    "inbound_number": "+447807127121",
    "inbound_number_id": "num_36IR2Jpl1u1wOuRBgmMmoMhawjE",
    "account_level_opt_out": false,
    "opt_out_time": "2025-12-03T12:20:10Z"
  }
}

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	Specifies the event: "opt_out".
→ 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.
→account_level_opt_out	True when the number has been opted out for all communications within the account (or Workspace, if Workspaces are enabled on your account). False if the number has been opted out on a specific number asset.
→ opt_out_time	Timestamp (ISO 8601 format) relating to when the number was added to your Opt Outs List.
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.