Search code, repositories, users, issues, pull requests...

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

MessageParamsAudio.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

MessageParamsAudio.from

Inherited from

Defined in

messageType

messageType: "audio";

Defined in

to

to: string;

The recipient of the message.

Implementation of

MessageParamsAudio.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

MessageParamsAudio.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

MessageParamsAudio.webhookVersion

Inherited from

Defined in

`abstract` AbstractFileMessage

An abstract base class for file messages.

Extends

AbstractMessage

Extended by

Implements

MessageParamsFile

Constructors

new AbstractFileMessage()

protected new AbstractFileMessage(params): AbstractFileMessage

Constructs a new AbstractFileMessage instance.

Parameters

params

MessageParamsFile

The parameters for creating a file message.

Returns

Overrides

messages/lib/classes/AbstractFileMessage.ts:19

Defined in

Properties

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

MessageParamsFile.clientRef

Inherited from

Defined in

file

file: MessageFileType;

The file attachment content.

Implementation of

MessageParamsFile.file

Defined in

from

from: string;

The sender of the message.

Implementation of

MessageParamsFile.from

Inherited from

Defined in

messageType

messageType: "file";

Defined in

to

to: string;

The recipient of the message.

Implementation of

MessageParamsFile.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

MessageParamsFile.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

MessageParamsFile.webhookVersion

Inherited from

Defined in

`abstract` AbstractImageMessage

An abstract base class for image messages.

Extends

AbstractMessage

Extended by

Implements

MessageParamsImage

Constructors

new AbstractImageMessage()

new AbstractImageMessage(params): AbstractImageMessage

Constructs a new AbstractImageMessage instance.

Parameters

params

MessageParamsImage

The parameters for creating an image message.

Returns

Overrides

messages/lib/classes/AbstractImageMessage.ts:20

Defined in

Properties

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

MessageParamsImage.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

MessageParamsImage.from

Inherited from

Defined in

image

image: MessageImageType;

The image attachment content.

Implementation of

MessageParamsImage.image

Defined in

messageType

messageType: "image";

Defined in

to

to: string;

The recipient of the message.

Implementation of

MessageParamsImage.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

MessageParamsImage.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

MessageParamsImage.webhookVersion

Inherited from

Defined in

`abstract` AbstractMessage

An abstract base class for message objects.

Extended by

Implements

MessageParams

Constructors

new AbstractMessage()

new AbstractMessage(params): AbstractMessage

Constructs a new AbstractMessage instance.

Parameters

params

MessageParams

The parameters for creating a message.

Returns

messages/lib/classes/AbstractMessage.ts:43

Defined in

Properties

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

MessageParams.clientRef

Defined in

from

from: string;

The sender of the message.

Implementation of

MessageParams.from

Defined in

to

to: string;

The recipient of the message.

Implementation of

MessageParams.to

Defined in

webhookUrl?

optional webhookUrl: string;

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

MessageParams.webhookUrl

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

MessageParams.webhookVersion

Defined in

`abstract` AbstractTextMessage

An abstract base class for text message objects.

Extends

AbstractMessage

Extended by

Implements

MessageParamsText

Constructors

new AbstractTextMessage()

new AbstractTextMessage(params): AbstractTextMessage

Constructs a new AbstractTextMessage instance for text messages.

Parameters

params

MessageParamsText

The parameters for creating a text message.

Returns

Overrides

messages/lib/classes/AbstractTextMessage.ts:26

Defined in

Properties

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

MessageParamsText.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

MessageParamsText.from

Inherited from

Defined in

messageType

messageType: "text";

The type of message, which is 'text' for text messages.

Defined in

text

text: string;

The text content of the message.

Implementation of

MessageParamsText.text

Defined in

to

to: string;

The recipient of the message.

Implementation of

MessageParamsText.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

MessageParamsText.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

MessageParamsText.webhookVersion

Inherited from

Defined in

`abstract` AbstractVcardMessage

An abstract base class for vCard (contact card) message objects.

Extends

AbstractMessage

Extended by

MMSVcard

Implements

MessageParamsVcard

Constructors

new AbstractVcardMessage()

new AbstractVcardMessage(params): AbstractVcardMessage

Constructs a new AbstractVcardMessage instance for vCard messages.

Parameters

params

MessageParamsVcard

The parameters for creating a vCard message.

Returns

Overrides

messages/lib/classes/AbstractVcardMessage.ts:27

Defined in

Properties

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

MessageParamsVcard.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

MessageParamsVcard.from

Inherited from

Defined in

messages/lib/classes/AbstractVcardMessage.ts:15

messageType

messageType: "vcard";

The type of message, which is 'vcard' for vCard messages.

Defined in

to

to: string;

The recipient of the message.

Implementation of

MessageParamsVcard.to

Inherited from

Defined in

messages/lib/classes/AbstractVcardMessage.ts:20

vcard

vcard: MessageVcardType;

The vCard (contact card) content of the message.

Implementation of

MessageParamsVcard.vcard

Defined in

webhookUrl?

optional webhookUrl: string;

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

MessageParamsVcard.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

MessageParamsVcard.webhookVersion

Inherited from

Defined in

`abstract` AbstractVideoMessage

An abstract base class for video message objects.

Extends

AbstractMessage

Extended by

Implements

MessageParamsVideo

Constructors

new AbstractVideoMessage()

new AbstractVideoMessage(params): AbstractVideoMessage

Constructs a new AbstractVideoMessage instance for video messages.

Parameters

params

MessageParamsVideo

The parameters for creating a video message.

Returns

Overrides

messages/lib/classes/AbstractVideoMessage.ts:27

Defined in

Properties

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

MessageParamsVideo.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

MessageParamsVideo.from

Inherited from

Defined in

messageType

messageType: "video";

The type of message, which is 'video' for video messages.

Defined in

to

to: string;

The recipient of the message.

Implementation of

MessageParamsVideo.to

Inherited from

Defined in

video

video: MessageVideoType;

The video content of the message.

Implementation of

MessageParamsVideo.video

Defined in

webhookUrl?

optional webhookUrl: string;

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

MessageParamsVideo.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

MessageParamsVideo.webhookVersion

Inherited from

Defined in

https://developer.nexmo.com/en/messages/overview

Messages

Client class to interact with the Messages API which enables users to manage send messages through various channels programmatically.

See

Examples

Create a standalone Messages client

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

import { Vonage } from '@vonage/server-client';

const vonage = new Vonage({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET
});

const messagesClient = vonage.messages;

Extends

Client

Constructors

new Messages()

new Messages(credentials, options?): Messages

Creates a new instance of the Client.

Parameters

credentials

The authentication credentials or an authentication instance.

AuthInterface | AuthParams

options?

ConfigParams

Optional configuration settings for the client.

Returns

Messages

Inherited from

Client.constructor

Defined in

server-client/dist/lib/client.d.ts:35

Methods

addAuthenticationToRequest()

addAuthenticationToRequest(request): Promise<VetchOptions>

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

Client.addAuthenticationToRequest

The request to which authentication should be added.

Returns

Promise<VetchOptions>

A promise that resolves to the request with added authentication.

Overrides

Defined in

messages/lib/messages.ts:57

addBasicAuthToRequest()

protected addBasicAuthToRequest(request): Promise<VetchOptions>

Adds basic authentication headers to the request.

Parameters

request

Client.addBasicAuthToRequest

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

The request options with the added authentication.

Inherited from

Defined in

server-client/dist/lib/client.d.ts:71

addJWTToRequest()

protected addJWTToRequest(request): Promise<VetchOptions>

Adds a JWT to the request.

Parameters

request

Client.addJWTToRequest

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

The request options with the added authentication.

Inherited from

Defined in

server-client/dist/lib/client.d.ts:64

addQueryKeySecretToRequest()

protected addQueryKeySecretToRequest(request): Promise<VetchOptions>

Adds API key and secret to the request.

Parameters

request

Client.addQueryKeySecretToRequest

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

The request options with the added authentication.

Inherited from

Defined in

server-client/dist/lib/client.d.ts:57

addQueryKeySecretToRequestBody()

protected addQueryKeySecretToRequestBody(request): Promise<VetchOptions>

Adds API key and secret to the request body.

Parameters

request

Client.addQueryKeySecretToRequestBody

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

The request options with the added authentication.

Inherited from

Defined in

server-client/dist/lib/client.d.ts:50

getConfig()

getConfig(): ConfigParams

Returns

ConfigParams

Inherited from

Client.getConfig

Defined in

server-client/dist/lib/client.d.ts:36

parseResponse()

protected parseResponse<T>(request, response): Promise<VetchResponse<T>>

Parses the response based on its content type.

Type Parameters

• T

The expected type of the parsed response data.

Parameters

request

The request options.

response

Response

The raw response from the request.

Returns

Promise<VetchResponse<T>>

The parsed response.

Inherited from

Client.parseResponse

Defined in

server-client/dist/lib/client.d.ts:168

prepareBody()

protected prepareBody(request): undefined | string

Prepares the body for the request based on the content type.

Parameters

request

The request options.

Returns

undefined | string

The prepared request body as a string or undefined.

Inherited from

Client.prepareBody

Defined in

server-client/dist/lib/client.d.ts:158

prepareRequest()

protected prepareRequest(request): Promise<VetchOptions>

Prepares the request with necessary headers, authentication, and query parameters.

Parameters

request

Client.prepareRequest

The initial request options.

Returns

Promise<VetchOptions>

The modified request options.

Inherited from

Defined in

server-client/dist/lib/client.d.ts:151

send()

send(message): Promise<MessageSuccess>

Sends a message using the Vonage API.

Parameters

message

The message to be sent.

AnyChannel

Returns

Promise<MessageSuccess>

A promise that resolves to a success response with a message UUID.

Defined in

messages/lib/messages.ts:82

sendDeleteRequest()

sendDeleteRequest<T>(url): Promise<VetchResponse<T>>

Sends a DELETE request to the specified URL.

Type Parameters

• T

Parameters

url

string

The URL endpoint for the DELETE request.

Returns

Promise<VetchResponse<T>>

The response from the DELETE request.

Inherited from

Client.sendDeleteRequest

Defined in

server-client/dist/lib/client.d.ts:78

sendFormSubmitRequest()

sendFormSubmitRequest<T>(url, payload?): Promise<VetchResponse<T>>

Sends a POST request with form data to the specified URL.

Type Parameters

• 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<T>>

The response from the POST request.

Inherited from

Client.sendFormSubmitRequest

Defined in

server-client/dist/lib/client.d.ts:86

sendGetRequest()

sendGetRequest<T>(url, queryParams?): Promise<VetchResponse<T>>

Sends a GET request to the specified URL with optional query parameters.

Type Parameters

• 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<T>>

The response from the GET request.

Inherited from

Client.sendGetRequest

Defined in

server-client/dist/lib/client.d.ts:94

sendPatchRequest()

sendPatchRequest<T>(url, payload?): Promise<VetchResponse<T>>

Sends a PATCH request to the specified URL with an optional payload.

Type Parameters

• 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<T>>

The response from the PATCH request.

Inherited from

Client.sendPatchRequest

Defined in

server-client/dist/lib/client.d.ts:104

sendPostRequest()

sendPostRequest<T>(url, payload?): Promise<VetchResponse<T>>

Sends a POST request to the specified URL with an optional payload.

Type Parameters

• 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<T>>

The response from the POST request.

Inherited from

Client.sendPostRequest

Defined in

server-client/dist/lib/client.d.ts:114

sendPutRequest()

sendPutRequest<T>(url, payload?): Promise<VetchResponse<T>>

Sends a PUT request to the specified URL with an optional payload.

Type Parameters

• 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<T>>

The response from the PUT request.

Inherited from

Client.sendPutRequest

Defined in

server-client/dist/lib/client.d.ts:124

sendRequest()

sendRequest<T>(request): Promise<VetchResponse<T>>

Sends a request adding necessary headers, handling authentication, and parsing the response.

Type Parameters

• T

Parameters

request

Client.sendRequestWithData

The options defining the request, including URL, method, headers, and data.

Returns

Promise<VetchResponse<T>>

The parsed response from the request.

Inherited from

Client.sendRequest

Defined in

server-client/dist/lib/client.d.ts:144

sendRequestWithData()

sendRequestWithData<T>(
   method, 
   url, 
payload?): Promise<VetchResponse<T>>

Sends a request with JSON-encoded data to the specified URL using the provided HTTP method.

Type Parameters

• T

Parameters

method

The HTTP method to be used for the request (only POST, PATCH, or PUT are acceptable).

POST | PUT | 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<T>>

The response from the request.

Inherited from

Defined in

server-client/dist/lib/client.d.ts:135

updateMessage()

updateMessage(messageId, status): Promise<true>

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"

const vonage = new Vonage(
  {
    applicationId: myAppId,
    privateKey: myPrivateKey
  },
  {
    apiHost: 'https://api-eu.vonage.com'
  }
)

await vonage.messages.updateMessage(messageId, UpdateMessageStatus.READ);

Defined in

messages/lib/messages.ts:131

Properties

auth

protected auth: AuthInterface;

The authentication instance responsible for generating authentication headers and query parameters.

Inherited from

Client.auth

Defined in

server-client/dist/lib/client.d.ts:24

authType?

protected optional authType: AuthenticationType;

The type of authentication used for the client's requests.

Inherited from

Client.authType

Defined in

server-client/dist/lib/client.d.ts:20

config

protected config: ConfigParams;

Configuration settings for the client, including default hosts for various services and other request settings.

Inherited from

Client.config

Defined in

server-client/dist/lib/client.d.ts:28

transformers

static transformers: object;

Static property containing utility transformers.

camelCaseObjectKeys

camelCaseObjectKeys: PartialTransformFunction;

kebabCaseObjectKeys

kebabCaseObjectKeys: PartialTransformFunction;

omit()

omit: (keys, obj) => TransformedObject;

Parameters

keys

string[]

obj

ObjectToTransform

Returns

TransformedObject

snakeCaseObjectKeys

snakeCaseObjectKeys: PartialTransformFunction;

Inherited from

Client.transformers

Defined in

server-client/dist/lib/client.d.ts:11

MessengerAudio

Represents an audio message for the Messenger channel.

Extends

AbstractAudioMessage

Implements

MessengerAudioParams

Constructors

new MessengerAudio()

new MessengerAudio(params): MessengerAudio

Sends an audio message to the Facebook Messenger channel.

Parameters

params

MessengerAudioParams

The parameters for creating a Messenger audio message.

Returns

MessengerAudio

Example

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

messages/lib/classes/Messenger/MessengerAudio.ts:43

Defined in

Properties

audio

audio: MessageAudioType;

The audio message content.

Implementation of

MessengerAudioParams.audio

Inherited from

Defined in

messages/lib/classes/Messenger/MessengerAudio.ts:16

channel

channel: "messenger";

The channel for this message (always 'messenger').

Defined in

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

MessengerAudioParams.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

MessengerAudioParams.from

Inherited from

Defined in

messageType

messageType: "audio";

Inherited from

Defined in

messages/lib/classes/Messenger/MessengerAudio.ts:21

messenger

messenger: MessengerType;

The messenger information for this message.

Implementation of

MessengerAudioParams.messenger

Defined in

to

to: string;

The recipient of the message.

Implementation of

MessengerAudioParams.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

MessengerAudioParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

MessengerAudioParams.webhookVersion

Inherited from

Defined in

MessengerFile

Represents a file message for the Messenger channel.

Extends

AbstractFileMessage

Implements

Constructors

new MessengerFile()

new MessengerFile(params): MessengerFile

Sends a file message to the Facebook Messenger channel.

Parameters

params

MessageParams

The parameters for creating a Messenger file message.

Returns

MessengerFile

Example

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

messages/lib/classes/Messenger/MessengerFile.ts:45

Defined in

Properties

channel

channel: "messenger";

The channel for this message (always 'messenger').

Defined in

messages/lib/classes/Messenger/MessengerFile.ts:16

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

MessageParams.clientRef

Inherited from

Defined in

file

file: MessageFileType;

The file attachment content.

Implementation of

MessengerFileParams.file

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

MessageParams.from

Inherited from

Defined in

messageType

messageType: "file";

Inherited from

Defined in

messages/lib/classes/Messenger/MessengerFile.ts:21

messenger

messenger: MessengerType;

The messenger information for this message.

Implementation of

MessengerFileParams.messenger

Defined in

to

to: string;

The recipient of the message.

Implementation of

MessageParams.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

MessageParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

MessageParams.webhookVersion

Inherited from

Defined in

MessengerImage

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

Implements

MessengerImageParams

Constructors

new MessengerImage()

new MessengerImage(params): MessengerImage

Send an image message using the Facebook Messenger channel.

Parameters

params

MessengerImageParams

The parameters for the image message.

Returns

MessengerImage

Example

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

messages/lib/classes/Messenger/MessengerImage.ts:47

Defined in

Properties

channel

channel: "messenger";

The channel for sending the message, which is set to 'messenger'.

Defined in

messages/lib/classes/Messenger/MessengerImage.ts:19

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

MessengerImageParams.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

MessengerImageParams.from

Inherited from

Defined in

image

image: MessageImageType;

The image attachment content.

Implementation of

MessengerImageParams.image

Inherited from

Defined in

messageType

messageType: "image";

Inherited from

Defined in

messages/lib/classes/Messenger/MessengerImage.ts:24

messenger

messenger: MessengerType;

Additional Messenger-specific parameters for the image message.

Implementation of

MessengerImageParams.messenger

Defined in

to

to: string;

The recipient of the message.

Implementation of

MessengerImageParams.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

MessengerImageParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

MessengerImageParams.webhookVersion

Inherited from

Defined in

MessengerText

Represents a text message for the Messenger channel.

Extends

AbstractTextMessage

Implements

MessengerTextParams

Constructors

new MessengerText()

new MessengerText(params): MessengerText

Sends a text message to the Facebook Messenger channel.

Parameters

params

MessengerTextParams

The parameters for creating a Messenger text message.

Returns

MessengerText

Example

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

messages/lib/classes/Messenger/MessengerText.ts:42

Defined in

Properties

channel

channel: "messenger";

The channel for this message (always 'messenger').

Defined in

messages/lib/classes/Messenger/MessengerText.ts:16

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

MessengerTextParams.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

MessengerTextParams.from

Inherited from

Defined in

messageType

messageType: "text";

The type of message, which is 'text' for text messages.

Inherited from

Defined in

messages/lib/classes/Messenger/MessengerText.ts:21

messenger

messenger: MessengerType;

The messenger information for this message.

Implementation of

MessengerTextParams.messenger

Defined in

text

text: string;

The text content of the message.

Implementation of

MessengerTextParams.text

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

MessengerTextParams.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

MessengerTextParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

MessengerTextParams.webhookVersion

Inherited from

Defined in

MessengerVideo

Represents a video message for the Messenger channel.

Extends

AbstractVideoMessage

Implements

MessengerVideoParams

Constructors

new MessengerVideo()

new MessengerVideo(params): MessengerVideo

Send a video message using the Facebook Messenger channel.

Parameters

params

MessengerVideoParams

The parameters for creating a Messenger video message.

Returns

MessengerVideo

Example

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

messages/lib/classes/Messenger/MessengerVideo.ts:44

Defined in

Properties

channel

channel: "messenger";

The channel for this message (always 'messenger').

Defined in

messages/lib/classes/Messenger/MessengerVideo.ts:16

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

MessengerVideoParams.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

MessengerVideoParams.from

Inherited from

Defined in

messageType

messageType: "video";

The type of message, which is 'video' for video messages.

Inherited from

Defined in

messages/lib/classes/Messenger/MessengerVideo.ts:21

messenger

messenger: MessengerType;

The messenger information for this message.

Implementation of

MessengerVideoParams.messenger

Defined in

to

to: string;

The recipient of the message.

Implementation of

MessengerVideoParams.to

Inherited from

Defined in

video

video: MessageVideoType;

The video content of the message.

Implementation of

MessengerVideoParams.video

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

MessengerVideoParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

MessengerVideoParams.webhookVersion

Inherited from

Defined in

MMSAudio

Represents an audio message for the MMS channel.

Extends

AbstractAudioMessage

Implements

MessageParamsAudio

Constructors

new MMSAudio()

new MMSAudio(params): MMSAudio

Send an MMS audio message.

Parameters

params

MessageParamsAudio

The parameters for creating the audio message.

Returns

MMSAudio

Example

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

messages/lib/classes/MMS/MMSAudio.ts:36

Defined in

Properties

audio

audio: MessageAudioType;

The audio message content.

Implementation of

MessageParamsAudio.audio

Inherited from

Defined in

messages/lib/classes/MMS/MMSAudio.ts:13

channel

channel: "mms";

Defined in

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

MessageParamsAudio.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

MessageParamsAudio.from

Inherited from

Defined in

messageType

messageType: "audio";

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

MessageParamsAudio.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

MessageParamsAudio.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

MessageParamsAudio.webhookVersion

Inherited from

Defined in

MMSImage

Represents an image message for the MMS channel.

Extends

AbstractImageMessage

Implements

MessageParamsImage

Constructors

new MMSImage()

new MMSImage(params): MMSImage

Send an MMS image message.

Parameters

params

MessageParamsImage

The parameters for creating the image message.

Returns

MMSImage

Example

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

messages/lib/classes/MMS/MMSImage.ts:36

Defined in

Properties

channel

channel: "mms";

Defined in

messages/lib/classes/MMS/MMSImage.ts:13

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

MessageParamsImage.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

MessageParamsImage.from

Inherited from

Defined in

image

image: MessageImageType;

The image attachment content.

Implementation of

MessageParamsImage.image

Inherited from

Defined in

messageType

messageType: "image";

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

MessageParamsImage.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

MessageParamsImage.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

MessageParamsImage.webhookVersion

Inherited from

Defined in

MMSVcard

Represents a vCard message for the MMS channel.

Extends

AbstractVcardMessage

Implements

MessageParamsVcard

Constructors

new MMSVcard()

new MMSVcard(params): MMSVcard

Send an MMS vCard message.

Parameters

params

MessageParamsVcard

The parameters for creating the vCard message.

Returns

MMSVcard

Example

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

messages/lib/classes/MMS/MMSVcard.ts:36

Defined in

Properties

channel

channel: "mms";

Defined in

messages/lib/classes/MMS/MMSVcard.ts:13

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

MessageParamsVcard.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

MessageParamsVcard.from

Inherited from

Defined in

messageType

messageType: "vcard";

The type of message, which is 'vcard' for vCard messages.

Inherited from

messages/lib/classes/AbstractVcardMessage.ts:15

Defined in

to

to: string;

The recipient of the message.

Implementation of

MessageParamsVcard.to

Inherited from

Defined in

vcard

vcard: MessageVcardType;

The vCard (contact card) content of the message.

Implementation of

MessageParamsVcard.vcard

Inherited from

messages/lib/classes/AbstractVcardMessage.ts:20

Defined in

webhookUrl?

optional webhookUrl: string;

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

MessageParamsVcard.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

MessageParamsVcard.webhookVersion

Inherited from

Defined in

MMSVideo

Represents a video message for the MMS channel.

Extends

AbstractVideoMessage

Implements

MessageParamsVideo

Constructors

new MMSVideo()

new MMSVideo(params): MMSVideo

Send an MMS video message.

Parameters

params

MessageParamsVideo

The parameters for creating the video message.

Returns

MMSVideo

Example

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

messages/lib/classes/MMS/MMSVideo.ts:35

Defined in

Properties

channel

channel: "mms";

Defined in

messages/lib/classes/MMS/MMSVideo.ts:13

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

MessageParamsVideo.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

MessageParamsVideo.from

Inherited from

Defined in

messageType

messageType: "video";

The type of message, which is 'video' for video messages.

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

MessageParamsVideo.to

Inherited from

Defined in

video

video: MessageVideoType;

The video content of the message.

Implementation of

MessageParamsVideo.video

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

MessageParamsVideo.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

MessageParamsVideo.webhookVersion

Inherited from

Defined in

RCSCustom

Represents a custom message for RCS.

Extends

AbstractMessage

Implements

RCSCustomParams

Constructors

new RCSCustom()

new RCSCustom(params): RCSCustom

Sends a custom message through RCS

Parameters

params

RCSCustomParams

The parameters for creating a RCS custom message.

Returns

RCSCustom

Example

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

messages/lib/classes/RCS/RCSCustom.ts:54

Defined in

Properties

channel

channel: RCS = Channels.RCS;

The channel through which the message will be sent. Always rcs

Implementation of

RCSCustomParams.channel

Defined in

messages/lib/classes/RCS/RCSCustom.ts:14

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

RCSCustomParams.clientRef

Inherited from

Defined in

messages/lib/classes/RCS/RCSCustom.ts:24

custom

custom: Record<string, unknown>;

A custom payload. The schema of a custom object can vary widely.

Implementation of

RCSCustomParams.custom

Defined in

from

from: string;

The sender of the message.

Implementation of

RCSCustomParams.from

Inherited from

Defined in

messages/lib/classes/RCS/RCSCustom.ts:19

messageType

messageType: string = 'custom';

The type of message. For a custom message, this will always be custom.

Defined in

to

to: string;

The recipient of the message.

Implementation of

RCSCustomParams.to

Inherited from

Defined in

messages/lib/classes/RCS/RCSCustom.ts:32

ttl?

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.

Implementation of

RCSCustomParams.ttl

Defined in

webhookUrl?

optional webhookUrl: string;

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

RCSCustomParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

RCSCustomParams.webhookVersion

Inherited from

Defined in

RCSFile

Represents a file message for the RCS channel.

Extends

AbstractFileMessage

Implements

Constructors

new RCSFile()

new RCSFile(params): RCSFile

Sends a file message to the RCS channel.

Parameters

params

MessageParams & object & object

The parameters for creating a RCS file message.

Returns

RCSFile

Example

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

messages/lib/classes/RCS/RCSFile.ts:48

Defined in

Properties

channel

channel: RCS = Channels.RCS;

The channel for this message (always 'rcs').

Implementation of

RCSFileParams.channel

Defined in

messages/lib/classes/RCS/RCSFile.ts:17

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

RCSFileParams.clientRef

Inherited from

Defined in

file

file: MessageFileType;

The file attachment content.

Implementation of

RCSFileParams.file

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

RCSFileParams.from

Inherited from

Defined in

messageType

messageType: "file";

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

RCSFileParams.to

Inherited from

Defined in

messages/lib/classes/RCS/RCSFile.ts:25

ttl?

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.

Implementation of

RCSFileParams.ttl

Defined in

webhookUrl?

optional webhookUrl: string;

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

RCSFileParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

RCSFileParams.webhookVersion

Inherited from

Defined in

RCSImage

Represents an image message for the RCS channel.

Extends

AbstractImageMessage

Implements

RCSImageParams

Constructors

new RCSImage()

new RCSImage(params): RCSImage

Send an RCS image message.

Parameters

params

RCSImageParams

The parameters for creating the image message.

Returns

RCSImage

Example

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

messages/lib/classes/RCS/RCSImage.ts:44

Defined in

Properties

channel

channel: RCS = Channels.RCS;

The channel through which the message will be sent. Always rcs

Implementation of

RCSImageParams.channel

Defined in

messages/lib/classes/RCS/RCSImage.ts:14

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

RCSImageParams.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

RCSImageParams.from

Inherited from

Defined in

image

image: MessageImageType;

The image attachment content.

Implementation of

RCSImageParams.image

Inherited from

Defined in

messageType

messageType: "image";

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

RCSImageParams.to

Inherited from

Defined in

messages/lib/classes/RCS/RCSImage.ts:22

ttl?

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.

Implementation of

RCSImageParams.ttl

Defined in

webhookUrl?

optional webhookUrl: string;

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

RCSImageParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

RCSImageParams.webhookVersion

Inherited from

Defined in

RCSText

Represents a text message for the RCS channel.

Extends

AbstractTextMessage

Implements

RCSTextParams

Constructors

new RCSText()

new RCSText(params): RCSText

Sends a text message through the RCS channel.

Parameters

params

RCSTextParams

The parameters for creating a RCS text message.

Returns

RCSText

Example

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

messages/lib/classes/RCS/RCSText.ts:43

Defined in

Properties

channel

channel: RCS = Channels.RCS;

The channel for this message (always 'rcs').

Implementation of

RCSTextParams.channel

Defined in

messages/lib/classes/RCS/RCSText.ts:14

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

RCSTextParams.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

RCSTextParams.from

Inherited from

Defined in

messageType

messageType: "text";

The type of message, which is 'text' for text messages.

Inherited from

Defined in

text

text: string;

The text content of the message.

Implementation of

RCSTextParams.text

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

RCSTextParams.to

Inherited from

Defined in

messages/lib/classes/RCS/RCSText.ts:22

ttl?

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.

Implementation of

RCSTextParams.ttl

Defined in

webhookUrl?

optional webhookUrl: string;

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

RCSTextParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

RCSTextParams.webhookVersion

Inherited from

Defined in

RCSVideo

Represents an video message for the RCS channel.

Extends

AbstractVideoMessage

Implements

RCSVideoParams

Constructors

new RCSVideo()

new RCSVideo(params): RCSVideo

Send an RCS video message.

Parameters

params

RCSVideoParams

The parameters for creating the video message.

Returns

RCSVideo

Example

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

messages/lib/classes/RCS/RCSVideo.ts:45

Defined in

Properties

channel

channel: RCS;

The channel through which the message will be sent. Always rcs

Implementation of

RCSVideoParams.channel

Defined in

messages/lib/classes/RCS/RCSVideo.ts:14

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

RCSVideoParams.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

RCSVideoParams.from

Inherited from

Defined in

messageType

messageType: "video";

The type of message, which is 'video' for video messages.

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

RCSVideoParams.to

Inherited from

Defined in

messages/lib/classes/RCS/RCSVideo.ts:22

ttl?

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.

Implementation of

RCSVideoParams.ttl

Defined in

video

video: MessageVideoType;

The video content of the message.

Implementation of

RCSVideoParams.video

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

RCSVideoParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

RCSVideoParams.webhookVersion

Inherited from

Defined in

SMS

Send a text message using the SMS channel.

Extends

AbstractTextMessage

Implements

SMSParams

Constructors

new SMS()

new SMS(
   params, 
   to?, 
   from?, 
   clientRef?): SMS

Send an SMS message

Parameters

params

The message parameters or text message.

string | 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

Examples

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

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

messages/lib/classes/SMS/SMS.ts:58

Defined in

Properties

channel

channel: "sms";

Defined in

messages/lib/classes/SMS/SMS.ts:13

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

SMSParams.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

SMSParams.from

Inherited from

Defined in

messageType

messageType: "text";

The type of message, which is 'text' for text messages.

Inherited from

Defined in

messages/lib/classes/SMS/SMS.ts:15

sms?

optional sms: SMSExtraParams;

Implementation of

SMSParams.sms

Defined in

text

text: string;

The text content of the message.

Implementation of

SMSParams.text

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

SMSParams.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

SMSParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

SMSParams.webhookVersion

Inherited from

Defined in

ViberFile

Represents a file message for the Viber Service channel.

Extends

AbstractFileMessage

Implements

ViberFileParams

Constructors

new ViberFile()

new ViberFile(params): ViberFile

Send a file message using the Viber Service channel.

Parameters

params

ViberFileParams

The parameters for the ViberFile message.

Returns

ViberFile

Example

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

messages/lib/classes/Viber/ViberFile.ts:38

Defined in

Properties

channel

channel: "viber_service";

Defined in

messages/lib/classes/Viber/ViberFile.ts:10

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

ViberFileParams.clientRef

Inherited from

Defined in

file

file: MessageFileType;

The file attachment content.

Implementation of

ViberFileParams.file

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

ViberFileParams.from

Inherited from

Defined in

messageType

messageType: "file";

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

ViberFileParams.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

ViberFileParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

ViberFileParams.webhookVersion

Inherited from

Defined in

ViberImage

Represents an image message for the Viber Service channel.

Extends

AbstractImageMessage

Implements

ViberImageParams

Constructors

new ViberImage()

new ViberImage(params): ViberImage

Send an image message using the Viber Service channel.

Parameters

params

ViberImageParams

The parameters for the ViberImage message.

Returns

ViberImage

Example

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

messages/lib/classes/Viber/ViberImage.ts:43

Defined in

Properties

channel

channel: "viber_service";

Defined in

messages/lib/classes/Viber/ViberImage.ts:14

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

ViberImageParams.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

ViberImageParams.from

Inherited from

Defined in

image

image: MessageImageType;

The image attachment content.

Implementation of

ViberImageParams.image

Inherited from

Defined in

messageType

messageType: "image";

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

ViberImageParams.to

Inherited from

Defined in

messages/lib/classes/Viber/ViberImage.ts:15

viberService

viberService: ViberActionParams;

The Viber action parameters for sending the image.

Implementation of

ViberImageParams.viberService

Defined in

webhookUrl?

optional webhookUrl: string;

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

ViberImageParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

ViberImageParams.webhookVersion

Inherited from

Defined in

ViberText

Represents a text message for the Viber Service channel.

Extends

AbstractTextMessage

Implements

ViberTextParams

Constructors

new ViberText()

new ViberText(params): ViberText

Send a text message using the Viber Service channel.

Parameters

params

ViberTextParams

The parameters for the ViberText message.

Returns

ViberText

Example

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

messages/lib/classes/Viber/ViberText.ts:42

Defined in

Properties

channel

channel: "viber_service";

Defined in

messages/lib/classes/Viber/ViberText.ts:14

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

ViberTextParams.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

ViberTextParams.from

Inherited from

Defined in

messageType

messageType: "text";

The type of message, which is 'text' for text messages.

Inherited from

Defined in

text

text: string;

The text content of the message.

Implementation of

ViberTextParams.text

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

ViberTextParams.to

Inherited from

Defined in

messages/lib/classes/Viber/ViberText.ts:15

viberService

viberService: ViberActionParams;

The Viber service and action parameters for the message.

Implementation of

ViberTextParams.viberService

Defined in

webhookUrl?

optional webhookUrl: string;

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

ViberTextParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

ViberTextParams.webhookVersion

Inherited from

Defined in

ViberVideo

Represents a video message for the Viber Service channel.

Extends

AbstractVideoMessage

Implements

ViberVideoParams

Constructors

new ViberVideo()

new ViberVideo(params): ViberVideo

Send a video message using the Viber Service channel.

Parameters

params

ViberVideoParams

The parameters for the ViberVideo message.

Returns

ViberVideo

Example

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

messages/lib/classes/Viber/ViberVideo.ts:43

Defined in

Properties

channel

channel: "viber_service";

Defined in

messages/lib/classes/Viber/ViberVideo.ts:13

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

ViberVideoParams.clientRef

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

ViberVideoParams.from

Inherited from

Defined in

messageType

messageType: "video";

The type of message, which is 'video' for video messages.

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

ViberVideoParams.to

Inherited from

Defined in

messages/lib/classes/Viber/ViberVideo.ts:14

viberService

viberService: object & object & ViberService;

The Viber service, action parameters, and video message details.

Type declaration

duration

duration: string;

The duration of the video in seconds.

fileSize

fileSize: string;

The file size of the video in MB.

Type declaration

action

action: ViberAction;

The action associated with the Viber message.

Implementation of

ViberVideoParams.viberService

Defined in

video

video: MessageVideoType;

The video content of the message.

Implementation of

ViberVideoParams.video

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

ViberVideoParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

ViberVideoParams.webhookVersion

Inherited from

Defined in

WhatsAppAudio

Represents an audio message for WhatsApp.

Extends

AbstractAudioMessage

Implements

WhatsAppAudioParams

Constructors

new WhatsAppAudio()

new WhatsAppAudio(params): WhatsAppAudio

Sends an audio message to a WhatsApp user.

Parameters

params

WhatsAppAudioParams

The parameters for creating a WhatsApp audio message.

Returns

WhatsAppAudio

Example

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

messages/lib/classes/WhatsApp/WhatsAppAudio.ts:37

Defined in

Properties

audio

audio: MessageAudioType;

The audio message content.

Implementation of

WhatsAppAudioParams.audio

Inherited from

Defined in

messages/lib/classes/WhatsApp/WhatsAppAudio.ts:13

channel

channel: "whatsapp";

Defined in

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

WhatsAppAudioParams.clientRef

Inherited from

Defined in

messages/lib/classes/WhatsApp/WhatsAppAudio.ts:15

context?

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

Implementation of

WhatsAppAudioParams.context

Defined in

from

from: string;

The sender of the message.

Implementation of

WhatsAppAudioParams.from

Inherited from

Defined in

messageType

messageType: "audio";

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

WhatsAppAudioParams.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

WhatsAppAudioParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

WhatsAppAudioParams.webhookVersion

Inherited from

Defined in

WhatsAppCustom

Represents a custom message for WhatsApp.

Extends

AbstractMessage

Implements

WhatsAppCustomParams

Constructors

new WhatsAppCustom()

new WhatsAppCustom(params): WhatsAppCustom

Sends a custom message to a WhatsApp user.

Parameters

params

WhatsAppCustomParams

The parameters for creating a WhatsApp custom message.

Returns

WhatsAppCustom

Example

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

messages/lib/classes/WhatsApp/WhatsAppCustom.ts:47

Defined in

Properties

channel

channel: "whatsapp";

Defined in

messages/lib/classes/WhatsApp/WhatsAppCustom.ts:17

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

WhatsAppCustomParams.clientRef

Inherited from

Defined in

messages/lib/classes/WhatsApp/WhatsAppCustom.ts:21

context?

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

Implementation of

WhatsAppCustomParams.context

Defined in

custom

custom: WhatsAppCustomType;

The custom WhatsApp message type.

Implementation of

WhatsAppCustomParams.custom

Defined in

messages/lib/classes/WhatsApp/WhatsAppCustom.ts:19

from

from: string;

The sender of the message.

Implementation of

WhatsAppCustomParams.from

Inherited from

Defined in

messages/lib/classes/WhatsApp/WhatsAppCustom.ts:18

messageType

messageType: "custom";

Defined in

to

to: string;

The recipient of the message.

Implementation of

WhatsAppCustomParams.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

WhatsAppCustomParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

WhatsAppCustomParams.webhookVersion

Inherited from

Defined in

WhatsAppFile

Represents a file message for WhatsApp.

Extends

AbstractFileMessage

Implements

WhatsAppFileParams

Constructors

new WhatsAppFile()

new WhatsAppFile(params): WhatsAppFile

Send a WhatsApp file message.

Parameters

params

WhatsAppFileParams

The parameters for creating a WhatsApp file message.

Returns

WhatsAppFile

Example

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

messages/lib/classes/WhatsApp/WhatsAppFile.ts:38

Defined in

Properties

channel

channel: Channels = Channels.WHATSAPP;

Defined in

messages/lib/classes/WhatsApp/WhatsAppFile.ts:14

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

WhatsAppFileParams.clientRef

Inherited from

Defined in

messages/lib/classes/WhatsApp/WhatsAppFile.ts:16

context?

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

Implementation of

WhatsAppFileParams.context

Defined in

file

file: MessageFileType;

The file attachment content.

Implementation of

WhatsAppFileParams.file

Inherited from

Defined in

from

from: string;

The sender of the message.

Implementation of

WhatsAppFileParams.from

Inherited from

Defined in

messageType

messageType: "file";

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

WhatsAppFileParams.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

WhatsAppFileParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

WhatsAppFileParams.webhookVersion

Inherited from

Defined in

WhatsAppImage

Represents an image message for WhatsApp.

Extends

AbstractImageMessage

Implements

WhatsAppImageParams

Constructors

new WhatsAppImage()

new WhatsAppImage(params): WhatsAppImage

Sends an image message to a WhatsApp user.

Parameters

params

WhatsAppImageParams

The parameters for creating a WhatsApp image message.

Returns

WhatsAppImage

Example

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

messages/lib/classes/WhatsApp/WhatsAppImage.ts:37

Defined in

Properties

channel

channel: "whatsapp";

Defined in

messages/lib/classes/WhatsApp/WhatsAppImage.ts:13

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

WhatsAppImageParams.clientRef

Inherited from

Defined in

messages/lib/classes/WhatsApp/WhatsAppImage.ts:15

context?

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

Implementation of

WhatsAppImageParams.context

Defined in

from

from: string;

The sender of the message.

Implementation of

WhatsAppImageParams.from

Inherited from

Defined in

image

image: MessageImageType;

The image attachment content.

Implementation of

WhatsAppImageParams.image

Inherited from

Defined in

messageType

messageType: "image";

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

WhatsAppImageParams.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

WhatsAppImageParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

WhatsAppImageParams.webhookVersion

Inherited from

Defined in

WhatsAppReaction

Represents a reaction message for WhatsApp.

Extends

AbstractMessage

Implements

WhatsAppReactionParams

Constructors

new WhatsAppReaction()

new WhatsAppReaction(params): WhatsAppReaction

Sends a reaction message to a WhatsApp user.

Parameters

params

WhatsAppReactionParams

The parameters for creating a WhatsApp reaction message.

Returns

WhatsAppReaction

Examples

Send a reaction

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

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

messages/lib/classes/WhatsApp/WhatsAppReaction.ts:62

Defined in

Properties

channel

channel: "whatsapp";

Defined in

messages/lib/classes/WhatsApp/WhatsAppReaction.ts:17

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

WhatsAppReactionParams.clientRef

Inherited from

Defined in

messages/lib/classes/WhatsApp/WhatsAppReaction.ts:21

context?

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

Implementation of

WhatsAppReactionParams.context

Defined in

from

from: string;

The sender of the message.

Implementation of

WhatsAppReactionParams.from

Inherited from

Defined in

messages/lib/classes/WhatsApp/WhatsAppReaction.ts:18

messageType

messageType: "reaction";

Defined in

reaction

reaction: WhatsAppReactionType;

Implementation of

WhatsAppReactionParams.reaction

Defined in

messages/lib/classes/WhatsApp/WhatsAppReaction.ts:19

to

to: string;

The recipient of the message.

Implementation of

WhatsAppReactionParams.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

WhatsAppReactionParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

WhatsAppReactionParams.webhookVersion

Inherited from

Defined in

WhatsAppSticker

Represents a sticker message for WhatsApp.

Extends

AbstractMessage

Implements

WhatsAppStickerParams

Constructors

new WhatsAppSticker()

new WhatsAppSticker(params): WhatsAppSticker

Send a sticker message to a WhatsApp user.

Parameters

params

WhatsAppStickerParams

The parameters for creating a WhatsApp sticker message.

Returns

WhatsAppSticker

Examples

Send a sticker message with a sticker ID:

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:

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

messages/lib/classes/WhatsApp/WhatsAppSticker.ts:62

Defined in

Properties

channel

channel: "whatsapp";

Defined in

messages/lib/classes/WhatsApp/WhatsAppSticker.ts:18

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

WhatsAppStickerParams.clientRef

Inherited from

Defined in

messages/lib/classes/WhatsApp/WhatsAppSticker.ts:22

context?

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

Implementation of

WhatsAppStickerParams.context

Defined in

from

from: string;

The sender of the message.

Implementation of

WhatsAppStickerParams.from

Inherited from

Defined in

messages/lib/classes/WhatsApp/WhatsAppSticker.ts:19

messageType

messageType: "sticker";

Defined in

sticker

sticker: WhatsAppStickerIdType | WhatsAppStickerUrlType;

The sticker to be sent, which can be either a sticker ID or a sticker URL.

Implementation of

WhatsAppStickerParams.sticker

Defined in

messages/lib/classes/WhatsApp/WhatsAppSticker.ts:20

to

to: string;

The recipient of the message.

Implementation of

WhatsAppStickerParams.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

WhatsAppStickerParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

WhatsAppStickerParams.webhookVersion

Inherited from

Defined in

WhatsAppTemplate

Represents a template message for WhatsApp.

Extends

AbstractMessage

Implements

WhatsAppTemplateParams

Constructors

new WhatsAppTemplate()

new WhatsAppTemplate(params): WhatsAppTemplate

Send a template message to a WhatsApp user.

Parameters

params

WhatsAppTemplateParams

The parameters for creating a WhatsApp template message.

Returns

WhatsAppTemplate

Example

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

messages/lib/classes/WhatsApp/WhatsAppTemplate.ts:54

Defined in

Properties

channel

channel: "whatsapp";

Defined in

messages/lib/classes/WhatsApp/WhatsAppTemplate.ts:18

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

WhatsAppTemplateParams.clientRef

Inherited from

Defined in

messages/lib/classes/WhatsApp/WhatsAppTemplate.ts:23

context?

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

Implementation of

WhatsAppTemplateParams.context

Defined in

from

from: string;

The sender of the message.

Implementation of

WhatsAppTemplateParams.from

Inherited from

Defined in

messages/lib/classes/WhatsApp/WhatsAppTemplate.ts:19

messageType

messageType: "template";

Defined in

template

template: WhatsAppTemplateType;

The WhatsApp template to be sent.

Implementation of

WhatsAppTemplateParams.template

Defined in

messages/lib/classes/WhatsApp/WhatsAppTemplate.ts:21

to

to: string;

The recipient of the message.

Implementation of

WhatsAppTemplateParams.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

WhatsAppTemplateParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

WhatsAppTemplateParams.webhookVersion

Inherited from

Defined in

messages/lib/classes/WhatsApp/WhatsAppTemplate.ts:20

whatsapp

whatsapp: WhatsAppPolicyType;

WhatsApp policy type for the template message.

Implementation of

WhatsAppTemplateParams.whatsapp

Defined in

WhatsAppText

Represents a text message for WhatsApp.

Extends

AbstractTextMessage

Implements

WhatsAppTextParams

Constructors

new WhatsAppText()

new WhatsAppText(params): WhatsAppText

Send a WhatsApp text message.

Parameters

params

WhatsAppTextParams

The parameters for creating a WhatsApp text message.

Returns

WhatsAppText

Example

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

messages/lib/classes/WhatsApp/WhatsAppText.ts:34

Defined in

Properties

channel

channel: "whatsapp";

Defined in

messages/lib/classes/WhatsApp/WhatsAppText.ts:13

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

WhatsAppTextParams.clientRef

Inherited from

Defined in

messages/lib/classes/WhatsApp/WhatsAppText.ts:15

context?

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

Implementation of

WhatsAppTextParams.context

Defined in

from

from: string;

The sender of the message.

Implementation of

WhatsAppTextParams.from

Inherited from

Defined in

messageType

messageType: "text";

The type of message, which is 'text' for text messages.

Inherited from

Defined in

text

text: string;

The text content of the message.

Implementation of

WhatsAppTextParams.text

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

WhatsAppTextParams.to

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

WhatsAppTextParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

WhatsAppTextParams.webhookVersion

Inherited from

Defined in

WhatsAppVideo

Represents a video message for WhatsApp.

Extends

AbstractVideoMessage

Implements

WhatsAppVideoParams

Constructors

new WhatsAppVideo()

new WhatsAppVideo(params): WhatsAppVideo

Sends a video message to a WhatsApp user.

Parameters

params

WhatsAppVideoParams

The parameters for creating a WhatsApp video message.

Returns

WhatsAppVideo

Example

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

messages/lib/classes/WhatsApp/WhatsAppVideo.ts:38

Defined in

Properties

channel

channel: "whatsapp";

Defined in

messages/lib/classes/WhatsApp/WhatsAppVideo.ts:13

clientRef?

optional clientRef: string;

An optional client reference for the message.

Implementation of

WhatsAppVideoParams.clientRef

Inherited from

Defined in

messages/lib/classes/WhatsApp/WhatsAppVideo.ts:15

context?

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

Implementation of

WhatsAppVideoParams.context

Defined in

from

from: string;

The sender of the message.

Implementation of

WhatsAppVideoParams.from

Inherited from

Defined in

messageType

messageType: "video";

The type of message, which is 'video' for video messages.

Inherited from

Defined in

to

to: string;

The recipient of the message.

Implementation of

WhatsAppVideoParams.to

Inherited from

Defined in

video

video: MessageVideoType;

The video content of the message.

Implementation of

WhatsAppVideoParams.video

Inherited from

Defined in

webhookUrl?

optional webhookUrl: string;

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

WhatsAppVideoParams.webhookUrl

Inherited from

Defined in

webhookVersion?

optional webhookVersion: "v0.1" | "v1";

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

WhatsAppVideoParams.webhookVersion

Inherited from

Defined in