Object Schemas

​

Introduction

​

Message Content

{
    rcs: RCSMessage | null,
    wa: WhatsAppMessage | null,
    sms: string | null,
    fallbackChain: string[] | null,
}

1. The rcs property is a flexible data structure that specifies the RCS message.
2. The wa property is a JSON object that specifies a valid WhatsApp message structure.
3. The sms property is valid SMS text.
4. You must supply a value for one of the properties; the mandatory property depends on the provider you are sending to.
5. You may supply values for more than one property. For instance, providing a value for sms is required to fall back to SMS.
6. The fallbackChain is an array of Brand Agent IDs. If a message fails for a reason that triggers fallback then the next item in the chain will be tried. The fallback processing can continue until the last item in the chain has been tried.
7. For every agent identified in the fallbackChain there must content for the assocciated provider type. For example if the chain contains an SMS agent then the sms property must be supplied.
8. Each string in the fallbackChain must identify an existing agent. These values are not verified during submit, but they are verified during processing. An invalid entry will terminate fallback processing.
9. The fallbackChain cannot contain any duplicates, and it cannot contain the agentId associated with the send request.

​

Template Content

{
    id: string,
    model: object|null
}

1. The id object must identify an existing template.
2. If the template does not have any parameters, the model does not have to be supplied.
3. If the template has parameters the model contains the name-value pairs to fill in the template.
4. Every template parameter must have an entry in the model.

{
    "id": "welcome-message",
    "model": {
        "firstName": "Bobby",
        "lastName": "McCarthy"
    }
}

​

RCS Message

​

Text message

{
   "contentMessage":{
      "text":"Hello world"
   }
}

​

URL actions

{
   "contentMessage":{
      "text":"What is your favourite colour?",
      "suggestions":[
         {
            "action":{
               "text":"Blue",
               "postbackData": "fav-color-blue",
               "openUrlAction":{
                  "url":"https://www.example.com?fav=blue"
               }
            }
        },
        {
            "action":{
               "text":"Red",
               "postbackData": "fav-colour-red",
               "openUrlAction":{
                  "url":"https://www.example.com?fav=red"
               }
            }
         }
      ]
   }
}