-
Notifications
You must be signed in to change notification settings - Fork 181
Vonage SMS
Documentation / Vonage SMS
Enumeration representing the possible message classes.
Defines different message classes that can be associated with SMS messages.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
NUMBER_0 |
0 |
Class 0: Flash SMS. | packages/sms/lib/enums/MessageClassEnum.ts:10 |
NUMBER_1 |
1 |
Class 1: Immediate display (user should be able to read the message instantly). | packages/sms/lib/enums/MessageClassEnum.ts:15 |
NUMBER_2 |
2 |
Class 2: Mobile equipment-to-mobile equipment (ME-to-ME) communication. | packages/sms/lib/enums/MessageClassEnum.ts:20 |
NUMBER_3 |
3 |
Class 3: SIM card-based storage. | packages/sms/lib/enums/MessageClassEnum.ts:25 |
Enumeration representing possible SMS status codes.
Defines different status codes that can be associated with SMS messages.
This matches SMSErrors. Since Enums can't be joined, this is here to help check valid statuses
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
ACCOUNT_NOT_ENABLED |
"11" |
Account Not Enabled For HTTP: Account is not provisioned for the SMS API. | packages/sms/lib/enums/SMSStatus.ts:68 |
BARRED_NUMBER |
"7" |
Barred Number: The number you're trying to send messages to is blocklisted. | packages/sms/lib/enums/SMSStatus.ts:48 |
INTERNAL_ERROR |
"5" |
Internal Error: An error occurred while processing the message. | packages/sms/lib/enums/SMSStatus.ts:38 |
INVALID_CALLBACK_URL |
"23" |
Invalid Callback URL: Callback URL is too long or contains illegal characters. | packages/sms/lib/enums/SMSStatus.ts:93 |
INVALID_CREDENTIALS |
"4" |
Invalid Credentials: API key and/or secret are incorrect, invalid, or disabled. | packages/sms/lib/enums/SMSStatus.ts:33 |
INVALID_MESSAGE |
"6" |
Invalid Message: The platform was unable to process the message. | packages/sms/lib/enums/SMSStatus.ts:43 |
INVALID_NETWORK_CODE |
"22" |
Invalid Network Code: Network code is unrecognized or doesn't match the destination. | packages/sms/lib/enums/SMSStatus.ts:88 |
INVALID_PARAM |
"3" |
Invalid Parameter: The value of one or more parameters is invalid. | packages/sms/lib/enums/SMSStatus.ts:28 |
INVALID_SENDER_ADDRESS |
"15" |
Invalid Sender Address: Using a non-authorized sender ID in the 'from' field. | packages/sms/lib/enums/SMSStatus.ts:83 |
INVALID_SIGNATURE |
"14" |
Invalid Signature: The supplied signature could not be verified. | packages/sms/lib/enums/SMSStatus.ts:78 |
MESSAGE_TOO_LONG |
"12" |
Message Too Long: Message length exceeds the maximum allowed. | packages/sms/lib/enums/SMSStatus.ts:73 |
MISSING_REQUIRED_PARAM |
"2" |
Missing Required Parameter: One or more required parameters are missing. | packages/sms/lib/enums/SMSStatus.ts:23 |
NON_WHITELISTED_DESTINATION |
"29" |
Non-Whitelisted Destination: Vonage account is in demo mode and requires whitelisted numbers. This error is returned if you attempt to send a message to a number that isn't in your pre-approved destination list. | packages/sms/lib/enums/SMSStatus.ts:100 |
NUMBER_DEACTIVATED |
"33" |
Number Deactivated: The number you're trying to send messages to is deactivated. | packages/sms/lib/enums/SMSStatus.ts:110 |
PARTNER_ACCOUNT_BARRED |
"8" |
Partner Account Barred: Your Vonage account has been suspended. | packages/sms/lib/enums/SMSStatus.ts:53 |
PARTNER_QUOTA_VIOLATION |
"9" |
Partner Quota Violation: Insufficient credit to send the message. | packages/sms/lib/enums/SMSStatus.ts:58 |
SIGNATURE_AND_API_SECRET_DISALLOWED |
"32" |
Signature And API Secret Disallowed: A signed request may not present an API secret. | packages/sms/lib/enums/SMSStatus.ts:105 |
SUCCESS |
"0" |
Success: The message was sent successfully. | packages/sms/lib/enums/SMSStatus.ts:13 |
THROTTLED |
"1" |
Throttled: Sending SMS faster than the account limit. | packages/sms/lib/enums/SMSStatus.ts:18 |
TOO_MANY_EXISTING_BINDS |
"10" |
Too Many Existing Binds: Number of simultaneous connections exceeds account allocation. | packages/sms/lib/enums/SMSStatus.ts:63 |
Enumeration representing possible message types for SMS.
Defines different message types that can be associated with SMS messages.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
BINARY |
"binary" |
Binary: The message body is in binary format. | packages/sms/lib/enums/TypeEnum.ts:15 |
TEXT |
"text" |
Text: The message body contains standard text. | packages/sms/lib/enums/TypeEnum.ts:10 |
UNICODE |
"unicode" |
Unicode: The message body is URL-encoded Unicode, valid for various character sets. | packages/sms/lib/enums/TypeEnum.ts:20 |
Class representing a failure when sending all SMS messages.
Extends the SMSFailure class and is used to indicate that all SMS messages failed to send.
new MessageSendAllFailure(response): MessageSendAllFailureCreates an instance of MessageSendAllFailure.
The response containing details about the failed SMS messages.
packages/sms/lib/classes/Error/MessageSendAllFailure.ts:15
optional cause: unknown;node_modules/typescript/lib/lib.es2022.error.d.ts:24
message: string;node_modules/typescript/lib/lib.es5.d.ts:1077
name: string;node_modules/typescript/lib/lib.es5.d.ts:1076
protected response: SMSMessages;The response containing details about the SMS messages.
packages/sms/lib/classes/Error/SMSFailure.ts:13
optional stack: string;node_modules/typescript/lib/lib.es5.d.ts:1078
static optional prepareStackTrace: (err, stackTraces) => any;Optional override for formatting stack traces
Error
CallSite[]
any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
node_modules/@types/node/globals.d.ts:143
static stackTraceLimit: number;node_modules/@types/node/globals.d.ts:145
getFailedMessages(): ErrorMessage[]Retrieves an array of failed messages in the response.
An array of failed messages in the response.
packages/sms/lib/classes/Error/SMSFailure.ts:40
getMessages(): ErrorMessage & SMSMessageResponse & object[]Retrieves an array of all messages in the response.
ErrorMessage & object[]
An array of all messages in the response.
packages/sms/lib/classes/Error/SMSFailure.ts:31
getResponse(): SMSMessagesRetrieves the original response containing details about the SMS messages.
The original response containing details about the SMS messages.
packages/sms/lib/classes/Error/SMSFailure.ts:51
getSuccessfulMessages(): Message[]Retrieves an array of successfully sent messages in the response.
Message[]
An array of successfully sent messages in the response.
packages/sms/lib/classes/Error/SMSFailure.ts:60
static captureStackTrace(targetObject, constructorOpt?): voidCreate .stack property on a target object
object
Function
void
node_modules/@types/node/globals.d.ts:136
Class representing a partial failure when sending SMS messages.
Extends the SMSFailure class and is used to indicate that some SMS messages failed to send.
new MessageSendPartialFailure(response): MessageSendPartialFailureCreates an instance of MessageSendPartialFailure.
The response containing details about the partially failed SMS messages.
packages/sms/lib/classes/Error/MessageSendPartialFailure.ts:15
optional cause: unknown;node_modules/typescript/lib/lib.es2022.error.d.ts:24
message: string;node_modules/typescript/lib/lib.es5.d.ts:1077
name: string;node_modules/typescript/lib/lib.es5.d.ts:1076
protected response: SMSMessages;The response containing details about the SMS messages.
packages/sms/lib/classes/Error/SMSFailure.ts:13
optional stack: string;node_modules/typescript/lib/lib.es5.d.ts:1078
static optional prepareStackTrace: (err, stackTraces) => any;Optional override for formatting stack traces
Error
CallSite[]
any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
node_modules/@types/node/globals.d.ts:143
static stackTraceLimit: number;node_modules/@types/node/globals.d.ts:145
getFailedMessages(): ErrorMessage[]Retrieves an array of failed messages in the response.
An array of failed messages in the response.
packages/sms/lib/classes/Error/SMSFailure.ts:40
getMessages(): ErrorMessage & SMSMessageResponse & object[]Retrieves an array of all messages in the response.
ErrorMessage & object[]
An array of all messages in the response.
packages/sms/lib/classes/Error/SMSFailure.ts:31
getResponse(): SMSMessagesRetrieves the original response containing details about the SMS messages.
The original response containing details about the SMS messages.
packages/sms/lib/classes/Error/SMSFailure.ts:51
getSuccessfulMessages(): Message[]Retrieves an array of successfully sent messages in the response.
Message[]
An array of successfully sent messages in the response.
packages/sms/lib/classes/Error/SMSFailure.ts:60
static captureStackTrace(targetObject, constructorOpt?): voidCreate .stack property on a target object
object
Function
void
node_modules/@types/node/globals.d.ts:136
Client for sending legacy SMS messages using the Vonage API.
Create a standalone SMS client
import { AlgorithmTypes } from '@vonage/auth';
import { SMS } from '@vonage/sms';
const smsClient = new SMS({
apiKey: VONAGE_API_KEY,
apiSecret: VONAGE_API_SECRET
secret: {
secret: VONAGE_SIGNATURE_SECRET
algorithm: AlgorithmTypes.sha512hmac
},
});Create an SMS client from the Vonage client
import { AlgorithmTypes } from '@vonage/auth';
import { Vonage } from '@vonage/server-client';
const vonage = new Vonage({
apiKey: VONAGE_API_KEY,
apiSecret: VONAGE_API_SECRET
secret: {
secret: VONAGE_SIGNATURE_SECRET
algorithm: AlgorithmTypes.sha512hmac
},
});
const smsClient = vonage.sms;new SMS(credentials, options?): SMSCreates a new instance of the Client.
The authentication credentials or an authentication instance.
Optional configuration settings for the client.
packages/server-client/dist/lib/client.d.ts:35
protected auth: AuthInterface;The authentication instance responsible for generating authentication headers and query parameters.
packages/server-client/dist/lib/client.d.ts:24
protected optional authType: AuthenticationType = AuthenticationType.BASIC;protected config: ConfigParams;Configuration settings for the client, including default hosts for various services and other request settings.
packages/server-client/dist/lib/client.d.ts:28
static transformers: object;Static property containing utility transformers.
camelCaseObjectKeys: PartialTransformFunction;kebabCaseObjectKeys: PartialTransformFunction;omit: (keys, obj) => TransformedObject;string[]
snakeCaseObjectKeys: PartialTransformFunction;packages/server-client/dist/lib/client.d.ts:11
addAuthenticationToRequest(request): Promise<VetchOptions>Adds the appropriate authentication headers or parameters to the request based on the authentication type.
The request options to which authentication needs to be added.
Promise<VetchOptions>
- The request options with the added authentication.
Client.addAuthenticationToRequest
packages/server-client/dist/lib/client.d.ts:43
protected addBasicAuthToRequest(request): Promise<VetchOptions>Adds basic authentication headers to the request.
The request options to which authentication needs to be added.
Promise<VetchOptions>
- The request options with the added authentication.
packages/server-client/dist/lib/client.d.ts:71
protected addJWTToRequest(request): Promise<VetchOptions>Adds a JWT to the request.
The request options to which authentication needs to be added.
Promise<VetchOptions>
- The request options with the added authentication.
packages/server-client/dist/lib/client.d.ts:64
protected addQueryKeySecretToRequest(request): Promise<VetchOptions>Adds API key and secret to the request.
The request options to which authentication needs to be added.
Promise<VetchOptions>
- The request options with the added authentication.
Client.addQueryKeySecretToRequest
packages/server-client/dist/lib/client.d.ts:57
protected addQueryKeySecretToRequestBody(request): Promise<VetchOptions>Adds API key and secret to the request body.
The request options to which authentication needs to be added.
Promise<VetchOptions>
- The request options with the added authentication.
Client.addQueryKeySecretToRequestBody
packages/server-client/dist/lib/client.d.ts:50
getConfig(): ConfigParamspackages/server-client/dist/lib/client.d.ts:36
protected parseResponse<T>(request, response): Promise<VetchResponse<T>>Parses the response based on its content type.
• T
The expected type of the parsed response data.
The request options.
Response
The raw response from the request.
Promise<VetchResponse<T>>
- The parsed response.
packages/server-client/dist/lib/client.d.ts:168
protected prepareBody(request): undefined | stringPrepares the body for the request based on the content type.
The request options.
undefined | string
- The prepared request body as a string or undefined.
packages/server-client/dist/lib/client.d.ts:158
protected prepareRequest(request): Promise<VetchOptions>Prepares the request with necessary headers, authentication, and query parameters.
The initial request options.
Promise<VetchOptions>
- The modified request options.
packages/server-client/dist/lib/client.d.ts:151
send(params?): Promise<SMSMessages>Sends an SMS message using the legacy Vonage SMS API.
The parameters for the SMS message.
Promise<SMSMessages>
A Promise that resolves to the response containing details about the sent SMS messages.
If all SMS messages fail to send.
If some SMS messages fail to send.
const response = await smsClient.send({
to: TO_NUMBER,
from: FROM_NUMBER,
text: 'Hello from Vonage SMS API',
});
console.log(`Number of messages sent: ${response.messageCount}`););sendDeleteRequest<T>(url): Promise<VetchResponse<T>>Sends a DELETE request to the specified URL.
• T
string
The URL endpoint for the DELETE request.
Promise<VetchResponse<T>>
- The response from the DELETE request.
packages/server-client/dist/lib/client.d.ts:78
sendFormSubmitRequest<T>(url, payload?): Promise<VetchResponse<T>>Sends a POST request with form data to the specified URL.
• T
string
The URL endpoint for the POST request.
Record<string, undefined | string>
Optional payload containing form data to send with the POST request.
Promise<VetchResponse<T>>
- The response from the POST request.
packages/server-client/dist/lib/client.d.ts:86
sendGetRequest<T>(url, queryParams?): Promise<VetchResponse<T>>Sends a GET request to the specified URL with optional query parameters.
• T
string
The URL endpoint for the GET request.
Optional query parameters to append to the URL. These should be compatible with Node's URLSearchParams.
Promise<VetchResponse<T>>
- The response from the GET request.
packages/server-client/dist/lib/client.d.ts:94
sendPatchRequest<T>(url, payload?): Promise<VetchResponse<T>>Sends a PATCH request to the specified URL with an optional payload.
• T
string
The URL endpoint for the PATCH request.
Optional payload to be sent as the body of the PATCH request.
Promise<VetchResponse<T>>
- The response from the PATCH request.
packages/server-client/dist/lib/client.d.ts:104
sendPostRequest<T>(url, payload?): Promise<VetchResponse<T>>Sends a POST request to the specified URL with an optional payload.
• T
string
The URL endpoint for the POST request.
Optional payload to be sent as the body of the POST request.
Promise<VetchResponse<T>>
- The response from the POST request.
packages/server-client/dist/lib/client.d.ts:114
sendPutRequest<T>(url, payload?): Promise<VetchResponse<T>>Sends a PUT request to the specified URL with an optional payload.
• T
string
The URL endpoint for the PUT request.
Optional payload to be sent as the body of the PUT request.
Promise<VetchResponse<T>>
- The response from the PUT request.
packages/server-client/dist/lib/client.d.ts:124
sendRequest<T>(request): Promise<VetchResponse<T>>Sends a request adding necessary headers, handling authentication, and parsing the response.
• T
The options defining the request, including URL, method, headers, and data.
Promise<VetchResponse<T>>
- The parsed response from the request.
packages/server-client/dist/lib/client.d.ts:144
sendRequestWithData<T>(
method,
url,
payload?): Promise<VetchResponse<T>>Sends a request with JSON-encoded data to the specified URL using the provided HTTP method.
• T
The HTTP method to be used for the request (only POST, PATCH, or PUT are acceptable).
POST | PUT | PATCH
string
The URL endpoint for the request.
Optional payload to be sent as the body of the request, JSON-encoded.
Promise<VetchResponse<T>>
- The response from the request.
packages/server-client/dist/lib/client.d.ts:135
verifySignature(
signature,
params,
signatureSecret,
algorithm): booleanVerifies the signature of a request using the specified algorithm and signature secret.
string
The signature to be verified.
Record<string, string>
The request parameters used to generate the signature.
string
The secret key used for generating the signature.
The algorithm used for generating the signature.
boolean
true if the signature is valid, false otherwise.
This will not parse the request parameters from the request object, so you will need to do that yourself.
If the provided signature algorithm is not supported.
const params = Object.assign(request.query, request.body);
const { sig } = params;
sms.verifySignature(
sig,
{}, // request parameters
VONAGE_API_SIGNATURE_SECRET,
AlgorithmTypes.md5hash,
) === params.sig) {
console.log("Valid signature");
} else {
console.log("Invalid signature");
}Class representing a failure response when sending SMS messages.
Extends the built-in Error class and provides methods for accessing and handling failed SMS messages.
Error
new SMSFailure(message, response): SMSFailureCreates an instance of SMSFailure.
string
The error message.
The response containing details about the SMS messages.
Error.constructor
packages/sms/lib/classes/Error/SMSFailure.ts:21
optional cause: unknown;Error.cause
node_modules/typescript/lib/lib.es2022.error.d.ts:24
message: string;Error.message
node_modules/typescript/lib/lib.es5.d.ts:1077
name: string;Error.name
node_modules/typescript/lib/lib.es5.d.ts:1076
protected response: SMSMessages;The response containing details about the SMS messages.
packages/sms/lib/classes/Error/SMSFailure.ts:13
optional stack: string;Error.stack
node_modules/typescript/lib/lib.es5.d.ts:1078
static optional prepareStackTrace: (err, stackTraces) => any;Optional override for formatting stack traces
Error
CallSite[]
any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Error.prepareStackTrace
node_modules/@types/node/globals.d.ts:143
static stackTraceLimit: number;Error.stackTraceLimit
node_modules/@types/node/globals.d.ts:145
getFailedMessages(): ErrorMessage[]Retrieves an array of failed messages in the response.
An array of failed messages in the response.
packages/sms/lib/classes/Error/SMSFailure.ts:40
getMessages(): ErrorMessage & SMSMessageResponse & object[]Retrieves an array of all messages in the response.
ErrorMessage & object[]
An array of all messages in the response.
packages/sms/lib/classes/Error/SMSFailure.ts:31
getResponse(): SMSMessagesRetrieves the original response containing details about the SMS messages.
The original response containing details about the SMS messages.
packages/sms/lib/classes/Error/SMSFailure.ts:51
getSuccessfulMessages(): Message[]Retrieves an array of successfully sent messages in the response.
Message[]
An array of successfully sent messages in the response.
packages/sms/lib/classes/Error/SMSFailure.ts:60
static captureStackTrace(targetObject, constructorOpt?): voidCreate .stack property on a target object
object
Function
void
Error.captureStackTrace
node_modules/@types/node/globals.d.ts:136
type DeliveryReceipt: object;Interface representing a delivery receipt for an SMS message.
Describes the structure of a delivery receipt containing information about the message's delivery status.
optional apiKey: string;The API key that sent the SMS (optional).
optional clientRef: string;Your client reference for the message (optional).
optional errCode: string;The status of the request (optional).
optional messageId: string;The Vonage ID for this message (optional).
optional messageTimestamp: string;The time when Vonage started to push this Delivery Receipt to your webhook endpoint (optional).
optional msisdn: string;The recipient's phone number in E.164 format (optional).
optional networkCode: string;The Mobile Country Code Mobile Network Code (MCCMNC) of the carrier (optional).
optional nonce: string;A random string forming part of the signed set of parameters for validation (optional).
optional price: string;The cost of the message (optional).
optional scts: string;When the Delivery Receipt was received from the carrier in YYMMDDHHMM format (optional).
optional sig: string;The hash of the request parameters, a timestamp, and the signature secret (optional).
optional status: string;A code explaining the message's delivery status (optional).
optional timestamp: string;A Unix timestamp representation of 'messageTimestamp' (optional).
optional to: string;The SenderID set in the 'from' field of the request (optional).
packages/sms/lib/types/Responses/DeliveryReceipt.ts:6
type ErrorMessage: object;Interface representing an error message.
Describes the structure of an error message containing status and error text.
optional errorText: string;The error text providing details about the error (optional).
optional status: string;The status code indicating the error (optional).
packages/sms/lib/types/ErrorMessage.ts:6
type InboundMessage: object;Interface representing an inbound SMS message.
Describes the structure of an inbound SMS message, including its properties and details.
api-key: string;The Vonage API Key of the receiving account.
concat: string;Indicates whether this is a concatenated message.
concat-part: string;The number of this part in the concatenated message.
concat-ref: string;The transaction reference for concatenated messages.
concat-total: string;The total number of parts in this concatenated message.
data: string;The content of this message, if the type is binary.
keyword: string;The first word in the message body, converted to uppercase.
message-timestamp: string;The time when Vonage started to push this Inbound SMS to your webhook endpoint.
messageId: string;The unique ID of the inbound message.
msisdn: string;The phone number that this inbound message was sent from in E.164 format.
nonce: string;A random string that forms part of the signed set of parameters for validation.
text: string;The message body for this inbound message.
timestamp: string;A Unix timestamp representation of 'message-timestamp'.
to: string;The phone number the message was sent to (virtual number) in E.164 format.
type: TypeEnum | string;The format of the message body.
udh: string;The hex encoded User Data Header, if the type is binary.
packages/sms/lib/types/InboundMessage.ts:8
type Message: SMSMessageResponse & object;Type representing an SMS message.
Extends the structure of an SMS message response and includes additional optional properties.
optional accountRef: string;An optional string used to identify separate accounts using the SMS endpoint for billing purposes (optional).
optional clientRef: string;Your client reference for the message (optional).
optional messageId: string;The unique ID of the SMS message (optional).
optional messagePrice: string;The estimated cost of the SMS message (optional).
optional remainingBalance: string;Your estimated remaining balance after sending the SMS (optional).
packages/sms/lib/types/Message.ts:8
type SendSMSResponse: SMSResponse;Deprecated type alias for SMSResponse.
Please use SMSResponse instead.
Use SMSResponse instead.
packages/sms/lib/types/Responses/SendSMSResponse.ts:10
type SMSEmptyResponse: object;Deprecated interface for an empty SMS response.
optional errorCode: string;The error code, if applicable (optional).
optional errorCodeLabel: string;A label for the error code, if provided (optional).
There is no substitution for this interface.
packages/sms/lib/types/Responses/SMSEmptyResponse.ts:6
type SMSGeneralResponse: SMSResponse;Deprecated type alias for SMSResponse.
Please use SMSResponse instead.
Use SMSResponse instead.
packages/sms/lib/types/Responses/SMSGeneralResponse.ts:10
type SMSMessageResponse: object;Interface representing an SMS message response.
Describes the structure of a response containing information about an SMS message's status and details.
optional account-ref: string;An optional string used to identify separate accounts using the SMS endpoint for billing purposes (optional).
optional client-ref: string;Your client reference for the message (optional).
message-id: string;The unique ID of the SMS message.
message-price: string;The estimated cost of the SMS message.
network: string;The estimated ID of the network of the recipient.
remaining-balance: string;Your estimated remaining balance after sending the SMS.
status: SMSStatus;The status of the SMS message.
to: string;The recipient's phone number in E.164 format.
packages/sms/lib/types/Responses/SMSMessageResponse.ts:7
type SMSMessages: SMSResponse & object;Interface representing an SMS response containing multiple messages, including errors.
Extends the structure of an SMS response and includes additional properties for message count and an array of messages, which can include both valid messages and error messages.
messageCount: number;The count of messages included in the response.
messages: Message & ErrorMessage[];An array of messages, which can include both valid messages and error messages.
packages/sms/lib/types/SMSMessages.ts:13
type SMSParams: object;Type representing parameters for sending an SMS.
Describes the structure of parameters that can be used when sending an SMS, including sender, recipient, message content, and additional options.
optional accountRef: string;An optional string used to identify separate accounts using the SMS endpoint for billing purposes (optional).
optional body: string;The binary body of the message (optional).
optional callback: string;The webhook callback URL for receiving delivery receipts (optional).
optional clientRef: string;Your client reference for the message (optional).
optional contentId: string;An optional content ID for regulatory requirements (optional).
optional entityId: string;An optional entity ID for regulatory requirements (optional).
from: string;The sender's phone number or name.
optional messageClass: MessageClassEnum;The message class (optional).
optional protocolId: number;The protocol identifier for binary messages (optional).
optional statusReportReq: boolean;Indicates if a delivery receipt is requested (optional).
optional text: string;The text content of the SMS message (optional).
optional title: string;The title of the message (optional).
to: string;The recipient's phone number in E.164 format.
optional ttl: number;The time-to-live (TTL) duration in milliseconds for delivery attempts (optional).
optional type: TypeEnum;The format of the message body (optional).
optional udh: string;The User Data Header (UDH) for binary messages (optional).
optional url: string;The URL for WAP Push messages (optional).
optional validity: string;The validity period of the message (optional).
packages/sms/lib/types/SMSParams.ts:9
type SMSRequestBody: object;Interface representing the request body for sending an SMS.
Describes the structure of the request body used when sending an SMS message.
optional body: string;Hex-encoded binary data (optional).
callback?: string;The webhook endpoint for the delivery receipt (optional).
client_ref?: string;Your own reference for the message (optional).
optional client-ref: string;Your own reference for the message (optional).
optional content-id: string;A string parameter for regulatory requirements (optional).
optional entity-id: string;A string parameter for regulatory requirements (optional).
from: string;The Alphanumeric senderID (if supported for the destination) or virtual number (specified in E.164 format) that the SMS is being sent from.
message_class?: number;The Data Coding Scheme value of the message (optional).
optional message-class: MessageClassEnum;The Data Coding Scheme value of the message (optional).
optional protocol-id: number;The value of the protocol identifier to use (optional).
optional status-report-req: boolean;Boolean indicating if a Delivery Receipt is requested (optional).
optional text: string;The body of the message being sent (optional).
to: string;The recipient's phone number in E.164 format.
ttl?: number;The duration in milliseconds for delivery attempts (optional).
type?: TypeEnum;The format of the message body (optional).
udh?: string;Custom Hex-encoded User Data Header (optional).
packages/sms/lib/types/Requests/SMSRequestBody.ts:8
type SMSResponse: object;Interface representing an SMS response.
Describes the structure of a response containing information about SMS messages or error messages.
message-count: number;The count of messages included in the response.
messages: SMSMessageResponse[] | SMSErrorMessageResponse[];An array of SMS message responses or SMS error message responses.
packages/sms/lib/types/Responses/SMSResponse.ts:9
const COLLECTION_FORMATS: object;Collection Formats for API Parameter Serialization.
Defines various collection formats used for serializing API parameters.
csv: string = ',';Comma-separated values collection format.
pipes: string = '|';Pipe-separated values collection format.
ssv: string = ' ';Space-separated values collection format.
tsv: string = '\t';Tab-separated values collection format.