Data Streams - SMS

SMS - Inbound Message

{
    "userId": "",
    "channel": "SMS",
    "destination": "919676219269",
    "message": "key flow",
    "tid": "234190eb-df62-45c8-9281-c4b6f5b09c20",
    "datetime": "2020-02-25T12:40:45.051+05:30",
    "ts": "2020-02-25T12:40:45.051+05:30",
    "x_networkid": "",
    "dataIntegration": {
    "context": {
		"serviceId": "43553",
		"serviceName": "Appointment Booking",
		"flowId": "1234",
		"flowName": "Doctor Appointment ",
		"messagingAPI": "False",
		"Key": "Value", // added in the send or receive or start nodes
		"Key2": "Value2" added in the send or receive or start nodes
		},
    "appContext": {
      "tenant_identifier": "CloudQAPMV2",
      "Topic": "CloudQAPMV2Email",
      "URL": "dummy_data",
      "webhookurl": ""
    }
  }
}		

Inbound Message Descriptions

Field NameDescription
userId
channel
destination
message
tid
datetime
ts
x_networkid
dataIntegration
context
serviceId
serviceName
flowId
flowName
messagingAPI
Key
Key2
appContext
tenant_identifier
Topic
URL
webhookurl

SMS - Delivery Receipt

{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-05-11T19:16:00.911+04:00",
      "Description": "Submitted",
      "code": "7501",
      "deliveryChannel": "SMS",
      "additionalInfo": "",
      "destination": "17472126048",
      "destinationType": "msisdn",
      "deliveryStatus": "Submitted"
    },
    "subtid": "277e3695-dffb-431c-8e8c-612cc686b8fa",
    "transid": "933d440b-0780-4d1b-ad0d-37f949bf974d",
    "callbackData": "",
    "correlationid": ""
  },
  "dataIntegration": {
    "context": {
      "Message": "",
      "senderNum": "17472126048",
      "keyword": "DISMS"
    },
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "dummy_data",
      "webhookurl": ""
    }
  }
}
{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-05-11T19:16:06.587+04:00",
      "Description": "Delivered",
      "code": "7500",
      "deliveryChannel": "SMS",
      "additionalInfo": "",
      "destination": "17472126048",
      "destinationType": "msisdn",
      "deliveryStatus": "Delivered"
    },
    "subtid": "277e3695-dffb-431c-8e8c-612cc686b8fa",
    "transid": "933d440b-0780-4d1b-ad0d-37f949bf974d",
    "callbackData": "",
    "correlationid": ""
  },
  "dataIntegration": {
    "context": {
      "Message": "",
      "senderNum": "17472126048",
      "keyword": "DISMS"
    },
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "dummy_data",
      "webhookurl": ""
    }
  }
}
{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-05-11T19:16:22.301+04:00",
      "Description": "Submitted",
      "code": "7501",
      "deliveryChannel": "SMS",
      "additionalInfo": "",
      "destination": "17472126048",
      "destinationType": "msisdn",
      "deliveryStatus": "Submitted"
    },
    "subtid": "7145e52e-239e-4bcd-ab48-8a4b9efd0c98",
    "transid": "933d440b-0780-4d1b-ad0d-37f949bf974d",
    "callbackData": "",
    "correlationid": ""
  },
  "dataIntegration": {
    "context": {
      "Receive MSG": "DISMSr",
      "Channel": "SMS"
    },
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "dummy_data",
      "webhookurl": ""
    }
  }
}
{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-05-11T19:16:32.429+04:00",
      "Description": "Delivered",
      "code": "7500",
      "deliveryChannel": "SMS",
      "additionalInfo": "",
      "destination": "17472126048",
      "destinationType": "msisdn",
      "deliveryStatus": "Delivered"
    },
    "subtid": "7145e52e-239e-4bcd-ab48-8a4b9efd0c98",
    "transid": "933d440b-0780-4d1b-ad0d-37f949bf974d",
    "callbackData": "",
    "correlationid": ""
  },
  "dataIntegration": {
    "context": {
      "Receive MSG": "DISMSr",
      "Channel": "SMS"
    },
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL":"dummy_data",
      "webhookurl": ""
    }
  }
}
{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-05-11T19:16:22.298+04:00",
      "Description": "Submitted",
      "code": "7501",
      "deliveryChannel": "SMS",
      "additionalInfo": "",
      "destination": "17472126048",
      "destinationType": "msisdn",
      "deliveryStatus": "Submitted"
    },
    "subtid": "f1e47691-b99d-4ba1-a523-a50f636dc73c",
    "transid": "933d440b-0780-4d1b-ad0d-37f949bf974d",
    "callbackData": "",
    "correlationid": ""
  },
  "dataIntegration": {
    "context": {
      "gatewaytid": "09f6d8f4-acc5-4d02-aab5-6ecea1bcb0a9"
    },
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "dummy_data",
      "webhookurl": ""
    }
  }
}
{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-05-11T19:16:29.328+04:00",
      "Description": "Delivered",
      "code": "7500",
      "deliveryChannel": "SMS",
      "additionalInfo": "",
      "destination": "17472126048",
      "destinationType": "msisdn",
      "deliveryStatus": "Delivered"
    },
    "subtid": "f1e47691-b99d-4ba1-a523-a50f636dc73c",
    "transid": "933d440b-0780-4d1b-ad0d-37f949bf974d",
    "callbackData": "",
    "correlationid": ""
  },
  "dataIntegration": {
    "context": {
      "gatewaytid": "09f6d8f4-acc5-4d02-aab5-6ecea1bcb0a9"
    },
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "dummy_data",
      "webhookurl": ""
    }
  }
}
{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-05-11T19:16:22.298+04:00",
      "Description": "Submitted",
      "code": "7501",
      "deliveryChannel": "SMS",
      "additionalInfo": "",
      "destination": "17472126048",
      "destinationType": "msisdn",
      "deliveryStatus": "Submitted"
    },
    "subtid": "09f6d8f4-acc5-4d02-aab5-6ecea1bcb0a9",
    "transid": "933d440b-0780-4d1b-ad0d-37f949bf974d",
    "callbackData": "",
    "correlationid": ""
  },
  "dataIntegration": {
    "context": {
      "datetime": "2022-05-11T15:16:22.232Z"
    },
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "dummy_data",
      "webhookurl": ""
    }
  }
}
{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-05-11T19:16:32.486+04:00",
      "Description": "Delivered",
      "code": "7500",
      "deliveryChannel": "SMS",
      "additionalInfo": "",
      "destination": "17472126048",
      "destinationType": "msisdn",
      "deliveryStatus": "Delivered"
    },
    "subtid": "09f6d8f4-acc5-4d02-aab5-6ecea1bcb0a9",
    "transid": "933d440b-0780-4d1b-ad0d-37f949bf974d",
    "callbackData": "",
    "correlationid": ""
  },
  "dataIntegration": {
    "context": {
      "datetime": "2022-05-11T15:16:22.232Z"
    },
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "dummy_data",
      "webhookurl": ""
    }
  }
}

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
destinationType This is always msisdn for SMS
additionalinfoAdditional info such as details about the browser used to open a link in case of Click events.
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 - Outbound Message

[Request] ["{\"esmeid\":-1|\"service-id\":\"-1\"|\"oa\":\"16513373954\"|\"extra-params\":\"x_ngmpdr=1&connect_message_id=83f8685f-6bf4-489f-9222-c824cd77fb69&x_validity=&x_cattype=1&x_skey=CLO95982-MMS17238-MMS97867&x_fixedroute=1&x_ngmptpserviceid=1&x_encrypt=CFBIGB&x_req_origin_time=2022-03-15+06%3A31%3A06.824&source=&x_tid=4b238de0-f073-42a9-9d33-b2597213eceb&x_priority=3&transDet=&sendAt=&msgtype=1&x_ngmpuname=ohadmin&x_dndenable=0&x_utcexpiry=&x_corelationid=4b238de0-f073-42a9-9d33-b2597213eceb&x_sroute=SEC_TRANS_NMX&source_tid=4b238de0-f073-42a9-9d33-b2597213eceb&x_ngmppassword=Oh%40123&x_sr=2&tmpSourceOriginTime=2022-03-15+06%3A31%3A06.824&x_appname=PRI_TRANS_NMX&x_ngmpcostid=1&x_ngmptypeid=2\"|\"dcs\":0|\"da\":\"447495302105\"|\"tid\":\"4b238de0-f073-42a9-9d33-b2597213eceb\"|\"sr\":2}"]

"dataIntegration": {
    "context": {
		"serviceId": "43553",
		"serviceName": "Appointment Booking",
		"flowId": "1234",
		"flowName": "Doctor Appointment ",
		"messagingAPI": "False",
		"Key": "Value", // added in the send or receive or start nodes
		"Key2": "Value2" added in the send or receive or start nodes
		}
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "dummy_data",
      "webhookurl": ""
    }
  }
}

Outbound Message Descriptions

Field NameDescription
context
dataIntegration
serviceId
serviceName
flowId
flowName
messagingAPI
Key
Key2
appContext
tenant_identifier
Topic
URL
webhookurl