@azure-tools/communication-toll-free-verification v1.0.0-alpha.20230223.1
Azure Communication Toll Free Verification client library for JavaScript
The Toll Free Verification library provides capabilities for Campaign Brief administration.
Getting started
Prerequisites
- An Azure subscription.
- An existing Communication Services resource. If you need to create the resource, you can use the Azure Portal, the Azure PowerShell, or the Azure CLI.
Installing
npm install @azure-tools/communication-toll-free-verification
Browser support
JavaScript Bundle
To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our bundling documentation.
Key concepts
Examples
Authentication
To create a client object to access the Communication Services API, you will need a connection string
or the endpoint
of your Communication Services resource and a credential
. The Toll Free Verification client can use either Azure Active Directory credentials or an API key credential to authenticate.
You can get a key and/or connection string from your Communication Services resource in the Azure Portal. You can also find the endpoint for your Communication Services resource in the Azure Portal.
Once you have a key, you can authenticate the TollFreeVerificationClient
with any of the following methods:
Using a connection string
const { TollFreeVerificationClient } = require("@azure-tools/communication-toll-free-verification");
const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
const client = new TollFreeVerificationClient(connectionString);
Using an access key with AzureKeyCredential
If you use a key to initialize the client you will also need to provide the appropriate endpoint. You can get this endpoint from your Communication Services resource in Azure Portal. Once you have a key and endpoint, you can authenticate with the following code:
const { AzureKeyCredential } = require("@azure/core-auth");
const { TollFreeVerificationClient } = require("@azure-tools/communication-toll-free-verification");
const credential = new AzureKeyCredential("<key-from-resource>");
const client = new TollFreeVerificationClient("<endpoint-from-resource>", credential);
Using an Azure Active Directory Credential
Connection string authentication is used in most of the examples, but you can also authenticate with Azure Active Directory using the Azure Identity library. To use the DefaultAzureCredential provider shown below, or other credential providers provided with the Azure SDK, please install the @azure/identity
package:
npm install @azure/identity
The @azure/identity
package provides a variety of credential types that your application can use to do this. The README for @azure/identity
provides more details and samples to get you started.
const { DefaultAzureCredential } = require ("@azure/identity");
const { TollFreeVerificationClient } = require("@azure-tools/communication-toll-free-verification");
let credential = new DefaultAzureCredential();
const client = new TollFreeVerificationClient("<endpoint-from-resource>", credential);
Usage
The following sections provide code snippets that cover some of the common tasks using the Azure Communication Services Toll Free Verification client. The scenarios that are covered here consist of:
Get the current applied configuration
Use the getCampaignBrief
method to obtain the current applied configuration for your resource.
const { TollFreeVerificationClient } = require("@azure-tools/communication-toll-free-verification");
const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
const client = new TollFreeVerificationClient(connectionString);
// get a campaign brief
var campaignBrief = await client.getCampaignBrief("63215741-b596-4eb4-a9c0-b2905ce22cb0", "US");
console.log(campaignBrief);
Troubleshooting
Next steps
Please take a look at the samples directory for detailed examples on how to use this library.
Contributing
If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.
Related projects
2 days ago
7 days ago
9 days ago
12 days ago
13 days ago
14 days ago
15 days ago
16 days ago
1 month ago
2 months ago
3 months ago
3 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
6 months ago
6 months ago
6 months ago
5 months ago
6 months ago
6 months ago
6 months ago
7 months ago
9 months ago
7 months ago
7 months ago
7 months ago
9 months ago
9 months ago
8 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago