SMS

Navigate to Integrations -> Outbound Webhooks

SMS Delivery Receipts

  • Select the service you are sending the SMS from
  • Select the channel as SMS
{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-10-10T13:53:13.749+01:00",
      "Description": "Submitted",
      "code": "7501",
      "deliveryChannel": "SMS",
      "additionalInfo": "",
      "destination": "9189xxxxxxxx",
      "destinationType": "msisdn",
      "deliveryStatus": "Submitted"
    },
    "subtid": "",
    "transid": "7f3af32c-8d6a-4173-b1c8-4805135ada71",
    "callbackData": "",
    "correlationid": ""
  }
}
{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-10-10T13:53:13.749+01:00",
      "Description": "Invalid Sender ID",
      "code": "7101",
      "deliveryChannel": "SMS",
      "additionalInfo": "",
      "destination": "9189xxxxxxxx",
      "destinationType": "msisdn",
      "deliveryStatus": "Failed"
    },
    "subtid": "",
    "transid": "3bf586f4-3001-4272-8da2-a7161644cebc",
    "callbackData": "",
    "correlationid": ""
  }
}
{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-10-10T13:53:13.749+01:00",
      "Description": "Invalid address",
      "code": "7102",
      "deliveryChannel": "SMS",
      "additionalInfo": "",
      "destination": "9189xxxxxxxx",
      "destinationType": "msisdn",
      "deliveryStatus": "Failed"
    },
    "subtid": "",
    "transid": "dba07fc1-0d68-4ce7-ae9f-d7ec539ac832",
    "callbackData": "",
    "correlationid": ""
  }
}
{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-10-10T13:53:13.749+01:00",
      "Description": "Message length exceeded",
      "code": "7107",
      "deliveryChannel": "SMS",
      "additionalInfo": "",
      "destination": "91891xxxxxxxx",
      "destinationType": "msisdn",
      "deliveryStatus": "Failed"
    },
    "subtid": "",
    "transid": "4daf1851-eca4-4cad-a231-9be44a0f60ce",
    "callbackData": "",
    "correlationid": ""
  }
}
{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-10-10T13:53:13.749+01:00",
      "Description": "<dynamic response>",
      "code": "<dynamic code>",
      "deliveryChannel": "SMS",
      "additionalInfo": "",
      "destination": "9189xxxxxxxx",
      "destinationType": "msisdn",
      "deliveryStatus": "Un-Delivered"
    },
    "subtid": "",
    "transid": "f7541551-0d9d-4aea-b68d-1499168e24fb",
    "callbackData": "",
    "correlationid": ""
  }
}
{
    "deliveryInfoNotification": {
        "deliveryInfo": {
            "deliveryChannel": "sms",
            "Description": "http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-smtp.html|192.0.2.1",
            "destinationType": "msisdn",
            "timeStamp": "2022-10-10T13:53:13.749+01:00",
            "additionalInfo":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.90 Safari/537.36",
            "code": "7528",
            "deliveryStatus": "Clicked",
            "destination": "4475xxxxxxxx"
        },
        "correlationid": "3bd8edf31c81-4b72d8a2-290d-49e2-993e",
        "callbackData": "return callbackdata",
        "transid": "4b72d8a2-290d-49e2-993e-3bd8edf31c81"
    }
}
{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-10-10T13:53:13.749+01:00",
      "Description": "Delivered",
      "code": "7500",
      "deliveryChannel": "SMS",
      "additionalInfo": "",
      "destination": "9189xxxxxxxx",
      "destinationType": "msisdn",
      "deliveryStatus": "Delivered"
    },
    "subtid": "",
    "transid": "7f3af32c-8d6a-4173-b1c8-4805135ada71",
    "callbackData": "",
    "correlationid": ""
  }
}

Delivery Receipts Descriptions

Field NameDescription
timeStampTimestamp of the event
descriptionDetailed description of the delivery status.
codeStatus code as mentioned in the documentation
deliveryChannelChannel to be used to send message
destinationThe mobile number to which message will be sent
destinationTypeThis is always msisdn for SMS
additionalinfoAdditional info such as details about the browser used to open a link in case of Click events. Please note that Clicked events are tracked only when using shortenLinks with trackClicks set to true via Messaging API v2. Click tracking isn't available for Smart Links at the moment.
deliveryStatusStatus of messages once sent
subtidA unique transaction id will be generated as subtid for the flow level transactions(or node tid)
transidUnique transaction reference id of the request
callbackDataData that you have configured to receive on the notify Url. This is configured as a part of the request
correlationidThe CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request.
SubmittedWhen a message is submitted to the Webex Connect gateway
DeliveredReturned when the delivery is completed successfully
Un-DeliveredWe have different reasons for the un-delivered in the document
FailedWe have multiple reasons for the failure of a message
Eg: When the sender ID is invalid.
When the address is invalid more details and error codes are already covered in the document

SMS Incoming Messages

  • Navigate to Integrations -> Outbound Webhooks
  • Select the short-code/number that you expect to receive messages on as the 'Entity'
  • Select Incoming Message checkbox under 'Which notifications do you want to receive' section
  • Configure the URL you would like to receive a notification for incoming messages on under 'Endpoint Configuration' section
  • Optionally configure Hub Signature details
  • Click Save

Once done, you'll be notified on the configured URL whenever an incoming message is received on the configured Webex Connect phone number/short code.

{
  "userId": "9009",
  "channel": "SMS",
  "oa": "441157070619",
  "da": "1XXXX661353",
  "message": "Incoming SMS Text",
  "tid": "105eddec-dd53-433d-9d6f-37f10ac76a06",
  "datetime": "2024-01-07T14:36:09.266Z",
  "ts": "2015-04-12T13:00:19.456Z",
  "x_networkid" : "10"
}

Incoming Messages Descriptions

Field NameDescriptions
channelChannel is SMS always for incoming SMS
oaPhone number on which the SMS has been received on
daEnd user phone number from which the message was sent from
messageMessage content
tidUnique transaction reference id of the request
datetimeTimestamp when this message was received on Webex Connect
tsTimestamp when this message was received on Webex Connect

Error Codes

Error CodeDescriptionStatus
7500Returned when the delivery is completed successfullyDelivered
7501Returned when message is submitted to the gatewaySubmitted
7004Returned when an invalid value or parameters are providedUn-Delivered
7006Returned when an occur occurs in serverUn-Delivered
7101Returned when the sender ID is invalidUn-Delivered
7102Returned when the address is invalidUn-Delivered
7107Returned when the message length exceeded 1024 charactersUn-Delivered
7109Returned when the user is registered on Do Not Disturb listUn-Delivered
7201Returned when the delivery failed at operatorUn-Delivered
7202Returned when the delivery failed at platformUn-Delivered
7203Returned when the subscriber address is not knownUn-Delivered
7204Returned when the subscriber account has insufficient creditsUn-Delivered
7205Returned when there is an error in binary messageUn-Delivered
7206Returned when the subscribers SIM is fullUn-Delivered
7207Returned when the subscriber is out of coverage areaUn-Delivered
7208Returned when message is expiredUn-Delivered
7209Returned when unable to deliver multi-part messageUn-Delivered
7210Returned when there is an error in billing configurationUn-Delivered
7211Returned when an error occurs at operatorUn-Delivered