[**Documentation**](index.md) *** [Documentation](packages.md) / Vonage Messages # Vonage Messages SDK for Node.js ![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/Vonage/vonage-node-sdk/ci.yml?branch=3.x) [![Codecov](https://img.shields.io/codecov/c/github/vonage/vonage-node-sdk?label=Codecov&logo=codecov&style=flat-square)](https://codecov.io/gh/Vonage/vonage-server-sdk) ![Latest Release](https://img.shields.io/github/v/release/vonage/vonage-node-sdk?logo=npm&style=flat-square) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-square)](../../CODE_OF_CONDUCT.md) [![License](https://img.shields.io/npm/l/@vonage/server-sdk?label=License&style=flat-square)](../../LICENSE.TXT) Vonage This is the Vonage Messages SDK for Node.js for use with [Vonage APIs](https://www.vonage.com/). To use it you will need a Vonage account. Sign up [for free][signup] at vonage.com. For full API documentation refer to [developer.nexmo.com](https://developer.nexmo.com/). If you are updating from V2 to V3, please check the migration guide found [here](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/messages/v2_TO_v3_MIGRATION_GUIDE.md) * [Installation](#installation) * [Usage](#usage) * [Promises](#promises) * [Channels](#channels) ## Installation We recommend using this SDK as part of the overall [`@vonage/server-sdk` package](https://github.com/vonage/vonage-node-sdk). Please see the main package for installation. You can also use this SDK standalone if you only need access to just the Messages API. ### With NPM ```bash npm install @vonage/messages ``` ### With Yarn ```bash yarn add @vonage/messages ``` ## Usage ### As part of the Vonage Server SDK If you are using this SDK as part of the Vonage Server SDK, you can access it as the `messages` property off of the client that you instantiate. ```js const {Vonage} = require('@vonage/server-sdk'); const { Auth, AlgorithmTypes } = require('@vonage/auth'); const { SMS } = require('@vonage/messages'); const vonage = new Vonage(new Auth({ apiKey: API_KEY, apiSecret: API_SECRET, applicationId: APP_ID, privateKey: PRIVATE_KEY_PATH, signature: { secret: 'ABCDE', algorithm: AlgorithmTypes.md5hash, }, }), options); vonage.messages.send(new SMS({ to: TO_NUMBER, from: FROM_NUMBER, text: MESSAGE })); ``` ### Standalone The SDK can be used standalone from the main [Vonage Server SDK for Node.js](https://github.com/vonage/vonage-node-sdk) if you only need to use the Messages API. All you need to do is `require('@vonage/messages')`, and use the returned object to create your own client. ```js const {Auth} = require('@vonage/auth'); const {Messages} = require('@vonage/messages'); const messagesClient = new Messages(new Auth({ apiKey: API_KEY, apiSecret: API_SECRET, applicationId: APP_ID, privateKey: PRIVATE_KEY_PATH, }), options); ``` ## Promises Most methods that interact with the Vonage API uses Promises. You can either resolve these yourself, or use `await` to wait for a response. ```js const resp = await messagesClient.send(new SMS({ to: TO_NUMBER, from: FROM_NUMBER, text: MESSAGE })); messagesClient.send(new SMS({ to: TO_NUMBER, from: FROM_NUMBER, text: MESSAGE, })) .then(resp => console.log(resp)) .catch(err => console.error(err)); ``` ## Testing Run: ```bash npm run test ``` ## Channels The Vonage Messages API supports several different communication channels, and from time to time will add new channels. Each channel follows our normal product development cycle and therefore different channels within the overall API may have different release statuses at a certain point in time. Channels available for general use will be listed as having 'General Availability'. Channels which are currently part of a Beta program will be listed as 'Beta'. This table details the current release status of each channel implemented in this SDK: | Channel | API Release Status | |---------------------|:--------------------:| | SMS | General Availability | | MMS | General Availability | | RCS | Beta | | Facebook Messenger | General Availability | | WhatsApp | General Availability | | WhatsApp (reaction) | Beta | | Viber | General Availability | [signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=node-server-sdk [license]: _media/LICENSE.txt ## Other ### Channels Defined in: [messages/lib/enums/Channels.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Channels.ts#L1) #### Enumeration Members | Enumeration Member | Value | Defined in | | ------ | ------ | ------ | | `MESSENGER` | `"messenger"` | [messages/lib/enums/Channels.ts:2](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Channels.ts#L2) | | `MMS` | `"mms"` | [messages/lib/enums/Channels.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Channels.ts#L3) | | `RCS` | `"rcs"` | [messages/lib/enums/Channels.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Channels.ts#L7) | | `SMS` | `"sms"` | [messages/lib/enums/Channels.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Channels.ts#L4) | | `VIBER` | `"viber_service"` | [messages/lib/enums/Channels.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Channels.ts#L6) | | `WHATSAPP` | `"whatsapp"` | [messages/lib/enums/Channels.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Channels.ts#L5) | *** ### MessengerCategory Defined in: [messages/lib/enums/Messenger/MessengerCategory.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerCategory.ts#L6) Enum representing categories for Facebook Messenger messages. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `MESSAGE_TAG` | `"message_tag"` | Represents a message tag message category. | [messages/lib/enums/Messenger/MessengerCategory.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerCategory.ts#L20) | | `RESPONSE` | `"response"` | Represents a response message category. | [messages/lib/enums/Messenger/MessengerCategory.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerCategory.ts#L10) | | `UPDATE` | `"update"` | Represents an update message category. | [messages/lib/enums/Messenger/MessengerCategory.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerCategory.ts#L15) | *** ### MessengerTags Defined in: [messages/lib/enums/Messenger/MessengerTags.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerTags.ts#L8) Enum representing message tags for Facebook Messenger messages. These tags are used to categorize the purpose and relevance of the message. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `ACCOUNT_UPDATE` | `"ACCOUNT_UPDATE"` | Represents an account update message tag. | [messages/lib/enums/Messenger/MessengerTags.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerTags.ts#L22) | | `APPOINTMENT_UPDATE` | `"APPOINTMENT_UPDATE"` | Represents an appointment update message tag. | [messages/lib/enums/Messenger/MessengerTags.ts:47](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerTags.ts#L47) | | `CONFIRMED_EVENT_UPDATE` | `"CONFIRMED_EVENT_UPDATE"` | Represents a confirmed event update message tag. | [messages/lib/enums/Messenger/MessengerTags.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerTags.ts#L12) | | `FEATURE_FUNCTIONALITY_UPDATE` | `"FEATURE_FUNCTIONALITY_UPDATE"` | Represents a feature functionality update message tag. | [messages/lib/enums/Messenger/MessengerTags.ts:62](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerTags.ts#L62) | | `GAME_EVENT` | `"GAME_EVENT"` | Represents a game event message tag. | [messages/lib/enums/Messenger/MessengerTags.ts:52](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerTags.ts#L52) | | `HUMAN_AGENT` | `"HUMAN_AGENT"` | Represents a message tag for human agent communication. | [messages/lib/enums/Messenger/MessengerTags.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerTags.ts#L27) | | `ISSUE_RESOLUTION` | `"ISSUE_RESOLUTION"` | Represents a message tag for issue resolution. | [messages/lib/enums/Messenger/MessengerTags.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerTags.ts#L42) | | `PAYMENT_UPDATE` | `"PAYMENT_UPDATE"` | Represents a payment update message tag. | [messages/lib/enums/Messenger/MessengerTags.ts:72](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerTags.ts#L72) | | `PERSONAL_FINANCE_UPDATE` | `"PERSONAL_FINANCE_UPDATE"` | Represents a personal finance update message tag. | [messages/lib/enums/Messenger/MessengerTags.ts:77](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerTags.ts#L77) | | `POST_PURCHASE_UPDATE` | `"POST_PURCHASE_UPDATE"` | Represents a post-purchase update message tag. | [messages/lib/enums/Messenger/MessengerTags.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerTags.ts#L17) | | `RESERVATION_UPDATE` | `"RESERVATION_UPDATE"` | Represents a reservation update message tag. | [messages/lib/enums/Messenger/MessengerTags.ts:37](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerTags.ts#L37) | | `SHIPPING_UPDATE` | `"SHIPPING_UPDATE"` | Represents a shipping update message tag. | [messages/lib/enums/Messenger/MessengerTags.ts:32](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerTags.ts#L32) | | `TICKET_UPDATE` | `"TICKET_UPDATE"` | Represents a ticket update message tag. | [messages/lib/enums/Messenger/MessengerTags.ts:67](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerTags.ts#L67) | | `TRANSPORTATION_UPDATE` | `"TRANSPORTATION_UPDATE"` | Represents a transportation update message tag. | [messages/lib/enums/Messenger/MessengerTags.ts:57](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Messenger/MessengerTags.ts#L57) | *** ### UpdateMessageStatus Defined in: [messages/lib/enums/UpdateMessageStatus.ts:2](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/UpdateMessageStatus.ts#L2) #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `READ` | `"read"` | The status to set for the message. Setting the status of an inbound WhatsApp message to read indicates to the sender of the message that the message has been read (blue ticks are shown on that message in the WhatsApp UI). The status of an outbound WhatsApp message cannot be updated via this endpoint. | [messages/lib/enums/UpdateMessageStatus.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/UpdateMessageStatus.ts#L10) | | `REVOKED` | `"revoked"` | The status to set for the message. Setting the status of an outbound RCS message to revoked revokes that message if possible. | [messages/lib/enums/UpdateMessageStatus.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/UpdateMessageStatus.ts#L17) | *** ### ViberCategory Defined in: [messages/lib/enums/Viber/ViberCategory.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Viber/ViberCategory.ts#L8) Enum representing message categories for Viber messages. These categories are used to classify the type and purpose of Viber messages. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `PROMOTION` | `"promotion"` | Represents the promotion message category. | [messages/lib/enums/Viber/ViberCategory.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Viber/ViberCategory.ts#L17) | | `TRANSACTION` | `"transaction"` | Represents the transaction message category. | [messages/lib/enums/Viber/ViberCategory.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/Viber/ViberCategory.ts#L12) | *** ### WhatsAppLanguageCode Defined in: [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L8) Enum representing language codes for WhatsApp messages. These language codes are used to specify the language of WhatsApp messages. #### Enumeration Members | Enumeration Member | Value | Defined in | | ------ | ------ | ------ | | `AFRIKAANS` | `"af"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L9) | | `ALBANIAN` | `"sq"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L10) | | `ARABIC` | `"ar"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L11) | | `AZERBAIJANI` | `"az"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L12) | | `BENGALI` | `"bn"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L13) | | `BULGARIAN` | `"bg"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L14) | | `CATALAN` | `"ca"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L15) | | `CHINESE_CHN` | `"zh_CN"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L16) | | `CHINESE_HKG` | `"zh_HK"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L17) | | `CHINESE_TAI` | `"zh_TW"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L18) | | `CROATIAN` | `"hr"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L19) | | `CZECH` | `"cs"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L20) | | `DANISH` | `"da"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L21) | | `DUTCH` | `"nl"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L22) | | `ENGLISH` | `"en"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L23) | | `ENGLISH_UK` | `"en_GB"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L24) | | `ENGLISH_US` | `"en_US"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L25) | | `ESTONIAN` | `"et"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:26](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L26) | | `FILIPINO` | `"fil"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L27) | | `FINNISH` | `"fi"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L28) | | `FRENCH` | `"fr"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:29](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L29) | | `GEORGIAN` | `"ka"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L30) | | `GERMAN` | `"de"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:31](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L31) | | `GREEK` | `"el"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:32](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L32) | | `GUJARATI` | `"gu"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L33) | | `HAUSA` | `"ha"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L34) | | `HEBREW` | `"he"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L35) | | `HINDI` | `"hi"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L36) | | `HUNGARIAN` | `"hu"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:37](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L37) | | `INDONESIAN` | `"id"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L38) | | `IRISH` | `"ga"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:39](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L39) | | `ITALIAN` | `"it"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L40) | | `JAPANESE` | `"ja"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:41](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L41) | | `KANNADA` | `"kn"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L42) | | `KAZAKH` | `"kk"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L43) | | `KINYARWANDA` | `"rw_RW"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:44](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L44) | | `KOREAN` | `"ko"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L45) | | `KYRGYZ_KYRGYZSTAN` | `"ky_KG"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:46](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L46) | | `LAO` | `"lo"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:47](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L47) | | `LATVIAN` | `"lv"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:48](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L48) | | `LITHUANIAN` | `"lt"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:49](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L49) | | `MACEDONIAN` | `"mk"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:50](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L50) | | `MALAY` | `"ms"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:51](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L51) | | `MALAYALAM` | `"ml"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:52](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L52) | | `MARATHI` | `"mr"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:53](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L53) | | `NORWEGIAN` | `"nb"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:54](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L54) | | `PERSIAN` | `"fa"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:55](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L55) | | `POLISH` | `"pl"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:56](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L56) | | `PORTUGUESE_BR` | `"pt_BR"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:57](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L57) | | `PORTUGUESE_POR` | `"pt_PT"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:58](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L58) | | `PUNJABI` | `"pa"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:59](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L59) | | `ROMANIAN` | `"ro"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:60](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L60) | | `RUSSIAN` | `"ru"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:61](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L61) | | `SERBIAN` | `"sr"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:62](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L62) | | `SLOVAK` | `"sk"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:63](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L63) | | `SLOVENIAN` | `"sl"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:64](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L64) | | `SPANISH` | `"es"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:65](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L65) | | `SPANISH_ARG` | `"es_AR"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:66](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L66) | | `SPANISH_MEX` | `"es_MX"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:68](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L68) | | `SPANISH_SPA` | `"es_ES"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:67](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L67) | | `SWAHILI` | `"sw"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:69](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L69) | | `SWEDISH` | `"sv"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:70](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L70) | | `TAMIL` | `"ta"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:71](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L71) | | `TELUGU` | `"te"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:72](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L72) | | `THAI` | `"th"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:73](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L73) | | `TURKISH` | `"tr"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:74](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L74) | | `UKRAINIAN` | `"uk"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:75](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L75) | | `URDU` | `"ur"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:76](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L76) | | `UZBEK` | `"uz"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:77](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L77) | | `VIETNAMESE` | `"vi"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:78](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L78) | | `ZULU` | `"zu"` | [messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts:79](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/enums/WhatsApp/WhatsAppLanguageCodes.ts#L79) | *** ### `abstract` AbstractAudioMessage Defined in: [messages/lib/classes/AbstractAudioMessage.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractAudioMessage.ts#L8) An abstract base class for audio messages. #### Extends - [`AbstractMessage`](#abstractmessage) #### Extended by - [`MMSAudio`](#mmsaudio) - [`MessengerAudio`](#messengeraudio) - [`WhatsAppAudio`](#whatsappaudio) #### Implements - [`MessageParamsAudio`](#messageparamsaudio) #### Constructors ##### Constructor ```ts new AbstractAudioMessage(params): AbstractAudioMessage; ``` Defined in: [messages/lib/classes/AbstractAudioMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractAudioMessage.ts#L20) Constructs a new `AbstractAudioMessage` instance. ###### Parameters ###### params [`MessageParamsAudio`](#messageparamsaudio) The parameters for creating an audio message. ###### Returns [`AbstractAudioMessage`](#abstractaudiomessage) ###### Overrides [`AbstractMessage`](#abstractmessage).[`constructor`](#constructor-3) #### Properties ##### audio ```ts audio: MessageAudioType; ``` Defined in: [messages/lib/classes/AbstractAudioMessage.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractAudioMessage.ts#L13) The audio message content. ###### Implementation of ```ts MessageParamsAudio.audio ``` ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts MessageParamsAudio.clientRef ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`clientRef`](#clientref-3) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts MessageParamsAudio.from ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`from`](#from-3) ##### messageType ```ts messageType: "audio"; ``` Defined in: [messages/lib/classes/AbstractAudioMessage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractAudioMessage.ts#L12) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts MessageParamsAudio.to ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`to`](#to-3) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts MessageParamsAudio.webhookUrl ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookUrl`](#webhookurl-3) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts MessageParamsAudio.webhookVersion ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookVersion`](#webhookversion-3) *** ### `abstract` AbstractFileMessage Defined in: [messages/lib/classes/AbstractFileMessage.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractFileMessage.ts#L7) An abstract base class for file messages. #### Extends - [`AbstractMessage`](#abstractmessage) #### Extended by - [`MessengerFile`](#messengerfile) - [`ViberFile`](#viberfile) - [`WhatsAppFile`](#whatsappfile) - [`RCSFile`](#rcsfile) #### Implements - [`MessageParamsFile`](#messageparamsfile) #### Constructors ##### Constructor ```ts protected new AbstractFileMessage(params): AbstractFileMessage; ``` Defined in: [messages/lib/classes/AbstractFileMessage.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractFileMessage.ts#L19) Constructs a new `AbstractFileMessage` instance. ###### Parameters ###### params [`MessageParamsFile`](#messageparamsfile) The parameters for creating a file message. ###### Returns [`AbstractFileMessage`](#abstractfilemessage) ###### Overrides [`AbstractMessage`](#abstractmessage).[`constructor`](#constructor-3) #### Properties ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts MessageParamsFile.clientRef ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`clientRef`](#clientref-3) ##### file ```ts file: MessageFileType; ``` Defined in: [messages/lib/classes/AbstractFileMessage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractFileMessage.ts#L12) The file attachment content. ###### Implementation of ```ts MessageParamsFile.file ``` ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts MessageParamsFile.from ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`from`](#from-3) ##### messageType ```ts messageType: "file"; ``` Defined in: [messages/lib/classes/AbstractFileMessage.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractFileMessage.ts#L11) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts MessageParamsFile.to ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`to`](#to-3) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts MessageParamsFile.webhookUrl ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookUrl`](#webhookurl-3) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts MessageParamsFile.webhookVersion ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookVersion`](#webhookversion-3) *** ### `abstract` AbstractImageMessage Defined in: [messages/lib/classes/AbstractImageMessage.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractImageMessage.ts#L8) An abstract base class for image messages. #### Extends - [`AbstractMessage`](#abstractmessage) #### Extended by - [`MMSImage`](#mmsimage) - [`MessengerImage`](#messengerimage) - [`ViberImage`](#viberimage) - [`WhatsAppImage`](#whatsappimage) - [`RCSImage`](#rcsimage) #### Implements - [`MessageParamsImage`](#messageparamsimage) #### Constructors ##### Constructor ```ts new AbstractImageMessage(params): AbstractImageMessage; ``` Defined in: [messages/lib/classes/AbstractImageMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractImageMessage.ts#L20) Constructs a new `AbstractImageMessage` instance. ###### Parameters ###### params [`MessageParamsImage`](#messageparamsimage) The parameters for creating an image message. ###### Returns [`AbstractImageMessage`](#abstractimagemessage) ###### Overrides [`AbstractMessage`](#abstractmessage).[`constructor`](#constructor-3) #### Properties ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts MessageParamsImage.clientRef ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`clientRef`](#clientref-3) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts MessageParamsImage.from ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`from`](#from-3) ##### image ```ts image: MessageImageType; ``` Defined in: [messages/lib/classes/AbstractImageMessage.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractImageMessage.ts#L13) The image attachment content. ###### Implementation of ```ts MessageParamsImage.image ``` ##### messageType ```ts messageType: "image"; ``` Defined in: [messages/lib/classes/AbstractImageMessage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractImageMessage.ts#L12) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts MessageParamsImage.to ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`to`](#to-3) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts MessageParamsImage.webhookUrl ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookUrl`](#webhookurl-3) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts MessageParamsImage.webhookVersion ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookVersion`](#webhookversion-3) *** ### `abstract` AbstractMessage Defined in: [messages/lib/classes/AbstractMessage.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L6) An abstract base class for message objects. #### Extended by - [`AbstractAudioMessage`](#abstractaudiomessage) - [`AbstractFileMessage`](#abstractfilemessage) - [`AbstractImageMessage`](#abstractimagemessage) - [`AbstractTextMessage`](#abstracttextmessage) - [`AbstractVcardMessage`](#abstractvcardmessage) - [`AbstractVideoMessage`](#abstractvideomessage) - [`WhatsAppCustom`](#whatsappcustom) - [`WhatsAppSticker`](#whatsappsticker) - [`WhatsAppTemplate`](#whatsapptemplate) - [`WhatsAppReaction`](#whatsappreaction) - [`RCSCustom`](#rcscustom) #### Implements - [`MessageParams`](#messageparams) #### Constructors ##### Constructor ```ts new AbstractMessage(params): AbstractMessage; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L43) Constructs a new `AbstractMessage` instance. ###### Parameters ###### params [`MessageParams`](#messageparams) The parameters for creating a message. ###### Returns [`AbstractMessage`](#abstractmessage) #### Properties ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts MessageParams.clientRef ``` ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts MessageParams.from ``` ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts MessageParams.to ``` ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts MessageParams.webhookUrl ``` ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts MessageParams.webhookVersion ``` *** ### `abstract` AbstractTextMessage Defined in: [messages/lib/classes/AbstractTextMessage.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractTextMessage.ts#L7) An abstract base class for text message objects. #### Extends - [`AbstractMessage`](#abstractmessage) #### Extended by - [`MessengerText`](#messengertext) - [`SMS`](#sms-1) - [`ViberText`](#vibertext) - [`WhatsAppText`](#whatsapptext) - [`RCSText`](#rcstext) #### Implements - [`MessageParamsText`](#messageparamstext) #### Constructors ##### Constructor ```ts new AbstractTextMessage(params): AbstractTextMessage; ``` Defined in: [messages/lib/classes/AbstractTextMessage.ts:26](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractTextMessage.ts#L26) Constructs a new `AbstractTextMessage` instance for text messages. ###### Parameters ###### params [`MessageParamsText`](#messageparamstext) The parameters for creating a text message. ###### Returns [`AbstractTextMessage`](#abstracttextmessage) ###### Overrides [`AbstractMessage`](#abstractmessage).[`constructor`](#constructor-3) #### Properties ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts MessageParamsText.clientRef ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`clientRef`](#clientref-3) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts MessageParamsText.from ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`from`](#from-3) ##### messageType ```ts messageType: "text"; ``` Defined in: [messages/lib/classes/AbstractTextMessage.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractTextMessage.ts#L14) The type of message, which is 'text' for text messages. ##### text ```ts text: string; ``` Defined in: [messages/lib/classes/AbstractTextMessage.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractTextMessage.ts#L19) The text content of the message. ###### Implementation of ```ts MessageParamsText.text ``` ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts MessageParamsText.to ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`to`](#to-3) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts MessageParamsText.webhookUrl ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookUrl`](#webhookurl-3) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts MessageParamsText.webhookVersion ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookVersion`](#webhookversion-3) *** ### `abstract` AbstractVcardMessage Defined in: [messages/lib/classes/AbstractVcardMessage.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVcardMessage.ts#L8) An abstract base class for vCard (contact card) message objects. #### Extends - [`AbstractMessage`](#abstractmessage) #### Extended by - [`MMSVcard`](#mmsvcard) #### Implements - [`MessageParamsVcard`](#messageparamsvcard) #### Constructors ##### Constructor ```ts new AbstractVcardMessage(params): AbstractVcardMessage; ``` Defined in: [messages/lib/classes/AbstractVcardMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVcardMessage.ts#L27) Constructs a new `AbstractVcardMessage` instance for vCard messages. ###### Parameters ###### params [`MessageParamsVcard`](#messageparamsvcard) The parameters for creating a vCard message. ###### Returns [`AbstractVcardMessage`](#abstractvcardmessage) ###### Overrides [`AbstractMessage`](#abstractmessage).[`constructor`](#constructor-3) #### Properties ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts MessageParamsVcard.clientRef ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`clientRef`](#clientref-3) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts MessageParamsVcard.from ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`from`](#from-3) ##### messageType ```ts messageType: "vcard"; ``` Defined in: [messages/lib/classes/AbstractVcardMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVcardMessage.ts#L15) The type of message, which is 'vcard' for vCard messages. ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts MessageParamsVcard.to ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`to`](#to-3) ##### vcard ```ts vcard: MessageVcardType; ``` Defined in: [messages/lib/classes/AbstractVcardMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVcardMessage.ts#L20) The vCard (contact card) content of the message. ###### Implementation of ```ts MessageParamsVcard.vcard ``` ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts MessageParamsVcard.webhookUrl ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookUrl`](#webhookurl-3) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts MessageParamsVcard.webhookVersion ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookVersion`](#webhookversion-3) *** ### `abstract` AbstractVideoMessage Defined in: [messages/lib/classes/AbstractVideoMessage.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVideoMessage.ts#L8) An abstract base class for video message objects. #### Extends - [`AbstractMessage`](#abstractmessage) #### Extended by - [`MMSVideo`](#mmsvideo) - [`MessengerVideo`](#messengervideo) - [`ViberVideo`](#vibervideo) - [`WhatsAppVideo`](#whatsappvideo) - [`RCSVideo`](#rcsvideo) #### Implements - [`MessageParamsVideo`](#messageparamsvideo) #### Constructors ##### Constructor ```ts new AbstractVideoMessage(params): AbstractVideoMessage; ``` Defined in: [messages/lib/classes/AbstractVideoMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVideoMessage.ts#L27) Constructs a new `AbstractVideoMessage` instance for video messages. ###### Parameters ###### params [`MessageParamsVideo`](#messageparamsvideo) The parameters for creating a video message. ###### Returns [`AbstractVideoMessage`](#abstractvideomessage) ###### Overrides [`AbstractMessage`](#abstractmessage).[`constructor`](#constructor-3) #### Properties ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts MessageParamsVideo.clientRef ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`clientRef`](#clientref-3) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts MessageParamsVideo.from ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`from`](#from-3) ##### messageType ```ts messageType: "video"; ``` Defined in: [messages/lib/classes/AbstractVideoMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVideoMessage.ts#L15) The type of message, which is 'video' for video messages. ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts MessageParamsVideo.to ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`to`](#to-3) ##### video ```ts video: MessageVideoType; ``` Defined in: [messages/lib/classes/AbstractVideoMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVideoMessage.ts#L20) The video content of the message. ###### Implementation of ```ts MessageParamsVideo.video ``` ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts MessageParamsVideo.webhookUrl ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookUrl`](#webhookurl-3) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts MessageParamsVideo.webhookVersion ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookVersion`](#webhookversion-3) *** ### Messages Defined in: [messages/lib/messages.ts:48](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/messages.ts#L48) Client class to interact with the Messages API which enables users to manage send messages through various channels programmatically. #### See [https://developer.nexmo.com/en/messages/overview](https://developer.nexmo.com/en/messages/overview) #### Examples Create a standalone Messages client ```ts import { Messages } from '@vonage/messages'; const messagesClient = new Messages({ apiKey: VONAGE_API_KEY, apiSecret: VONAGE_API_SECRET }); ``` Create an Messages client from the Vonage client ```ts import { Vonage } from '@vonage/server-client'; const vonage = new Vonage({ apiKey: VONAGE_API_KEY, apiSecret: VONAGE_API_SECRET }); const messagesClient = vonage.messages; ``` #### Extends - [`Client`](Vonage-Server-Client.md#client) #### Constructors ##### Constructor ```ts new Messages(credentials, options?): Messages; ``` Defined in: server-client/dist/lib/client.d.ts:35 Creates a new instance of the Client. ###### Parameters ###### credentials The authentication credentials or an authentication instance. [`AuthInterface`](Vonage-Auth.md#authinterface) | [`AuthParams`](Vonage-Auth.md#authparams) ###### options? [`ConfigParams`](Vonage-Server-Client.md#configparams) Optional configuration settings for the client. ###### Returns [`Messages`](#messages) ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`constructor`](Vonage-Server-Client.md#client#constructor) #### Methods ##### addAuthenticationToRequest() ```ts addAuthenticationToRequest(request): Promise; ``` Defined in: [messages/lib/messages.ts:58](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/messages.ts#L58) Adds authentication details to the given request based on the configured authentication type. Handle various ways the Messages API handles auth The Messages API handles both JWT (preferred) as well as Basic so we cannot just set a local authType ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request to which authentication should be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> A promise that resolves to the request with added authentication. ###### Overrides [`Client`](Vonage-Server-Client.md#client).[`addAuthenticationToRequest`](Vonage-Server-Client.md#client#addauthenticationtorequest) ##### addBasicAuthToRequest() ```ts protected addBasicAuthToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:71 Adds basic authentication headers to the request. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addBasicAuthToRequest`](Vonage-Server-Client.md#client#addbasicauthtorequest) ##### addJWTToRequest() ```ts protected addJWTToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:64 Adds a JWT to the request. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addJWTToRequest`](Vonage-Server-Client.md#client#addjwttorequest) ##### addQueryKeySecretToRequest() ```ts protected addQueryKeySecretToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:57 Adds API key and secret to the request. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addQueryKeySecretToRequest`](Vonage-Server-Client.md#client#addquerykeysecrettorequest) ##### addQueryKeySecretToRequestBody() ```ts protected addQueryKeySecretToRequestBody(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:50 Adds API key and secret to the request body. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addQueryKeySecretToRequestBody`](Vonage-Server-Client.md#client#addquerykeysecrettorequestbody) ##### getConfig() ```ts getConfig(): ConfigParams; ``` Defined in: server-client/dist/lib/client.d.ts:36 ###### Returns [`ConfigParams`](Vonage-Server-Client.md#configparams) ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`getConfig`](Vonage-Server-Client.md#client#getconfig) ##### parseResponse() ```ts protected parseResponse(request, response): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:168 Parses the response based on its content type. ###### Type Parameters ###### T `T` The expected type of the parsed response data. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options. ###### response `Response` The raw response from the request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The parsed response. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`parseResponse`](Vonage-Server-Client.md#client#parseresponse) ##### prepareBody() ```ts protected prepareBody(request): undefined | string; ``` Defined in: server-client/dist/lib/client.d.ts:158 Prepares the body for the request based on the content type. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options. ###### Returns `undefined` \| `string` - The prepared request body as a string or undefined. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`prepareBody`](Vonage-Server-Client.md#client#preparebody) ##### prepareRequest() ```ts protected prepareRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:151 Prepares the request with necessary headers, authentication, and query parameters. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The initial request options. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The modified request options. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`prepareRequest`](Vonage-Server-Client.md#client#preparerequest) ##### send() ```ts send(message): Promise; ``` Defined in: [messages/lib/messages.ts:83](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/messages.ts#L83) Sends a message using the Vonage API. ###### Parameters ###### message The message to be sent. [`MessengerType`](#messengertype) | [`MessengerParams`](#messengerparams) | [`MessengerAudioParams`](#messengeraudioparams) | [`MessengerFileParams`](#messengerfileparams) | [`MessengerImageParams`](#messengerimageparams) | [`MessengerTextParams`](#messengertextparams) | [`MessengerVideoParams`](#messengervideoparams) | `object` & [`MessengerType`](#messengertype) | `object` & [`MessengerParams`](#messengerparams) | `object` & [`MessengerParams`](#messengerparams) & `object` & [`MessageParams`](#messageparams) | `object` & `object` & [`MessengerParams`](#messengerparams) | `object` & [`MessengerParams`](#messengerparams) & `object` & [`MessageParams`](#messageparams) | `object` & [`MessengerParams`](#messengerparams) & `object` & [`MessageParams`](#messageparams) | `object` & [`MessengerParams`](#messengerparams) & `object` & [`MessageParams`](#messageparams) | [`MMSAudioParams`](#mmsaudioparams) | [`MMSImageParams`](#mmsimageparams) | [`MMSVcardParams`](#mmsvcardparams) | [`MMSVideoParams`](#mmsvideoparams) | `object` & [`MessageParams`](#messageparams) & [`MessageAudioType`](#messageaudiotype) | `object` & [`MessageParams`](#messageparams) & [`MessageImageType`](#messageimagetype) | `object` & `object` & [`MessageParams`](#messageparams) & [`MessageVcardType`](#messagevcardtype) | `object` & [`MessageParams`](#messageparams) & [`MessageVideoType`](#messagevideotype) | [`ViberAction`](#viberaction) | [`ViberService`](#viberservice-3) | [`ViberActionParams`](#viberactionparams) | [`ViberFileParams`](#viberfileparams) | [`ViberImageParams`](#viberimageparams) | [`ViberTextParams`](#vibertextparams) | [`ViberVideoParams`](#vibervideoparams) | `object` & [`ViberAction`](#viberaction) | `object` & [`ViberService`](#viberservice-3) | `object` & `object` & [`ViberService`](#viberservice-3) | `object` & `object` & [`MessageParams`](#messageparams) | `object` & `object` & `object` & [`MessageParams`](#messageparams) | `object` & `object` & `object` & [`MessageParams`](#messageparams) | `object` & `object` & `object` & [`MessageParams`](#messageparams) | [`WhatsAppAudioParams`](#whatsappaudioparams) | [`WhatsAppCustomParams`](#whatsappcustomparams) | [`WhatsAppFileParams`](#whatsappfileparams) | [`WhatsAppImageParams`](#whatsappimageparams) | [`WhatsAppStickerIdType`](#whatsappstickeridtype) | [`WhatsAppStickerParams`](#whatsappstickerparams) | [`WhatsAppTemplateParams`](#whatsapptemplateparams) | [`WhatsAppTextParams`](#whatsapptextparams) | [`WhatsAppVideoParams`](#whatsappvideoparams) | [`WhatsAppReactionParams`](#whatsappreactionparams) | `object` & `object` & `object` & [`MessageParams`](#messageparams) & `object` | `object` & `object` & `object` & [`MessageParams`](#messageparams) | `object` & `object` & `object` & [`MessageParams`](#messageparams) | `object` & `object` & [`MessageParams`](#messageparams) & `object` | `object` & [`WhatsAppStickerIdType`](#whatsappstickeridtype) | `object` & `object` & `object` & [`MessageParams`](#messageparams) | `object` & `object` & `object` & [`MessageParams`](#messageparams) | `object` & `object` & [`MessageParams`](#messageparams) & `object` | `object` & `object` & `object` & [`MessageParams`](#messageparams) & `object` | `object` & `object` & `object` & [`MessageParams`](#messageparams) | [`SMSParams`](#smsparams) | [`SMSChannel`](#smschannel-1) | [`RCSCustomParams`](#rcscustomparams) | [`RCSFileParams`](#rcsfileparams) | [`RCSImageParams`](#rcsimageparams) | [`RCSTextParams`](#rcstextparams) | [`RCSVideoParams`](#rcsvideoparams) | \{ `failover?`: [`AnyChannel`](#anychannel)[]; \} ###### Returns `Promise`\<[`MessageSuccess`](#messagesuccess)\> A promise that resolves to a success response with a message UUID. ##### sendDeleteRequest() ```ts sendDeleteRequest(url): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:78 Sends a DELETE request to the specified URL. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the DELETE request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the DELETE request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendDeleteRequest`](Vonage-Server-Client.md#client#senddeleterequest) ##### sendFormSubmitRequest() ```ts sendFormSubmitRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:86 Sends a POST request with form data to the specified URL. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the POST request. ###### payload? `Record`\<`string`, `undefined` \| `string`\> Optional payload containing form data to send with the POST request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the POST request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendFormSubmitRequest`](Vonage-Server-Client.md#client#sendformsubmitrequest) ##### sendGetRequest() ```ts sendGetRequest(url, queryParams?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:94 Sends a GET request to the specified URL with optional query parameters. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the GET request. ###### queryParams? Optional query parameters to append to the URL. These should be compatible with Node's URLSearchParams. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the GET request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendGetRequest`](Vonage-Server-Client.md#client#sendgetrequest) ##### sendPatchRequest() ```ts sendPatchRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:104 Sends a PATCH request to the specified URL with an optional payload. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the PATCH request. ###### payload? Optional payload to be sent as the body of the PATCH request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the PATCH request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendPatchRequest`](Vonage-Server-Client.md#client#sendpatchrequest) ##### sendPostRequest() ```ts sendPostRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:114 Sends a POST request to the specified URL with an optional payload. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the POST request. ###### payload? Optional payload to be sent as the body of the POST request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the POST request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendPostRequest`](Vonage-Server-Client.md#client#sendpostrequest) ##### sendPutRequest() ```ts sendPutRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:124 Sends a PUT request to the specified URL with an optional payload. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the PUT request. ###### payload? Optional payload to be sent as the body of the PUT request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the PUT request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendPutRequest`](Vonage-Server-Client.md#client#sendputrequest) ##### sendRequest() ```ts sendRequest(request): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:144 Sends a request adding necessary headers, handling authentication, and parsing the response. ###### Type Parameters ###### T `T` ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The options defining the request, including URL, method, headers, and data. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The parsed response from the request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendRequest`](Vonage-Server-Client.md#client#sendrequest) ##### sendRequestWithData() ```ts sendRequestWithData( method, url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:135 Sends a request with JSON-encoded data to the specified URL using the provided HTTP method. ###### Type Parameters ###### T `T` ###### Parameters ###### method The HTTP method to be used for the request (only POST, PATCH, or PUT are acceptable). [`POST`](Vonage-Vetch.md#httpmethods#post) | [`PUT`](Vonage-Vetch.md#httpmethods#put) | [`PATCH`](Vonage-Vetch.md#httpmethods#patch) ###### url `string` The URL endpoint for the request. ###### payload? Optional payload to be sent as the body of the request, JSON-encoded. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendRequestWithData`](Vonage-Server-Client.md#client#sendrequestwithdata) ##### updateMessage() ```ts updateMessage(messageId, status): Promise; ``` Defined in: [messages/lib/messages.ts:132](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/messages.ts#L132) Update the status of outbound and/or inbound messages for certain channels. For example, you can revoke outbound messages or mark inbound messages as read. Please not that this endpoint is region specifc. You will need to set the region when you create the client. ###### Parameters ###### messageId `string` The ID of the message to update. ###### status `string` The status to update the message to. ###### Returns `Promise`\<`true`\> A promise that resolves to true if the message was updated successfully. ###### Example Update the status of a WhatsApp message to "read" ```ts const vonage = new Vonage( { applicationId: myAppId, privateKey: myPrivateKey }, { apiHost: 'https://api-eu.vonage.com' } ) await vonage.messages.updateMessage(messageId, UpdateMessageStatus.READ); ``` #### Properties ##### auth ```ts protected auth: AuthInterface; ``` Defined in: server-client/dist/lib/client.d.ts:24 The authentication instance responsible for generating authentication headers and query parameters. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`auth`](Vonage-Server-Client.md#client#auth) ##### authType? ```ts protected optional authType: AuthenticationType; ``` Defined in: server-client/dist/lib/client.d.ts:20 The type of authentication used for the client's requests. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`authType`](Vonage-Server-Client.md#client#authtype) ##### config ```ts protected config: ConfigParams; ``` Defined in: server-client/dist/lib/client.d.ts:28 Configuration settings for the client, including default hosts for various services and other request settings. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`config`](Vonage-Server-Client.md#client#config) ##### transformers ```ts static transformers: object; ``` Defined in: server-client/dist/lib/client.d.ts:11 Static property containing utility transformers. ###### camelCaseObjectKeys ```ts camelCaseObjectKeys: PartialTransformFunction; ``` ###### kebabCaseObjectKeys ```ts kebabCaseObjectKeys: PartialTransformFunction; ``` ###### omit() ```ts omit: (keys, obj) => TransformedObject; ``` ###### Parameters ###### keys `string`[] ###### obj [`ObjectToTransform`](Vonage-Server-Client.md#objecttotransform) ###### Returns [`TransformedObject`](Vonage-Server-Client.md#transformedobject) ###### snakeCaseObjectKeys ```ts snakeCaseObjectKeys: PartialTransformFunction; ``` ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`transformers`](Vonage-Server-Client.md#client#transformers) *** ### MessengerAudio Defined in: [messages/lib/classes/Messenger/MessengerAudio.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerAudio.ts#L9) Represents an audio message for the Messenger channel. #### Extends - [`AbstractAudioMessage`](#abstractaudiomessage) #### Implements - [`MessengerAudioParams`](#messengeraudioparams) #### Constructors ##### Constructor ```ts new MessengerAudio(params): MessengerAudio; ``` Defined in: [messages/lib/classes/Messenger/MessengerAudio.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerAudio.ts#L43) Sends an audio message to the Facebook Messenger channel. ###### Parameters ###### params [`MessengerAudioParams`](#messengeraudioparams) The parameters for creating a Messenger audio message. ###### Returns [`MessengerAudio`](#messengeraudio) ###### Example ```ts import { MessengerAudio } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new MessengerAudio({ to: TO_NUMBER, from: FROM_NUMBER, audio: { url: 'https://example.com/audio.mp3', }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractAudioMessage`](#abstractaudiomessage).[`constructor`](#constructor) #### Properties ##### audio ```ts audio: MessageAudioType; ``` Defined in: [messages/lib/classes/AbstractAudioMessage.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractAudioMessage.ts#L13) The audio message content. ###### Implementation of ```ts MessengerAudioParams.audio ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`audio`](#audio) ##### channel ```ts channel: "messenger"; ``` Defined in: [messages/lib/classes/Messenger/MessengerAudio.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerAudio.ts#L16) The channel for this message (always 'messenger'). ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts MessengerAudioParams.clientRef ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`clientRef`](#clientref) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts MessengerAudioParams.from ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`from`](#from) ##### messageType ```ts messageType: "audio"; ``` Defined in: [messages/lib/classes/AbstractAudioMessage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractAudioMessage.ts#L12) ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`messageType`](#messagetype) ##### messenger ```ts messenger: MessengerType; ``` Defined in: [messages/lib/classes/Messenger/MessengerAudio.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerAudio.ts#L21) The messenger information for this message. ###### Implementation of ```ts MessengerAudioParams.messenger ``` ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts MessengerAudioParams.to ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`to`](#to) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts MessengerAudioParams.webhookUrl ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`webhookUrl`](#webhookurl) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts MessengerAudioParams.webhookVersion ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`webhookVersion`](#webhookversion) *** ### MessengerFile Defined in: [messages/lib/classes/Messenger/MessengerFile.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerFile.ts#L9) Represents a file message for the Messenger channel. #### Extends - [`AbstractFileMessage`](#abstractfilemessage) #### Implements - [`MessengerFileParams`](#messengerfileparams) - [`MessageParams`](#messageparams) #### Constructors ##### Constructor ```ts new MessengerFile(params): MessengerFile; ``` Defined in: [messages/lib/classes/Messenger/MessengerFile.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerFile.ts#L45) Sends a file message to the Facebook Messenger channel. ###### Parameters ###### params [`MessageParams`](#messageparams) & `object` & [`MessengerParams`](#messengerparams) The parameters for creating a Messenger file message. ###### Returns [`MessengerFile`](#messengerfile) ###### Example ```ts import { MessengerFile } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new MessengerFile({ to: TO_NUMBER, from: FROM_NUMBER, file: { url: 'https://example.com/image.jpg', caption: 'This is an image', }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractFileMessage`](#abstractfilemessage).[`constructor`](#constructor-1) #### Properties ##### channel ```ts channel: "messenger"; ``` Defined in: [messages/lib/classes/Messenger/MessengerFile.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerFile.ts#L16) The channel for this message (always 'messenger'). ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts MessageParams.clientRef ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`clientRef`](#clientref-1) ##### file ```ts file: MessageFileType; ``` Defined in: [messages/lib/classes/AbstractFileMessage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractFileMessage.ts#L12) The file attachment content. ###### Implementation of ```ts MessengerFileParams.file ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`file`](#file) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts MessageParams.from ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`from`](#from-1) ##### messageType ```ts messageType: "file"; ``` Defined in: [messages/lib/classes/AbstractFileMessage.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractFileMessage.ts#L11) ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`messageType`](#messagetype-1) ##### messenger ```ts messenger: MessengerType; ``` Defined in: [messages/lib/classes/Messenger/MessengerFile.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerFile.ts#L21) The messenger information for this message. ###### Implementation of ```ts MessengerFileParams.messenger ``` ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts MessageParams.to ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`to`](#to-1) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts MessageParams.webhookUrl ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`webhookUrl`](#webhookurl-1) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts MessageParams.webhookVersion ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`webhookVersion`](#webhookversion-1) *** ### MessengerImage Defined in: [messages/lib/classes/Messenger/MessengerImage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerImage.ts#L12) Represents an image message for the Messenger channel. This class extends the `AbstractImageMessage` class and implements the `MessengerImageParams` interface. It is used for sending image messages on the Messenger channel. #### Extends - [`AbstractImageMessage`](#abstractimagemessage) #### Implements - [`MessengerImageParams`](#messengerimageparams) #### Constructors ##### Constructor ```ts new MessengerImage(params): MessengerImage; ``` Defined in: [messages/lib/classes/Messenger/MessengerImage.ts:47](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerImage.ts#L47) Send an image message using the Facebook Messenger channel. ###### Parameters ###### params [`MessengerImageParams`](#messengerimageparams) The parameters for the image message. ###### Returns [`MessengerImage`](#messengerimage) ###### Example ```ts import { MessengerImage } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new MessengerImage({ to: TO_NUMBER, from: FROM_NUMBER, image: { url: 'https://example.com/image.jpg', caption: 'This is an image', }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractImageMessage`](#abstractimagemessage).[`constructor`](#constructor-2) #### Properties ##### channel ```ts channel: "messenger"; ``` Defined in: [messages/lib/classes/Messenger/MessengerImage.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerImage.ts#L19) The channel for sending the message, which is set to 'messenger'. ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts MessengerImageParams.clientRef ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`clientRef`](#clientref-2) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts MessengerImageParams.from ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`from`](#from-2) ##### image ```ts image: MessageImageType; ``` Defined in: [messages/lib/classes/AbstractImageMessage.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractImageMessage.ts#L13) The image attachment content. ###### Implementation of ```ts MessengerImageParams.image ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`image`](#image) ##### messageType ```ts messageType: "image"; ``` Defined in: [messages/lib/classes/AbstractImageMessage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractImageMessage.ts#L12) ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`messageType`](#messagetype-2) ##### messenger ```ts messenger: MessengerType; ``` Defined in: [messages/lib/classes/Messenger/MessengerImage.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerImage.ts#L24) Additional Messenger-specific parameters for the image message. ###### Implementation of ```ts MessengerImageParams.messenger ``` ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts MessengerImageParams.to ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`to`](#to-2) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts MessengerImageParams.webhookUrl ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`webhookUrl`](#webhookurl-2) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts MessengerImageParams.webhookVersion ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`webhookVersion`](#webhookversion-2) *** ### MessengerText Defined in: [messages/lib/classes/Messenger/MessengerText.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerText.ts#L9) Represents a text message for the Messenger channel. #### Extends - [`AbstractTextMessage`](#abstracttextmessage) #### Implements - [`MessengerTextParams`](#messengertextparams) #### Constructors ##### Constructor ```ts new MessengerText(params): MessengerText; ``` Defined in: [messages/lib/classes/Messenger/MessengerText.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerText.ts#L42) Sends a text message to the Facebook Messenger channel. ###### Parameters ###### params [`MessengerTextParams`](#messengertextparams) The parameters for creating a Messenger text message. ###### Returns [`MessengerText`](#messengertext) ###### Example ```ts import { MessengerText } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new MessengerText({ to: TO_NUMBER, from: FROM_NUMBER, text: 'Hello world', clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractTextMessage`](#abstracttextmessage).[`constructor`](#constructor-4) #### Properties ##### channel ```ts channel: "messenger"; ``` Defined in: [messages/lib/classes/Messenger/MessengerText.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerText.ts#L16) The channel for this message (always 'messenger'). ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts MessengerTextParams.clientRef ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`clientRef`](#clientref-4) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts MessengerTextParams.from ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`from`](#from-4) ##### messageType ```ts messageType: "text"; ``` Defined in: [messages/lib/classes/AbstractTextMessage.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractTextMessage.ts#L14) The type of message, which is 'text' for text messages. ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`messageType`](#messagetype-3) ##### messenger ```ts messenger: MessengerType; ``` Defined in: [messages/lib/classes/Messenger/MessengerText.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerText.ts#L21) The messenger information for this message. ###### Implementation of ```ts MessengerTextParams.messenger ``` ##### text ```ts text: string; ``` Defined in: [messages/lib/classes/AbstractTextMessage.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractTextMessage.ts#L19) The text content of the message. ###### Implementation of ```ts MessengerTextParams.text ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`text`](#text) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts MessengerTextParams.to ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`to`](#to-4) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts MessengerTextParams.webhookUrl ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`webhookUrl`](#webhookurl-4) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts MessengerTextParams.webhookVersion ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`webhookVersion`](#webhookversion-4) *** ### MessengerVideo Defined in: [messages/lib/classes/Messenger/MessengerVideo.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerVideo.ts#L9) Represents a video message for the Messenger channel. #### Extends - [`AbstractVideoMessage`](#abstractvideomessage) #### Implements - [`MessengerVideoParams`](#messengervideoparams) #### Constructors ##### Constructor ```ts new MessengerVideo(params): MessengerVideo; ``` Defined in: [messages/lib/classes/Messenger/MessengerVideo.ts:44](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerVideo.ts#L44) Send a video message using the Facebook Messenger channel. ###### Parameters ###### params [`MessengerVideoParams`](#messengervideoparams) The parameters for creating a Messenger video message. ###### Returns [`MessengerVideo`](#messengervideo) ###### Example ```ts import { MessagengerVideo } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new MessagengerVideo({ to: TO_NUMBER, from: FROM_NUMBER, video: { url: 'https://example.com/video.mp4', caption: 'This is a video', }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractVideoMessage`](#abstractvideomessage).[`constructor`](#constructor-6) #### Properties ##### channel ```ts channel: "messenger"; ``` Defined in: [messages/lib/classes/Messenger/MessengerVideo.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerVideo.ts#L16) The channel for this message (always 'messenger'). ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts MessengerVideoParams.clientRef ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`clientRef`](#clientref-6) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts MessengerVideoParams.from ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`from`](#from-6) ##### messageType ```ts messageType: "video"; ``` Defined in: [messages/lib/classes/AbstractVideoMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVideoMessage.ts#L15) The type of message, which is 'video' for video messages. ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`messageType`](#messagetype-5) ##### messenger ```ts messenger: MessengerType; ``` Defined in: [messages/lib/classes/Messenger/MessengerVideo.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Messenger/MessengerVideo.ts#L21) The messenger information for this message. ###### Implementation of ```ts MessengerVideoParams.messenger ``` ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts MessengerVideoParams.to ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`to`](#to-6) ##### video ```ts video: MessageVideoType; ``` Defined in: [messages/lib/classes/AbstractVideoMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVideoMessage.ts#L20) The video content of the message. ###### Implementation of ```ts MessengerVideoParams.video ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`video`](#video) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts MessengerVideoParams.webhookUrl ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`webhookUrl`](#webhookurl-6) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts MessengerVideoParams.webhookVersion ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`webhookVersion`](#webhookversion-6) *** ### MMSAudio Defined in: [messages/lib/classes/MMS/MMSAudio.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/MMS/MMSAudio.ts#L9) Represents an audio message for the MMS channel. #### Extends - [`AbstractAudioMessage`](#abstractaudiomessage) #### Implements - [`MessageParamsAudio`](#messageparamsaudio) #### Constructors ##### Constructor ```ts new MMSAudio(params): MMSAudio; ``` Defined in: [messages/lib/classes/MMS/MMSAudio.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/MMS/MMSAudio.ts#L36) Send an MMS audio message. ###### Parameters ###### params [`MessageParamsAudio`](#messageparamsaudio) The parameters for creating the audio message. ###### Returns [`MMSAudio`](#mmsaudio) ###### Example ```ts import { MMSAudio } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new MMSAudio({ to: TO_NUMBER, from: FROM_NUMBER, audio: { url: 'https://example.com/audio.mp3', }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractAudioMessage`](#abstractaudiomessage).[`constructor`](#constructor) #### Properties ##### audio ```ts audio: MessageAudioType; ``` Defined in: [messages/lib/classes/AbstractAudioMessage.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractAudioMessage.ts#L13) The audio message content. ###### Implementation of ```ts MessageParamsAudio.audio ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`audio`](#audio) ##### channel ```ts channel: "mms"; ``` Defined in: [messages/lib/classes/MMS/MMSAudio.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/MMS/MMSAudio.ts#L13) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts MessageParamsAudio.clientRef ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`clientRef`](#clientref) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts MessageParamsAudio.from ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`from`](#from) ##### messageType ```ts messageType: "audio"; ``` Defined in: [messages/lib/classes/AbstractAudioMessage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractAudioMessage.ts#L12) ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`messageType`](#messagetype) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts MessageParamsAudio.to ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`to`](#to) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts MessageParamsAudio.webhookUrl ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`webhookUrl`](#webhookurl) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts MessageParamsAudio.webhookVersion ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`webhookVersion`](#webhookversion) *** ### MMSImage Defined in: [messages/lib/classes/MMS/MMSImage.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/MMS/MMSImage.ts#L9) Represents an image message for the MMS channel. #### Extends - [`AbstractImageMessage`](#abstractimagemessage) #### Implements - [`MessageParamsImage`](#messageparamsimage) #### Constructors ##### Constructor ```ts new MMSImage(params): MMSImage; ``` Defined in: [messages/lib/classes/MMS/MMSImage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/MMS/MMSImage.ts#L36) Send an MMS image message. ###### Parameters ###### params [`MessageParamsImage`](#messageparamsimage) The parameters for creating the image message. ###### Returns [`MMSImage`](#mmsimage) ###### Example ```ts import { MMSImage } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new MMSImage({ to: TO_NUMBER, from: FROM_NUMBER, image: { url: 'https://example.com/image.jpg', caption: 'This is an example image', }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractImageMessage`](#abstractimagemessage).[`constructor`](#constructor-2) #### Properties ##### channel ```ts channel: "mms"; ``` Defined in: [messages/lib/classes/MMS/MMSImage.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/MMS/MMSImage.ts#L13) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts MessageParamsImage.clientRef ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`clientRef`](#clientref-2) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts MessageParamsImage.from ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`from`](#from-2) ##### image ```ts image: MessageImageType; ``` Defined in: [messages/lib/classes/AbstractImageMessage.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractImageMessage.ts#L13) The image attachment content. ###### Implementation of ```ts MessageParamsImage.image ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`image`](#image) ##### messageType ```ts messageType: "image"; ``` Defined in: [messages/lib/classes/AbstractImageMessage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractImageMessage.ts#L12) ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`messageType`](#messagetype-2) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts MessageParamsImage.to ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`to`](#to-2) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts MessageParamsImage.webhookUrl ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`webhookUrl`](#webhookurl-2) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts MessageParamsImage.webhookVersion ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`webhookVersion`](#webhookversion-2) *** ### MMSVcard Defined in: [messages/lib/classes/MMS/MMSVcard.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/MMS/MMSVcard.ts#L9) Represents a vCard message for the MMS channel. #### Extends - [`AbstractVcardMessage`](#abstractvcardmessage) #### Implements - [`MessageParamsVcard`](#messageparamsvcard) #### Constructors ##### Constructor ```ts new MMSVcard(params): MMSVcard; ``` Defined in: [messages/lib/classes/MMS/MMSVcard.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/MMS/MMSVcard.ts#L36) Send an MMS vCard message. ###### Parameters ###### params [`MessageParamsVcard`](#messageparamsvcard) The parameters for creating the vCard message. ###### Returns [`MMSVcard`](#mmsvcard) ###### Example ```ts import { MMSVcard } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new MMSVcard({ to: TO_NUMBER, from: FROM_NUMBER, vcard: { url: 'https://example.com/vcard.vcf', caption: 'Download my contact information', }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractVcardMessage`](#abstractvcardmessage).[`constructor`](#constructor-5) #### Properties ##### channel ```ts channel: "mms"; ``` Defined in: [messages/lib/classes/MMS/MMSVcard.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/MMS/MMSVcard.ts#L13) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts MessageParamsVcard.clientRef ``` ###### Inherited from [`AbstractVcardMessage`](#abstractvcardmessage).[`clientRef`](#clientref-5) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts MessageParamsVcard.from ``` ###### Inherited from [`AbstractVcardMessage`](#abstractvcardmessage).[`from`](#from-5) ##### messageType ```ts messageType: "vcard"; ``` Defined in: [messages/lib/classes/AbstractVcardMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVcardMessage.ts#L15) The type of message, which is 'vcard' for vCard messages. ###### Inherited from [`AbstractVcardMessage`](#abstractvcardmessage).[`messageType`](#messagetype-4) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts MessageParamsVcard.to ``` ###### Inherited from [`AbstractVcardMessage`](#abstractvcardmessage).[`to`](#to-5) ##### vcard ```ts vcard: MessageVcardType; ``` Defined in: [messages/lib/classes/AbstractVcardMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVcardMessage.ts#L20) The vCard (contact card) content of the message. ###### Implementation of ```ts MessageParamsVcard.vcard ``` ###### Inherited from [`AbstractVcardMessage`](#abstractvcardmessage).[`vcard`](#vcard) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts MessageParamsVcard.webhookUrl ``` ###### Inherited from [`AbstractVcardMessage`](#abstractvcardmessage).[`webhookUrl`](#webhookurl-5) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts MessageParamsVcard.webhookVersion ``` ###### Inherited from [`AbstractVcardMessage`](#abstractvcardmessage).[`webhookVersion`](#webhookversion-5) *** ### MMSVideo Defined in: [messages/lib/classes/MMS/MMSVideo.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/MMS/MMSVideo.ts#L9) Represents a video message for the MMS channel. #### Extends - [`AbstractVideoMessage`](#abstractvideomessage) #### Implements - [`MessageParamsVideo`](#messageparamsvideo) #### Constructors ##### Constructor ```ts new MMSVideo(params): MMSVideo; ``` Defined in: [messages/lib/classes/MMS/MMSVideo.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/MMS/MMSVideo.ts#L35) Send an MMS video message. ###### Parameters ###### params [`MessageParamsVideo`](#messageparamsvideo) The parameters for creating the video message. ###### Returns [`MMSVideo`](#mmsvideo) ###### Example ```ts import { MMSVideo } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new MMSVideo({ to: TO_NUMBER, from: FROM_NUMBER, video: { url: 'https://example.com/video.mp4', }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractVideoMessage`](#abstractvideomessage).[`constructor`](#constructor-6) #### Properties ##### channel ```ts channel: "mms"; ``` Defined in: [messages/lib/classes/MMS/MMSVideo.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/MMS/MMSVideo.ts#L13) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts MessageParamsVideo.clientRef ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`clientRef`](#clientref-6) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts MessageParamsVideo.from ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`from`](#from-6) ##### messageType ```ts messageType: "video"; ``` Defined in: [messages/lib/classes/AbstractVideoMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVideoMessage.ts#L15) The type of message, which is 'video' for video messages. ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`messageType`](#messagetype-5) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts MessageParamsVideo.to ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`to`](#to-6) ##### video ```ts video: MessageVideoType; ``` Defined in: [messages/lib/classes/AbstractVideoMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVideoMessage.ts#L20) The video content of the message. ###### Implementation of ```ts MessageParamsVideo.video ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`video`](#video) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts MessageParamsVideo.webhookUrl ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`webhookUrl`](#webhookurl-6) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts MessageParamsVideo.webhookVersion ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`webhookVersion`](#webhookversion-6) *** ### RCSCustom Defined in: [messages/lib/classes/RCS/RCSCustom.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSCustom.ts#L10) Represents a custom message for RCS. #### Extends - [`AbstractMessage`](#abstractmessage) #### Implements - [`RCSCustomParams`](#rcscustomparams) #### Constructors ##### Constructor ```ts new RCSCustom(params): RCSCustom; ``` Defined in: [messages/lib/classes/RCS/RCSCustom.ts:54](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSCustom.ts#L54) Sends a custom message through RCS ###### Parameters ###### params [`RCSCustomParams`](#rcscustomparams) The parameters for creating a RCS custom message. ###### Returns [`RCSCustom`](#rcscustom) ###### Example ```ts import { RCSCustom } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new RCSCustom({ to: TO_NUMBER, from: FROM_NUMBER, custom: { foo: 'bar', } clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractMessage`](#abstractmessage).[`constructor`](#constructor-3) #### Properties ##### channel ```ts channel: RCS = Channels.RCS; ``` Defined in: [messages/lib/classes/RCS/RCSCustom.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSCustom.ts#L14) The channel through which the message will be sent. Always `rcs` ###### Implementation of ```ts RCSCustomParams.channel ``` ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts RCSCustomParams.clientRef ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`clientRef`](#clientref-3) ##### custom ```ts custom: Record; ``` Defined in: [messages/lib/classes/RCS/RCSCustom.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSCustom.ts#L24) A custom payload. The schema of a custom object can vary widely. ###### Implementation of ```ts RCSCustomParams.custom ``` ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts RCSCustomParams.from ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`from`](#from-3) ##### messageType ```ts messageType: string = 'custom'; ``` Defined in: [messages/lib/classes/RCS/RCSCustom.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSCustom.ts#L19) The type of message. For a custom message, this will always be `custom`. ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts RCSCustomParams.to ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`to`](#to-3) ##### ttl? ```ts optional ttl: number; ``` Defined in: [messages/lib/classes/RCS/RCSCustom.ts:32](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSCustom.ts#L32) The duration in seconds the delivery of a message will be attempted. By default Vonage attempts delivery for 72 hours, however the maximum effective value depends on the operator and is typically 24 - 48 hours. We recommend this value should be kept at its default or at least 30 minutes. ###### Implementation of ```ts RCSCustomParams.ttl ``` ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts RCSCustomParams.webhookUrl ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookUrl`](#webhookurl-3) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts RCSCustomParams.webhookVersion ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookVersion`](#webhookversion-3) *** ### RCSFile Defined in: [messages/lib/classes/RCS/RCSFile.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSFile.ts#L10) Represents a file message for the RCS channel. #### Extends - [`AbstractFileMessage`](#abstractfilemessage) #### Implements - [`RCSFileParams`](#rcsfileparams) - [`MessageParams`](#messageparams) #### Constructors ##### Constructor ```ts new RCSFile(params): RCSFile; ``` Defined in: [messages/lib/classes/RCS/RCSFile.ts:48](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSFile.ts#L48) Sends a file message to the RCS channel. ###### Parameters ###### params [`MessageParams`](#messageparams) & `object` & `object` The parameters for creating a RCS file message. ###### Returns [`RCSFile`](#rcsfile) ###### Example ```ts import { RCSFile } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new RCSFile({ to: TO_NUMBER, from: FROM_NUMBER, file: { url: 'https://example.com/image.pdf', }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractFileMessage`](#abstractfilemessage).[`constructor`](#constructor-1) #### Properties ##### channel ```ts channel: RCS = Channels.RCS; ``` Defined in: [messages/lib/classes/RCS/RCSFile.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSFile.ts#L17) The channel for this message (always 'rcs'). ###### Implementation of ```ts RCSFileParams.channel ``` ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts RCSFileParams.clientRef ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`clientRef`](#clientref-1) ##### file ```ts file: MessageFileType; ``` Defined in: [messages/lib/classes/AbstractFileMessage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractFileMessage.ts#L12) The file attachment content. ###### Implementation of ```ts RCSFileParams.file ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`file`](#file) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts RCSFileParams.from ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`from`](#from-1) ##### messageType ```ts messageType: "file"; ``` Defined in: [messages/lib/classes/AbstractFileMessage.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractFileMessage.ts#L11) ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`messageType`](#messagetype-1) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts RCSFileParams.to ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`to`](#to-1) ##### ttl? ```ts optional ttl: number; ``` Defined in: [messages/lib/classes/RCS/RCSFile.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSFile.ts#L25) The duration in seconds the delivery of a message will be attempted. By default Vonage attempts delivery for 72 hours, however the maximum effective value depends on the operator and is typically 24 - 48 hours. We recommend this value should be kept at its default or at least 30 minutes. ###### Implementation of ```ts RCSFileParams.ttl ``` ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts RCSFileParams.webhookUrl ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`webhookUrl`](#webhookurl-1) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts RCSFileParams.webhookVersion ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`webhookVersion`](#webhookversion-1) *** ### RCSImage Defined in: [messages/lib/classes/RCS/RCSImage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSImage.ts#L10) Represents an image message for the RCS channel. #### Extends - [`AbstractImageMessage`](#abstractimagemessage) #### Implements - [`RCSImageParams`](#rcsimageparams) #### Constructors ##### Constructor ```ts new RCSImage(params): RCSImage; ``` Defined in: [messages/lib/classes/RCS/RCSImage.ts:44](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSImage.ts#L44) Send an RCS image message. ###### Parameters ###### params [`RCSImageParams`](#rcsimageparams) The parameters for creating the image message. ###### Returns [`RCSImage`](#rcsimage) ###### Example ```ts import { RCSImage } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new RCSImage({ to: TO_NUMBER, from: FROM_NUMBER, image: { url: 'https://example.com/image.jpg', }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractImageMessage`](#abstractimagemessage).[`constructor`](#constructor-2) #### Properties ##### channel ```ts channel: RCS = Channels.RCS; ``` Defined in: [messages/lib/classes/RCS/RCSImage.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSImage.ts#L14) The channel through which the message will be sent. Always `rcs` ###### Implementation of ```ts RCSImageParams.channel ``` ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts RCSImageParams.clientRef ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`clientRef`](#clientref-2) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts RCSImageParams.from ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`from`](#from-2) ##### image ```ts image: MessageImageType; ``` Defined in: [messages/lib/classes/AbstractImageMessage.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractImageMessage.ts#L13) The image attachment content. ###### Implementation of ```ts RCSImageParams.image ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`image`](#image) ##### messageType ```ts messageType: "image"; ``` Defined in: [messages/lib/classes/AbstractImageMessage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractImageMessage.ts#L12) ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`messageType`](#messagetype-2) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts RCSImageParams.to ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`to`](#to-2) ##### ttl? ```ts optional ttl: number; ``` Defined in: [messages/lib/classes/RCS/RCSImage.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSImage.ts#L22) The duration in seconds the delivery of a message will be attempted. By default Vonage attempts delivery for 72 hours, however the maximum effective value depends on the operator and is typically 24 - 48 hours. We recommend this value should be kept at its default or at least 30 minutes. ###### Implementation of ```ts RCSImageParams.ttl ``` ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts RCSImageParams.webhookUrl ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`webhookUrl`](#webhookurl-2) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts RCSImageParams.webhookVersion ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`webhookVersion`](#webhookversion-2) *** ### RCSText Defined in: [messages/lib/classes/RCS/RCSText.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSText.ts#L10) Represents a text message for the RCS channel. #### Extends - [`AbstractTextMessage`](#abstracttextmessage) #### Implements - [`RCSTextParams`](#rcstextparams) #### Constructors ##### Constructor ```ts new RCSText(params): RCSText; ``` Defined in: [messages/lib/classes/RCS/RCSText.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSText.ts#L43) Sends a text message through the RCS channel. ###### Parameters ###### params [`RCSTextParams`](#rcstextparams) The parameters for creating a RCS text message. ###### Returns [`RCSText`](#rcstext) ###### Example ```ts import { RCSText } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new RCSText({ to: TO_NUMBER, from: FROM_NUMBER, text: 'Hello world', clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractTextMessage`](#abstracttextmessage).[`constructor`](#constructor-4) #### Properties ##### channel ```ts channel: RCS = Channels.RCS; ``` Defined in: [messages/lib/classes/RCS/RCSText.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSText.ts#L14) The channel for this message (always 'rcs'). ###### Implementation of ```ts RCSTextParams.channel ``` ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts RCSTextParams.clientRef ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`clientRef`](#clientref-4) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts RCSTextParams.from ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`from`](#from-4) ##### messageType ```ts messageType: "text"; ``` Defined in: [messages/lib/classes/AbstractTextMessage.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractTextMessage.ts#L14) The type of message, which is 'text' for text messages. ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`messageType`](#messagetype-3) ##### text ```ts text: string; ``` Defined in: [messages/lib/classes/AbstractTextMessage.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractTextMessage.ts#L19) The text content of the message. ###### Implementation of ```ts RCSTextParams.text ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`text`](#text) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts RCSTextParams.to ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`to`](#to-4) ##### ttl? ```ts optional ttl: number; ``` Defined in: [messages/lib/classes/RCS/RCSText.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSText.ts#L22) The duration in seconds the delivery of a message will be attempted. By default Vonage attempts delivery for 72 hours, however the maximum effective value depends on the operator and is typically 24 - 48 hours. We recommend this value should be kept at its default or at least 30 minutes. ###### Implementation of ```ts RCSTextParams.ttl ``` ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts RCSTextParams.webhookUrl ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`webhookUrl`](#webhookurl-4) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts RCSTextParams.webhookVersion ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`webhookVersion`](#webhookversion-4) *** ### RCSVideo Defined in: [messages/lib/classes/RCS/RCSVideo.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSVideo.ts#L10) Represents an video message for the RCS channel. #### Extends - [`AbstractVideoMessage`](#abstractvideomessage) #### Implements - [`RCSVideoParams`](#rcsvideoparams) #### Constructors ##### Constructor ```ts new RCSVideo(params): RCSVideo; ``` Defined in: [messages/lib/classes/RCS/RCSVideo.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSVideo.ts#L45) Send an RCS video message. ###### Parameters ###### params [`RCSVideoParams`](#rcsvideoparams) The parameters for creating the video message. ###### Returns [`RCSVideo`](#rcsvideo) ###### Example ```ts import { RCSVideo } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new RCSVideo({ to: TO_NUMBER, from: FROM_NUMBER, audio: { url: 'https://example.com/video.mp4', }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractVideoMessage`](#abstractvideomessage).[`constructor`](#constructor-6) #### Properties ##### channel ```ts channel: RCS; ``` Defined in: [messages/lib/classes/RCS/RCSVideo.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSVideo.ts#L14) The channel through which the message will be sent. Always `rcs` ###### Implementation of ```ts RCSVideoParams.channel ``` ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts RCSVideoParams.clientRef ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`clientRef`](#clientref-6) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts RCSVideoParams.from ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`from`](#from-6) ##### messageType ```ts messageType: "video"; ``` Defined in: [messages/lib/classes/AbstractVideoMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVideoMessage.ts#L15) The type of message, which is 'video' for video messages. ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`messageType`](#messagetype-5) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts RCSVideoParams.to ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`to`](#to-6) ##### ttl? ```ts optional ttl: number; ``` Defined in: [messages/lib/classes/RCS/RCSVideo.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/RCS/RCSVideo.ts#L22) The duration in seconds the delivery of a message will be attempted. By default Vonage attempts delivery for 72 hours, however the maximum effective value depends on the operator and is typically 24 - 48 hours. We recommend this value should be kept at its default or at least 30 minutes. ###### Implementation of ```ts RCSVideoParams.ttl ``` ##### video ```ts video: MessageVideoType; ``` Defined in: [messages/lib/classes/AbstractVideoMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVideoMessage.ts#L20) The video content of the message. ###### Implementation of ```ts RCSVideoParams.video ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`video`](#video) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts RCSVideoParams.webhookUrl ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`webhookUrl`](#webhookurl-6) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts RCSVideoParams.webhookVersion ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`webhookVersion`](#webhookversion-6) *** ### SMS Defined in: [messages/lib/classes/SMS/SMS.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/SMS/SMS.ts#L12) Send a text message using the SMS channel. #### Extends - [`AbstractTextMessage`](#abstracttextmessage) #### Implements - [`SMSParams`](#smsparams) #### Constructors ##### Constructor ```ts new SMS( params, to?, from?, clientRef?): SMS; ``` Defined in: [messages/lib/classes/SMS/SMS.ts:58](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/SMS/SMS.ts#L58) Send an SMS message ###### Parameters ###### params The message parameters or text message. `string` | [`SMSParams`](#smsparams) ###### to? `string` The recipient's phone number. ###### from? `string` The sender's phone number. ###### clientRef? `string` The client reference for the message. ###### Returns [`SMS`](#sms-1) ###### Examples ```ts import { SMS } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new SMS({ to: TO_NUMBER, from: FROM_NUMBER, text: 'Hello world', clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` Send SMS with entity ID and content ID ```ts import { SMS } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new SMS({ to: TO_NUMBER, from: FROM_NUMBER, text: 'Hello world', clientRef: 'my-personal-reference', sms: { entityId: 'MyEntityID', contentId: 'MyContentID' } })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractTextMessage`](#abstracttextmessage).[`constructor`](#constructor-4) #### Properties ##### channel ```ts channel: "sms"; ``` Defined in: [messages/lib/classes/SMS/SMS.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/SMS/SMS.ts#L13) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts SMSParams.clientRef ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`clientRef`](#clientref-4) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts SMSParams.from ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`from`](#from-4) ##### messageType ```ts messageType: "text"; ``` Defined in: [messages/lib/classes/AbstractTextMessage.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractTextMessage.ts#L14) The type of message, which is 'text' for text messages. ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`messageType`](#messagetype-3) ##### sms? ```ts optional sms: SMSExtraParams; ``` Defined in: [messages/lib/classes/SMS/SMS.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/SMS/SMS.ts#L15) ###### Implementation of ```ts SMSParams.sms ``` ##### text ```ts text: string; ``` Defined in: [messages/lib/classes/AbstractTextMessage.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractTextMessage.ts#L19) The text content of the message. ###### Implementation of ```ts SMSParams.text ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`text`](#text) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts SMSParams.to ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`to`](#to-4) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts SMSParams.webhookUrl ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`webhookUrl`](#webhookurl-4) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts SMSParams.webhookVersion ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`webhookVersion`](#webhookversion-4) *** ### ViberFile Defined in: [messages/lib/classes/Viber/ViberFile.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Viber/ViberFile.ts#L9) Represents a file message for the Viber Service channel. #### Extends - [`AbstractFileMessage`](#abstractfilemessage) #### Implements - [`ViberFileParams`](#viberfileparams) #### Constructors ##### Constructor ```ts new ViberFile(params): ViberFile; ``` Defined in: [messages/lib/classes/Viber/ViberFile.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Viber/ViberFile.ts#L38) Send a file message using the Viber Service channel. ###### Parameters ###### params [`ViberFileParams`](#viberfileparams) The parameters for the ViberFile message. ###### Returns [`ViberFile`](#viberfile) ###### Example ```ts import { ViberFile } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new ViberFile({ to: TO_NUMBER, from: FROM_NUMBER, file: { url: 'https://my-host.com/my-file.pdf', }, viberService: { action: { url: 'https://my-host.com/my-path', text: 'My button text', }, }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractFileMessage`](#abstractfilemessage).[`constructor`](#constructor-1) #### Properties ##### channel ```ts channel: "viber_service"; ``` Defined in: [messages/lib/classes/Viber/ViberFile.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Viber/ViberFile.ts#L10) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts ViberFileParams.clientRef ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`clientRef`](#clientref-1) ##### file ```ts file: MessageFileType; ``` Defined in: [messages/lib/classes/AbstractFileMessage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractFileMessage.ts#L12) The file attachment content. ###### Implementation of ```ts ViberFileParams.file ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`file`](#file) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts ViberFileParams.from ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`from`](#from-1) ##### messageType ```ts messageType: "file"; ``` Defined in: [messages/lib/classes/AbstractFileMessage.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractFileMessage.ts#L11) ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`messageType`](#messagetype-1) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts ViberFileParams.to ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`to`](#to-1) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts ViberFileParams.webhookUrl ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`webhookUrl`](#webhookurl-1) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts ViberFileParams.webhookVersion ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`webhookVersion`](#webhookversion-1) *** ### ViberImage Defined in: [messages/lib/classes/Viber/ViberImage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Viber/ViberImage.ts#L10) Represents an image message for the Viber Service channel. #### Extends - [`AbstractImageMessage`](#abstractimagemessage) #### Implements - [`ViberImageParams`](#viberimageparams) #### Constructors ##### Constructor ```ts new ViberImage(params): ViberImage; ``` Defined in: [messages/lib/classes/Viber/ViberImage.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Viber/ViberImage.ts#L43) Send an image message using the Viber Service channel. ###### Parameters ###### params [`ViberImageParams`](#viberimageparams) The parameters for the ViberImage message. ###### Returns [`ViberImage`](#viberimage) ###### Example ```ts import { ViberImage } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new ViberImage({ to: TO_NUMBER, from: FROM_NUMBER, image: { url: 'https://my-host.com/my-image.jpg', }, viberService: { action: { url: 'https://my-host.com/my-path', text: 'My button text', }, }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractImageMessage`](#abstractimagemessage).[`constructor`](#constructor-2) #### Properties ##### channel ```ts channel: "viber_service"; ``` Defined in: [messages/lib/classes/Viber/ViberImage.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Viber/ViberImage.ts#L14) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts ViberImageParams.clientRef ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`clientRef`](#clientref-2) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts ViberImageParams.from ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`from`](#from-2) ##### image ```ts image: MessageImageType; ``` Defined in: [messages/lib/classes/AbstractImageMessage.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractImageMessage.ts#L13) The image attachment content. ###### Implementation of ```ts ViberImageParams.image ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`image`](#image) ##### messageType ```ts messageType: "image"; ``` Defined in: [messages/lib/classes/AbstractImageMessage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractImageMessage.ts#L12) ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`messageType`](#messagetype-2) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts ViberImageParams.to ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`to`](#to-2) ##### viberService ```ts viberService: ViberActionParams; ``` Defined in: [messages/lib/classes/Viber/ViberImage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Viber/ViberImage.ts#L15) The Viber action parameters for sending the image. ###### Implementation of ```ts ViberImageParams.viberService ``` ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts ViberImageParams.webhookUrl ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`webhookUrl`](#webhookurl-2) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts ViberImageParams.webhookVersion ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`webhookVersion`](#webhookversion-2) *** ### ViberText Defined in: [messages/lib/classes/Viber/ViberText.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Viber/ViberText.ts#L10) Represents a text message for the Viber Service channel. #### Extends - [`AbstractTextMessage`](#abstracttextmessage) #### Implements - [`ViberTextParams`](#vibertextparams) #### Constructors ##### Constructor ```ts new ViberText(params): ViberText; ``` Defined in: [messages/lib/classes/Viber/ViberText.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Viber/ViberText.ts#L42) Send a text message using the Viber Service channel. ###### Parameters ###### params [`ViberTextParams`](#vibertextparams) The parameters for the ViberText message. ###### Returns [`ViberText`](#vibertext) ###### Example ```ts import { ViberText } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new ViberText({ to: TO_NUMBER, from: FROM_NUMBER, text: 'Hello world', viberService: { action: { url: 'https://my-host.com/my-path', text: 'My button text', }, }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractTextMessage`](#abstracttextmessage).[`constructor`](#constructor-4) #### Properties ##### channel ```ts channel: "viber_service"; ``` Defined in: [messages/lib/classes/Viber/ViberText.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Viber/ViberText.ts#L14) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts ViberTextParams.clientRef ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`clientRef`](#clientref-4) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts ViberTextParams.from ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`from`](#from-4) ##### messageType ```ts messageType: "text"; ``` Defined in: [messages/lib/classes/AbstractTextMessage.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractTextMessage.ts#L14) The type of message, which is 'text' for text messages. ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`messageType`](#messagetype-3) ##### text ```ts text: string; ``` Defined in: [messages/lib/classes/AbstractTextMessage.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractTextMessage.ts#L19) The text content of the message. ###### Implementation of ```ts ViberTextParams.text ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`text`](#text) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts ViberTextParams.to ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`to`](#to-4) ##### viberService ```ts viberService: ViberActionParams; ``` Defined in: [messages/lib/classes/Viber/ViberText.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Viber/ViberText.ts#L15) The Viber service and action parameters for the message. ###### Implementation of ```ts ViberTextParams.viberService ``` ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts ViberTextParams.webhookUrl ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`webhookUrl`](#webhookurl-4) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts ViberTextParams.webhookVersion ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`webhookVersion`](#webhookversion-4) *** ### ViberVideo Defined in: [messages/lib/classes/Viber/ViberVideo.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Viber/ViberVideo.ts#L9) Represents a video message for the Viber Service channel. #### Extends - [`AbstractVideoMessage`](#abstractvideomessage) #### Implements - [`ViberVideoParams`](#vibervideoparams) #### Constructors ##### Constructor ```ts new ViberVideo(params): ViberVideo; ``` Defined in: [messages/lib/classes/Viber/ViberVideo.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Viber/ViberVideo.ts#L43) Send a video message using the Viber Service channel. ###### Parameters ###### params [`ViberVideoParams`](#vibervideoparams) The parameters for the ViberVideo message. ###### Returns [`ViberVideo`](#vibervideo) ###### Example ```ts import { ViberVideo } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new ViberVideo({ to: TO_NUMBER, from: FROM_NUMBER, text: 'Hello world', video: { url: 'https://my-host.com/my-video.mp4', }, viberService: { action: { url: 'https://my-host.com/my-path', text: 'My button text', }, }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractVideoMessage`](#abstractvideomessage).[`constructor`](#constructor-6) #### Properties ##### channel ```ts channel: "viber_service"; ``` Defined in: [messages/lib/classes/Viber/ViberVideo.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Viber/ViberVideo.ts#L13) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts ViberVideoParams.clientRef ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`clientRef`](#clientref-6) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts ViberVideoParams.from ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`from`](#from-6) ##### messageType ```ts messageType: "video"; ``` Defined in: [messages/lib/classes/AbstractVideoMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVideoMessage.ts#L15) The type of message, which is 'video' for video messages. ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`messageType`](#messagetype-5) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts ViberVideoParams.to ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`to`](#to-6) ##### viberService ```ts viberService: object & object & ViberService; ``` Defined in: [messages/lib/classes/Viber/ViberVideo.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/Viber/ViberVideo.ts#L14) The Viber service, action parameters, and video message details. ###### Type declaration ###### duration ```ts duration: string; ``` The duration of the video in seconds. ###### fileSize ```ts fileSize: string; ``` The file size of the video in MB. ###### Type declaration ###### action ```ts action: ViberAction; ``` The action associated with the Viber message. ###### Implementation of ```ts ViberVideoParams.viberService ``` ##### video ```ts video: MessageVideoType; ``` Defined in: [messages/lib/classes/AbstractVideoMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVideoMessage.ts#L20) The video content of the message. ###### Implementation of ```ts ViberVideoParams.video ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`video`](#video) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts ViberVideoParams.webhookUrl ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`webhookUrl`](#webhookurl-6) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts ViberVideoParams.webhookVersion ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`webhookVersion`](#webhookversion-6) *** ### WhatsAppAudio Defined in: [messages/lib/classes/WhatsApp/WhatsAppAudio.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppAudio.ts#L9) Represents an audio message for WhatsApp. #### Extends - [`AbstractAudioMessage`](#abstractaudiomessage) #### Implements - [`WhatsAppAudioParams`](#whatsappaudioparams) #### Constructors ##### Constructor ```ts new WhatsAppAudio(params): WhatsAppAudio; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppAudio.ts:37](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppAudio.ts#L37) Sends an audio message to a WhatsApp user. ###### Parameters ###### params [`WhatsAppAudioParams`](#whatsappaudioparams) The parameters for creating a WhatsApp audio message. ###### Returns [`WhatsAppAudio`](#whatsappaudio) ###### Example ```ts import { WhatsAppAudio } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new WhatsAppAudio({ to: TO_NUMBER, from: FROM_NUMBER, audio: { url: 'https://example.com/audio.mp3', caption: 'This is an audio message', }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractAudioMessage`](#abstractaudiomessage).[`constructor`](#constructor) #### Properties ##### audio ```ts audio: MessageAudioType; ``` Defined in: [messages/lib/classes/AbstractAudioMessage.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractAudioMessage.ts#L13) The audio message content. ###### Implementation of ```ts WhatsAppAudioParams.audio ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`audio`](#audio) ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppAudio.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppAudio.ts#L13) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts WhatsAppAudioParams.clientRef ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`clientRef`](#clientref) ##### context? ```ts optional context: WhatsAppContext; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppAudio.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppAudio.ts#L15) An optional context used for quoting/replying to a specific meesage in a conversation. When used, the WhatsApp UI will display the new message along with a contextual bubble that displays the quoted/replied to message's content ###### Implementation of ```ts WhatsAppAudioParams.context ``` ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts WhatsAppAudioParams.from ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`from`](#from) ##### messageType ```ts messageType: "audio"; ``` Defined in: [messages/lib/classes/AbstractAudioMessage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractAudioMessage.ts#L12) ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`messageType`](#messagetype) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts WhatsAppAudioParams.to ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`to`](#to) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts WhatsAppAudioParams.webhookUrl ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`webhookUrl`](#webhookurl) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts WhatsAppAudioParams.webhookVersion ``` ###### Inherited from [`AbstractAudioMessage`](#abstractaudiomessage).[`webhookVersion`](#webhookversion) *** ### WhatsAppCustom Defined in: [messages/lib/classes/WhatsApp/WhatsAppCustom.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppCustom.ts#L13) Represents a custom message for WhatsApp. #### Extends - [`AbstractMessage`](#abstractmessage) #### Implements - [`WhatsAppCustomParams`](#whatsappcustomparams) #### Constructors ##### Constructor ```ts new WhatsAppCustom(params): WhatsAppCustom; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppCustom.ts:47](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppCustom.ts#L47) Sends a custom message to a WhatsApp user. ###### Parameters ###### params [`WhatsAppCustomParams`](#whatsappcustomparams) The parameters for creating a WhatsApp custom message. ###### Returns [`WhatsAppCustom`](#whatsappcustom) ###### Example ```ts import { WhatsAppCustom } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new WhatsAppCustom({ to: TO_NUMBER, from: FROM_NUMBER, custom: { type: 'template', template: { namespace: 'your-namespace', name: 'your-template-name', }, } clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractMessage`](#abstractmessage).[`constructor`](#constructor-3) #### Properties ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppCustom.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppCustom.ts#L17) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts WhatsAppCustomParams.clientRef ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`clientRef`](#clientref-3) ##### context? ```ts optional context: WhatsAppContext; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppCustom.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppCustom.ts#L21) An optional context used for quoting/replying to a specific meesage in a conversation. When used, the WhatsApp UI will display the new message along with a contextual bubble that displays the quoted/replied to message's content ###### Implementation of ```ts WhatsAppCustomParams.context ``` ##### custom ```ts custom: WhatsAppCustomType; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppCustom.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppCustom.ts#L19) The custom WhatsApp message type. ###### Implementation of ```ts WhatsAppCustomParams.custom ``` ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts WhatsAppCustomParams.from ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`from`](#from-3) ##### messageType ```ts messageType: "custom"; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppCustom.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppCustom.ts#L18) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts WhatsAppCustomParams.to ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`to`](#to-3) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts WhatsAppCustomParams.webhookUrl ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookUrl`](#webhookurl-3) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts WhatsAppCustomParams.webhookVersion ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookVersion`](#webhookversion-3) *** ### WhatsAppFile Defined in: [messages/lib/classes/WhatsApp/WhatsAppFile.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppFile.ts#L10) Represents a file message for WhatsApp. #### Extends - [`AbstractFileMessage`](#abstractfilemessage) #### Implements - [`WhatsAppFileParams`](#whatsappfileparams) #### Constructors ##### Constructor ```ts new WhatsAppFile(params): WhatsAppFile; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppFile.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppFile.ts#L38) Send a WhatsApp file message. ###### Parameters ###### params [`WhatsAppFileParams`](#whatsappfileparams) The parameters for creating a WhatsApp file message. ###### Returns [`WhatsAppFile`](#whatsappfile) ###### Example ```ts import { WhatsAppFile } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new WhatsAppFile({ to: TO_NUMBER, from: FROM_NUMBER, file: { url: 'https://example.com/image.jpg', }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractFileMessage`](#abstractfilemessage).[`constructor`](#constructor-1) #### Properties ##### channel ```ts channel: Channels = Channels.WHATSAPP; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppFile.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppFile.ts#L14) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts WhatsAppFileParams.clientRef ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`clientRef`](#clientref-1) ##### context? ```ts optional context: WhatsAppContext; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppFile.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppFile.ts#L16) An optional context used for quoting/replying to a specific meesage in a conversation. When used, the WhatsApp UI will display the new message along with a contextual bubble that displays the quoted/replied to message's content ###### Implementation of ```ts WhatsAppFileParams.context ``` ##### file ```ts file: MessageFileType; ``` Defined in: [messages/lib/classes/AbstractFileMessage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractFileMessage.ts#L12) The file attachment content. ###### Implementation of ```ts WhatsAppFileParams.file ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`file`](#file) ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts WhatsAppFileParams.from ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`from`](#from-1) ##### messageType ```ts messageType: "file"; ``` Defined in: [messages/lib/classes/AbstractFileMessage.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractFileMessage.ts#L11) ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`messageType`](#messagetype-1) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts WhatsAppFileParams.to ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`to`](#to-1) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts WhatsAppFileParams.webhookUrl ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`webhookUrl`](#webhookurl-1) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts WhatsAppFileParams.webhookVersion ``` ###### Inherited from [`AbstractFileMessage`](#abstractfilemessage).[`webhookVersion`](#webhookversion-1) *** ### WhatsAppImage Defined in: [messages/lib/classes/WhatsApp/WhatsAppImage.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppImage.ts#L9) Represents an image message for WhatsApp. #### Extends - [`AbstractImageMessage`](#abstractimagemessage) #### Implements - [`WhatsAppImageParams`](#whatsappimageparams) #### Constructors ##### Constructor ```ts new WhatsAppImage(params): WhatsAppImage; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppImage.ts:37](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppImage.ts#L37) Sends an image message to a WhatsApp user. ###### Parameters ###### params [`WhatsAppImageParams`](#whatsappimageparams) The parameters for creating a WhatsApp image message. ###### Returns [`WhatsAppImage`](#whatsappimage) ###### Example ```ts import { WhatsAppImage } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new WhatsAppImage({ to: TO_NUMBER, from: FROM_NUMBER, image: { url: 'https://example.com/image.jpg', caption: 'This is an image message', }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractImageMessage`](#abstractimagemessage).[`constructor`](#constructor-2) #### Properties ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppImage.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppImage.ts#L13) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts WhatsAppImageParams.clientRef ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`clientRef`](#clientref-2) ##### context? ```ts optional context: WhatsAppContext; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppImage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppImage.ts#L15) An optional context used for quoting/replying to a specific meesage in a conversation. When used, the WhatsApp UI will display the new message along with a contextual bubble that displays the quoted/replied to message's content ###### Implementation of ```ts WhatsAppImageParams.context ``` ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts WhatsAppImageParams.from ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`from`](#from-2) ##### image ```ts image: MessageImageType; ``` Defined in: [messages/lib/classes/AbstractImageMessage.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractImageMessage.ts#L13) The image attachment content. ###### Implementation of ```ts WhatsAppImageParams.image ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`image`](#image) ##### messageType ```ts messageType: "image"; ``` Defined in: [messages/lib/classes/AbstractImageMessage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractImageMessage.ts#L12) ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`messageType`](#messagetype-2) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts WhatsAppImageParams.to ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`to`](#to-2) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts WhatsAppImageParams.webhookUrl ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`webhookUrl`](#webhookurl-2) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts WhatsAppImageParams.webhookVersion ``` ###### Inherited from [`AbstractImageMessage`](#abstractimagemessage).[`webhookVersion`](#webhookversion-2) *** ### WhatsAppReaction Defined in: [messages/lib/classes/WhatsApp/WhatsAppReaction.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppReaction.ts#L13) Represents a reaction message for WhatsApp. #### Extends - [`AbstractMessage`](#abstractmessage) #### Implements - [`WhatsAppReactionParams`](#whatsappreactionparams) #### Constructors ##### Constructor ```ts new WhatsAppReaction(params): WhatsAppReaction; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppReaction.ts:62](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppReaction.ts#L62) Sends a reaction message to a WhatsApp user. ###### Parameters ###### params [`WhatsAppReactionParams`](#whatsappreactionparams) The parameters for creating a WhatsApp reaction message. ###### Returns [`WhatsAppReaction`](#whatsappreaction) ###### Examples Send a reaction ```ts import { WhatsAppReaction } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new WhatsAppReaction({ to: TO_NUMBER, from: FROM_NUMBER, reaction: { action: 'react', emoji: '😍', } clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` Remove reaction ```ts import { WhatsAppReaction } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new WhatsAppReaction({ to: TO_NUMBER, from: FROM_NUMBER, reaction: { action: 'unreact', } clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractMessage`](#abstractmessage).[`constructor`](#constructor-3) #### Properties ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppReaction.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppReaction.ts#L17) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts WhatsAppReactionParams.clientRef ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`clientRef`](#clientref-3) ##### context? ```ts optional context: WhatsAppContext; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppReaction.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppReaction.ts#L21) An optional context used for quoting/replying to a specific meesage in a conversation. When used, the WhatsApp UI will display the new message along with a contextual bubble that displays the quoted/replied to message's content ###### Implementation of ```ts WhatsAppReactionParams.context ``` ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts WhatsAppReactionParams.from ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`from`](#from-3) ##### messageType ```ts messageType: "reaction"; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppReaction.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppReaction.ts#L18) ##### reaction ```ts reaction: WhatsAppReactionType; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppReaction.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppReaction.ts#L19) ###### Implementation of ```ts WhatsAppReactionParams.reaction ``` ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts WhatsAppReactionParams.to ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`to`](#to-3) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts WhatsAppReactionParams.webhookUrl ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookUrl`](#webhookurl-3) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts WhatsAppReactionParams.webhookVersion ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookVersion`](#webhookversion-3) *** ### WhatsAppSticker Defined in: [messages/lib/classes/WhatsApp/WhatsAppSticker.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppSticker.ts#L14) Represents a sticker message for WhatsApp. #### Extends - [`AbstractMessage`](#abstractmessage) #### Implements - [`WhatsAppStickerParams`](#whatsappstickerparams) #### Constructors ##### Constructor ```ts new WhatsAppSticker(params): WhatsAppSticker; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppSticker.ts:62](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppSticker.ts#L62) Send a sticker message to a WhatsApp user. ###### Parameters ###### params [`WhatsAppStickerParams`](#whatsappstickerparams) The parameters for creating a WhatsApp sticker message. ###### Returns [`WhatsAppSticker`](#whatsappsticker) ###### Examples Send a sticker message with a sticker ID: ```ts import { WhatsAppSticker } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new WhatsAppSticker({ to: TO_NUMBER, from: FROM_NUMBER, sticker: { id: '0-0', }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` Send a sticker message with a sticker URL: ```ts import { WhatsAppSticker } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new WhatsAppSticker({ to: TO_NUMBER, from: FROM_NUMBER, sticker: { url: 'https://example.com/sticker.png', }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractMessage`](#abstractmessage).[`constructor`](#constructor-3) #### Properties ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppSticker.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppSticker.ts#L18) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts WhatsAppStickerParams.clientRef ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`clientRef`](#clientref-3) ##### context? ```ts optional context: WhatsAppContext; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppSticker.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppSticker.ts#L22) An optional context used for quoting/replying to a specific meesage in a conversation. When used, the WhatsApp UI will display the new message along with a contextual bubble that displays the quoted/replied to message's content ###### Implementation of ```ts WhatsAppStickerParams.context ``` ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts WhatsAppStickerParams.from ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`from`](#from-3) ##### messageType ```ts messageType: "sticker"; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppSticker.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppSticker.ts#L19) ##### sticker ```ts sticker: | WhatsAppStickerIdType | WhatsAppStickerUrlType; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppSticker.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppSticker.ts#L20) The sticker to be sent, which can be either a sticker ID or a sticker URL. ###### Implementation of ```ts WhatsAppStickerParams.sticker ``` ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts WhatsAppStickerParams.to ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`to`](#to-3) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts WhatsAppStickerParams.webhookUrl ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookUrl`](#webhookurl-3) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts WhatsAppStickerParams.webhookVersion ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookVersion`](#webhookversion-3) *** ### WhatsAppTemplate Defined in: [messages/lib/classes/WhatsApp/WhatsAppTemplate.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppTemplate.ts#L14) Represents a template message for WhatsApp. #### Extends - [`AbstractMessage`](#abstractmessage) #### Implements - [`WhatsAppTemplateParams`](#whatsapptemplateparams) #### Constructors ##### Constructor ```ts new WhatsAppTemplate(params): WhatsAppTemplate; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppTemplate.ts:54](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppTemplate.ts#L54) Send a template message to a WhatsApp user. ###### Parameters ###### params [`WhatsAppTemplateParams`](#whatsapptemplateparams) The parameters for creating a WhatsApp template message. ###### Returns [`WhatsAppTemplate`](#whatsapptemplate) ###### Example ```ts import { WhatsAppTemplate, WhatsAppLanguageCode } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new WhatsAppTemplate({ to: TO_NUMBER, from: FROM_NUMBER, whatsapp: { policy: 'deterministic', locale: WhatsAppLanguageCode.EN, }, template: { name: 'your-template-name', parameters: [ 'foo', 'bar', ], }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractMessage`](#abstractmessage).[`constructor`](#constructor-3) #### Properties ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppTemplate.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppTemplate.ts#L18) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts WhatsAppTemplateParams.clientRef ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`clientRef`](#clientref-3) ##### context? ```ts optional context: WhatsAppContext; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppTemplate.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppTemplate.ts#L23) An optional context used for quoting/replying to a specific meesage in a conversation. When used, the WhatsApp UI will display the new message along with a contextual bubble that displays the quoted/replied to message's content ###### Implementation of ```ts WhatsAppTemplateParams.context ``` ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts WhatsAppTemplateParams.from ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`from`](#from-3) ##### messageType ```ts messageType: "template"; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppTemplate.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppTemplate.ts#L19) ##### template ```ts template: WhatsAppTemplateType; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppTemplate.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppTemplate.ts#L21) The WhatsApp template to be sent. ###### Implementation of ```ts WhatsAppTemplateParams.template ``` ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts WhatsAppTemplateParams.to ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`to`](#to-3) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts WhatsAppTemplateParams.webhookUrl ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookUrl`](#webhookurl-3) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts WhatsAppTemplateParams.webhookVersion ``` ###### Inherited from [`AbstractMessage`](#abstractmessage).[`webhookVersion`](#webhookversion-3) ##### whatsapp ```ts whatsapp: WhatsAppPolicyType; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppTemplate.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppTemplate.ts#L20) WhatsApp policy type for the template message. ###### Implementation of ```ts WhatsAppTemplateParams.whatsapp ``` *** ### WhatsAppText Defined in: [messages/lib/classes/WhatsApp/WhatsAppText.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppText.ts#L9) Represents a text message for WhatsApp. #### Extends - [`AbstractTextMessage`](#abstracttextmessage) #### Implements - [`WhatsAppTextParams`](#whatsapptextparams) #### Constructors ##### Constructor ```ts new WhatsAppText(params): WhatsAppText; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppText.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppText.ts#L34) Send a WhatsApp text message. ###### Parameters ###### params [`WhatsAppTextParams`](#whatsapptextparams) The parameters for creating a WhatsApp text message. ###### Returns [`WhatsAppText`](#whatsapptext) ###### Example ```ts import { WhatsAppText } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new WhatsAppText({ to: TO_NUMBER, from: FROM_NUMBER, text: 'Hello world', clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractTextMessage`](#abstracttextmessage).[`constructor`](#constructor-4) #### Properties ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppText.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppText.ts#L13) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts WhatsAppTextParams.clientRef ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`clientRef`](#clientref-4) ##### context? ```ts optional context: WhatsAppContext; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppText.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppText.ts#L15) An optional context used for quoting/replying to a specific meesage in a conversation. When used, the WhatsApp UI will display the new message along with a contextual bubble that displays the quoted/replied to message's content ###### Implementation of ```ts WhatsAppTextParams.context ``` ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts WhatsAppTextParams.from ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`from`](#from-4) ##### messageType ```ts messageType: "text"; ``` Defined in: [messages/lib/classes/AbstractTextMessage.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractTextMessage.ts#L14) The type of message, which is 'text' for text messages. ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`messageType`](#messagetype-3) ##### text ```ts text: string; ``` Defined in: [messages/lib/classes/AbstractTextMessage.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractTextMessage.ts#L19) The text content of the message. ###### Implementation of ```ts WhatsAppTextParams.text ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`text`](#text) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts WhatsAppTextParams.to ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`to`](#to-4) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts WhatsAppTextParams.webhookUrl ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`webhookUrl`](#webhookurl-4) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts WhatsAppTextParams.webhookVersion ``` ###### Inherited from [`AbstractTextMessage`](#abstracttextmessage).[`webhookVersion`](#webhookversion-4) *** ### WhatsAppVideo Defined in: [messages/lib/classes/WhatsApp/WhatsAppVideo.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppVideo.ts#L9) Represents a video message for WhatsApp. #### Extends - [`AbstractVideoMessage`](#abstractvideomessage) #### Implements - [`WhatsAppVideoParams`](#whatsappvideoparams) #### Constructors ##### Constructor ```ts new WhatsAppVideo(params): WhatsAppVideo; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppVideo.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppVideo.ts#L38) Sends a video message to a WhatsApp user. ###### Parameters ###### params [`WhatsAppVideoParams`](#whatsappvideoparams) The parameters for creating a WhatsApp video message. ###### Returns [`WhatsAppVideo`](#whatsappvideo) ###### Example ```ts import { WhatsAppVideo } from '@vonage/messages'; const { messageUUID } = await messagesClient.send(new WhatsAppVideo({ to: TO_NUMBER, from: FROM_NUMBER, video: { url: 'https://example.com/video.mp4', caption: 'This is a video message', }, clientRef: 'my-personal-reference', })); console.log(`Message sent successfully with UUID ${messageUUID}`); ``` ###### Overrides [`AbstractVideoMessage`](#abstractvideomessage).[`constructor`](#constructor-6) #### Properties ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppVideo.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppVideo.ts#L13) ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L20) An optional client reference for the message. ###### Implementation of ```ts WhatsAppVideoParams.clientRef ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`clientRef`](#clientref-6) ##### context? ```ts optional context: WhatsAppContext; ``` Defined in: [messages/lib/classes/WhatsApp/WhatsAppVideo.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/WhatsApp/WhatsAppVideo.ts#L15) An optional context used for quoting/replying to a specific meesage in a conversation. When used, the WhatsApp UI will display the new message along with a contextual bubble that displays the quoted/replied to message's content ###### Implementation of ```ts WhatsAppVideoParams.context ``` ##### from ```ts from: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L15) The sender of the message. ###### Implementation of ```ts WhatsAppVideoParams.from ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`from`](#from-6) ##### messageType ```ts messageType: "video"; ``` Defined in: [messages/lib/classes/AbstractVideoMessage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVideoMessage.ts#L15) The type of message, which is 'video' for video messages. ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`messageType`](#messagetype-5) ##### to ```ts to: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L10) The recipient of the message. ###### Implementation of ```ts WhatsAppVideoParams.to ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`to`](#to-6) ##### video ```ts video: MessageVideoType; ``` Defined in: [messages/lib/classes/AbstractVideoMessage.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractVideoMessage.ts#L20) The video content of the message. ###### Implementation of ```ts WhatsAppVideoParams.video ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`video`](#video) ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L27) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ###### Implementation of ```ts WhatsAppVideoParams.webhookUrl ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`webhookUrl`](#webhookurl-6) ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/classes/AbstractMessage.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/classes/AbstractMessage.ts#L36) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. ###### Implementation of ```ts WhatsAppVideoParams.webhookVersion ``` ###### Inherited from [`AbstractVideoMessage`](#abstractvideomessage).[`webhookVersion`](#webhookversion-6) *** ### AnyChannel ```ts type AnyChannel = | AnyMessengerChannel | AnyMMSChannel | AnyViberChannel | AnyWhatsAppChannel | SMSChannel | AnyRCSChannel; ``` Defined in: [messages/lib/types/Channels/index.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/index.ts#L19) Represents a union type that can be any of the specific channel message parameters or configurations, including Messenger, MMS, Viber, WhatsApp, or SMS. *** ### AnyMessengerChannel ```ts type AnyMessengerChannel = object & AnyMessengerParams; ``` Defined in: [messages/lib/types/Channels/Messenger/index.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Messenger/index.ts#L38) Represents a union type that includes the 'channel' property set to 'messenger' along with any of the Messenger-specific message parameters or MessengerType. #### Type declaration ##### channel ```ts channel: MESSENGER; ``` The channel through which the message will be sent, which is 'messenger' for Messenger. *** ### AnyMMSChannel ```ts type AnyMMSChannel = object & AnyMMSParams; ``` Defined in: [messages/lib/types/Channels/MMS/index.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/MMS/index.ts#L30) Represents a union type that includes the 'channel' property set to 'mms' along with any of the MMS-specific message parameters. #### Type declaration ##### channel ```ts channel: MMS; ``` The channel through which the message will be sent, which is 'mms' for MMS. *** ### AnyRCSChannel ```ts type AnyRCSChannel = | RCSCustomParams | RCSFileParams | RCSImageParams | RCSTextParams | RCSVideoParams; ``` Defined in: [messages/lib/types/Channels/RCS/index.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/RCS/index.ts#L13) *** ### AnyViberChannel ```ts type AnyViberChannel = object & AnyViberParams; ``` Defined in: [messages/lib/types/Channels/Viber/index.ts:39](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Viber/index.ts#L39) Represents a union type that includes the 'channel' property set to 'viber' along with any of the Viber-specific message parameters or configurations. #### Type declaration ##### channel ```ts channel: VIBER; ``` The channel through which the message will be sent, which is 'viber' for Viber. *** ### AnyWhatsAppChannel ```ts type AnyWhatsAppChannel = object & AnyWhatsAppParams; ``` Defined in: [messages/lib/types/Channels/WhatsApp/index.ts:56](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/index.ts#L56) Represents a union type that includes the 'channel' property set to 'whatsapp_service' along with any of the WhatsApp-specific message parameters or configurations. #### Type declaration ##### channel ```ts channel: WHATSAPP; ``` The channel through which the message will be sent, which is 'whatsapp' for WhatsApp. *** ### MessageAudioType ```ts type MessageAudioType = object; ``` Defined in: [messages/lib/types/MessageAudioType.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageAudioType.ts#L4) Represents an audio message type. #### Properties ##### url ```ts url: string; ``` Defined in: [messages/lib/types/MessageAudioType.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageAudioType.ts#L8) The URL of the audio attachment. *** ### MessageFileType ```ts type MessageFileType = object; ``` Defined in: [messages/lib/types/MessageFileType.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageFileType.ts#L4) Represents a file message type. #### Properties ##### url ```ts url: string; ``` Defined in: [messages/lib/types/MessageFileType.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageFileType.ts#L8) The URL of the file attachment. *** ### MessageImageType ```ts type MessageImageType = object; ``` Defined in: [messages/lib/types/MessageImageType.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageImageType.ts#L4) Represents an image message type. #### Properties ##### url ```ts url: string; ``` Defined in: [messages/lib/types/MessageImageType.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageImageType.ts#L8) The URL of the image attachment. *** ### MessageParams ```ts type MessageParams = object; ``` Defined in: [messages/lib/types/MessageParams.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageParams.ts#L4) Represents the parameters for a message. #### Properties ##### clientRef? ```ts optional clientRef: string; ``` Defined in: [messages/lib/types/MessageParams.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageParams.ts#L19) Client reference of up to 100 characters. The reference will be present in every message status. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/MessageParams.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageParams.ts#L13) The ID of the message sender. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/MessageParams.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageParams.ts#L8) The ID of the message recipient. ##### webhookUrl? ```ts optional webhookUrl: string; ``` Defined in: [messages/lib/types/MessageParams.ts:26](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageParams.ts#L26) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ##### webhookVersion? ```ts optional webhookVersion: "v0.1" | "v1"; ``` Defined in: [messages/lib/types/MessageParams.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageParams.ts#L35) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. *** ### MessageParamsAudio ```ts type MessageParamsAudio = object & MessageParams; ``` Defined in: [messages/lib/types/MessageParamsAudio.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageParamsAudio.ts#L7) Represents the parameters for a message with audio. #### Type declaration ##### audio ```ts audio: MessageAudioType; ``` The audio message content. *** ### MessageParamsFile ```ts type MessageParamsFile = object & MessageParams; ``` Defined in: [messages/lib/types/MessageParamsFile.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageParamsFile.ts#L7) Represents the parameters for a message with a file attachment. #### Type declaration ##### file ```ts file: MessageFileType; ``` The file attachment content. *** ### MessageParamsImage ```ts type MessageParamsImage = object & MessageParams; ``` Defined in: [messages/lib/types/MessageParamsImage.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageParamsImage.ts#L7) Represents the parameters for a message with an image attachment. #### Type declaration ##### image ```ts image: MessageImageType; ``` The image attachment content. ##### ttl? ```ts optional ttl: number; ``` The amount of time in seconds the message will live for *** ### MessageParamsText ```ts type MessageParamsText = object & MessageParams; ``` Defined in: [messages/lib/types/MessageParamsText.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageParamsText.ts#L6) Represents the parameters for a text message. #### Type declaration ##### text ```ts text: string; ``` The text content of the message. *** ### MessageParamsVcard ```ts type MessageParamsVcard = MessageVcardParams & MessageParams; ``` Defined in: [messages/lib/types/MessageParamsVcard.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageParamsVcard.ts#L7) Represents the parameters for a message containing a vCard. *** ### MessageParamsVideo ```ts type MessageParamsVideo = object & MessageParams; ``` Defined in: [messages/lib/types/MessageParamsVideo.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageParamsVideo.ts#L7) Represents the parameters for a message containing a video. #### Type declaration ##### video ```ts video: MessageVideoType; ``` The video information to be included in the message. *** ### MessageSuccess ```ts type MessageSuccess = object; ``` Defined in: [messages/lib/types/MessageSuccess.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageSuccess.ts#L1) #### Properties ##### messageUUID ```ts messageUUID: string; ``` Defined in: [messages/lib/types/MessageSuccess.ts:2](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageSuccess.ts#L2) *** ### MessageSuccessResponse ```ts type MessageSuccessResponse = object; ``` Defined in: [messages/lib/types/Responses/MessageSuccessResponse.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Responses/MessageSuccessResponse.ts#L12) Represents a successful response received when sending a message. This type includes a `message_uuid` field, which is a unique identifier for the sent message. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase` #### Properties ##### message\_uuid ```ts message_uuid: string; ``` Defined in: [messages/lib/types/Responses/MessageSuccessResponse.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Responses/MessageSuccessResponse.ts#L14) A unique identifier for the sent message. *** ### MessageVcardParams ```ts type MessageVcardParams = object; ``` Defined in: [messages/lib/types/MessageVcardType.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageVcardType.ts#L16) Represents a vCard message type. #### Properties ##### vcard ```ts vcard: MessageVcardType; ``` Defined in: [messages/lib/types/MessageVcardType.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageVcardType.ts#L17) *** ### MessageVcardType ```ts type MessageVcardType = object; ``` Defined in: [messages/lib/types/MessageVcardType.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageVcardType.ts#L1) #### Properties ##### caption? ```ts optional caption: string; ``` Defined in: [messages/lib/types/MessageVcardType.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageVcardType.ts#L10) Additional text to accompany the vCard. ##### url ```ts url: string; ``` Defined in: [messages/lib/types/MessageVcardType.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageVcardType.ts#L5) The URL of the vCard attachment. *** ### MessageVideoType ```ts type MessageVideoType = object; ``` Defined in: [messages/lib/types/MessageVideoType.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageVideoType.ts#L4) Represents a video message type. #### Properties ##### url ```ts url: string; ``` Defined in: [messages/lib/types/MessageVideoType.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/MessageVideoType.ts#L8) The URL of the video attachment. *** ### MessageWithFailover ```ts type MessageWithFailover = | { failover?: AnyChannel[]; } | AnyChannel; ``` Defined in: [messages/lib/types/Channels/index.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/index.ts#L27) *** ### RCSCustomParams ```ts type RCSCustomParams = MessageParams & object; ``` Defined in: [messages/lib/types/Channels/RCS/RCSCustomParams.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/RCS/RCSCustomParams.ts#L7) Represents the parameters for sending a custom message using RCS. #### Type declaration ##### channel? ```ts optional channel: RCS; ``` The channel to send to. You must provide `rcs` in this field. ##### custom ```ts custom: Record; ``` A custom payload. The schema of a custom object can vary widely. ##### ttl? ```ts optional ttl: number; ``` The duration in seconds the delivery of a message will be attempted. By default Vonage attempts delivery for 72 hours, however the maximum effective value depends on the operator and is typically 24 - 48 hours. We recommend this value should be kept at its default or at least 30 minutes. *** ### RCSFileParams ```ts type RCSFileParams = MessageParamsFile & object; ``` Defined in: [messages/lib/types/Channels/RCS/RCSFileParams.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/RCS/RCSFileParams.ts#L7) Represents the parameters for sending a file message using RCS. #### Type declaration ##### channel? ```ts optional channel: RCS; ``` The channel to send to. You must provide `rcs` in this field. ##### ttl? ```ts optional ttl: number; ``` The duration in seconds the delivery of a message will be attempted. By default Vonage attempts delivery for 72 hours, however the maximum effective value depends on the operator and is typically 24 - 48 hours. We recommend this value should be kept at its default or at least 30 minutes. *** ### RCSImageParams ```ts type RCSImageParams = MessageParamsImage & object; ``` Defined in: [messages/lib/types/Channels/RCS/RCSImageParams.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/RCS/RCSImageParams.ts#L7) Represents the parameters for sending an image message using RCS. #### Type declaration ##### channel? ```ts optional channel: RCS; ``` The channel to send to. You must provide `rcs` in this field. *** ### RCSTextParams ```ts type RCSTextParams = MessageParams & object; ``` Defined in: [messages/lib/types/Channels/RCS/RCSTextParams.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/RCS/RCSTextParams.ts#L7) Represents the parameters for sending a text message using RCS. #### Type declaration ##### channel? ```ts optional channel: RCS; ``` The channel to send to. You must provide `rcs` in this field. ##### text ```ts text: string; ``` The text of the message to send. Limited to 3072 characters, including unicode. ##### ttl? ```ts optional ttl: number; ``` The duration in seconds the delivery of a message will be attempted. By default Vonage attempts delivery for 72 hours, however the maximum effective value depends on the operator and is typically 24 - 48 hours. We recommend this value should be kept at its default or at least 30 minutes. *** ### RCSVideoParams ```ts type RCSVideoParams = MessageParams & object; ``` Defined in: [messages/lib/types/Channels/RCS/RCSVideoParams.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/RCS/RCSVideoParams.ts#L8) Represents the parameters for sending a video message using RCS. #### Type declaration ##### channel? ```ts optional channel: RCS; ``` The channel to send to. You must provide `rcs` in this field. ##### ttl? ```ts optional ttl: number; ``` The duration in seconds the delivery of a message will be attempted. By default Vonage attempts delivery for 72 hours, however the maximum effective value depends on the operator and is typically 24 - 48 hours. We recommend this value should be kept at its default or at least 30 minutes. ##### video ```ts video: MessageVideoType; ``` *** ### SendMessageParams ```ts type SendMessageParams = | AnyMessengerParams | AnyViberParams | AnyWhatsAppParams | AnyMMSParams | SMSParams; ``` Defined in: [messages/lib/types/SendMessageParams.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/SendMessageParams.ts#L15) Represents parameters for sending various types of messages. This union type can be used to send messages across different platforms like Messenger, MMS, SMS, Viber, WhatsApp, etc. Use the corresponding Type for the specific message type you want to send. *** ### SMSChannel ```ts type SMSChannel = object & SMSParams; ``` Defined in: [messages/lib/types/Channels/SMSParams.ts:53](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/SMSParams.ts#L53) Represents an SMS channel message, combining the channel type with SMS-specific parameters. This type includes the `channel` field specifying the SMS channel and combines it with the SMS message parameters defined in `SMSParams`. #### Type declaration ##### channel ```ts channel: SMS; ``` ##### sms? ```ts optional sms: SMSExtraParams; ``` ##### ttl? ```ts optional ttl: number; ``` The duration in seconds the delivery of an SMS will be attempted. By default Vonage attempts delivery for 72 hours, however the maximum effective value depends on the operator and is typically 24 - 48 hours. We recommend this value should be kept at its default or at least 30 minutes. *** ### SMSExtraParams ```ts type SMSExtraParams = object; ``` Defined in: [messages/lib/types/Channels/SMSParams.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/SMSParams.ts#L18) #### Properties ##### contentId? ```ts optional contentId: string; ``` Defined in: [messages/lib/types/Channels/SMSParams.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/SMSParams.ts#L34) A string parameter that satisfies regulatory requirements when sending an SMS to specific countries. ##### encodingType? ```ts optional encodingType: "unicode" | "text" | "auto"; ``` Defined in: [messages/lib/types/Channels/SMSParams.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/SMSParams.ts#L28) The encoding type to use for the message. If set to either text or unicode the specified type will be used. If set to auto (the default), the Messages API will automatically set the type based on the content of text; i.e. if unicode characters are detected in text, then the message will be encoded as unicode, and otherwise as text. ###### Link https://api.support.vonage.com/hc/en-us/sections/200622473-Country-Specific-Features-and-Restrictions ##### entityId? ```ts optional entityId: string; ``` Defined in: [messages/lib/types/Channels/SMSParams.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/SMSParams.ts#L42) A string parameter that satisfies regulatory requirements when sending an SMS to specific countries. ###### Link https://api.support.vonage.com/hc/en-us/sections/200622473-Country-Specific-Features-and-Restrictions *** ### UpdateMessageRequest ```ts type UpdateMessageRequest = object; ``` Defined in: [messages/lib/types/Requests/UpdateMessageRequest.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/UpdateMessageRequest.ts#L6) The request object for the Messages.update method. #### Properties ##### status ```ts status: UpdateMessageStatus | string; ``` Defined in: [messages/lib/types/Requests/UpdateMessageRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/UpdateMessageRequest.ts#L15) The status to set for the message. This value depends on the type of message that was sent. The SDK has no way to know which value will be correct for the message. Confirm with the API specification or the API documentation which value is correct for the message [https://developer.vonage.com/en/api/messages#UpdateMessage](https://developer.vonage.com/en/api/messages#UpdateMessage). *** ### WhatsAppContext ```ts type WhatsAppContext = object; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppParams.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppParams.ts#L3) #### Properties ##### messageUUID ```ts messageUUID: string; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppParams.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppParams.ts#L7) The UUID of the message being replied to/quoted. *** ### WhatsAppCustomType ```ts type WhatsAppCustomType = object; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppCustomType.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppCustomType.ts#L6) Represents a custom WhatsApp message type with arbitrary properties. #### Index Signature ```ts [key: string]: unknown ``` *** ### WhatsAppFileParams ```ts type WhatsAppFileParams = object & WhatsAppParams; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppFileParams.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppFileParams.ts#L9) Represents a WhatsApp file message type. #### Type declaration ##### file ```ts file: object & MessageFileType; ``` The file attachment content. ###### Type declaration ###### caption? ```ts optional caption: string; ``` An optional caption to accompany the file. ###### name? ```ts optional name: string; ``` Optional parameter that specifies the name of the file being sent. If not included, the value for caption will be used as the file name. If neither name or caption are included, the file name will be parsed from the url. *** ### WhatsAppParams ```ts type WhatsAppParams = object & MessageParams; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppParams.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppParams.ts#L10) #### Type declaration ##### context? ```ts optional context: WhatsAppContext; ``` An optional context used for quoting/replying to a specific meesage in a conversation. When used, the WhatsApp UI will display the new message along with a contextual bubble that displays the quoted/replied to message's content *** ### WhatsAppPolicyType ```ts type WhatsAppPolicyType = object; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppPolicyType.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppPolicyType.ts#L8) Represents a WhatsApp policy type for deterministic messaging. #### Properties ##### locale ```ts locale: WhatsAppLanguageCode; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppPolicyType.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppPolicyType.ts#L17) The locale for the WhatsApp message, following the WhatsApp language code. ##### policy ```ts policy: "deterministic"; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppPolicyType.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppPolicyType.ts#L12) The policy type, which is set to 'deterministic'. *** ### WhatsAppReactionRequest ```ts type WhatsAppReactionRequest = object; ``` Defined in: [messages/lib/types/Requests/WhatsAppReactionRequest.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppReactionRequest.ts#L1) #### Properties ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/types/Requests/WhatsAppReactionRequest.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppReactionRequest.ts#L25) The channel through which the message will be sent, which is 'whatsapp' for WhatsApp. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppReactionRequest.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppReactionRequest.ts#L5) A client-defined reference string for the message. ##### context ```ts context: object; ``` Defined in: [messages/lib/types/Requests/WhatsAppReactionRequest.ts:50](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppReactionRequest.ts#L50) A context used for quoting/replying/reacting to a specific message in a conversation. When used for quoting or replying, the WhatsApp UI will display the new message along with a contextual bubble that displays the quoted/replied to message's content. When used for reacting the WhatsApp UI will display the reaction emoji below the reacted to message. ###### message\_uuid ```ts message_uuid: string; ``` The UUID of the message being quoted/replied/reacted to. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppReactionRequest.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppReactionRequest.ts#L20) The sender's identifier. ##### message\_type ```ts message_type: "reaction"; ``` Defined in: [messages/lib/types/Requests/WhatsAppReactionRequest.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppReactionRequest.ts#L10) The type of the message, which is 'reaction' for a text message. ##### reaction ```ts reaction: object; ``` Defined in: [messages/lib/types/Requests/WhatsAppReactionRequest.ts:57](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppReactionRequest.ts#L57) ###### action ```ts action: "react" | "unreact"; ``` The action taken. ###### emoji? ```ts optional emoji: string; ``` The emoji used as a reaction. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppReactionRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppReactionRequest.ts#L15) The recipient's identifier. ##### webhook\_url ```ts webhook_url: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppReactionRequest.ts:41](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppReactionRequest.ts#L41) Specifies the URL to which Status Webhook messages will be sent for this particular message. Over-rides account-level and application-level Status Webhook url settings on a per-message basis. ##### webhook\_version ```ts webhook_version: "v0.1" | "v1"; ``` Defined in: [messages/lib/types/Requests/WhatsAppReactionRequest.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppReactionRequest.ts#L34) Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format. Over-rides account-level and application-level API version settings on a per-message basis. *** ### WhatsAppReactionType ```ts type WhatsAppReactionType = object; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatAppReactionType.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatAppReactionType.ts#L1) #### Properties ##### action ```ts action: "react" | "unreact"; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatAppReactionType.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatAppReactionType.ts#L5) The action taken. ##### emoji? ```ts optional emoji: string; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatAppReactionType.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatAppReactionType.ts#L10) The emoji used as a reaction. *** ### WhatsAppStickerIdType ```ts type WhatsAppStickerIdType = object; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppStickerIdType.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppStickerIdType.ts#L6) Represents a WhatsApp sticker ID type. #### Properties ##### id ```ts id: string; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppStickerIdType.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppStickerIdType.ts#L10) The ID of the WhatsApp sticker. *** ### WhatsAppStickerUrlType ```ts type WhatsAppStickerUrlType = object; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppStickerUrlType.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppStickerUrlType.ts#L6) Represents a WhatsApp sticker by URL. #### Properties ##### url ```ts url: string; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppStickerUrlType.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppStickerUrlType.ts#L10) The URL of the WhatsApp sticker. *** ### WhatsAppTemplateType ```ts type WhatsAppTemplateType = object; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppTemplateType.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppTemplateType.ts#L6) Represents a WhatsApp template for sending structured template messages. #### Properties ##### name ```ts name: string; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppTemplateType.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppTemplateType.ts#L10) The name of the WhatsApp template. ##### parameters ```ts parameters: string[]; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppTemplateType.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppTemplateType.ts#L15) An array of parameters for the WhatsApp template. ## Parameters ### AnyMessengerParams ```ts type AnyMessengerParams = | MessengerAudioParams | MessengerFileParams | MessengerImageParams | MessengerParams | MessengerTextParams | MessengerType | MessengerVideoParams; ``` Defined in: [messages/lib/types/Channels/Messenger/index.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Messenger/index.ts#L25) Represents a union type that can be any of the Messenger-specific message parameters or MessengerType. *** ### AnyMMSParams ```ts type AnyMMSParams = | MMSAudioParams | MMSImageParams | MMSVcardParams | MMSVideoParams; ``` Defined in: [messages/lib/types/Channels/MMS/index.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/MMS/index.ts#L18) Represents a union type that can be any of the MMS-specific message parameters. *** ### AnyViberParams ```ts type AnyViberParams = | ViberAction | ViberActionParams | ViberFileParams | ViberImageParams | ViberService | ViberTextParams | ViberVideoParams; ``` Defined in: [messages/lib/types/Channels/Viber/index.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Viber/index.ts#L24) Represents a union type that can be any of the Viber-specific message parameters or configurations. *** ### AnyWhatsAppParams ```ts type AnyWhatsAppParams = | WhatsAppAudioParams | WhatsAppCustomParams | WhatsAppFileParams | WhatsAppImageParams | WhatsAppStickerIdType | WhatsAppStickerParams | WhatsAppTemplateParams | WhatsAppTextParams | WhatsAppReactionParams | WhatsAppVideoParams; ``` Defined in: [messages/lib/types/Channels/WhatsApp/index.ts:37](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/index.ts#L37) Represents a union type that can be any of the WhatsApp-specific message parameters or configurations. *** ### MessengerAudioParams ```ts type MessengerAudioParams = MessengerParams & MessageParamsAudio; ``` Defined in: [messages/lib/types/Channels/Messenger/MessengerAudioParams.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Messenger/MessengerAudioParams.ts#L11) Represents parameters for sending an audio message via the Messenger platform. Combines parameters from both MessengerParams and MessageParamsAudio. *** ### MessengerFileParams ```ts type MessengerFileParams = object & MessengerParams; ``` Defined in: [messages/lib/types/Channels/Messenger/MessengerFileParams.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Messenger/MessengerFileParams.ts#L10) Represents parameters for sending a file message via the Messenger platform. #### Type declaration ##### file ```ts file: MessageFileType; ``` *** ### MessengerImageParams ```ts type MessengerImageParams = MessengerParams & MessageParamsImage; ``` Defined in: [messages/lib/types/Channels/Messenger/MessengerImageParams.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Messenger/MessengerImageParams.ts#L11) Represents parameters for sending an image message via the Messenger platform. Combines parameters from both MessengerParams and MessageParamsImage. *** ### MessengerParams ```ts type MessengerParams = object; ``` Defined in: [messages/lib/types/Channels/Messenger/MessengerParams.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Messenger/MessengerParams.ts#L9) Represents parameters specific to the Messenger platform. #### Properties ##### messenger ```ts messenger: MessengerType; ``` Defined in: [messages/lib/types/Channels/Messenger/MessengerParams.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Messenger/MessengerParams.ts#L10) *** ### MessengerTextParams ```ts type MessengerTextParams = MessengerParams & MessageParamsText; ``` Defined in: [messages/lib/types/Channels/Messenger/MessengerTextParams.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Messenger/MessengerTextParams.ts#L10) Represents parameters for sending a text message via the Messenger platform. *** ### MessengerType ```ts type MessengerType = object; ``` Defined in: [messages/lib/types/Channels/Messenger/MessengerType.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Messenger/MessengerType.ts#L9) Represents the type of message to be sent via the Messenger platform. #### Properties ##### category ```ts category: MessengerCategory; ``` Defined in: [messages/lib/types/Channels/Messenger/MessengerType.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Messenger/MessengerType.ts#L13) The category of the Messenger message. ##### tag? ```ts optional tag: string; ``` Defined in: [messages/lib/types/Channels/Messenger/MessengerType.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Messenger/MessengerType.ts#L18) An optional tag describing the type and relevance of the 1:1 communication between your app and the end user. *** ### MessengerVideoParams ```ts type MessengerVideoParams = MessengerParams & MessageParamsVideo; ``` Defined in: [messages/lib/types/Channels/Messenger/MessengerVideoParams.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Messenger/MessengerVideoParams.ts#L10) Represents parameters for sending a video message via the Messenger platform. *** ### MMSAudioParams ```ts type MMSAudioParams = MessageParams & MessageAudioType; ``` Defined in: [messages/lib/types/Channels/MMS/MMSAudioParams.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/MMS/MMSAudioParams.ts#L13) Represents the parameters for sending an audio message on the MMS channel. This type combines the common message parameters from `MessageParams` with audio-specific parameters defined in `MessageAudioType`. It is used when creating an audio message for the MMS channel. *** ### MMSImageParams ```ts type MMSImageParams = MessageParams & MessageImageType; ``` Defined in: [messages/lib/types/Channels/MMS/MMSImageParams.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/MMS/MMSImageParams.ts#L13) Represents the parameters for sending an image message on the MMS channel. This type combines the common message parameters from `MessageParams` with image-specific parameters defined in `MessageImageType`. It is used when creating an image message for the MMS channel. *** ### MMSVcardParams ```ts type MMSVcardParams = object & MessageParams & MessageVcardType; ``` Defined in: [messages/lib/types/Channels/MMS/MMSVcardParams.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/MMS/MMSVcardParams.ts#L13) Represents the parameters for sending a vCard message on the MMS channel. This type combines the common message parameters from `MessageParams` with vCard-specific parameters defined in `MessageVcardType`. It is used when creating a vCard message for the MMS channel. #### Type declaration ##### ttl? ```ts optional ttl: number; ``` The amount of time in seconds the message will live for *** ### MMSVideoParams ```ts type MMSVideoParams = MessageParams & MessageVideoType; ``` Defined in: [messages/lib/types/Channels/MMS/MMSVideoParams.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/MMS/MMSVideoParams.ts#L13) Represents the parameters for sending a video message on the MMS channel. This type combines the common message parameters from `MessageParams` with video-specific parameters defined in `MessageVideoType`. It is used when creating a video message for the MMS channel. *** ### SMSParams ```ts type SMSParams = object & MessageParamsText; ``` Defined in: [messages/lib/types/Channels/SMSParams.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/SMSParams.ts#L16) Represents the parameters for sending an SMS message. This type is an alias for `MessageParamsText` and is used when creating an SMS message. #### Type declaration ##### sms? ```ts optional sms: SMSExtraParams; ``` #### Remarks The purpose of this type is to ensure a consistent interface for SMS message parameters, making it easier to extend or modify the type in the future without impacting existing code that uses it. It is based on the `MessageParamsText` type. *** ### ViberAction ```ts type ViberAction = object; ``` Defined in: [messages/lib/types/Channels/Viber/ViberAction.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Viber/ViberAction.ts#L7) Represents an action associated with a Viber message. #### Properties ##### text ```ts text: string; ``` Defined in: [messages/lib/types/Channels/Viber/ViberAction.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Viber/ViberAction.ts#L16) The text displayed for the action. ##### url ```ts url: string; ``` Defined in: [messages/lib/types/Channels/Viber/ViberAction.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Viber/ViberAction.ts#L11) The URL to be opened when the action is triggered. *** ### ViberActionParams ```ts type ViberActionParams = object & ViberService; ``` Defined in: [messages/lib/types/Channels/Viber/ViberActionParams.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Viber/ViberActionParams.ts#L9) Represents parameters for a Viber action message. #### Type declaration ##### action ```ts action: ViberAction; ``` The action associated with the Viber message. *** ### ViberFileParams ```ts type ViberFileParams = object & MessageParams; ``` Defined in: [messages/lib/types/Channels/Viber/ViberFileParams.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Viber/ViberFileParams.ts#L10) Represents parameters for sending a file via Viber. #### Type declaration ##### file ```ts file: object & MessageFileType; ``` ###### Type declaration ###### name? ```ts optional name: string; ``` The name and extension of the file. *** ### ViberImageParams ```ts type ViberImageParams = object & MessageParamsImage; ``` Defined in: [messages/lib/types/Channels/Viber/ViberImageParams.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Viber/ViberImageParams.ts#L10) Represents parameters for sending an image via Viber. #### Type declaration ##### viberService ```ts viberService: ViberActionParams; ``` The Viber action parameters for sending the image. *** ### ViberService ```ts type ViberService = object; ``` Defined in: [messages/lib/types/Channels/Viber/ViberService.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Viber/ViberService.ts#L10) Represents parameters for a Viber service message. #### Properties ##### action? ```ts optional action: ViberAction; ``` Defined in: [messages/lib/types/Channels/Viber/ViberService.ts:29](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Viber/ViberService.ts#L29) ##### category ```ts category: ViberCategory; ``` Defined in: [messages/lib/types/Channels/Viber/ViberService.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Viber/ViberService.ts#L27) The category of the Viber service message. ##### ttl ```ts ttl: number; ``` Defined in: [messages/lib/types/Channels/Viber/ViberService.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Viber/ViberService.ts#L15) The time-to-live (TTL) of the message to be delivered in seconds. If the message is not delivered within this time, it will be deleted. ##### type ```ts type: string; ``` Defined in: [messages/lib/types/Channels/Viber/ViberService.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Viber/ViberService.ts#L22) The Viber-specific type definition. To use "template," please contact your Vonage Account Manager to set up templates. To find out more, please visit the product page. *** ### ViberTextParams ```ts type ViberTextParams = object & MessageParamsText; ``` Defined in: [messages/lib/types/Channels/Viber/ViberTextParams.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Viber/ViberTextParams.ts#L10) Represents parameters for sending a text message via Viber with action buttons. #### Type declaration ##### text ```ts text: string; ``` The text content of the message. ##### viberService ```ts viberService: ViberActionParams; ``` The Viber service and action parameters for the message. *** ### ViberVideoParams ```ts type ViberVideoParams = object & MessageParamsVideo; ``` Defined in: [messages/lib/types/Channels/Viber/ViberVideoParams.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/Viber/ViberVideoParams.ts#L10) Represents parameters for sending a video message via Viber with action buttons. #### Type declaration ##### viberService ```ts viberService: object & ViberActionParams; ``` The Viber service, action parameters, and video message details. ###### Type declaration ###### duration ```ts duration: string; ``` The duration of the video in seconds. ###### fileSize ```ts fileSize: string; ``` The file size of the video in MB. ##### video ```ts video: object; ``` The details of the video message to be sent. ###### video.caption? ```ts optional video.caption: string; ``` The caption to be displayed with the video. ###### video.thumbUrl? ```ts optional video.thumbUrl: string; ``` The URL of the thumbnail image to be displayed with the video. ###### video.url ```ts video.url: string; ``` The URL of the video attachment. *** ### WhatsAppAudioParams ```ts type WhatsAppAudioParams = object & WhatsAppParams & MessageParamsAudio; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppAudioParams.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppAudioParams.ts#L10) Represents parameters for sending an audio message via WhatsApp. #### Type declaration ##### ttl? ```ts optional ttl: number; ``` The amount of time in seconds the message will live for *** ### WhatsAppCustomParams ```ts type WhatsAppCustomParams = object & WhatsAppParams; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppCustomParams.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppCustomParams.ts#L10) Represents parameters for sending a custom WhatsApp message with a file attachment. #### Type declaration ##### custom ```ts custom: WhatsAppCustomType; ``` The custom WhatsApp message type. *** ### WhatsAppImageParams ```ts type WhatsAppImageParams = WhatsAppParams & MessageParamsImage; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppImageParams.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppImageParams.ts#L10) Represents a WhatsApp image message type. *** ### WhatsAppReactionParams ```ts type WhatsAppReactionParams = object & WhatsAppParams; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppReactionParams.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppReactionParams.ts#L9) Represents WhatsApp reaction message parameters. #### Type declaration ##### reaction ```ts reaction: WhatsAppReactionType; ``` *** ### WhatsAppStickerParams ```ts type WhatsAppStickerParams = object & WhatsAppParams; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppStickerParams.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppStickerParams.ts#L11) Represents WhatsApp sticker parameters for sending stickers in a message. #### Type declaration ##### sticker ```ts sticker: | WhatsAppStickerIdType | WhatsAppStickerUrlType; ``` The sticker to be sent, which can be either a sticker ID or a sticker URL. *** ### WhatsAppTemplateParams ```ts type WhatsAppTemplateParams = object & WhatsAppParams; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppTemplateParams.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppTemplateParams.ts#L11) Represents WhatsApp template message parameters. #### Type declaration ##### template ```ts template: WhatsAppTemplateType; ``` The WhatsApp template to be sent. ##### whatsapp ```ts whatsapp: WhatsAppPolicyType; ``` WhatsApp policy type for the template message. *** ### WhatsAppTextParams ```ts type WhatsAppTextParams = WhatsAppParams & MessageParamsText; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppTextParams.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppTextParams.ts#L10) Represents a text message type for WhatsApp. *** ### WhatsAppVideoParams ```ts type WhatsAppVideoParams = object & WhatsAppParams & MessageParamsVideo; ``` Defined in: [messages/lib/types/Channels/WhatsApp/WhatsAppVideoParams.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Channels/WhatsApp/WhatsAppVideoParams.ts#L10) Represents a video message type for WhatsApp. #### Type declaration ##### ttl? ```ts optional ttl: number; ``` The amount of time in seconds the message will live for ## Requests ### MessengerAudioRequest ```ts type MessengerAudioRequest = object; ``` Defined in: [messages/lib/types/Requests/MessengerAudioRequest.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerAudioRequest.ts#L13) Represents a request to send an audio message via the Messenger channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure request structure before it's transformed into `snake_case` for the API call. #### Properties ##### audio ```ts audio: object; ``` Defined in: [messages/lib/types/Requests/MessengerAudioRequest.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerAudioRequest.ts#L19) The audio content of the message, including the URL of the audio file. ###### url ```ts url: string; ``` The URL of the audio file. ##### channel ```ts channel: "messenger"; ``` Defined in: [messages/lib/types/Requests/MessengerAudioRequest.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerAudioRequest.ts#L28) The channel for sending the message, which is set to 'messenger'. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/MessengerAudioRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerAudioRequest.ts#L15) A client reference string for tracking the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/MessengerAudioRequest.ts:26](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerAudioRequest.ts#L26) The sender of the message. ##### message\_type ```ts message_type: "audio"; ``` Defined in: [messages/lib/types/Requests/MessengerAudioRequest.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerAudioRequest.ts#L17) The message type, which is set to 'audio' for an audio message. ##### messenger ```ts messenger: MessengerType; ``` Defined in: [messages/lib/types/Requests/MessengerAudioRequest.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerAudioRequest.ts#L30) Additional details about the Messenger message type. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/MessengerAudioRequest.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerAudioRequest.ts#L24) The recipient of the message. *** ### MessengerFileRequest ```ts type MessengerFileRequest = object; ``` Defined in: [messages/lib/types/Requests/MessengerFileRequest.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerFileRequest.ts#L13) Represents a request to send a file message via the Messenger channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure request structure before it's transformed into `snake_case` for the API call. #### Properties ##### channel ```ts channel: "messenger"; ``` Defined in: [messages/lib/types/Requests/MessengerFileRequest.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerFileRequest.ts#L28) The channel for sending the message, which is set to 'messenger'. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/MessengerFileRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerFileRequest.ts#L15) A client reference string for tracking the message. ##### file ```ts file: object; ``` Defined in: [messages/lib/types/Requests/MessengerFileRequest.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerFileRequest.ts#L19) The file content of the message, including the URL of the file. ###### url ```ts url: string; ``` The URL of the file. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/MessengerFileRequest.ts:26](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerFileRequest.ts#L26) The sender of the message. ##### message\_type ```ts message_type: "file"; ``` Defined in: [messages/lib/types/Requests/MessengerFileRequest.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerFileRequest.ts#L17) The message type, which is set to 'file' for a file message. ##### messenger ```ts messenger: MessengerType; ``` Defined in: [messages/lib/types/Requests/MessengerFileRequest.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerFileRequest.ts#L30) Additional details about the Messenger message type. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/MessengerFileRequest.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerFileRequest.ts#L24) The recipient of the message. *** ### MessengerImageRequest ```ts type MessengerImageRequest = object; ``` Defined in: [messages/lib/types/Requests/MessengerImageRequest.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerImageRequest.ts#L13) Represents a request to send an image message via the Messenger channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure request structure before it's transformed into `snake_case` for the API call. #### Properties ##### channel ```ts channel: "messenger"; ``` Defined in: [messages/lib/types/Requests/MessengerImageRequest.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerImageRequest.ts#L28) The channel for sending the message, which is set to 'messenger'. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/MessengerImageRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerImageRequest.ts#L15) A client reference string for tracking the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/MessengerImageRequest.ts:26](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerImageRequest.ts#L26) The sender of the message. ##### image ```ts image: object; ``` Defined in: [messages/lib/types/Requests/MessengerImageRequest.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerImageRequest.ts#L19) The image content of the message, including the URL of the image. ###### url ```ts url: string; ``` The URL of the image. ##### message\_type ```ts message_type: "image"; ``` Defined in: [messages/lib/types/Requests/MessengerImageRequest.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerImageRequest.ts#L17) The message type, which is set to 'image' for an image message. ##### messenger ```ts messenger: MessengerType; ``` Defined in: [messages/lib/types/Requests/MessengerImageRequest.ts:31](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerImageRequest.ts#L31) Additional details about the Messenger message type. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/MessengerImageRequest.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerImageRequest.ts#L24) The recipient of the message. *** ### MessengerTextRequest ```ts type MessengerTextRequest = object; ``` Defined in: [messages/lib/types/Requests/MessengerTextRequest.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerTextRequest.ts#L12) Represents a request for sending a text message via the Messenger channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "messenger"; ``` Defined in: [messages/lib/types/Requests/MessengerTextRequest.ts:41](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerTextRequest.ts#L41) The channel through which the message will be sent, which is 'messenger' for Messenger. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/MessengerTextRequest.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerTextRequest.ts#L16) A client-defined reference string for the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/MessengerTextRequest.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerTextRequest.ts#L36) The sender's phone number or identifier. ##### message\_type ```ts message_type: "text"; ``` Defined in: [messages/lib/types/Requests/MessengerTextRequest.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerTextRequest.ts#L21) The type of the message, which is 'text' for a text message. ##### messenger ```ts messenger: MessengerType; ``` Defined in: [messages/lib/types/Requests/MessengerTextRequest.ts:46](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerTextRequest.ts#L46) Additional information specific to the Messenger channel. ##### text ```ts text: string; ``` Defined in: [messages/lib/types/Requests/MessengerTextRequest.ts:26](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerTextRequest.ts#L26) The text content of the message. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/MessengerTextRequest.ts:31](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerTextRequest.ts#L31) The recipient's phone number or identifier. *** ### MessengerVideoRequest ```ts type MessengerVideoRequest = object; ``` Defined in: [messages/lib/types/Requests/MessengerVideoRequest.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerVideoRequest.ts#L13) Represents a request for sending a video message via the Messenger channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "messenger"; ``` Defined in: [messages/lib/types/Requests/MessengerVideoRequest.ts:47](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerVideoRequest.ts#L47) The channel through which the message will be sent, which is 'messenger' for Messenger. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/MessengerVideoRequest.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerVideoRequest.ts#L17) A client-defined reference string for the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/MessengerVideoRequest.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerVideoRequest.ts#L42) The sender's phone number or identifier. ##### message\_type ```ts message_type: "video"; ``` Defined in: [messages/lib/types/Requests/MessengerVideoRequest.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerVideoRequest.ts#L22) The type of the message, which is 'video' for a video message. ##### messenger ```ts messenger: MessengerType; ``` Defined in: [messages/lib/types/Requests/MessengerVideoRequest.ts:52](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerVideoRequest.ts#L52) Additional information specific to the Messenger channel. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/MessengerVideoRequest.ts:37](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerVideoRequest.ts#L37) The recipient's phone number or identifier. ##### video ```ts video: object; ``` Defined in: [messages/lib/types/Requests/MessengerVideoRequest.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MessengerVideoRequest.ts#L27) The video content of the message. ###### url ```ts url: string; ``` The URL of the video to be sent in the message. *** ### MMSAudioRequest ```ts type MMSAudioRequest = object; ``` Defined in: [messages/lib/types/Requests/MMSAudioRequest.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSAudioRequest.ts#L11) Represents a request for sending an audio message via the MMS (Multimedia Messaging Service) channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### audio ```ts audio: object; ``` Defined in: [messages/lib/types/Requests/MMSAudioRequest.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSAudioRequest.ts#L25) The audio content of the message, including the URL of the audio and an optional caption. ###### caption? ```ts optional caption: string; ``` An optional caption or description for the audio message. ###### url ```ts url: string; ``` The URL of the audio file to be sent in the message. ##### channel ```ts channel: "mms"; ``` Defined in: [messages/lib/types/Requests/MMSAudioRequest.ts:50](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSAudioRequest.ts#L50) The channel through which the message will be sent, which is 'mms' for MMS. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/MMSAudioRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSAudioRequest.ts#L15) A client-defined reference string for the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/MMSAudioRequest.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSAudioRequest.ts#L45) The sender's phone number or identifier. ##### message\_type ```ts message_type: "audio"; ``` Defined in: [messages/lib/types/Requests/MMSAudioRequest.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSAudioRequest.ts#L20) The type of the message, which is 'audio' for an audio message. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/MMSAudioRequest.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSAudioRequest.ts#L40) The recipient's phone number or identifier. *** ### MMSImageRequest ```ts type MMSImageRequest = object; ``` Defined in: [messages/lib/types/Requests/MMSImageRequest.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSImageRequest.ts#L11) Represents a request for sending an image message via the MMS (Multimedia Messaging Service) channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "mms"; ``` Defined in: [messages/lib/types/Requests/MMSImageRequest.ts:50](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSImageRequest.ts#L50) The channel through which the message will be sent, which is 'mms' for MMS. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/MMSImageRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSImageRequest.ts#L15) A client-defined reference string for the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/MMSImageRequest.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSImageRequest.ts#L45) The sender's phone number or identifier. ##### image ```ts image: object; ``` Defined in: [messages/lib/types/Requests/MMSImageRequest.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSImageRequest.ts#L25) The image content of the message, including the URL of the image and an optional caption. ###### caption? ```ts optional caption: string; ``` An optional caption or description for the image message. ###### url ```ts url: string; ``` The URL of the image file to be sent in the message. ##### message\_type ```ts message_type: "image"; ``` Defined in: [messages/lib/types/Requests/MMSImageRequest.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSImageRequest.ts#L20) The type of the message, which is 'image' for an image message. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/MMSImageRequest.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSImageRequest.ts#L40) The recipient's phone number or identifier. ##### ttl? ```ts optional ttl: number; ``` Defined in: [messages/lib/types/Requests/MMSImageRequest.ts:55](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSImageRequest.ts#L55) The amount of time in seconds the message will live for *** ### MMSVcardRequest ```ts type MMSVcardRequest = object; ``` Defined in: [messages/lib/types/Requests/MMSVcardRequest.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSVcardRequest.ts#L11) Represents a request for sending a vCard message via the MMS (Multimedia Messaging Service) channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "mms"; ``` Defined in: [messages/lib/types/Requests/MMSVcardRequest.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSVcardRequest.ts#L45) The channel through which the message will be sent, which is 'mms' for MMS. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/MMSVcardRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSVcardRequest.ts#L15) A client-defined reference string for the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/MMSVcardRequest.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSVcardRequest.ts#L40) The sender's phone number or identifier. ##### message\_type ```ts message_type: "vcard"; ``` Defined in: [messages/lib/types/Requests/MMSVcardRequest.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSVcardRequest.ts#L20) The type of the message, which is 'vcard' for a vCard message. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/MMSVcardRequest.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSVcardRequest.ts#L35) The recipient's phone number or identifier. ##### vcard ```ts vcard: object; ``` Defined in: [messages/lib/types/Requests/MMSVcardRequest.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSVcardRequest.ts#L25) The vCard content of the message, including the URL of the vCard file. ###### url ```ts url: string; ``` The URL of the vCard file to be sent in the message. *** ### MMSVideoRequest ```ts type MMSVideoRequest = object; ``` Defined in: [messages/lib/types/Requests/MMSVideoRequest.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSVideoRequest.ts#L11) Represents a request for sending a video message via the MMS (Multimedia Messaging Service) channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "mms"; ``` Defined in: [messages/lib/types/Requests/MMSVideoRequest.ts:50](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSVideoRequest.ts#L50) The channel through which the message will be sent, which is 'mms' for MMS. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/MMSVideoRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSVideoRequest.ts#L15) A client-defined reference string for the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/MMSVideoRequest.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSVideoRequest.ts#L45) The sender's phone number or identifier. ##### message\_type ```ts message_type: "video"; ``` Defined in: [messages/lib/types/Requests/MMSVideoRequest.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSVideoRequest.ts#L20) The type of the message, which is 'video' for a video message. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/MMSVideoRequest.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSVideoRequest.ts#L40) The recipient's phone number or identifier. ##### video ```ts video: object; ``` Defined in: [messages/lib/types/Requests/MMSVideoRequest.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/MMSVideoRequest.ts#L25) The video content of the message, including the URL of the video file and an optional caption. ###### caption? ```ts optional caption: string; ``` An optional caption for the video. ###### url ```ts url: string; ``` The URL of the video file to be sent in the message. *** ### SMSMessageRequest ```ts type SMSMessageRequest = object; ``` Defined in: [messages/lib/types/Requests/SMSMessageRequest.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/SMSMessageRequest.ts#L11) Represents a request for sending a text message via the SMS (Short Message Service) channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "sms"; ``` Defined in: [messages/lib/types/Requests/SMSMessageRequest.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/SMSMessageRequest.ts#L40) The channel through which the message will be sent, which is 'sms' for SMS. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/SMSMessageRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/SMSMessageRequest.ts#L15) A client-defined reference string for the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/SMSMessageRequest.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/SMSMessageRequest.ts#L35) The sender's phone number or identifier. ##### message\_type ```ts message_type: "text"; ``` Defined in: [messages/lib/types/Requests/SMSMessageRequest.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/SMSMessageRequest.ts#L20) The type of the message, which is 'text' for a text message. ##### sms? ```ts optional sms: object; ``` Defined in: [messages/lib/types/Requests/SMSMessageRequest.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/SMSMessageRequest.ts#L42) ###### content\_id? ```ts optional content_id: string; ``` A string parameter that satisfies regulatory requirements when sending an SMS to specific countries. ###### encoding\_type? ```ts optional encoding_type: "unicode" | "text" | "auto"; ``` The encoding type to use for the message. If set to either text or unicode the specified type will be used. If set to auto (the default), the Messages API will automatically set the type based on the content of text; i.e. if unicode characters are detected in text, then the message will be encoded as unicode, and otherwise as text. ###### Link https://api.support.vonage.com/hc/en-us/sections/200622473-Country-Specific-Features-and-Restrictions ###### entity\_id? ```ts optional entity_id: string; ``` A string parameter that satisfies regulatory requirements when sending an SMS to specific countries. ###### Link https://api.support.vonage.com/hc/en-us/sections/200622473-Country-Specific-Features-and-Restrictions ##### text ```ts text: string; ``` Defined in: [messages/lib/types/Requests/SMSMessageRequest.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/SMSMessageRequest.ts#L25) The text content of the message. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/SMSMessageRequest.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/SMSMessageRequest.ts#L30) The recipient's phone number. *** ### ViberFileRequest ```ts type ViberFileRequest = object; ``` Defined in: [messages/lib/types/Requests/ViberFileRequest.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberFileRequest.ts#L13) Represents a request for sending a file message via the Viber Service channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "viber_service"; ``` Defined in: [messages/lib/types/Requests/ViberFileRequest.ts:52](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberFileRequest.ts#L52) The channel through which the message will be sent, which is 'viber_service' for Viber Service. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/ViberFileRequest.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberFileRequest.ts#L17) A client-defined reference string for the message. ##### file ```ts file: object; ``` Defined in: [messages/lib/types/Requests/ViberFileRequest.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberFileRequest.ts#L27) The file content to be sent, including the URL and name. ###### name ```ts name: string; ``` The name of the file. ###### url ```ts url: string; ``` The URL of the file to be sent. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/ViberFileRequest.ts:47](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberFileRequest.ts#L47) The sender's identifier. ##### message\_type ```ts message_type: "file"; ``` Defined in: [messages/lib/types/Requests/ViberFileRequest.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberFileRequest.ts#L22) The type of the message, which is 'file' for a file message. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/ViberFileRequest.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberFileRequest.ts#L42) The recipient's identifier. ##### viber\_service ```ts viber_service: ViberService; ``` Defined in: [messages/lib/types/Requests/ViberFileRequest.ts:57](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberFileRequest.ts#L57) The Viber service configuration. *** ### ViberImageRequest ```ts type ViberImageRequest = object; ``` Defined in: [messages/lib/types/Requests/ViberImageRequest.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberImageRequest.ts#L13) Represents a request for sending an image message via the Viber Service channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "viber_service"; ``` Defined in: [messages/lib/types/Requests/ViberImageRequest.ts:52](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberImageRequest.ts#L52) The channel through which the message will be sent, which is 'viber_service' for Viber Service. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/ViberImageRequest.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberImageRequest.ts#L17) A client-defined reference string for the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/ViberImageRequest.ts:47](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberImageRequest.ts#L47) The sender's identifier. ##### image ```ts image: object; ``` Defined in: [messages/lib/types/Requests/ViberImageRequest.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberImageRequest.ts#L27) The image content to be sent, including the URL and optional caption. ###### caption? ```ts optional caption: string; ``` An optional caption for the image. ###### url ```ts url: string; ``` The URL of the image to be sent. ##### message\_type ```ts message_type: "image"; ``` Defined in: [messages/lib/types/Requests/ViberImageRequest.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberImageRequest.ts#L22) The type of the message, which is 'image' for an image message. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/ViberImageRequest.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberImageRequest.ts#L42) The recipient's identifier. ##### viber\_service ```ts viber_service: ViberService; ``` Defined in: [messages/lib/types/Requests/ViberImageRequest.ts:57](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberImageRequest.ts#L57) The Viber service configuration. *** ### ViberTextRequest ```ts type ViberTextRequest = object; ``` Defined in: [messages/lib/types/Requests/ViberTextRequest.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberTextRequest.ts#L13) Represents a request for sending a text message via the Viber Service channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "viber_service"; ``` Defined in: [messages/lib/types/Requests/ViberTextRequest.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberTextRequest.ts#L42) The channel through which the message will be sent, which is 'viber_service' for Viber Service. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/ViberTextRequest.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberTextRequest.ts#L17) A client-defined reference string for the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/ViberTextRequest.ts:37](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberTextRequest.ts#L37) The sender's identifier. ##### message\_type ```ts message_type: "text"; ``` Defined in: [messages/lib/types/Requests/ViberTextRequest.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberTextRequest.ts#L22) The type of the message, which is 'text' for a text message. ##### text ```ts text: string; ``` Defined in: [messages/lib/types/Requests/ViberTextRequest.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberTextRequest.ts#L27) The text content of the message. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/ViberTextRequest.ts:32](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberTextRequest.ts#L32) The recipient's identifier. ##### viber\_service ```ts viber_service: ViberService; ``` Defined in: [messages/lib/types/Requests/ViberTextRequest.ts:47](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberTextRequest.ts#L47) The Viber service configuration. *** ### ViberVideoRequest ```ts type ViberVideoRequest = object; ``` Defined in: [messages/lib/types/Requests/ViberVideoRequest.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberVideoRequest.ts#L13) Represents a request for sending a video message via the Viber Service channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "viber_service"; ``` Defined in: [messages/lib/types/Requests/ViberVideoRequest.ts:57](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberVideoRequest.ts#L57) The channel through which the message will be sent, which is 'viber_service' for Viber Service. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/ViberVideoRequest.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberVideoRequest.ts#L17) A client-defined reference string for the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/ViberVideoRequest.ts:52](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberVideoRequest.ts#L52) The sender's identifier. ##### message\_type ```ts message_type: "video"; ``` Defined in: [messages/lib/types/Requests/ViberVideoRequest.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberVideoRequest.ts#L22) The type of the message, which is 'video' for a video message. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/ViberVideoRequest.ts:47](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberVideoRequest.ts#L47) The recipient's identifier. ##### viber\_service ```ts viber_service: ViberService; ``` Defined in: [messages/lib/types/Requests/ViberVideoRequest.ts:62](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberVideoRequest.ts#L62) The Viber service configuration. ##### video ```ts video: object; ``` Defined in: [messages/lib/types/Requests/ViberVideoRequest.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/ViberVideoRequest.ts#L27) The video content of the message, including its URL and optional caption and thumbnail URL. ###### caption? ```ts optional caption: string; ``` An optional caption for the video. ###### thumb\_url? ```ts optional thumb_url: string; ``` An optional URL for the video's thumbnail. ###### url ```ts url: string; ``` The URL of the video. *** ### WhatsAppAudioRequest ```ts type WhatsAppAudioRequest = object; ``` Defined in: [messages/lib/types/Requests/WhatsAppAudioRequest.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppAudioRequest.ts#L11) Represents a request for sending an audio message via the WhatsApp channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### audio ```ts audio: object; ``` Defined in: [messages/lib/types/Requests/WhatsAppAudioRequest.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppAudioRequest.ts#L25) The audio content of the message, including its URL. ###### url ```ts url: string; ``` The URL of the audio. ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/types/Requests/WhatsAppAudioRequest.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppAudioRequest.ts#L45) The channel through which the message will be sent, which is 'whatsapp' for WhatsApp. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppAudioRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppAudioRequest.ts#L15) A client-defined reference string for the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppAudioRequest.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppAudioRequest.ts#L40) The sender's identifier. ##### message\_type ```ts message_type: "audio"; ``` Defined in: [messages/lib/types/Requests/WhatsAppAudioRequest.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppAudioRequest.ts#L20) The type of the message, which is 'audio' for an audio message. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppAudioRequest.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppAudioRequest.ts#L35) The recipient's identifier. *** ### WhatsAppCustomRequest ```ts type WhatsAppCustomRequest = object; ``` Defined in: [messages/lib/types/Requests/WhatsAppCustomRequest.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppCustomRequest.ts#L11) Represents a request for sending a custom message via the WhatsApp channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/types/Requests/WhatsAppCustomRequest.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppCustomRequest.ts#L40) The channel through which the message will be sent, which is 'whatsapp' for WhatsApp. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppCustomRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppCustomRequest.ts#L15) A client-defined reference string for the message. ##### custom ```ts custom: Record; ``` Defined in: [messages/lib/types/Requests/WhatsAppCustomRequest.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppCustomRequest.ts#L25) The custom content of the message as a record of unknown type. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppCustomRequest.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppCustomRequest.ts#L35) The sender's identifier. ##### message\_type ```ts message_type: "custom"; ``` Defined in: [messages/lib/types/Requests/WhatsAppCustomRequest.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppCustomRequest.ts#L20) The type of the message, which is 'custom' for a custom message. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppCustomRequest.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppCustomRequest.ts#L30) The recipient's identifier. *** ### WhatsAppFileRequest ```ts type WhatsAppFileRequest = object; ``` Defined in: [messages/lib/types/Requests/WhatsAppFileRequest.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppFileRequest.ts#L11) Represents a request for sending a file message via the WhatsApp channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/types/Requests/WhatsAppFileRequest.ts:50](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppFileRequest.ts#L50) The channel through which the message will be sent, which is 'whatsapp' for WhatsApp. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppFileRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppFileRequest.ts#L15) A client-defined reference string for the message. ##### file ```ts file: object; ``` Defined in: [messages/lib/types/Requests/WhatsAppFileRequest.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppFileRequest.ts#L25) The file content of the message, including the URL of the file and an optional caption. ###### caption? ```ts optional caption: string; ``` An optional caption for the file. ###### url ```ts url: string; ``` The URL of the file to be sent. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppFileRequest.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppFileRequest.ts#L45) The sender's identifier. ##### message\_type ```ts message_type: "file"; ``` Defined in: [messages/lib/types/Requests/WhatsAppFileRequest.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppFileRequest.ts#L20) The type of the message, which is 'file' for a file message. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppFileRequest.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppFileRequest.ts#L40) The recipient's identifier. *** ### WhatsAppImageRequest ```ts type WhatsAppImageRequest = object; ``` Defined in: [messages/lib/types/Requests/WhatsAppImageRequest.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppImageRequest.ts#L11) Represents a request for sending an image message via the WhatsApp channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/types/Requests/WhatsAppImageRequest.ts:50](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppImageRequest.ts#L50) The channel through which the message will be sent, which is 'whatsapp' for WhatsApp. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppImageRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppImageRequest.ts#L15) A client-defined reference string for the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppImageRequest.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppImageRequest.ts#L45) The sender's identifier. ##### image ```ts image: object; ``` Defined in: [messages/lib/types/Requests/WhatsAppImageRequest.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppImageRequest.ts#L25) The image content of the message, including the URL of the image and an optional caption. ###### caption? ```ts optional caption: string; ``` An optional caption for the image. ###### url ```ts url: string; ``` The URL of the image to be sent. ##### message\_type ```ts message_type: "image"; ``` Defined in: [messages/lib/types/Requests/WhatsAppImageRequest.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppImageRequest.ts#L20) The type of the message, which is 'image' for an image message. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppImageRequest.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppImageRequest.ts#L40) The recipient's identifier. ##### ttl? ```ts optional ttl: number; ``` Defined in: [messages/lib/types/Requests/WhatsAppImageRequest.ts:55](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppImageRequest.ts#L55) The amount of time in seconds the message will live for *** ### WhatsAppStickerIdRequest ```ts type WhatsAppStickerIdRequest = object; ``` Defined in: [messages/lib/types/Requests/WhatsAppStickerIdRequest.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppStickerIdRequest.ts#L11) Represents a request for sending a sticker message via the WhatsApp channel using a sticker ID. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/types/Requests/WhatsAppStickerIdRequest.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppStickerIdRequest.ts#L45) The channel through which the message will be sent, which is 'whatsapp' for WhatsApp. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppStickerIdRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppStickerIdRequest.ts#L15) A client-defined reference string for the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppStickerIdRequest.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppStickerIdRequest.ts#L40) The sender's identifier. ##### message\_type ```ts message_type: "sticker"; ``` Defined in: [messages/lib/types/Requests/WhatsAppStickerIdRequest.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppStickerIdRequest.ts#L20) The type of the message, which is 'sticker' for a sticker message. ##### sticker ```ts sticker: object; ``` Defined in: [messages/lib/types/Requests/WhatsAppStickerIdRequest.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppStickerIdRequest.ts#L25) The sticker content of the message, including the sticker ID. ###### id ```ts id: string; ``` The ID of the sticker to be sent. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppStickerIdRequest.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppStickerIdRequest.ts#L35) The recipient's identifier. *** ### WhatsAppStickerUrlRequest ```ts type WhatsAppStickerUrlRequest = object; ``` Defined in: [messages/lib/types/Requests/WhatsAppStickerUrlRequest.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppStickerUrlRequest.ts#L11) Represents a request for sending a sticker message via the WhatsApp channel using a sticker URL. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/types/Requests/WhatsAppStickerUrlRequest.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppStickerUrlRequest.ts#L45) The channel through which the message will be sent, which is 'whatsapp' for WhatsApp. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppStickerUrlRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppStickerUrlRequest.ts#L15) A client-defined reference string for the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppStickerUrlRequest.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppStickerUrlRequest.ts#L40) The sender's identifier. ##### message\_type ```ts message_type: "sticker"; ``` Defined in: [messages/lib/types/Requests/WhatsAppStickerUrlRequest.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppStickerUrlRequest.ts#L20) The type of the message, which is 'sticker' for a sticker message. ##### sticker ```ts sticker: object; ``` Defined in: [messages/lib/types/Requests/WhatsAppStickerUrlRequest.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppStickerUrlRequest.ts#L25) The sticker content of the message, including the sticker URL. ###### url ```ts url: string; ``` The URL of the sticker to be sent. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppStickerUrlRequest.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppStickerUrlRequest.ts#L35) The recipient's identifier. *** ### WhatsAppTemplateRequest ```ts type WhatsAppTemplateRequest = object; ``` Defined in: [messages/lib/types/Requests/WhatsAppTemplateRequest.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppTemplateRequest.ts#L13) Represents a request for sending a template message via the WhatsApp channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/types/Requests/WhatsAppTemplateRequest.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppTemplateRequest.ts#L42) The channel through which the message will be sent, which is 'whatsapp' for WhatsApp. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppTemplateRequest.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppTemplateRequest.ts#L17) A client-defined reference string for the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppTemplateRequest.ts:37](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppTemplateRequest.ts#L37) The sender's identifier. ##### message\_type ```ts message_type: "template"; ``` Defined in: [messages/lib/types/Requests/WhatsAppTemplateRequest.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppTemplateRequest.ts#L22) The type of the message, which is 'template' for a template message. ##### template ```ts template: WhatsAppTemplateType; ``` Defined in: [messages/lib/types/Requests/WhatsAppTemplateRequest.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppTemplateRequest.ts#L27) The template content of the message, including the template type. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppTemplateRequest.ts:32](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppTemplateRequest.ts#L32) The recipient's identifier. ##### whatsapp ```ts whatsapp: WhatsAppPolicyType; ``` Defined in: [messages/lib/types/Requests/WhatsAppTemplateRequest.ts:47](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppTemplateRequest.ts#L47) The policy and locale settings for sending the WhatsApp template message. *** ### WhatsAppTextRequest ```ts type WhatsAppTextRequest = object; ``` Defined in: [messages/lib/types/Requests/WhatsAppTextRequest.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppTextRequest.ts#L11) Represents a request for sending a text message via the WhatsApp channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/types/Requests/WhatsAppTextRequest.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppTextRequest.ts#L40) The channel through which the message will be sent, which is 'whatsapp' for WhatsApp. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppTextRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppTextRequest.ts#L15) A client-defined reference string for the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppTextRequest.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppTextRequest.ts#L35) The sender's identifier. ##### message\_type ```ts message_type: "text"; ``` Defined in: [messages/lib/types/Requests/WhatsAppTextRequest.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppTextRequest.ts#L20) The type of the message, which is 'text' for a text message. ##### text ```ts text: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppTextRequest.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppTextRequest.ts#L25) The text content of the message. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppTextRequest.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppTextRequest.ts#L30) The recipient's identifier. *** ### WhatsAppVideoRequest ```ts type WhatsAppVideoRequest = object; ``` Defined in: [messages/lib/types/Requests/WhatsAppVideoRequest.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppVideoRequest.ts#L11) Represents a request for sending a video message via the WhatsApp channel. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### channel ```ts channel: "whatsapp"; ``` Defined in: [messages/lib/types/Requests/WhatsAppVideoRequest.ts:50](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppVideoRequest.ts#L50) The channel through which the message will be sent, which is 'whatsapp' for WhatsApp. ##### client\_ref ```ts client_ref: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppVideoRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppVideoRequest.ts#L15) A client-defined reference string for the message. ##### from ```ts from: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppVideoRequest.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppVideoRequest.ts#L45) The sender's identifier. ##### message\_type ```ts message_type: "video"; ``` Defined in: [messages/lib/types/Requests/WhatsAppVideoRequest.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppVideoRequest.ts#L20) The type of the message, which is 'video' for a video message. ##### to ```ts to: string; ``` Defined in: [messages/lib/types/Requests/WhatsAppVideoRequest.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppVideoRequest.ts#L40) The recipient's identifier. ##### video ```ts video: object; ``` Defined in: [messages/lib/types/Requests/WhatsAppVideoRequest.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/messages/lib/types/Requests/WhatsAppVideoRequest.ts#L25) The video content of the message, including the URL and an optional caption. ###### caption? ```ts optional caption: string; ``` An optional caption for the video. ###### url ```ts url: string; ``` The URL of the video.