Class SmsClient

Package version

A SmsClient represents a Client to the Azure Communication Sms service allowing you to send SMS messages.

Hierarchy

SmsClient

Index

Constructors

constructor

Methods

send

Constructors

constructor

new SmsClient(connectionString: string, options?: SmsClientOptions): SmsClient
new SmsClient(url: string, credential: KeyCredential, options?: SmsClientOptions): SmsClient

- Defined in smsClient.ts:72
Initializes a new instance of the SmsClient class.

Parameters
- connectionString: string
  
  Connection string to connect to an Azure Communication Service resource. Example: "endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret";
- Optional options: SmsClientOptions
  
  Optional. Options to configure the HTTP pipeline.
Returns SmsClient
- Defined in smsClient.ts:80
Initializes a new instance of the SmsClient class using an Azure KeyCredential.

Parameters
- url: string
  
  The endpoint of the service (ex: https://contoso.eastus.communications.azure.net).
- credential: KeyCredential
  
  An object that is used to authenticate requests to the service. Use the Azure KeyCredential or @azure/identity to create a credential.
- Optional options: SmsClientOptions
  
  Optional. Options to configure the HTTP pipeline.
Returns SmsClient

Methods

send

send(sendRequest: SendRequest, options?: SendOptions): Promise<RestResponse>

- Defined in smsClient.ts:130
Sends a SMS from a phone number that is acquired by the authenticated account, to another phone number.

Parameters
- sendRequest: SendRequest
  
  Provides the sender's and recipient's phone numbers, and the contents of the message
- Default value options: SendOptions = {}
  
  Additional request options
Returns Promise<RestResponse>

Generated using TypeDoc