Routeon OMNIAPI

#### FileMessage Object

| Field | Type | Mandatory | Description |
|--------------------|----------------|-----------|---------------------------------|
| thumbnailFileName | string | No | The file name of the thumbnail. |
| thumbnailUrl | string (url) | No | The URL of the thumbnail. |
| thumbnailMIMEType | string | No | The MIME type of the thumbnail. |
| thumbnailFileSize | integer | No | The size of the thumbnail. |
| fileName | string | No | The file name. |
| fileUrl | string (url) | Yes | The URL of the file. |
| fileMIMEType | string | No | The MIME type of the file. |
| fileSize | integer | No | The size of the file. |

#### AudioMessage Object

| Field | Type | Mandatory | Description |
|----------------|----------------------------------|-----------|-----------------------------------|
| fileName | string | No | The file name. |
| fileUrl | string (url) | Yes | The URL of the file. |
| fileMIMEType | string | No | The MIME type of the file. |
| fileSize | integer | No | The size of the file. |
| playingLength | integer minimum: 1 maximum: 600 | No | The playing length of the audio. |

#### GeolocationPushMessage Object

| Field | Type | Mandatory | Description |
|------------|------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| label | string maxLength: 200 | No | This can be used to tag the nature of the location. |
| timestamp | string(date-time) | No | This is the time when the location information was pushed. |
| expiry | string(date-time) | No | This is an absolute date at which time the recipient is no longer permitted to possess the location information. |
| timeOffset | integer | No | This is the time zone where the location information was pushed, expressed as the number of minutes away from UTC as defined in [RFC4480]. |
| pos | string | Yes | This is the coordinates in WGS 84 (latitude, longitude) decimal notion as described in [RFC5491], providing the latitude and longitude as “double”-encoded decimal numbers (as specified in [GML3.1.1]) representing the degrees, separated by a space starting with the latitude. |
| radius | number | No | The radius of the circle will be represented in meters, which will be indicated by setting the unit of measure attribute of the radius element to the value of EPSG9001 as described in [RFC5491]. |

#### Suggested Chip List Item

The list is an array of objects of the following form:

```json
{
"": {
"": {
"": {

}
},
"displayText": "",
"postback": {
"data": ""
}
}
}
```

1. The `` for a proposed response should be `reply` and for an action it should be `action`.
2. The `` property defines an action and is not present in responses (see below for more information on what actions and action categories are).
3. The `displayText` property specifies the name of the button for this response/action, and for the response this is the response text.
4. In the `postback/data` property, the chatbot specifies arbitrary data that will be sent back to it along with a reply/notification that the user has clicked on the button for this reply/action.

##### Action categories

#### RichcardMessage Object

| Field | Type | Mandatory | Description |
|---------|-------------------|-----------|---------------------------------------------------------|
| layout | Layout Object | Yes | In this section markup and formatting options |
| content | Content Object | Yes | This section contains the contents of the card itself |

##### Layout Object

| Field | Type | Mandatory | Description |
|----------------------|--------------|------------------------------------------|-----------------------------------------------------------------|
| cardOrientation | string | Yes | Card orientation: VERTICAL or HORIZONTAL |
| imageAlignment | string | Yes if "cardOrientation" is "HORIZONTAL" | The position of the media on the horizontal card: LEFT or RIGHT |
| titleFontStyle | string array | No | Header font style: array of italics, bold, underline |
| descriptionFontStyle | string array | No | Header font style: array of italics, bold, underline |
| cardStyle | string | No | Link to CSS describing the card style |

##### Content Object

| Field | Type | Mandatory | Description |
|--------------|---------------------|-----------|---------------------------------------------------------------------------------------------------|
| media | Media Object | No | In this subsection, media content settings |
| title | string | No | Card header |
| description | string | No | Card description/text |
| suggestions | Suggested Chip List | No | A list of suggested responses and/or actions that are drawn inside the card. Maximum of 4 pieces. |

##### Media Object

| Field | Type | Mandatory | Description |
|----------------------|--------------|------------------------------|-------------------------------------------------------------------------------------|
| mediaUrl | string | Yes | URL of the media file |
| mediaContentType | string | Yes | MIME type of the media file |
| mediaFileSize | string | Yes | Media file size in bytes |
| thumbnailUrl | string | No | URL of the thumbnail for the media file |
| thumbnailContentType | string array | Yes if "thumbnailUrl" is set | MIME thumbnail type for the media file |
| thumbnailFileSize | integer | Yes if "thumbnailUrl" is set | Media file thumbnail size in bytes |
| height | integer | Yes | Media height: SHORT_HEIGHT, MEDIUM_HEIGHT or TALL_HEIGHT |
| contentDescription | integer | No | Text description of media content, shown instead of media if it cannot be displayed |

```json
{
"payload": {
"RCSMessage": {
"textMessage": "This is simple text"
}
}
}
```

```json
{
"payload":{
"richcardMessage":{
"message":{
"generalPurposeCard":{
"layout":{
"titleFontStyle":[
"bold"
],
"cardOrientation":"VERTICAL",
"descriptionFontStyle":[
"italic"
]
},
"content":{
"media":{
"height":"SHORT_HEIGHT",
"mediaUrl":"http://62.67.222.59/files/storage/0c68be49-c851-4892-88f7-77bedb7ac2f0/8492d8805e7dfaf5f9a5a0e7282e21eee2099259d359fbf9e48b69c97c26e6ca/pepsi.png",
"thumbnailUrl":"http://62.67.222.59/files/storage/7b8d58dc-865b-4b83-beca-020497713d29/76914f3b37963de292af9cca9de408a3e2ccc0ee9fa6f93a682a3dbd482938aa/thumb",
"mediaFileSize":791264,
"mediaContentType":"image/png",
"thumbnailFileSize":4013,
"thumbnailContentType":"image/png"
},
"title":"Cupidatat non proident",
"description":"Lorem ipsum dolor sit amet",
"suggestions":[
{
"reply":{
"displayText":"Eiusmod tempor incididunt"
}
},
{
"reply":{
"displayText":"Excepteur sint"
}
}
]
}
}
}
}
}
}
```

#### Type `Template`

| Field | Type | Mandatory | Description |
|------------|----------------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| namespace | string | Yes | Namespace associated with WhatsApp Business Account to which the sender's name is assigned |
| name | string | Yes | Template name (pass-through identifier) |
| language | Object Language | Yes | Text message content |
| components | Array of objects Component | No | Template components. They are used to pass variables to be inserted into the corresponding template component. If no variables are provided in the component, the component is not specified. If there are no components with variables in the template, the whole field is not specified. |

#### Field `language`

| Field | Type | Mandatory | Description |
|--------|--------|-----------|-----------------------------------------------------------|
| policy | string | Yes | Language Policy. The only possible value - deterministic. |
| code | string | Yes | Template language. See here for allowed values. |

#### Field `component`

| Field | Type | Mandatory | Description |
|------------|----------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| type | string | Yes | The template component for which the variables are passed. Possible values: header, body, footer, button. Variables for text templates must be passed in the body component. |
| subtype | string | No | Component subtype. Mandatory for a button type component and applicable only to it. Possible values: quick_reply, url. |
| index | integer | No | Button index number in the template, starting from 0. Mandatory for the only button type component to which it is applicable. |
| parameters | Array of objects Parameter | No | Array of variables to be inserted into the corresponding template component. Variables are listed in the same order in which they are numbered in the component. |

#### Type `Parameter`

| Field | Type | Mandatory | Description |
|-----------|-----------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| type | string | Yes | Variable type to be inserted. Possible values: text, currency, date_time, image, document, video, payload. |
| text | string | Yes* | Plain text to be inserted. For buttons of url type - a variable part of the URL. It can be in any component, except for quick_reply buttons. The only parameter type that can be in url type buttons. |
| currency | Object Currency | Yes* | Localizable variable for values in currency to be inserted. It can be in any component except buttons. |
| date_time | Object DateTime | Yes* | Localizable variable for datetime values to be inserted. It can be in any component except buttons. |
| image | Object Media | Yes* | Image variable. It can be in the header component only. |
| document | Object Media | Yes* | PDF document variable. It can be in the header component only. |
| video | Object Media | Yes* | Video variable. It can be in the header component only. |
| payload | string | Yes* | Payload, which is sent back together with the notification when the quick_reply button was tapped. It can only be in quick_reply type buttons . The only parameter type that can be in quick_reply type buttons. |

> *- one of the fields, depending on the variable type.

#### Type `Currency`

| Field | Type | Mandatory | Description |
|----------------|---------|-----------|--------------------------------------------------------------------------------------------------|
| amount_1000 | integer | Yes | Currency amount multiplied by 1000 |
| code | string | Yes | Three-letter currency code |
| fallback_value | string | Yes | The currency amount as plain text in case the data cannot be presented in the recipient`s locale |

#### Type `DateTime`

| Field | Type | Mandatory | Description |
|----------------|---------|-----------|--------------------------------------------------------------------------------------|
| year | integer | Yes* | Year |
| month | integer | Yes* | Month |
| day_of_month | integer | Yes* | Day of the month |
| hour | integer | Yes* | Hour |
| minute | integer | Yes* | Minute |
| day_of_week | integer | Yes | Day of the week (1-7) |
| fallback_value | string | Yes | Date as a plain text, in case the data cannot be presented in the recipient's locale |
| timestamp | integer | No* | Unix timestamp (number of seconds from 00:00 January 1, 1970) |

> *- either timestamp or all other date fields can be specified.

#### Type `text`

| Field | Type | Mandatory | Description |
|-------|--------|-----------|--------------|
| body | string | Yes | Message text |

#### Type `Location`

| Field | Type | Mandatory | Description |
|-----------|--------|-----------|---------------|
| latitude | string | Yes | Latitude |
| longitude | string | Yes | Longitude |
| name | string | No | Location name |
| address | string | No | Address |

#### Type `Media`

| Field | Type | Mandatory | Description |
|----------|--------|-----------|--------------------------------------------------------------|
| link | string | Yes | URL of the file to be uploaded |
| caption | string | No | File description. Not applicable to audio and sticker types. |
| filename | string | No | PDF file name. It applies to document type only. |

```json
{
"contact": "48501923322",
"webhook": "https://example.com/webhooks/status",
"isOtp": false,
"channel": 4,
"senderId": "104594471418892442531",
"payload": {
"recipient_type": "individual",
"type": "template",
"template": {
"namespace": "88b39973_f0d5_54e1_29cf_e80f1e3da4f2",
"name": "movie_ticket_update",
"language": {
"code": "en",
"policy": "deterministic"
},
"components": [
{
"type": "header",
"parameters": [
{
"type": "image",
"image": {
"id": "your-image-id"
}
}
]
},
{
"type": "body",
"parameters": [
{
"type": "text",
"text": "Star Rangers"
},
{
"type": "date_time",
"date_time" : {
"fallback_value": "May 1st, 2019 8:45pm",
"day_of_month": 20,
"year": 2019,
"month": 9,
"hour": 20,
"minute": 45
}
},
{
"type": "text",
"text": "Carnival, Sangam"
},
{
"type": "text",
"text": "Silver"
},
{
"type": "text",
"text": "F6, F7, F8"
}
]
}
]
}
}
}
```

```json
{
"payload": {
"preview_url": true,
"recipient_type": "individual",
"type": "text",
"text": {
"body": "OMNI API whatsapp omni message. Wait for 10 secs."
}
}
}
```

```json
{
"recipient_type": "individual",
"to": "905063565285",
"type": "interactive",
"interactive": {
"type": "button",
"header": {
"type": "image",
"image": {
"link": "https://your-domain.com/files/storage/dev2/9929b7f0-cdc4-4b33-aea3-4c552208d0db/d83626585b711b1992eac2c623011ba7383ccc6dd5c455a3338fbf476f92100d/4b6a3366-97b5-4e50-b1b4-c8d63dafbf19.jpg"
}
},
"body": {
"text": "This is s cat!"
},
"action": {
"buttons": [
{
"type": "reply",
"reply": {
"title": "Are you agree?",
"id": "ID: 0"
}
}
]
}
}
}
```

```json
{
"to": "905063565285",
"type": "image",
"image": {
"link": "https://your-domain.com/files/storage/dev2/0d75dda3-2942-45d6-bbfd-02f37496c6e7/92c2962981b9a8ab6194a5bcc1bcbecb6040a32d0e2d72d4e5c29b67dc1065ce/download%282%29.png"
}
}
```

```json
{
"recipient_type": "individual",
"to": "905063565285",
"type": "location",
"location": {
"longitude": 30.31,
"latitude": 59.94,
"name": "https://www.hermitagemuseum.org/wps/portal/hermitage/",
"address": "Saint-Petersburg"
}
}
```

```json
{
"recipient_type": "individual",
"to": "905063565285",
"type": "interactive",
"interactive": {
"type": "list",
"header": {
"type": "text",
"text": "This is question!"
},
"body": {
"text": "Are you ready?"
},
"footer": {
"text": ""
},
"action": {
"button": "Header",
"sections": [
{
"title": "Answer",
"rows": [
{
"title": "Yes",
"id": "5",
"description": ""
},
{
"title": "No",
"id": "6",
"description": ""
}
]
}
]
}
}
}
```

```json
{
"contact": "alex@example.com",
"webhook": "https://webhook.site/8882947e-cef3-48ea-be43-79f4b8b4a350",
"isOtp": false,
"channel": 7,
"senderId": "email_fromAlex",
"payload": {
"subject": "subject",
"subtitle": "subtitle",
"body": {
"rendered": [
{
"contentType": "html",
"content": "Hello my friend."
}
]
}
}
}
```

```json
{
"contact": "askirilloff@gmail.com",
"webhook": "https://webhook.site/d6afd08a-8064-4b59-9a45-2719fecd8cd3",
"isOtp": false,
"channel": 7,
"senderId": "email_fromAlex",
"payload": {
"subject": "Email subject",
"subtitle": "Email subtitle",
"body": {
"rendered": [
{
"contentType": "html",
"content": "<!--

n n .mj-outlook-group-fix { width:100% !important; }n n @import url(https://fonts.googleapis.com/css?family=Droid+Sans:300,400,500,700);n@import url(https://fonts.googleapis.com/css?family=Roboto:300,400,500,700);n@import url(https://fonts.googleapis.com/css?family=Ubuntu:300,400,500,700);

<!--

Make it easy for everyone to compose emails!

"
}
]
}
}
}
```

```http request
POST /api/v1/messages HTTP/1.1
Host: {{URL}}
X-API-Key: 660046f99d249708e83e1b4bd1f02dc7167b7f6da1d81d73b865de40303cc81e
Content-Type: application/json
Content-Length: 1016

{
"contact": "905063565285",
"channel": 4,
"senderId": "1234567890",
"payload": {
"type": "template",
"template": {
"namespace": "9b6b4fcb_da19_4a26_8fe8_78074a91b584",
"name": "verification_code",
"language": {
"policy": "deterministic",
"code": "en_US"
},
"components": [
{
"type": "body",
"parameters": [
{
"type": "text",
"text": "Booking.com"
},
{
"type": "text",
"text": "56821"
},
{
"type": "text",
"text": "3"
}
]
}
]
}
}
}
```

```http request
POST /api/v1/messages HTTP/1.1
Host: {{URL}}
X-API-Key: 660046f99d249708e83e1b4bd1f02dc7167b7f6da1d81d73b865de40303cc81e
Content-Type: application/json
Content-Length: 2491

{
"contact": "905063565285",
"channel": 4,
"senderId": "1234567890",
"payload": {
"recipient_type": "individual",
"type": "template",
"template": {
"namespace": "88b39973_f0d5_54e1_29cf_e80f1e3da4f2",
"name": "upcoming_trip_reminder",
"language": {
"code": "en",
"policy": "deterministic"
},
"components": [
{
"type": "header",
"parameters": [
{
"type": "text",
"text": "12/26"
}
]
},
{
"type": "body",
"parameters": [
{
"type": "text",
"text": "*Ski Trip*"
},
{
"type": "date_time",
"date_time": {
"fallback_value": "29th July 2019, 8:00am",
"day_of_month": "29",
"year": "2019",
"month": "7",
"hour": "8",
"minute": "00"
}
},
{
"type": "text",
"text": "*Squaw Valley Ski Resort, Tahoe*"
}
]
},
{
"type": "button",
"sub_type": "quick_reply",
"index": 0,
"parameters": [
{
"type": "payload",
"payload": "Yes-Button-Payload"
}
]
},
{
"type": "button",
"sub_type": "quick_reply",
"index": 1,
"parameters": [
{
"type": "payload",
"payload": "No-Button-Payload"
}
]
}
]
}
}
}
```