# Send a Messages API message

**POST** `/messages-api/1/messages`

Send messages at scale through multiple channels, utilizing various message types.

## Authentication

- **APIKeyHeader** — API key passed via the `Authorization` header.
- **Basic** — HTTP basic authentication.
- **IBSSOTokenHeader** — API key passed via the `Authorization` header.
- **OAuth2** — OAuth 2.0 bearer token.

## Request Body

Content type: `application/json`

### Text message APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ]
}
```

### Text message with buttons APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        },
        "buttons": [
          {
            "text": "Thank you",
            "postbackData": "thanks",
            "type": "REPLY"
          },
          {
            "text": "I send you more :3",
            "postbackData": "more",
            "type": "REPLY"
          }
        ]
      }
    }
  ]
}
```

### Image message APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/image.jpg",
          "type": "IMAGE"
        }
      }
    }
  ]
}
```

### Video message APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/video.mp4",
          "type": "VIDEO"
        }
      }
    }
  ]
}
```

### Document message APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/document.pdf",
          "type": "DOCUMENT"
        }
      }
    }
  ]
}
```

### Rich link message APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
        }
      ],
      "content": {
        "body": {
          "redirectUrl": "https://example.com",
          "text": "Have a bear-y good day!",
          "url": "https://example.com/image.jpg",
          "isVideo": false,
          "type": "RICH_LINK"
        }
      }
    }
  ]
}
```

### Authentication request message APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
        }
      ],
      "content": {
        "body": {
          "text": "Authentication!",
          "type": "AUTHENTICATION_REQUEST"
        },
        "confirmationBody": {
          "text": "Thank you!",
          "imageUrl": "https://example.com/authenticated.jpg"
        }
      }
    }
  ]
}
```

### List message APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
        }
      ],
      "content": {
        "body": {
          "text": "Welcome to the Safari Adventure Crew!",
          "subtext": "Adjust your trip",
          "sections": [
            {
              "sectionTitle": "Essentials",
              "items": [
                {
                  "text": "Binoculars"
                },
                {
                  "text": "Safari Hat"
                }
              ]
            },
            {
              "sectionTitle": "Animals to Meet",
              "items": [
                {
                  "text": "Elephant"
                },
                {
                  "text": "Zebra"
                }
              ]
            }
          ],
          "type": "LIST"
        },
        "confirmationBody": {
          "text": "Thanks!",
          "imageUrl": "https://example.com/thanks.jpg"
        }
      }
    }
  ]
}
```

### Carousel message APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
        }
      ],
      "content": {
        "body": {
          "cards": [
            {
              "body": {
                "text": "Cuddle with softest otter in the river",
                "url": "https://example.com/image.png",
                "isVideo": false
              },
              "buttons": [
                {
                  "text": "Otter",
                  "url": "https://example.com/otter",
                  "postbackData": "postbackData",
                  "type": "OPEN_URL"
                }
              ]
            }
          ],
          "type": "CAROUSEL"
        }
      }
    }
  ]
}
```

### Sticker message APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
        }
      ],
      "content": {
        "body": {
          "reference": "https://example.com/sticker.webp",
          "type": "STICKER"
        }
      }
    }
  ]
}
```

### Mixed message APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
        }
      ],
      "content": {
        "body": {
          "items": [
            {
              "url": "https://example.com/example1.jpg"
            },
            {
              "url": "https://example.com/example2.jpg"
            },
            {
              "url": "https://example.com/example3.jpg"
            }
          ],
          "type": "MIXED"
        }
      }
    }
  ]
}
```

### Time picker message APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
        }
      ],
      "content": {
        "body": {
          "text": "When do you want to meet?",
          "imageUrl": "https://example.com/image.jpg",
          "event": {
            "title": "Important meeting",
            "timeslots": [
              {
                "duration": 3600,
                "startTime": "2035-05-26T08:30:00Z"
              },
              {
                "duration": 3600,
                "startTime": "2035-05-26T09:30:00Z"
              }
            ],
            "location": {
              "latitude": 44.95305,
              "longitude": 13.85637,
              "radius": 50.0,
              "name": "Infobip d.o.o."
            }
          },
          "type": "TIME_PICKER"
        },
        "confirmationBody": {
          "text": "Thanks!",
          "imageUrl": "https://example.com/thanks.jpg"
        }
      }
    }
  ]
}
```

### Order request message APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
        }
      ],
      "content": {
        "body": {
          "text": "Message text",
          "subtext": "Message subtitle",
          "imageUrl": "https://example.com/image.jpg",
          "order": {
            "items": [
              {
                "name": "Item name",
                "retailerId": "retailerId",
                "amount": 100
              }
            ]
          },
          "payment": {
            "configuration": {
              "merchantDomain": "customMerchantDomain",
              "merchantDisplayName": "customMerchantDisplayName",
              "type": "APPLE_PAY"
            },
            "total": {
              "value": 75,
              "description": "Total description"
            }
          },
          "shippings": [
            {
              "amount": 10,
              "description": "Shipping description",
              "identifier": "identified",
              "label": "label"
            }
          ],
          "type": "ORDER_REQUEST"
        }
      }
    }
  ]
}
```

### Template message with parameters APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "template": {
        "templateName": "binaryChoice.engage.noImage",
        "language": "en-us",
        "referenceId": "referenceId"
      },
      "content": {
        "body": {
          "type": "TEXT",
          "brandName": "Infobip"
        }
      }
    }
  ]
}
```

### Text message with options and webhooks APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "options": {
        "platform": {
          "entityId": "entityId",
          "applicationId": "applicationId"
        },
        "validityPeriod": {
          "amount": 10,
          "timeUnit": "MINUTES"
        },
        "adaptationMode": false,
        "campaignReferenceId": "campaignReferenceId"
      },
      "webhooks": {
        "delivery": {
          "url": "https://example.com/delivery-webhook"
        },
        "callbackData": "callbackData"
      }
    }
  ]
}
```

### Text message with scheduling and URL shortening and tracking APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ],
  "options": {
    "schedule": {
      "bulkId": "bulkId",
      "sendAt": "2025-10-01T00:00:00.000Z"
    },
    "tracking": {
      "shortenUrl": true,
      "trackClicks": true,
      "trackingUrl": "https://example.com/track-url",
      "removeProtocol": true
    }
  }
}
```

### Text message with failover to other channels APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "byChannel": [
            {
              "channel": "APPLE_MB",
              "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
            },
            {
              "channel": "INSTAGRAM_DM",
              "to": "768938852147373"
            },
            {
              "channel": "WHATSAPP",
              "to": "123456789"
            }
          ]
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "failover": [
        {
          "channel": "INSTAGRAM_DM",
          "sender": "17841447232797249"
        },
        {
          "channel": "WHATSAPP",
          "sender": "447491163862",
          "template": {
            "templateName": "givenTemplateName",
            "language": "en"
          }
        }
      ]
    }
  ]
}
```

### Template message with parameters with failover to other channels APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "byChannel": [
            {
              "channel": "APPLE_MB",
              "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
            },
            {
              "channel": "INSTAGRAM_DM",
              "to": "768938852147373"
            },
            {
              "channel": "LINE_ON",
              "to": "123456789"
            }
          ]
        }
      ],
      "template": {
        "templateName": "binaryChoice.engage.noImage",
        "language": "en-us",
        "referenceId": "referenceId"
      },
      "content": {
        "body": {
          "type": "TEXT",
          "brandName": "Infobip"
        }
      },
      "webhooks": {
        "delivery": {
          "url": "https://example.com/delivery-webhook",
          "receiveTriggeredFailoverReports": true
        },
        "callbackData": "callbackData"
      },
      "failover": [
        {
          "channel": "INSTAGRAM_DM",
          "sender": "17841447232797249",
          "content": {
            "body": {
              "text": "Hello, how are you?",
              "type": "TEXT"
            }
          }
        },
        {
          "channel": "LINE_ON",
          "sender": "LINE IB Test",
          "content": {
            "body": {
              "url": "https://example.com/image.jpg",
              "text": "Hello, how are you?",
              "type": "IMAGE"
            }
          }
        }
      ]
    }
  ]
}
```

### Form message APPLE_MB

```json
{
  "messages": [
    {
      "channel": "APPLE_MB",
      "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
      "destinations": [
        {
          "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
        }
      ],
      "content": {
        "body": {
          "text": "Please fill this form to receive absolutely nothing!",
          "imageUrl": "https://example.com/image.jpg",
          "pages": [
            {
              "title": "Welcome to the form!",
              "text": "Please fill all fields.",
              "buttonText": "Proceed to first question",
              "imageUrl": "https://example.com/image.jpg",
              "type": "INTRO"
            },
            {
              "title": "First page",
              "text": "What is your name?",
              "pageIdentifier": "1",
              "nextPageIdentifier": "2",
              "submitForm": false,
              "options": {
                "hintText": "A small hint",
                "placeholder": "Insert your name",
                "isRequired": false,
                "inputType": "SINGLELINE",
                "labelText": "Name",
                "maximumCharacterCount": 30,
                "keyboardType": "DEFAULT",
                "textContentType": "GIVEN_NAME"
              },
              "type": "INPUT"
            },
            {
              "title": "Second page",
              "text": "Pick your favourite animal",
              "pageIdentifier": "2",
              "nextPageIdentifier": "3",
              "items": [
                {
                  "identifier": "2-1",
                  "title": "Dog",
                  "value": "dog"
                },
                {
                  "identifier": "2-2",
                  "title": "Cat",
                  "value": "cat"
                }
              ],
              "submitForm": false,
              "subtext": "Choose an animal",
              "selectedItemIndex": 0,
              "type": "PICKER"
            },
            {
              "title": "Third page",
              "text": "Select two colours of your liking",
              "pageIdentifier": "3",
              "nextPageIdentifier": "4",
              "items": [
                {
                  "identifier": "3-1",
                  "title": "Red",
                  "value": "red"
                },
                {
                  "identifier": "3-2",
                  "title": "Green",
                  "value": "green"
                },
                {
                  "identifier": "3-1",
                  "title": "Blue",
                  "value": "blue"
                }
              ],
              "submitForm": false,
              "multipleSelection": true,
              "type": "SELECT"
            },
            {
              "title": "Fourth page",
              "text": "When is your birthday?",
              "pageIdentifier": "4",
              "submitForm": true,
              "options": {
                "dateFormat": "yyyy-MM-DD",
                "startDate": "2025-01-01T14:00:00Z",
                "maximumDate": "2025-01-01T14:00:00Z",
                "minimumDate": "1900-01-01T14:00:00Z",
                "dateLabel": "Your birthday"
              },
              "type": "DATE_PICKER"
            }
          ],
          "startPageIdentifier": "1",
          "isPrivate": false,
          "showSummary": false,
          "type": "FORM"
        },
        "confirmationBody": {
          "text": "Thank you!",
          "imageUrl": "https://example.com/form.jpg"
        }
      }
    }
  ]
}
```

### Text message INSTAGRAM_DM

```json
{
  "messages": [
    {
      "channel": "INSTAGRAM_DM",
      "sender": "17841447232797249",
      "destinations": [
        {
          "to": "768938852147373"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ]
}
```

### Text message with buttons INSTAGRAM_DM

```json
{
  "messages": [
    {
      "channel": "INSTAGRAM_DM",
      "sender": "17841447232797249",
      "destinations": [
        {
          "to": "768938852147373"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        },
        "buttons": [
          {
            "text": "Thank you",
            "postbackData": "thanks",
            "type": "REPLY"
          },
          {
            "text": "I send you more :3",
            "postbackData": "more",
            "type": "REPLY"
          }
        ]
      }
    }
  ]
}
```

### Image message INSTAGRAM_DM

```json
{
  "messages": [
    {
      "channel": "INSTAGRAM_DM",
      "sender": "17841447232797249",
      "destinations": [
        {
          "to": "768938852147373"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/image.jpg",
          "type": "IMAGE"
        }
      }
    }
  ]
}
```

### Video message INSTAGRAM_DM

```json
{
  "messages": [
    {
      "channel": "INSTAGRAM_DM",
      "sender": "17841447232797249",
      "destinations": [
        {
          "to": "768938852147373"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/video.mp4",
          "type": "VIDEO"
        }
      }
    }
  ]
}
```

### Document message INSTAGRAM_DM

```json
{
  "messages": [
    {
      "channel": "INSTAGRAM_DM",
      "sender": "17841447232797249",
      "destinations": [
        {
          "to": "768938852147373"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/document.pdf",
          "type": "DOCUMENT"
        }
      }
    }
  ]
}
```

### Rich link message INSTAGRAM_DM

```json
{
  "messages": [
    {
      "channel": "INSTAGRAM_DM",
      "sender": "17841447232797249",
      "destinations": [
        {
          "to": "768938852147373"
        }
      ],
      "content": {
        "body": {
          "redirectUrl": "https://example.com",
          "text": "Have a bear-y good day!",
          "url": "https://example.com/image.jpg",
          "isVideo": false,
          "buttonText": "Click here",
          "type": "RICH_LINK"
        }
      }
    }
  ]
}
```

### List message INSTAGRAM_DM

```json
{
  "messages": [
    {
      "channel": "INSTAGRAM_DM",
      "sender": "17841447232797249",
      "destinations": [
        {
          "to": "768938852147373"
        }
      ],
      "content": {
        "body": {
          "text": "Welcome to the Safari Adventure Crew!",
          "subtext": "Adjust your trip",
          "sections": [
            {
              "sectionTitle": "Essentials",
              "items": [
                {
                  "text": "Binoculars"
                },
                {
                  "text": "Safari Hat"
                }
              ]
            },
            {
              "sectionTitle": "Animals to Meet",
              "items": [
                {
                  "text": "Elephant"
                },
                {
                  "text": "Zebra"
                }
              ]
            }
          ],
          "type": "LIST"
        }
      }
    }
  ]
}
```

### Carousel message INSTAGRAM_DM

```json
{
  "messages": [
    {
      "channel": "INSTAGRAM_DM",
      "sender": "17841447232797249",
      "destinations": [
        {
          "to": "768938852147373"
        }
      ],
      "content": {
        "body": {
          "cards": [
            {
              "body": {
                "title": "Otter Plushie",
                "text": "Cuddle with softest otter in the river",
                "url": "https://example.com/image.png",
                "isVideo": false
              },
              "buttons": [
                {
                  "text": "Otter",
                  "url": "https://example.com/otter",
                  "postbackData": "postbackData",
                  "type": "OPEN_URL"
                }
              ]
            },
            {
              "body": {
                "title": "Penguin Plushie",
                "text": "Waddle with adorable penguin friend",
                "url": "https://example.com/image.png",
                "isVideo": false
              },
              "buttons": [
                {
                  "text": "Penguin",
                  "url": "https://example.com/penguin",
                  "postbackData": "postbackData",
                  "type": "OPEN_URL"
                }
              ]
            }
          ],
          "type": "CAROUSEL"
        }
      }
    }
  ]
}
```

### Location message INSTAGRAM_DM

```json
{
  "messages": [
    {
      "channel": "INSTAGRAM_DM",
      "sender": "17841447232797249",
      "destinations": [
        {
          "to": "768938852147373"
        }
      ],
      "content": {
        "body": {
          "latitude": 44.95305,
          "longitude": 13.85637,
          "name": "Infobip d.o.o.",
          "address": "Istarska 157, 52215 Vodnjan, Croatia",
          "type": "LOCATION"
        }
      }
    }
  ]
}
```

### Sticker message INSTAGRAM_DM

```json
{
  "messages": [
    {
      "channel": "INSTAGRAM_DM",
      "sender": "17841447232797249",
      "destinations": [
        {
          "to": "768938852147373"
        }
      ],
      "content": {
        "body": {
          "reference": "https://example.com/sticker.webp",
          "type": "STICKER"
        }
      }
    }
  ]
}
```

### Text message with options and webhooks INSTAGRAM_DM

```json
{
  "messages": [
    {
      "channel": "INSTAGRAM_DM",
      "sender": "17841447232797249",
      "destinations": [
        {
          "to": "768938852147373"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "options": {
        "platform": {
          "entityId": "entityId",
          "applicationId": "applicationId"
        },
        "validityPeriod": {
          "amount": 10,
          "timeUnit": "MINUTES"
        },
        "adaptationMode": false,
        "campaignReferenceId": "campaignReferenceId"
      },
      "webhooks": {
        "delivery": {
          "url": "https://example.com/delivery-webhook"
        },
        "callbackData": "callbackData"
      }
    }
  ]
}
```

### Text message with scheduling and URL shortening and tracking INSTAGRAM_DM

```json
{
  "messages": [
    {
      "channel": "INSTAGRAM_DM",
      "sender": "17841447232797249",
      "destinations": [
        {
          "to": "768938852147373"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ],
  "options": {
    "schedule": {
      "bulkId": "bulkId",
      "sendAt": "2025-10-01T00:00:00.000Z"
    },
    "tracking": {
      "shortenUrl": true,
      "trackClicks": true,
      "trackingUrl": "https://example.com/track-url",
      "removeProtocol": true
    }
  }
}
```

### Text message with failover to other channels INSTAGRAM_DM

```json
{
  "messages": [
    {
      "channel": "INSTAGRAM_DM",
      "sender": "17841447232797249",
      "destinations": [
        {
          "byChannel": [
            {
              "channel": "INSTAGRAM_DM",
              "to": "768938852147373"
            },
            {
              "channel": "LINE_ON",
              "to": "123456789"
            },
            {
              "channel": "WHATSAPP",
              "to": "123456789"
            }
          ]
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "failover": [
        {
          "channel": "LINE_ON",
          "sender": "LINE IB Test"
        },
        {
          "channel": "WHATSAPP",
          "sender": "447491163862",
          "template": {
            "templateName": "givenTemplateName",
            "language": "en"
          }
        }
      ]
    }
  ]
}
```

### Text message LINE_ON

```json
{
  "messages": [
    {
      "channel": "LINE_ON",
      "sender": "LINE IB Test",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ]
}
```

### Text message with buttons LINE_ON

```json
{
  "messages": [
    {
      "channel": "LINE_ON",
      "sender": "LINE IB Test",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        },
        "buttons": [
          {
            "text": "Check vibes",
            "url": "https://example.com/vibes",
            "type": "OPEN_URL"
          }
        ]
      }
    }
  ]
}
```

### Image message LINE_ON

```json
{
  "messages": [
    {
      "channel": "LINE_ON",
      "sender": "LINE IB Test",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/image.jpg",
          "type": "IMAGE"
        }
      }
    }
  ]
}
```

### Video message LINE_ON

```json
{
  "messages": [
    {
      "channel": "LINE_ON",
      "sender": "LINE IB Test",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/video.mp4",
          "type": "VIDEO"
        }
      }
    }
  ]
}
```

### Document message LINE_ON

```json
{
  "messages": [
    {
      "channel": "LINE_ON",
      "sender": "LINE IB Test",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/document.pdf",
          "type": "DOCUMENT"
        }
      }
    }
  ]
}
```

### Location message LINE_ON

```json
{
  "messages": [
    {
      "channel": "LINE_ON",
      "sender": "LINE IB Test",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "latitude": 44.95305,
          "longitude": 13.85637,
          "name": "Infobip d.o.o.",
          "address": "Istarska 157, 52215 Vodnjan, Croatia",
          "type": "LOCATION"
        }
      }
    }
  ]
}
```

### Text message with options and webhooks LINE_ON

```json
{
  "messages": [
    {
      "channel": "LINE_ON",
      "sender": "LINE IB Test",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "options": {
        "platform": {
          "entityId": "entityId",
          "applicationId": "applicationId"
        },
        "validityPeriod": {
          "amount": 10,
          "timeUnit": "MINUTES"
        },
        "adaptationMode": false,
        "campaignReferenceId": "campaignReferenceId"
      },
      "webhooks": {
        "delivery": {
          "url": "https://example.com/delivery-webhook"
        },
        "callbackData": "callbackData"
      }
    }
  ]
}
```

### Text message with scheduling and URL shortening and tracking LINE_ON

```json
{
  "messages": [
    {
      "channel": "LINE_ON",
      "sender": "LINE IB Test",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ],
  "options": {
    "schedule": {
      "bulkId": "bulkId",
      "sendAt": "2025-10-01T00:00:00.000Z"
    },
    "tracking": {
      "shortenUrl": true,
      "trackClicks": true,
      "trackingUrl": "https://example.com/track-url",
      "removeProtocol": true
    }
  }
}
```

### Text message with failover to other channels LINE_ON

```json
{
  "messages": [
    {
      "channel": "LINE_ON",
      "sender": "LINE IB Test",
      "destinations": [
        {
          "byChannel": [
            {
              "channel": "LINE_ON",
              "to": "123456789"
            },
            {
              "channel": "MESSENGER",
              "to": "24060905360217212"
            },
            {
              "channel": "WHATSAPP",
              "to": "123456789"
            }
          ]
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "failover": [
        {
          "channel": "MESSENGER",
          "sender": "731401526720514"
        },
        {
          "channel": "WHATSAPP",
          "sender": "447491163862",
          "template": {
            "templateName": "givenTemplateName",
            "language": "en"
          }
        }
      ]
    }
  ]
}
```

### Text message MESSENGER

```json
{
  "messages": [
    {
      "channel": "MESSENGER",
      "sender": "731401526720514",
      "destinations": [
        {
          "to": "24060905360217212"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ]
}
```

### Text message with buttons MESSENGER

```json
{
  "messages": [
    {
      "channel": "MESSENGER",
      "sender": "731401526720514",
      "destinations": [
        {
          "to": "24060905360217212"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        },
        "buttons": [
          {
            "text": "Thank you",
            "postbackData": "thanks",
            "type": "REPLY"
          },
          {
            "text": "I send you more :3",
            "postbackData": "more",
            "type": "REPLY"
          }
        ]
      }
    }
  ]
}
```

### Image message MESSENGER

```json
{
  "messages": [
    {
      "channel": "MESSENGER",
      "sender": "731401526720514",
      "destinations": [
        {
          "to": "24060905360217212"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/image.jpg",
          "type": "IMAGE"
        }
      }
    }
  ]
}
```

### Video message MESSENGER

```json
{
  "messages": [
    {
      "channel": "MESSENGER",
      "sender": "731401526720514",
      "destinations": [
        {
          "to": "24060905360217212"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/video.mp4",
          "type": "VIDEO"
        }
      }
    }
  ]
}
```

### Document message MESSENGER

```json
{
  "messages": [
    {
      "channel": "MESSENGER",
      "sender": "731401526720514",
      "destinations": [
        {
          "to": "24060905360217212"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/document.pdf",
          "type": "DOCUMENT"
        }
      }
    }
  ]
}
```

### Rich link message MESSENGER

```json
{
  "messages": [
    {
      "channel": "MESSENGER",
      "sender": "731401526720514",
      "destinations": [
        {
          "to": "24060905360217212"
        }
      ],
      "content": {
        "body": {
          "redirectUrl": "https://example.com",
          "text": "Have a bear-y good day!",
          "url": "https://example.com/image.jpg",
          "isVideo": false,
          "buttonText": "Click here",
          "type": "RICH_LINK"
        }
      }
    }
  ]
}
```

### List message MESSENGER

```json
{
  "messages": [
    {
      "channel": "MESSENGER",
      "sender": "731401526720514",
      "destinations": [
        {
          "to": "24060905360217212"
        }
      ],
      "content": {
        "body": {
          "text": "Welcome to the Safari Adventure Crew!",
          "subtext": "Adjust your trip",
          "sections": [
            {
              "sectionTitle": "Essentials",
              "items": [
                {
                  "text": "Binoculars"
                },
                {
                  "text": "Safari Hat"
                }
              ]
            },
            {
              "sectionTitle": "Animals to Meet",
              "items": [
                {
                  "text": "Elephant"
                },
                {
                  "text": "Zebra"
                }
              ]
            }
          ],
          "type": "LIST"
        }
      }
    }
  ]
}
```

### Carousel message MESSENGER

```json
{
  "messages": [
    {
      "channel": "MESSENGER",
      "sender": "731401526720514",
      "destinations": [
        {
          "to": "24060905360217212"
        }
      ],
      "content": {
        "body": {
          "cards": [
            {
              "body": {
                "title": "Otter Plushie",
                "text": "Cuddle with softest otter in the river",
                "url": "https://example.com/image.png",
                "isVideo": false
              },
              "buttons": [
                {
                  "text": "Otter",
                  "url": "https://example.com/otter",
                  "postbackData": "postbackData",
                  "type": "OPEN_URL"
                }
              ]
            },
            {
              "body": {
                "title": "Penguin Plushie",
                "text": "Waddle with adorable penguin friend",
                "url": "https://example.com/image.png",
                "isVideo": false
              },
              "buttons": [
                {
                  "text": "Penguin",
                  "url": "https://example.com/penguin",
                  "postbackData": "postbackData",
                  "type": "OPEN_URL"
                }
              ]
            }
          ],
          "type": "CAROUSEL"
        }
      }
    }
  ]
}
```

### Location message MESSENGER

```json
{
  "messages": [
    {
      "channel": "MESSENGER",
      "sender": "731401526720514",
      "destinations": [
        {
          "to": "24060905360217212"
        }
      ],
      "content": {
        "body": {
          "latitude": 44.95305,
          "longitude": 13.85637,
          "name": "Infobip d.o.o.",
          "address": "Istarska 157, 52215 Vodnjan, Croatia",
          "type": "LOCATION"
        }
      }
    }
  ]
}
```

### Sticker message MESSENGER

```json
{
  "messages": [
    {
      "channel": "MESSENGER",
      "sender": "731401526720514",
      "destinations": [
        {
          "to": "24060905360217212"
        }
      ],
      "content": {
        "body": {
          "reference": "https://example.com/sticker.webp",
          "type": "STICKER"
        }
      }
    }
  ]
}
```

### Text message with options and webhooks MESSENGER

```json
{
  "messages": [
    {
      "channel": "MESSENGER",
      "sender": "731401526720514",
      "destinations": [
        {
          "to": "24060905360217212"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "options": {
        "platform": {
          "entityId": "entityId",
          "applicationId": "applicationId"
        },
        "validityPeriod": {
          "amount": 10,
          "timeUnit": "MINUTES"
        },
        "adaptationMode": false,
        "campaignReferenceId": "campaignReferenceId"
      },
      "webhooks": {
        "delivery": {
          "url": "https://example.com/delivery-webhook"
        },
        "callbackData": "callbackData"
      }
    }
  ]
}
```

### Text message with scheduling and URL shortening and tracking MESSENGER

```json
{
  "messages": [
    {
      "channel": "MESSENGER",
      "sender": "731401526720514",
      "destinations": [
        {
          "to": "24060905360217212"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ],
  "options": {
    "schedule": {
      "bulkId": "bulkId",
      "sendAt": "2025-10-01T00:00:00.000Z"
    },
    "tracking": {
      "shortenUrl": true,
      "trackClicks": true,
      "trackingUrl": "https://example.com/track-url",
      "removeProtocol": true
    }
  }
}
```

### Text message with failover to other channels MESSENGER

```json
{
  "messages": [
    {
      "channel": "MESSENGER",
      "sender": "731401526720514",
      "destinations": [
        {
          "byChannel": [
            {
              "channel": "MESSENGER",
              "to": "24060905360217212"
            },
            {
              "channel": "MMS",
              "to": "123456789"
            },
            {
              "channel": "WHATSAPP",
              "to": "123456789"
            }
          ]
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "failover": [
        {
          "channel": "MMS",
          "sender": "10950"
        },
        {
          "channel": "WHATSAPP",
          "sender": "447491163862",
          "template": {
            "templateName": "givenTemplateName",
            "language": "en"
          }
        }
      ]
    }
  ]
}
```

### Text message MMS

```json
{
  "messages": [
    {
      "channel": "MMS",
      "sender": "10950",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ]
}
```

### Image message MMS

```json
{
  "messages": [
    {
      "channel": "MMS",
      "sender": "10950",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/image.jpg",
          "type": "IMAGE"
        }
      }
    }
  ]
}
```

### Video message MMS

```json
{
  "messages": [
    {
      "channel": "MMS",
      "sender": "10950",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/video.mp4",
          "type": "VIDEO"
        }
      }
    }
  ]
}
```

### Document message MMS

```json
{
  "messages": [
    {
      "channel": "MMS",
      "sender": "10950",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/document.pdf",
          "type": "DOCUMENT"
        }
      }
    }
  ]
}
```

### Rich link message MMS

```json
{
  "messages": [
    {
      "channel": "MMS",
      "sender": "10950",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "redirectUrl": "https://example.com",
          "text": "Have a bear-y good day!",
          "url": "https://example.com/image.jpg",
          "isVideo": false,
          "type": "RICH_LINK"
        }
      }
    }
  ]
}
```

### Carousel message MMS

```json
{
  "messages": [
    {
      "channel": "MMS",
      "sender": "10950",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "cards": [
            {
              "body": {
                "text": "Cuddle with softest otter in the river",
                "url": "https://example.com/image.png",
                "isVideo": false
              },
              "buttons": [
                {
                  "text": "Otter",
                  "url": "https://example.com/otter",
                  "postbackData": "postbackData",
                  "type": "OPEN_URL"
                }
              ]
            }
          ],
          "type": "CAROUSEL"
        }
      }
    }
  ]
}
```

### Location message MMS

```json
{
  "messages": [
    {
      "channel": "MMS",
      "sender": "10950",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "latitude": 44.95305,
          "longitude": 13.85637,
          "name": "Infobip d.o.o.",
          "address": "Istarska 157, 52215 Vodnjan, Croatia",
          "type": "LOCATION"
        }
      }
    }
  ]
}
```

### Sticker message MMS

```json
{
  "messages": [
    {
      "channel": "MMS",
      "sender": "10950",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "reference": "https://example.com/sticker.webp",
          "type": "STICKER"
        }
      }
    }
  ]
}
```

### Mixed message MMS

```json
{
  "messages": [
    {
      "channel": "MMS",
      "sender": "10950",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "items": [
            {
              "url": "https://example.com/example1.jpg",
              "contentId": "example-content-id"
            },
            {
              "text": "Some text",
              "contentId": "example-text-content-id"
            },
            {
              "url": "https://example.com/example3.jpg",
              "contentId": "example-content-id"
            }
          ],
          "type": "MIXED"
        }
      }
    }
  ]
}
```

### Text message with options and webhooks MMS

```json
{
  "messages": [
    {
      "channel": "MMS",
      "sender": "10950",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "options": {
        "platform": {
          "entityId": "entityId",
          "applicationId": "applicationId"
        },
        "validityPeriod": {
          "amount": 10,
          "timeUnit": "MINUTES"
        },
        "adaptationMode": false,
        "campaignReferenceId": "campaignReferenceId"
      },
      "webhooks": {
        "delivery": {
          "url": "https://example.com/delivery-webhook"
        },
        "callbackData": "callbackData"
      }
    }
  ]
}
```

### Text message with scheduling and URL shortening and tracking MMS

```json
{
  "messages": [
    {
      "channel": "MMS",
      "sender": "10950",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ],
  "options": {
    "schedule": {
      "bulkId": "bulkId",
      "sendAt": "2025-10-01T00:00:00.000Z"
    },
    "tracking": {
      "shortenUrl": true,
      "trackClicks": true,
      "trackingUrl": "https://example.com/track-url",
      "removeProtocol": true
    }
  }
}
```

### Text message with failover to other channels MMS

```json
{
  "messages": [
    {
      "channel": "MMS",
      "sender": "10950",
      "destinations": [
        {
          "byChannel": [
            {
              "channel": "MMS",
              "to": "123456789"
            },
            {
              "channel": "RCS",
              "to": "123456789"
            },
            {
              "channel": "WHATSAPP",
              "to": "123456789"
            }
          ]
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "failover": [
        {
          "channel": "RCS",
          "sender": "ibpDemoPly"
        },
        {
          "channel": "WHATSAPP",
          "sender": "447491163862",
          "template": {
            "templateName": "givenTemplateName",
            "language": "en"
          }
        }
      ]
    }
  ]
}
```

### Text message RCS

```json
{
  "messages": [
    {
      "channel": "RCS",
      "sender": "ibpDemoPly",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ]
}
```

### Text message with buttons RCS

```json
{
  "messages": [
    {
      "channel": "RCS",
      "sender": "ibpDemoPly",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        },
        "buttons": [
          {
            "text": "Thank you",
            "postbackData": "thanks",
            "type": "REPLY"
          },
          {
            "text": "I send you more :3",
            "postbackData": "more",
            "type": "REPLY"
          }
        ]
      }
    }
  ]
}
```

### Image message RCS

```json
{
  "messages": [
    {
      "channel": "RCS",
      "sender": "ibpDemoPly",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/image.jpg",
          "type": "IMAGE"
        }
      }
    }
  ]
}
```

### Video message RCS

```json
{
  "messages": [
    {
      "channel": "RCS",
      "sender": "ibpDemoPly",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/video.mp4",
          "type": "VIDEO"
        }
      }
    }
  ]
}
```

### Document message RCS

```json
{
  "messages": [
    {
      "channel": "RCS",
      "sender": "ibpDemoPly",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/document.pdf",
          "type": "DOCUMENT"
        }
      }
    }
  ]
}
```

### Rich link message RCS

```json
{
  "messages": [
    {
      "channel": "RCS",
      "sender": "ibpDemoPly",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "redirectUrl": "https://example.com",
          "text": "Have a bear-y good day!",
          "url": "https://example.com/image.jpg",
          "isVideo": false,
          "buttonText": "Click here",
          "type": "RICH_LINK"
        }
      }
    }
  ]
}
```

### List message RCS

```json
{
  "messages": [
    {
      "channel": "RCS",
      "sender": "ibpDemoPly",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Welcome to the Safari Adventure Crew!",
          "subtext": "Adjust your trip",
          "sections": [
            {
              "sectionTitle": "Essentials",
              "items": [
                {
                  "text": "Binoculars"
                },
                {
                  "text": "Safari Hat"
                }
              ]
            },
            {
              "sectionTitle": "Animals to Meet",
              "items": [
                {
                  "text": "Elephant"
                },
                {
                  "text": "Zebra"
                }
              ]
            }
          ],
          "type": "LIST"
        }
      }
    }
  ]
}
```

### Carousel message RCS

```json
{
  "messages": [
    {
      "channel": "RCS",
      "sender": "ibpDemoPly",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "cards": [
            {
              "body": {
                "title": "Otter Plushie",
                "text": "Cuddle with softest otter in the river",
                "url": "https://example.com/image.png",
                "isVideo": false
              },
              "buttons": [
                {
                  "text": "Otter",
                  "url": "https://example.com/otter",
                  "postbackData": "postbackData",
                  "type": "OPEN_URL"
                }
              ]
            },
            {
              "body": {
                "title": "Penguin Plushie",
                "text": "Waddle with adorable penguin friend",
                "url": "https://example.com/image.png",
                "isVideo": false
              },
              "buttons": [
                {
                  "text": "Penguin",
                  "url": "https://example.com/penguin",
                  "postbackData": "postbackData",
                  "type": "OPEN_URL"
                }
              ]
            }
          ],
          "type": "CAROUSEL"
        }
      }
    }
  ]
}
```

### Location message RCS

```json
{
  "messages": [
    {
      "channel": "RCS",
      "sender": "ibpDemoPly",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "latitude": 44.95305,
          "longitude": 13.85637,
          "name": "Infobip d.o.o.",
          "address": "Istarska 157, 52215 Vodnjan, Croatia",
          "type": "LOCATION"
        }
      }
    }
  ]
}
```

### Template message RCS

```json
{
  "messages": [
    {
      "channel": "RCS",
      "sender": "ibpDemoPly",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "template": {
        "templateName": "templateName"
      }
    }
  ]
}
```

### Template message with parameters RCS

```json
{
  "messages": [
    {
      "channel": "RCS",
      "sender": "ibpDemoPly",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "template": {
        "templateName": "templateName"
      },
      "content": {
        "body": {
          "type": "TEXT",
          "custom_param_1": "Infobip",
          "custom_param_2": "5:30 AM"
        }
      }
    }
  ]
}
```

### Text message with options and webhooks RCS

```json
{
  "messages": [
    {
      "channel": "RCS",
      "sender": "ibpDemoPly",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "options": {
        "platform": {
          "entityId": "entityId",
          "applicationId": "applicationId"
        },
        "validityPeriod": {
          "amount": 10,
          "timeUnit": "MINUTES"
        },
        "adaptationMode": false,
        "campaignReferenceId": "campaignReferenceId"
      },
      "webhooks": {
        "delivery": {
          "url": "https://example.com/delivery-webhook"
        },
        "callbackData": "callbackData",
        "seen": {
          "url": "https://example.com/seen-webhook"
        }
      }
    }
  ]
}
```

### Text message with scheduling and URL shortening and tracking RCS

```json
{
  "messages": [
    {
      "channel": "RCS",
      "sender": "ibpDemoPly",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ],
  "options": {
    "schedule": {
      "bulkId": "bulkId",
      "sendAt": "2025-10-01T00:00:00.000Z"
    },
    "tracking": {
      "shortenUrl": true,
      "trackClicks": true,
      "trackingUrl": "https://example.com/track-url",
      "removeProtocol": true
    }
  }
}
```

### Text message with failover to other channels RCS

```json
{
  "messages": [
    {
      "channel": "RCS",
      "sender": "ibpDemoPly",
      "destinations": [
        {
          "byChannel": [
            {
              "channel": "RCS",
              "to": "123456789"
            },
            {
              "channel": "SMS",
              "to": "123456789"
            },
            {
              "channel": "WHATSAPP",
              "to": "123456789"
            }
          ]
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "failover": [
        {
          "channel": "SMS",
          "sender": "447491163862"
        },
        {
          "channel": "WHATSAPP",
          "sender": "447491163862",
          "template": {
            "templateName": "givenTemplateName",
            "language": "en"
          }
        }
      ]
    }
  ]
}
```

### Template message with parameters with failover to other channels RCS

```json
{
  "messages": [
    {
      "channel": "RCS",
      "sender": "ibpDemoPly",
      "destinations": [
        {
          "byChannel": [
            {
              "channel": "RCS",
              "to": "123456789"
            },
            {
              "channel": "SMS",
              "to": "123456789"
            },
            {
              "channel": "VIBER_BM",
              "to": "123456789"
            }
          ]
        }
      ],
      "template": {
        "templateName": "templateName"
      },
      "content": {
        "body": {
          "type": "TEXT",
          "custom_param_1": "Infobip",
          "custom_param_2": "5:30 AM"
        }
      },
      "webhooks": {
        "delivery": {
          "url": "https://example.com/delivery-webhook",
          "receiveTriggeredFailoverReports": true
        },
        "callbackData": "callbackData"
      },
      "failover": [
        {
          "channel": "SMS",
          "sender": "447491163862",
          "content": {
            "body": {
              "text": "Hello, how are you?",
              "type": "TEXT"
            }
          }
        },
        {
          "channel": "VIBER_BM",
          "sender": "InfobipDemo",
          "content": {
            "body": {
              "url": "https://example.com/image.jpg",
              "text": "Hello, how are you?",
              "type": "IMAGE"
            }
          }
        }
      ]
    }
  ]
}
```

### Text message SMS

```json
{
  "messages": [
    {
      "channel": "SMS",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ]
}
```

### Image message SMS

```json
{
  "messages": [
    {
      "channel": "SMS",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/image.jpg",
          "type": "IMAGE"
        }
      }
    }
  ]
}
```

### Video message SMS

```json
{
  "messages": [
    {
      "channel": "SMS",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/video.mp4",
          "type": "VIDEO"
        }
      }
    }
  ]
}
```

### Document message SMS

```json
{
  "messages": [
    {
      "channel": "SMS",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/document.pdf",
          "type": "DOCUMENT"
        }
      }
    }
  ]
}
```

### Location message SMS

```json
{
  "messages": [
    {
      "channel": "SMS",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "latitude": 44.95305,
          "longitude": 13.85637,
          "name": "Infobip d.o.o.",
          "address": "Istarska 157, 52215 Vodnjan, Croatia",
          "type": "LOCATION"
        }
      }
    }
  ]
}
```

### Text message with options and webhooks SMS

```json
{
  "messages": [
    {
      "channel": "SMS",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "options": {
        "platform": {
          "entityId": "entityId",
          "applicationId": "applicationId"
        },
        "validityPeriod": {
          "amount": 10,
          "timeUnit": "MINUTES"
        },
        "adaptationMode": false,
        "campaignReferenceId": "campaignReferenceId"
      },
      "webhooks": {
        "delivery": {
          "url": "https://example.com/delivery-webhook"
        },
        "callbackData": "callbackData"
      }
    }
  ]
}
```

### Text message with scheduling and URL shortening and tracking SMS

```json
{
  "messages": [
    {
      "channel": "SMS",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ],
  "options": {
    "schedule": {
      "bulkId": "bulkId",
      "sendAt": "2025-10-01T00:00:00.000Z"
    },
    "tracking": {
      "shortenUrl": true,
      "trackClicks": true,
      "trackingUrl": "https://example.com/track-url",
      "removeProtocol": true
    }
  }
}
```

### Text message with failover to other channels SMS

```json
{
  "messages": [
    {
      "channel": "SMS",
      "sender": "447491163862",
      "destinations": [
        {
          "byChannel": [
            {
              "channel": "SMS",
              "to": "123456789"
            },
            {
              "channel": "VIBER_BM",
              "to": "123456789"
            },
            {
              "channel": "WHATSAPP",
              "to": "123456789"
            }
          ]
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "failover": [
        {
          "channel": "VIBER_BM",
          "sender": "InfobipDemo"
        },
        {
          "channel": "WHATSAPP",
          "sender": "447491163862",
          "template": {
            "templateName": "givenTemplateName",
            "language": "en"
          }
        }
      ]
    }
  ]
}
```

### Text message VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ]
}
```

### Text message with buttons VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        },
        "buttons": [
          {
            "text": "Check vibes",
            "url": "https://example.com/vibes",
            "type": "OPEN_URL"
          }
        ]
      }
    }
  ]
}
```

### Image message VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/image.jpg",
          "type": "IMAGE"
        }
      }
    }
  ]
}
```

### Animated GIF image message VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/image.gif",
          "imageFormat": "GIF",
          "type": "IMAGE"
        }
      }
    }
  ]
}
```

### Image message with imageAction and ratio VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/image.jpg",
          "text": "Check out our latest offer",
          "imageAction": "https://www.infobip.com/",
          "ratio": "LANDSCAPE",
          "type": "IMAGE"
        }
      }
    }
  ]
}
```

### Video message VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/video.mp4",
          "thumbnailUrl": "https://example.com/thumbnail.jpg",
          "type": "VIDEO"
        }
      }
    }
  ]
}
```

### Document message VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/document.pdf",
          "filename": "document.pdf",
          "type": "DOCUMENT"
        }
      }
    }
  ]
}
```

### Rich link message VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "redirectUrl": "https://example.com",
          "text": "Have a bear-y good day!",
          "url": "https://example.com/image.jpg",
          "isVideo": false,
          "buttonText": "Click here",
          "type": "RICH_LINK"
        }
      }
    }
  ]
}
```

### Carousel message VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "header": {
          "text": "Check our plushies",
          "type": "TEXT"
        },
        "body": {
          "cards": [
            {
              "body": {
                "text": "Cuddle with softest otter in the river",
                "url": "https://example.com/image.png",
                "isVideo": false
              },
              "buttons": [
                {
                  "text": "Otter",
                  "url": "https://example.com/otter",
                  "postbackData": "postbackData",
                  "type": "OPEN_URL"
                }
              ]
            },
            {
              "body": {
                "text": "Waddle with adorable penguin friend",
                "url": "https://example.com/image.png",
                "isVideo": false
              },
              "buttons": [
                {
                  "text": "Penguin",
                  "url": "https://example.com/penguin",
                  "postbackData": "postbackData",
                  "type": "OPEN_URL"
                }
              ]
            }
          ],
          "type": "CAROUSEL"
        }
      }
    }
  ]
}
```

### Location message VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "latitude": 44.95305,
          "longitude": 13.85637,
          "name": "Infobip d.o.o.",
          "address": "Istarska 157, 52215 Vodnjan, Croatia",
          "type": "LOCATION"
        }
      }
    }
  ]
}
```

### Sticker message VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "reference": "https://example.com/sticker.webp",
          "type": "STICKER"
        }
      }
    }
  ]
}
```

### Template message with parameters VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "template": {
        "templateName": "0aac888f-2ee2-4112-9659-1755a951966a",
        "language": "en"
      },
      "content": {
        "body": {
          "pin": "1234",
          "type": "TEXT"
        }
      }
    }
  ]
}
```

### Text message with options and webhooks VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "options": {
        "platform": {
          "entityId": "entityId",
          "applicationId": "applicationId"
        },
        "validityPeriod": {
          "amount": 10,
          "timeUnit": "MINUTES"
        },
        "adaptationMode": false,
        "campaignReferenceId": "campaignReferenceId"
      },
      "webhooks": {
        "delivery": {
          "url": "https://example.com/delivery-webhook"
        },
        "callbackData": "callbackData",
        "seen": {
          "url": "https://example.com/seen-webhook"
        }
      }
    }
  ]
}
```

### Text message with traffic type option VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "options": {
        "adaptationMode": false,
        "trafficType": "TRANSACTIONAL"
      }
    }
  ]
}
```

### Text message with enabled session rate and primary device only options VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "options": {
        "adaptationMode": false,
        "sessionRate": true,
        "primaryDevice": true
      }
    }
  ]
}
```

### Text message with scheduling and URL shortening and tracking VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ],
  "options": {
    "schedule": {
      "bulkId": "bulkId",
      "sendAt": "2025-10-01T00:00:00.000Z"
    },
    "tracking": {
      "shortenUrl": true,
      "trackClicks": true,
      "trackingUrl": "https://example.com/track-url",
      "removeProtocol": true
    }
  }
}
```

### Text message with failover to other channels VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "byChannel": [
            {
              "channel": "VIBER_BM",
              "to": "123456789"
            },
            {
              "channel": "VIBER_BOT",
              "to": "SirE8dEwjQEda4/VugaE+A=="
            },
            {
              "channel": "WHATSAPP",
              "to": "123456789"
            }
          ]
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "failover": [
        {
          "channel": "VIBER_BOT",
          "sender": "pa:5964217479313231708"
        },
        {
          "channel": "WHATSAPP",
          "sender": "447491163862",
          "template": {
            "templateName": "givenTemplateName",
            "language": "en"
          }
        }
      ]
    }
  ]
}
```

### Template message with parameters with failover to other channels VIBER_BM

```json
{
  "messages": [
    {
      "channel": "VIBER_BM",
      "sender": "InfobipDemo",
      "destinations": [
        {
          "byChannel": [
            {
              "channel": "VIBER_BM",
              "to": "123456789"
            },
            {
              "channel": "VIBER_BOT",
              "to": "SirE8dEwjQEda4/VugaE+A=="
            },
            {
              "channel": "WHATSAPP",
              "to": "123456789"
            }
          ]
        }
      ],
      "template": {
        "templateName": "0aac888f-2ee2-4112-9659-1755a951966a",
        "language": "en"
      },
      "content": {
        "body": {
          "pin": "1234",
          "type": "TEXT"
        }
      },
      "webhooks": {
        "delivery": {
          "url": "https://example.com/delivery-webhook",
          "receiveTriggeredFailoverReports": true
        },
        "callbackData": "callbackData"
      },
      "failover": [
        {
          "channel": "VIBER_BOT",
          "sender": "pa:5964217479313231708",
          "content": {
            "body": {
              "text": "Hello, how are you?",
              "type": "TEXT"
            }
          }
        },
        {
          "channel": "WHATSAPP",
          "sender": "447491163862",
          "content": {
            "body": {
              "url": "https://example.com/image.jpg",
              "text": "Hello, how are you?",
              "type": "IMAGE"
            }
          }
        }
      ]
    }
  ]
}
```

### Text message VIBER_BOT

```json
{
  "messages": [
    {
      "channel": "VIBER_BOT",
      "sender": "pa:5964217479313231708",
      "destinations": [
        {
          "to": "SirE8dEwjQEda4/VugaE+A=="
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ]
}
```

### Text message with senderDisplayInfo VIBER_BOT

```json
{
  "messages": [
    {
      "channel": "VIBER_BOT",
      "sender": "pa:5964217479313231708",
      "destinations": [
        {
          "to": "SirE8dEwjQEda4/VugaE+A=="
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        },
        "senderDisplayInfo": {
          "name": "Company name",
          "avatarUrl": "https://example.com/avatarUrl.jpg"
        }
      }
    }
  ]
}
```

### Text message with buttons VIBER_BOT

```json
{
  "messages": [
    {
      "channel": "VIBER_BOT",
      "sender": "pa:5964217479313231708",
      "destinations": [
        {
          "to": "SirE8dEwjQEda4/VugaE+A=="
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        },
        "buttons": [
          {
            "text": "Thank you",
            "postbackData": "thanks",
            "type": "REPLY"
          },
          {
            "text": "I send you more :3",
            "postbackData": "more",
            "type": "REPLY"
          }
        ]
      }
    }
  ]
}
```

### Image message VIBER_BOT

```json
{
  "messages": [
    {
      "channel": "VIBER_BOT",
      "sender": "pa:5964217479313231708",
      "destinations": [
        {
          "to": "SirE8dEwjQEda4/VugaE+A=="
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/image.jpg",
          "type": "IMAGE"
        }
      }
    }
  ]
}
```

### Video message VIBER_BOT

```json
{
  "messages": [
    {
      "channel": "VIBER_BOT",
      "sender": "pa:5964217479313231708",
      "destinations": [
        {
          "to": "SirE8dEwjQEda4/VugaE+A=="
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/video.mp4",
          "type": "VIDEO"
        }
      }
    }
  ]
}
```

### Document message VIBER_BOT

```json
{
  "messages": [
    {
      "channel": "VIBER_BOT",
      "sender": "pa:5964217479313231708",
      "destinations": [
        {
          "to": "SirE8dEwjQEda4/VugaE+A=="
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/document.pdf",
          "filename": "document.pdf",
          "type": "DOCUMENT"
        }
      }
    }
  ]
}
```

### Rich link message VIBER_BOT

```json
{
  "messages": [
    {
      "channel": "VIBER_BOT",
      "sender": "pa:5964217479313231708",
      "destinations": [
        {
          "to": "SirE8dEwjQEda4/VugaE+A=="
        }
      ],
      "content": {
        "body": {
          "redirectUrl": "https://example.com",
          "text": "Have a bear-y good day!",
          "url": "https://example.com/image.jpg",
          "isVideo": false,
          "buttonText": "Click here",
          "type": "RICH_LINK"
        }
      }
    }
  ]
}
```

### List message VIBER_BOT

```json
{
  "messages": [
    {
      "channel": "VIBER_BOT",
      "sender": "pa:5964217479313231708",
      "destinations": [
        {
          "to": "SirE8dEwjQEda4/VugaE+A=="
        }
      ],
      "content": {
        "body": {
          "text": "Welcome to the Safari Adventure Crew!",
          "subtext": "Adjust your trip",
          "sections": [
            {
              "sectionTitle": "Essentials",
              "items": [
                {
                  "text": "Binoculars"
                },
                {
                  "text": "Safari Hat"
                }
              ]
            },
            {
              "sectionTitle": "Animals to Meet",
              "items": [
                {
                  "text": "Elephant"
                },
                {
                  "text": "Zebra"
                }
              ]
            }
          ],
          "type": "LIST"
        }
      }
    }
  ]
}
```

### Carousel message VIBER_BOT

```json
{
  "messages": [
    {
      "channel": "VIBER_BOT",
      "sender": "pa:5964217479313231708",
      "destinations": [
        {
          "to": "SirE8dEwjQEda4/VugaE+A=="
        }
      ],
      "content": {
        "body": {
          "cards": [
            {
              "body": {
                "title": "Otter Plushie",
                "text": "Cuddle with softest otter in the river",
                "url": "https://example.com/image.png",
                "isVideo": false
              },
              "buttons": [
                {
                  "text": "Otter",
                  "url": "https://example.com/otter",
                  "postbackData": "postbackData",
                  "type": "OPEN_URL"
                }
              ]
            },
            {
              "body": {
                "title": "Penguin Plushie",
                "text": "Waddle with adorable penguin friend",
                "url": "https://example.com/image.png",
                "isVideo": false
              },
              "buttons": [
                {
                  "text": "Penguin",
                  "url": "https://example.com/penguin",
                  "postbackData": "postbackData",
                  "type": "OPEN_URL"
                }
              ]
            }
          ],
          "type": "CAROUSEL"
        }
      }
    }
  ]
}
```

### Location message VIBER_BOT

```json
{
  "messages": [
    {
      "channel": "VIBER_BOT",
      "sender": "pa:5964217479313231708",
      "destinations": [
        {
          "to": "SirE8dEwjQEda4/VugaE+A=="
        }
      ],
      "content": {
        "body": {
          "latitude": 44.95305,
          "longitude": 13.85637,
          "type": "LOCATION"
        }
      }
    }
  ]
}
```

### Contact message VIBER_BOT

```json
{
  "messages": [
    {
      "channel": "VIBER_BOT",
      "sender": "pa:5964217479313231708",
      "destinations": [
        {
          "to": "SirE8dEwjQEda4/VugaE+A=="
        }
      ],
      "content": {
        "body": {
          "name": "Some Something",
          "phoneNumber": "123456789",
          "type": "CONTACT"
        }
      }
    }
  ]
}
```

### Sticker message VIBER_BOT

```json
{
  "messages": [
    {
      "channel": "VIBER_BOT",
      "sender": "pa:5964217479313231708",
      "destinations": [
        {
          "to": "SirE8dEwjQEda4/VugaE+A=="
        }
      ],
      "content": {
        "body": {
          "reference": "40133",
          "type": "STICKER"
        }
      }
    }
  ]
}
```

### Text message with options and webhooks VIBER_BOT

```json
{
  "messages": [
    {
      "channel": "VIBER_BOT",
      "sender": "pa:5964217479313231708",
      "destinations": [
        {
          "to": "SirE8dEwjQEda4/VugaE+A=="
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "options": {
        "platform": {
          "entityId": "entityId",
          "applicationId": "applicationId"
        },
        "validityPeriod": {
          "amount": 10,
          "timeUnit": "MINUTES"
        },
        "adaptationMode": false,
        "campaignReferenceId": "campaignReferenceId"
      },
      "webhooks": {
        "delivery": {
          "url": "https://example.com/delivery-webhook"
        },
        "callbackData": "callbackData",
        "seen": {
          "url": "https://example.com/seen-webhook"
        }
      }
    }
  ]
}
```

### Text message with scheduling and URL shortening and tracking VIBER_BOT

```json
{
  "messages": [
    {
      "channel": "VIBER_BOT",
      "sender": "pa:5964217479313231708",
      "destinations": [
        {
          "to": "SirE8dEwjQEda4/VugaE+A=="
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ],
  "options": {
    "schedule": {
      "bulkId": "bulkId",
      "sendAt": "2025-10-01T00:00:00.000Z"
    },
    "tracking": {
      "shortenUrl": true,
      "trackClicks": true,
      "trackingUrl": "https://example.com/track-url",
      "removeProtocol": true
    }
  }
}
```

### Text message with failover to other channels VIBER_BOT

```json
{
  "messages": [
    {
      "channel": "VIBER_BOT",
      "sender": "pa:5964217479313231708",
      "destinations": [
        {
          "byChannel": [
            {
              "channel": "VIBER_BOT",
              "to": "SirE8dEwjQEda4/VugaE+A=="
            },
            {
              "channel": "WHATSAPP",
              "to": "123456789"
            },
            {
              "channel": "RCS",
              "to": "123456789"
            }
          ]
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "failover": [
        {
          "channel": "WHATSAPP",
          "sender": "447491163862"
        },
        {
          "channel": "RCS",
          "sender": "ibpDemoPly",
          "template": {
            "templateName": "givenTemplateName"
          }
        }
      ]
    }
  ]
}
```

### Text message WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ]
}
```

### Text message with buttons WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        },
        "buttons": [
          {
            "text": "Thank you",
            "postbackData": "thanks",
            "type": "REPLY"
          },
          {
            "text": "I send you more :3",
            "postbackData": "more",
            "type": "REPLY"
          }
        ]
      }
    }
  ]
}
```

### Image message WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/image.jpg",
          "type": "IMAGE"
        }
      }
    }
  ]
}
```

### Video message WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/video.mp4",
          "type": "VIDEO"
        }
      }
    }
  ]
}
```

### Document message WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "url": "https://example.com/document.pdf",
          "type": "DOCUMENT"
        }
      }
    }
  ]
}
```

### Rich link message WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "redirectUrl": "https://example.com",
          "text": "Have a bear-y good day!",
          "url": "https://example.com/image.jpg",
          "isVideo": false,
          "type": "RICH_LINK"
        }
      }
    }
  ]
}
```

### List message WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Welcome to the Safari Adventure Crew!",
          "subtext": "Adjust your trip",
          "sections": [
            {
              "sectionTitle": "Essentials",
              "items": [
                {
                  "text": "Binoculars"
                },
                {
                  "text": "Safari Hat"
                }
              ]
            },
            {
              "sectionTitle": "Animals to Meet",
              "items": [
                {
                  "text": "Elephant"
                },
                {
                  "text": "Zebra"
                }
              ]
            }
          ],
          "type": "LIST"
        }
      }
    }
  ]
}
```

### Carousel message WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "cards": [
            {
              "body": {
                "text": "Cuddle with softest otter in the river",
                "url": "https://example.com/image.png",
                "isVideo": false
              },
              "buttons": [
                {
                  "text": "Otter",
                  "url": "https://example.com/otter",
                  "postbackData": "postbackData",
                  "type": "OPEN_URL"
                }
              ]
            }
          ],
          "type": "CAROUSEL"
        }
      }
    }
  ]
}
```

### Location message WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "latitude": 44.95305,
          "longitude": 13.85637,
          "name": "Infobip d.o.o.",
          "address": "Istarska 157, 52215 Vodnjan, Croatia",
          "type": "LOCATION"
        }
      }
    }
  ]
}
```

### Contact message WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "name": "Some Something",
          "phoneNumber": "123456789",
          "type": "CONTACT"
        }
      }
    }
  ]
}
```

### Sticker message WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "reference": "https://example.com/sticker.webp",
          "type": "STICKER"
        }
      }
    }
  ]
}
```

### Product message WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "header": {
          "text": "Check our products",
          "type": "TEXT"
        },
        "body": {
          "text": "New watches.",
          "catalogId": "3735864913400897",
          "sections": [
            {
              "title": "New watch",
              "productRetailerIds": [
                "pf8e9cpb9u"
              ]
            },
            {
              "title": "Another watch",
              "productRetailerIds": [
                "a92wdavv4a"
              ]
            },
            {
              "title": "Another new watch",
              "productRetailerIds": [
                "5m9rpwuk95"
              ]
            }
          ],
          "type": "PRODUCT"
        }
      }
    }
  ]
}
```

### Flow message WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Share with us your opinion",
          "id": "1049250280482345",
          "token": "tokenForTracking",
          "buttonText": "Click Me!",
          "mode": "PUBLISHED",
          "action": {
            "payload": {
              "screen": "BOOKING_DETAILS"
            },
            "type": "NAVIGATE"
          },
          "type": "FLOW"
        }
      }
    }
  ]
}
```

### Order request message WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Message text",
          "imageUrl": "https://example.com/image.jpg",
          "order": {
            "catalogId": "catalogId",
            "currency": "INR",
            "type": "DIGITAL_GOODS",
            "items": [
              {
                "name": "Item name",
                "retailerId": "retailerId",
                "quantity": 1,
                "amount": 100,
                "saleAmount": 50
              }
            ],
            "expiration": {
              "timestamp": "2024-02-06T14:18:29.797Z",
              "description": "Description of the expiration"
            }
          },
          "payment": {
            "configuration": {
              "id": "paymentId",
              "name": "paymentConfigurationName",
              "productDescription": "description of product in order",
              "customerFirstName": "customerFirstName",
              "customerLastName": "customerLastName",
              "customerEmail": "customerEmail@example.com",
              "callbackData": [
                "callbackData"
              ],
              "type": "UPI_PAYU"
            },
            "total": {
              "value": 75
            },
            "subtotal": 50,
            "tax": {
              "value": 25,
              "description": "Tax description"
            },
            "discount": {
              "value": 10,
              "description": "Discount description"
            }
          },
          "shippings": [
            {
              "amount": 10,
              "description": "Shipping description"
            }
          ],
          "type": "ORDER_REQUEST"
        }
      }
    }
  ]
}
```

### Order status message WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "title": "Message text",
          "id": "orderId",
          "orderType": "UPI_PAYU",
          "orderStatus": "PENDING",
          "type": "ORDER_STATUS"
        }
      }
    }
  ]
}
```

### Template message WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "template": {
        "templateName": "templateName",
        "language": "en"
      }
    }
  ]
}
```

### Template message with parameters WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "template": {
        "templateName": "templateName",
        "language": "en"
      },
      "content": {
        "body": {
          "type": "TEXT",
          "1": "Infobip",
          "2": "5:30 AM"
        }
      }
    }
  ]
}
```

### Template message with named parameters WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "template": {
        "templateName": "templateName",
        "language": "en"
      },
      "content": {
        "body": {
          "type": "TEXT",
          "first_name": "John",
          "appointment_time": "5:30 AM"
        }
      }
    }
  ]
}
```

### Template message with parameters and dynamic URL buttons WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "template": {
        "templateName": "templateName",
        "language": "en"
      },
      "content": {
        "body": {
          "type": "TEXT",
          "1": "Infobip",
          "2": "5:30 AM"
        },
        "buttons": [
          {
            "suffix": "example1",
            "type": "OPEN_URL"
          },
          {
            "suffix": "example2",
            "type": "OPEN_URL"
          }
        ]
      }
    }
  ]
}
```

### Template authentication message with copy code button WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "template": {
        "templateName": "templateName",
        "language": "en"
      },
      "content": {
        "body": {
          "type": "TEXT",
          "1": "Infobip",
          "2": "12345"
        },
        "buttons": [
          {
            "suffix": "12345",
            "type": "OPEN_URL"
          }
        ]
      }
    }
  ]
}
```

### Template carousel message WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "template": {
        "templateName": "templateName",
        "language": "en"
      },
      "content": {
        "body": {
          "cards": [
            {
              "header": {
                "url": "https://example.com/giraffe.jpg",
                "type": "IMAGE"
              },
              "body": {
                "1": "Girafffe"
              },
              "buttons": [
                {
                  "postbackData": "giraffe",
                  "type": "QUICK_REPLY"
                }
              ]
            },
            {
              "header": {
                "url": "https://example.com/zebra.jpg",
                "type": "IMAGE"
              },
              "body": {
                "1": "Zebra"
              },
              "buttons": [
                {
                  "postbackData": "zebra",
                  "type": "QUICK_REPLY"
                }
              ]
            }
          ],
          "type": "CAROUSEL"
        }
      }
    }
  ]
}
```

### Text message with options and webhooks WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "options": {
        "platform": {
          "entityId": "entityId",
          "applicationId": "applicationId"
        },
        "validityPeriod": {
          "amount": 10,
          "timeUnit": "MINUTES"
        },
        "adaptationMode": false,
        "campaignReferenceId": "campaignReferenceId"
      },
      "webhooks": {
        "delivery": {
          "url": "https://example.com/delivery-webhook"
        },
        "callbackData": "callbackData",
        "seen": {
          "url": "https://example.com/seen-webhook"
        }
      }
    }
  ]
}
```

### Text message with scheduling and URL shortening and tracking WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      }
    }
  ],
  "options": {
    "schedule": {
      "bulkId": "bulkId",
      "sendAt": "2025-10-01T00:00:00.000Z"
    },
    "tracking": {
      "shortenUrl": true,
      "trackClicks": true,
      "trackingUrl": "https://example.com/track-url",
      "removeProtocol": true
    }
  }
}
```

### Text message with failover to other channels WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "byChannel": [
            {
              "channel": "WHATSAPP",
              "to": "123456789"
            },
            {
              "channel": "APPLE_MB",
              "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
            },
            {
              "channel": "RCS",
              "to": "123456789"
            }
          ]
        }
      ],
      "content": {
        "body": {
          "text": "Sending you lots of otterly delightful vibes today!",
          "type": "TEXT"
        }
      },
      "failover": [
        {
          "channel": "APPLE_MB",
          "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad"
        },
        {
          "channel": "RCS",
          "sender": "ibpDemoPly",
          "template": {
            "templateName": "givenTemplateName"
          }
        }
      ]
    }
  ]
}
```

### Template message with parameters with failover to other channels WHATSAPP

```json
{
  "messages": [
    {
      "channel": "WHATSAPP",
      "sender": "447491163862",
      "destinations": [
        {
          "byChannel": [
            {
              "channel": "WHATSAPP",
              "to": "123456789"
            },
            {
              "channel": "APPLE_MB",
              "to": "urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0="
            },
            {
              "channel": "INSTAGRAM_DM",
              "to": "768938852147373"
            }
          ]
        }
      ],
      "template": {
        "templateName": "templateName",
        "language": "en"
      },
      "content": {
        "body": {
          "type": "TEXT",
          "1": "Infobip",
          "2": "5:30 AM"
        }
      },
      "webhooks": {
        "delivery": {
          "url": "https://example.com/delivery-webhook",
          "receiveTriggeredFailoverReports": true
        },
        "callbackData": "callbackData"
      },
      "failover": [
        {
          "channel": "APPLE_MB",
          "sender": "e1c86198-d9bf-43ee-a635-7fe9cbcf45ad",
          "content": {
            "body": {
              "text": "Hello, how are you?",
              "type": "TEXT"
            }
          }
        },
        {
          "channel": "INSTAGRAM_DM",
          "sender": "17841447232797249",
          "content": {
            "body": {
              "url": "https://example.com/image.jpg",
              "text": "Hello, how are you?",
              "type": "IMAGE"
            }
          }
        }
      ]
    }
  ]
}
```

### Template message with URL button KAKAO_ALIM

```json
{
  "messages": [
    {
      "channel": "KAKAO_ALIM",
      "sender": "a1213cfb5de2722e67f326cc5162c78b5c48a0d7",
      "destinations": [
        {
          "to": "123456789"
        }
      ],
      "template": {
        "templateName": "TEMPLATE_NAME"
      },
      "content": {
        "body": {
          "type": "TEXT",
          "text": "Your order has been shipped."
        },
        "buttons": [
          {
            "text": "Track your order",
            "url": "https://www.infobip.com",
            "urlPc": "https://www.infobip.com",
            "type": "URL_WITH_TEXT"
          }
        ]
      }
    }
  ]
}
```

### Template message with failover to other channels KAKAO_ALIM

```json
{
  "messages": [
    {
      "channel": "KAKAO_ALIM",
      "sender": "a1213cfb5de2722e67f326cc5162c78b5c48a0d7",
      "destinations": [
        {
          "byChannel": [
            {
              "channel": "KAKAO_ALIM",
              "to": "123456789"
            },
            {
              "channel": "WHATSAPP",
              "to": "123456789"
            }
          ]
        }
      ],
      "template": {
        "templateName": "TEMPLATE_NAME"
      },
      "content": {
        "body": {
          "type": "TEXT",
          "text": "Your order has been shipped."
        }
      },
      "failover": [
        {
          "channel": "WHATSAPP",
          "sender": "447491163862",
          "template": {
            "templateName": "templateName",
            "language": "en"
          },
          "content": {
            "body": {
              "type": "TEXT",
              "1": "Infobip"
            }
          }
        }
      ]
    }
  ]
}
```

## Responses

### 200 OK

Content type: `application/json`

### Successful response

```json
{
  "bulkId": "1688025180464000013",
  "messages": [
    {
      "messageId": "1688025180464000014",
      "status": {
        "groupId": 1,
        "groupName": "PENDING",
        "id": 26,
        "name": "MESSAGE_ACCEPTED",
        "description": "Message sent to next instance"
      },
      "destination": "48600700800"
    }
  ]
}
```

### 400 Bad Request

Content type: `application/json`

### Bad request

```json
{
  "errorCode": "E400",
  "description": "Request cannot be processed.",
  "action": "Check the syntax, violations and adjust the request.",
  "violations": [
    {
      "property": "property.path",
      "violation": "Violation message."
    }
  ],
  "resources": []
}
```

### 401 Unauthorized

Content type: `application/json`

```json
{
  "errorCode": "E401",
  "description": "The request lacks valid authentication credentials for the requested resource.",
  "action": "Check the resources and adjust authentication credentials.",
  "violations": [],
  "resources": [
    {
      "name": "API Authentication",
      "url": "https://www.infobip.com/docs/essentials/api-authentication"
    }
  ]
}
```

### 403 Forbidden

Content type: `application/json`

```json
{
  "errorCode": "E403",
  "description": "Insufficient permissions to access the requested resource.",
  "action": "Repeat the request with new or different credentials.",
  "violations": [],
  "resources": [
    {
      "name": "API Scopes",
      "url": "https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes"
    }
  ]
}
```

### 500 Internal Server Error

Content type: `application/json`

```json
{
  "errorCode": "E500",
  "description": "Something went wrong.",
  "action": "Contact the support.",
  "violations": [],
  "resources": []
}
```

## Schemas

### MessagesApiDescriptiveTotalAmount

Total amount of the order.

- **value** (number, optional) — Value of the amount (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
- **description** (string, optional) — (Apple specific, required) Additional description of the amount.

### MessagesApiMessageFormSelectPageItem

An array of objects defining the user experience.

- **identifier** (string, required) — Unique identifier of the item.
- **title** (string, required) — Title of the item.
- **value** (string, required) — Value of the item.
- **nextPageIdentifier** (string, optional) — Identifier of the next page. Set this value only when multipleSelection is not defined or set to false.
- **imageUrl** (string, optional) — Image of the item.

### SendingSpeedLimit

Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.

- **amount** (integer (int32), required) — The number of messages to be sent per timeUnit. By default, the system sends messages as fast as the infrastructure allows. Use this parameter to adapt sending capacity to your needs. The system is only able to work against its maximum capacity for ambitious message batches.
- **timeUnit** (SpeedLimitTimeUnit, optional) — The time unit to define when setting a messaging speed limit. Defaults to `MINUTE`.
  Possible values: `MINUTE`, `HOUR`, `DAY`

### MessagesApiMessageApplePayPaymentConfiguration

- **type** (MessagesApiMessagePaymentConfigurationType, required)
  Possible values: `PG_PAYU`, `PG_RAZORPAY`, `UPI_PAYU`, `BRAZIL`, `BRAZIL_PIX_DC`, `BRAZIL_LINK`, `BRAZIL_BOLETO`, `UPI_INTENT`, `APPLE_PAY`
- **merchantDomain** (string, optional) — The domain of the merchant's website.
- **merchantDisplayName** (string, optional) — The merchant's display name.
- **merchantPaymentGatewayUrl** (string, optional) — The URL of the merchant's payment gateway. This is the URL that Apple Pay uses to process payments.
- **merchantCountryCode** (string, optional) — The two-letter ISO 3166 merchant’s country code.
- **currencyCode** (string, optional) — The three-letter ISO 4217 currency code for the payment.
- **merchantCapabilities** (MessagesApiMessageApplePayPaymentConfigurationMerchantCapability[], optional) — An array of payment capabilities supported by the merchant. The array must include 3DS.
- **supportedNetworks** (MessagesApiMessageApplePayPaymentConfigurationNetwork[], optional) — An array of payment networks supported by the merchant. The array must include one or more of the following values: AMEX, DISCOVER, MASTERCARD, PRIVATE_LABEL or VISA.
- **requiredBillingFields** (MessagesApiMessageApplePayPaymentConfigurationContactField[], optional) — The list of the customer's required billing information needed to process the transaction.
- **requiredShippingFields** (MessagesApiMessageApplePayPaymentConfigurationContactField[], optional) — The list of shipping or contact information required from the customer to fulfill the order.
- **paymentMethodUpdateUrl** (string, optional) — Called by Apple Pay when the user changes the payment method.
- **shippingContactUpdateUrl** (string, optional) — Called by Apple Pay when the user changes their shipping address information.
- **shippingMethodUpdateUrl** (string, optional) — Called by Apple Pay when the user changes the shipping method.
- **orderTrackingUrl** (string, optional) — Called by Apple Pay after completing the order provides you with an opportunity to update the order information in your system.
- **fallbackUrl** (string, optional) — A URL that opens in a web browser so the user can complete the purchase if their device is unable to make payments using Apple Pay.

### MessagesApiMessageOrderRequestBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **text** (string, optional) — Payment request title.
- **subtext** (string, optional) — (Apple specific) Payment request subtitle
- **imageUrl** (string, optional) — URL of an image sent.
- **order** (MessagesApiMessageOrder, optional) — Payment request order.
  - **catalogId** (string, optional) — (WhatsApp specific) ID that uniquely identifies the [catalog](https://www.infobip.com/docs/api/platform/catalogs-api) registered with Facebook and connected to the WhatsApp Business Account the sender belongs to.
  - **currency** (MessagesApiMessageOrderCurrency, optional) — (WhatsApp specific, required) Order currency.
    Possible values: `INR`, `BRL`
  - **type** (MessagesApiMessageOrderType, optional) — (WhatsApp specific, required) Type of the goods in the order.
    Possible values: `PHYSICAL_GOODS`, `DIGITAL_GOODS`
  - **detailsType** (MessagesApiMessageOrderDetailsType, optional) — (WhatsApp specific) A quick payment option bypassing the review step. Applicable for PG PayU and PG Razorpay.
    Possible values: `QUICK_PAY`
  - **items** (MessagesApiMessageOrderItem[], optional) — An array of items in the order.
    - **name** (string, required) — Name of the item.
    - **retailerId** (string, optional) — (WhatsApp specific, and required) Product-unique identifier, as defined in catalog.
    - **quantity** (integer (int32), optional) — (WhatsApp specific) Item quantity.
    - **amount** (number, required) — Price of the item (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
    - **saleAmount** (number, optional) — (WhatsApp specific) Item discount (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
    - **importer** (MessagesApiMessageOrderImporter, optional) — (WhatsApp specific) Importer data. Required when catalogId is not provided. It's supported only for UPI PayU payments.
      - **name** (string, optional) — Name of the importer. Required when catalogId is not provided.
      - **address** (MessagesApiMessageOrderImporterAddress, optional) — Address of the importer. Required when catalogId is not provided.
        - **firstAddressLine** (string, optional) — First address line.
        - **secondAddressLine** (string, optional) — Second address line.
        - **city** (string, optional) — City name.
        - **zoneCode** (string, optional) — Zone code value.
        - **postalCode** (string, optional) — Zip code value.
        - **countryCode** (string, optional) — Country code value.
      - **originCountry** (string, optional) — Country of origin. Required when catalogId is not provided.
  - **expiration** (MessagesApiMessageOrderExpiration, optional) — (WhatsApp specific) Expiration of the order.
    - **timestamp** (string (date-time), optional) — Timestamp of the expiration. Must be at least 5 minutes in the future.
    - **description** (string, optional) — Description of the expiration.
- **payment** (MessagesApiMessagePayment, optional) — Request payment data.
  - **configuration** (MessagesApiMessagePaymentConfiguration, optional) — Required for WhatsApp, optional for Apple. Type of the payment.
    - **type** (MessagesApiMessagePaymentConfigurationType, required)
      Possible values: `PG_PAYU`, `PG_RAZORPAY`, `UPI_PAYU`, `BRAZIL`, `BRAZIL_PIX_DC`, `BRAZIL_LINK`, `BRAZIL_BOLETO`, `UPI_INTENT`, `APPLE_PAY`
  - **total** (MessagesApiDescriptiveTotalAmount, optional) — Total amount of the order.
    - **value** (number, optional) — Value of the amount (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
    - **description** (string, optional) — (Apple specific, required) Additional description of the amount.
  - **subtotal** (number, optional) — (WhatsApp specific, required) Sub-total amount of the order (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
  - **tax** (MessagesApiMessageDescriptiveTaxAmount, optional) — (WhatsApp specific, required) Tax amount of the order.
    - **value** (number, optional) — Value of the amount (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
    - **description** (string, optional) — Additional description of the amount. Optional for WhatsApp.
  - **discount** (MessagesApiMessageDescriptiveDiscountAmount, optional) — (WhatsApp specific) Discount of the order.
    - **value** (number, optional) — Value of the amount (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
    - **description** (string, optional) — Additional description of the amount. Optional for WhatsApp.
- **shippings** (MessagesApiMessageShipping[], optional) — An array of shipping information. For WhatsApp only one item allowed, for Apple many allowed.
  - **amount** (number, required) — Amount of shipping cost (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
  - **description** (string, optional) — (Apple specific and required) Additional description of shipping cost. Optional for WhatsApp.
  - **identifier** (string, optional) — (Apple specific and required) Client-defined value used to identify this shipping method.
  - **label** (string, optional) — (Apple specific and required) Short description of the shipping method.

### MessagesApiMessageApplePayPaymentConfigurationNetwork

An array of payment networks supported by the merchant. The array must include one or more of the following values: AMEX, DISCOVER, MASTERCARD, PRIVATE_LABEL or VISA.

### MessagesApiCarouselTemplateOpenUrlButton

- **type** (MessagesApiCarouselTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `PHONE_NUMBER`
- **suffix** (string, optional) — Extension of a URL defined in the registered template.

### MessagesApiMessageDocumentBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **url** (string, optional) — URL of the document.
- **text** (string, optional) — Document caption.
- **filename** (string, optional) — Document filename.

### MessageStatus

Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.

- **groupId** (integer (int32), optional) — Status group ID.
- **groupName** (MessageGeneralStatus, optional) — Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).
  Possible values: `ACCEPTED`, `PENDING`, `UNDELIVERABLE`, `DELIVERED`, `EXPIRED`, `REJECTED`
- **id** (integer (int32), optional) — Status code ID.
- **name** (string, optional) — [Status code](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) name.
- **description** (string, optional) — Human-readable description of the status.
- **action** (string, optional) — Action to take to recover from the error.

### MessagesApiTemplate

Details of the template.

- **templateName** (string, required) — Template name or identifier which given channel uses to send a template message.
- **language** (string, optional) — Language of the template.
- **referenceId** (string, optional) — Reference field (used only in Apple) to provide context of what the message is for (e.g. order number, case identifier, etc).
- **groupKey** (string, optional) — Key associated with a group of templates. Used only in KAKAO_ALIM channel for templates registered under a group.

### MessagesApiMessagePaymentConfiguration

Required for WhatsApp, optional for Apple. Type of the payment.

- **type** (MessagesApiMessagePaymentConfigurationType, required)
  Possible values: `PG_PAYU`, `PG_RAZORPAY`, `UPI_PAYU`, `BRAZIL`, `BRAZIL_PIX_DC`, `BRAZIL_LINK`, `BRAZIL_BOLETO`, `UPI_INTENT`, `APPLE_PAY`

### MessagesApiMessageSelectFormPage

- **type** (MessagesApiMessageFormPageType, required)
  Possible values: `INTRO`, `SELECT`, `PICKER`, `DATE_PICKER`, `INPUT`
- **title** (string, optional) — Title of the page.
- **text** (string, optional) — Text of the page.
- **pageIdentifier** (string, optional) — Unique identifier of the page.
- **nextPageIdentifier** (string, optional) — Identifier of the next page. If not set, the client assumes the current page to be the final page.
- **items** (MessagesApiMessageFormSelectPageItem[], optional) — An array of objects defining the user experience.
  - **identifier** (string, required) — Unique identifier of the item.
  - **title** (string, required) — Title of the item.
  - **value** (string, required) — Value of the item.
  - **nextPageIdentifier** (string, optional) — Identifier of the next page. Set this value only when multipleSelection is not defined or set to false.
  - **imageUrl** (string, optional) — Image of the item.
- **submitForm** (boolean, optional) — Placed on the pages to denote the end page of the form. Can be set on multiple pages.
- **multipleSelection** (boolean, optional) — Enables multiple selection for the page.

### MessagesApiMessageOptions

Message options.

- **platform** (Platform, optional) — Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
  - **entityId** (string, optional) — Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
  - **applicationId** (string, optional) — Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
- **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
  - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
  - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
    Possible values: `SECONDS`, `MINUTES`, `HOURS`
- **deliveryTimeWindow** (DeliveryTimeWindow, optional) — Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.
  - **days** (DeliveryDay[], required) — Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
  - **from** (DeliveryTime, optional) — The exact time of the day. The time is expressed in the UTC time zone.
    - **hour** (integer (int32), required) — Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
    - **minute** (integer (int32), required) — Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
  - **to** (DeliveryTime, optional) — The exact time of the day. The time is expressed in the UTC time zone.
    - **hour** (integer (int32), required) — Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
    - **minute** (integer (int32), required) — Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
- **adaptationMode** (boolean, optional) — If channel does not fully support message to be sent, we will try to map it as best effort. This is default behavior, even if this option is not specified.
- **regional** (RegionalOptions, optional) — Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
  - **indiaDlt** (IndiaDltOptions, optional) — Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
    - **contentTemplateId** (string, optional) — Registered DLT content template ID which matches message you are sending.
    - **principalEntityId** (string, required) — Your assigned DLT principal entity ID.
    - **telemarketerId** (string, optional) — Your assigned Telemarketer ID. (required for Aggregators)
  - **turkeyIys** (TurkeyIysOptions, optional) — IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
    - **brandCode** (integer (int32), optional) — Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
    - **recipientType** (RecipientType, required) — Recipient Type must be `TACIR` or `BIREYSEL`.
      Possible values: `BIREYSEL`, `TACIR`
  - **southKorea** (SouthKoreaOptions, optional) — Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
    - **title** (string, optional) — Title of the message.
    - **resellerCode** (integer (int32), optional) — Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.
- **campaignReferenceId** (string, optional) — ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
- **transliteration** (TransliterationCode, optional) — The transliteration of your sent message from one script to another. Transliteration is used to replace characters which are not recognized as part of your defaulted alphabet. Possible values: `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `BULGARIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `PORTUGUESE`, `COLOMBIAN`, and `NON_UNICODE`. Supported by SMS.
  Possible values: `NONE`, `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `NON_UNICODE`, `PORTUGUESE`, `COLOMBIAN`, `BULGARIAN_CYRILLIC`, `ALL`
- **correlationData** (string, optional) — Correlation data included in the outbound message. If provided, it will be returned in the inbound message. Auto-generated if not set explicitly.
- **trafficType** (MessagesApiTrafficType, optional) — Traffic type classification for message sending. Supported by Viber for non-template messages only.
  Possible values: `PROMOTIONAL`, `TRANSACTIONAL`
- **sessionRate** (boolean, optional) — Defines if the message should be charged using session rate. Supported by Viber for content with text/image/document only (without buttons, extra text etc.) body type. For text/image only body types `sessionRate` won't be applied if parameter `primaryDevice` is set to true.
- **primaryDevice** (boolean, optional) — Defines if the message should be sent only to the end user's primary device (phone or tablet). Supported by Viber for message with content with text/image/document only (without buttons, extra text etc.) body type or template message.

### MessagesApiTemplateHeaderType

### MessagesApiWebhooks

Provides options for configuring message webhooks.

- **delivery** (MessagesApiDelivery, optional) — Provides options for configuring the delivery report behavior.
  - **url** (string, optional) — The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/api#notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.
  - **intermediateReport** (boolean, optional) — The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. The default setting is `false`.
  - **receiveTriggeredFailoverReports** (boolean, optional) — Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`.
- **contentType** (string, optional) — Preferred delivery report content type, `application/json` or `application/xml`.
- **callbackData** (string, optional) — Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report and Seen Report. The maximum value is 4000 characters.
- **seen** (SeenStatusReporting, optional) — Provides options for configuring the seen report behavior.
  - **url** (string, optional) — The URL on your call back server where a seen report will be sent.

### MessagesApiUpiIntentPaymentLinkFormat

- **type** (MessagesApiUpiIntentPaymentFormatType, required)
  Possible values: `LINK`
- **paymentLink** (string, optional) — Payment link.

### MessagesApiMessageButtonType

### MessagesApiTemplateVideoHeader

- **type** (MessagesApiTemplateHeaderType, required)
  Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`
- **url** (string, optional) — URL of a video.

### MessagesApiTemplateCarouselCardVideoHeader

- **type** (MessagesApiTemplateCarouselCardHeaderType, required)
  Possible values: `IMAGE`, `VIDEO`
- **url** (string, optional) — URL of a video.

### MessagesApiTemplateCarouselCardHeaderType

### MessagesApiMessageInputFormPageOptions

Options of the page.

- **hintText** (string, optional) — Text to give the user more input context that displays below the Input field.
- **regex** (string, optional) — String representing a JSON encoded regular expression (regex) string to limit the type of input for input field to use.
- **placeholder** (string, optional) — Text string used when there is no other text in the input text field.
- **isRequired** (boolean, optional) — When set to true, the next button on page is disabled until the user provides input.
- **inputType** (MessagesApiMessageInputFormInputType, optional) — Type of input.
  Possible values: `SINGLELINE`, `MULTILINE`
- **labelText** (string, optional) — Text label shown to identify the input field. Applicable only for SINGLELINE input type.
- **prefixText** (string, optional) — String value representing optional text shown next to the text field. Applicable only for SINGLELINE input type.
- **maximumCharacterCount** (integer (int32), optional) — Maximum field size in characters.
- **keyboardType** (MessagesApiMessageInputFormPageKeyboard, optional) — Type of keyboard to be shown.
  Possible values: `DEFAULT`, `ASCII_CAPABLE`, `NUMBERS_AND_PUNCTUATION`, `URL`, `NUMBER_PAD`, `PHONE_PAD`, `NAME_PHONE_PAD`, `EMAIL_ADDRESS`, `DECIMAL_PAD`, `TWITTER_KEYBOARD`, `WEB_SEARCH`
- **textContentType** (MessagesApiMessageInputFormPageTextContentType, optional) — Value representing the keyboard and system information about the expected semantic meaning for the content that users enter.
  Possible values: `NAME_PREFIX`, `GIVEN_NAME`, `MIDDLE_NAME`, `FAMILY_NAME`, `NAME_SUFFIX`, `NICKNAME`, `JOB_TITLE`, `ORGANIZATION_NAME`, `LOCATION`, `FULL_STREET_ADDRESS`, `STREET_ADDRESS_LINE_1`, `STREET_ADDRESS_LINE_2`, `ADDRESS_CITY`, `ADDRESS_STATE`, `ADDRESS_CITY_STATE`, `SUBLOCALITY`, `COUNTRY_NAME`, `POSTAL_CODE`, `PHONE_NUMBER`, `EMAIL_ADDRESS`, `URL`, `CREDIT_CARD_NUMBER`, `USERNAME`, `PASSWORD`, `NEW_PASSWORD`, `ONE_TIME_CODE`

### ApiError

- **errorCode** (string, required) — An error code uniquely identifying the error case.
- **description** (string, required) — A detailed description of an error.
- **action** (string, required) — An action that should be taken to recover from the error.
- **violations** (ApiErrorViolation[], required) — List of violations that caused the error.
  - **property** (string, optional) — Request property that caused the error.
  - **violation** (string, optional) — Detailed violation description.
- **resources** (ApiErrorResource[], required) — List of available resources to recover from the error.
  - **name** (string, optional) — Resource name.
  - **url** (string, optional) — Resource URL.

### MessagesApiMessageProductSection

An array of product sections. Header and title fields are required in case of multiple products.

- **title** (string, optional) — The title of the section. Required, if the message has more than one section.
- **productRetailerIds** (string[], required) — Unique product identifier, as defined in catalog.

### MessagesApiMessageListSection

Section's list.

- **sectionTitle** (string, required) — Section's title
- **multipleSelection** (boolean, optional) — Multiple Selection.
- **items** (MessagesApiMessageListItem[], required) — List Items.
  - **id** (string, optional) — Item ID (supported only by WhatsApp), has to be unique for each item.
  - **text** (string, required) — Item Text.
  - **description** (string, optional) — Item Description.
  - **imageUrl** (string, optional) — Item's Image URL.

### MessagesApiMessageCarouselCardBody

Body of a card.

- **title** (string, optional) — Title of the card.
- **text** (string, optional) — Text to be sent.
- **url** (string, optional) — URL of the card's media. It can be image or video. When you provide it with `isVideo=true` then it will be mapped as a video, otherwise - as an image.
- **isVideo** (boolean, optional) — Indicates if provided `url` is a video.
- **thumbnailUrl** (string, optional) — URL of the thumbnail image. If you add this, then we use as thumbnail image for video you provided in `url`. Applicable only when `isVideo=true`.
- **cardOptions** (MessagesApiMessageCardOptions, optional) — Set of alignment options for the Card.
  - **orientation** (MessagesApiMessageCardOptionsOrientationEnum, optional) — Orientation of the card.
    Possible values: `HORIZONTAL`, `VERTICAL`
  - **alignment** (MessagesApiMessageCardOptionsAlignmentEnum, optional) — Alignment of the card.
    Possible values: `LEFT`, `RIGHT`
  - **height** (MessagesApiMessageCardOptionsHeightEnum, optional) — Height of the card media.
    Possible values: `SHORT`, `MEDIUM`, `TALL`

### ApiErrorResource

List of available resources to recover from the error.

- **name** (string, optional) — Resource name.
- **url** (string, optional) — Resource URL.

### MessagesApiMessageFlowBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **text** (string, optional) — Text to be sent.
- **id** (string, optional) — ID of the flow.
- **token** (string, optional) — Token of the flow.
- **buttonText** (string, optional) — Button label text.
- **mode** (MessagesApiMessageFlowMode, optional) — Mode of the flow.
  Possible values: `DRAFT`, `PUBLISHED`
- **action** (MessagesApiMessageFlowAction, optional) — Action of the flow.
  - **type** (MessagesApiMessageFlowActionType, required)
    Possible values: `NAVIGATE`, `DATA_EXCHANGE`

### MessagesApiMessageReplyButton

- **type** (MessagesApiMessageButtonType, required)
  Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
- **text** (string, optional) — Text to be displayed on the button.
- **postbackData** (string, optional) — Custom data that will be sent to you when the user replies to the message.

### MessagesApiMessageButton

List of buttons of the message.

- **type** (MessagesApiMessageButtonType, required)
  Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`

### MessagesApiMessagePayment

Request payment data.

- **configuration** (MessagesApiMessagePaymentConfiguration, optional) — Required for WhatsApp, optional for Apple. Type of the payment.
  - **type** (MessagesApiMessagePaymentConfigurationType, required)
    Possible values: `PG_PAYU`, `PG_RAZORPAY`, `UPI_PAYU`, `BRAZIL`, `BRAZIL_PIX_DC`, `BRAZIL_LINK`, `BRAZIL_BOLETO`, `UPI_INTENT`, `APPLE_PAY`
- **total** (MessagesApiDescriptiveTotalAmount, optional) — Total amount of the order.
  - **value** (number, optional) — Value of the amount (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
  - **description** (string, optional) — (Apple specific, required) Additional description of the amount.
- **subtotal** (number, optional) — (WhatsApp specific, required) Sub-total amount of the order (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
- **tax** (MessagesApiMessageDescriptiveTaxAmount, optional) — (WhatsApp specific, required) Tax amount of the order.
  - **value** (number, optional) — Value of the amount (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
  - **description** (string, optional) — Additional description of the amount. Optional for WhatsApp.
- **discount** (MessagesApiMessageDescriptiveDiscountAmount, optional) — (WhatsApp specific) Discount of the order.
  - **value** (number, optional) — Value of the amount (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
  - **description** (string, optional) — Additional description of the amount. Optional for WhatsApp.

### MessagesApiMessageFlowMode

Mode of the flow.

### MessagesApiTemplateButton

List of buttons of a template message. Supported `type` values depend on `channel`: `WHATSAPP` supports QUICK_REPLY, OPEN_URL, PHONE_NUMBER, FLOW, COPY_CODE, CATALOG, MULTI_PRODUCT; `KAKAO_ALIM` supports URL_WITH_TEXT, APP_LINK, BOT_KEYWORD, CHATBOT_SWITCH, DELIVERY_TRACKING, MESSAGE_DELIVERY, ADD_CHANNEL.

- **type** (MessagesApiTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`

### MessagesApiMessageShipping

An array of shipping information. For WhatsApp only one item allowed, for Apple many allowed.

- **amount** (number, required) — Amount of shipping cost (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
- **description** (string, optional) — (Apple specific and required) Additional description of shipping cost. Optional for WhatsApp.
- **identifier** (string, optional) — (Apple specific and required) Client-defined value used to identify this shipping method.
- **label** (string, optional) — (Apple specific and required) Short description of the shipping method.

### MessagesApiRequestOptions

Options applicable to all messages in the request.

- **schedule** (RequestSchedulingSettings, optional) — Options for scheduling a message.
  - **bulkId** (string, optional) — Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response.
  - **sendAt** (string (date-time), optional) — Date and time when the message is to be sent. Used for scheduled messages. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, and can only be scheduled for no later than 180 days in advance.
  - **sendingSpeedLimit** (SendingSpeedLimit, optional) — Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.
    - **amount** (integer (int32), required) — The number of messages to be sent per timeUnit. By default, the system sends messages as fast as the infrastructure allows. Use this parameter to adapt sending capacity to your needs. The system is only able to work against its maximum capacity for ambitious message batches.
    - **timeUnit** (SpeedLimitTimeUnit, optional) — The time unit to define when setting a messaging speed limit. Defaults to `MINUTE`.
      Possible values: `MINUTE`, `HOUR`, `DAY`
- **tracking** (UrlOptions, optional) — Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature. Does not apply to channels that do not support it: Instagram, LINE, Messenger, Viber Bot.
  - **shortenUrl** (boolean, optional) — Enable shortening of the URLs within a message. Set this to `true`, if you want to set up other URL options.
  - **trackClicks** (boolean, optional) — Enable tracking of short URL clicks within a message: which URL was clicked, how many times, and by whom.
  - **trackingUrl** (string, optional) — The URL of your callback server on to which the Click report will be sent.
  - **removeProtocol** (boolean, optional) — Remove a protocol, such as `https://`, from links to shorten a message. Note that some mobiles may not recognize such links as a URL.
  - **customDomain** (string, optional) — Select a predefined custom domain to use when generating a short URL.
- **messageOrdering** (MessageOrderingOptions, optional) — Message ordering options.
  - **respectOrder** (boolean, optional) — If set to `true`, messages will be sent in the same order as they are provided in the request.
  - **stopOnFailure** (boolean, optional) — It can be used in combination with `respectOrder` to stop sending messages when first message from request fails.

### MessagesApiTemplateChatbotSwitchButton

- **type** (MessagesApiTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
- **text** (string, optional) — Text to be displayed on the button.
- **chatExtra** (string, optional) — Additional metadata passed to the chatbot.
- **chatEvent** (string, optional) — Chatbot event name to trigger.

### MessagesApiMessageConfirmationBody

Body of the confirmation message.

- **text** (string, required) — Text to be sent.
- **description** (string, optional) — Description to be sent.
- **imageUrl** (string, optional) — URL of the image.

### MessagesApiMessageBrazilPaymentConfiguration

- **type** (MessagesApiMessagePaymentConfigurationType, required)
  Possible values: `PG_PAYU`, `PG_RAZORPAY`, `UPI_PAYU`, `BRAZIL`, `BRAZIL_PIX_DC`, `BRAZIL_LINK`, `BRAZIL_BOLETO`, `UPI_INTENT`, `APPLE_PAY`
- **id** (string, optional) — Unique identifier of the payment. It can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters
- **name** (string, optional) — Name of the WhatsApp payment configuration to be used for this order.

### MessagesApiMessageListItem

List Items.

- **id** (string, optional) — Item ID (supported only by WhatsApp), has to be unique for each item.
- **text** (string, required) — Item Text.
- **description** (string, optional) — Item Description.
- **imageUrl** (string, optional) — Item's Image URL.

### MessagesApiBaseFailover

Provides options for configuring a message failover. When message fails it will be sent over channels in order specified in an array. It has to contain unique entries per channel and it cannot contain entry with the same channel as original message. **Make sure to provide correct sender and destinations specified as `Channels Destination` for each channel**.

*oneOf:*

- **Option 1** (MessagesApiFailover)
  - **channel** (OutboundMessageChannel, required) — Messaging channel used for sending a message.
    Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`
  - **sender** (string, optional) — Sender for channel specified above.
  - **content** (MessagesApiMessageContent, optional) — Content of the message.
    - **header** (MessagesApiMessageHeader, optional) — Header of the message.
      - **type** (MessagesApiMessageHeaderType, required)
        Possible values: `TEXT`
    - **body** (MessagesApiMessageBody, required) — Body of the message.
      - **type** (MessagesApiMessageBodyType, required)
        Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
    - **buttons** (MessagesApiMessageButton[], optional) — List of buttons of the message.
      - **type** (MessagesApiMessageButtonType, required)
        Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
    - **confirmationBody** (MessagesApiMessageConfirmationBody, optional) — Body of the confirmation message.
      - **text** (string, required) — Text to be sent.
      - **description** (string, optional) — Description to be sent.
      - **imageUrl** (string, optional) — URL of the image.
    - **senderDisplayInfo** (MessagesApiMessageSenderDisplayInfo, optional) — Sender display info (name and avatar). Used only for Viber Bot messages.
      - **name** (string, optional) — The sender's name to display.
      - **avatarUrl** (string, optional) — The sender's avatar URL.
    - **footer** (MessagesApiMessageFooter, optional) — Footer of the message.
      - **text** (string, required) — Text of the footer.
  - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
    - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
    - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
      Possible values: `SECONDS`, `MINUTES`, `HOURS`
- **Option 2** (MessagesApiTemplateFailover)
  - **channel** (OutboundTemplateChannel, required) — Messaging channel used for sending a template message.
    Possible values: `APPLE_MB`, `RCS`, `VIBER_BM`, `WHATSAPP`, `KAKAO_ALIM`
  - **sender** (string, optional) — Sender for channel specified above.
  - **template** (MessagesApiTemplate, required) — Details of the template.
    - **templateName** (string, required) — Template name or identifier which given channel uses to send a template message.
    - **language** (string, optional) — Language of the template.
    - **referenceId** (string, optional) — Reference field (used only in Apple) to provide context of what the message is for (e.g. order number, case identifier, etc).
    - **groupKey** (string, optional) — Key associated with a group of templates. Used only in KAKAO_ALIM channel for templates registered under a group.
  - **content** (MessagesApiTemplateMessageContent, optional) — Content of the message.
    - **header** (MessagesApiTemplateHeader, optional) — Header of a template message.
      - **type** (MessagesApiTemplateHeaderType, required)
        Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`
    - **body** (MessagesApiTemplateBody, optional) — Body of a template message.
      - **type** (MessagesApiTemplateBodyType, required)
        Possible values: `TEXT`, `CAROUSEL`
    - **buttons** (MessagesApiTemplateButton[], optional) — List of buttons of a template message. Supported `type` values depend on `channel`: `WHATSAPP` supports QUICK_REPLY, OPEN_URL, PHONE_NUMBER, FLOW, COPY_CODE, CATALOG, MULTI_PRODUCT; `KAKAO_ALIM` supports URL_WITH_TEXT, APP_LINK, BOT_KEYWORD, CHATBOT_SWITCH, DELIVERY_TRACKING, MESSAGE_DELIVERY, ADD_CHANNEL.
      - **type** (MessagesApiTemplateButtonType, required)
        Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
    - **expirationTime** (string, optional) — Expiration time of a limited-time offer template message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
  - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
    - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
    - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
      Possible values: `SECONDS`, `MINUTES`, `HOURS`


### MessagesApiMessageImageRatio

Image aspect ratio. Supported only by `VIBER_BM`.

### MessagesApiMessagePaymentConfigurationType

### MessagesApiMessageUpiPayuPaymentConfiguration

- **type** (MessagesApiMessagePaymentConfigurationType, required)
  Possible values: `PG_PAYU`, `PG_RAZORPAY`, `UPI_PAYU`, `BRAZIL`, `BRAZIL_PIX_DC`, `BRAZIL_LINK`, `BRAZIL_BOLETO`, `UPI_INTENT`, `APPLE_PAY`
- **id** (string, optional) — Unique identifier of the payment.
- **name** (string, optional) — Name of the WhatsApp payment configuration to be used for this order.
- **productDescription** (string, optional) — Brief description of products in this order.
- **customerFirstName** (string, optional) — Customer's first name.
- **customerLastName** (string, optional) — Customer's last name.
- **customerEmail** (string (email), optional) — Customer's email.
- **callbackData** (string[], optional) — List of custom parameters corresponding to the transaction.

### MessagesApiTemplateBotKeywordButton

- **type** (MessagesApiTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
- **text** (string, optional) — Text to be displayed on the button.

### MessagesApiTemplateBodyType

### MessagesApiMessageFlowActionPayload

Payload of the action.

- **screen** (string, required) — ID of the first screen of the flow.
- **data** (object, optional) — Input data for first screen of the flow. Must be a non-empty object.

### MessagesApiTemplateQuickReplyButton

- **type** (MessagesApiTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
- **postbackData** (string, optional) — Custom client data that will be included in a user's response.

### MessagesApiCarouselTemplateButton

List of buttons of a card.

- **type** (MessagesApiCarouselTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `PHONE_NUMBER`

### ValidityPeriod

Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.

- **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
- **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
  Possible values: `SECONDS`, `MINUTES`, `HOURS`

### MessagesApiMessageTextBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **text** (string, optional) — Text to be sent.

### MessagesApiMessageFormBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **text** (string, optional) — Text of the received message.
- **imageUrl** (string, optional) — Image of the received message.
- **pages** (MessagesApiMessageFormPage[], optional) — An array of different pages to be shown in the form. If INTRO page is included it will always appear first.
  - **type** (MessagesApiMessageFormPageType, required)
    Possible values: `INTRO`, `SELECT`, `PICKER`, `DATE_PICKER`, `INPUT`
- **startPageIdentifier** (string, optional) — Identifier for the starting page of the form. Must match one of the string identifiers for the configured pages.
- **isPrivate** (boolean, optional) — Indicates whether to mark the response as private.
- **showSummary** (boolean, optional) — If set to true then it shows the summary of all the selections made within the form.

### OutboundMessageChannel

Messaging channel used for sending a message.

### MessageOrderingOptions

Message ordering options.

- **respectOrder** (boolean, optional) — If set to `true`, messages will be sent in the same order as they are provided in the request.
- **stopOnFailure** (boolean, optional) — It can be used in combination with `respectOrder` to stop sending messages when first message from request fails.

### MessagesApiTemplateImageHeader

- **type** (MessagesApiTemplateHeaderType, required)
  Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`
- **url** (string, optional) — URL of an image.

### MessagesApiMessageOrderDetailsType

(WhatsApp specific) A quick payment option bypassing the review step. Applicable for PG PayU and PG Razorpay.

### MessagesApiTemplateFlowButton

- **type** (MessagesApiTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
- **token** (string, optional) — Flow token.
- **data** (object, optional) — Message action payload data. JSON object with the data payload for the first screen

### ApiErrorViolation

List of violations that caused the error.

- **property** (string, optional) — Request property that caused the error.
- **violation** (string, optional) — Detailed violation description.

### MessagesApiMessageRichLinkBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **redirectUrl** (string, optional) — URL to be redirected to.
- **text** (string, optional) — Text to be sent.
- **url** (string, optional) — URL of the rich link. It can be image or video. When you provide it with `isVideo=true` then it will be mapped as a video, otherwise - as an image.
- **isVideo** (boolean, optional) — Indicates if provided `url` is a video.
- **thumbnailUrl** (string, optional) — URL of the thumbnail image. If you add this, then we use as thumbnail image for video you provided in `url`. Applicable only when `isVideo=true`.
- **buttonText** (string, optional) — Button label text.
- **cardOptions** (MessagesApiMessageCardOptions, optional) — Set of alignment options for the Card.
  - **orientation** (MessagesApiMessageCardOptionsOrientationEnum, optional) — Orientation of the card.
    Possible values: `HORIZONTAL`, `VERTICAL`
  - **alignment** (MessagesApiMessageCardOptionsAlignmentEnum, optional) — Alignment of the card.
    Possible values: `LEFT`, `RIGHT`
  - **height** (MessagesApiMessageCardOptionsHeightEnum, optional) — Height of the card media.
    Possible values: `SHORT`, `MEDIUM`, `TALL`

### MessagesApiTemplateCarouselBody

- **type** (MessagesApiTemplateBodyType, required)
  Possible values: `TEXT`, `CAROUSEL`
- **cards** (MessagesApiTemplateCarouselCard[], optional) — Carousel cards.
  - **header** (MessagesApiTemplateCarouselCardHeader, required) — Header of a card.
    - **type** (MessagesApiTemplateCarouselCardHeaderType, required)
      Possible values: `IMAGE`, `VIDEO`
  - **body** (object, optional) — Body of a card.
  - **buttons** (MessagesApiCarouselTemplateButton[], optional) — List of buttons of a card.
    - **type** (MessagesApiCarouselTemplateButtonType, required)
      Possible values: `QUICK_REPLY`, `OPEN_URL`, `PHONE_NUMBER`

### DeliveryTimeWindow

Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.

- **days** (DeliveryDay[], required) — Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
- **from** (DeliveryTime, optional) — The exact time of the day. The time is expressed in the UTC time zone.
  - **hour** (integer (int32), required) — Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
  - **minute** (integer (int32), required) — Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
- **to** (DeliveryTime, optional) — The exact time of the day. The time is expressed in the UTC time zone.
  - **hour** (integer (int32), required) — Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
  - **minute** (integer (int32), required) — Minute when the time window opens when used in the `from` property or closes when used in the `to` property.

### MessagesApiMessageFlowActionType

### MessagesApiMessageFlowAction

Action of the flow.

- **type** (MessagesApiMessageFlowActionType, required)
  Possible values: `NAVIGATE`, `DATA_EXCHANGE`

### MessagesApiMessageApplePayPaymentConfigurationContactField

The list of shipping or contact information required from the customer to fulfill the order.

### MessagesApiMessageCardOptions

Set of alignment options for the Card.

- **orientation** (MessagesApiMessageCardOptionsOrientationEnum, optional) — Orientation of the card.
  Possible values: `HORIZONTAL`, `VERTICAL`
- **alignment** (MessagesApiMessageCardOptionsAlignmentEnum, optional) — Alignment of the card.
  Possible values: `LEFT`, `RIGHT`
- **height** (MessagesApiMessageCardOptionsHeightEnum, optional) — Height of the card media.
  Possible values: `SHORT`, `MEDIUM`, `TALL`

### MessagesApiMessageFooter

Footer of the message.

- **text** (string, required) — Text of the footer.

### MessagesApiMessageImageBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **url** (string, optional) — URL of the image.
- **text** (string, optional) — Image caption.
- **imageFormat** (MessagesApiMessageImageFormat, optional) — Image format. Use `GIF` to enable animated GIF rendering. Supported only by `VIBER_BM`.
  Possible values: `GIF`, `IMG`
- **imageAction** (string, optional) — URL opened when the user taps the image. Only supported for the VIBER_BM channel, for image messages with text (content.header, content.body.text or content.footer), optionally with a button. It is independent of the button URL. If omitted, image taps use the button URL.
- **ratio** (MessagesApiMessageImageRatio, optional) — Image aspect ratio. Supported only by `VIBER_BM`.
  Possible values: `SQUARE`, `PORTRAIT`, `LANDSCAPE`

### MessagesApiTemplateOpenUrlButton

- **type** (MessagesApiTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
- **suffix** (string, optional) — Extension of a URL defined in the registered template. Used only in channel WHATSAPP.

### MessagesApiMessageDescriptiveDiscountAmount

(WhatsApp specific) Discount of the order.

- **value** (number, optional) — Value of the amount (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
- **description** (string, optional) — Additional description of the amount. Optional for WhatsApp.

### ValidityPeriodTimeUnit

Message validity period time unit.

### MessagesApiTemplateFailover

Configuration of a single failover step

- **channel** (OutboundTemplateChannel, required) — Messaging channel used for sending a template message.
  Possible values: `APPLE_MB`, `RCS`, `VIBER_BM`, `WHATSAPP`, `KAKAO_ALIM`
- **sender** (string, optional) — Sender for channel specified above.
- **template** (MessagesApiTemplate, required) — Details of the template.
  - **templateName** (string, required) — Template name or identifier which given channel uses to send a template message.
  - **language** (string, optional) — Language of the template.
  - **referenceId** (string, optional) — Reference field (used only in Apple) to provide context of what the message is for (e.g. order number, case identifier, etc).
  - **groupKey** (string, optional) — Key associated with a group of templates. Used only in KAKAO_ALIM channel for templates registered under a group.
- **content** (MessagesApiTemplateMessageContent, optional) — Content of the message.
  - **header** (MessagesApiTemplateHeader, optional) — Header of a template message.
    - **type** (MessagesApiTemplateHeaderType, required)
      Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`
  - **body** (MessagesApiTemplateBody, optional) — Body of a template message.
    - **type** (MessagesApiTemplateBodyType, required)
      Possible values: `TEXT`, `CAROUSEL`
  - **buttons** (MessagesApiTemplateButton[], optional) — List of buttons of a template message. Supported `type` values depend on `channel`: `WHATSAPP` supports QUICK_REPLY, OPEN_URL, PHONE_NUMBER, FLOW, COPY_CODE, CATALOG, MULTI_PRODUCT; `KAKAO_ALIM` supports URL_WITH_TEXT, APP_LINK, BOT_KEYWORD, CHATBOT_SWITCH, DELIVERY_TRACKING, MESSAGE_DELIVERY, ADD_CHANNEL.
    - **type** (MessagesApiTemplateButtonType, required)
      Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
  - **expirationTime** (string, optional) — Expiration time of a limited-time offer template message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
- **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
  - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
  - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
    Possible values: `SECONDS`, `MINUTES`, `HOURS`

### MessagesApiMessageOrderImporter

(WhatsApp specific) Importer data. Required when catalogId is not provided. It's supported only for UPI PayU payments.

- **name** (string, optional) — Name of the importer. Required when catalogId is not provided.
- **address** (MessagesApiMessageOrderImporterAddress, optional) — Address of the importer. Required when catalogId is not provided.
  - **firstAddressLine** (string, optional) — First address line.
  - **secondAddressLine** (string, optional) — Second address line.
  - **city** (string, optional) — City name.
  - **zoneCode** (string, optional) — Zone code value.
  - **postalCode** (string, optional) — Zip code value.
  - **countryCode** (string, optional) — Country code value.
- **originCountry** (string, optional) — Country of origin. Required when catalogId is not provided.

### MessagesApiOpenUrlButtonOpenIn

Options available for RCS. Type of the URL open application. It is used to define how URL will be opened on a mobile phone. If it is not specified or if device does not support webviews, URL will be opened using browser. Following options are available:
* `BROWSER`: Browser will be used on a mobile phone to open URL.
* `WEBVIEW_FULL`: Integrated webview window will be used on a mobile phone to open URL. The web page takes up the full screen on a mobile phone.
* `WEBVIEW_HALF`: Integrated webview window will be used on a mobile phone to open URL. The web page takes up half of the screen on a mobile phone.
* `WEBVIEW_TALL`: Integrated webview window will be used on a mobile phone to open URL. The web page takes up three quarters of the screen on a mobile phone.

### MessagesApiMessageOrderStatusOrderStatus

Status of the order.

### OutboundTemplateChannel

Messaging channel used for sending a template message.

### SeenStatusReporting

Provides options for configuring the seen report behavior.

- **url** (string, optional) — The URL on your call back server where a seen report will be sent.

### IndiaDltOptions

Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.

- **contentTemplateId** (string, optional) — Registered DLT content template ID which matches message you are sending.
- **principalEntityId** (string, required) — Your assigned DLT principal entity ID.
- **telemarketerId** (string, optional) — Your assigned Telemarketer ID. (required for Aggregators)

### SpeedLimitTimeUnit

The time unit to define when setting a messaging speed limit. Defaults to `MINUTE`.

### MessagesApiMessagePickerFormPage

- **type** (MessagesApiMessageFormPageType, required)
  Possible values: `INTRO`, `SELECT`, `PICKER`, `DATE_PICKER`, `INPUT`
- **title** (string, optional) — Title of the page.
- **text** (string, optional) — Text of the page.
- **pageIdentifier** (string, optional) — Unique identifier of the page.
- **nextPageIdentifier** (string, optional) — Identifier of the next page. If not set, the client assumes the current page to be the final page.
- **items** (MessagesApiMessageFormPickerPageItem[], optional) — An array of objects defining the user experience.
  - **identifier** (string, required) — Unique identifier of the item.
  - **title** (string, required) — Title of the item.
  - **value** (string, required) — Value of the item.
- **submitForm** (boolean, optional) — Placed on the pages to denote the end page of the form. Can be set on multiple pages.
- **subtext** (string, optional) — Text shown next to the picker text field.
- **selectedItemIndex** (integer (int32), optional) — A zero-indexed number identifying the item in the picker wheel should be selected by default.

### MessagesApiUpiIntentPaymentFormatType

### MessagesApiMessageAddCalendarEventButton

- **type** (MessagesApiMessageButtonType, required)
  Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
- **text** (string, optional) — Text to be displayed on the button.
- **postbackData** (string, optional) — Custom data that will be sent to you when the user replies to the message.
- **startTime** (string (date-time), optional) — Event start time. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
- **endTime** (string (date-time), optional) — Event end time. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
- **title** (string, optional) — Event title.
- **description** (string, optional) — Event description.

### MessagesApiTemplateTextHeader

Key value pairs that will be replaced during message sending in a header. For channel WHATSAPP, all keys must be either only numerical or only lowercase letters and underscores. Valid examples `{"1": "John", "type": "TEXT"}` and `{"first_name": "John", "type": "TEXT"}`.

- **type** (MessagesApiTemplateHeaderType, required)
  Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`

### MessagesApiMessage

Represents a single message.

- **channel** (OutboundMessageChannel, required) — Messaging channel used for sending a message.
  Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`
- **sender** (string, optional) — The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
- **destinations** (MessageDestination[], required) — Array of destination objects for where messages are being sent. A valid destination is required. **`Channels Destination` is required when sending messages with defined failover.**
  *oneOf:*

  - **Option 1** (MessagesApiChannelsDestination)
    - **messageId** (string, optional) — The ID that uniquely identifies the message sent. If failover is defined, then it will override values provided in `byChannel` array and be applied to each message in failover flow.
    - **byChannel** (MessagesApiChannelDestination[], required) — An array of substitute destinations, each associated with a specific `channel`. Only one substitute destination is allowed per `channel`. A substitute destination must be provided for the main `channel` defined in the `message`.
      - **channel** (Channel, required)
        Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`, `KAKAO_ALIM`
      - **to** (string, required) — The destination address of the message associated with given channel. It can be alphanumeric or numeric.
      - **messageId** (string, optional) — The ID that uniquely identifies the message sent.
  - **Option 2** (MessagesApiToDestination)
    - **to** (string, required) — The destination address of the message. It can be alphanumeric or numeric.
    - **messageId** (string, optional) — The ID that uniquely identifies the message sent.

- **content** (MessagesApiMessageContent, required) — Content of the message.
  - **header** (MessagesApiMessageHeader, optional) — Header of the message.
    - **type** (MessagesApiMessageHeaderType, required)
      Possible values: `TEXT`
  - **body** (MessagesApiMessageBody, required) — Body of the message.
    - **type** (MessagesApiMessageBodyType, required)
      Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
  - **buttons** (MessagesApiMessageButton[], optional) — List of buttons of the message.
    - **type** (MessagesApiMessageButtonType, required)
      Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
  - **confirmationBody** (MessagesApiMessageConfirmationBody, optional) — Body of the confirmation message.
    - **text** (string, required) — Text to be sent.
    - **description** (string, optional) — Description to be sent.
    - **imageUrl** (string, optional) — URL of the image.
  - **senderDisplayInfo** (MessagesApiMessageSenderDisplayInfo, optional) — Sender display info (name and avatar). Used only for Viber Bot messages.
    - **name** (string, optional) — The sender's name to display.
    - **avatarUrl** (string, optional) — The sender's avatar URL.
  - **footer** (MessagesApiMessageFooter, optional) — Footer of the message.
    - **text** (string, required) — Text of the footer.
- **options** (MessagesApiMessageOptions, optional) — Message options.
  - **platform** (Platform, optional) — Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
    - **entityId** (string, optional) — Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
    - **applicationId** (string, optional) — Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
  - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
    - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
    - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
      Possible values: `SECONDS`, `MINUTES`, `HOURS`
  - **deliveryTimeWindow** (DeliveryTimeWindow, optional) — Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.
    - **days** (DeliveryDay[], required) — Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
    - **from** (DeliveryTime, optional) — The exact time of the day. The time is expressed in the UTC time zone.
      - **hour** (integer (int32), required) — Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
      - **minute** (integer (int32), required) — Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
    - **to** (DeliveryTime, optional) — The exact time of the day. The time is expressed in the UTC time zone.
      - **hour** (integer (int32), required) — Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
      - **minute** (integer (int32), required) — Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
  - **adaptationMode** (boolean, optional) — If channel does not fully support message to be sent, we will try to map it as best effort. This is default behavior, even if this option is not specified.
  - **regional** (RegionalOptions, optional) — Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
    - **indiaDlt** (IndiaDltOptions, optional) — Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
      - **contentTemplateId** (string, optional) — Registered DLT content template ID which matches message you are sending.
      - **principalEntityId** (string, required) — Your assigned DLT principal entity ID.
      - **telemarketerId** (string, optional) — Your assigned Telemarketer ID. (required for Aggregators)
    - **turkeyIys** (TurkeyIysOptions, optional) — IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
      - **brandCode** (integer (int32), optional) — Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
      - **recipientType** (RecipientType, required) — Recipient Type must be `TACIR` or `BIREYSEL`.
        Possible values: `BIREYSEL`, `TACIR`
    - **southKorea** (SouthKoreaOptions, optional) — Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
      - **title** (string, optional) — Title of the message.
      - **resellerCode** (integer (int32), optional) — Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.
  - **campaignReferenceId** (string, optional) — ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
  - **transliteration** (TransliterationCode, optional) — The transliteration of your sent message from one script to another. Transliteration is used to replace characters which are not recognized as part of your defaulted alphabet. Possible values: `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `BULGARIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `PORTUGUESE`, `COLOMBIAN`, and `NON_UNICODE`. Supported by SMS.
    Possible values: `NONE`, `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `NON_UNICODE`, `PORTUGUESE`, `COLOMBIAN`, `BULGARIAN_CYRILLIC`, `ALL`
  - **correlationData** (string, optional) — Correlation data included in the outbound message. If provided, it will be returned in the inbound message. Auto-generated if not set explicitly.
  - **trafficType** (MessagesApiTrafficType, optional) — Traffic type classification for message sending. Supported by Viber for non-template messages only.
    Possible values: `PROMOTIONAL`, `TRANSACTIONAL`
  - **sessionRate** (boolean, optional) — Defines if the message should be charged using session rate. Supported by Viber for content with text/image/document only (without buttons, extra text etc.) body type. For text/image only body types `sessionRate` won't be applied if parameter `primaryDevice` is set to true.
  - **primaryDevice** (boolean, optional) — Defines if the message should be sent only to the end user's primary device (phone or tablet). Supported by Viber for message with content with text/image/document only (without buttons, extra text etc.) body type or template message.
- **webhooks** (MessagesApiWebhooks, optional) — Provides options for configuring message webhooks.
  - **delivery** (MessagesApiDelivery, optional) — Provides options for configuring the delivery report behavior.
    - **url** (string, optional) — The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/api#notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.
    - **intermediateReport** (boolean, optional) — The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. The default setting is `false`.
    - **receiveTriggeredFailoverReports** (boolean, optional) — Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`.
  - **contentType** (string, optional) — Preferred delivery report content type, `application/json` or `application/xml`.
  - **callbackData** (string, optional) — Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report and Seen Report. The maximum value is 4000 characters.
  - **seen** (SeenStatusReporting, optional) — Provides options for configuring the seen report behavior.
    - **url** (string, optional) — The URL on your call back server where a seen report will be sent.
- **failover** (MessagesApiBaseFailover[], optional) — Provides options for configuring a message failover. When message fails it will be sent over channels in order specified in an array. It has to contain unique entries per channel and it cannot contain entry with the same channel as original message. **Make sure to provide correct sender and destinations specified as `Channels Destination` for each channel**.
  *oneOf:*

  - **Option 1** (MessagesApiFailover)
    - **channel** (OutboundMessageChannel, required) — Messaging channel used for sending a message.
      Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`
    - **sender** (string, optional) — Sender for channel specified above.
    - **content** (MessagesApiMessageContent, optional) — Content of the message.
      - **header** (MessagesApiMessageHeader, optional) — Header of the message.
        - **type** (MessagesApiMessageHeaderType, required)
          Possible values: `TEXT`
      - **body** (MessagesApiMessageBody, required) — Body of the message.
        - **type** (MessagesApiMessageBodyType, required)
          Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
      - **buttons** (MessagesApiMessageButton[], optional) — List of buttons of the message.
        - **type** (MessagesApiMessageButtonType, required)
          Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
      - **confirmationBody** (MessagesApiMessageConfirmationBody, optional) — Body of the confirmation message.
        - **text** (string, required) — Text to be sent.
        - **description** (string, optional) — Description to be sent.
        - **imageUrl** (string, optional) — URL of the image.
      - **senderDisplayInfo** (MessagesApiMessageSenderDisplayInfo, optional) — Sender display info (name and avatar). Used only for Viber Bot messages.
        - **name** (string, optional) — The sender's name to display.
        - **avatarUrl** (string, optional) — The sender's avatar URL.
      - **footer** (MessagesApiMessageFooter, optional) — Footer of the message.
        - **text** (string, required) — Text of the footer.
    - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
      - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
      - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
        Possible values: `SECONDS`, `MINUTES`, `HOURS`
  - **Option 2** (MessagesApiTemplateFailover)
    - **channel** (OutboundTemplateChannel, required) — Messaging channel used for sending a template message.
      Possible values: `APPLE_MB`, `RCS`, `VIBER_BM`, `WHATSAPP`, `KAKAO_ALIM`
    - **sender** (string, optional) — Sender for channel specified above.
    - **template** (MessagesApiTemplate, required) — Details of the template.
      - **templateName** (string, required) — Template name or identifier which given channel uses to send a template message.
      - **language** (string, optional) — Language of the template.
      - **referenceId** (string, optional) — Reference field (used only in Apple) to provide context of what the message is for (e.g. order number, case identifier, etc).
      - **groupKey** (string, optional) — Key associated with a group of templates. Used only in KAKAO_ALIM channel for templates registered under a group.
    - **content** (MessagesApiTemplateMessageContent, optional) — Content of the message.
      - **header** (MessagesApiTemplateHeader, optional) — Header of a template message.
        - **type** (MessagesApiTemplateHeaderType, required)
          Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`
      - **body** (MessagesApiTemplateBody, optional) — Body of a template message.
        - **type** (MessagesApiTemplateBodyType, required)
          Possible values: `TEXT`, `CAROUSEL`
      - **buttons** (MessagesApiTemplateButton[], optional) — List of buttons of a template message. Supported `type` values depend on `channel`: `WHATSAPP` supports QUICK_REPLY, OPEN_URL, PHONE_NUMBER, FLOW, COPY_CODE, CATALOG, MULTI_PRODUCT; `KAKAO_ALIM` supports URL_WITH_TEXT, APP_LINK, BOT_KEYWORD, CHATBOT_SWITCH, DELIVERY_TRACKING, MESSAGE_DELIVERY, ADD_CHANNEL.
        - **type** (MessagesApiTemplateButtonType, required)
          Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
      - **expirationTime** (string, optional) — Expiration time of a limited-time offer template message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
    - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
      - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
      - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
        Possible values: `SECONDS`, `MINUTES`, `HOURS`


### MessagesApiMessageMixedMediaItem

Supported by APPLE_MB, MMS

- **url** (string, required) — URL of the media's item.
- **contentId** (string, optional) — Custom content identifier for the media item. Supported by MMS only (Apple ignores).

### MessagesApiMessageOpenUrlButton

- **type** (MessagesApiMessageButtonType, required)
  Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
- **text** (string, optional) — Text to be displayed on the button.
- **url** (string, optional) — URL to be opened when clicked on the button.
- **postbackData** (string, optional) — Custom data that will be sent to you when the user replies to the message.
- **openIn** (MessagesApiOpenUrlButtonOpenIn, optional) — Options available for RCS. Type of the URL open application. It is used to define how URL will be opened on a mobile phone. If it is not specified or if device does not support webviews, URL will be opened using browser. Following options are available:
* `BROWSER`: Browser will be used on a mobile phone to open URL.
* `WEBVIEW_FULL`: Integrated webview window will be used on a mobile phone to open URL. The web page takes up the full screen on a mobile phone.
* `WEBVIEW_HALF`: Integrated webview window will be used on a mobile phone to open URL. The web page takes up half of the screen on a mobile phone.
* `WEBVIEW_TALL`: Integrated webview window will be used on a mobile phone to open URL. The web page takes up three quarters of the screen on a mobile phone.
  Possible values: `BROWSER`, `WEBVIEW_FULL`, `WEBVIEW_HALF`, `WEBVIEW_TALL`

### MessageResponseDetails

Other details of the message.

### MessagesApiTemplateMessageDeliveryButton

- **type** (MessagesApiTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
- **text** (string, optional) — Text to be displayed on the button.

### MessagesApiTemplateButtonType

### MessagesApiMessageHeaderType

### MessagesApiCarouselTemplateQuickReplyButton

- **type** (MessagesApiCarouselTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `PHONE_NUMBER`
- **postbackData** (string, optional) — Custom client data that will be included in a user's response.

### MessageDestination

Array of destination objects for where messages are being sent. A valid destination is required. **`Channels Destination` is required when sending messages with defined failover.**

*oneOf:*

- **Option 1** (MessagesApiChannelsDestination)
  - **messageId** (string, optional) — The ID that uniquely identifies the message sent. If failover is defined, then it will override values provided in `byChannel` array and be applied to each message in failover flow.
  - **byChannel** (MessagesApiChannelDestination[], required) — An array of substitute destinations, each associated with a specific `channel`. Only one substitute destination is allowed per `channel`. A substitute destination must be provided for the main `channel` defined in the `message`.
    - **channel** (Channel, required)
      Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`, `KAKAO_ALIM`
    - **to** (string, required) — The destination address of the message associated with given channel. It can be alphanumeric or numeric.
    - **messageId** (string, optional) — The ID that uniquely identifies the message sent.
- **Option 2** (MessagesApiToDestination)
  - **to** (string, required) — The destination address of the message. It can be alphanumeric or numeric.
  - **messageId** (string, optional) — The ID that uniquely identifies the message sent.


### MessagesApiMessageInputFormPage

- **type** (MessagesApiMessageFormPageType, required)
  Possible values: `INTRO`, `SELECT`, `PICKER`, `DATE_PICKER`, `INPUT`
- **title** (string, optional) — Title of the page.
- **text** (string, optional) — Text of the page.
- **pageIdentifier** (string, optional) — Unique identifier of the page.
- **nextPageIdentifier** (string, optional) — Identifier of the next page. If not set, the client assumes the current page to be the final page.
- **submitForm** (boolean, optional) — Placed on the pages to denote the end page of the form. Can be set on multiple pages.
- **options** (MessagesApiMessageInputFormPageOptions, optional) — Options of the page.
  - **hintText** (string, optional) — Text to give the user more input context that displays below the Input field.
  - **regex** (string, optional) — String representing a JSON encoded regular expression (regex) string to limit the type of input for input field to use.
  - **placeholder** (string, optional) — Text string used when there is no other text in the input text field.
  - **isRequired** (boolean, optional) — When set to true, the next button on page is disabled until the user provides input.
  - **inputType** (MessagesApiMessageInputFormInputType, optional) — Type of input.
    Possible values: `SINGLELINE`, `MULTILINE`
  - **labelText** (string, optional) — Text label shown to identify the input field. Applicable only for SINGLELINE input type.
  - **prefixText** (string, optional) — String value representing optional text shown next to the text field. Applicable only for SINGLELINE input type.
  - **maximumCharacterCount** (integer (int32), optional) — Maximum field size in characters.
  - **keyboardType** (MessagesApiMessageInputFormPageKeyboard, optional) — Type of keyboard to be shown.
    Possible values: `DEFAULT`, `ASCII_CAPABLE`, `NUMBERS_AND_PUNCTUATION`, `URL`, `NUMBER_PAD`, `PHONE_PAD`, `NAME_PHONE_PAD`, `EMAIL_ADDRESS`, `DECIMAL_PAD`, `TWITTER_KEYBOARD`, `WEB_SEARCH`
  - **textContentType** (MessagesApiMessageInputFormPageTextContentType, optional) — Value representing the keyboard and system information about the expected semantic meaning for the content that users enter.
    Possible values: `NAME_PREFIX`, `GIVEN_NAME`, `MIDDLE_NAME`, `FAMILY_NAME`, `NAME_SUFFIX`, `NICKNAME`, `JOB_TITLE`, `ORGANIZATION_NAME`, `LOCATION`, `FULL_STREET_ADDRESS`, `STREET_ADDRESS_LINE_1`, `STREET_ADDRESS_LINE_2`, `ADDRESS_CITY`, `ADDRESS_STATE`, `ADDRESS_CITY_STATE`, `SUBLOCALITY`, `COUNTRY_NAME`, `POSTAL_CODE`, `PHONE_NUMBER`, `EMAIL_ADDRESS`, `URL`, `CREDIT_CARD_NUMBER`, `USERNAME`, `PASSWORD`, `NEW_PASSWORD`, `ONE_TIME_CODE`

### MessagesApiMessageIntroFormPage

- **type** (MessagesApiMessageFormPageType, required)
  Possible values: `INTRO`, `SELECT`, `PICKER`, `DATE_PICKER`, `INPUT`
- **title** (string, optional) — If set, it displays in bold the title on the main page underneath the image.
- **text** (string, optional) — If set, displays additional text on the main page underneath the title.
- **buttonText** (string, optional) — Text on the button shown on the main page. If missing then this view doesn't display and continues onto the first module.
- **imageUrl** (string, optional) — Image to be shown at the top of the main page.

### MessagesApiMessageFormPageType

### Platform

Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).

- **entityId** (string, optional) — Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
- **applicationId** (string, optional) — Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).

### MessagesApiTemplateUrlWithTextButton

- **type** (MessagesApiTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
- **text** (string, optional) — Text to be displayed on the button.
- **url** (string, optional) — URL to be opened when the button is tapped on mobile devices.
- **urlPc** (string, optional) — URL to be opened when the button is tapped on PC.

### MessagesApiMessageHeader

Header of the message.

- **type** (MessagesApiMessageHeaderType, required)
  Possible values: `TEXT`

### MessagesApiMessageTimePickerTimeslot

Possible timeslots for event.

- **duration** (integer (int32), required) — Duration of the time slot in seconds.
- **startTime** (string (date-time), required) — Event start time. UTC string in ISO-8601 format. On end-user phone it is converted to their timezone.
- **identifier** (string, optional) — Identifier of timeslot. Will be autogenerated if not provided.

### MessagesApiMessageFormPickerPageItem

An array of objects defining the user experience.

- **identifier** (string, required) — Unique identifier of the item.
- **title** (string, required) — Title of the item.
- **value** (string, required) — Value of the item.

### MessagesApiTemplateAddChannelButton

- **type** (MessagesApiTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
- **text** (string, optional) — Text to be displayed on the button.

### MessagesApiTemplateCopyCodeButton

- **type** (MessagesApiTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
- **code** (string, optional) — Coupon code.

### MessagesApiMessageApplePayPaymentConfigurationMerchantCapability

An array of payment capabilities supported by the merchant. The array must include 3DS.

### MessagesApiMessageCarouselCard

Carousel cards.

- **body** (MessagesApiMessageCarouselCardBody, required) — Body of a card.
  - **title** (string, optional) — Title of the card.
  - **text** (string, optional) — Text to be sent.
  - **url** (string, optional) — URL of the card's media. It can be image or video. When you provide it with `isVideo=true` then it will be mapped as a video, otherwise - as an image.
  - **isVideo** (boolean, optional) — Indicates if provided `url` is a video.
  - **thumbnailUrl** (string, optional) — URL of the thumbnail image. If you add this, then we use as thumbnail image for video you provided in `url`. Applicable only when `isVideo=true`.
  - **cardOptions** (MessagesApiMessageCardOptions, optional) — Set of alignment options for the Card.
    - **orientation** (MessagesApiMessageCardOptionsOrientationEnum, optional) — Orientation of the card.
      Possible values: `HORIZONTAL`, `VERTICAL`
    - **alignment** (MessagesApiMessageCardOptionsAlignmentEnum, optional) — Alignment of the card.
      Possible values: `LEFT`, `RIGHT`
    - **height** (MessagesApiMessageCardOptionsHeightEnum, optional) — Height of the card media.
      Possible values: `SHORT`, `MEDIUM`, `TALL`
- **buttons** (MessagesApiMessageButton[], optional) — List of buttons of a card.
  - **type** (MessagesApiMessageButtonType, required)
    Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`

### MessagesApiCarouselTemplateButtonType

### TransliterationCode

The transliteration of your sent message from one script to another. Transliteration is used to replace characters which are not recognized as part of your defaulted alphabet. Possible values: `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `BULGARIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `PORTUGUESE`, `COLOMBIAN`, and `NON_UNICODE`. Supported by SMS.

### MessagesApiMessageOrder

Payment request order.

- **catalogId** (string, optional) — (WhatsApp specific) ID that uniquely identifies the [catalog](https://www.infobip.com/docs/api/platform/catalogs-api) registered with Facebook and connected to the WhatsApp Business Account the sender belongs to.
- **currency** (MessagesApiMessageOrderCurrency, optional) — (WhatsApp specific, required) Order currency.
  Possible values: `INR`, `BRL`
- **type** (MessagesApiMessageOrderType, optional) — (WhatsApp specific, required) Type of the goods in the order.
  Possible values: `PHYSICAL_GOODS`, `DIGITAL_GOODS`
- **detailsType** (MessagesApiMessageOrderDetailsType, optional) — (WhatsApp specific) A quick payment option bypassing the review step. Applicable for PG PayU and PG Razorpay.
  Possible values: `QUICK_PAY`
- **items** (MessagesApiMessageOrderItem[], optional) — An array of items in the order.
  - **name** (string, required) — Name of the item.
  - **retailerId** (string, optional) — (WhatsApp specific, and required) Product-unique identifier, as defined in catalog.
  - **quantity** (integer (int32), optional) — (WhatsApp specific) Item quantity.
  - **amount** (number, required) — Price of the item (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
  - **saleAmount** (number, optional) — (WhatsApp specific) Item discount (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
  - **importer** (MessagesApiMessageOrderImporter, optional) — (WhatsApp specific) Importer data. Required when catalogId is not provided. It's supported only for UPI PayU payments.
    - **name** (string, optional) — Name of the importer. Required when catalogId is not provided.
    - **address** (MessagesApiMessageOrderImporterAddress, optional) — Address of the importer. Required when catalogId is not provided.
      - **firstAddressLine** (string, optional) — First address line.
      - **secondAddressLine** (string, optional) — Second address line.
      - **city** (string, optional) — City name.
      - **zoneCode** (string, optional) — Zone code value.
      - **postalCode** (string, optional) — Zip code value.
      - **countryCode** (string, optional) — Country code value.
    - **originCountry** (string, optional) — Country of origin. Required when catalogId is not provided.
- **expiration** (MessagesApiMessageOrderExpiration, optional) — (WhatsApp specific) Expiration of the order.
  - **timestamp** (string (date-time), optional) — Timestamp of the expiration. Must be at least 5 minutes in the future.
  - **description** (string, optional) — Description of the expiration.

### MessagesApiMessageOrderImporterAddress

Address of the importer. Required when catalogId is not provided.

- **firstAddressLine** (string, optional) — First address line.
- **secondAddressLine** (string, optional) — Second address line.
- **city** (string, optional) — City name.
- **zoneCode** (string, optional) — Zone code value.
- **postalCode** (string, optional) — Zip code value.
- **countryCode** (string, optional) — Country code value.

### MessagesApiMessageAuthenticationRequestBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **text** (string, optional) — Text to be sent.
- **scopes** (string[], optional) — Array that specifies the scopes of the request.
- **imageUrl** (string, optional) — URL of the image.

### MessagesApiMessageUpiPgRazorpayPaymentConfiguration

- **type** (MessagesApiMessagePaymentConfigurationType, required)
  Possible values: `PG_PAYU`, `PG_RAZORPAY`, `UPI_PAYU`, `BRAZIL`, `BRAZIL_PIX_DC`, `BRAZIL_LINK`, `BRAZIL_BOLETO`, `UPI_INTENT`, `APPLE_PAY`
- **id** (string, optional) — Unique identifier of the payment. It can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters
- **name** (string, optional) — Name of the WhatsApp payment configuration to be used for this order.
- **beneficiary** (MessagesApiMessagePaymentBeneficiary, optional) — Beneficiary of the payment.
  - **name** (string, optional) — Beneficiary's name.
  - **firstAddressLine** (string, optional) — First address line.
  - **secondAddressLine** (string, optional) — Second address line.
  - **city** (string, optional) — City name.
  - **state** (string, optional) — State name.
  - **country** (MessagesApiMessagePaymentBeneficiaryCountry, optional) — Country name.
    Possible values: `INDIA`
  - **postalCode** (string, optional) — Zip code value.
- **callbackData** (object, optional) — Object with key value pairs containing custom parameters corresponding to the transaction.

### MessagesApiMessageInputFormPageTextContentType

Value representing the keyboard and system information about the expected semantic meaning for the content that users enter.

### MessagesApiToDestination

Represents a simple destination.

- **to** (string, required) — The destination address of the message. It can be alphanumeric or numeric.
- **messageId** (string, optional) — The ID that uniquely identifies the message sent.

### MessagesApiTemplateMessageContent

Content of the message.

- **header** (MessagesApiTemplateHeader, optional) — Header of a template message.
  - **type** (MessagesApiTemplateHeaderType, required)
    Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`
- **body** (MessagesApiTemplateBody, optional) — Body of a template message.
  - **type** (MessagesApiTemplateBodyType, required)
    Possible values: `TEXT`, `CAROUSEL`
- **buttons** (MessagesApiTemplateButton[], optional) — List of buttons of a template message. Supported `type` values depend on `channel`: `WHATSAPP` supports QUICK_REPLY, OPEN_URL, PHONE_NUMBER, FLOW, COPY_CODE, CATALOG, MULTI_PRODUCT; `KAKAO_ALIM` supports URL_WITH_TEXT, APP_LINK, BOT_KEYWORD, CHATBOT_SWITCH, DELIVERY_TRACKING, MESSAGE_DELIVERY, ADD_CHANNEL.
  - **type** (MessagesApiTemplateButtonType, required)
    Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
- **expirationTime** (string, optional) — Expiration time of a limited-time offer template message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.

### MessagesApiChannelsDestination

Represents a destination which can be specified by a `channel`. **It is required for a message failover**.

- **messageId** (string, optional) — The ID that uniquely identifies the message sent. If failover is defined, then it will override values provided in `byChannel` array and be applied to each message in failover flow.
- **byChannel** (MessagesApiChannelDestination[], required) — An array of substitute destinations, each associated with a specific `channel`. Only one substitute destination is allowed per `channel`. A substitute destination must be provided for the main `channel` defined in the `message`.
  - **channel** (Channel, required)
    Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`, `KAKAO_ALIM`
  - **to** (string, required) — The destination address of the message associated with given channel. It can be alphanumeric or numeric.
  - **messageId** (string, optional) — The ID that uniquely identifies the message sent.

### UrlOptions

Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature. Does not apply to channels that do not support it: Instagram, LINE, Messenger, Viber Bot.

- **shortenUrl** (boolean, optional) — Enable shortening of the URLs within a message. Set this to `true`, if you want to set up other URL options.
- **trackClicks** (boolean, optional) — Enable tracking of short URL clicks within a message: which URL was clicked, how many times, and by whom.
- **trackingUrl** (string, optional) — The URL of your callback server on to which the Click report will be sent.
- **removeProtocol** (boolean, optional) — Remove a protocol, such as `https://`, from links to shorten a message. Note that some mobiles may not recognize such links as a URL.
- **customDomain** (string, optional) — Select a predefined custom domain to use when generating a short URL.

### MessagesApiMessageFlowNavigateAction

- **type** (MessagesApiMessageFlowActionType, required)
  Possible values: `NAVIGATE`, `DATA_EXCHANGE`
- **payload** (MessagesApiMessageFlowActionPayload, optional) — Payload of the action.
  - **screen** (string, required) — ID of the first screen of the flow.
  - **data** (object, optional) — Input data for first screen of the flow. Must be a non-empty object.

### MessagesApiMessageDialPhoneButton

- **type** (MessagesApiMessageButtonType, required)
  Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
- **text** (string, optional) — Text to be displayed on the button.
- **phoneNumber** (string, optional) — Valid phone number.
- **postbackData** (string, optional) — Custom data that will be sent to you when the user replies to the message.

### MessagesApiTemplateCarouselCard

Carousel cards.

- **header** (MessagesApiTemplateCarouselCardHeader, required) — Header of a card.
  - **type** (MessagesApiTemplateCarouselCardHeaderType, required)
    Possible values: `IMAGE`, `VIDEO`
- **body** (object, optional) — Body of a card.
- **buttons** (MessagesApiCarouselTemplateButton[], optional) — List of buttons of a card.
  - **type** (MessagesApiCarouselTemplateButtonType, required)
    Possible values: `QUICK_REPLY`, `OPEN_URL`, `PHONE_NUMBER`

### SouthKoreaOptions

Use case dependent parameters for sending SMS to phone numbers registered in South Korea.

- **title** (string, optional) — Title of the message.
- **resellerCode** (integer (int32), optional) — Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.

### MessagesApiMessageOrderCurrency

(WhatsApp specific, required) Order currency.

### MessagesApiMessageBrazilPixDcPaymentConfiguration

- **type** (MessagesApiMessagePaymentConfigurationType, required)
  Possible values: `PG_PAYU`, `PG_RAZORPAY`, `UPI_PAYU`, `BRAZIL`, `BRAZIL_PIX_DC`, `BRAZIL_LINK`, `BRAZIL_BOLETO`, `UPI_INTENT`, `APPLE_PAY`
- **id** (string, optional) — Unique identifier of the payment. It can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters
- **name** (string, optional) — Name of the WhatsApp payment configuration to be used for this order. Can be omitted for Brazil PIX.
- **code** (string, optional) — Dynamic Pix code which will be copied by the buyer.
- **merchantName** (string, optional) — Pix account holder name.
- **keyType** (MessagesApiMessageBrazilPixDcPaymentContentKeyType, optional) — Key type to identify the pix user’s account.
  Possible values: `CPF`, `CNPJ`, `EMAIL`, `PHONE`, `EVP`
- **key** (string, optional) — Key to identify the pix user’s account.

### MessagesApiCarouselTemplatePhoneNumberButton

- **type** (MessagesApiCarouselTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `PHONE_NUMBER`

### RecipientType

Recipient Type must be `TACIR` or `BIREYSEL`.

### MessagesApiMessageContactBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **name** (string, optional) — Name of the contact.
- **phoneNumber** (string, optional) — Phone number of the contact.

### MessagesApiMessageTextHeader

- **type** (MessagesApiMessageHeaderType, required)
  Possible values: `TEXT`
- **text** (string, optional) — Text of the header.

### MessagesApiMessageUpiIntentPaymentConfiguration

- **type** (MessagesApiMessagePaymentConfigurationType, required)
  Possible values: `PG_PAYU`, `PG_RAZORPAY`, `UPI_PAYU`, `BRAZIL`, `BRAZIL_PIX_DC`, `BRAZIL_LINK`, `BRAZIL_BOLETO`, `UPI_INTENT`, `APPLE_PAY`
- **id** (string, optional) — Unique identifier of the payment. It can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters
- **beneficiary** (MessagesApiMessagePaymentBeneficiary, optional) — Beneficiary of the payment.
  - **name** (string, optional) — Beneficiary's name.
  - **firstAddressLine** (string, optional) — First address line.
  - **secondAddressLine** (string, optional) — Second address line.
  - **city** (string, optional) — City name.
  - **state** (string, optional) — State name.
  - **country** (MessagesApiMessagePaymentBeneficiaryCountry, optional) — Country name.
    Possible values: `INDIA`
  - **postalCode** (string, optional) — Zip code value.
- **format** (MessagesApiUpiIntentPaymentFormat, optional) — Format of the payment.
  - **type** (MessagesApiUpiIntentPaymentFormatType, required)
    Possible values: `LINK`

### MessagesApiMessageStickerBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **reference** (string, optional) — Unique reference to the sticker. It can be URL or identifier. If it is URL, resource should be of WebP type.

### MessagesApiTemplateCarouselCardImageHeader

- **type** (MessagesApiTemplateCarouselCardHeaderType, required)
  Possible values: `IMAGE`, `VIDEO`
- **url** (string, optional) — URL of an image.

### MessagesApiTemplateMultiProductButtonSection

An array of multi product sections.

- **title** (string, required) — Title of the section.
- **productIds** (string[], required) — An array of product-unique identifiers as defined in the catalog. If product retailer ID doesn't exist in your catalog, the product won't be displayed.

### MessagesApiMessageMixedBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **items** (MessagesApiMessageMixedItem[], optional) — Mixed items.
  *oneOf:*

  - **Option 1** (MessagesApiMessageMixedMediaItem)
    - **url** (string, required) — URL of the media's item.
    - **contentId** (string, optional) — Custom content identifier for the media item. Supported by MMS only (Apple ignores).
  - **Option 2** (MessagesApiMessageMixedTextItem)
    - **text** (string, required) — Text to be sent.
    - **contentId** (string, optional) — Custom content identifier for the text item. Supported by MMS only (Apple ignores).


### MessagesApiTemplateCatalogButton

- **type** (MessagesApiTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
- **productId** (string, optional) — Product-unique identifier from the catalog.

### MessagesApiMessageFlowDataExchangeAction

- **type** (MessagesApiMessageFlowActionType, required)
  Possible values: `NAVIGATE`, `DATA_EXCHANGE`

### DeliveryDay

Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.

### MessagesApiTrafficType

Traffic type classification for message sending. Supported by Viber for non-template messages only.

### MessagesApiMessageCardOptionsOrientationEnum

Orientation of the card.

### MessagesApiTemplateTextBody

Key value pairs that will be replaced during message sending. For channel WHATSAPP, all keys must be either only numerical or only lowercase letters and underscores. Valid examples `{"1": "John", "2": "Smith", "type": "TEXT"}` and `{"first_name": "John", "type": "TEXT"}`.

- **type** (MessagesApiTemplateBodyType, required)
  Possible values: `TEXT`, `CAROUSEL`

### MessagesApiMessageRequestLocationButton

- **type** (MessagesApiMessageButtonType, required)
  Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
- **text** (string, optional) — Text to be displayed on the button.
- **postbackData** (string, optional) — Custom data that will be sent to you when the user replies to the message.

### MessagesApiMessageBrazilBoletoPaymentConfiguration

- **type** (MessagesApiMessagePaymentConfigurationType, required)
  Possible values: `PG_PAYU`, `PG_RAZORPAY`, `UPI_PAYU`, `BRAZIL`, `BRAZIL_PIX_DC`, `BRAZIL_LINK`, `BRAZIL_BOLETO`, `UPI_INTENT`, `APPLE_PAY`
- **id** (string, optional) — Unique identifier of the payment. It can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters
- **code** (string, optional) — Boleto code.

### MessagesApiMessageBrazilLinkPaymentConfiguration

- **type** (MessagesApiMessagePaymentConfigurationType, required)
  Possible values: `PG_PAYU`, `PG_RAZORPAY`, `UPI_PAYU`, `BRAZIL`, `BRAZIL_PIX_DC`, `BRAZIL_LINK`, `BRAZIL_BOLETO`, `UPI_INTENT`, `APPLE_PAY`
- **id** (string, optional) — Unique identifier of the payment. It can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters
- **paymentLink** (string, optional) — Payment link.

### MessagesApiMessageOrderStatusOrderType

Type of the order payment.

### MessagesApiFailover

Configuration of a single failover step

- **channel** (OutboundMessageChannel, required) — Messaging channel used for sending a message.
  Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`
- **sender** (string, optional) — Sender for channel specified above.
- **content** (MessagesApiMessageContent, optional) — Content of the message.
  - **header** (MessagesApiMessageHeader, optional) — Header of the message.
    - **type** (MessagesApiMessageHeaderType, required)
      Possible values: `TEXT`
  - **body** (MessagesApiMessageBody, required) — Body of the message.
    - **type** (MessagesApiMessageBodyType, required)
      Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
  - **buttons** (MessagesApiMessageButton[], optional) — List of buttons of the message.
    - **type** (MessagesApiMessageButtonType, required)
      Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
  - **confirmationBody** (MessagesApiMessageConfirmationBody, optional) — Body of the confirmation message.
    - **text** (string, required) — Text to be sent.
    - **description** (string, optional) — Description to be sent.
    - **imageUrl** (string, optional) — URL of the image.
  - **senderDisplayInfo** (MessagesApiMessageSenderDisplayInfo, optional) — Sender display info (name and avatar). Used only for Viber Bot messages.
    - **name** (string, optional) — The sender's name to display.
    - **avatarUrl** (string, optional) — The sender's avatar URL.
  - **footer** (MessagesApiMessageFooter, optional) — Footer of the message.
    - **text** (string, required) — Text of the footer.
- **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
  - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
  - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
    Possible values: `SECONDS`, `MINUTES`, `HOURS`

### MessagesApiMessageTimePickerLocation

Location of the event.

- **latitude** (number (double), required) — Latitude of the location.
- **longitude** (number (double), required) — Longitude of the location.
- **radius** (number (double), optional) — Radius of the location in meters.
- **name** (string, required) — Name of the location.

### MessagesApiMessageTimePickerEvent

Event with possible occurrences and location.

- **title** (string, required) — Title of event.
- **timeslots** (MessagesApiMessageTimePickerTimeslot[], required) — Possible timeslots for event.
  - **duration** (integer (int32), required) — Duration of the time slot in seconds.
  - **startTime** (string (date-time), required) — Event start time. UTC string in ISO-8601 format. On end-user phone it is converted to their timezone.
  - **identifier** (string, optional) — Identifier of timeslot. Will be autogenerated if not provided.
- **location** (MessagesApiMessageTimePickerLocation, optional) — Location of the event.
  - **latitude** (number (double), required) — Latitude of the location.
  - **longitude** (number (double), required) — Longitude of the location.
  - **radius** (number (double), optional) — Radius of the location in meters.
  - **name** (string, required) — Name of the location.
- **imageUrl** (string, optional) — URL of the event's image.

### MessagesApiTemplateMessage

Represents a single template message.

- **channel** (OutboundTemplateChannel, required) — Messaging channel used for sending a template message.
  Possible values: `APPLE_MB`, `RCS`, `VIBER_BM`, `WHATSAPP`, `KAKAO_ALIM`
- **sender** (string, optional) — The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
- **destinations** (MessageDestination[], required) — Array of destination objects for where messages are being sent. A valid destination is required. **`Channels Destination` is required when sending messages with defined failover.**
  *oneOf:*

  - **Option 1** (MessagesApiChannelsDestination)
    - **messageId** (string, optional) — The ID that uniquely identifies the message sent. If failover is defined, then it will override values provided in `byChannel` array and be applied to each message in failover flow.
    - **byChannel** (MessagesApiChannelDestination[], required) — An array of substitute destinations, each associated with a specific `channel`. Only one substitute destination is allowed per `channel`. A substitute destination must be provided for the main `channel` defined in the `message`.
      - **channel** (Channel, required)
        Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`, `KAKAO_ALIM`
      - **to** (string, required) — The destination address of the message associated with given channel. It can be alphanumeric or numeric.
      - **messageId** (string, optional) — The ID that uniquely identifies the message sent.
  - **Option 2** (MessagesApiToDestination)
    - **to** (string, required) — The destination address of the message. It can be alphanumeric or numeric.
    - **messageId** (string, optional) — The ID that uniquely identifies the message sent.

- **template** (MessagesApiTemplate, required) — Details of the template.
  - **templateName** (string, required) — Template name or identifier which given channel uses to send a template message.
  - **language** (string, optional) — Language of the template.
  - **referenceId** (string, optional) — Reference field (used only in Apple) to provide context of what the message is for (e.g. order number, case identifier, etc).
  - **groupKey** (string, optional) — Key associated with a group of templates. Used only in KAKAO_ALIM channel for templates registered under a group.
- **content** (MessagesApiTemplateMessageContent, optional) — Content of the message.
  - **header** (MessagesApiTemplateHeader, optional) — Header of a template message.
    - **type** (MessagesApiTemplateHeaderType, required)
      Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`
  - **body** (MessagesApiTemplateBody, optional) — Body of a template message.
    - **type** (MessagesApiTemplateBodyType, required)
      Possible values: `TEXT`, `CAROUSEL`
  - **buttons** (MessagesApiTemplateButton[], optional) — List of buttons of a template message. Supported `type` values depend on `channel`: `WHATSAPP` supports QUICK_REPLY, OPEN_URL, PHONE_NUMBER, FLOW, COPY_CODE, CATALOG, MULTI_PRODUCT; `KAKAO_ALIM` supports URL_WITH_TEXT, APP_LINK, BOT_KEYWORD, CHATBOT_SWITCH, DELIVERY_TRACKING, MESSAGE_DELIVERY, ADD_CHANNEL.
    - **type** (MessagesApiTemplateButtonType, required)
      Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
  - **expirationTime** (string, optional) — Expiration time of a limited-time offer template message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
- **options** (MessagesApiMessageOptions, optional) — Message options.
  - **platform** (Platform, optional) — Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
    - **entityId** (string, optional) — Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
    - **applicationId** (string, optional) — Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
  - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
    - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
    - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
      Possible values: `SECONDS`, `MINUTES`, `HOURS`
  - **deliveryTimeWindow** (DeliveryTimeWindow, optional) — Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.
    - **days** (DeliveryDay[], required) — Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
    - **from** (DeliveryTime, optional) — The exact time of the day. The time is expressed in the UTC time zone.
      - **hour** (integer (int32), required) — Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
      - **minute** (integer (int32), required) — Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
    - **to** (DeliveryTime, optional) — The exact time of the day. The time is expressed in the UTC time zone.
      - **hour** (integer (int32), required) — Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
      - **minute** (integer (int32), required) — Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
  - **adaptationMode** (boolean, optional) — If channel does not fully support message to be sent, we will try to map it as best effort. This is default behavior, even if this option is not specified.
  - **regional** (RegionalOptions, optional) — Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
    - **indiaDlt** (IndiaDltOptions, optional) — Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
      - **contentTemplateId** (string, optional) — Registered DLT content template ID which matches message you are sending.
      - **principalEntityId** (string, required) — Your assigned DLT principal entity ID.
      - **telemarketerId** (string, optional) — Your assigned Telemarketer ID. (required for Aggregators)
    - **turkeyIys** (TurkeyIysOptions, optional) — IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
      - **brandCode** (integer (int32), optional) — Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
      - **recipientType** (RecipientType, required) — Recipient Type must be `TACIR` or `BIREYSEL`.
        Possible values: `BIREYSEL`, `TACIR`
    - **southKorea** (SouthKoreaOptions, optional) — Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
      - **title** (string, optional) — Title of the message.
      - **resellerCode** (integer (int32), optional) — Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.
  - **campaignReferenceId** (string, optional) — ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
  - **transliteration** (TransliterationCode, optional) — The transliteration of your sent message from one script to another. Transliteration is used to replace characters which are not recognized as part of your defaulted alphabet. Possible values: `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `BULGARIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `PORTUGUESE`, `COLOMBIAN`, and `NON_UNICODE`. Supported by SMS.
    Possible values: `NONE`, `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `NON_UNICODE`, `PORTUGUESE`, `COLOMBIAN`, `BULGARIAN_CYRILLIC`, `ALL`
  - **correlationData** (string, optional) — Correlation data included in the outbound message. If provided, it will be returned in the inbound message. Auto-generated if not set explicitly.
  - **trafficType** (MessagesApiTrafficType, optional) — Traffic type classification for message sending. Supported by Viber for non-template messages only.
    Possible values: `PROMOTIONAL`, `TRANSACTIONAL`
  - **sessionRate** (boolean, optional) — Defines if the message should be charged using session rate. Supported by Viber for content with text/image/document only (without buttons, extra text etc.) body type. For text/image only body types `sessionRate` won't be applied if parameter `primaryDevice` is set to true.
  - **primaryDevice** (boolean, optional) — Defines if the message should be sent only to the end user's primary device (phone or tablet). Supported by Viber for message with content with text/image/document only (without buttons, extra text etc.) body type or template message.
- **webhooks** (MessagesApiWebhooks, optional) — Provides options for configuring message webhooks.
  - **delivery** (MessagesApiDelivery, optional) — Provides options for configuring the delivery report behavior.
    - **url** (string, optional) — The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/api#notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.
    - **intermediateReport** (boolean, optional) — The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. The default setting is `false`.
    - **receiveTriggeredFailoverReports** (boolean, optional) — Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`.
  - **contentType** (string, optional) — Preferred delivery report content type, `application/json` or `application/xml`.
  - **callbackData** (string, optional) — Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report and Seen Report. The maximum value is 4000 characters.
  - **seen** (SeenStatusReporting, optional) — Provides options for configuring the seen report behavior.
    - **url** (string, optional) — The URL on your call back server where a seen report will be sent.
- **failover** (MessagesApiBaseFailover[], optional) — Provides options for configuring a message failover. When message fails it will be sent over channels in order specified in an array. It has to contain unique entries per channel and it cannot contain entry with the same channel as original message. **Make sure to provide correct sender and destinations specified as `Channels Destination` for each channel**.
  *oneOf:*

  - **Option 1** (MessagesApiFailover)
    - **channel** (OutboundMessageChannel, required) — Messaging channel used for sending a message.
      Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`
    - **sender** (string, optional) — Sender for channel specified above.
    - **content** (MessagesApiMessageContent, optional) — Content of the message.
      - **header** (MessagesApiMessageHeader, optional) — Header of the message.
        - **type** (MessagesApiMessageHeaderType, required)
          Possible values: `TEXT`
      - **body** (MessagesApiMessageBody, required) — Body of the message.
        - **type** (MessagesApiMessageBodyType, required)
          Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
      - **buttons** (MessagesApiMessageButton[], optional) — List of buttons of the message.
        - **type** (MessagesApiMessageButtonType, required)
          Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
      - **confirmationBody** (MessagesApiMessageConfirmationBody, optional) — Body of the confirmation message.
        - **text** (string, required) — Text to be sent.
        - **description** (string, optional) — Description to be sent.
        - **imageUrl** (string, optional) — URL of the image.
      - **senderDisplayInfo** (MessagesApiMessageSenderDisplayInfo, optional) — Sender display info (name and avatar). Used only for Viber Bot messages.
        - **name** (string, optional) — The sender's name to display.
        - **avatarUrl** (string, optional) — The sender's avatar URL.
      - **footer** (MessagesApiMessageFooter, optional) — Footer of the message.
        - **text** (string, required) — Text of the footer.
    - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
      - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
      - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
        Possible values: `SECONDS`, `MINUTES`, `HOURS`
  - **Option 2** (MessagesApiTemplateFailover)
    - **channel** (OutboundTemplateChannel, required) — Messaging channel used for sending a template message.
      Possible values: `APPLE_MB`, `RCS`, `VIBER_BM`, `WHATSAPP`, `KAKAO_ALIM`
    - **sender** (string, optional) — Sender for channel specified above.
    - **template** (MessagesApiTemplate, required) — Details of the template.
      - **templateName** (string, required) — Template name or identifier which given channel uses to send a template message.
      - **language** (string, optional) — Language of the template.
      - **referenceId** (string, optional) — Reference field (used only in Apple) to provide context of what the message is for (e.g. order number, case identifier, etc).
      - **groupKey** (string, optional) — Key associated with a group of templates. Used only in KAKAO_ALIM channel for templates registered under a group.
    - **content** (MessagesApiTemplateMessageContent, optional) — Content of the message.
      - **header** (MessagesApiTemplateHeader, optional) — Header of a template message.
        - **type** (MessagesApiTemplateHeaderType, required)
          Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`
      - **body** (MessagesApiTemplateBody, optional) — Body of a template message.
        - **type** (MessagesApiTemplateBodyType, required)
          Possible values: `TEXT`, `CAROUSEL`
      - **buttons** (MessagesApiTemplateButton[], optional) — List of buttons of a template message. Supported `type` values depend on `channel`: `WHATSAPP` supports QUICK_REPLY, OPEN_URL, PHONE_NUMBER, FLOW, COPY_CODE, CATALOG, MULTI_PRODUCT; `KAKAO_ALIM` supports URL_WITH_TEXT, APP_LINK, BOT_KEYWORD, CHATBOT_SWITCH, DELIVERY_TRACKING, MESSAGE_DELIVERY, ADD_CHANNEL.
        - **type** (MessagesApiTemplateButtonType, required)
          Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
      - **expirationTime** (string, optional) — Expiration time of a limited-time offer template message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
    - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
      - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
      - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
        Possible values: `SECONDS`, `MINUTES`, `HOURS`


### MessagesApiMessageMixedTextItem

Supported by MMS

- **text** (string, required) — Text to be sent.
- **contentId** (string, optional) — Custom content identifier for the text item. Supported by MMS only (Apple ignores).

### MessagesApiTemplatePhoneNumberButton

- **type** (MessagesApiTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`

### MessagesApiMessageBrazilPixDcPaymentContentKeyType

Key type to identify the pix user’s account.

### MessagesApiMessageOrderExpiration

(WhatsApp specific) Expiration of the order.

- **timestamp** (string (date-time), optional) — Timestamp of the expiration. Must be at least 5 minutes in the future.
- **description** (string, optional) — Description of the expiration.

### TurkeyIysOptions

IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.

- **brandCode** (integer (int32), optional) — Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
- **recipientType** (RecipientType, required) — Recipient Type must be `TACIR` or `BIREYSEL`.
  Possible values: `BIREYSEL`, `TACIR`

### MessagesApiMessageTimePickerBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **text** (string, optional) — Text to be sent.
- **subtext** (string, optional) — Subtext to be sent.
- **imageUrl** (string, optional) — URL of the image.
- **event** (MessagesApiMessageTimePickerEvent, optional) — Event with possible occurrences and location.
  - **title** (string, required) — Title of event.
  - **timeslots** (MessagesApiMessageTimePickerTimeslot[], required) — Possible timeslots for event.
    - **duration** (integer (int32), required) — Duration of the time slot in seconds.
    - **startTime** (string (date-time), required) — Event start time. UTC string in ISO-8601 format. On end-user phone it is converted to their timezone.
    - **identifier** (string, optional) — Identifier of timeslot. Will be autogenerated if not provided.
  - **location** (MessagesApiMessageTimePickerLocation, optional) — Location of the event.
    - **latitude** (number (double), required) — Latitude of the location.
    - **longitude** (number (double), required) — Longitude of the location.
    - **radius** (number (double), optional) — Radius of the location in meters.
    - **name** (string, required) — Name of the location.
  - **imageUrl** (string, optional) — URL of the event's image.

### MessagesApiTemplateAppLinkButton

- **type** (MessagesApiTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
- **text** (string, optional) — Text to be displayed on the button.
- **androidScheme** (string, optional) — Android URI scheme of the application.
- **iosScheme** (string, optional) — iOS URI scheme of the application.
- **url** (string, optional) — URL to be opened on mobile devices when the application is not installed.
- **urlPc** (string, optional) — URL to be opened on PC.

### MessageResponseMessageResponseDetails

An array of message objects of a single message or multiple messages sent under one bulk ID.

- **messageId** (string, optional) — Unique message ID. If not provided, it will be auto-generated and returned in the API response.
- **status** (MessageStatus, optional) — Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.
  - **groupId** (integer (int32), optional) — Status group ID.
  - **groupName** (MessageGeneralStatus, optional) — Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).
    Possible values: `ACCEPTED`, `PENDING`, `UNDELIVERABLE`, `DELIVERED`, `EXPIRED`, `REJECTED`
  - **id** (integer (int32), optional) — Status code ID.
  - **name** (string, optional) — [Status code](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) name.
  - **description** (string, optional) — Human-readable description of the status.
  - **action** (string, optional) — Action to take to recover from the error.
- **destination** (string, optional) — The destination address of the message, i.e., its recipient.
- **details** (MessageResponseDetails, optional) — Other details of the message.

### MessagesApiMessageCardOptionsAlignmentEnum

Alignment of the card.

### MessagesApiRequest

- **messages** (MessagesApiBaseMessage[], required) — Array of message objects of a single message or multiple messages sent under one bulk ID.
  *oneOf:*

  - **Option 1** (MessagesApiMessage)
    - **channel** (OutboundMessageChannel, required) — Messaging channel used for sending a message.
      Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`
    - **sender** (string, optional) — The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
    - **destinations** (MessageDestination[], required) — Array of destination objects for where messages are being sent. A valid destination is required. **`Channels Destination` is required when sending messages with defined failover.**
      *oneOf:*

      - **Option 1** (MessagesApiChannelsDestination)
        - **messageId** (string, optional) — The ID that uniquely identifies the message sent. If failover is defined, then it will override values provided in `byChannel` array and be applied to each message in failover flow.
        - **byChannel** (MessagesApiChannelDestination[], required) — An array of substitute destinations, each associated with a specific `channel`. Only one substitute destination is allowed per `channel`. A substitute destination must be provided for the main `channel` defined in the `message`.
          - **channel** (Channel, required)
            Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`, `KAKAO_ALIM`
          - **to** (string, required) — The destination address of the message associated with given channel. It can be alphanumeric or numeric.
          - **messageId** (string, optional) — The ID that uniquely identifies the message sent.
      - **Option 2** (MessagesApiToDestination)
        - **to** (string, required) — The destination address of the message. It can be alphanumeric or numeric.
        - **messageId** (string, optional) — The ID that uniquely identifies the message sent.

    - **content** (MessagesApiMessageContent, required) — Content of the message.
      - **header** (MessagesApiMessageHeader, optional) — Header of the message.
        - **type** (MessagesApiMessageHeaderType, required)
          Possible values: `TEXT`
      - **body** (MessagesApiMessageBody, required) — Body of the message.
        - **type** (MessagesApiMessageBodyType, required)
          Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
      - **buttons** (MessagesApiMessageButton[], optional) — List of buttons of the message.
        - **type** (MessagesApiMessageButtonType, required)
          Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
      - **confirmationBody** (MessagesApiMessageConfirmationBody, optional) — Body of the confirmation message.
        - **text** (string, required) — Text to be sent.
        - **description** (string, optional) — Description to be sent.
        - **imageUrl** (string, optional) — URL of the image.
      - **senderDisplayInfo** (MessagesApiMessageSenderDisplayInfo, optional) — Sender display info (name and avatar). Used only for Viber Bot messages.
        - **name** (string, optional) — The sender's name to display.
        - **avatarUrl** (string, optional) — The sender's avatar URL.
      - **footer** (MessagesApiMessageFooter, optional) — Footer of the message.
        - **text** (string, required) — Text of the footer.
    - **options** (MessagesApiMessageOptions, optional) — Message options.
      - **platform** (Platform, optional) — Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        - **entityId** (string, optional) — Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        - **applicationId** (string, optional) — Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
        - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
          Possible values: `SECONDS`, `MINUTES`, `HOURS`
      - **deliveryTimeWindow** (DeliveryTimeWindow, optional) — Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.
        - **days** (DeliveryDay[], required) — Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
        - **from** (DeliveryTime, optional) — The exact time of the day. The time is expressed in the UTC time zone.
          - **hour** (integer (int32), required) — Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
          - **minute** (integer (int32), required) — Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
        - **to** (DeliveryTime, optional) — The exact time of the day. The time is expressed in the UTC time zone.
          - **hour** (integer (int32), required) — Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
          - **minute** (integer (int32), required) — Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
      - **adaptationMode** (boolean, optional) — If channel does not fully support message to be sent, we will try to map it as best effort. This is default behavior, even if this option is not specified.
      - **regional** (RegionalOptions, optional) — Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
        - **indiaDlt** (IndiaDltOptions, optional) — Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
          - **contentTemplateId** (string, optional) — Registered DLT content template ID which matches message you are sending.
          - **principalEntityId** (string, required) — Your assigned DLT principal entity ID.
          - **telemarketerId** (string, optional) — Your assigned Telemarketer ID. (required for Aggregators)
        - **turkeyIys** (TurkeyIysOptions, optional) — IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
          - **brandCode** (integer (int32), optional) — Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
          - **recipientType** (RecipientType, required) — Recipient Type must be `TACIR` or `BIREYSEL`.
            Possible values: `BIREYSEL`, `TACIR`
        - **southKorea** (SouthKoreaOptions, optional) — Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
          - **title** (string, optional) — Title of the message.
          - **resellerCode** (integer (int32), optional) — Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.
      - **campaignReferenceId** (string, optional) — ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
      - **transliteration** (TransliterationCode, optional) — The transliteration of your sent message from one script to another. Transliteration is used to replace characters which are not recognized as part of your defaulted alphabet. Possible values: `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `BULGARIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `PORTUGUESE`, `COLOMBIAN`, and `NON_UNICODE`. Supported by SMS.
        Possible values: `NONE`, `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `NON_UNICODE`, `PORTUGUESE`, `COLOMBIAN`, `BULGARIAN_CYRILLIC`, `ALL`
      - **correlationData** (string, optional) — Correlation data included in the outbound message. If provided, it will be returned in the inbound message. Auto-generated if not set explicitly.
      - **trafficType** (MessagesApiTrafficType, optional) — Traffic type classification for message sending. Supported by Viber for non-template messages only.
        Possible values: `PROMOTIONAL`, `TRANSACTIONAL`
      - **sessionRate** (boolean, optional) — Defines if the message should be charged using session rate. Supported by Viber for content with text/image/document only (without buttons, extra text etc.) body type. For text/image only body types `sessionRate` won't be applied if parameter `primaryDevice` is set to true.
      - **primaryDevice** (boolean, optional) — Defines if the message should be sent only to the end user's primary device (phone or tablet). Supported by Viber for message with content with text/image/document only (without buttons, extra text etc.) body type or template message.
    - **webhooks** (MessagesApiWebhooks, optional) — Provides options for configuring message webhooks.
      - **delivery** (MessagesApiDelivery, optional) — Provides options for configuring the delivery report behavior.
        - **url** (string, optional) — The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/api#notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.
        - **intermediateReport** (boolean, optional) — The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. The default setting is `false`.
        - **receiveTriggeredFailoverReports** (boolean, optional) — Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`.
      - **contentType** (string, optional) — Preferred delivery report content type, `application/json` or `application/xml`.
      - **callbackData** (string, optional) — Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report and Seen Report. The maximum value is 4000 characters.
      - **seen** (SeenStatusReporting, optional) — Provides options for configuring the seen report behavior.
        - **url** (string, optional) — The URL on your call back server where a seen report will be sent.
    - **failover** (MessagesApiBaseFailover[], optional) — Provides options for configuring a message failover. When message fails it will be sent over channels in order specified in an array. It has to contain unique entries per channel and it cannot contain entry with the same channel as original message. **Make sure to provide correct sender and destinations specified as `Channels Destination` for each channel**.
      *oneOf:*

      - **Option 1** (MessagesApiFailover)
        - **channel** (OutboundMessageChannel, required) — Messaging channel used for sending a message.
          Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`
        - **sender** (string, optional) — Sender for channel specified above.
        - **content** (MessagesApiMessageContent, optional) — Content of the message.
          - **header** (MessagesApiMessageHeader, optional) — Header of the message.
            - **type** (MessagesApiMessageHeaderType, required)
              Possible values: `TEXT`
          - **body** (MessagesApiMessageBody, required) — Body of the message.
            - **type** (MessagesApiMessageBodyType, required)
              Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
          - **buttons** (MessagesApiMessageButton[], optional) — List of buttons of the message.
            - **type** (MessagesApiMessageButtonType, required)
              Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
          - **confirmationBody** (MessagesApiMessageConfirmationBody, optional) — Body of the confirmation message.
            - **text** (string, required) — Text to be sent.
            - **description** (string, optional) — Description to be sent.
            - **imageUrl** (string, optional) — URL of the image.
          - **senderDisplayInfo** (MessagesApiMessageSenderDisplayInfo, optional) — Sender display info (name and avatar). Used only for Viber Bot messages.
            - **name** (string, optional) — The sender's name to display.
            - **avatarUrl** (string, optional) — The sender's avatar URL.
          - **footer** (MessagesApiMessageFooter, optional) — Footer of the message.
            - **text** (string, required) — Text of the footer.
        - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
          - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
          - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
            Possible values: `SECONDS`, `MINUTES`, `HOURS`
      - **Option 2** (MessagesApiTemplateFailover)
        - **channel** (OutboundTemplateChannel, required) — Messaging channel used for sending a template message.
          Possible values: `APPLE_MB`, `RCS`, `VIBER_BM`, `WHATSAPP`, `KAKAO_ALIM`
        - **sender** (string, optional) — Sender for channel specified above.
        - **template** (MessagesApiTemplate, required) — Details of the template.
          - **templateName** (string, required) — Template name or identifier which given channel uses to send a template message.
          - **language** (string, optional) — Language of the template.
          - **referenceId** (string, optional) — Reference field (used only in Apple) to provide context of what the message is for (e.g. order number, case identifier, etc).
          - **groupKey** (string, optional) — Key associated with a group of templates. Used only in KAKAO_ALIM channel for templates registered under a group.
        - **content** (MessagesApiTemplateMessageContent, optional) — Content of the message.
          - **header** (MessagesApiTemplateHeader, optional) — Header of a template message.
            - **type** (MessagesApiTemplateHeaderType, required)
              Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`
          - **body** (MessagesApiTemplateBody, optional) — Body of a template message.
            - **type** (MessagesApiTemplateBodyType, required)
              Possible values: `TEXT`, `CAROUSEL`
          - **buttons** (MessagesApiTemplateButton[], optional) — List of buttons of a template message. Supported `type` values depend on `channel`: `WHATSAPP` supports QUICK_REPLY, OPEN_URL, PHONE_NUMBER, FLOW, COPY_CODE, CATALOG, MULTI_PRODUCT; `KAKAO_ALIM` supports URL_WITH_TEXT, APP_LINK, BOT_KEYWORD, CHATBOT_SWITCH, DELIVERY_TRACKING, MESSAGE_DELIVERY, ADD_CHANNEL.
            - **type** (MessagesApiTemplateButtonType, required)
              Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
          - **expirationTime** (string, optional) — Expiration time of a limited-time offer template message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
        - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
          - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
          - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
            Possible values: `SECONDS`, `MINUTES`, `HOURS`

  - **Option 2** (MessagesApiTemplateMessage)
    - **channel** (OutboundTemplateChannel, required) — Messaging channel used for sending a template message.
      Possible values: `APPLE_MB`, `RCS`, `VIBER_BM`, `WHATSAPP`, `KAKAO_ALIM`
    - **sender** (string, optional) — The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
    - **destinations** (MessageDestination[], required) — Array of destination objects for where messages are being sent. A valid destination is required. **`Channels Destination` is required when sending messages with defined failover.**
      *oneOf:*

      - **Option 1** (MessagesApiChannelsDestination)
        - **messageId** (string, optional) — The ID that uniquely identifies the message sent. If failover is defined, then it will override values provided in `byChannel` array and be applied to each message in failover flow.
        - **byChannel** (MessagesApiChannelDestination[], required) — An array of substitute destinations, each associated with a specific `channel`. Only one substitute destination is allowed per `channel`. A substitute destination must be provided for the main `channel` defined in the `message`.
          - **channel** (Channel, required)
            Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`, `KAKAO_ALIM`
          - **to** (string, required) — The destination address of the message associated with given channel. It can be alphanumeric or numeric.
          - **messageId** (string, optional) — The ID that uniquely identifies the message sent.
      - **Option 2** (MessagesApiToDestination)
        - **to** (string, required) — The destination address of the message. It can be alphanumeric or numeric.
        - **messageId** (string, optional) — The ID that uniquely identifies the message sent.

    - **template** (MessagesApiTemplate, required) — Details of the template.
      - **templateName** (string, required) — Template name or identifier which given channel uses to send a template message.
      - **language** (string, optional) — Language of the template.
      - **referenceId** (string, optional) — Reference field (used only in Apple) to provide context of what the message is for (e.g. order number, case identifier, etc).
      - **groupKey** (string, optional) — Key associated with a group of templates. Used only in KAKAO_ALIM channel for templates registered under a group.
    - **content** (MessagesApiTemplateMessageContent, optional) — Content of the message.
      - **header** (MessagesApiTemplateHeader, optional) — Header of a template message.
        - **type** (MessagesApiTemplateHeaderType, required)
          Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`
      - **body** (MessagesApiTemplateBody, optional) — Body of a template message.
        - **type** (MessagesApiTemplateBodyType, required)
          Possible values: `TEXT`, `CAROUSEL`
      - **buttons** (MessagesApiTemplateButton[], optional) — List of buttons of a template message. Supported `type` values depend on `channel`: `WHATSAPP` supports QUICK_REPLY, OPEN_URL, PHONE_NUMBER, FLOW, COPY_CODE, CATALOG, MULTI_PRODUCT; `KAKAO_ALIM` supports URL_WITH_TEXT, APP_LINK, BOT_KEYWORD, CHATBOT_SWITCH, DELIVERY_TRACKING, MESSAGE_DELIVERY, ADD_CHANNEL.
        - **type** (MessagesApiTemplateButtonType, required)
          Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
      - **expirationTime** (string, optional) — Expiration time of a limited-time offer template message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
    - **options** (MessagesApiMessageOptions, optional) — Message options.
      - **platform** (Platform, optional) — Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        - **entityId** (string, optional) — Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        - **applicationId** (string, optional) — Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
        - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
          Possible values: `SECONDS`, `MINUTES`, `HOURS`
      - **deliveryTimeWindow** (DeliveryTimeWindow, optional) — Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.
        - **days** (DeliveryDay[], required) — Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
        - **from** (DeliveryTime, optional) — The exact time of the day. The time is expressed in the UTC time zone.
          - **hour** (integer (int32), required) — Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
          - **minute** (integer (int32), required) — Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
        - **to** (DeliveryTime, optional) — The exact time of the day. The time is expressed in the UTC time zone.
          - **hour** (integer (int32), required) — Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
          - **minute** (integer (int32), required) — Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
      - **adaptationMode** (boolean, optional) — If channel does not fully support message to be sent, we will try to map it as best effort. This is default behavior, even if this option is not specified.
      - **regional** (RegionalOptions, optional) — Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
        - **indiaDlt** (IndiaDltOptions, optional) — Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
          - **contentTemplateId** (string, optional) — Registered DLT content template ID which matches message you are sending.
          - **principalEntityId** (string, required) — Your assigned DLT principal entity ID.
          - **telemarketerId** (string, optional) — Your assigned Telemarketer ID. (required for Aggregators)
        - **turkeyIys** (TurkeyIysOptions, optional) — IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
          - **brandCode** (integer (int32), optional) — Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
          - **recipientType** (RecipientType, required) — Recipient Type must be `TACIR` or `BIREYSEL`.
            Possible values: `BIREYSEL`, `TACIR`
        - **southKorea** (SouthKoreaOptions, optional) — Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
          - **title** (string, optional) — Title of the message.
          - **resellerCode** (integer (int32), optional) — Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.
      - **campaignReferenceId** (string, optional) — ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
      - **transliteration** (TransliterationCode, optional) — The transliteration of your sent message from one script to another. Transliteration is used to replace characters which are not recognized as part of your defaulted alphabet. Possible values: `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `BULGARIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `PORTUGUESE`, `COLOMBIAN`, and `NON_UNICODE`. Supported by SMS.
        Possible values: `NONE`, `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `NON_UNICODE`, `PORTUGUESE`, `COLOMBIAN`, `BULGARIAN_CYRILLIC`, `ALL`
      - **correlationData** (string, optional) — Correlation data included in the outbound message. If provided, it will be returned in the inbound message. Auto-generated if not set explicitly.
      - **trafficType** (MessagesApiTrafficType, optional) — Traffic type classification for message sending. Supported by Viber for non-template messages only.
        Possible values: `PROMOTIONAL`, `TRANSACTIONAL`
      - **sessionRate** (boolean, optional) — Defines if the message should be charged using session rate. Supported by Viber for content with text/image/document only (without buttons, extra text etc.) body type. For text/image only body types `sessionRate` won't be applied if parameter `primaryDevice` is set to true.
      - **primaryDevice** (boolean, optional) — Defines if the message should be sent only to the end user's primary device (phone or tablet). Supported by Viber for message with content with text/image/document only (without buttons, extra text etc.) body type or template message.
    - **webhooks** (MessagesApiWebhooks, optional) — Provides options for configuring message webhooks.
      - **delivery** (MessagesApiDelivery, optional) — Provides options for configuring the delivery report behavior.
        - **url** (string, optional) — The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/api#notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.
        - **intermediateReport** (boolean, optional) — The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. The default setting is `false`.
        - **receiveTriggeredFailoverReports** (boolean, optional) — Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`.
      - **contentType** (string, optional) — Preferred delivery report content type, `application/json` or `application/xml`.
      - **callbackData** (string, optional) — Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report and Seen Report. The maximum value is 4000 characters.
      - **seen** (SeenStatusReporting, optional) — Provides options for configuring the seen report behavior.
        - **url** (string, optional) — The URL on your call back server where a seen report will be sent.
    - **failover** (MessagesApiBaseFailover[], optional) — Provides options for configuring a message failover. When message fails it will be sent over channels in order specified in an array. It has to contain unique entries per channel and it cannot contain entry with the same channel as original message. **Make sure to provide correct sender and destinations specified as `Channels Destination` for each channel**.
      *oneOf:*

      - **Option 1** (MessagesApiFailover)
        - **channel** (OutboundMessageChannel, required) — Messaging channel used for sending a message.
          Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`
        - **sender** (string, optional) — Sender for channel specified above.
        - **content** (MessagesApiMessageContent, optional) — Content of the message.
          - **header** (MessagesApiMessageHeader, optional) — Header of the message.
            - **type** (MessagesApiMessageHeaderType, required)
              Possible values: `TEXT`
          - **body** (MessagesApiMessageBody, required) — Body of the message.
            - **type** (MessagesApiMessageBodyType, required)
              Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
          - **buttons** (MessagesApiMessageButton[], optional) — List of buttons of the message.
            - **type** (MessagesApiMessageButtonType, required)
              Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
          - **confirmationBody** (MessagesApiMessageConfirmationBody, optional) — Body of the confirmation message.
            - **text** (string, required) — Text to be sent.
            - **description** (string, optional) — Description to be sent.
            - **imageUrl** (string, optional) — URL of the image.
          - **senderDisplayInfo** (MessagesApiMessageSenderDisplayInfo, optional) — Sender display info (name and avatar). Used only for Viber Bot messages.
            - **name** (string, optional) — The sender's name to display.
            - **avatarUrl** (string, optional) — The sender's avatar URL.
          - **footer** (MessagesApiMessageFooter, optional) — Footer of the message.
            - **text** (string, required) — Text of the footer.
        - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
          - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
          - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
            Possible values: `SECONDS`, `MINUTES`, `HOURS`
      - **Option 2** (MessagesApiTemplateFailover)
        - **channel** (OutboundTemplateChannel, required) — Messaging channel used for sending a template message.
          Possible values: `APPLE_MB`, `RCS`, `VIBER_BM`, `WHATSAPP`, `KAKAO_ALIM`
        - **sender** (string, optional) — Sender for channel specified above.
        - **template** (MessagesApiTemplate, required) — Details of the template.
          - **templateName** (string, required) — Template name or identifier which given channel uses to send a template message.
          - **language** (string, optional) — Language of the template.
          - **referenceId** (string, optional) — Reference field (used only in Apple) to provide context of what the message is for (e.g. order number, case identifier, etc).
          - **groupKey** (string, optional) — Key associated with a group of templates. Used only in KAKAO_ALIM channel for templates registered under a group.
        - **content** (MessagesApiTemplateMessageContent, optional) — Content of the message.
          - **header** (MessagesApiTemplateHeader, optional) — Header of a template message.
            - **type** (MessagesApiTemplateHeaderType, required)
              Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`
          - **body** (MessagesApiTemplateBody, optional) — Body of a template message.
            - **type** (MessagesApiTemplateBodyType, required)
              Possible values: `TEXT`, `CAROUSEL`
          - **buttons** (MessagesApiTemplateButton[], optional) — List of buttons of a template message. Supported `type` values depend on `channel`: `WHATSAPP` supports QUICK_REPLY, OPEN_URL, PHONE_NUMBER, FLOW, COPY_CODE, CATALOG, MULTI_PRODUCT; `KAKAO_ALIM` supports URL_WITH_TEXT, APP_LINK, BOT_KEYWORD, CHATBOT_SWITCH, DELIVERY_TRACKING, MESSAGE_DELIVERY, ADD_CHANNEL.
            - **type** (MessagesApiTemplateButtonType, required)
              Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
          - **expirationTime** (string, optional) — Expiration time of a limited-time offer template message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
        - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
          - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
          - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
            Possible values: `SECONDS`, `MINUTES`, `HOURS`


- **options** (MessagesApiRequestOptions, optional) — Options applicable to all messages in the request.
  - **schedule** (RequestSchedulingSettings, optional) — Options for scheduling a message.
    - **bulkId** (string, optional) — Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response.
    - **sendAt** (string (date-time), optional) — Date and time when the message is to be sent. Used for scheduled messages. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, and can only be scheduled for no later than 180 days in advance.
    - **sendingSpeedLimit** (SendingSpeedLimit, optional) — Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.
      - **amount** (integer (int32), required) — The number of messages to be sent per timeUnit. By default, the system sends messages as fast as the infrastructure allows. Use this parameter to adapt sending capacity to your needs. The system is only able to work against its maximum capacity for ambitious message batches.
      - **timeUnit** (SpeedLimitTimeUnit, optional) — The time unit to define when setting a messaging speed limit. Defaults to `MINUTE`.
        Possible values: `MINUTE`, `HOUR`, `DAY`
  - **tracking** (UrlOptions, optional) — Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature. Does not apply to channels that do not support it: Instagram, LINE, Messenger, Viber Bot.
    - **shortenUrl** (boolean, optional) — Enable shortening of the URLs within a message. Set this to `true`, if you want to set up other URL options.
    - **trackClicks** (boolean, optional) — Enable tracking of short URL clicks within a message: which URL was clicked, how many times, and by whom.
    - **trackingUrl** (string, optional) — The URL of your callback server on to which the Click report will be sent.
    - **removeProtocol** (boolean, optional) — Remove a protocol, such as `https://`, from links to shorten a message. Note that some mobiles may not recognize such links as a URL.
    - **customDomain** (string, optional) — Select a predefined custom domain to use when generating a short URL.
  - **messageOrdering** (MessageOrderingOptions, optional) — Message ordering options.
    - **respectOrder** (boolean, optional) — If set to `true`, messages will be sent in the same order as they are provided in the request.
    - **stopOnFailure** (boolean, optional) — It can be used in combination with `respectOrder` to stop sending messages when first message from request fails.

### MessagesApiMessageCarouselBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **cards** (MessagesApiMessageCarouselCard[], optional) — Carousel cards.
  - **body** (MessagesApiMessageCarouselCardBody, required) — Body of a card.
    - **title** (string, optional) — Title of the card.
    - **text** (string, optional) — Text to be sent.
    - **url** (string, optional) — URL of the card's media. It can be image or video. When you provide it with `isVideo=true` then it will be mapped as a video, otherwise - as an image.
    - **isVideo** (boolean, optional) — Indicates if provided `url` is a video.
    - **thumbnailUrl** (string, optional) — URL of the thumbnail image. If you add this, then we use as thumbnail image for video you provided in `url`. Applicable only when `isVideo=true`.
    - **cardOptions** (MessagesApiMessageCardOptions, optional) — Set of alignment options for the Card.
      - **orientation** (MessagesApiMessageCardOptionsOrientationEnum, optional) — Orientation of the card.
        Possible values: `HORIZONTAL`, `VERTICAL`
      - **alignment** (MessagesApiMessageCardOptionsAlignmentEnum, optional) — Alignment of the card.
        Possible values: `LEFT`, `RIGHT`
      - **height** (MessagesApiMessageCardOptionsHeightEnum, optional) — Height of the card media.
        Possible values: `SHORT`, `MEDIUM`, `TALL`
  - **buttons** (MessagesApiMessageButton[], optional) — List of buttons of a card.
    - **type** (MessagesApiMessageButtonType, required)
      Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`

### MessagesApiMessageProductBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **text** (string, optional) — Content of message body. Required only for multi-product messages.
- **catalogId** (string, optional) — The ID that uniquely identifies the catalog
- **sections** (MessagesApiMessageProductSection[], optional) — An array of product sections. Header and title fields are required in case of multiple products.
  - **title** (string, optional) — The title of the section. Required, if the message has more than one section.
  - **productRetailerIds** (string[], required) — Unique product identifier, as defined in catalog.

### MessagesApiUpiIntentPaymentFormat

Format of the payment.

- **type** (MessagesApiUpiIntentPaymentFormatType, required)
  Possible values: `LINK`

### MessagesApiMessageDescriptiveTaxAmount

(WhatsApp specific, required) Tax amount of the order.

- **value** (number, optional) — Value of the amount (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
- **description** (string, optional) — Additional description of the amount. Optional for WhatsApp.

### DeliveryTime

The exact time of the day. The time is expressed in the UTC time zone.

- **hour** (integer (int32), required) — Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
- **minute** (integer (int32), required) — Minute when the time window opens when used in the `from` property or closes when used in the `to` property.

### MessagesApiTemplateBody

Body of a template message.

- **type** (MessagesApiTemplateBodyType, required)
  Possible values: `TEXT`, `CAROUSEL`

### MessagesApiTemplateDeliveryTrackingButton

- **type** (MessagesApiTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
- **text** (string, optional) — Text to be displayed on the button.

### MessagesApiMessageFormPage

An array of different pages to be shown in the form. If INTRO page is included it will always appear first.

- **type** (MessagesApiMessageFormPageType, required)
  Possible values: `INTRO`, `SELECT`, `PICKER`, `DATE_PICKER`, `INPUT`

### MessagesApiTemplateHeader

Header of a template message.

- **type** (MessagesApiTemplateHeaderType, required)
  Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`

### MessagesApiMessageImageFormat

Image format. Use `GIF` to enable animated GIF rendering. Supported only by `VIBER_BM`.

### MessagesApiMessageContent

Content of the message.

- **header** (MessagesApiMessageHeader, optional) — Header of the message.
  - **type** (MessagesApiMessageHeaderType, required)
    Possible values: `TEXT`
- **body** (MessagesApiMessageBody, required) — Body of the message.
  - **type** (MessagesApiMessageBodyType, required)
    Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **buttons** (MessagesApiMessageButton[], optional) — List of buttons of the message.
  - **type** (MessagesApiMessageButtonType, required)
    Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
- **confirmationBody** (MessagesApiMessageConfirmationBody, optional) — Body of the confirmation message.
  - **text** (string, required) — Text to be sent.
  - **description** (string, optional) — Description to be sent.
  - **imageUrl** (string, optional) — URL of the image.
- **senderDisplayInfo** (MessagesApiMessageSenderDisplayInfo, optional) — Sender display info (name and avatar). Used only for Viber Bot messages.
  - **name** (string, optional) — The sender's name to display.
  - **avatarUrl** (string, optional) — The sender's avatar URL.
- **footer** (MessagesApiMessageFooter, optional) — Footer of the message.
  - **text** (string, required) — Text of the footer.

### MessagesApiMessageOrderStatusBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **title** (string, optional) — Content of the message body.
- **id** (string, optional) — Unique identifier of the payment.
- **orderType** (MessagesApiMessageOrderStatusOrderType, optional) — Type of the order payment.
  Possible values: `UPI_PAYU`, `BRAZIL`, `BRAZIL_PIX_DC`, `PG_PAYU`, `PG_RAZORPAY`, `BRAZIL_LINK`, `BRAZIL_BOLETO`, `UPI_INTENT`
- **orderStatus** (MessagesApiMessageOrderStatusOrderStatus, optional) — Status of the order.
  Possible values: `PENDING`, `PROCESSING`, `PARTIALLY_SHIPPED`, `SHIPPED`, `COMPLETED`, `CANCELED`
- **description** (string, optional) — Description of the order status.

### RequestSchedulingSettings

Options for scheduling a message.

- **bulkId** (string, optional) — Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response.
- **sendAt** (string (date-time), optional) — Date and time when the message is to be sent. Used for scheduled messages. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, and can only be scheduled for no later than 180 days in advance.
- **sendingSpeedLimit** (SendingSpeedLimit, optional) — Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.
  - **amount** (integer (int32), required) — The number of messages to be sent per timeUnit. By default, the system sends messages as fast as the infrastructure allows. Use this parameter to adapt sending capacity to your needs. The system is only able to work against its maximum capacity for ambitious message batches.
  - **timeUnit** (SpeedLimitTimeUnit, optional) — The time unit to define when setting a messaging speed limit. Defaults to `MINUTE`.
    Possible values: `MINUTE`, `HOUR`, `DAY`

### MessagesApiTemplateMultiProductButton

- **type** (MessagesApiTemplateButtonType, required)
  Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
- **productId** (string, optional) — Product-unique identifier, as defined in catalog. If omitted, the image of the first item in your catalog will be used.
- **sections** (MessagesApiTemplateMultiProductButtonSection[], optional) — An array of multi product sections.
  - **title** (string, required) — Title of the section.
  - **productIds** (string[], required) — An array of product-unique identifiers as defined in the catalog. If product retailer ID doesn't exist in your catalog, the product won't be displayed.

### MessageGeneralStatus

Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).

### MessagesApiMessageBody

Body of the message.

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`

### MessagesApiMessageInputFormPageKeyboard

Type of keyboard to be shown.

### Channel

### MessagesApiMessageLocationBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **latitude** (number (double), optional) — Latitude of the location.
- **longitude** (number (double), optional) — Longitude of the location.
- **name** (string, optional) — Location name.
- **address** (string, optional) — Location address.

### RegionalOptions

Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.

- **indiaDlt** (IndiaDltOptions, optional) — Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
  - **contentTemplateId** (string, optional) — Registered DLT content template ID which matches message you are sending.
  - **principalEntityId** (string, required) — Your assigned DLT principal entity ID.
  - **telemarketerId** (string, optional) — Your assigned Telemarketer ID. (required for Aggregators)
- **turkeyIys** (TurkeyIysOptions, optional) — IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
  - **brandCode** (integer (int32), optional) — Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
  - **recipientType** (RecipientType, required) — Recipient Type must be `TACIR` or `BIREYSEL`.
    Possible values: `BIREYSEL`, `TACIR`
- **southKorea** (SouthKoreaOptions, optional) — Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
  - **title** (string, optional) — Title of the message.
  - **resellerCode** (integer (int32), optional) — Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.

### MessagesApiMessageOrderType

(WhatsApp specific, required) Type of the goods in the order.

### MessagesApiDelivery

Provides options for configuring the delivery report behavior.

- **url** (string, optional) — The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/api#notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.
- **intermediateReport** (boolean, optional) — The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. The default setting is `false`.
- **receiveTriggeredFailoverReports** (boolean, optional) — Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`.

### MessagesApiTemplateDocumentHeader

- **type** (MessagesApiTemplateHeaderType, required)
  Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`
- **url** (string, optional) — URL of a document.
- **filename** (string, optional) — Name of the file which will be used to display in message.

### MessagesApiMessageDatePickerFormPageOptions

Options of the page.

- **dateFormat** (string, optional) — Date format used on the page e.g. `MM/dd/yyyy`.
- **startDate** (string (date-time), optional) — Date displayed by the date picker. Has the following format: `YYYY-MM-DD`.
- **maximumDate** (string (date-time), optional) — Maximum date that the date picker can show. Has the following format: `YYYY-MM-DD`.
- **minimumDate** (string (date-time), optional) — Minimum date that the date picker can show. Has the following format: `YYYY-MM-DD`.
- **dateLabel** (string, optional) — Text to be shown next to the date field.

### MessagesApiTemplateCarouselCardHeader

Header of a card.

- **type** (MessagesApiTemplateCarouselCardHeaderType, required)
  Possible values: `IMAGE`, `VIDEO`

### MessagesApiMessageVideoBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **url** (string, optional) — URL of the video.
- **text** (string, optional) — Video caption.
- **thumbnailUrl** (string, optional) — URL of the thumbnail of the video (required and used only for Viber messages).

### MessagesApiMessageOrderItem

An array of items in the order.

- **name** (string, required) — Name of the item.
- **retailerId** (string, optional) — (WhatsApp specific, and required) Product-unique identifier, as defined in catalog.
- **quantity** (integer (int32), optional) — (WhatsApp specific) Item quantity.
- **amount** (number, required) — Price of the item (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
- **saleAmount** (number, optional) — (WhatsApp specific) Item discount (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)
- **importer** (MessagesApiMessageOrderImporter, optional) — (WhatsApp specific) Importer data. Required when catalogId is not provided. It's supported only for UPI PayU payments.
  - **name** (string, optional) — Name of the importer. Required when catalogId is not provided.
  - **address** (MessagesApiMessageOrderImporterAddress, optional) — Address of the importer. Required when catalogId is not provided.
    - **firstAddressLine** (string, optional) — First address line.
    - **secondAddressLine** (string, optional) — Second address line.
    - **city** (string, optional) — City name.
    - **zoneCode** (string, optional) — Zone code value.
    - **postalCode** (string, optional) — Zip code value.
    - **countryCode** (string, optional) — Country code value.
  - **originCountry** (string, optional) — Country of origin. Required when catalogId is not provided.

### MessagesApiMessageDatePickerFormPage

- **type** (MessagesApiMessageFormPageType, required)
  Possible values: `INTRO`, `SELECT`, `PICKER`, `DATE_PICKER`, `INPUT`
- **title** (string, optional) — Title of the page.
- **text** (string, optional) — Text of the page.
- **pageIdentifier** (string, optional) — Unique identifier of the page.
- **nextPageIdentifier** (string, optional) — Identifier of the next page. If not set, the client assumes the current page to be the final page.
- **submitForm** (boolean, optional) — Placed on the pages to denote the end page of the form. Can be set on multiple pages.
- **options** (MessagesApiMessageDatePickerFormPageOptions, optional) — Options of the page.
  - **dateFormat** (string, optional) — Date format used on the page e.g. `MM/dd/yyyy`.
  - **startDate** (string (date-time), optional) — Date displayed by the date picker. Has the following format: `YYYY-MM-DD`.
  - **maximumDate** (string (date-time), optional) — Maximum date that the date picker can show. Has the following format: `YYYY-MM-DD`.
  - **minimumDate** (string (date-time), optional) — Minimum date that the date picker can show. Has the following format: `YYYY-MM-DD`.
  - **dateLabel** (string, optional) — Text to be shown next to the date field.

### MessagesApiMessageBodyType

### MessagesApiMessagePaymentBeneficiaryCountry

Country name.

### MessagesApiBaseMessage

Array of message objects of a single message or multiple messages sent under one bulk ID.

*oneOf:*

- **Option 1** (MessagesApiMessage)
  - **channel** (OutboundMessageChannel, required) — Messaging channel used for sending a message.
    Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`
  - **sender** (string, optional) — The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
  - **destinations** (MessageDestination[], required) — Array of destination objects for where messages are being sent. A valid destination is required. **`Channels Destination` is required when sending messages with defined failover.**
    *oneOf:*

    - **Option 1** (MessagesApiChannelsDestination)
      - **messageId** (string, optional) — The ID that uniquely identifies the message sent. If failover is defined, then it will override values provided in `byChannel` array and be applied to each message in failover flow.
      - **byChannel** (MessagesApiChannelDestination[], required) — An array of substitute destinations, each associated with a specific `channel`. Only one substitute destination is allowed per `channel`. A substitute destination must be provided for the main `channel` defined in the `message`.
        - **channel** (Channel, required)
          Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`, `KAKAO_ALIM`
        - **to** (string, required) — The destination address of the message associated with given channel. It can be alphanumeric or numeric.
        - **messageId** (string, optional) — The ID that uniquely identifies the message sent.
    - **Option 2** (MessagesApiToDestination)
      - **to** (string, required) — The destination address of the message. It can be alphanumeric or numeric.
      - **messageId** (string, optional) — The ID that uniquely identifies the message sent.

  - **content** (MessagesApiMessageContent, required) — Content of the message.
    - **header** (MessagesApiMessageHeader, optional) — Header of the message.
      - **type** (MessagesApiMessageHeaderType, required)
        Possible values: `TEXT`
    - **body** (MessagesApiMessageBody, required) — Body of the message.
      - **type** (MessagesApiMessageBodyType, required)
        Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
    - **buttons** (MessagesApiMessageButton[], optional) — List of buttons of the message.
      - **type** (MessagesApiMessageButtonType, required)
        Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
    - **confirmationBody** (MessagesApiMessageConfirmationBody, optional) — Body of the confirmation message.
      - **text** (string, required) — Text to be sent.
      - **description** (string, optional) — Description to be sent.
      - **imageUrl** (string, optional) — URL of the image.
    - **senderDisplayInfo** (MessagesApiMessageSenderDisplayInfo, optional) — Sender display info (name and avatar). Used only for Viber Bot messages.
      - **name** (string, optional) — The sender's name to display.
      - **avatarUrl** (string, optional) — The sender's avatar URL.
    - **footer** (MessagesApiMessageFooter, optional) — Footer of the message.
      - **text** (string, required) — Text of the footer.
  - **options** (MessagesApiMessageOptions, optional) — Message options.
    - **platform** (Platform, optional) — Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      - **entityId** (string, optional) — Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      - **applicationId** (string, optional) — Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
    - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
      - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
      - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
        Possible values: `SECONDS`, `MINUTES`, `HOURS`
    - **deliveryTimeWindow** (DeliveryTimeWindow, optional) — Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.
      - **days** (DeliveryDay[], required) — Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
      - **from** (DeliveryTime, optional) — The exact time of the day. The time is expressed in the UTC time zone.
        - **hour** (integer (int32), required) — Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
        - **minute** (integer (int32), required) — Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
      - **to** (DeliveryTime, optional) — The exact time of the day. The time is expressed in the UTC time zone.
        - **hour** (integer (int32), required) — Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
        - **minute** (integer (int32), required) — Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
    - **adaptationMode** (boolean, optional) — If channel does not fully support message to be sent, we will try to map it as best effort. This is default behavior, even if this option is not specified.
    - **regional** (RegionalOptions, optional) — Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
      - **indiaDlt** (IndiaDltOptions, optional) — Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
        - **contentTemplateId** (string, optional) — Registered DLT content template ID which matches message you are sending.
        - **principalEntityId** (string, required) — Your assigned DLT principal entity ID.
        - **telemarketerId** (string, optional) — Your assigned Telemarketer ID. (required for Aggregators)
      - **turkeyIys** (TurkeyIysOptions, optional) — IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
        - **brandCode** (integer (int32), optional) — Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
        - **recipientType** (RecipientType, required) — Recipient Type must be `TACIR` or `BIREYSEL`.
          Possible values: `BIREYSEL`, `TACIR`
      - **southKorea** (SouthKoreaOptions, optional) — Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
        - **title** (string, optional) — Title of the message.
        - **resellerCode** (integer (int32), optional) — Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.
    - **campaignReferenceId** (string, optional) — ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
    - **transliteration** (TransliterationCode, optional) — The transliteration of your sent message from one script to another. Transliteration is used to replace characters which are not recognized as part of your defaulted alphabet. Possible values: `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `BULGARIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `PORTUGUESE`, `COLOMBIAN`, and `NON_UNICODE`. Supported by SMS.
      Possible values: `NONE`, `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `NON_UNICODE`, `PORTUGUESE`, `COLOMBIAN`, `BULGARIAN_CYRILLIC`, `ALL`
    - **correlationData** (string, optional) — Correlation data included in the outbound message. If provided, it will be returned in the inbound message. Auto-generated if not set explicitly.
    - **trafficType** (MessagesApiTrafficType, optional) — Traffic type classification for message sending. Supported by Viber for non-template messages only.
      Possible values: `PROMOTIONAL`, `TRANSACTIONAL`
    - **sessionRate** (boolean, optional) — Defines if the message should be charged using session rate. Supported by Viber for content with text/image/document only (without buttons, extra text etc.) body type. For text/image only body types `sessionRate` won't be applied if parameter `primaryDevice` is set to true.
    - **primaryDevice** (boolean, optional) — Defines if the message should be sent only to the end user's primary device (phone or tablet). Supported by Viber for message with content with text/image/document only (without buttons, extra text etc.) body type or template message.
  - **webhooks** (MessagesApiWebhooks, optional) — Provides options for configuring message webhooks.
    - **delivery** (MessagesApiDelivery, optional) — Provides options for configuring the delivery report behavior.
      - **url** (string, optional) — The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/api#notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.
      - **intermediateReport** (boolean, optional) — The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. The default setting is `false`.
      - **receiveTriggeredFailoverReports** (boolean, optional) — Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`.
    - **contentType** (string, optional) — Preferred delivery report content type, `application/json` or `application/xml`.
    - **callbackData** (string, optional) — Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report and Seen Report. The maximum value is 4000 characters.
    - **seen** (SeenStatusReporting, optional) — Provides options for configuring the seen report behavior.
      - **url** (string, optional) — The URL on your call back server where a seen report will be sent.
  - **failover** (MessagesApiBaseFailover[], optional) — Provides options for configuring a message failover. When message fails it will be sent over channels in order specified in an array. It has to contain unique entries per channel and it cannot contain entry with the same channel as original message. **Make sure to provide correct sender and destinations specified as `Channels Destination` for each channel**.
    *oneOf:*

    - **Option 1** (MessagesApiFailover)
      - **channel** (OutboundMessageChannel, required) — Messaging channel used for sending a message.
        Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`
      - **sender** (string, optional) — Sender for channel specified above.
      - **content** (MessagesApiMessageContent, optional) — Content of the message.
        - **header** (MessagesApiMessageHeader, optional) — Header of the message.
          - **type** (MessagesApiMessageHeaderType, required)
            Possible values: `TEXT`
        - **body** (MessagesApiMessageBody, required) — Body of the message.
          - **type** (MessagesApiMessageBodyType, required)
            Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
        - **buttons** (MessagesApiMessageButton[], optional) — List of buttons of the message.
          - **type** (MessagesApiMessageButtonType, required)
            Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
        - **confirmationBody** (MessagesApiMessageConfirmationBody, optional) — Body of the confirmation message.
          - **text** (string, required) — Text to be sent.
          - **description** (string, optional) — Description to be sent.
          - **imageUrl** (string, optional) — URL of the image.
        - **senderDisplayInfo** (MessagesApiMessageSenderDisplayInfo, optional) — Sender display info (name and avatar). Used only for Viber Bot messages.
          - **name** (string, optional) — The sender's name to display.
          - **avatarUrl** (string, optional) — The sender's avatar URL.
        - **footer** (MessagesApiMessageFooter, optional) — Footer of the message.
          - **text** (string, required) — Text of the footer.
      - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
        - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
          Possible values: `SECONDS`, `MINUTES`, `HOURS`
    - **Option 2** (MessagesApiTemplateFailover)
      - **channel** (OutboundTemplateChannel, required) — Messaging channel used for sending a template message.
        Possible values: `APPLE_MB`, `RCS`, `VIBER_BM`, `WHATSAPP`, `KAKAO_ALIM`
      - **sender** (string, optional) — Sender for channel specified above.
      - **template** (MessagesApiTemplate, required) — Details of the template.
        - **templateName** (string, required) — Template name or identifier which given channel uses to send a template message.
        - **language** (string, optional) — Language of the template.
        - **referenceId** (string, optional) — Reference field (used only in Apple) to provide context of what the message is for (e.g. order number, case identifier, etc).
        - **groupKey** (string, optional) — Key associated with a group of templates. Used only in KAKAO_ALIM channel for templates registered under a group.
      - **content** (MessagesApiTemplateMessageContent, optional) — Content of the message.
        - **header** (MessagesApiTemplateHeader, optional) — Header of a template message.
          - **type** (MessagesApiTemplateHeaderType, required)
            Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`
        - **body** (MessagesApiTemplateBody, optional) — Body of a template message.
          - **type** (MessagesApiTemplateBodyType, required)
            Possible values: `TEXT`, `CAROUSEL`
        - **buttons** (MessagesApiTemplateButton[], optional) — List of buttons of a template message. Supported `type` values depend on `channel`: `WHATSAPP` supports QUICK_REPLY, OPEN_URL, PHONE_NUMBER, FLOW, COPY_CODE, CATALOG, MULTI_PRODUCT; `KAKAO_ALIM` supports URL_WITH_TEXT, APP_LINK, BOT_KEYWORD, CHATBOT_SWITCH, DELIVERY_TRACKING, MESSAGE_DELIVERY, ADD_CHANNEL.
          - **type** (MessagesApiTemplateButtonType, required)
            Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
        - **expirationTime** (string, optional) — Expiration time of a limited-time offer template message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
      - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
        - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
          Possible values: `SECONDS`, `MINUTES`, `HOURS`

- **Option 2** (MessagesApiTemplateMessage)
  - **channel** (OutboundTemplateChannel, required) — Messaging channel used for sending a template message.
    Possible values: `APPLE_MB`, `RCS`, `VIBER_BM`, `WHATSAPP`, `KAKAO_ALIM`
  - **sender** (string, optional) — The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
  - **destinations** (MessageDestination[], required) — Array of destination objects for where messages are being sent. A valid destination is required. **`Channels Destination` is required when sending messages with defined failover.**
    *oneOf:*

    - **Option 1** (MessagesApiChannelsDestination)
      - **messageId** (string, optional) — The ID that uniquely identifies the message sent. If failover is defined, then it will override values provided in `byChannel` array and be applied to each message in failover flow.
      - **byChannel** (MessagesApiChannelDestination[], required) — An array of substitute destinations, each associated with a specific `channel`. Only one substitute destination is allowed per `channel`. A substitute destination must be provided for the main `channel` defined in the `message`.
        - **channel** (Channel, required)
          Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`, `KAKAO_ALIM`
        - **to** (string, required) — The destination address of the message associated with given channel. It can be alphanumeric or numeric.
        - **messageId** (string, optional) — The ID that uniquely identifies the message sent.
    - **Option 2** (MessagesApiToDestination)
      - **to** (string, required) — The destination address of the message. It can be alphanumeric or numeric.
      - **messageId** (string, optional) — The ID that uniquely identifies the message sent.

  - **template** (MessagesApiTemplate, required) — Details of the template.
    - **templateName** (string, required) — Template name or identifier which given channel uses to send a template message.
    - **language** (string, optional) — Language of the template.
    - **referenceId** (string, optional) — Reference field (used only in Apple) to provide context of what the message is for (e.g. order number, case identifier, etc).
    - **groupKey** (string, optional) — Key associated with a group of templates. Used only in KAKAO_ALIM channel for templates registered under a group.
  - **content** (MessagesApiTemplateMessageContent, optional) — Content of the message.
    - **header** (MessagesApiTemplateHeader, optional) — Header of a template message.
      - **type** (MessagesApiTemplateHeaderType, required)
        Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`
    - **body** (MessagesApiTemplateBody, optional) — Body of a template message.
      - **type** (MessagesApiTemplateBodyType, required)
        Possible values: `TEXT`, `CAROUSEL`
    - **buttons** (MessagesApiTemplateButton[], optional) — List of buttons of a template message. Supported `type` values depend on `channel`: `WHATSAPP` supports QUICK_REPLY, OPEN_URL, PHONE_NUMBER, FLOW, COPY_CODE, CATALOG, MULTI_PRODUCT; `KAKAO_ALIM` supports URL_WITH_TEXT, APP_LINK, BOT_KEYWORD, CHATBOT_SWITCH, DELIVERY_TRACKING, MESSAGE_DELIVERY, ADD_CHANNEL.
      - **type** (MessagesApiTemplateButtonType, required)
        Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
    - **expirationTime** (string, optional) — Expiration time of a limited-time offer template message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
  - **options** (MessagesApiMessageOptions, optional) — Message options.
    - **platform** (Platform, optional) — Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      - **entityId** (string, optional) — Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      - **applicationId** (string, optional) — Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
    - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
      - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
      - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
        Possible values: `SECONDS`, `MINUTES`, `HOURS`
    - **deliveryTimeWindow** (DeliveryTimeWindow, optional) — Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.
      - **days** (DeliveryDay[], required) — Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
      - **from** (DeliveryTime, optional) — The exact time of the day. The time is expressed in the UTC time zone.
        - **hour** (integer (int32), required) — Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
        - **minute** (integer (int32), required) — Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
      - **to** (DeliveryTime, optional) — The exact time of the day. The time is expressed in the UTC time zone.
        - **hour** (integer (int32), required) — Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
        - **minute** (integer (int32), required) — Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
    - **adaptationMode** (boolean, optional) — If channel does not fully support message to be sent, we will try to map it as best effort. This is default behavior, even if this option is not specified.
    - **regional** (RegionalOptions, optional) — Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
      - **indiaDlt** (IndiaDltOptions, optional) — Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
        - **contentTemplateId** (string, optional) — Registered DLT content template ID which matches message you are sending.
        - **principalEntityId** (string, required) — Your assigned DLT principal entity ID.
        - **telemarketerId** (string, optional) — Your assigned Telemarketer ID. (required for Aggregators)
      - **turkeyIys** (TurkeyIysOptions, optional) — IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
        - **brandCode** (integer (int32), optional) — Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
        - **recipientType** (RecipientType, required) — Recipient Type must be `TACIR` or `BIREYSEL`.
          Possible values: `BIREYSEL`, `TACIR`
      - **southKorea** (SouthKoreaOptions, optional) — Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
        - **title** (string, optional) — Title of the message.
        - **resellerCode** (integer (int32), optional) — Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.
    - **campaignReferenceId** (string, optional) — ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
    - **transliteration** (TransliterationCode, optional) — The transliteration of your sent message from one script to another. Transliteration is used to replace characters which are not recognized as part of your defaulted alphabet. Possible values: `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `BULGARIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `PORTUGUESE`, `COLOMBIAN`, and `NON_UNICODE`. Supported by SMS.
      Possible values: `NONE`, `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `NON_UNICODE`, `PORTUGUESE`, `COLOMBIAN`, `BULGARIAN_CYRILLIC`, `ALL`
    - **correlationData** (string, optional) — Correlation data included in the outbound message. If provided, it will be returned in the inbound message. Auto-generated if not set explicitly.
    - **trafficType** (MessagesApiTrafficType, optional) — Traffic type classification for message sending. Supported by Viber for non-template messages only.
      Possible values: `PROMOTIONAL`, `TRANSACTIONAL`
    - **sessionRate** (boolean, optional) — Defines if the message should be charged using session rate. Supported by Viber for content with text/image/document only (without buttons, extra text etc.) body type. For text/image only body types `sessionRate` won't be applied if parameter `primaryDevice` is set to true.
    - **primaryDevice** (boolean, optional) — Defines if the message should be sent only to the end user's primary device (phone or tablet). Supported by Viber for message with content with text/image/document only (without buttons, extra text etc.) body type or template message.
  - **webhooks** (MessagesApiWebhooks, optional) — Provides options for configuring message webhooks.
    - **delivery** (MessagesApiDelivery, optional) — Provides options for configuring the delivery report behavior.
      - **url** (string, optional) — The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/api#notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.
      - **intermediateReport** (boolean, optional) — The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. The default setting is `false`.
      - **receiveTriggeredFailoverReports** (boolean, optional) — Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`.
    - **contentType** (string, optional) — Preferred delivery report content type, `application/json` or `application/xml`.
    - **callbackData** (string, optional) — Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report and Seen Report. The maximum value is 4000 characters.
    - **seen** (SeenStatusReporting, optional) — Provides options for configuring the seen report behavior.
      - **url** (string, optional) — The URL on your call back server where a seen report will be sent.
  - **failover** (MessagesApiBaseFailover[], optional) — Provides options for configuring a message failover. When message fails it will be sent over channels in order specified in an array. It has to contain unique entries per channel and it cannot contain entry with the same channel as original message. **Make sure to provide correct sender and destinations specified as `Channels Destination` for each channel**.
    *oneOf:*

    - **Option 1** (MessagesApiFailover)
      - **channel** (OutboundMessageChannel, required) — Messaging channel used for sending a message.
        Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`
      - **sender** (string, optional) — Sender for channel specified above.
      - **content** (MessagesApiMessageContent, optional) — Content of the message.
        - **header** (MessagesApiMessageHeader, optional) — Header of the message.
          - **type** (MessagesApiMessageHeaderType, required)
            Possible values: `TEXT`
        - **body** (MessagesApiMessageBody, required) — Body of the message.
          - **type** (MessagesApiMessageBodyType, required)
            Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
        - **buttons** (MessagesApiMessageButton[], optional) — List of buttons of the message.
          - **type** (MessagesApiMessageButtonType, required)
            Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
        - **confirmationBody** (MessagesApiMessageConfirmationBody, optional) — Body of the confirmation message.
          - **text** (string, required) — Text to be sent.
          - **description** (string, optional) — Description to be sent.
          - **imageUrl** (string, optional) — URL of the image.
        - **senderDisplayInfo** (MessagesApiMessageSenderDisplayInfo, optional) — Sender display info (name and avatar). Used only for Viber Bot messages.
          - **name** (string, optional) — The sender's name to display.
          - **avatarUrl** (string, optional) — The sender's avatar URL.
        - **footer** (MessagesApiMessageFooter, optional) — Footer of the message.
          - **text** (string, required) — Text of the footer.
      - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
        - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
          Possible values: `SECONDS`, `MINUTES`, `HOURS`
    - **Option 2** (MessagesApiTemplateFailover)
      - **channel** (OutboundTemplateChannel, required) — Messaging channel used for sending a template message.
        Possible values: `APPLE_MB`, `RCS`, `VIBER_BM`, `WHATSAPP`, `KAKAO_ALIM`
      - **sender** (string, optional) — Sender for channel specified above.
      - **template** (MessagesApiTemplate, required) — Details of the template.
        - **templateName** (string, required) — Template name or identifier which given channel uses to send a template message.
        - **language** (string, optional) — Language of the template.
        - **referenceId** (string, optional) — Reference field (used only in Apple) to provide context of what the message is for (e.g. order number, case identifier, etc).
        - **groupKey** (string, optional) — Key associated with a group of templates. Used only in KAKAO_ALIM channel for templates registered under a group.
      - **content** (MessagesApiTemplateMessageContent, optional) — Content of the message.
        - **header** (MessagesApiTemplateHeader, optional) — Header of a template message.
          - **type** (MessagesApiTemplateHeaderType, required)
            Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`
        - **body** (MessagesApiTemplateBody, optional) — Body of a template message.
          - **type** (MessagesApiTemplateBodyType, required)
            Possible values: `TEXT`, `CAROUSEL`
        - **buttons** (MessagesApiTemplateButton[], optional) — List of buttons of a template message. Supported `type` values depend on `channel`: `WHATSAPP` supports QUICK_REPLY, OPEN_URL, PHONE_NUMBER, FLOW, COPY_CODE, CATALOG, MULTI_PRODUCT; `KAKAO_ALIM` supports URL_WITH_TEXT, APP_LINK, BOT_KEYWORD, CHATBOT_SWITCH, DELIVERY_TRACKING, MESSAGE_DELIVERY, ADD_CHANNEL.
          - **type** (MessagesApiTemplateButtonType, required)
            Possible values: `QUICK_REPLY`, `OPEN_URL`, `URL_WITH_TEXT`, `PHONE_NUMBER`, `FLOW`, `COPY_CODE`, `CATALOG`, `MULTI_PRODUCT`, `APP_LINK`, `BOT_KEYWORD`, `CHATBOT_SWITCH`, `DELIVERY_TRACKING`, `MESSAGE_DELIVERY`, `ADD_CHANNEL`
        - **expirationTime** (string, optional) — Expiration time of a limited-time offer template message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
      - **validityPeriod** (ValidityPeriod, optional) — Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
        - **amount** (integer (int32), required) — Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        - **timeUnit** (ValidityPeriodTimeUnit, optional) — Message validity period time unit.
          Possible values: `SECONDS`, `MINUTES`, `HOURS`



### MessagesApiMessageInputFormInputType

Type of input.

### MessagesApiChannelDestination

An array of substitute destinations, each associated with a specific `channel`. Only one substitute destination is allowed per `channel`. A substitute destination must be provided for the main `channel` defined in the `message`.

- **channel** (Channel, required)
  Possible values: `APPLE_MB`, `INSTAGRAM_DM`, `LINE_ON`, `MESSENGER`, `MMS`, `RCS`, `SMS`, `VIBER_BM`, `VIBER_BOT`, `WHATSAPP`, `KAKAO_ALIM`
- **to** (string, required) — The destination address of the message associated with given channel. It can be alphanumeric or numeric.
- **messageId** (string, optional) — The ID that uniquely identifies the message sent.

### MessagesApiMessageShowLocationButton

- **type** (MessagesApiMessageButtonType, required)
  Possible values: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `ADD_CALENDAR_EVENT`
- **text** (string, optional) — Text to be displayed on the button.
- **latitude** (number (double), optional) — Latitude of the location.
- **longitude** (number (double), optional) — Longitude of the location.
- **name** (string, optional) — Location name.
- **postbackData** (string, optional) — Custom data that will be sent to you when the user replies to the message.

### MessagesApiMessagePgPayuPaymentConfiguration

- **type** (MessagesApiMessagePaymentConfigurationType, required)
  Possible values: `PG_PAYU`, `PG_RAZORPAY`, `UPI_PAYU`, `BRAZIL`, `BRAZIL_PIX_DC`, `BRAZIL_LINK`, `BRAZIL_BOLETO`, `UPI_INTENT`, `APPLE_PAY`
- **id** (string, optional) — Unique identifier of the payment. It can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters
- **name** (string, optional) — Name of the WhatsApp payment configuration to be used for this order.
- **beneficiary** (MessagesApiMessagePaymentBeneficiary, optional) — Beneficiary of the payment.
  - **name** (string, optional) — Beneficiary's name.
  - **firstAddressLine** (string, optional) — First address line.
  - **secondAddressLine** (string, optional) — Second address line.
  - **city** (string, optional) — City name.
  - **state** (string, optional) — State name.
  - **country** (MessagesApiMessagePaymentBeneficiaryCountry, optional) — Country name.
    Possible values: `INDIA`
  - **postalCode** (string, optional) — Zip code value.
- **callbackData** (string[], optional) — List of custom parameters corresponding to the transaction.

### MessagesApiMessageSenderDisplayInfo

Sender display info (name and avatar). Used only for Viber Bot messages.

- **name** (string, optional) — The sender's name to display.
- **avatarUrl** (string, optional) — The sender's avatar URL.

### MessagesApiTemplateLocationHeader

- **type** (MessagesApiTemplateHeaderType, required)
  Possible values: `TEXT`, `DOCUMENT`, `IMAGE`, `VIDEO`, `LOCATION`
- **latitude** (number (double), optional) — Latitude of the location.
- **longitude** (number (double), optional) — Longitude of the location.

### MessagesApiMessagePaymentBeneficiary

Beneficiary of the payment.

- **name** (string, optional) — Beneficiary's name.
- **firstAddressLine** (string, optional) — First address line.
- **secondAddressLine** (string, optional) — Second address line.
- **city** (string, optional) — City name.
- **state** (string, optional) — State name.
- **country** (MessagesApiMessagePaymentBeneficiaryCountry, optional) — Country name.
  Possible values: `INDIA`
- **postalCode** (string, optional) — Zip code value.

### MessagesApiMessageMixedItem

Mixed items.

*oneOf:*

- **Option 1** (MessagesApiMessageMixedMediaItem)
  - **url** (string, required) — URL of the media's item.
  - **contentId** (string, optional) — Custom content identifier for the media item. Supported by MMS only (Apple ignores).
- **Option 2** (MessagesApiMessageMixedTextItem)
  - **text** (string, required) — Text to be sent.
  - **contentId** (string, optional) — Custom content identifier for the text item. Supported by MMS only (Apple ignores).


### MessagesApiMessageCardOptionsHeightEnum

Height of the card media.

### ResponseEnvelopeMessageResponseMessageResponseDetails

- **bulkId** (string, optional) — Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response. Typically used for fetching delivery reports and message logs.
- **messages** (MessageResponseMessageResponseDetails[], required) — An array of message objects of a single message or multiple messages sent under one bulk ID.
  - **messageId** (string, optional) — Unique message ID. If not provided, it will be auto-generated and returned in the API response.
  - **status** (MessageStatus, optional) — Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.
    - **groupId** (integer (int32), optional) — Status group ID.
    - **groupName** (MessageGeneralStatus, optional) — Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).
      Possible values: `ACCEPTED`, `PENDING`, `UNDELIVERABLE`, `DELIVERED`, `EXPIRED`, `REJECTED`
    - **id** (integer (int32), optional) — Status code ID.
    - **name** (string, optional) — [Status code](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) name.
    - **description** (string, optional) — Human-readable description of the status.
    - **action** (string, optional) — Action to take to recover from the error.
  - **destination** (string, optional) — The destination address of the message, i.e., its recipient.
  - **details** (MessageResponseDetails, optional) — Other details of the message.

### MessagesApiMessageListBody

- **type** (MessagesApiMessageBodyType, required)
  Possible values: `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT`, `RICH_LINK`, `AUTHENTICATION_REQUEST`, `LIST`, `CAROUSEL`, `LOCATION`, `CONTACT`, `STICKER`, `PRODUCT`, `MIXED`, `FLOW`, `TIME_PICKER`, `ORDER_REQUEST`, `ORDER_STATUS`, `FORM`
- **text** (string, optional) — Text to be sent.
- **subtext** (string, optional) — Subtext to be sent.
- **imageUrl** (string, optional) — URL of the image.
- **sections** (MessagesApiMessageListSection[], optional) — Section's list.
  - **sectionTitle** (string, required) — Section's title
  - **multipleSelection** (boolean, optional) — Multiple Selection.
  - **items** (MessagesApiMessageListItem[], required) — List Items.
    - **id** (string, optional) — Item ID (supported only by WhatsApp), has to be unique for each item.
    - **text** (string, required) — Item Text.
    - **description** (string, optional) — Item Description.
    - **imageUrl** (string, optional) — Item's Image URL.
