Azure client library for Azure Communication Messages Services client library samples for JavaScript

Browse code

These sample programs show how to use the JavaScript client libraries for Azure client library for Azure Communication Messages Services in some common scenarios.

File Name Description
DownloadMedia.js Download a media file
GetMessageTemplateList.js Get Template list for a channel
SendAudioMessage.js Send a audio message
SendDocumentMessage.js Send a document message
SendImageMessage.js Send an image message
SendTemplateMessage.js Send a template message
SendTextMessage.js Send a text message
SendTextTemplateMessageUsingAAD.js Use AAD token credentials when sending a whatsapp template message.
[SendVideoMessage.js][sendvideomessage] Send a video message

Prerequisites

The sample programs are compatible with LTS versions of Node.js.

You need an Azure subscription to run these sample programs.

Samples retrieve credentials to access the service endpoint from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function.

Adapting the samples to run in the browser may require some additional consideration. For details, please see the package README.

Setup

To run the samples using the published version of the package:

  1. Install the dependencies using npm:
npm install

  1. Edit the file sample.env, adding the correct credentials to access the Azure service and run the samples. Then rename the file from sample.env to just .env. The sample programs will read this file automatically.

  2. Run whichever samples you like (note that some samples may require additional setup, see the table above):

node DownloadMedia.js

Alternatively, run a single sample with the correct environment variables set (setting up the .env file is not required if you do this), for example (cross-platform):

cross-env ACS_ACCESS_KEY="<acs access key>" ACS_URL="<acs url>" node DownloadMedia.js

Next Steps

Take a look at our API Documentation for more information about the APIs that are available in the clients.