> For the complete documentation index, see [llms.txt](https://help.clickatell.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.clickatell.com/developers-api-reference/reference/models.md).

# Models

## The FallbackStatus object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"FallbackStatus":{"type":"object","properties":{"channel":{"type":"string","enum":["sms","whatsapp"]},"timestamp":{"type":"integer","format":"int64"},"statusDescription":{"type":"integer","format":"int32"},"status":{"type":"string"},"messageId":{"type":"string"},"clientMessageId":{"type":"string"}}}}}}
```

## The MessageStatus object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"MessageStatus":{"type":"object","properties":{"channel":{"type":"string","enum":["sms","whatsapp"]},"timestamp":{"type":"integer","format":"int64"},"statusCode":{"type":"integer","format":"int32"},"status":{"type":"string"},"messageId":{"type":"string"},"clientMessageId":{"type":"string"}}}}}}
```

## The OmniStatusCallbackRequest object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"OmniStatusCallbackRequest":{"type":"object","properties":{"integrationId":{"type":"string"},"integrationName":{"type":"string"},"event":{"$ref":"#/components/schemas/StatusEvents"}}},"StatusEvents":{"type":"object","properties":{"messageStatusUpdate":{"type":"array","items":{"$ref":"#/components/schemas/MessageStatus"}},"messageFallback":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/FallbackStatus"}},"statusIsTyping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/TypingStatus"}}}},"MessageStatus":{"type":"object","properties":{"channel":{"type":"string","enum":["sms","whatsapp"]},"timestamp":{"type":"integer","format":"int64"},"statusCode":{"type":"integer","format":"int32"},"status":{"type":"string"},"messageId":{"type":"string"},"clientMessageId":{"type":"string"}}},"FallbackStatus":{"type":"object","properties":{"channel":{"type":"string","enum":["sms","whatsapp"]},"timestamp":{"type":"integer","format":"int64"},"statusDescription":{"type":"integer","format":"int32"},"status":{"type":"string"},"messageId":{"type":"string"},"clientMessageId":{"type":"string"}}},"TypingStatus":{"type":"object","properties":{"channel":{"type":"string","enum":["sms","whatsapp"]},"timestamp":{"type":"integer","format":"int64"},"from":{"type":"string"}}}}}}
```

## The StatusEvents object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"StatusEvents":{"type":"object","properties":{"messageStatusUpdate":{"type":"array","items":{"$ref":"#/components/schemas/MessageStatus"}},"messageFallback":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/FallbackStatus"}},"statusIsTyping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/TypingStatus"}}}},"MessageStatus":{"type":"object","properties":{"channel":{"type":"string","enum":["sms","whatsapp"]},"timestamp":{"type":"integer","format":"int64"},"statusCode":{"type":"integer","format":"int32"},"status":{"type":"string"},"messageId":{"type":"string"},"clientMessageId":{"type":"string"}}},"FallbackStatus":{"type":"object","properties":{"channel":{"type":"string","enum":["sms","whatsapp"]},"timestamp":{"type":"integer","format":"int64"},"statusDescription":{"type":"integer","format":"int32"},"status":{"type":"string"},"messageId":{"type":"string"},"clientMessageId":{"type":"string"}}},"TypingStatus":{"type":"object","properties":{"channel":{"type":"string","enum":["sms","whatsapp"]},"timestamp":{"type":"integer","format":"int64"},"from":{"type":"string"}}}}}}
```

## The TypingStatus object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"TypingStatus":{"type":"object","properties":{"channel":{"type":"string","enum":["sms","whatsapp"]},"timestamp":{"type":"integer","format":"int64"},"from":{"type":"string"}}}}}}
```

## The ButtonResponseReply object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"ButtonResponseReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"postbackData":{"type":"string"},"selectedItem":{"$ref":"#/components/schemas/SelectedButtonItem"}}},"WhatsAppContent":{"type":"object","properties":{"profileName":{"type":"string","description":"Users profile name as set up on their WA Client"},"referralInfo":{"$ref":"#/components/schemas/ReferralInfo"},"userId":{"type":"string","description":"Business-Scoped User ID (BSUID) of the WhatsApp user. Format: CC.alphanumeric (max 131 chars). Always present for WhatsApp messages. Not encrypted for client-side encryption."},"parentUserId":{"type":"string","description":"Parent BSUID for linked business portfolios. Format: CC.ENT.alphanumeric (max 135 chars). Present only if your company is an eligible enterprise explicitly enrolled in a Parent BSUID account. Not encrypted for client-side encryption."},"username":{"type":"string","description":"WhatsApp username handle. Present only if the user has enabled a username. Encrypted for client-side encryption."}},"description":"WhatsApp specific content"},"ReferralInfo":{"type":"object","properties":{"headline":{"type":"string","description":"Headline used in the ad that generated the message."},"content":{"type":"string","description":"Body from the ad that generated the message."},"sourceType":{"type":"string","description":"The type of the ad’s source.","enum":["ad","post"]},"sourceId":{"type":"string","description":"Facebook ID for an ad or a post."},"sourceUrl":{"type":"string","description":"The url that leads to the ad or post. Opening this url takes you to the ad viewed by your user."}}},"SelectedButtonItem":{"type":"object","properties":{"postbackData":{"type":"string"},"content":{"type":"string"}}}}}}
```

## The ContactsReply object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"ContactsReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/WhatsAppContact"}},"charset":{"type":"string"}}},"WhatsAppContent":{"type":"object","properties":{"profileName":{"type":"string","description":"Users profile name as set up on their WA Client"},"referralInfo":{"$ref":"#/components/schemas/ReferralInfo"},"userId":{"type":"string","description":"Business-Scoped User ID (BSUID) of the WhatsApp user. Format: CC.alphanumeric (max 131 chars). Always present for WhatsApp messages. Not encrypted for client-side encryption."},"parentUserId":{"type":"string","description":"Parent BSUID for linked business portfolios. Format: CC.ENT.alphanumeric (max 135 chars). Present only if your company is an eligible enterprise explicitly enrolled in a Parent BSUID account. Not encrypted for client-side encryption."},"username":{"type":"string","description":"WhatsApp username handle. Present only if the user has enabled a username. Encrypted for client-side encryption."}},"description":"WhatsApp specific content"},"ReferralInfo":{"type":"object","properties":{"headline":{"type":"string","description":"Headline used in the ad that generated the message."},"content":{"type":"string","description":"Body from the ad that generated the message."},"sourceType":{"type":"string","description":"The type of the ad’s source.","enum":["ad","post"]},"sourceId":{"type":"string","description":"Facebook ID for an ad or a post."},"sourceUrl":{"type":"string","description":"The url that leads to the ad or post. Opening this url takes you to the ad viewed by your user."}}},"WhatsAppContact":{"required":["name"],"type":"object","properties":{"addresses":{"minItems":1,"type":"array","description":"List of address object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"birthday":{"pattern":"YYYY-MM-DD","type":"string","description":"String date value."},"emails":{"minItems":1,"type":"array","description":"List of the email object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"name":{"type":"object","additionalProperties":{"type":"string","description":"Name object. See request example WhatsApp Contacts: One message"},"description":"Name object. See request example WhatsApp Contacts: One message"},"origin":{"type":"string","description":"<b>WhatsApp inbound only</b><br>Indicates how the contact was shared by the user. <i>contact_request</i> means the contact was shared in direct response to a REQUEST_CONTACT_INFO button; <i>other</i> means the contact was shared organically (e.g. a forwarded vCard). Present only on inbound contact messages when supplied by WhatsApp; omitted when absent. Not encrypted for client-side encryption.","enum":["contact_request","other"]},"org":{"type":"object","additionalProperties":{"type":"string","description":"See request example WhatsApp Contacts: One message"},"description":"See request example WhatsApp Contacts: One message"},"phones":{"minItems":1,"type":"array","description":"List of the phone object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"urls":{"minItems":1,"type":"array","description":"List of the url object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}}}}}}}
```

## The InlineMediaReply object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"InlineMediaReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"caption":{"type":"string"},"content":{"type":"string"},"sha256Hash":{"type":"string"},"contentType":{"type":"string"}}},"WhatsAppContent":{"type":"object","properties":{"profileName":{"type":"string","description":"Users profile name as set up on their WA Client"},"referralInfo":{"$ref":"#/components/schemas/ReferralInfo"},"userId":{"type":"string","description":"Business-Scoped User ID (BSUID) of the WhatsApp user. Format: CC.alphanumeric (max 131 chars). Always present for WhatsApp messages. Not encrypted for client-side encryption."},"parentUserId":{"type":"string","description":"Parent BSUID for linked business portfolios. Format: CC.ENT.alphanumeric (max 135 chars). Present only if your company is an eligible enterprise explicitly enrolled in a Parent BSUID account. Not encrypted for client-side encryption."},"username":{"type":"string","description":"WhatsApp username handle. Present only if the user has enabled a username. Encrypted for client-side encryption."}},"description":"WhatsApp specific content"},"ReferralInfo":{"type":"object","properties":{"headline":{"type":"string","description":"Headline used in the ad that generated the message."},"content":{"type":"string","description":"Body from the ad that generated the message."},"sourceType":{"type":"string","description":"The type of the ad’s source.","enum":["ad","post"]},"sourceId":{"type":"string","description":"Facebook ID for an ad or a post."},"sourceUrl":{"type":"string","description":"The url that leads to the ad or post. Opening this url takes you to the ad viewed by your user."}}}}}}
```

## The ListPickerResponseReply object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"ListPickerResponseReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"postbackData":{"type":"string"},"selectedItems":{"type":"array","items":{"$ref":"#/components/schemas/SelectedButtonItem"}}}},"WhatsAppContent":{"type":"object","properties":{"profileName":{"type":"string","description":"Users profile name as set up on their WA Client"},"referralInfo":{"$ref":"#/components/schemas/ReferralInfo"},"userId":{"type":"string","description":"Business-Scoped User ID (BSUID) of the WhatsApp user. Format: CC.alphanumeric (max 131 chars). Always present for WhatsApp messages. Not encrypted for client-side encryption."},"parentUserId":{"type":"string","description":"Parent BSUID for linked business portfolios. Format: CC.ENT.alphanumeric (max 135 chars). Present only if your company is an eligible enterprise explicitly enrolled in a Parent BSUID account. Not encrypted for client-side encryption."},"username":{"type":"string","description":"WhatsApp username handle. Present only if the user has enabled a username. Encrypted for client-side encryption."}},"description":"WhatsApp specific content"},"ReferralInfo":{"type":"object","properties":{"headline":{"type":"string","description":"Headline used in the ad that generated the message."},"content":{"type":"string","description":"Body from the ad that generated the message."},"sourceType":{"type":"string","description":"The type of the ad’s source.","enum":["ad","post"]},"sourceId":{"type":"string","description":"Facebook ID for an ad or a post."},"sourceUrl":{"type":"string","description":"The url that leads to the ad or post. Opening this url takes you to the ad viewed by your user."}}},"SelectedButtonItem":{"type":"object","properties":{"postbackData":{"type":"string"},"content":{"type":"string"}}}}}}
```

## The LocationReply object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"LocationReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"charset":{"type":"string","description":"Character encoding","default":"UTF-8"},"locationAddress":{"type":"string","description":"Address of the location"},"locationName":{"type":"string","description":"Name of the location"},"latitude":{"type":"string","description":"Numeric latitude value expressed as a string"},"latitute":{"type":"string","description":"Numeric latitude value expressed as a string"},"longitude":{"type":"string","description":"Numeric longitude value expressed as a string"}}},"WhatsAppContent":{"type":"object","properties":{"profileName":{"type":"string","description":"Users profile name as set up on their WA Client"},"referralInfo":{"$ref":"#/components/schemas/ReferralInfo"},"userId":{"type":"string","description":"Business-Scoped User ID (BSUID) of the WhatsApp user. Format: CC.alphanumeric (max 131 chars). Always present for WhatsApp messages. Not encrypted for client-side encryption."},"parentUserId":{"type":"string","description":"Parent BSUID for linked business portfolios. Format: CC.ENT.alphanumeric (max 135 chars). Present only if your company is an eligible enterprise explicitly enrolled in a Parent BSUID account. Not encrypted for client-side encryption."},"username":{"type":"string","description":"WhatsApp username handle. Present only if the user has enabled a username. Encrypted for client-side encryption."}},"description":"WhatsApp specific content"},"ReferralInfo":{"type":"object","properties":{"headline":{"type":"string","description":"Headline used in the ad that generated the message."},"content":{"type":"string","description":"Body from the ad that generated the message."},"sourceType":{"type":"string","description":"The type of the ad’s source.","enum":["ad","post"]},"sourceId":{"type":"string","description":"Facebook ID for an ad or a post."},"sourceUrl":{"type":"string","description":"The url that leads to the ad or post. Opening this url takes you to the ad viewed by your user."}}}}}}
```

## The MediaReply object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"MediaReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"caption":{"type":"string"}},"anyOf":[{"$ref":"#/components/schemas/InlineMediaReply"},{"$ref":"#/components/schemas/ReferenceMediaReply"}]},"WhatsAppContent":{"type":"object","properties":{"profileName":{"type":"string","description":"Users profile name as set up on their WA Client"},"referralInfo":{"$ref":"#/components/schemas/ReferralInfo"},"userId":{"type":"string","description":"Business-Scoped User ID (BSUID) of the WhatsApp user. Format: CC.alphanumeric (max 131 chars). Always present for WhatsApp messages. Not encrypted for client-side encryption."},"parentUserId":{"type":"string","description":"Parent BSUID for linked business portfolios. Format: CC.ENT.alphanumeric (max 135 chars). Present only if your company is an eligible enterprise explicitly enrolled in a Parent BSUID account. Not encrypted for client-side encryption."},"username":{"type":"string","description":"WhatsApp username handle. Present only if the user has enabled a username. Encrypted for client-side encryption."}},"description":"WhatsApp specific content"},"ReferralInfo":{"type":"object","properties":{"headline":{"type":"string","description":"Headline used in the ad that generated the message."},"content":{"type":"string","description":"Body from the ad that generated the message."},"sourceType":{"type":"string","description":"The type of the ad’s source.","enum":["ad","post"]},"sourceId":{"type":"string","description":"Facebook ID for an ad or a post."},"sourceUrl":{"type":"string","description":"The url that leads to the ad or post. Opening this url takes you to the ad viewed by your user."}}},"InlineMediaReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"caption":{"type":"string"},"content":{"type":"string"},"sha256Hash":{"type":"string"},"contentType":{"type":"string"}}},"ReferenceMediaReply":{"required":["files"],"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"caption":{"type":"string"},"files":{"type":"array","description":"An array of the file object with a list of media items that is attached to the inbound media message. This parameter is only applicable to MO event callbacks for media by reference ","items":{"$ref":"#/components/schemas/ReferenceMediaFile"}}}},"ReferenceMediaFile":{"required":["byteSize","contentType","downloadUrl"],"type":"object","properties":{"contentType":{"type":"string","description":"Media content type for the media item"},"downloadUrl":{"type":"string","description":"Download URL to be used for downloading the media item"},"sha256Hash":{"type":"string"},"byteSize":{"type":"integer","description":"Byte size of the file to be downloaded","format":"int64"},"fileName":{"type":"string","description":"Original file name (if it is available)"}}}}}}
```

## The OmniReplyCallbackRequest object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"OmniReplyCallbackRequest":{"type":"object","properties":{"integrationId":{"type":"string"},"integrationName":{"type":"string"},"event":{"$ref":"#/components/schemas/ReplyEvents"}}},"ReplyEvents":{"type":"object","properties":{"moText":{"type":"array","items":{"$ref":"#/components/schemas/TextReply"}},"moMedia":{"type":"array","items":{"$ref":"#/components/schemas/MediaReply"}},"moLocation":{"type":"array","items":{"$ref":"#/components/schemas/LocationReply"}},"moContacts":{"type":"array","items":{"$ref":"#/components/schemas/ContactsReply"}},"moSuggestedResponse":{"type":"array","items":{"$ref":"#/components/schemas/SuggestedResponseReply"}},"moListPickerResponse":{"type":"array","items":{"$ref":"#/components/schemas/ListPickerResponseReply"}},"moButtonResponse":{"type":"array","items":{"$ref":"#/components/schemas/ButtonResponseReply"}}}},"TextReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"charset":{"type":"string"},"content":{"type":"string"},"sms":{"$ref":"#/components/schemas/Sms"}}},"WhatsAppContent":{"type":"object","properties":{"profileName":{"type":"string","description":"Users profile name as set up on their WA Client"},"referralInfo":{"$ref":"#/components/schemas/ReferralInfo"},"userId":{"type":"string","description":"Business-Scoped User ID (BSUID) of the WhatsApp user. Format: CC.alphanumeric (max 131 chars). Always present for WhatsApp messages. Not encrypted for client-side encryption."},"parentUserId":{"type":"string","description":"Parent BSUID for linked business portfolios. Format: CC.ENT.alphanumeric (max 135 chars). Present only if your company is an eligible enterprise explicitly enrolled in a Parent BSUID account. Not encrypted for client-side encryption."},"username":{"type":"string","description":"WhatsApp username handle. Present only if the user has enabled a username. Encrypted for client-side encryption."}},"description":"WhatsApp specific content"},"ReferralInfo":{"type":"object","properties":{"headline":{"type":"string","description":"Headline used in the ad that generated the message."},"content":{"type":"string","description":"Body from the ad that generated the message."},"sourceType":{"type":"string","description":"The type of the ad’s source.","enum":["ad","post"]},"sourceId":{"type":"string","description":"Facebook ID for an ad or a post."},"sourceUrl":{"type":"string","description":"The url that leads to the ad or post. Opening this url takes you to the ad viewed by your user."}}},"Sms":{"type":"object","properties":{"udh":{"type":"string"},"network":{"type":"integer","format":"int32"}}},"MediaReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"caption":{"type":"string"}},"anyOf":[{"$ref":"#/components/schemas/InlineMediaReply"},{"$ref":"#/components/schemas/ReferenceMediaReply"}]},"InlineMediaReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"caption":{"type":"string"},"content":{"type":"string"},"sha256Hash":{"type":"string"},"contentType":{"type":"string"}}},"ReferenceMediaReply":{"required":["files"],"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"caption":{"type":"string"},"files":{"type":"array","description":"An array of the file object with a list of media items that is attached to the inbound media message. This parameter is only applicable to MO event callbacks for media by reference ","items":{"$ref":"#/components/schemas/ReferenceMediaFile"}}}},"ReferenceMediaFile":{"required":["byteSize","contentType","downloadUrl"],"type":"object","properties":{"contentType":{"type":"string","description":"Media content type for the media item"},"downloadUrl":{"type":"string","description":"Download URL to be used for downloading the media item"},"sha256Hash":{"type":"string"},"byteSize":{"type":"integer","description":"Byte size of the file to be downloaded","format":"int64"},"fileName":{"type":"string","description":"Original file name (if it is available)"}}},"LocationReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"charset":{"type":"string","description":"Character encoding","default":"UTF-8"},"locationAddress":{"type":"string","description":"Address of the location"},"locationName":{"type":"string","description":"Name of the location"},"latitude":{"type":"string","description":"Numeric latitude value expressed as a string"},"latitute":{"type":"string","description":"Numeric latitude value expressed as a string"},"longitude":{"type":"string","description":"Numeric longitude value expressed as a string"}}},"ContactsReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/WhatsAppContact"}},"charset":{"type":"string"}}},"WhatsAppContact":{"required":["name"],"type":"object","properties":{"addresses":{"minItems":1,"type":"array","description":"List of address object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"birthday":{"pattern":"YYYY-MM-DD","type":"string","description":"String date value."},"emails":{"minItems":1,"type":"array","description":"List of the email object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"name":{"type":"object","additionalProperties":{"type":"string","description":"Name object. See request example WhatsApp Contacts: One message"},"description":"Name object. See request example WhatsApp Contacts: One message"},"origin":{"type":"string","description":"<b>WhatsApp inbound only</b><br>Indicates how the contact was shared by the user. <i>contact_request</i> means the contact was shared in direct response to a REQUEST_CONTACT_INFO button; <i>other</i> means the contact was shared organically (e.g. a forwarded vCard). Present only on inbound contact messages when supplied by WhatsApp; omitted when absent. Not encrypted for client-side encryption.","enum":["contact_request","other"]},"org":{"type":"object","additionalProperties":{"type":"string","description":"See request example WhatsApp Contacts: One message"},"description":"See request example WhatsApp Contacts: One message"},"phones":{"minItems":1,"type":"array","description":"List of the phone object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"urls":{"minItems":1,"type":"array","description":"List of the url object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}}}},"SuggestedResponseReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"charset":{"type":"string"},"postbackData":{"type":"string"},"content":{"type":"string"}}},"ListPickerResponseReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"postbackData":{"type":"string"},"selectedItems":{"type":"array","items":{"$ref":"#/components/schemas/SelectedButtonItem"}}}},"SelectedButtonItem":{"type":"object","properties":{"postbackData":{"type":"string"},"content":{"type":"string"}}},"ButtonResponseReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"postbackData":{"type":"string"},"selectedItem":{"$ref":"#/components/schemas/SelectedButtonItem"}}}}}}
```

## The ReferenceMediaFile object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"ReferenceMediaFile":{"required":["byteSize","contentType","downloadUrl"],"type":"object","properties":{"contentType":{"type":"string","description":"Media content type for the media item"},"downloadUrl":{"type":"string","description":"Download URL to be used for downloading the media item"},"sha256Hash":{"type":"string"},"byteSize":{"type":"integer","description":"Byte size of the file to be downloaded","format":"int64"},"fileName":{"type":"string","description":"Original file name (if it is available)"}}}}}}
```

## The ReferenceMediaReply object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"ReferenceMediaReply":{"required":["files"],"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"caption":{"type":"string"},"files":{"type":"array","description":"An array of the file object with a list of media items that is attached to the inbound media message. This parameter is only applicable to MO event callbacks for media by reference ","items":{"$ref":"#/components/schemas/ReferenceMediaFile"}}}},"WhatsAppContent":{"type":"object","properties":{"profileName":{"type":"string","description":"Users profile name as set up on their WA Client"},"referralInfo":{"$ref":"#/components/schemas/ReferralInfo"},"userId":{"type":"string","description":"Business-Scoped User ID (BSUID) of the WhatsApp user. Format: CC.alphanumeric (max 131 chars). Always present for WhatsApp messages. Not encrypted for client-side encryption."},"parentUserId":{"type":"string","description":"Parent BSUID for linked business portfolios. Format: CC.ENT.alphanumeric (max 135 chars). Present only if your company is an eligible enterprise explicitly enrolled in a Parent BSUID account. Not encrypted for client-side encryption."},"username":{"type":"string","description":"WhatsApp username handle. Present only if the user has enabled a username. Encrypted for client-side encryption."}},"description":"WhatsApp specific content"},"ReferralInfo":{"type":"object","properties":{"headline":{"type":"string","description":"Headline used in the ad that generated the message."},"content":{"type":"string","description":"Body from the ad that generated the message."},"sourceType":{"type":"string","description":"The type of the ad’s source.","enum":["ad","post"]},"sourceId":{"type":"string","description":"Facebook ID for an ad or a post."},"sourceUrl":{"type":"string","description":"The url that leads to the ad or post. Opening this url takes you to the ad viewed by your user."}}},"ReferenceMediaFile":{"required":["byteSize","contentType","downloadUrl"],"type":"object","properties":{"contentType":{"type":"string","description":"Media content type for the media item"},"downloadUrl":{"type":"string","description":"Download URL to be used for downloading the media item"},"sha256Hash":{"type":"string"},"byteSize":{"type":"integer","description":"Byte size of the file to be downloaded","format":"int64"},"fileName":{"type":"string","description":"Original file name (if it is available)"}}}}}}
```

## The ReferralInfo object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"ReferralInfo":{"type":"object","properties":{"headline":{"type":"string","description":"Headline used in the ad that generated the message."},"content":{"type":"string","description":"Body from the ad that generated the message."},"sourceType":{"type":"string","description":"The type of the ad’s source.","enum":["ad","post"]},"sourceId":{"type":"string","description":"Facebook ID for an ad or a post."},"sourceUrl":{"type":"string","description":"The url that leads to the ad or post. Opening this url takes you to the ad viewed by your user."}}}}}}
```

## The ReplyEvents object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"ReplyEvents":{"type":"object","properties":{"moText":{"type":"array","items":{"$ref":"#/components/schemas/TextReply"}},"moMedia":{"type":"array","items":{"$ref":"#/components/schemas/MediaReply"}},"moLocation":{"type":"array","items":{"$ref":"#/components/schemas/LocationReply"}},"moContacts":{"type":"array","items":{"$ref":"#/components/schemas/ContactsReply"}},"moSuggestedResponse":{"type":"array","items":{"$ref":"#/components/schemas/SuggestedResponseReply"}},"moListPickerResponse":{"type":"array","items":{"$ref":"#/components/schemas/ListPickerResponseReply"}},"moButtonResponse":{"type":"array","items":{"$ref":"#/components/schemas/ButtonResponseReply"}}}},"TextReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"charset":{"type":"string"},"content":{"type":"string"},"sms":{"$ref":"#/components/schemas/Sms"}}},"WhatsAppContent":{"type":"object","properties":{"profileName":{"type":"string","description":"Users profile name as set up on their WA Client"},"referralInfo":{"$ref":"#/components/schemas/ReferralInfo"},"userId":{"type":"string","description":"Business-Scoped User ID (BSUID) of the WhatsApp user. Format: CC.alphanumeric (max 131 chars). Always present for WhatsApp messages. Not encrypted for client-side encryption."},"parentUserId":{"type":"string","description":"Parent BSUID for linked business portfolios. Format: CC.ENT.alphanumeric (max 135 chars). Present only if your company is an eligible enterprise explicitly enrolled in a Parent BSUID account. Not encrypted for client-side encryption."},"username":{"type":"string","description":"WhatsApp username handle. Present only if the user has enabled a username. Encrypted for client-side encryption."}},"description":"WhatsApp specific content"},"ReferralInfo":{"type":"object","properties":{"headline":{"type":"string","description":"Headline used in the ad that generated the message."},"content":{"type":"string","description":"Body from the ad that generated the message."},"sourceType":{"type":"string","description":"The type of the ad’s source.","enum":["ad","post"]},"sourceId":{"type":"string","description":"Facebook ID for an ad or a post."},"sourceUrl":{"type":"string","description":"The url that leads to the ad or post. Opening this url takes you to the ad viewed by your user."}}},"Sms":{"type":"object","properties":{"udh":{"type":"string"},"network":{"type":"integer","format":"int32"}}},"MediaReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"caption":{"type":"string"}},"anyOf":[{"$ref":"#/components/schemas/InlineMediaReply"},{"$ref":"#/components/schemas/ReferenceMediaReply"}]},"InlineMediaReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"caption":{"type":"string"},"content":{"type":"string"},"sha256Hash":{"type":"string"},"contentType":{"type":"string"}}},"ReferenceMediaReply":{"required":["files"],"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"caption":{"type":"string"},"files":{"type":"array","description":"An array of the file object with a list of media items that is attached to the inbound media message. This parameter is only applicable to MO event callbacks for media by reference ","items":{"$ref":"#/components/schemas/ReferenceMediaFile"}}}},"ReferenceMediaFile":{"required":["byteSize","contentType","downloadUrl"],"type":"object","properties":{"contentType":{"type":"string","description":"Media content type for the media item"},"downloadUrl":{"type":"string","description":"Download URL to be used for downloading the media item"},"sha256Hash":{"type":"string"},"byteSize":{"type":"integer","description":"Byte size of the file to be downloaded","format":"int64"},"fileName":{"type":"string","description":"Original file name (if it is available)"}}},"LocationReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"charset":{"type":"string","description":"Character encoding","default":"UTF-8"},"locationAddress":{"type":"string","description":"Address of the location"},"locationName":{"type":"string","description":"Name of the location"},"latitude":{"type":"string","description":"Numeric latitude value expressed as a string"},"latitute":{"type":"string","description":"Numeric latitude value expressed as a string"},"longitude":{"type":"string","description":"Numeric longitude value expressed as a string"}}},"ContactsReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/WhatsAppContact"}},"charset":{"type":"string"}}},"WhatsAppContact":{"required":["name"],"type":"object","properties":{"addresses":{"minItems":1,"type":"array","description":"List of address object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"birthday":{"pattern":"YYYY-MM-DD","type":"string","description":"String date value."},"emails":{"minItems":1,"type":"array","description":"List of the email object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"name":{"type":"object","additionalProperties":{"type":"string","description":"Name object. See request example WhatsApp Contacts: One message"},"description":"Name object. See request example WhatsApp Contacts: One message"},"origin":{"type":"string","description":"<b>WhatsApp inbound only</b><br>Indicates how the contact was shared by the user. <i>contact_request</i> means the contact was shared in direct response to a REQUEST_CONTACT_INFO button; <i>other</i> means the contact was shared organically (e.g. a forwarded vCard). Present only on inbound contact messages when supplied by WhatsApp; omitted when absent. Not encrypted for client-side encryption.","enum":["contact_request","other"]},"org":{"type":"object","additionalProperties":{"type":"string","description":"See request example WhatsApp Contacts: One message"},"description":"See request example WhatsApp Contacts: One message"},"phones":{"minItems":1,"type":"array","description":"List of the phone object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"urls":{"minItems":1,"type":"array","description":"List of the url object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}}}},"SuggestedResponseReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"charset":{"type":"string"},"postbackData":{"type":"string"},"content":{"type":"string"}}},"ListPickerResponseReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"postbackData":{"type":"string"},"selectedItems":{"type":"array","items":{"$ref":"#/components/schemas/SelectedButtonItem"}}}},"SelectedButtonItem":{"type":"object","properties":{"postbackData":{"type":"string"},"content":{"type":"string"}}},"ButtonResponseReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"postbackData":{"type":"string"},"selectedItem":{"$ref":"#/components/schemas/SelectedButtonItem"}}}}}}
```

## The SelectedButtonItem object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"SelectedButtonItem":{"type":"object","properties":{"postbackData":{"type":"string"},"content":{"type":"string"}}}}}}
```

## The Sms object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"Sms":{"type":"object","properties":{"udh":{"type":"string"},"network":{"type":"integer","format":"int32"}}}}}}
```

## The SuggestedResponseReply object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"SuggestedResponseReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"charset":{"type":"string"},"postbackData":{"type":"string"},"content":{"type":"string"}}},"WhatsAppContent":{"type":"object","properties":{"profileName":{"type":"string","description":"Users profile name as set up on their WA Client"},"referralInfo":{"$ref":"#/components/schemas/ReferralInfo"},"userId":{"type":"string","description":"Business-Scoped User ID (BSUID) of the WhatsApp user. Format: CC.alphanumeric (max 131 chars). Always present for WhatsApp messages. Not encrypted for client-side encryption."},"parentUserId":{"type":"string","description":"Parent BSUID for linked business portfolios. Format: CC.ENT.alphanumeric (max 135 chars). Present only if your company is an eligible enterprise explicitly enrolled in a Parent BSUID account. Not encrypted for client-side encryption."},"username":{"type":"string","description":"WhatsApp username handle. Present only if the user has enabled a username. Encrypted for client-side encryption."}},"description":"WhatsApp specific content"},"ReferralInfo":{"type":"object","properties":{"headline":{"type":"string","description":"Headline used in the ad that generated the message."},"content":{"type":"string","description":"Body from the ad that generated the message."},"sourceType":{"type":"string","description":"The type of the ad’s source.","enum":["ad","post"]},"sourceId":{"type":"string","description":"Facebook ID for an ad or a post."},"sourceUrl":{"type":"string","description":"The url that leads to the ad or post. Opening this url takes you to the ad viewed by your user."}}}}}}
```

## The TextReply object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"TextReply":{"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel which is used with the specified message","enum":["sms","whatsapp"]},"messageId":{"type":"string","description":"Id of a message that originated from client"},"relatedMessageId":{"type":"string","description":"Id of a message to which client responds"},"relatedClientMessageId":{"type":"string","description":"Id which was specified in <i>clientMessageId</i> field"},"from":{"type":"string","description":"Sender identifier. Phone number (international format, no leading +) or WhatsApp BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars) for WhatsApp messages."},"to":{"type":"string","description":"Receiver phone number"},"timestamp":{"type":"integer","description":"Unix timestamp when the system received the message in milliseconds","format":"int64"},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded CipherTextBlob which must be used to generate the plain text decryption key for decryption of the content parameter"},"whatsapp":{"$ref":"#/components/schemas/WhatsAppContent"},"charset":{"type":"string"},"content":{"type":"string"},"sms":{"$ref":"#/components/schemas/Sms"}}},"WhatsAppContent":{"type":"object","properties":{"profileName":{"type":"string","description":"Users profile name as set up on their WA Client"},"referralInfo":{"$ref":"#/components/schemas/ReferralInfo"},"userId":{"type":"string","description":"Business-Scoped User ID (BSUID) of the WhatsApp user. Format: CC.alphanumeric (max 131 chars). Always present for WhatsApp messages. Not encrypted for client-side encryption."},"parentUserId":{"type":"string","description":"Parent BSUID for linked business portfolios. Format: CC.ENT.alphanumeric (max 135 chars). Present only if your company is an eligible enterprise explicitly enrolled in a Parent BSUID account. Not encrypted for client-side encryption."},"username":{"type":"string","description":"WhatsApp username handle. Present only if the user has enabled a username. Encrypted for client-side encryption."}},"description":"WhatsApp specific content"},"ReferralInfo":{"type":"object","properties":{"headline":{"type":"string","description":"Headline used in the ad that generated the message."},"content":{"type":"string","description":"Body from the ad that generated the message."},"sourceType":{"type":"string","description":"The type of the ad’s source.","enum":["ad","post"]},"sourceId":{"type":"string","description":"Facebook ID for an ad or a post."},"sourceUrl":{"type":"string","description":"The url that leads to the ad or post. Opening this url takes you to the ad viewed by your user."}}},"Sms":{"type":"object","properties":{"udh":{"type":"string"},"network":{"type":"integer","format":"int32"}}}}}}
```

## The WhatsAppContact object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppContact":{"required":["name"],"type":"object","properties":{"addresses":{"minItems":1,"type":"array","description":"List of address object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"birthday":{"pattern":"YYYY-MM-DD","type":"string","description":"String date value."},"emails":{"minItems":1,"type":"array","description":"List of the email object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"name":{"type":"object","additionalProperties":{"type":"string","description":"Name object. See request example WhatsApp Contacts: One message"},"description":"Name object. See request example WhatsApp Contacts: One message"},"origin":{"type":"string","description":"<b>WhatsApp inbound only</b><br>Indicates how the contact was shared by the user. <i>contact_request</i> means the contact was shared in direct response to a REQUEST_CONTACT_INFO button; <i>other</i> means the contact was shared organically (e.g. a forwarded vCard). Present only on inbound contact messages when supplied by WhatsApp; omitted when absent. Not encrypted for client-side encryption.","enum":["contact_request","other"]},"org":{"type":"object","additionalProperties":{"type":"string","description":"See request example WhatsApp Contacts: One message"},"description":"See request example WhatsApp Contacts: One message"},"phones":{"minItems":1,"type":"array","description":"List of the phone object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"urls":{"minItems":1,"type":"array","description":"List of the url object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}}}}}}}
```

## The WhatsAppContent object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppContent":{"type":"object","properties":{"profileName":{"type":"string","description":"Users profile name as set up on their WA Client"},"referralInfo":{"$ref":"#/components/schemas/ReferralInfo"},"userId":{"type":"string","description":"Business-Scoped User ID (BSUID) of the WhatsApp user. Format: CC.alphanumeric (max 131 chars). Always present for WhatsApp messages. Not encrypted for client-side encryption."},"parentUserId":{"type":"string","description":"Parent BSUID for linked business portfolios. Format: CC.ENT.alphanumeric (max 135 chars). Present only if your company is an eligible enterprise explicitly enrolled in a Parent BSUID account. Not encrypted for client-side encryption."},"username":{"type":"string","description":"WhatsApp username handle. Present only if the user has enabled a username. Encrypted for client-side encryption."}},"description":"WhatsApp specific content"},"ReferralInfo":{"type":"object","properties":{"headline":{"type":"string","description":"Headline used in the ad that generated the message."},"content":{"type":"string","description":"Body from the ad that generated the message."},"sourceType":{"type":"string","description":"The type of the ad’s source.","enum":["ad","post"]},"sourceId":{"type":"string","description":"Facebook ID for an ad or a post."},"sourceUrl":{"type":"string","description":"The url that leads to the ad or post. Opening this url takes you to the ad viewed by your user."}}}}}}
```

## The OmniMessageStatusEntry object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"OmniMessageStatusEntry":{"type":"object","properties":{"status":{"type":"string","enum":["UNKNOWN","QUEUED","SCHEDULED","SENT_TO_SUPPLIER","DEVICE_ACK","READ","EXPIRED","STOPPED_BY_USER","STOPPED_BY_ADMIN","DELIVERY_FAILURE","EMULATED","INSUFFICIENT_ACCOUNT_BALANCE","VOLUME_LIMIT","VOLUME_LIMIT_DAILY","VOLUME_LIMIT_MONTHLY","RECIPIENT_DOES_NOT_EXIST","STOP_MARKETING_MESSAGES","EXCESSIVE_MESSAGES_TO_RECIPIENT","ENCRYPTION_ACCESS_DENIED","ENCRYPTION_CONTENT_ERROR","ENCRYPTION_VALIDATION_ERROR","ANONYMOUS_USER_ID_INVALID","ANONYMOUS_USER_ID_ERROR","MEDIA_NOT_FOUND","MEDIA_SIZE_ERROR","MEDIA_CHECKSUM_FAILURE","MEDIA_REJECTED_BY_SUPPLIER","MEDIA_METADATA_ERROR","MEDIA_ACCESS_ERROR","MEDIA_TYPE_NOT_SUPPORTED","ROUTING_ERROR","WHATSAPP_ACCOUNT_PAYMENT_ISSUE","WHATSAPP_RE_ENGAGEMENT_REQUIRED","WHATSAPP_SPAM_RATE_LIMIT_REACHED","WHATSAPP_SERVER_RATE_LIMIT","WHATSAPP_EXPERIMENTAL_NUMBER","WHATSAPP_TEMPLATE_TEXT_TOO_LONG","WHATSAPP_TEMPLATE_FORMAT_MISMATCH","WHATSAPP_TEMPLATE_FORMATTING_POLICY_VIOLATED","WHATSAPP_TEMPLATE_MEDIA_FORMAT_UNSUPPORTED","WHATSAPP_PARAMETER_MISSING","WHATSAPP_PARAMETER_INVALID","WHATSAPP_PARAMETER_NOT_REQUIRED","WHATSAPP_TEMPLATE_INVALID_URL","WHATSAPP_TEMPLATE_INVALID_PHONE_NUMBER","WHATSAPP_TEMPLATE_RECEIVER_NO_BUTTON_SUPPORT","WHATSAPP_TEMPLATE_DOES_NOT_EXIST","WHATSAPP_TEMPLATE_PARAM_COUNT_MISMATCH","WHATSAPP_TEMPLATE_PAUSED","WHATSAPP_TEMPLATE_DISABLED","WHATSAPP_COMPLIANCE_INFO_MISSING","WHATSAPP_PRODUCT_CATALOG_NOT_FOUND","WHATSAPP_PRODUCT_NOT_FOUND_IN_CATALOG","WHATSAPP_PRODUCT_COMPLIANCE_ERROR","WHATSAPP_MESSAGE_UNDELIVERABLE","WHATSAPP_CHOSE_NOT_TO_DELIVER","PAYMENT_COMPLETED","PAYMENT_DECLINED","PAYMENT_FAILED","PAYMENT_INVALID_MERCHANT_SESSION","PAYMENT_INVALID_WEBHOOK_ENDPOINTS"]},"timestamp":{"type":"integer","format":"int64"}}}}}}
```

## The OmniMessageStatusResponse object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"OmniMessageStatusResponse":{"type":"object","properties":{"sms":{"$ref":"#/components/schemas/OmniMessageStatusEntry"},"whatsapp":{"$ref":"#/components/schemas/OmniMessageStatusEntry"}}},"OmniMessageStatusEntry":{"type":"object","properties":{"status":{"type":"string","enum":["UNKNOWN","QUEUED","SCHEDULED","SENT_TO_SUPPLIER","DEVICE_ACK","READ","EXPIRED","STOPPED_BY_USER","STOPPED_BY_ADMIN","DELIVERY_FAILURE","EMULATED","INSUFFICIENT_ACCOUNT_BALANCE","VOLUME_LIMIT","VOLUME_LIMIT_DAILY","VOLUME_LIMIT_MONTHLY","RECIPIENT_DOES_NOT_EXIST","STOP_MARKETING_MESSAGES","EXCESSIVE_MESSAGES_TO_RECIPIENT","ENCRYPTION_ACCESS_DENIED","ENCRYPTION_CONTENT_ERROR","ENCRYPTION_VALIDATION_ERROR","ANONYMOUS_USER_ID_INVALID","ANONYMOUS_USER_ID_ERROR","MEDIA_NOT_FOUND","MEDIA_SIZE_ERROR","MEDIA_CHECKSUM_FAILURE","MEDIA_REJECTED_BY_SUPPLIER","MEDIA_METADATA_ERROR","MEDIA_ACCESS_ERROR","MEDIA_TYPE_NOT_SUPPORTED","ROUTING_ERROR","WHATSAPP_ACCOUNT_PAYMENT_ISSUE","WHATSAPP_RE_ENGAGEMENT_REQUIRED","WHATSAPP_SPAM_RATE_LIMIT_REACHED","WHATSAPP_SERVER_RATE_LIMIT","WHATSAPP_EXPERIMENTAL_NUMBER","WHATSAPP_TEMPLATE_TEXT_TOO_LONG","WHATSAPP_TEMPLATE_FORMAT_MISMATCH","WHATSAPP_TEMPLATE_FORMATTING_POLICY_VIOLATED","WHATSAPP_TEMPLATE_MEDIA_FORMAT_UNSUPPORTED","WHATSAPP_PARAMETER_MISSING","WHATSAPP_PARAMETER_INVALID","WHATSAPP_PARAMETER_NOT_REQUIRED","WHATSAPP_TEMPLATE_INVALID_URL","WHATSAPP_TEMPLATE_INVALID_PHONE_NUMBER","WHATSAPP_TEMPLATE_RECEIVER_NO_BUTTON_SUPPORT","WHATSAPP_TEMPLATE_DOES_NOT_EXIST","WHATSAPP_TEMPLATE_PARAM_COUNT_MISMATCH","WHATSAPP_TEMPLATE_PAUSED","WHATSAPP_TEMPLATE_DISABLED","WHATSAPP_COMPLIANCE_INFO_MISSING","WHATSAPP_PRODUCT_CATALOG_NOT_FOUND","WHATSAPP_PRODUCT_NOT_FOUND_IN_CATALOG","WHATSAPP_PRODUCT_COMPLIANCE_ERROR","WHATSAPP_MESSAGE_UNDELIVERABLE","WHATSAPP_CHOSE_NOT_TO_DELIVER","PAYMENT_COMPLETED","PAYMENT_DECLINED","PAYMENT_FAILED","PAYMENT_INVALID_MERCHANT_SESSION","PAYMENT_INVALID_WEBHOOK_ENDPOINTS"]},"timestamp":{"type":"integer","format":"int64"}}}}}}
```

## The OmniMessageListResponse object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"OmniMessageListResponse":{"type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/OmniMessagesResponse"}},"error":{"$ref":"#/components/schemas/OmniResponseError"},"type":{"type":"string","writeOnly":true,"enum":["SUCCESS","MIXED","FAIL"]}}},"OmniMessagesResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/OmniResponseError"},"apiMessageId":{"type":"string","description":"System defined message ID."},"accepted":{"type":"boolean","description":"Indication if the message has passed API validation"},"to":{"type":"string","description":"Recipient of the message, echoed back exactly as submitted. For WhatsApp this is a BSUID if a BSUID was submitted."},"clientMessageId":{"type":"string","description":"Customer defined message ID for tracking purposes."}}},"OmniResponseError":{"type":"object","properties":{"code":{"type":"integer","description":"<i>Error Code</i> value in ","format":"int32"},"description":{"type":"string","description":"<i>Error Message</i>"}}}}}}
```

## The OmniMessagesResponse object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"OmniMessagesResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/OmniResponseError"},"apiMessageId":{"type":"string","description":"System defined message ID."},"accepted":{"type":"boolean","description":"Indication if the message has passed API validation"},"to":{"type":"string","description":"Recipient of the message, echoed back exactly as submitted. For WhatsApp this is a BSUID if a BSUID was submitted."},"clientMessageId":{"type":"string","description":"Customer defined message ID for tracking purposes."}}},"OmniResponseError":{"type":"object","properties":{"code":{"type":"integer","description":"<i>Error Code</i> value in ","format":"int32"},"description":{"type":"string","description":"<i>Error Message</i>"}}}}}}
```

## The OmniResponseError object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"OmniResponseError":{"type":"object","properties":{"code":{"type":"integer","description":"<i>Error Code</i> value in ","format":"int32"},"description":{"type":"string","description":"<i>Error Message</i>"}}}}}}
```

## The Location object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"Location":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"maximum":180,"minimum":-180,"type":"string","description":"Longitude of the location as a numeric string value."},"latitude":{"maximum":90,"minimum":-90,"type":"string","description":"Longitude of the location as a numeric string value."},"name":{"type":"string","description":"Name of the location."},"address":{"type":"string","description":"Address of the location. The address will only be displayed if the name was set."}},"description":"<b>WhatsApp only</b><br>Object containing parameters for sending a location message."}}}}
```

## The OmniIntegrationWaMediaRequest object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"OmniIntegrationWaMediaRequest":{"type":"object","properties":{"contentType":{"type":"string","description":"Media type header for file format and file content. This parameter is required when sending a media message.<br><b>Inline required.</b>"},"caption":{"type":"string","description":"This is an optional parameter and may be used to describe the media file being sent. Do not use when sending audio media."},"fileName":{"type":"string","description":"This is an optional parameter and may be used to specify name of a file that is sent to WhatsApp."},"sha256Hash":{"type":"string","description":"SHA256 File hash of the unencrypted file content."},"fileId":{"type":"string","description":"File reference id as returned in the media file upload API call.<br><b>By Reference required.</b>"}},"description":"<b>WhatsApp only</b><br>Object containing parameters for sending a media message."}}}}
```

## The OmniMessageRequest object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"OmniMessageRequest":{"required":["to"],"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel to be used with the specified message.","enum":["sms","whatsapp"]},"to":{"type":"string","description":"Recipient of the message.<ul>\n<li><b>SMS</b> &ndash; MSISDN, international format, no leading +.</li>\n<li><b>WhatsApp</b> &ndash; MSISDN or BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars). Both are accepted. Use the BSUID when you have one; use the MSISDN to reach a user for the first time, and for one-tap, zero-tap or copy-code authentication templates, which cannot be sent to a BSUID. See <i>WhatsApp recipient identifiers</i> in the API description.</li></ul>"},"content":{"minLength":1,"type":"string","description":"The string value contains actual message content. <br><b>Character set UTF-8</b><br>WhatsApp Inline Media: base64 encoded media data<br><b>Not required for media by reference message sending</b><br><br><b>Limit</b><ul><li>WhatsApp text: 4096 characters</li><li>WhatsApp media: 1MB (total 20MB payload limit)</li></ul>"},"clientMessageId":{"type":"string","description":"Customer defined message ID for tracking purposes. Returned in callbacks and certain API submission formats."},"scheduledDeliveryTime":{"pattern":"yyyy-MM-ddTHH:mm:ssXXX","type":"string","description":"Ability to schedule messages for later delivery."},"validityPeriod":{"type":"integer","description":"The message will not be processed/queued/retried for a period exceeding the provided validity period. (In minutes)","format":"int32","default":1440},"previewFirstUrl":{"type":"boolean","description":"<b>WhatsApp only</b><br>True or false - will indicate if URL link must display as preview on recipient phone. Only applicable when sending plain text messages."},"location":{"$ref":"#/components/schemas/Location"},"contacts":{"type":"array","description":"<b>WhatsApp only</b><br>Array of the contact object containing parameters for sending a contacts message.<br><b>Note:</b><br> if contact object is presented, minimum requirement is the name parameter + at least one other parameter.","items":{"$ref":"#/components/schemas/WhatsAppContact"}},"media":{"$ref":"#/components/schemas/OmniIntegrationWaMediaRequest"},"template":{"$ref":"#/components/schemas/WhatsAppMessageTemplate"},"listPicker":{"$ref":"#/components/schemas/WhatsAppMessageList"},"button":{"$ref":"#/components/schemas/WhatsAppMessageButton"},"actionUrl":{"$ref":"#/components/schemas/WhatsAppMessageCTAButton"},"locationRequest":{"$ref":"#/components/schemas/WhatsAppMessageLocationRequest"},"from":{"type":"string","description":"<b>Sms only</b><br>The two-way number that will be used for message delivery<br>from - Required Field for Two Way communication in the USA."},"userDataHeader":{"type":"string","description":"<b>Sms only</b><br>UDH content of a message. It does not contain any text, but rather specifies how the message should be processed. Basically, it’s a part of the SMS which tells the receiving handset what type of message being sent."},"binary":{"type":"boolean","description":"<b>Sms only</b><br>Specifies if <i>content</i> delivered by client needs to be in binary format."},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded encrypted data key as generated from AWS KMS. Note that MC2 will have to submit additional fields to SMS/WA adapter for client side encryption to work. For client side encrypted media by reference send message requests this field must be populated even if the media <i>caption</i> is null."},"encryptionKeyArn":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Customer defined encryption key ARN."},"encryptionCipher":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Customer defined encryption cipher."}}},"Location":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"maximum":180,"minimum":-180,"type":"string","description":"Longitude of the location as a numeric string value."},"latitude":{"maximum":90,"minimum":-90,"type":"string","description":"Longitude of the location as a numeric string value."},"name":{"type":"string","description":"Name of the location."},"address":{"type":"string","description":"Address of the location. The address will only be displayed if the name was set."}},"description":"<b>WhatsApp only</b><br>Object containing parameters for sending a location message."},"WhatsAppContact":{"required":["name"],"type":"object","properties":{"addresses":{"minItems":1,"type":"array","description":"List of address object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"birthday":{"pattern":"YYYY-MM-DD","type":"string","description":"String date value."},"emails":{"minItems":1,"type":"array","description":"List of the email object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"name":{"type":"object","additionalProperties":{"type":"string","description":"Name object. See request example WhatsApp Contacts: One message"},"description":"Name object. See request example WhatsApp Contacts: One message"},"origin":{"type":"string","description":"<b>WhatsApp inbound only</b><br>Indicates how the contact was shared by the user. <i>contact_request</i> means the contact was shared in direct response to a REQUEST_CONTACT_INFO button; <i>other</i> means the contact was shared organically (e.g. a forwarded vCard). Present only on inbound contact messages when supplied by WhatsApp; omitted when absent. Not encrypted for client-side encryption.","enum":["contact_request","other"]},"org":{"type":"object","additionalProperties":{"type":"string","description":"See request example WhatsApp Contacts: One message"},"description":"See request example WhatsApp Contacts: One message"},"phones":{"minItems":1,"type":"array","description":"List of the phone object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"urls":{"minItems":1,"type":"array","description":"List of the url object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}}}},"OmniIntegrationWaMediaRequest":{"type":"object","properties":{"contentType":{"type":"string","description":"Media type header for file format and file content. This parameter is required when sending a media message.<br><b>Inline required.</b>"},"caption":{"type":"string","description":"This is an optional parameter and may be used to describe the media file being sent. Do not use when sending audio media."},"fileName":{"type":"string","description":"This is an optional parameter and may be used to specify name of a file that is sent to WhatsApp."},"sha256Hash":{"type":"string","description":"SHA256 File hash of the unencrypted file content."},"fileId":{"type":"string","description":"File reference id as returned in the media file upload API call.<br><b>By Reference required.</b>"}},"description":"<b>WhatsApp only</b><br>Object containing parameters for sending a media message."},"WhatsAppMessageTemplate":{"required":["templateName","body"],"type":"object","properties":{"templateName":{"type":"string","description":"Template name which was specified when created."},"language":{"type":"string","description":"Specifies the language the template may be rendered in."},"header":{"$ref":"#/components/schemas/WhatsAppMessageTemplateHeader"},"body":{"$ref":"#/components/schemas/WhatsAppMessageTemplateBody"},"buttons":{"$ref":"#/components/schemas/WhatsAppMessageTemplateButtons"},"templateButtons":{"maxItems":10,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/WhatsAppMixedTemplateButton"},"description":"<li>Suppports a combination of button types in a single WhatsApp message template.</li>  <li>All buttons of the same type must be grouped together, e.g., all “url” buttons, all “suggestedResponse” buttons, etc.</li>  <li><b>Note:</b> If a “phone” or “static URL” button is used in the template, their position (index) requires the “index” parameter of other buttons to be incremented accordingly.</li> <li>See Example: <i>WhatsApp Interactive Text Template with Mixed Buttons.</i></li>\n"}},"description":"<b>WhatsApp only</b><br>Object containing parameters for sending a template message."},"WhatsAppMessageTemplateHeader":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Indicates the header type of the template.<br><b>Note:</b><i> location</i> header type (location template) only supported for cloud-hosted numbers","enum":["text","media","location"]},"text":{"$ref":"#/components/schemas/WhatsAppTemplateHeaderText"},"media":{"$ref":"#/components/schemas/WhatsAppTemplateHeaderMedia"},"location":{"$ref":"#/components/schemas/WhatsAppTemplateHeaderLocation"}},"description":"Template header."},"WhatsAppTemplateHeaderText":{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string","description":"Key value pairs; key is string numeric value parameter and value set to the parameter value WhatsApp currently only allows for a single parameter value in the header text. <br><b>Only required if the template was created with a variable in the header text</b>"},"description":"Key value pairs; key is string numeric value parameter and value set to the parameter value WhatsApp currently only allows for a single parameter value in the header text. <br><b>Only required if the template was created with a variable in the header text</b>"}},"description":"Required, if type text"},"WhatsAppTemplateHeaderMedia":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","description":"<i>fileId</i> as returned in the api reponse of the media upload request (see <i>Upload Media file for One Api</i>). <br>WhatsApp allows files of type image, video and document."}},"description":"Required, if type media"},"WhatsAppTemplateHeaderLocation":{"required":["address","latitude","longitude","name"],"type":"object","properties":{"longitude":{"maximum":180,"minimum":-180,"type":"string","description":"Longitude of the location as a numeric string value."},"latitude":{"maximum":90,"minimum":-90,"type":"string","description":"Longitude of the location as a numeric string value."},"name":{"type":"string","description":"Name of the location."},"address":{"type":"string","description":"Address of the location. The address will only be displayed if the name was set."}},"description":"<b>Note:</b> <i>location</i> header only supported for cloud numbers. Required, if type location"},"WhatsAppMessageTemplateBody":{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string","description":"Key value pairs; key is string numeric value parameter and value set to the parameter value"},"description":"Key value pairs; key is string numeric value parameter and value set to the parameter value"}},"description":"Body object."},"WhatsAppMessageTemplateButtons":{"type":"object","properties":{"suggestedResponse":{"$ref":"#/components/schemas/WhatsAppTemplateSuggestedResponse"},"websiteUrl":{"type":"array","items":{"$ref":"#/components/schemas/WhatsAppTemplateWebsiteUrl"}}},"description":"<b>To be deprecated</b><br><u>Use <i>templateButtons</i> instead</u> <br>Interactive template message buttons. <br><i>buttons</i> parameter supports 1 button type (websiteUrl or suggestedResponse) per send message request."},"WhatsAppTemplateSuggestedResponse":{"required":["postbackData"],"type":"object","properties":{"postbackData":{"maximum":3,"maxProperties":3,"type":"object","additionalProperties":{"maximum":3,"maxProperties":3,"type":"string","description":"<b>Key</b> : String integer value of the button to which the postbackData should be associated<br><b>Value</b> : User defined data that will be returned in the callback function to the business."},"description":"<b>Key</b> : String integer value of the button to which the postbackData should be associated<br><b>Value</b> : User defined data that will be returned in the callback function to the business."}}},"WhatsAppTemplateWebsiteUrl":{"required":["listPosition"],"type":"object","properties":{"listPosition":{"type":"integer","description":"If a template was create with a dial button in the 1st position and the websiteUrl in the 2nd position then the <i>listPosition</i> will be 2.<br>If a template was created with the websiteUrl button in 1st position and the dial button in the 2nd position will be 1.","format":"int32","enum":[1,2]},"parameters":{"maxProperties":1,"type":"object","additionalProperties":{"maxProperties":1,"type":"string","description":" WhatsApp supports parameter value in a dynamic URL."},"description":" WhatsApp supports parameter value in a dynamic URL."}}},"WhatsAppMixedTemplateButton":{"type":"object","anyOf":[{"$ref":"#/components/schemas/WhatsAppMixedTemplateButtonUrl"},{"$ref":"#/components/schemas/WhatsAppMixedTemplateButtonSuggestedResponse"},{"$ref":"#/components/schemas/WhatsAppMixedTemplateButtonCouponCode"},{"$ref":"#/components/schemas/WhatsAppMixedTemplateButtonOtp"}]},"WhatsAppMixedTemplateButtonUrl":{"required":["index","type","url"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["url"]},"url":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"Enter final part of URL in this field (the first part is already specified in template)."}}}}},"WhatsAppMixedTemplateButtonSuggestedResponse":{"required":["index","type","suggestedResponse"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["suggestedResponse"]},"suggestedResponse":{"type":"object","required":["postbackData"],"properties":{"postbackData":{"type":"string","description":"This string will be passed back in response message if user taps this button."}}}}},"WhatsAppMixedTemplateButtonCouponCode":{"required":["index","type","couponCode"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["couponCode"]},"couponCode":{"type":"object","required":["code"],"properties":{"code":{"maximum":15,"type":"string","description":"Coupon code value."}}}}},"WhatsAppMixedTemplateButtonOtp":{"required":["index","type","otp"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["otp"]},"otp":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"OTP code value for authentication templates."}}}}},"WhatsAppMessageList":{"required":["button","sections","subtitle"],"type":"object","properties":{"sections":{"maxItems":10,"minItems":1,"type":"array","description":"Array of the message objects containing items for sending a list message.","items":{"$ref":"#/components/schemas/WhatsAppMessageListSection"}},"title":{"maximum":60,"type":"string","description":"Title for the list picker message.<br><b>Note:</b> Does not allow markdown"},"subtitle":{"maximum":1024,"type":"string","description":"Subtitle for the list picker message"},"button":{"maximum":20,"type":"string","description":"Button name for the list picker message.<br><b>Note:</b> Does not allow markdown"},"footer":{"maximum":60,"type":"string"}},"description":"<b>WhatsApp only</b><br>Object containing parameter for sending a list message"},"WhatsAppMessageListSection":{"type":"object","properties":{"items":{"maxItems":10,"minItems":1,"type":"array","description":"Array of the section message object containing specific title fields for sending a list message. Max items in total is 10.","items":{"$ref":"#/components/schemas/WhatsAppMessageListSectionItem"}},"title":{"maximum":24,"type":"string","description":"Title of section<br><b>Note:</b> Does not allow markdown.<br>If more than one section is presented, this field is required."}}},"WhatsAppMessageListSectionItem":{"required":["postbackData","title"],"type":"object","properties":{"title":{"maximum":24,"type":"string","description":"Title of item<br><b>Note:</b> Does not allow markdown"},"subtitle":{"maximum":72,"type":"string","description":"Subtitle of item<br><b>Note:</b> Does not allow markdown"},"postbackData":{"maximum":200,"type":"string","description":"Used to identify the item(s) that have been selected.<br><b>Note:</b> Does not support emojis or markdown as it is not a visible field."}}},"WhatsAppMessageButton":{"required":["body","items"],"type":"object","properties":{"body":{"maximum":1024,"type":"string"},"header":{"$ref":"#/components/schemas/WhatsAppInteractiveMessageHeader"},"items":{"maxItems":3,"minItems":1,"type":"array","description":"Array of button item objects containing specific fields for sending a button message.","items":{"$ref":"#/components/schemas/WhatsAppMessageButtonItem"}},"footer":{"maximum":60,"type":"string"}},"description":"<b>WhatsApp only</b><br>Object containing parameter for sending a button message"},"WhatsAppInteractiveMessageHeader":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Indicates the header type<br>","enum":["text","media"]},"text":{"maximum":60,"type":"string","description":"Required, if type text<br><b>Note:</b> Does not allow markdown"},"media":{"$ref":"#/components/schemas/WhatsAppInteractiveMessageMedia"}},"description":"Header content displayed on top of a message."},"WhatsAppInteractiveMessageMedia":{"required":["fileId","type"],"type":"object","properties":{"type":{"type":"string","description":"File type value.","enum":["image","video","document"]},"fileId":{"type":"string","description":"File reference id as returned in the media file upload API call."}},"description":"Required, if type media"},"WhatsAppMessageButtonItem":{"required":["postbackData","title"],"type":"object","properties":{"postbackData":{"maximum":256,"type":"string","description":"Used to identify the item(s) that have been selected.<br><b>Note:</b> The value must be unique across all reply buttons in the message."},"title":{"maximum":20,"type":"string","description":"Title of item group.<br><b>Note:</b> Does not allow markdown"},"type":{"type":"string","description":"This is a reserved field for the case where other option types get added. An example for GBM is a 'open url' action.","enum":["reply"]}}},"WhatsAppMessageCTAButton":{"required":["body","title","url"],"type":"object","properties":{"body":{"maximum":1024,"type":"string"},"header":{"$ref":"#/components/schemas/WhatsAppInteractiveMessageHeader"},"footer":{"maximum":60,"type":"string"},"title":{"maximum":20,"type":"string","description":"Title that will be displayed on the button"},"url":{"maximum":2000,"type":"string","description":"Url for CTA button"}},"description":"<b>WhatsApp only</b><br>Object containing parameter for sending a button message"},"WhatsAppMessageLocationRequest":{"required":["body"],"type":"object","properties":{"body":{"maximum":1024,"type":"string","description":"Whatsapp supports: emojis, markdown, links"}},"description":"<b>WhatsApp only</b> <br>Object for sending a location request message"}}}}
```

## The SendOmniChannelMessagesRequest object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"SendOmniChannelMessagesRequest":{"required":["messages"],"type":"object","properties":{"messages":{"maxItems":100,"minItems":1,"type":"array","description":"An array of one or more messages can be specified","items":{"$ref":"#/components/schemas/OmniMessageRequest"}}},"description":"One api send message request"},"OmniMessageRequest":{"required":["to"],"type":"object","properties":{"channel":{"type":"string","description":"Specifies the channel to be used with the specified message.","enum":["sms","whatsapp"]},"to":{"type":"string","description":"Recipient of the message.<ul>\n<li><b>SMS</b> &ndash; MSISDN, international format, no leading +.</li>\n<li><b>WhatsApp</b> &ndash; MSISDN or BSUID (Business-Scoped User ID, format: CC.alphanumeric, max 131 chars). Both are accepted. Use the BSUID when you have one; use the MSISDN to reach a user for the first time, and for one-tap, zero-tap or copy-code authentication templates, which cannot be sent to a BSUID. See <i>WhatsApp recipient identifiers</i> in the API description.</li></ul>"},"content":{"minLength":1,"type":"string","description":"The string value contains actual message content. <br><b>Character set UTF-8</b><br>WhatsApp Inline Media: base64 encoded media data<br><b>Not required for media by reference message sending</b><br><br><b>Limit</b><ul><li>WhatsApp text: 4096 characters</li><li>WhatsApp media: 1MB (total 20MB payload limit)</li></ul>"},"clientMessageId":{"type":"string","description":"Customer defined message ID for tracking purposes. Returned in callbacks and certain API submission formats."},"scheduledDeliveryTime":{"pattern":"yyyy-MM-ddTHH:mm:ssXXX","type":"string","description":"Ability to schedule messages for later delivery."},"validityPeriod":{"type":"integer","description":"The message will not be processed/queued/retried for a period exceeding the provided validity period. (In minutes)","format":"int32","default":1440},"previewFirstUrl":{"type":"boolean","description":"<b>WhatsApp only</b><br>True or false - will indicate if URL link must display as preview on recipient phone. Only applicable when sending plain text messages."},"location":{"$ref":"#/components/schemas/Location"},"contacts":{"type":"array","description":"<b>WhatsApp only</b><br>Array of the contact object containing parameters for sending a contacts message.<br><b>Note:</b><br> if contact object is presented, minimum requirement is the name parameter + at least one other parameter.","items":{"$ref":"#/components/schemas/WhatsAppContact"}},"media":{"$ref":"#/components/schemas/OmniIntegrationWaMediaRequest"},"template":{"$ref":"#/components/schemas/WhatsAppMessageTemplate"},"listPicker":{"$ref":"#/components/schemas/WhatsAppMessageList"},"button":{"$ref":"#/components/schemas/WhatsAppMessageButton"},"actionUrl":{"$ref":"#/components/schemas/WhatsAppMessageCTAButton"},"locationRequest":{"$ref":"#/components/schemas/WhatsAppMessageLocationRequest"},"from":{"type":"string","description":"<b>Sms only</b><br>The two-way number that will be used for message delivery<br>from - Required Field for Two Way communication in the USA."},"userDataHeader":{"type":"string","description":"<b>Sms only</b><br>UDH content of a message. It does not contain any text, but rather specifies how the message should be processed. Basically, it’s a part of the SMS which tells the receiving handset what type of message being sent."},"binary":{"type":"boolean","description":"<b>Sms only</b><br>Specifies if <i>content</i> delivered by client needs to be in binary format."},"encryptionKey":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Base64 encoded encrypted data key as generated from AWS KMS. Note that MC2 will have to submit additional fields to SMS/WA adapter for client side encryption to work. For client side encrypted media by reference send message requests this field must be populated even if the media <i>caption</i> is null."},"encryptionKeyArn":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Customer defined encryption key ARN."},"encryptionCipher":{"type":"string","description":"<b>Client side encryption ONLY</b><br>Customer defined encryption cipher."}}},"Location":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"maximum":180,"minimum":-180,"type":"string","description":"Longitude of the location as a numeric string value."},"latitude":{"maximum":90,"minimum":-90,"type":"string","description":"Longitude of the location as a numeric string value."},"name":{"type":"string","description":"Name of the location."},"address":{"type":"string","description":"Address of the location. The address will only be displayed if the name was set."}},"description":"<b>WhatsApp only</b><br>Object containing parameters for sending a location message."},"WhatsAppContact":{"required":["name"],"type":"object","properties":{"addresses":{"minItems":1,"type":"array","description":"List of address object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"birthday":{"pattern":"YYYY-MM-DD","type":"string","description":"String date value."},"emails":{"minItems":1,"type":"array","description":"List of the email object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"name":{"type":"object","additionalProperties":{"type":"string","description":"Name object. See request example WhatsApp Contacts: One message"},"description":"Name object. See request example WhatsApp Contacts: One message"},"origin":{"type":"string","description":"<b>WhatsApp inbound only</b><br>Indicates how the contact was shared by the user. <i>contact_request</i> means the contact was shared in direct response to a REQUEST_CONTACT_INFO button; <i>other</i> means the contact was shared organically (e.g. a forwarded vCard). Present only on inbound contact messages when supplied by WhatsApp; omitted when absent. Not encrypted for client-side encryption.","enum":["contact_request","other"]},"org":{"type":"object","additionalProperties":{"type":"string","description":"See request example WhatsApp Contacts: One message"},"description":"See request example WhatsApp Contacts: One message"},"phones":{"minItems":1,"type":"array","description":"List of the phone object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}},"urls":{"minItems":1,"type":"array","description":"List of the url object. See request example WhatsApp Contacts: One message","items":{"type":"object","additionalProperties":{"type":"string"}}}}},"OmniIntegrationWaMediaRequest":{"type":"object","properties":{"contentType":{"type":"string","description":"Media type header for file format and file content. This parameter is required when sending a media message.<br><b>Inline required.</b>"},"caption":{"type":"string","description":"This is an optional parameter and may be used to describe the media file being sent. Do not use when sending audio media."},"fileName":{"type":"string","description":"This is an optional parameter and may be used to specify name of a file that is sent to WhatsApp."},"sha256Hash":{"type":"string","description":"SHA256 File hash of the unencrypted file content."},"fileId":{"type":"string","description":"File reference id as returned in the media file upload API call.<br><b>By Reference required.</b>"}},"description":"<b>WhatsApp only</b><br>Object containing parameters for sending a media message."},"WhatsAppMessageTemplate":{"required":["templateName","body"],"type":"object","properties":{"templateName":{"type":"string","description":"Template name which was specified when created."},"language":{"type":"string","description":"Specifies the language the template may be rendered in."},"header":{"$ref":"#/components/schemas/WhatsAppMessageTemplateHeader"},"body":{"$ref":"#/components/schemas/WhatsAppMessageTemplateBody"},"buttons":{"$ref":"#/components/schemas/WhatsAppMessageTemplateButtons"},"templateButtons":{"maxItems":10,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/WhatsAppMixedTemplateButton"},"description":"<li>Suppports a combination of button types in a single WhatsApp message template.</li>  <li>All buttons of the same type must be grouped together, e.g., all “url” buttons, all “suggestedResponse” buttons, etc.</li>  <li><b>Note:</b> If a “phone” or “static URL” button is used in the template, their position (index) requires the “index” parameter of other buttons to be incremented accordingly.</li> <li>See Example: <i>WhatsApp Interactive Text Template with Mixed Buttons.</i></li>\n"}},"description":"<b>WhatsApp only</b><br>Object containing parameters for sending a template message."},"WhatsAppMessageTemplateHeader":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Indicates the header type of the template.<br><b>Note:</b><i> location</i> header type (location template) only supported for cloud-hosted numbers","enum":["text","media","location"]},"text":{"$ref":"#/components/schemas/WhatsAppTemplateHeaderText"},"media":{"$ref":"#/components/schemas/WhatsAppTemplateHeaderMedia"},"location":{"$ref":"#/components/schemas/WhatsAppTemplateHeaderLocation"}},"description":"Template header."},"WhatsAppTemplateHeaderText":{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string","description":"Key value pairs; key is string numeric value parameter and value set to the parameter value WhatsApp currently only allows for a single parameter value in the header text. <br><b>Only required if the template was created with a variable in the header text</b>"},"description":"Key value pairs; key is string numeric value parameter and value set to the parameter value WhatsApp currently only allows for a single parameter value in the header text. <br><b>Only required if the template was created with a variable in the header text</b>"}},"description":"Required, if type text"},"WhatsAppTemplateHeaderMedia":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","description":"<i>fileId</i> as returned in the api reponse of the media upload request (see <i>Upload Media file for One Api</i>). <br>WhatsApp allows files of type image, video and document."}},"description":"Required, if type media"},"WhatsAppTemplateHeaderLocation":{"required":["address","latitude","longitude","name"],"type":"object","properties":{"longitude":{"maximum":180,"minimum":-180,"type":"string","description":"Longitude of the location as a numeric string value."},"latitude":{"maximum":90,"minimum":-90,"type":"string","description":"Longitude of the location as a numeric string value."},"name":{"type":"string","description":"Name of the location."},"address":{"type":"string","description":"Address of the location. The address will only be displayed if the name was set."}},"description":"<b>Note:</b> <i>location</i> header only supported for cloud numbers. Required, if type location"},"WhatsAppMessageTemplateBody":{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string","description":"Key value pairs; key is string numeric value parameter and value set to the parameter value"},"description":"Key value pairs; key is string numeric value parameter and value set to the parameter value"}},"description":"Body object."},"WhatsAppMessageTemplateButtons":{"type":"object","properties":{"suggestedResponse":{"$ref":"#/components/schemas/WhatsAppTemplateSuggestedResponse"},"websiteUrl":{"type":"array","items":{"$ref":"#/components/schemas/WhatsAppTemplateWebsiteUrl"}}},"description":"<b>To be deprecated</b><br><u>Use <i>templateButtons</i> instead</u> <br>Interactive template message buttons. <br><i>buttons</i> parameter supports 1 button type (websiteUrl or suggestedResponse) per send message request."},"WhatsAppTemplateSuggestedResponse":{"required":["postbackData"],"type":"object","properties":{"postbackData":{"maximum":3,"maxProperties":3,"type":"object","additionalProperties":{"maximum":3,"maxProperties":3,"type":"string","description":"<b>Key</b> : String integer value of the button to which the postbackData should be associated<br><b>Value</b> : User defined data that will be returned in the callback function to the business."},"description":"<b>Key</b> : String integer value of the button to which the postbackData should be associated<br><b>Value</b> : User defined data that will be returned in the callback function to the business."}}},"WhatsAppTemplateWebsiteUrl":{"required":["listPosition"],"type":"object","properties":{"listPosition":{"type":"integer","description":"If a template was create with a dial button in the 1st position and the websiteUrl in the 2nd position then the <i>listPosition</i> will be 2.<br>If a template was created with the websiteUrl button in 1st position and the dial button in the 2nd position will be 1.","format":"int32","enum":[1,2]},"parameters":{"maxProperties":1,"type":"object","additionalProperties":{"maxProperties":1,"type":"string","description":" WhatsApp supports parameter value in a dynamic URL."},"description":" WhatsApp supports parameter value in a dynamic URL."}}},"WhatsAppMixedTemplateButton":{"type":"object","anyOf":[{"$ref":"#/components/schemas/WhatsAppMixedTemplateButtonUrl"},{"$ref":"#/components/schemas/WhatsAppMixedTemplateButtonSuggestedResponse"},{"$ref":"#/components/schemas/WhatsAppMixedTemplateButtonCouponCode"},{"$ref":"#/components/schemas/WhatsAppMixedTemplateButtonOtp"}]},"WhatsAppMixedTemplateButtonUrl":{"required":["index","type","url"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["url"]},"url":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"Enter final part of URL in this field (the first part is already specified in template)."}}}}},"WhatsAppMixedTemplateButtonSuggestedResponse":{"required":["index","type","suggestedResponse"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["suggestedResponse"]},"suggestedResponse":{"type":"object","required":["postbackData"],"properties":{"postbackData":{"type":"string","description":"This string will be passed back in response message if user taps this button."}}}}},"WhatsAppMixedTemplateButtonCouponCode":{"required":["index","type","couponCode"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["couponCode"]},"couponCode":{"type":"object","required":["code"],"properties":{"code":{"maximum":15,"type":"string","description":"Coupon code value."}}}}},"WhatsAppMixedTemplateButtonOtp":{"required":["index","type","otp"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["otp"]},"otp":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"OTP code value for authentication templates."}}}}},"WhatsAppMessageList":{"required":["button","sections","subtitle"],"type":"object","properties":{"sections":{"maxItems":10,"minItems":1,"type":"array","description":"Array of the message objects containing items for sending a list message.","items":{"$ref":"#/components/schemas/WhatsAppMessageListSection"}},"title":{"maximum":60,"type":"string","description":"Title for the list picker message.<br><b>Note:</b> Does not allow markdown"},"subtitle":{"maximum":1024,"type":"string","description":"Subtitle for the list picker message"},"button":{"maximum":20,"type":"string","description":"Button name for the list picker message.<br><b>Note:</b> Does not allow markdown"},"footer":{"maximum":60,"type":"string"}},"description":"<b>WhatsApp only</b><br>Object containing parameter for sending a list message"},"WhatsAppMessageListSection":{"type":"object","properties":{"items":{"maxItems":10,"minItems":1,"type":"array","description":"Array of the section message object containing specific title fields for sending a list message. Max items in total is 10.","items":{"$ref":"#/components/schemas/WhatsAppMessageListSectionItem"}},"title":{"maximum":24,"type":"string","description":"Title of section<br><b>Note:</b> Does not allow markdown.<br>If more than one section is presented, this field is required."}}},"WhatsAppMessageListSectionItem":{"required":["postbackData","title"],"type":"object","properties":{"title":{"maximum":24,"type":"string","description":"Title of item<br><b>Note:</b> Does not allow markdown"},"subtitle":{"maximum":72,"type":"string","description":"Subtitle of item<br><b>Note:</b> Does not allow markdown"},"postbackData":{"maximum":200,"type":"string","description":"Used to identify the item(s) that have been selected.<br><b>Note:</b> Does not support emojis or markdown as it is not a visible field."}}},"WhatsAppMessageButton":{"required":["body","items"],"type":"object","properties":{"body":{"maximum":1024,"type":"string"},"header":{"$ref":"#/components/schemas/WhatsAppInteractiveMessageHeader"},"items":{"maxItems":3,"minItems":1,"type":"array","description":"Array of button item objects containing specific fields for sending a button message.","items":{"$ref":"#/components/schemas/WhatsAppMessageButtonItem"}},"footer":{"maximum":60,"type":"string"}},"description":"<b>WhatsApp only</b><br>Object containing parameter for sending a button message"},"WhatsAppInteractiveMessageHeader":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Indicates the header type<br>","enum":["text","media"]},"text":{"maximum":60,"type":"string","description":"Required, if type text<br><b>Note:</b> Does not allow markdown"},"media":{"$ref":"#/components/schemas/WhatsAppInteractiveMessageMedia"}},"description":"Header content displayed on top of a message."},"WhatsAppInteractiveMessageMedia":{"required":["fileId","type"],"type":"object","properties":{"type":{"type":"string","description":"File type value.","enum":["image","video","document"]},"fileId":{"type":"string","description":"File reference id as returned in the media file upload API call."}},"description":"Required, if type media"},"WhatsAppMessageButtonItem":{"required":["postbackData","title"],"type":"object","properties":{"postbackData":{"maximum":256,"type":"string","description":"Used to identify the item(s) that have been selected.<br><b>Note:</b> The value must be unique across all reply buttons in the message."},"title":{"maximum":20,"type":"string","description":"Title of item group.<br><b>Note:</b> Does not allow markdown"},"type":{"type":"string","description":"This is a reserved field for the case where other option types get added. An example for GBM is a 'open url' action.","enum":["reply"]}}},"WhatsAppMessageCTAButton":{"required":["body","title","url"],"type":"object","properties":{"body":{"maximum":1024,"type":"string"},"header":{"$ref":"#/components/schemas/WhatsAppInteractiveMessageHeader"},"footer":{"maximum":60,"type":"string"},"title":{"maximum":20,"type":"string","description":"Title that will be displayed on the button"},"url":{"maximum":2000,"type":"string","description":"Url for CTA button"}},"description":"<b>WhatsApp only</b><br>Object containing parameter for sending a button message"},"WhatsAppMessageLocationRequest":{"required":["body"],"type":"object","properties":{"body":{"maximum":1024,"type":"string","description":"Whatsapp supports: emojis, markdown, links"}},"description":"<b>WhatsApp only</b> <br>Object for sending a location request message"}}}}
```

## The WhatsAppMessageButton object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppMessageButton":{"required":["body","items"],"type":"object","properties":{"body":{"maximum":1024,"type":"string"},"header":{"$ref":"#/components/schemas/WhatsAppInteractiveMessageHeader"},"items":{"maxItems":3,"minItems":1,"type":"array","description":"Array of button item objects containing specific fields for sending a button message.","items":{"$ref":"#/components/schemas/WhatsAppMessageButtonItem"}},"footer":{"maximum":60,"type":"string"}},"description":"<b>WhatsApp only</b><br>Object containing parameter for sending a button message"},"WhatsAppInteractiveMessageHeader":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Indicates the header type<br>","enum":["text","media"]},"text":{"maximum":60,"type":"string","description":"Required, if type text<br><b>Note:</b> Does not allow markdown"},"media":{"$ref":"#/components/schemas/WhatsAppInteractiveMessageMedia"}},"description":"Header content displayed on top of a message."},"WhatsAppInteractiveMessageMedia":{"required":["fileId","type"],"type":"object","properties":{"type":{"type":"string","description":"File type value.","enum":["image","video","document"]},"fileId":{"type":"string","description":"File reference id as returned in the media file upload API call."}},"description":"Required, if type media"},"WhatsAppMessageButtonItem":{"required":["postbackData","title"],"type":"object","properties":{"postbackData":{"maximum":256,"type":"string","description":"Used to identify the item(s) that have been selected.<br><b>Note:</b> The value must be unique across all reply buttons in the message."},"title":{"maximum":20,"type":"string","description":"Title of item group.<br><b>Note:</b> Does not allow markdown"},"type":{"type":"string","description":"This is a reserved field for the case where other option types get added. An example for GBM is a 'open url' action.","enum":["reply"]}}}}}}
```

## The WhatsAppInteractiveMessageHeader object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppInteractiveMessageHeader":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Indicates the header type<br>","enum":["text","media"]},"text":{"maximum":60,"type":"string","description":"Required, if type text<br><b>Note:</b> Does not allow markdown"},"media":{"$ref":"#/components/schemas/WhatsAppInteractiveMessageMedia"}},"description":"Header content displayed on top of a message."},"WhatsAppInteractiveMessageMedia":{"required":["fileId","type"],"type":"object","properties":{"type":{"type":"string","description":"File type value.","enum":["image","video","document"]},"fileId":{"type":"string","description":"File reference id as returned in the media file upload API call."}},"description":"Required, if type media"}}}}
```

## The WhatsAppMessageButtonItem object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppMessageButtonItem":{"required":["postbackData","title"],"type":"object","properties":{"postbackData":{"maximum":256,"type":"string","description":"Used to identify the item(s) that have been selected.<br><b>Note:</b> The value must be unique across all reply buttons in the message."},"title":{"maximum":20,"type":"string","description":"Title of item group.<br><b>Note:</b> Does not allow markdown"},"type":{"type":"string","description":"This is a reserved field for the case where other option types get added. An example for GBM is a 'open url' action.","enum":["reply"]}}}}}}
```

## The WhatsAppMessageCTAButton object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppMessageCTAButton":{"required":["body","title","url"],"type":"object","properties":{"body":{"maximum":1024,"type":"string"},"header":{"$ref":"#/components/schemas/WhatsAppInteractiveMessageHeader"},"footer":{"maximum":60,"type":"string"},"title":{"maximum":20,"type":"string","description":"Title that will be displayed on the button"},"url":{"maximum":2000,"type":"string","description":"Url for CTA button"}},"description":"<b>WhatsApp only</b><br>Object containing parameter for sending a button message"},"WhatsAppInteractiveMessageHeader":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Indicates the header type<br>","enum":["text","media"]},"text":{"maximum":60,"type":"string","description":"Required, if type text<br><b>Note:</b> Does not allow markdown"},"media":{"$ref":"#/components/schemas/WhatsAppInteractiveMessageMedia"}},"description":"Header content displayed on top of a message."},"WhatsAppInteractiveMessageMedia":{"required":["fileId","type"],"type":"object","properties":{"type":{"type":"string","description":"File type value.","enum":["image","video","document"]},"fileId":{"type":"string","description":"File reference id as returned in the media file upload API call."}},"description":"Required, if type media"}}}}
```

## The WhatsAppInteractiveMessageMedia object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppInteractiveMessageMedia":{"required":["fileId","type"],"type":"object","properties":{"type":{"type":"string","description":"File type value.","enum":["image","video","document"]},"fileId":{"type":"string","description":"File reference id as returned in the media file upload API call."}},"description":"Required, if type media"}}}}
```

## The WhatsAppMessageList object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppMessageList":{"required":["button","sections","subtitle"],"type":"object","properties":{"sections":{"maxItems":10,"minItems":1,"type":"array","description":"Array of the message objects containing items for sending a list message.","items":{"$ref":"#/components/schemas/WhatsAppMessageListSection"}},"title":{"maximum":60,"type":"string","description":"Title for the list picker message.<br><b>Note:</b> Does not allow markdown"},"subtitle":{"maximum":1024,"type":"string","description":"Subtitle for the list picker message"},"button":{"maximum":20,"type":"string","description":"Button name for the list picker message.<br><b>Note:</b> Does not allow markdown"},"footer":{"maximum":60,"type":"string"}},"description":"<b>WhatsApp only</b><br>Object containing parameter for sending a list message"},"WhatsAppMessageListSection":{"type":"object","properties":{"items":{"maxItems":10,"minItems":1,"type":"array","description":"Array of the section message object containing specific title fields for sending a list message. Max items in total is 10.","items":{"$ref":"#/components/schemas/WhatsAppMessageListSectionItem"}},"title":{"maximum":24,"type":"string","description":"Title of section<br><b>Note:</b> Does not allow markdown.<br>If more than one section is presented, this field is required."}}},"WhatsAppMessageListSectionItem":{"required":["postbackData","title"],"type":"object","properties":{"title":{"maximum":24,"type":"string","description":"Title of item<br><b>Note:</b> Does not allow markdown"},"subtitle":{"maximum":72,"type":"string","description":"Subtitle of item<br><b>Note:</b> Does not allow markdown"},"postbackData":{"maximum":200,"type":"string","description":"Used to identify the item(s) that have been selected.<br><b>Note:</b> Does not support emojis or markdown as it is not a visible field."}}}}}}
```

## The WhatsAppMessageListSection object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppMessageListSection":{"type":"object","properties":{"items":{"maxItems":10,"minItems":1,"type":"array","description":"Array of the section message object containing specific title fields for sending a list message. Max items in total is 10.","items":{"$ref":"#/components/schemas/WhatsAppMessageListSectionItem"}},"title":{"maximum":24,"type":"string","description":"Title of section<br><b>Note:</b> Does not allow markdown.<br>If more than one section is presented, this field is required."}}},"WhatsAppMessageListSectionItem":{"required":["postbackData","title"],"type":"object","properties":{"title":{"maximum":24,"type":"string","description":"Title of item<br><b>Note:</b> Does not allow markdown"},"subtitle":{"maximum":72,"type":"string","description":"Subtitle of item<br><b>Note:</b> Does not allow markdown"},"postbackData":{"maximum":200,"type":"string","description":"Used to identify the item(s) that have been selected.<br><b>Note:</b> Does not support emojis or markdown as it is not a visible field."}}}}}}
```

## The WhatsAppMessageListSectionItem object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppMessageListSectionItem":{"required":["postbackData","title"],"type":"object","properties":{"title":{"maximum":24,"type":"string","description":"Title of item<br><b>Note:</b> Does not allow markdown"},"subtitle":{"maximum":72,"type":"string","description":"Subtitle of item<br><b>Note:</b> Does not allow markdown"},"postbackData":{"maximum":200,"type":"string","description":"Used to identify the item(s) that have been selected.<br><b>Note:</b> Does not support emojis or markdown as it is not a visible field."}}}}}}
```

## The WhatsAppMessageTemplate object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppMessageTemplate":{"required":["templateName","body"],"type":"object","properties":{"templateName":{"type":"string","description":"Template name which was specified when created."},"language":{"type":"string","description":"Specifies the language the template may be rendered in."},"header":{"$ref":"#/components/schemas/WhatsAppMessageTemplateHeader"},"body":{"$ref":"#/components/schemas/WhatsAppMessageTemplateBody"},"buttons":{"$ref":"#/components/schemas/WhatsAppMessageTemplateButtons"},"templateButtons":{"maxItems":10,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/WhatsAppMixedTemplateButton"},"description":"<li>Suppports a combination of button types in a single WhatsApp message template.</li>  <li>All buttons of the same type must be grouped together, e.g., all “url” buttons, all “suggestedResponse” buttons, etc.</li>  <li><b>Note:</b> If a “phone” or “static URL” button is used in the template, their position (index) requires the “index” parameter of other buttons to be incremented accordingly.</li> <li>See Example: <i>WhatsApp Interactive Text Template with Mixed Buttons.</i></li>\n"}},"description":"<b>WhatsApp only</b><br>Object containing parameters for sending a template message."},"WhatsAppMessageTemplateHeader":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Indicates the header type of the template.<br><b>Note:</b><i> location</i> header type (location template) only supported for cloud-hosted numbers","enum":["text","media","location"]},"text":{"$ref":"#/components/schemas/WhatsAppTemplateHeaderText"},"media":{"$ref":"#/components/schemas/WhatsAppTemplateHeaderMedia"},"location":{"$ref":"#/components/schemas/WhatsAppTemplateHeaderLocation"}},"description":"Template header."},"WhatsAppTemplateHeaderText":{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string","description":"Key value pairs; key is string numeric value parameter and value set to the parameter value WhatsApp currently only allows for a single parameter value in the header text. <br><b>Only required if the template was created with a variable in the header text</b>"},"description":"Key value pairs; key is string numeric value parameter and value set to the parameter value WhatsApp currently only allows for a single parameter value in the header text. <br><b>Only required if the template was created with a variable in the header text</b>"}},"description":"Required, if type text"},"WhatsAppTemplateHeaderMedia":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","description":"<i>fileId</i> as returned in the api reponse of the media upload request (see <i>Upload Media file for One Api</i>). <br>WhatsApp allows files of type image, video and document."}},"description":"Required, if type media"},"WhatsAppTemplateHeaderLocation":{"required":["address","latitude","longitude","name"],"type":"object","properties":{"longitude":{"maximum":180,"minimum":-180,"type":"string","description":"Longitude of the location as a numeric string value."},"latitude":{"maximum":90,"minimum":-90,"type":"string","description":"Longitude of the location as a numeric string value."},"name":{"type":"string","description":"Name of the location."},"address":{"type":"string","description":"Address of the location. The address will only be displayed if the name was set."}},"description":"<b>Note:</b> <i>location</i> header only supported for cloud numbers. Required, if type location"},"WhatsAppMessageTemplateBody":{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string","description":"Key value pairs; key is string numeric value parameter and value set to the parameter value"},"description":"Key value pairs; key is string numeric value parameter and value set to the parameter value"}},"description":"Body object."},"WhatsAppMessageTemplateButtons":{"type":"object","properties":{"suggestedResponse":{"$ref":"#/components/schemas/WhatsAppTemplateSuggestedResponse"},"websiteUrl":{"type":"array","items":{"$ref":"#/components/schemas/WhatsAppTemplateWebsiteUrl"}}},"description":"<b>To be deprecated</b><br><u>Use <i>templateButtons</i> instead</u> <br>Interactive template message buttons. <br><i>buttons</i> parameter supports 1 button type (websiteUrl or suggestedResponse) per send message request."},"WhatsAppTemplateSuggestedResponse":{"required":["postbackData"],"type":"object","properties":{"postbackData":{"maximum":3,"maxProperties":3,"type":"object","additionalProperties":{"maximum":3,"maxProperties":3,"type":"string","description":"<b>Key</b> : String integer value of the button to which the postbackData should be associated<br><b>Value</b> : User defined data that will be returned in the callback function to the business."},"description":"<b>Key</b> : String integer value of the button to which the postbackData should be associated<br><b>Value</b> : User defined data that will be returned in the callback function to the business."}}},"WhatsAppTemplateWebsiteUrl":{"required":["listPosition"],"type":"object","properties":{"listPosition":{"type":"integer","description":"If a template was create with a dial button in the 1st position and the websiteUrl in the 2nd position then the <i>listPosition</i> will be 2.<br>If a template was created with the websiteUrl button in 1st position and the dial button in the 2nd position will be 1.","format":"int32","enum":[1,2]},"parameters":{"maxProperties":1,"type":"object","additionalProperties":{"maxProperties":1,"type":"string","description":" WhatsApp supports parameter value in a dynamic URL."},"description":" WhatsApp supports parameter value in a dynamic URL."}}},"WhatsAppMixedTemplateButton":{"type":"object","anyOf":[{"$ref":"#/components/schemas/WhatsAppMixedTemplateButtonUrl"},{"$ref":"#/components/schemas/WhatsAppMixedTemplateButtonSuggestedResponse"},{"$ref":"#/components/schemas/WhatsAppMixedTemplateButtonCouponCode"},{"$ref":"#/components/schemas/WhatsAppMixedTemplateButtonOtp"}]},"WhatsAppMixedTemplateButtonUrl":{"required":["index","type","url"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["url"]},"url":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"Enter final part of URL in this field (the first part is already specified in template)."}}}}},"WhatsAppMixedTemplateButtonSuggestedResponse":{"required":["index","type","suggestedResponse"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["suggestedResponse"]},"suggestedResponse":{"type":"object","required":["postbackData"],"properties":{"postbackData":{"type":"string","description":"This string will be passed back in response message if user taps this button."}}}}},"WhatsAppMixedTemplateButtonCouponCode":{"required":["index","type","couponCode"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["couponCode"]},"couponCode":{"type":"object","required":["code"],"properties":{"code":{"maximum":15,"type":"string","description":"Coupon code value."}}}}},"WhatsAppMixedTemplateButtonOtp":{"required":["index","type","otp"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["otp"]},"otp":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"OTP code value for authentication templates."}}}}}}}}
```

## The WhatsAppMessageTemplateBody object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppMessageTemplateBody":{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string","description":"Key value pairs; key is string numeric value parameter and value set to the parameter value"},"description":"Key value pairs; key is string numeric value parameter and value set to the parameter value"}},"description":"Body object."}}}}
```

## The WhatsAppMessageTemplateButtons object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppMessageTemplateButtons":{"type":"object","properties":{"suggestedResponse":{"$ref":"#/components/schemas/WhatsAppTemplateSuggestedResponse"},"websiteUrl":{"type":"array","items":{"$ref":"#/components/schemas/WhatsAppTemplateWebsiteUrl"}}},"description":"<b>To be deprecated</b><br><u>Use <i>templateButtons</i> instead</u> <br>Interactive template message buttons. <br><i>buttons</i> parameter supports 1 button type (websiteUrl or suggestedResponse) per send message request."},"WhatsAppTemplateSuggestedResponse":{"required":["postbackData"],"type":"object","properties":{"postbackData":{"maximum":3,"maxProperties":3,"type":"object","additionalProperties":{"maximum":3,"maxProperties":3,"type":"string","description":"<b>Key</b> : String integer value of the button to which the postbackData should be associated<br><b>Value</b> : User defined data that will be returned in the callback function to the business."},"description":"<b>Key</b> : String integer value of the button to which the postbackData should be associated<br><b>Value</b> : User defined data that will be returned in the callback function to the business."}}},"WhatsAppTemplateWebsiteUrl":{"required":["listPosition"],"type":"object","properties":{"listPosition":{"type":"integer","description":"If a template was create with a dial button in the 1st position and the websiteUrl in the 2nd position then the <i>listPosition</i> will be 2.<br>If a template was created with the websiteUrl button in 1st position and the dial button in the 2nd position will be 1.","format":"int32","enum":[1,2]},"parameters":{"maxProperties":1,"type":"object","additionalProperties":{"maxProperties":1,"type":"string","description":" WhatsApp supports parameter value in a dynamic URL."},"description":" WhatsApp supports parameter value in a dynamic URL."}}}}}}
```

## The WhatsAppMessageTemplateHeader object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppMessageTemplateHeader":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Indicates the header type of the template.<br><b>Note:</b><i> location</i> header type (location template) only supported for cloud-hosted numbers","enum":["text","media","location"]},"text":{"$ref":"#/components/schemas/WhatsAppTemplateHeaderText"},"media":{"$ref":"#/components/schemas/WhatsAppTemplateHeaderMedia"},"location":{"$ref":"#/components/schemas/WhatsAppTemplateHeaderLocation"}},"description":"Template header."},"WhatsAppTemplateHeaderText":{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string","description":"Key value pairs; key is string numeric value parameter and value set to the parameter value WhatsApp currently only allows for a single parameter value in the header text. <br><b>Only required if the template was created with a variable in the header text</b>"},"description":"Key value pairs; key is string numeric value parameter and value set to the parameter value WhatsApp currently only allows for a single parameter value in the header text. <br><b>Only required if the template was created with a variable in the header text</b>"}},"description":"Required, if type text"},"WhatsAppTemplateHeaderMedia":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","description":"<i>fileId</i> as returned in the api reponse of the media upload request (see <i>Upload Media file for One Api</i>). <br>WhatsApp allows files of type image, video and document."}},"description":"Required, if type media"},"WhatsAppTemplateHeaderLocation":{"required":["address","latitude","longitude","name"],"type":"object","properties":{"longitude":{"maximum":180,"minimum":-180,"type":"string","description":"Longitude of the location as a numeric string value."},"latitude":{"maximum":90,"minimum":-90,"type":"string","description":"Longitude of the location as a numeric string value."},"name":{"type":"string","description":"Name of the location."},"address":{"type":"string","description":"Address of the location. The address will only be displayed if the name was set."}},"description":"<b>Note:</b> <i>location</i> header only supported for cloud numbers. Required, if type location"}}}}
```

## The WhatsAppMixedTemplateButton object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppMixedTemplateButton":{"type":"object","anyOf":[{"$ref":"#/components/schemas/WhatsAppMixedTemplateButtonUrl"},{"$ref":"#/components/schemas/WhatsAppMixedTemplateButtonSuggestedResponse"},{"$ref":"#/components/schemas/WhatsAppMixedTemplateButtonCouponCode"},{"$ref":"#/components/schemas/WhatsAppMixedTemplateButtonOtp"}]},"WhatsAppMixedTemplateButtonUrl":{"required":["index","type","url"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["url"]},"url":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"Enter final part of URL in this field (the first part is already specified in template)."}}}}},"WhatsAppMixedTemplateButtonSuggestedResponse":{"required":["index","type","suggestedResponse"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["suggestedResponse"]},"suggestedResponse":{"type":"object","required":["postbackData"],"properties":{"postbackData":{"type":"string","description":"This string will be passed back in response message if user taps this button."}}}}},"WhatsAppMixedTemplateButtonCouponCode":{"required":["index","type","couponCode"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["couponCode"]},"couponCode":{"type":"object","required":["code"],"properties":{"code":{"maximum":15,"type":"string","description":"Coupon code value."}}}}},"WhatsAppMixedTemplateButtonOtp":{"required":["index","type","otp"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["otp"]},"otp":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"OTP code value for authentication templates."}}}}}}}}
```

## The WhatsAppMixedTemplateButtonSuggestedResponse object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppMixedTemplateButtonSuggestedResponse":{"required":["index","type","suggestedResponse"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["suggestedResponse"]},"suggestedResponse":{"type":"object","required":["postbackData"],"properties":{"postbackData":{"type":"string","description":"This string will be passed back in response message if user taps this button."}}}}}}}}
```

## The WhatsAppMixedTemplateButtonUrl object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppMixedTemplateButtonUrl":{"required":["index","type","url"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["url"]},"url":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"Enter final part of URL in this field (the first part is already specified in template)."}}}}}}}}
```

## The WhatsAppMixedTemplateButtonCouponCode object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppMixedTemplateButtonCouponCode":{"required":["index","type","couponCode"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["couponCode"]},"couponCode":{"type":"object","required":["code"],"properties":{"code":{"maximum":15,"type":"string","description":"Coupon code value."}}}}}}}}
```

## The WhatsAppMixedTemplateButtonOtp object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppMixedTemplateButtonOtp":{"required":["index","type","otp"],"type":"object","properties":{"index":{"type":"integer","format":"int32","description":"Index of button in template in order it was created, starts at 1"},"type":{"type":"string","enum":["otp"]},"otp":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"OTP code value for authentication templates."}}}}}}}}
```

## The WhatsAppTemplateHeaderLocation object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppTemplateHeaderLocation":{"required":["address","latitude","longitude","name"],"type":"object","properties":{"longitude":{"maximum":180,"minimum":-180,"type":"string","description":"Longitude of the location as a numeric string value."},"latitude":{"maximum":90,"minimum":-90,"type":"string","description":"Longitude of the location as a numeric string value."},"name":{"type":"string","description":"Name of the location."},"address":{"type":"string","description":"Address of the location. The address will only be displayed if the name was set."}},"description":"<b>Note:</b> <i>location</i> header only supported for cloud numbers. Required, if type location"}}}}
```

## The WhatsAppTemplateHeaderMedia object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppTemplateHeaderMedia":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","description":"<i>fileId</i> as returned in the api reponse of the media upload request (see <i>Upload Media file for One Api</i>). <br>WhatsApp allows files of type image, video and document."}},"description":"Required, if type media"}}}}
```

## The WhatsAppTemplateHeaderText object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppTemplateHeaderText":{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string","description":"Key value pairs; key is string numeric value parameter and value set to the parameter value WhatsApp currently only allows for a single parameter value in the header text. <br><b>Only required if the template was created with a variable in the header text</b>"},"description":"Key value pairs; key is string numeric value parameter and value set to the parameter value WhatsApp currently only allows for a single parameter value in the header text. <br><b>Only required if the template was created with a variable in the header text</b>"}},"description":"Required, if type text"}}}}
```

## The WhatsAppTemplateSuggestedResponse object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppTemplateSuggestedResponse":{"required":["postbackData"],"type":"object","properties":{"postbackData":{"maximum":3,"maxProperties":3,"type":"object","additionalProperties":{"maximum":3,"maxProperties":3,"type":"string","description":"<b>Key</b> : String integer value of the button to which the postbackData should be associated<br><b>Value</b> : User defined data that will be returned in the callback function to the business."},"description":"<b>Key</b> : String integer value of the button to which the postbackData should be associated<br><b>Value</b> : User defined data that will be returned in the callback function to the business."}}}}}}
```

## The WhatsAppTemplateWebsiteUrl object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppTemplateWebsiteUrl":{"required":["listPosition"],"type":"object","properties":{"listPosition":{"type":"integer","description":"If a template was create with a dial button in the 1st position and the websiteUrl in the 2nd position then the <i>listPosition</i> will be 2.<br>If a template was created with the websiteUrl button in 1st position and the dial button in the 2nd position will be 1.","format":"int32","enum":[1,2]},"parameters":{"maxProperties":1,"type":"object","additionalProperties":{"maxProperties":1,"type":"string","description":" WhatsApp supports parameter value in a dynamic URL."},"description":" WhatsApp supports parameter value in a dynamic URL."}}}}}}
```

## The WhatsAppMessageLocationRequest object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppMessageLocationRequest":{"required":["body"],"type":"object","properties":{"body":{"maximum":1024,"type":"string","description":"Whatsapp supports: emojis, markdown, links"}},"description":"<b>WhatsApp only</b> <br>Object for sending a location request message"}}}}
```

## The MediaFileMetadataResponse object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"MediaFileMetadataResponse":{"type":"object","properties":{"expirationTime":{"type":"integer","format":"int64"},"broadcastAllowed":{"type":"boolean"}}}}}}
```

## The OmniMediaUploadResponse object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"OmniMediaUploadResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/OmniResponseError"},"fileId":{"type":"string"},"accepted":{"type":"boolean"}}},"OmniResponseError":{"type":"object","properties":{"code":{"type":"integer","description":"<i>Error Code</i> value in ","format":"int32"},"description":{"type":"string","description":"<i>Error Message</i>"}}}}}}
```

## The MessagingBalanceResponse object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"MessagingBalanceResponse":{"type":"object","properties":{"balance":{"type":"number"},"currency":{"type":"string"}}}}}}
```

## The NotificationEventResponse object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"NotificationEventResponse":{"type":"object","properties":{"messageStatusUpdate":{"type":"array","items":{"$ref":"#/components/schemas/NotificationResponse"}}}},"NotificationResponse":{"type":"object","properties":{"apiEventId":{"type":"string"},"accepted":{"type":"boolean"},"messageId":{"type":"string"},"clientEventId":{"type":"string"},"error":{"$ref":"#/components/schemas/OmniResponseError"}}},"OmniResponseError":{"type":"object","properties":{"code":{"type":"integer","description":"<i>Error Code</i> value in ","format":"int32"},"description":{"type":"string","description":"<i>Error Message</i>"}}}}}}
```

## The NotificationResponse object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"NotificationResponse":{"type":"object","properties":{"apiEventId":{"type":"string"},"accepted":{"type":"boolean"},"messageId":{"type":"string"},"clientEventId":{"type":"string"},"error":{"$ref":"#/components/schemas/OmniResponseError"}}},"OmniResponseError":{"type":"object","properties":{"code":{"type":"integer","description":"<i>Error Code</i> value in ","format":"int32"},"description":{"type":"string","description":"<i>Error Message</i>"}}}}}}
```

## The WhatsAppNotificationListResponse object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"WhatsAppNotificationListResponse":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/NotificationEventResponse"},"error":{"$ref":"#/components/schemas/OmniResponseError"},"type":{"type":"string","writeOnly":true,"enum":["SUCCESS","MIXED","FAIL"]}}},"NotificationEventResponse":{"type":"object","properties":{"messageStatusUpdate":{"type":"array","items":{"$ref":"#/components/schemas/NotificationResponse"}}}},"NotificationResponse":{"type":"object","properties":{"apiEventId":{"type":"string"},"accepted":{"type":"boolean"},"messageId":{"type":"string"},"clientEventId":{"type":"string"},"error":{"$ref":"#/components/schemas/OmniResponseError"}}},"OmniResponseError":{"type":"object","properties":{"code":{"type":"integer","description":"<i>Error Code</i> value in ","format":"int32"},"description":{"type":"string","description":"<i>Error Message</i>"}}}}}}
```

## The ReplyStatusEvent object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"ReplyStatusEvent":{"required":["messageStatusUpdate"],"type":"object","properties":{"messageStatusUpdate":{"maxItems":100,"minItems":1,"type":"array","description":"An array of one or more messages can be specified","items":{"$ref":"#/components/schemas/ReplyStatusUpdateNotification"}}},"description":"Business Read Status event request"},"ReplyStatusUpdateNotification":{"required":["messageId","statusCode"],"type":"object","properties":{"channel":{"type":"string","description":"Supplier channel on which the inbound message to which this notification relates was received","default":"whatsapp","enum":["whatsapp"]},"statusCode":{"type":"integer","description":"Business acknowledges that it has read (seen) an inbound message from the user","format":"int32","default":1001,"enum":[1001]},"messageId":{"type":"string","description":"MO message id of the message associated with this status update"},"clientEventId":{"type":"string","description":"Client internal id that the client can use to match the response to the request. This parameter will just be echoed back in the response."}}}}}}
```

## The ReplyStatusNotificationRequest object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"ReplyStatusNotificationRequest":{"required":["event"],"type":"object","properties":{"event":{"$ref":"#/components/schemas/ReplyStatusEvent"}},"description":"Send Business Read Status notification request"},"ReplyStatusEvent":{"required":["messageStatusUpdate"],"type":"object","properties":{"messageStatusUpdate":{"maxItems":100,"minItems":1,"type":"array","description":"An array of one or more messages can be specified","items":{"$ref":"#/components/schemas/ReplyStatusUpdateNotification"}}},"description":"Business Read Status event request"},"ReplyStatusUpdateNotification":{"required":["messageId","statusCode"],"type":"object","properties":{"channel":{"type":"string","description":"Supplier channel on which the inbound message to which this notification relates was received","default":"whatsapp","enum":["whatsapp"]},"statusCode":{"type":"integer","description":"Business acknowledges that it has read (seen) an inbound message from the user","format":"int32","default":1001,"enum":[1001]},"messageId":{"type":"string","description":"MO message id of the message associated with this status update"},"clientEventId":{"type":"string","description":"Client internal id that the client can use to match the response to the request. This parameter will just be echoed back in the response."}}}}}}
```

## The ReplyStatusUpdateNotification object

```json
{"openapi":"3.0.1","info":{"title":"One API","version":"1.0.0"},"components":{"schemas":{"ReplyStatusUpdateNotification":{"required":["messageId","statusCode"],"type":"object","properties":{"channel":{"type":"string","description":"Supplier channel on which the inbound message to which this notification relates was received","default":"whatsapp","enum":["whatsapp"]},"statusCode":{"type":"integer","description":"Business acknowledges that it has read (seen) an inbound message from the user","format":"int32","default":1001,"enum":[1001]},"messageId":{"type":"string","description":"MO message id of the message associated with this status update"},"clientEventId":{"type":"string","description":"Client internal id that the client can use to match the response to the request. This parameter will just be echoed back in the response."}}}}}}
```
