Azure Communication Services - Phone Numbers client library samples for TypeScript

These sample programs show how to use the TypeScript client libraries for Azure Communication Services - Phone Numbers in some common scenarios.

File Name Description
getPurchasedPhoneNumber.ts Get a purchased phone number.
getPurchasedPhoneNumbers.ts Get a list of all purchased phone numbers.
purchasePhoneNumber.ts Search for a toll-free phone number then purchase it.
releasePhoneNumber.ts Release a purchased phone number.
updatePhoneNumberCapabilities.ts Update the capabilities of a purchased phone number.


The sample programs are compatible with Node.js >=12.0.0.

Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the TypeScript documentation. Install the TypeScript compiler using:

npm install -g typescript

You need an Azure subscription and the following Azure resources 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.


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

  1. Install the dependencies using npm:
npm install
  1. Compile the samples:
npm run build
  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 dist/getPurchasedPhoneNumber.ts

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):

npx cross-env COMMUNICATION_SAMPLES_CONNECTION_STRING="<communication samples connection string>" PHONE_NUMBER_TO_GET="<phone number to get>" AZURE_PHONE_NUMBER="<azure phone number>" node dist/getPurchasedPhoneNumber.js

Next Steps

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