Data Streams

RCS - Inbound Message

{
"carrier": "26",
"datetime": "2022-01-12T13:07:25.067Z",
"appId": "Dummy_data",
"channel": "rcs",
"serviceProvider": "GOOGLE",
"messageId": "Dummy_data",
"dataIntegration": {
"context": {
"Key": "Value",
"Key2": "Value2"
},
"appContext": {
"adminKey": "",
"tenant_identifier": "dummyTenant"
}
},
"msisdn": "Dummy_data",
"message": "Dummy_data",
"event": "MO",
"tid": "Dummy_data",
"ts": "2022-01-12T13:07:25.067Z"
}

{
"carrier": "26",
"datetime": "2022-01-12T13:16:25.698Z",
"attachments": "[{\"payload\":{\"url\":\"https://rcs-user-content-ap.storage.googleapis.com/dummy\"},\"type\":\"image\"}]",
"appId": "dummy_data",
"channel": "rcs",
"serviceProvider": "GOOGLE",
"messageId": "dummy_data",
"dataIntegration": {
"context": {
"Key1": "Val1",
"Kwy2": "Val2"
},
"appContext": {
"key1": "val1",
"tenant_identifier": "qanewtheme"
}
},
"msisdn": "+dummy_data",
"event": "ATTACHMENT",
"tid": "04400294-e6c2-c225-6cde-4e7dab8b80fe",
"ts": "2022-01-12T13:16:25.698Z"
}

{
"postback": "clicked ",
"carrier": "26",
"datetime": "2022-01-12T13:24:32.205Z",
"appId": "Dummy_data",
"channel": "rcs",
"serviceProvider": "GOOGLE",
"messageId": "Dummy_data",
"dataIntegration": {
"dataIntegration": {
"context": {
"Key": "Value",
"Key2": "Value2"
},
"appContext": {
"adminKey": "",
"tenant_identifier": "dummyTenant"
}
},
"msisdn": "+Dummy_data",
"event": "postback",
"tid": "Dummy_data",
"ts": "2022-01-12T13:24:32.205Z"
}
}

{
"latitude": "Dummy_data",
"channel": "rcs",
"messageId": "Dummy_data",
"dataIntegration": {
"dataIntegration": {
"context": {
"Key": "Value",
"Key2": "Value2"
},
"appContext": {
"adminKey": "",
"tenant_identifier": "dummyTenant"
}
},
"tid": "Dummy_data",
"carrier": "26",
"datetime": "2022-01-12T13:21:45.619Z",
"appId": "Dummy_data",
"serviceProvider": "GOOGLE",
"msisdn": "+Dummy_data",
"event": "Location",
"ts": "2022-01-12T13:21:45.619Z",
"longitude": "Dummy_data"
}
}

RCS - Delivery Receipt

{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-01-12T18:54:17.868+05:30",
      "Description": "Delivered",
      "code": "7500",
      "deliveryChannel": "rcs",
      "additionalInfo": "",
      "destination": "+Dummy_data",
      "destinationType": "msisdn",
      "deliveryStatus": "Delivered"
    },
    "carrier": "24",
    "subtid": "Dummy_data",
    "transid": "Dummy_data",
    "callbackData": "",
    "serviceProvider": "GOOGLE",
    "correlationid": ""
  },
  "dataIntegration": {
    "dataIntegration": {
      "context": {
        "Key": "Value",
        "Key2": "Value2"
      },
      "appContext": {
        "adminKey": "",
        "tenant_identifier": "dummyTenant"
      }
    }
  }
}

{
"deliveryInfoNotification": {
"deliveryInfo": {
"timeStamp": "2022-01-12T18:54:19.347+05:30",
"Description": "Read",
"code": "7502",
"deliveryChannel": "rcs",
"additionalInfo": "",
"destination": "+dummy_data",
"destinationType": "msisdn",
"deliveryStatus": "Read"
},
"carrier": "24",
"subtid": "",
"transid": "dummy_data",
"callbackData": "",
"serviceProvider": "GOOGLE",
"correlationid": ""
},
"dataIntegration": {
"dataIntegration": {
"context": {
"Key": "Value",
"Key2": "Value2"
},
"appContext": {
"adminKey": "",
"tenant_identifier": "dummyTenant"
}
}
}
}

{
"deliveryInfoNotification": {
"deliveryInfo": {
"timeStamp": "2022-01-12T18:54:18.988+05:30",
"Description": "Submitted",
"code": "7501",
"deliveryChannel": "rcs",
"additionalInfo": "",
"destination": "+dummy_data",
"destinationType": "msisdn",
"deliveryStatus": "Submitted"
},
"carrier": "24",
"subtid": "dummy_data",
"transid": "dummy_data",
"callbackData": "",
"serviceProvider": "GOOGLE",
"correlationid": ""
},
"dataIntegration": {
"dataIntegration": {
"context": {
"Key": "Value",
"Key2": "Value2"
},
"appContext": {
"adminKey": "",
"tenant_identifier": "dummyTenant"
}
}
}
}

{
"deliveryInfoNotification": {
"deliveryInfo": {
"timeStamp": "2022-01-12T21:21:47.543+05:30",
"Description": "Invalid media details",
"code": "7740",
"deliveryChannel": "rcs",
"additionalInfo": "Invalid media URL",
"destination": "+dummy_data",
"destinationType": "msisdn",
"deliveryStatus": "Failed"
},
"carrier": "",
"subtid": "dummy_data",
"transid": "dummy_data",
"callbackData": "",
"serviceProvider": "",
"correlationid": ""
},
"dataIntegration": {
"dataIntegration": {
"context": {
"Key": "Value",
"Key2": "Value2"
},
"appContext": {
"adminKey": "",
"tenant_identifier": "dummyTenant"
}
}
}
}

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 RCS
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
Read	When a message is read by the user
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

RCS - Outbound Message

{
  "extraparams": {
    "notificationurl": "https://requestinspector.com/inspect/01ftfr8srt0tt3r3ked39fxa4v",
    "connect_message_id": "a2147d1a-9339-49a2-a393-8949a5b73621",
    "messagePriority": 1,
    "channel": 25,
    "destination": "+13392344331",
    "x_req_origin_time": "2022-02-17 07:53:08.646",
    "api_version": "V2",
    "tid": "21212e73-8aac-49aa-8231-1514020ac940",
    "sourceTid": "21212e73-8aac-49aa-8231-1514020ac940",
    "report_info": {
      "message_type": 0,
      "request_source": 1,
      "source_tid": "21212e73-8aac-49aa-8231-1514020ac940"
    },
    "mt_trans_date": "2022-02-17 07:53:08.859",
    "outbound_notification_events": [
      "Sent",
      "Delivered",
      "Read",
      "Failed"
    ],
    "routerId": "",
    "noOfMessages": 1,
    "servicekey": "cd571ab3-785d-11ec-b012-029bfcf2fec9",
    "options": {
      "trackOpens": false,
      "rawEmailViewInBrowser": false,
      "smsFallback": true,
      "bypassSuppression": false,
      "smsSenderId": "12048177155",
      "text": "fallback sms text",
      "trackClicks": false,
      "carrierId": 1234,
      "shortenLinks": false
    },
    "notifycallbackdata": "abc",
    "destinationType": "msisdn",
    "corelationid": "chaitanya",
    "apiDestination": "+13392344331",
    "txn_log_level": 2
  },
  "appId": "a_164127120205685060",
  "submittedOn": 1645084389693,
  "x_msg_seq": 0,
  "msisdn": "+13392344331",
  "carrierId": 1234,
  "priority": 1,
  "tid": "21212e73-8aac-49aa-8231-1514020ac940",
  "content": {
    "fileSize": 0,
    "text": "Thanks for reaching out. RCS in Cloud QA env",
    "type": "text"
"dataIntegration": {
    "context": {
      "Message": "",
      "senderNum": "17472126048",
      "keyword": "DISMS"
    },
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": " ",
      "webhookurl": ""
    }
  }
}

{
  "extraparams": {
    "notificationurl": "https://requestinspector.com/inspect/01fs3v6zj2se1akh2p698vvnxd",
    "connect_message_id": "0ca41d55-fb6b-481f-93b2-87d20976f89e",
    "messagePriority": 1,
    "channel": 25,
    "destination": "+13392344331",
    "x_req_origin_time": "2022-02-17 07:53:12.467",
    "api_version": "V2",
    "tid": "2c1c7f98-bc6c-407a-afc2-18cdc0047732",
    "sourceTid": "2c1c7f98-bc6c-407a-afc2-18cdc0047732",
    "report_info": {
      "message_type": 13,
      "request_source": 1,
      "source_tid": "2c1c7f98-bc6c-407a-afc2-18cdc0047732"
    },
    "mt_trans_date": "2022-02-17 07:53:12.474",
    "outbound_notification_events": [
      "Sent",
      "Delivered",
      "Read",
      "Failed"
    ],
    "routerId": "",
    "noOfMessages": 1,
    "servicekey": "cd571ab3-785d-11ec-b012-029bfcf2fec9",
    "options": {
      "trackOpens": false,
      "rawEmailViewInBrowser": false,
      "smsFallback": true,
      "bypassSuppression": false,
      "smsSenderId": "12048177155",
      "text": "fallback text",
      "carrierId": 0,
      "trackClicks": false,
      "shortenLinks": false
    },
    "notifycallbackdata": "abc",
    "destinationType": "msisdn",
    "corelationid": "na1b2b1i1",
    "apiDestination": "+13392344331",
    "txn_log_level": 2
  },
  "appId": "a_164127120205685060",
  "submittedOn": 1645084392830,
  "x_msg_seq": 0,
  "msisdn": "+13392344331",
  "carrierId": 0,
  "priority": 1,
  "tid": "2c1c7f98-bc6c-407a-afc2-18cdc0047732",
  "content": {
    "fileSize": 0,
    "mediaContentUrl": "http://res.cloudinary.com/demo/image/upload/sample.jpg",
    "type": "media"
 "dataIntegration": {
    "context": {
      "Message": "",
      "senderNum": "17472126048",
      "keyword": "DISMS"
    },
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "",
      "webhookurl": "https://integrations.imiconnect.site/v1/integration/"
    }
  }
}

{
  "extraparams": {
    "authkey": "12a3cd31-afab-4349-9f87-590342f53444",
    "connect_message_id": "11817c0a-acf0-4247-9ea9-f7f0ebb7a584",
    "channel": 25,
    "destination": "+13392344331",
    "x_req_origin_time": "2022-02-08 14:21:33.180",
    "dataIntegration": "[{\"prebuiltId\":5041,\"context\":{\"Message\":\"gmail\",\"Channel\":\"rcs\",\"Payload \":\"{\\\"text\\\":\\\"gmail\\\",\\\"type\\\":\\\"ResponseContent\\\",\\\"contentType\\\":\\\"TEXT\\\",\\\"postBackData\\\":\\\"gmail clicked\\\"}\"},\"dataIntegrationid\":2}]",
    "tid": "1aa6bb5e-b8ae-4337-946c-73dd972c61aa",
    "sid": "52_101",
    "report_info": {
      "message_type": 10,
      "request_source": 3,
      "source_tid": "fffd4777-e5c4-6efb-4499-a142a60f2533"
    },a
    "outbound_notification_events": [
      
    ],
    "routerId": "",
    "noOfMessages": 1,
    "_nodetid": "1aa6bb5e-b8ae-4337-946c-73dd972c61aa",
    "destinationType": "msisdn",
    "sourceOriginTime": "2022-02-08T14:21:33.127Z",
    "messagePriority": 1,
    "sfeSessionInfo": "transid::fffd4777-e5c4-6efb-4499-a142a60f2533_61_290",
    "api_version": "V1",
    "sourceTid": "fffd4777-e5c4-6efb-4499-a142a60f2533",
    "sfe_dr": 1,
    "mt_trans_date": "2022-02-08 14:21:33.182",
    "evtid": "9",
    "servicekey": "af25dee8-7911-11ec-b012-029bfcf2fec9",
    "apiDestination": "+13392344331",
    "txn_log_level": 2
  },
  "appId": "a_164127120205685060",
  "submittedOn": 1644330093789,
  "x_msg_seq": 0,
  "carrierId": 2021,
  "priority": 1,
  "msisdn": "+13392344331",
  "content": {
    "richCard": {
      "orientation": "vertical",
      "thumbnail": {
        "fileSize": 15860,
        "url": "http://res.cloudinary.com/demo/image/upload/sample.jpg"
      },
      "thumbnailAlignment": "Left",
      "description": "Rich Crad chekcs from 563 S2 Flows ",
      "suggestions": [
        {
          "displayText": "hello",
          "postbackData": "no",
          "type": "reply"
        },
        {
          "displayText": "Phone",
          "postbackData": "Dail",
          "phone": "+918737389393",
          "type": "dialPhone"
        },
        {
          "displayText": "url",
          "postbackData": "broswe",
          "type": "openUrl",
          "url": "https://www.gmail.com"
        }
      ],
      "media": {
        "fileSize": 0,
        "url": "https://stgrtmedia.s3.amazonaws.com/sp09133609/12629363001232297.mp4",
        "height": "MEDIUM"
      },
      "title": "Rich Card 😄😃😀🙂🙃😄😃😀🙂🙃😄😃😀🙂🙃"
    },
    "fileSize": 0,
    "suggestions": [
      
    ],
    "type": "standalone"
  },
  "tid": "1aa6bb5e-b8ae-4337-946c-73dd972c61aa"
}

"dataIntegration": {
    "context": {
      "Message": "",
      "senderNum": "17472126048",
      "keyword": "DISMS"
    },
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "b-3.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9098,b-1.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9098,b-2.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9098",
      "webhookurl": "https://integrations.imiconnect.site/v1/integration/"
    }
  }
}

{
  "extraparams": {
    "notificationurl": "https://requestinspector.com/inspect/01fs3v6zj2se1akh2p698vvnxd",
    "connect_message_id": "da16f041-482c-4e1f-8f0d-aeae9c76a383",
    "messagePriority": 1,
    "channel": 25,
    "destination": "+13392344331",
    "x_req_origin_time": "2022-02-17 07:53:18.714",
    "api_version": "V2",
    "tid": "1c7420f5-70ed-45ae-b881-5dadfff8be8f",
    "sourceTid": "1c7420f5-70ed-45ae-b881-5dadfff8be8f",
    "report_info": {
      "message_type": 11,
      "request_source": 1,
      "source_tid": "1c7420f5-70ed-45ae-b881-5dadfff8be8f"
    },
    "mt_trans_date": "2022-02-17 07:53:18.716",
    "outbound_notification_events": [
      "Sent",
      "Delivered",
      "Read",
      "Failed"
    ],
    "routerId": "",
    "noOfMessages": 1,
    "servicekey": "cd571ab3-785d-11ec-b012-029bfcf2fec9",
    "options": {
      "trackOpens": false,
      "rawEmailViewInBrowser": false,
      "smsFallback": true,
      "bypassSuppression": false,
      "smsSenderId": "12048177155",
      "text": "fallback text",
      "carrierId": 2020,
      "trackClicks": false,
      "shortenLinks": false
    },
    "notifycallbackdata": "abc",
    "destinationType": "msisdn",
    "corelationid": "na1b2b1i1",
    "apiDestination": "+13392344331",
    "txn_log_level": 2
  },
  "appId": "a_164127120205685060",
  "submittedOn": 1645084399048,
  "x_msg_seq": 0,
  "msisdn": "+13392344331",
  "carrierId": 2020,
  "priority": 1,
  "tid": "1c7420f5-70ed-45ae-b881-5dadfff8be8f",
  "content": {
    "cards": [
      {
        "description": "Carousle card new from rule\rs Enter carriage check in AWS NV",
        "suggestions": [
          
        ],
        "media": {
          "fileSize": 12053,
          "url": "http://techslides.com/demos/sample-videos/small.mp4",
          "height": "MEDIUM"
        },
        "title": "Carousel card\t check from API in QA\t with enter carriage"
      },
      {
        "description": "Carousel card",
        "suggestions": [
          
        ],
        "media": {
          "fileSize": 15860,
          "url": "http://res.cloudinary.com/demo/image/upload/sample.jpg",
          "height": "MEDIUM"
        },
        "title": "Carousel card 2\t check from messaging API"
      }
    ],
    "fileSize": 0,
    "width": "MEDIUM",
    "suggestions": [
      {
        "displayText": "Yes",
        "postbackData": "usr_msg_yes",
        "type": "reply"
      },
      {
        "displayText": "Impact",
        "address": "+14165551234",
        "postbackData": "e460dd65-e69b-4f86-a5af-458683248f2d_url_google",
        "latitude": "43.649269",
        "type": "viewLocation",
        "longitude": "-79.378423"
      },
      {
        "displayText": "Share location",
        "postbackData": "e460dd65-e69b-4f86-a5af-458683248f2d_url_google",
        "type": "shareLocation"
      }
    ],
    "type": "carousel"
 "dataIntegration": {
    "context": {
      "Message": "",
      "senderNum": "17472126048",
      "keyword": "DISMS"
    },
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "Dummy_data",
      "webhookurl": ""
    }
  }
}

{
  "extraparams": {
    "authkey": "12a3cd31-afab-4349-9f87-590342f53444",
    "connect_message_id": "cd950c15-0f55-44b6-9a3f-0895b4091301",
    "messagePriority": 1,
    "channel": 25,
    "destination": "13392344331",
    "sfeSessionInfo": "transid::5f628874-9f36-4bae-9b57-4673f09f680d_477_1064",
    "x_req_origin_time": "2022-02-24 04:52:51.935",
    "api_version": "V1",
    "tid": "034fd609-2183-400a-a385-d3385316f820",
    "sid": "40_430",
    "sourceTid": "5f628874-9f36-4bae-9b57-4673f09f680d",
    "report_info": {
      "message_type": 11,
      "request_source": 3,
      "source_tid": "5f628874-9f36-4bae-9b57-4673f09f680d"
    },
    "sfe_dr": 1,
    "mt_trans_date": "2022-02-24 04:52:51.943",
    "outbound_notification_events": [
      
    ],
    "routerId": "",
    "evtid": "9",
    "noOfMessages": 1,
    "servicekey": "cd571ab3-785d-11ec-b012-029bfcf2fec9",
    "_nodetid": "034fd609-2183-400a-a385-d3385316f820",
    "destinationType": "msisdn",
    "apiDestination": "13392344331",
    "sourceOriginTime": "2022-02-24T04:52:51.631Z",
    "txn_log_level": 2
  },
  "appId": "a_164127120205685060",
  "submittedOn": 1645678372797,
  "x_msg_seq": 0,
  "carrierId": 0,
  "msisdn": "13392344331",
  "priority": 1,
  "tid": "034fd609-2183-400a-a385-d3385316f820",
  "content": {
    "cards": [
      {
        "thumbnail": {
          "fileSize": 0,
          "url": "https://pisces.bbystatic.com/image2/BestBuy_US/images/products/5476/5476500_sd.jpg"
        },
        "description": "Carouselcard",
        "suggestions": [
          
        ],
        "media": {
          "fileSize": 0,
          "url": "https://pisces.bbystatic.com/image2/BestBuy_US/images/products/5476/5476500_sd.jpg",
          "height": "MEDIUM"
        },
        "title": "Card1"
      },
      {
        "thumbnail": {
          "fileSize": 0,
          "url": "http://res.cloudinary.com/demo/image/upload/sample.jpg"
        },
        "description": "Carouselcard1",
        "suggestions": [
          
        ],
        "media": {
          "fileSize": 0,
          "url": "http://res.cloudinary.com/demo/image/upload/sample.jpg",
          "height": "MEDIUM"
        },
        "title": "Card2"
      }
    ],
    "fileSize": 0,
    "width": "MEDIUM",
    "suggestions": [
      
    ],
    "type": "carousel"
"dataIntegration": {
    "context": {
      "Message": "",
      "senderNum": "17472126048",
      "keyword": "DISMS"
    },
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "Dummy_data",
      "webhookurl": ""
    }
  }
}

{
  "extraparams": {
    "authkey": "12a3cd31-afab-4349-9f87-590342f53444",
    "connect_message_id": "f3986176-e3ef-421f-ade7-bdcfe5d8a81f",
    "messagePriority": 1,
    "channel": 25,
    "destination": "+13392344331",
    "sfeSessionInfo": "transid::e2754078-9d2b-ae71-c882-0e2395746220_207_852",
    "x_req_origin_time": "2022-02-24 04:49:41.443",
    "api_version": "V1",
    "tid": "b63b369c-b9c5-4cef-890c-1277ef4bd609",
    "sid": "40_233",
    "sourceTid": "e2754078-9d2b-ae71-c882-0e2395746220",
    "report_info": {
      "message_type": 12,
      "request_source": 3,
      "source_tid": "e2754078-9d2b-ae71-c882-0e2395746220"
    },
    "sfe_dr": 1,
    "mt_trans_date": "2022-02-24 04:49:41.444",
    "outbound_notification_events": [
      
    ],
    "routerId": "",
    "evtid": "9",
    "noOfMessages": 1,
    "servicekey": "cd571ab3-785d-11ec-b012-029bfcf2fec9",
    "_nodetid": "b63b369c-b9c5-4cef-890c-1277ef4bd609",
    "destinationType": "msisdn",
    "apiDestination": "+13392344331",
    "sourceOriginTime": "2022-02-24T04:49:40.123Z",
    "txn_log_level": 2
  },
  "appId": "a_164127120205685060",
  "submittedOn": 1645678181775,
  "x_msg_seq": 0,
  "carrierId": 0,
  "msisdn": "+13392344331",
  "priority": 1,
  "tid": "b63b369c-b9c5-4cef-890c-1277ef4bd609",
  "content": {
    "fileSize": 0,
    "event": "IS_TYPING",
    "type": "agentEvent"

"dataIntegration": {
    "context": {
      "Message": "",
      "senderNum": "17472126048",
      "keyword": "DISMS"
    },
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "Dummy_data",
      "webhookurl": ""
    }
  }
}