SMSMessage

import type { SMSMessage } from "https://aws-api.deno.dev/v0.4/services/pinpoint.ts?docs=full";

Specifies the default settings for a one-time SMS message that's sent directly to an endpoint.

interface SMSMessage {

Body?: string | null;

EntityId?: string | null;

Keyword?: string | null;

MediaUrl?: string | null;

MessageType?: MessageType | null;

OriginationNumber?: string | null;

SenderId?: string | null;

Substitutions?: {

[key: string]: string[] | null | undefined;

} | null;

TemplateId?: string | null;

}

§Properties

Body?: string | null

[src]

The body of the SMS message.

EntityId?: string | null

[src]

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

Keyword?: string | null

[src]

The SMS program name that you provided to AWS Support when you requested your dedicated number.

MediaUrl?: string | null

[src]

This field is reserved for future use.

MessageType?: MessageType | null

[src]

The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

OriginationNumber?: string | null

[src]

The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.

SenderId?: string | null

[src]

The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.

Substitutions?: {

[key: string]: string[] | null | undefined;

} | null

[src]

The message variables to use in the SMS message. You can override the default variables with individual address variables.

TemplateId?: string | null

[src]

The template ID received from the regulatory body for sending SMS in your country.