Megosztás a következőn keresztül:

Azure Communication Administration ügyfélkódtár JavaScripthez – 1.0.0-beta.3-es verzió

A felügyeleti kódtár a felhasználók és a jogkivonatok Azure Communication Services kezelésére szolgál. Ez a kódtár a telefonszámok felügyeletére is alkalmas.

A beszerzett telefonszámok számos funkcióval rendelkezhetnek, az országtól, a számtípustól és a telefoncsomagtól függően. Ilyen például az SMS bejövő és kimenő használata, a PSTN bejövő és kimenő használata. A telefonszámok webhook URL-címen keresztül is hozzárendelhetők a robothoz.

Első lépések

Előfeltételek

Telepítés

npm install @azure/communication-administration

Fő fogalmak

Ügyfelek

A felügyeleti csomag két ügyfelet tesz elérhetővé. A CommunicationIdentityClient a felhasználók és jogkivonataik kezelésére szolgáló módszereket biztosít. A PhoneNumberAdministrationClient segítségével kezelheti a telefoncsomagokat és a telefonszámokat.

Telefonos csomagok áttekintése

A telefoncsomagok kétféle típusúak; Földrajzi és ingyenes. A földrajzi telefoncsomagok egy helyhez társított telefoncsomagok, amelyek telefonszámainak körzetszámai egy földrajzi hely körzetszámához vannak társítva. Toll-Free telefoncsomagok nem társított telefoncsomagok. Az USA-ban például az ingyenesen hívható számok tartalmazhatnak olyan körzetszámokat, mint a 800 vagy a 888.

Az ugyanazon országon belüli összes földrajzi telefoncsomag egy földrajzi telefonszámtípusú telefoncsomag-csoportba van csoportosítva. Az ugyanazon országon belüli összes Toll-Free telefoncsomag telefoncsomag-csoportba van csoportosítva.

Számok keresése és beszerzése

A telefonszámok a keresési létrehozási API-val kereshetők a telefoncsomag azonosítójának, a körzetszámnak és a telefonszámok mennyiségének megadásával. A megadott mennyiségű telefonszám tíz percig lesz fenntartva. A telefonszámok keresése megszakítható vagy megvásárolható. Ha a keresés megszakad, akkor a telefonszámok elérhetővé válnak mások számára. Ha a keresés meg van vásárolva, akkor a rendszer beszerzi a telefonszámokat az Azure-erőforrásokhoz.

Számok konfigurálása és hozzárendelése

A telefonszámok hozzárendelhetők egy visszahívási URL-címhez a configure number API-val. A konfiguráció részeként szüksége lesz egy beszerzett telefonszámra, visszahívási URL-címre és alkalmazásazonosítóra.

Példák

Hitelesítés

Kulcs és/vagy kapcsolati sztring az Azure Portalon található Communication Services-erőforrásból szerezheti be. Miután rendelkezik egy kulccsal, a és PhoneNumberAdministrationClient a CommunicationIdentityClient hitelesítését az alábbi módszerek bármelyikével végezheti el:

Létrehozás KeyCredential az AzureKeyCredential ügyfél inicializálása előtt

import { AzureKeyCredential } from "@azure/core-auth";
import { CommunicationIdentityClient } from "@azure/communication-administration";

const credential = new AzureKeyCredential(KEY);
const client = new CommunicationIdentityClient(HOST, credential);

Kapcsolati sztring használata

import { PhoneNumberAdministrationClient } from "@azure/communication-administration";

const connectionString = `endpoint=HOST;accessKey=KEY`;
const client = new CommunicationIdentityClient(connectionString);

Ha kulcs használatával inicializálja az ügyfelet, meg kell adnia a megfelelő végpontot is. Ezt a végpontot a Communication Services-erőforrásból szerezheti be az Azure Portalon.

Használat

CommunicationIdentityClient

A CommunicationIdentityClient példányának létrehozása

import { CommunicationIdentityClient } from "@azure/communication-administration";

const client = new CommunicationIdentityClient(CONNECTION_STRING);

Új felhasználó létrehozása

createUser A metódus használatával hozzon létre egy új felhasználót.

const user = await client.createUser();

Felhasználói jogkivonat létrehozása és frissítése

A metódussal issueToken kibocsáthat vagy frissíthet egy jogkivonatot egy meglévő felhasználó számára. A metódus a kommunikációs jogkivonat hatóköreinek listáját is felveszi. A hatókör beállításai a következők:

  • chat (Csevegés)
  • pstn (Nyilvános telefonhálózat)
  • voip (Hangátviteli IP-cím)
let { token } = await client.issueToken(user, ["chat"]);

A felhasználói jogkivonat frissítéséhez állíts ki egy másik jogkivonatot ugyanazzal a felhasználóval.

{ token } = await client.issueToken(user, ["chat"]);

Felhasználó jogkivonatainak visszavonása

A metódussal revokeTokens visszavonhatja egy felhasználó összes kibocsátott jogkivonatát.

await client.revokeTokens(user);

revokeTokens egy nem kötelező második argumentumot vesz fel, tokensValidFroma következőt: . Ha ez a dátum meg van adva, revokeTokens visszavonja az előtte kiadott összes jogkivonatot. Ellenkező esetben a rendszer minden jogkivonatot visszavon.

Felhasználó törlése

A metódussal deleteUser törölhet egy felhasználót.

await client.deleteUser(user);

PhoneNumberAdministrationClient

A PhoneNumberAdministrationClient példányának létrehozása

import { CommunicationIdentityClient } from "@azure/communication-administration";

const client = new CommunicationIdentityClient(CONNECTION_STRING);

Országok lekérése

A metódussal listSupportedCountries lekérheti a támogatott országok listáját.

const countries = await client.listSupportedCountries();

for await (const country of countries) {
  console.log(`Country code: ${country.countryCode}`);
  console.log(`Country name: ${country.localizedName}`);
}

Telefonos csomagcsoportok lekérése

A telefonos csomagcsoportok kétféle típusúak: földrajzi és ingyenes. A metódus használatával listPhonePlanGroups kérje le őket.

const countryCode = "US";
const phonePlanGroups = await client.listPhonePlanGroups(countryCode);

for await (const phonePlanGroup of phonePlanGroups) {
  console.log(`Phone plan group id: ${phonePlanGroup.phonePlanGroupId}`);
}

Helybeállítások beolvasása

Földrajzi telefoncsomagok esetén lekérdezheti az elérhető földrajzi helyeket. A helyek beállításai úgy vannak strukturálva, mint egy ország földrajzi hierarchiája. Az USA-ban például vannak államok, és az egyes államokon belül városok.

A metódussal getPhonePlanLocationOptions lekérheti a hely beállításait.

const { locationOptions } = await client.getPhonePlanLocationOptions({
  countryCode: "US",
  phonePlanGroupId: "phonePlanGroupId",
  phonePlanId: "phonePlanId"
});

console.log(`Got location options for: ${locationOptions.labelId}`);

Területkódok lekérése

A földrajzi telefoncsomagok területkódjainak beolvasásához a helybeállítások lekérdezéseinek megadása szükséges. Bele kell foglalnia a földrajzi helyek láncát, amely a által visszaadott getPhonePlanLocationOptionshelybeállítások objektumon halad át.

A módszer használatával getAreaCodes lekérheti a földrajzi telefoncsomagok körzetszámát.

const { primaryAreaCodes } = await client.getAreaCodes({
  locationType: "selection",
  countryCode: "US",
  phonePlanId: "phonePlanId",
  locationOptionsQueries
});

Telefonszámok lefoglalása vásárlásra

A metódus használatával beginReservePhoneNumbers keressen telefonszámokat, és foglalja le őket. Ez egy hosszú ideig futó művelet.

const reservePoller = await client.beginReservePhoneNumbers({
    name: "Phone number search 800",
    description: "Search for 800 phone numbers"
    phonePlanIds: ["phone-plan-id-1"],
    areaCode: "800",
    quantity: 3
});

A foglalás eredményeinek lekéréséhez használja a pollUntilDone létrehozott lekérdezés metódusát.

const phoneNumberReservation = await reservePoller.pollUntilDone();

A lekérdezést és a foglalást a létrehozott lekérdezési lekérdezés metódusának meghívásával cancelOperation mondhatja le.

await reservePoller.cancelOperation();

Telefonszámok vásárlása foglalásból

Ezzel a beginPurchasePhoneNumbers módszerrel vásárolhatja meg a telefonszámokat a foglalásból. A reservationId visszaadott érték beginReservePhoneNumbers megadása kötelező. beginPurchasePhoneNumbers hosszú ideig futó művelet.

const { reservationId } = phoneNumberReservation;
const purchasePoller = await client.beginPurchasePhoneNumbers(reservationId);

A vásárlás eredményeinek lekéréséhez használja a pollUntilDone létrehozott vásárlási poller metódusát.

const results = await purchasePoller.pollUntilDone();

Hibaelhárítás

Következő lépések

A kódtár használatára vonatkozó részletes példákért tekintse meg a mintakönyvtárat.

Közreműködés

Ha hozzá szeretne járulni ehhez a kódtárhoz, olvassa el a közreműködői útmutatót , amelyből többet is megtudhat a kód buildeléséhez és teszteléséhez.

Megjelenések

  • Last updated on