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 Name

Description

timeStamp

Timestamp of the event

description

Detailed description of the delivery status.

code

Status code as mentioned in the documentation

deliveryChannel

Channel to be used to send message

destination

The mobile number to which message will be sent

destinationType -

This is always msisdn for SMS

additionalinfo

Additional info such as details about the browser used to open a link in case of Click events.

deliveryStatus

Status of messages once sent

subtid

A unique transaction id will be generated as subtid for the flow level transactions(or node tid)

transid

Unique transaction reference id of the request

callbackData

Data that you have configured to receive on the notify Url. This is configured as a part of the request

correlationid

The 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.

Submitted

When a message is submitted to the Webex Connect gateway

Delivered

Returned when the delivery is completed successfully

Un-Delivered

We have different reasons for the un-delivered in the document

Failed

We 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": "918886661353",
  "message": "Simple Text",
  "tid": "105eddec-dd53-433d-9d6f-37f10ac76a06",
  "datetime": "2015-04-12 13:00:19",
  "ts": "2015-04-12T13:00:19.456Z",
  "timeStamp" : "2015-04-12T13:00:19.456Z",
  "x_networkid" : "10"
}

Incoming Messages Descriptions

Field Name

Descriptions

channel

Channel is SMS always for incoming SMS

oa

Enterprise number or business number

da

End user from which platform receive the MO messages

message

Message body which contains a message sent from the end-user

tid

Unique transaction reference id of the request

ts

Timestamp when MO received to connect

timeStamp

Timestamp when MO received to connect

Error Codes

Error Code

Description

Status

7500

Returned when the delivery is completed successfully

Delivered

7501

Returned when message is submitted to the gateway

Submitted

7004

Returned when an invalid value or parameters are provided

Un-Delivered

7006

Returned when an occur occurs in server

Un-Delivered

7101

Returned when the sender ID is invalid

Un-Delivered

7102

Returned when the address is invalid

Un-Delivered

7107

Returned when the message length exceeded 1024 characters

Un-Delivered

7109

Returned when the user is registered on Do Not Disturb list

Un-Delivered

7201

Returned when the delivery failed at operator

Un-Delivered

7202

Returned when the delivery failed at platform

Un-Delivered

7203

Returned when the subscriber address is not known

Un-Delivered

7204

Returned when the subscriber account has insufficient credits

Un-Delivered

7205

Returned when there is an error in binary message

Un-Delivered

7206

Returned when the subscribers SIM is full

Un-Delivered

7207

Returned when the subscriber is out of coverage area

Un-Delivered

7208

Returned when message is expired

Un-Delivered

7209

Returned when unable to deliver multi-part message

Un-Delivered

7210

Returned when there is an error in billing configuration

Un-Delivered

7211

Returned when an error occurs at operator

Un-Delivered