Identificatoren begrijpen

Microsoft Teams-gebruiker

De MicrosoftTeamsUserIdentifier-interface vertegenwoordigt een Teams-gebruiker met zijn Microsoft Entra-gebruikersobject-ID. U kunt de object-id van Microsoft Entra-gebruikers ophalen via de Microsoft Graph REST API/gebruikerseindpunt van de id eigenschap in het antwoord. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph. U kunt de id ook vinden als claim oid in een Microsoft Entra-token of Microsoft Entra-toegangstoken nadat uw gebruiker zich heeft aangemeld en een token heeft verkregen.

Basaal gebruik

// get the Teams user's ID from Graph APIs if only the email is known
const user = await graphClient.api("/users/bob@contoso.com").get();

// create an identifier
const teamsUser = { microsoftTeamsUserId: user.id };

// if you're not operating in the public cloud, you must also pass the right Cloud type.
const gcchTeamsUser = { microsoftTeamsUserId: userId, cloud: "gcch" };

API-verwijzing

Telefoonnummer

De PhoneNumberIdentifier interface vertegenwoordigt een telefoonnummer. De service gaat ervan uit dat telefoonnummers zijn opgemaakt in E.164-indeling.

Basaal gebruik

// create an identifier
const phoneNumber = { phoneNumber: "+112345556789" };

API-verwijzing

Microsoft Teams-toepassing

De MicrosoftTeamsAppIdentifier interface vertegenwoordigt een bot van de Teams Voice-toepassingen zoals Oproepwachtrij en Auto Attendant met de object-id van de Microsoft Entra-bot. De Teams-toepassingen moeten worden geconfigureerd met een resourceaccount. U kunt de object-id van de Microsoft Entra-bot ophalen via de Microsoft Graph REST API/gebruikerseindpunt van de id eigenschap in het antwoord. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph.

Basaal gebruik

// Get the Microsoft Teams App's ID from Graph APIs
const users = await graphClient.api("/users")
                    .filter(filterConditions)
                    .select('displayName,id')
                    .get();
//Here we assume that you have a function getBotFromUsers that gets the bot from the returned response
const bot = getBotFromUsers(users);
// Create an identifier
const teamsAppIdentifier = { teamsAppId: bot.id };

// If you're not operating in the public cloud, you must also pass the right Cloud type.
const gcchTeamsAppIdentifier = { teamsAppId: id, cloud: "gcch" };

API-verwijzing

Teams-extensiegebruiker

De TeamsExtensionUserIdentifier interface vertegenwoordigt een Teams-gebruiker die is ingeschakeld voor de uitbreidbaarheid van Teams-telefoons. A TeamsExtensionUserIdentifier vereist de Microsoft Entra-gebruikersobject-id van de Teams-gebruiker, de Tenant-id van Microsoft Entra waar de gebruiker zich bevindt en de Resource-id van Azure Communication Services. U kunt de Microsoft Entra-gebruikersobject-id ophalen via de Microsoft Graph REST API /users endpoint van de id eigenschap in de response, en de Microsoft Entra-tenant-id via de Microsoft Graph REST API /organization endpoint van de id eigenschap in de response. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph. U kunt de object-id ook vinden als de oid claim en de tenant-id als de tid claim in een Microsoft Entra-token of Microsoft Entra-toegangstoken nadat uw gebruiker zich heeft aangemeld en een token heeft verkregen.

Basaal gebruik

// get the Teams user's ID from Graph APIs if only the email is known
const user = await graphClient.api("/users/bob@contoso.com").get();

// Get the tenantId from Graph API
const org = await graphClient.api("/organization").get();
const tenantId = org.value[0].id;

//Communication Services Resource ID
const resourceId = "<resource-id-guid>";

// create an identifier
const teamsExtensionUser = { userId: user.id, tenantId: tenantId, resourceId: resourceId };

// if you're not operating in the public cloud, you must also pass the right Cloud type.
const gcchTeamsExtensionUser = { userId: user.id, tenantId: tenantId, resourceId: resourceId, cloud: "gcch" };

API-verwijzing

Onbekend

De UnknownIdentifier interface bestaat voor toekomstbestendig maken en u kunt deze tegenkomen wanneer u een oude versie van de SDK gebruikt en er onlangs een nieuw id-type wordt geïntroduceerd. Een onbekende identifier van de service wordt gedeserialiseerd als UnknownIdentifier in de SDK.

Basaal gebruik

// create an identifier
const unknownId = { id: "a raw id that originated in the service" };

API-verwijzing

Hoe de basisinterface `CommunicationIdentifier` te verwerken

Terwijl u id's maakt voor een concreet type dat u in de SDK doorgeeft, retourneert de SDK een CommunicationIdentifierKind, wat een gediscrimineerde samenvoeging is. Het is eenvoudig om te beperken tot een concreet type en we raden een switch-case-instructie aan met patroonkoppeling:

switch (communicationIdentifier.kind)
{
    case "communicationUser":
        // TypeScript has narrowed communicationIdentifier to be a CommunicationUserKind
        console.log(`Communication user: ${communicationIdentifier.communicationUserId}`);
        break;
    case "microsoftTeamsUser":
        // narrowed to MicrosoftTeamsUserKind
        console.log(`Teams user: ${communicationIdentifier.microsoftTeamsUserId}`);
        break;
    case "microsoftTeamsApp":
        // narrowed to MicrosoftTeamsAppIdentifier
        console.log(`Teams app: ${communicationIdentifier.teamsAppId}`);
        break;
    case "phoneNumber":
         // narrowed to PhoneNumberKind
        console.log(`Phone number: ${communicationIdentifier.phoneNumber}`);
        break;
    case "unknown":
         // narrowed to UnknownIdentifierKind
        console.log(`Unknown: ${communicationIdentifier.id}`);
        break;
    default:
        // be careful here whether you want to throw because a new SDK version
        // can introduce new identifier types
        break;
}

De id-interfaces zijn zodanig ontworpen dat u kind niet hoeft te specificeren om de overvloed aan informatie te verminderen. Bovendien wordt de discriminerende samenvoeging met de kind eigenschap alleen gebruikt wanneer deze wordt geretourneerd door de SDK. Als u echter een id moet vertalen naar het bijbehorende discriminerende samenvoegtype, kunt u deze helper gebruiken:

const identifierKind = getIdentifierKind(identifier); // now you can switch-case on the kind

Onbewerkte id-weergave

Soms moet u een id serialiseren naar een platte tekenreeks. Als u bijvoorbeeld de id wilt opslaan in een databasetabel of als u deze wilt gebruiken als URL-parameter.

Voor dat doel hebben id's een andere weergave met de naam RawId. Een id kan altijd worden omgezet in de bijbehorende onbewerkte id en een geldige onbewerkte id kan altijd worden geconverteerd naar een id.

Omdat azure-communication-common@2.1.0 de SDK helpt bij de conversie:

// get an identifier's raw Id
const rawId = getIdentifierRawId(communicationIdentifier);

// create an identifier from a given raw Id
const identifier = createIdentifierFromRawId(rawId);

Een ongeldige onbewerkte id wordt geconverteerd naar UnknownIdentifier in de SDK en elke validatie vindt alleen plaats aan de servicezijde.

Communicatiegebruiker

De CommunicationUserIdentifier vertegenwoordigt een gebruikersidentiteit die is gemaakt met behulp van de Identity SDK of REST API. Dit is de enige id die wordt gebruikt als uw toepassing geen gebruik maakt van microsoft Teams-interoperabiliteits- of telefoniefuncties.

Basaal gebruik

// at some point you will have created a new user identity in your trusted service
CommunicationUserIdentifier newUser = await identityClient.CreateUser();

// and then send newUser.Id down to your client application
// where you can again create an identifier for the user
var sameUser = new CommunicationUserIdentifier(newUserId);

API-verwijzing

Microsoft Teams-gebruiker

De MicrosoftTeamsUserIdentifier vertegenwoordigt een Teams-gebruiker met de microsoft Entra-gebruikersobject-id. U kunt de object-id van Microsoft Entra-gebruikers ophalen via de Microsoft Graph REST API/gebruikerseindpunt van de id eigenschap in het antwoord. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph. U kunt de id ook vinden als de oid claim in een Microsoft Entra-token of Microsoft Entra-toegangstoken nadat u zich hebt aangemeld en een token hebt verkregen.

Basaal gebruik

// get the Teams user's ID from Graph APIs if only the email is known
var user = await graphClient.Users["bob@contoso.com"]
    .Request()
    .GetAsync();

// create an identifier
var teamsUser = new MicrosoftTeamsUserIdentifier(user.Id);

// if you're not operating in the public cloud, you must also pass the right Cloud type.
var gcchTeamsUser = new MicrosoftTeamsUserIdentifier(userId: userId, cloud: CommunicationCloudEnvironment.Gcch);

API-verwijzing

Telefoonnummer

Het PhoneNumberIdentifier vertegenwoordigt een telefoonnummer. De service gaat ervan uit dat telefoonnummers zijn opgemaakt in E.164-indeling.

Basaal gebruik

// create an identifier
var phoneNumber = new PhoneNumberIdentifier("+112345556789");

API-verwijzing

Microsoft Teams-toepassing

De MicrosoftTeamsAppIdentifier interface vertegenwoordigt een bot van de Teams Voice-toepassingen zoals Oproepwachtrij en Auto Attendant met de object-id van de Microsoft Entra-bot. De Teams-toepassingen moeten worden geconfigureerd met een resourceaccount. U kunt de object-id van de Microsoft Entra-bot ophalen via de Microsoft Graph REST API/gebruikerseindpunt van de id eigenschap in het antwoord. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph.

Basaal gebruik

// Get the Microsoft Teams App's ID from Graph APIs
var users = await graphClient.Users.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Select = new string []{ "displayName","id" };
	requestConfiguration.QueryParameters.Filter = filterConditions;
});

// Here we assume that you have a function GetBotFromUsers that gets the bot from the returned response
var bot = GetBotFromUsers(users);

// Create an identifier
var teamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.Id);

// If you're not operating in the public cloud, you must also pass the right Cloud type.
var gcchTeamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.Id, CommunicationCloudEnvironment.Gcch);

API-verwijzing

Teams-extensiegebruiker

De TeamsExtensionUserIdentifier interface vertegenwoordigt een Teams-gebruiker die is ingeschakeld voor de uitbreidbaarheid van Teams-telefoons. A TeamsExtensionUserIdentifier vereist de Microsoft Entra-gebruikersobject-id van de Teams-gebruiker, de Tenant-id van Microsoft Entra waar de gebruiker zich bevindt en de Resource-id van Azure Communication Services. U kunt de Microsoft Entra-gebruikersobject-id ophalen via de Microsoft Graph REST API /users endpoint van de id eigenschap in de response, en de Microsoft Entra-tenant-id via de Microsoft Graph REST API /organization endpoint van de id eigenschap in de response. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph. U kunt de object-id ook vinden als de oid claim en de tenant-id als de tid claim in een Microsoft Entra-token of Microsoft Entra-toegangstoken nadat uw gebruiker zich heeft aangemeld en een token heeft verkregen.

Basaal gebruik

// get the Teams user's ID from Graph APIs if only the email is known
var user = await graphClient.Users["bob@contoso.com"]
    .Request()
    .GetAsync();

// Get the tenantId from Graph API
var organization = await graphClient.Organization
    .Request()
    .GetAsync();

string tenantId = organization.CurrentPage.FirstOrDefault()?.Id;

//Communication Services Resource ID
var resourceId = "<resource-id-guid>";

// create an identifier
var teamsExtensionUser = new TeamsExtensionUserIdentifier(user.Id, tenantId, resourceId);

// if you're not operating in the public cloud, you must also pass the right Cloud type.
var gcchTeamsExtensionUser = new TeamsExtensionUserIdentifier(userId: user.Id, tenantId: tenantId, resourceId: resourceId, cloud: CommunicationCloudEnvironment.Gcch);

API-verwijzing

Onbekend

Het UnknownIdentifier bestaat voor toekomstbestendig maken en u kunt deze tegenkomen wanneer u een oude versie van de SDK gebruikt en er onlangs een nieuw id-type wordt geïntroduceerd. Een onbekende identifier van de service wordt gedeserialiseerd als UnknownIdentifier in de SDK.

Basaal gebruik

// create an identifier
var unknown = new UnknownIdentifier("a raw id that originated in the service");

API-verwijzing

Hoe je de basisklasse `CommunicationIdentifier` afhandelt

Terwijl u id's maakt voor een concreet type dat u in de SDK doorgeeft, retourneert de SDK het CommunicationIdentifier protocol. Het is eenvoudig om down te casten naar een specifiek type en we raden een switch-case-instructie aan met pattern matching:

switch (communicationIdentifier)
{
    case CommunicationUserIdentifier communicationUser:
        Console.WriteLine($"Communication user: {communicationUser.Id}");
        break;
    case MicrosoftTeamsUserIdentifier teamsUser:
        Console.WriteLine($"Teams user: {teamsUser.UserId}");
        break;
    case MicrosoftTeamsAppIdentifier teamsApp:
        Console.WriteLine($"Teams app: {teamsApp.AppId}");
        break;
    case PhoneNumberIdentifier phoneNumber:
        Console.WriteLine($"Phone number: {phoneNumber.PhoneNumber}");
        break;
    case UnknownIdentifier unknown:
        Console.WriteLine($"Unknown: {unknown.Id}");
        break;
    default:
        // be careful here whether you want to throw because a new SDK version
        // can introduce new identifier types
        break;
}

Onbewerkte id-weergave

Soms moet u een id serialiseren naar een platte tekenreeks. Als u bijvoorbeeld de id wilt opslaan in een databasetabel of als u deze wilt gebruiken als URL-parameter.

Voor dat doel hebben id's een andere weergave met de naam RawId. Een id kan altijd worden omgezet in de bijbehorende onbewerkte id en een geldige onbewerkte id kan altijd worden geconverteerd naar een id.

Omdat Azure.Communication.Common 1.2.0 de SDK helpt bij de conversie:

// get an identifier's raw Id
string rawId = communicationIdentifier.RawId;

// create an identifier from a given raw Id
CommunicationIdentifier identifier = CommunicationIdentifier.FromRawId(rawId);

Een ongeldige onbewerkte id wordt geconverteerd naar UnknownIdentifier in de SDK en elke validatie vindt alleen plaats aan de servicezijde.

Communicatiegebruiker

De CommunicationUserIdentifier vertegenwoordigt een gebruikersidentiteit die is gemaakt met behulp van de Identity SDK of REST API. Dit is de enige id die wordt gebruikt als uw toepassing geen gebruik maakt van microsoft Teams-interoperabiliteits- of telefoniefuncties.

Basaal gebruik

# at some point you will have created a new user identity in your trusted service
new_user = identity_client.create_user()

# and then send new_user.properties['id'] down to your client application
# where you can again create an identifier for the user
same_user = CommunicationUserIdentifier(new_user_id)

API-verwijzing

Microsoft Teams-gebruiker

De MicrosoftTeamsUserIdentifier vertegenwoordigt een Teams-gebruiker met de microsoft Entra-gebruikersobject-id. U kunt de object-id van Microsoft Entra-gebruikers ophalen via de Microsoft Graph REST API/gebruikerseindpunt van de id eigenschap in het antwoord. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph. U kunt de id ook vinden als de oid claim in een Microsoft Entra-token of Microsoft Entra-toegangstoken nadat u zich hebt aangemeld en een token hebt verkregen.

Basaal gebruik

# get the Teams user's ID from Graph APIs if only the email is known
user_id = graph_client.get("/users/bob@contoso.com").json().get("id");

# create an identifier
teams_user = MicrosoftTeamsUserIdentifier(user_id)

# if you're not operating in the public cloud, you must also pass the right Cloud type.
gcch_teams_user = MicrosoftTeamsUserIdentifier(user_id, cloud=CommunicationCloudEnvironment.GCCH)

API-verwijzing

Telefoonnummer

Het PhoneNumberIdentifier vertegenwoordigt een telefoonnummer. De service gaat ervan uit dat telefoonnummers zijn opgemaakt in E.164-indeling.

Basaal gebruik

# create an identifier
phone_number = PhoneNumberIdentifier("+112345556789")

API-verwijzing

Microsoft Teams-toepassing

De MicrosoftTeamsAppIdentifier interface vertegenwoordigt een bot van de Teams Voice-toepassingen zoals Oproepwachtrij en Auto Attendant met de object-id van de Microsoft Entra-bot. De Teams-toepassingen moeten worden geconfigureerd met een resourceaccount. U kunt de object-id van de Microsoft Entra-bot ophalen via de Microsoft Graph REST API/gebruikerseindpunt van de id eigenschap in het antwoord. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph.

Basaal gebruik

# Get the Microsoft Teams App's ID from Graph APIs
users = graph_client.get("/users").json()

# Here we assume that you have a function get_bot_from_users that gets the bot from the returned response
bot = get_bot_from_users(users);

# Create an identifier
teams_app_identifier = MicrosoftTeamsAppIdentifier(app_id=bot.get("id"))

# If you're not operating in the public cloud, you must also pass the right Cloud type.
gcch_teams_app_identifier = MicrosoftTeamsAppIdentifier(
            app_id=bot.get("id"),
            cloud=CommunicationCloudEnvironment.GCCH
        )

API-verwijzing

Teams-extensiegebruiker

De TeamsExtensionUserIdentifier interface vertegenwoordigt een Teams-gebruiker die is ingeschakeld voor de uitbreidbaarheid van Teams-telefoons. A TeamsExtensionUserIdentifier vereist de Microsoft Entra-gebruikersobject-id van de Teams-gebruiker, de Tenant-id van Microsoft Entra waar de gebruiker zich bevindt en de Resource-id van Azure Communication Services. U kunt de Microsoft Entra-gebruikersobject-id ophalen via de Microsoft Graph REST API /users endpoint van de id eigenschap in de response, en de Microsoft Entra-tenant-id via de Microsoft Graph REST API /organization endpoint van de id eigenschap in de response. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph. U kunt de object-id ook vinden als de oid claim en de tenant-id als de tid claim in een Microsoft Entra-token of Microsoft Entra-toegangstoken nadat uw gebruiker zich heeft aangemeld en een token heeft verkregen.

Basaal gebruik

# get the Teams user's ID from Graph APIs if only the email is known
user_id = graph_client.get("/users/bob@contoso.com").json().get("id");

# get the tenantId from Graph API
tenant_id = graph_client.get("/organization").json()["value"][0]["id"]

# Communication Services Resource ID
resourceId = "<resource-id-guid>"

# create an identifier
teams_user = TeamsExtensionUserIdentifier(user_id, tenant_id, resource_id)

# if you're not operating in the public cloud, you must also pass the right Cloud type
gcch_teams_user = TeamsExtensionUserIdentifier(user_id, tenant_id, resource_id, cloud=CommunicationCloudEnvironment.GCCH)

API-verwijzing

Onbekend

Het UnknownIdentifier bestaat voor toekomstbestendig maken en u kunt deze tegenkomen wanneer u een oude versie van de SDK gebruikt en er onlangs een nieuw id-type wordt geïntroduceerd. Een onbekende id van de service wordt gedeserialiseerd naar de UnknownIdentifier SDK.

Basaal gebruik

# create an identifier
unknown = UnknownIdentifier("a raw id that originated in the service")

API-verwijzing

Hoe je de basisklasse `CommunicationIdentifier` afhandelt

Terwijl u id's maakt voor een concreet type dat u in de SDK doorgeeft, retourneert de SDK het CommunicationIdentifier protocol. Concrete identifierklassen zijn het CommunicationIdentifier-protocol en een getypte woordenlijst genaamd properties. U kunt dus patroonkoppeling gebruiken voor de exemplaarvariabele van kind het protocol om te vertalen naar het concrete type:

match communication_identifier.kind:
    case CommunicationIdentifierKind.COMMUNICATION_USER:
        print(f"Communication user: {communication_identifier.properties['id']}")
    case CommunicationIdentifierKind.MICROSOFT_TEAMS_USER:
        print(f"Teams user: {communication_identifier.properties['user_id']}")
    case CommunicationIdentifierKind.MICROSOFT_TEAMS_APP:
        print(f"Teams app: {communication_identifier.properties['app_id']}")
    case CommunicationIdentifierKind.PHONE_NUMBER:
        print(f"Phone number: {communication_identifier.properties['value']}")
    case CommunicationIdentifierKind.UNKNOWN:
        print(f"Unknown: {communication_identifier.raw_id}")
    case _:
        # be careful here whether you want to throw because a new SDK version
        # can introduce new identifier types

Onbewerkte id-weergave

Soms moet u een id serialiseren naar een platte tekenreeks. Als u bijvoorbeeld de id wilt opslaan in een databasetabel of als u deze wilt gebruiken als URL-parameter.

Voor dat doel hebben id's een andere weergave met de naam RawId. Een id kan altijd worden omgezet in de bijbehorende onbewerkte id en een geldige onbewerkte id kan altijd worden geconverteerd naar een id.

De SDK helpt bij de conversie:

# get an identifier's raw Id
raw_id = communication_identifier.raw_id

# create an identifier from a given raw Id
identifier = identifier_from_raw_id(raw_id)

Een ongeldige onbewerkte id wordt geconverteerd naar UnknownIdentifier in de SDK en elke validatie vindt alleen plaats aan de servicezijde.

Communicatiegebruiker

De CommunicationUserIdentifier vertegenwoordigt een gebruikersidentiteit die is gemaakt met behulp van de Identity SDK of REST API. Dit is de enige id die wordt gebruikt als uw toepassing geen gebruik maakt van microsoft Teams-interoperabiliteits- of telefoniefuncties.

Basaal gebruik

// at some point you will have created a new user identity in your trusted service
CommunicationUserIdentifier newUser = identityClient.CreateUser();

// and then send newUser.getId() down to your client application
// where you can again create an identifier for the user
var sameUser = new CommunicationUserIdentifier(newUserId);

API-verwijzing

Microsoft Teams-gebruiker

De MicrosoftTeamsUserIdentifier vertegenwoordigt een Teams-gebruiker met de microsoft Entra-gebruikersobject-id. U kunt de object-id van Microsoft Entra-gebruikers ophalen via de Microsoft Graph REST API/gebruikerseindpunt van de id eigenschap in het antwoord. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph. U kunt de id ook vinden als claim oid in een Microsoft Entra-token of Microsoft Entra-toegangstoken nadat uw gebruiker zich heeft aangemeld en een token heeft verkregen.

Basaal gebruik

// get the Teams user's ID from Graph APIs if only the email is known
var user = graphClient.users("bob@contoso.com")
    .buildRequest()
    .get();

// create an identifier
var teamsUser = new MicrosoftTeamsUserIdentifier(user.id);

// if you're not operating in the public cloud, you must also set the right Cloud type.
var gcchTeamsUser = new MicrosoftTeamsUserIdentifier(userId).setCloudEnvironment(CommunicationCloudEnvironment.GCCH);

API-verwijzing

Telefoonnummer

Het PhoneNumberIdentifier vertegenwoordigt een telefoonnummer. De service gaat ervan uit dat telefoonnummers zijn opgemaakt in E.164-indeling.

Basaal gebruik

// create an identifier
var phoneNumber = new PhoneNumberIdentifier("+112345556789");

API-verwijzing

Microsoft Teams-toepassing

De MicrosoftTeamsAppIdentifier interface vertegenwoordigt een bot van de Teams Voice-toepassingen zoals Oproepwachtrij en Auto Attendant met de object-id van de Microsoft Entra-bot. De Teams-toepassingen moeten worden geconfigureerd met een resourceaccount. U kunt de object-id van de Microsoft Entra-bot ophalen via de Microsoft Graph REST API/gebruikerseindpunt van de id eigenschap in het antwoord. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph.

Basaal gebruik

// Get the Microsoft Teams App's ID from Graph APIs
var user = graphClient.users()
	.buildRequest()
	.filter(filterConditions)
	.select("displayName,id")
	.get();

//Here we assume that you have a function getBotFromUsers that gets the bot from the returned response
var bot = getBotFromUsers(users);

// Create an identifier
var teamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.id);

// If you're not operating in the public cloud, you must also pass the right Cloud type.
var gcchTeamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.id, CommunicationCloudEnvironment.GCCH);

API-verwijzing

Teams-extensiegebruiker

De TeamsExtensionUserIdentifier interface vertegenwoordigt een Teams-gebruiker die is ingeschakeld voor de uitbreidbaarheid van Teams-telefoons. A TeamsExtensionUserIdentifier vereist de Microsoft Entra-gebruikersobject-id van de Teams-gebruiker, de Tenant-id van Microsoft Entra waar de gebruiker zich bevindt en de Resource-id van Azure Communication Services. U kunt de Microsoft Entra-gebruikersobject-id ophalen via de Microsoft Graph REST API /users endpoint van de id eigenschap in de response, en de Microsoft Entra-tenant-id via de Microsoft Graph REST API /organization endpoint van de id eigenschap in de response. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph. U kunt de object-id ook vinden als de oid claim en de tenant-id als de tid claim in een Microsoft Entra-token of Microsoft Entra-toegangstoken nadat uw gebruiker zich heeft aangemeld en een token heeft verkregen.

Basaal gebruik

// get the Teams user's ID from Graph APIs if only the email is known
var user = graphClient.users("bob@contoso.com")
    .buildRequest()
    .get();

// get the tenantId from Graph API
OrganizationCollectionPage organizations = graphClient.organization()
    .buildRequest()
    .get();
String tenantId = organizations.getCurrentPage().get(0).id;

// Communication Services Resource ID
var resourceId = "<resource-id-guid>";

// create an identifier
var teamsExtensionUser = new TeamsExtensionUserIdentifier(user.id, tenantId, resourceId);

// if you're not operating in the public cloud, you must also set the right Cloud type.
var gcchTeamsExtensionUser = new TeamsExtensionUserIdentifier(user.id, tenantId, resourceId).setCloudEnvironment(CommunicationCloudEnvironment.GCCH);

API-verwijzing

Onbekend

Het UnknownIdentifier bestaat voor toekomstbestendig maken en u kunt deze tegenkomen wanneer u een oude versie van de SDK gebruikt en er onlangs een nieuw id-type wordt geïntroduceerd. Een onbekende identifier van de service wordt gedeserialiseerd als UnknownIdentifier in de SDK.

Basaal gebruik

// create an identifier
var unknown = new UnknownIdentifier("a raw id that originated in the service");

API-verwijzing

Hoe je de basisklasse `CommunicationIdentifier` afhandelt

Terwijl u identificatoren maakt voor een concreet type dat u aan de SDK doorgeeft, retourneert de SDK de abstractie. U kunt terug casten naar een betontype:

if (communicationIdentifier instanceof CommunicationUserIdentifier) {
    System.out.println("Communication user: " + ((CommunicationUserIdentifier)communicationIdentifier).getId());
}
else if (communicationIdentifier instanceof MicrosoftTeamsUserIdentifier) {
    System.out.println("Teams user: " + ((MicrosoftTeamsUserIdentifier)communicationIdentifier).getUserId());
}
else if (communicationIdentifier instanceof  MicrosoftTeamsAppIdentifier) {
    Log.i(tag, "Teams app: " + (( MicrosoftTeamsAppIdentifier)communicationIdentifier).getAppId());
}
else if (communicationIdentifier instanceof PhoneNumberIdentifier) {
    System.out.println("Phone number: " + ((PhoneNumberIdentifier)communicationIdentifier).getPhoneNumber());
}
else if (communicationIdentifier instanceof UnknownIdentifier) {
    System.out.println("Unknown user: " + ((UnknownIdentifier)communicationIdentifier).getId());
}
else {
    // be careful here whether you want to throw because a new SDK version
        // can introduce new identifier types
}

Onbewerkte id-weergave

Soms moet u een id serialiseren naar een platte tekenreeks. Als u bijvoorbeeld de id wilt opslaan in een databasetabel of als u deze wilt gebruiken als URL-parameter.

Voor dat doel hebben id's een andere weergave met de naam RawId. Een id kan altijd worden omgezet in de bijbehorende onbewerkte id en een geldige onbewerkte id kan altijd worden geconverteerd naar een id.

Omdat azure-communication-common 1.2.0 de SDK helpt bij de conversie:

// get an identifier's raw Id
String rawId = communicationIdentifier.getRawId();

// create an identifier from a given raw Id
CommunicationIdentifier identifier = CommunicationIdentifier.fromRawId(rawId);

Een ongeldige onbewerkte id wordt geconverteerd naar UnknownIdentifier in de SDK en elke validatie vindt alleen plaats aan de servicezijde.

Communicatiegebruiker

De CommunicationUserIdentifier vertegenwoordigt een gebruikersidentiteit die is gemaakt met behulp van de Identity SDK of REST API. Dit is de enige id die wordt gebruikt als uw toepassing geen gebruik maakt van microsoft Teams-interoperabiliteits- of telefoniefuncties.

Basaal gebruik

// at some point you will have created a new user identity in your trusted service
// and send the new user id down to your client application
// where you can create an identifier for the user
let user = CommunicationUserIdentifier(newUserId)

API-verwijzing

Microsoft Teams-gebruiker

De MicrosoftTeamsUserIdentifier vertegenwoordigt een Teams-gebruiker met de microsoft Entra-gebruikersobject-id. U kunt de object-id van Microsoft Entra-gebruikers ophalen via de Microsoft Graph REST API/gebruikerseindpunt van de id eigenschap in het antwoord. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph. U kunt de id ook vinden als claim oid in een id-token of Microsoft Entra-toegangstoken nadat uw gebruiker zich heeft aangemeld en een token heeft verkregen.

Basaal gebruik

// get the Teams user's ID if only the email is known, assuming a helper method for the Graph API
let userId = await getUserIdFromGraph("bob@contoso.com")

// create an identifier
let teamsUser = MicrosoftTeamsUserIdentifier(userId: userId)

// if you're not operating in the public cloud, you must also pass the right Cloud type.
let gcchTeamsUser = MicrosoftTeamsUserIdentifier(userId: userId, cloud: CommunicationCloudEnvironment.Gcch)

API-verwijzing

Telefoonnummer

Het PhoneNumberIdentifier vertegenwoordigt een telefoonnummer. De service gaat ervan uit dat telefoonnummers zijn opgemaakt in E.164-indeling.

Basaal gebruik

// create an identifier
let phoneNumber = PhoneNumberIdentifier(phoneNumber: "+112345556789")

API-verwijzing

Microsoft Teams-toepassing

De MicrosoftTeamsAppIdentifier interface vertegenwoordigt een bot van de Teams Voice-toepassingen zoals Oproepwachtrij en Auto Attendant met de object-id van de Microsoft Entra-bot. De Teams-toepassingen moeten worden geconfigureerd met een resourceaccount. U kunt de object-id van de Microsoft Entra-bot ophalen via de Microsoft Graph REST API/gebruikerseindpunt van de id eigenschap in het antwoord. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph.

Basaal gebruik

// Get the Microsoft Teams App's ID from Graph APIs, assuming a helper method for the Graph API
let botId = await getBotIdFromGraph()

// Create an identifier
let teamsAppIdentifier = MicrosoftTeamsAppIdentifier(appId: botId)

// If you're not operating in the public cloud, you must also pass the right Cloud type.
let gcchTeamsAppIdentifier = MicrosoftTeamsAppIdentifier(appId: botId, cloudEnvironment: CommunicationCloudEnvironment.Gcch)

API-verwijzing

Teams-extensiegebruiker

De TeamsExtensionUserIdentifier interface vertegenwoordigt een Teams-gebruiker die is ingeschakeld voor de uitbreidbaarheid van Teams-telefoons. A TeamsExtensionUserIdentifier vereist de Microsoft Entra-gebruikersobject-id van de Teams-gebruiker, de Tenant-id van Microsoft Entra waar de gebruiker zich bevindt en de Resource-id van Azure Communication Services. U kunt de Microsoft Entra-gebruikersobject-id ophalen via de Microsoft Graph REST API /users endpoint van de id eigenschap in de response, en de Microsoft Entra-tenant-id via de Microsoft Graph REST API /organization endpoint van de id eigenschap in de response. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph. U kunt de object-id ook vinden als de oid claim en de tenant-id als de tid claim in een Microsoft Entra-token of Microsoft Entra-toegangstoken nadat uw gebruiker zich heeft aangemeld en een token heeft verkregen.

Basaal gebruik

// get the Teams user's ID if only the email is known, assuming a helper method for the Graph API
let userId = await getUserIdFromGraph("bob@contoso.com")

// get the tenantId from Graph API
let tenantId = await getTenantIdFromGraph()

// Communication Services Resource ID
let resourceId = "<resource-id-guid>"

// create an identifier
let teamsExtensionUser = TeamsExtensionUserIdentifier(userId: userId, tenantId: tenantId, resourceId: resourceId)

// if you're not operating in the public cloud, you must also pass the right Cloud type.
let gcchTeamsExtensionUser = TeamsExtensionUserIdentifier(userId: userId, tenantId: tenantId, resourceId: resourceId, cloudEnvironment: CommunicationCloudEnvironment.Gcch)

API-verwijzing

Onbekend

Het UnknownIdentifier bestaat voor toekomstbestendig maken en u kunt deze tegenkomen wanneer u een oude versie van de SDK gebruikt en er onlangs een nieuw id-type wordt geïntroduceerd. Een onbekende identifier van de service wordt gedeserialiseerd als UnknownIdentifier in de SDK.

Basaal gebruik

// create an identifier
let unknown = UnknownIdentifier("a raw id that originated in the service")

API-verwijzing

Hoe je omgaat met het basisprotocol `CommunicationIdentifier`

Terwijl u id's maakt voor een concreet type dat u in de SDK doorgeeft, retourneert de SDK het CommunicationIdentifier protocol. Het is eenvoudig om terug te casten naar een concreet type en we raden een switch-case-instructie met pattern matching aan.

switch (communicationIdentifier)
{
    case let communicationUser as CommunicationUserIdentifier:
        print(#"Communication user: \(communicationUser.id)"#)
    case let teamsUser as MicrosoftTeamsUserIdentifier:
        print(#"Teams user: \(teamsUser.UserId)"#)
    case let teamsApp as MicrosoftTeamsAppIdentifier:
        print(#"Teams app: \(teamsApp.appId)"#)
    case let phoneNumber as PhoneNumberIdentifier:
        print(#"Phone number: \(phoneNumber.PhoneNumber)"#)
    case let unknown as UnknownIdentifier:
        print(#"Unknown: \(unknown.Id)"#)
    @unknown default:
        // be careful here whether you want to throw because a new SDK version
        // can introduce new identifier types
        break;
}

Onbewerkte id-weergave

Soms moet u een id serialiseren naar een platte tekenreeks. Als u bijvoorbeeld de id wilt opslaan in een databasetabel of als u deze wilt gebruiken als URL-parameter.

Voor dat doel hebben id's een andere weergave met de naam RawId. Een id kan altijd worden omgezet in de bijbehorende onbewerkte id en een geldige onbewerkte id kan altijd worden geconverteerd naar een id.

Omdat Azure.Communication.Common 1.1.0 de SDK helpt bij de conversie:

Snel

// get an identifier's raw Id
let rawId = communicationIdentifier.rawId;

// create an identifier from a given raw Id
let identifier = createCommunicationIdentifier(fromRawId: rawId);

Een ongeldige ruwe ID wordt geconverteerd naar een UnknownIdentifier in de SDK en elke validatie vindt alleen plaats aan de serverzijde.

Communicatiegebruiker

De CommunicationUserIdentifier vertegenwoordigt een gebruikersidentiteit die is gemaakt met behulp van de Identity SDK of REST API. Dit is de enige id die wordt gebruikt als uw toepassing geen gebruik maakt van microsoft Teams-interoperabiliteits- of telefoniefuncties.

Basaal gebruik

// at some point you will have created a new user identity in your trusted service
CommunicationUserIdentifier newUser = identityClient.CreateUser();

// and then send newUser.getId() down to your client application
// where you can again create an identifier for the user
CommunicationUserIdentifier sameUser = new CommunicationUserIdentifier(newUserId);

API-verwijzing

Microsoft Teams-gebruiker

De MicrosoftTeamsUserIdentifier vertegenwoordigt een Teams-gebruiker met de microsoft Entra-gebruikersobject-id. U kunt de object-id van Microsoft Entra-gebruikers ophalen via de Microsoft Graph REST API/gebruikerseindpunt van de id eigenschap in het antwoord. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph. U kunt de id ook vinden als claim oid in een id-token of Microsoft Entra-toegangstoken nadat uw gebruiker zich heeft aangemeld en een token heeft verkregen.

Basaal gebruik

// get the Teams user's ID from Graph APIs if only the email is known
User user = graphClient.users("bob@contoso.com")
    .buildRequest()
    .get();

// create an identifier
MicrosoftTeamsUserIdentifier teamsUser = new MicrosoftTeamsUserIdentifier(user.id);

// if you're not operating in the public cloud, you must also set the right Cloud type.
MicrosoftTeamsUserIdentifier gcchTeamsUser = new MicrosoftTeamsUserIdentifier(userId).setCloudEnvironment(CommunicationCloudEnvironment.GCCH);

API-verwijzing

Telefoonnummer

Het PhoneNumberIdentifier vertegenwoordigt een telefoonnummer. De service gaat ervan uit dat telefoonnummers zijn opgemaakt in E.164-indeling.

Basaal gebruik

// create an identifier
PhoneNumberIdentifier phoneNumber = new PhoneNumberIdentifier("+112345556789");

API-verwijzing

Microsoft Teams-toepassing

De MicrosoftTeamsAppIdentifier interface vertegenwoordigt een bot van de Teams Voice-toepassingen zoals Oproepwachtrij en Auto Attendant met de object-id van de Microsoft Entra-bot. Configureer de Teams-toepassingen met een resourceaccount. U kunt de object-id van de Microsoft Entra-bot ophalen via de Microsoft Graph REST API/gebruikerseindpunt van de id eigenschap in het antwoord. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph.

Basaal gebruik

// Get the Microsoft Teams App's ID from Graph APIs
UserCollectionPage users = graphClient.users()
	.buildRequest()
	.filter(filterConditions)
	.select("displayName,id")
	.get();

//Here we assume that you have a function getBotFromUsers that gets the bot from the returned response
User bot = getBotFromUsers(users);

// Create an identifier
MicrosoftTeamsAppIdentifier teamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.id);

// If you're not operating in the public cloud, you must also pass the right Cloud type.
MicrosoftTeamsAppIdentifier gcchTeamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.id, CommunicationCloudEnvironment.GCCH);

API-verwijzing

Teams-extensiegebruiker

De TeamsExtensionUserIdentifier interface vertegenwoordigt een Teams-gebruiker die is ingeschakeld voor de uitbreidbaarheid van Teams-telefoons. A TeamsExtensionUserIdentifier vereist de Microsoft Entra-gebruikersobject-id van de Teams-gebruiker, de Tenant-id van Microsoft Entra waar de gebruiker zich bevindt en de Resource-id van Azure Communication Services. U kunt de Microsoft Entra-gebruikersobject-id ophalen via de Microsoft Graph REST API /users endpoint van de id eigenschap in de response, en de Microsoft Entra-tenant-id via de Microsoft Graph REST API /organization endpoint van de id eigenschap in de response. Zie Graph Explorer en bekijk de Graph SDK voor meer informatie over het werken met Microsoft Graph. U kunt de object-id ook vinden als de oid claim en de tenant-id als de tid claim in een Microsoft Entra-token of Microsoft Entra-toegangstoken nadat uw gebruiker zich heeft aangemeld en een token heeft verkregen.

Basaal gebruik

// get the Teams user's ID from Graph APIs if only the email is known
User user = graphClient.users("bob@contoso.com")
    .buildRequest()
    .get();

// get the tenantId from Graph API
OrganizationCollectionPage organizations = graphClient.organization()
    .buildRequest()
    .get();
String tenantId = organizations.getCurrentPage().get(0).id;

// Communication Services Resource ID
var resourceId = "<resource-id-guid>";

// create an identifier
var teamsExtensionUser = new TeamsExtensionUserIdentifier(user.id, tenantId, resourceId);

// if you're not operating in the public cloud, you must also set the right Cloud type.
var gcchTeamsExtensionUser = new TeamsExtensionUserIdentifier(user.id, tenantId, resourceId).setCloudEnvironment(CommunicationCloudEnvironment.GCCH);

API-verwijzing

Onbekend

Het UnknownIdentifier bestaat voor toekomstbestendig maken en u kunt deze tegenkomen wanneer u een oude versie van de SDK gebruikt en er onlangs een nieuw id-type wordt geïntroduceerd. Een onbekende identifier van de service wordt gedeserialiseerd als UnknownIdentifier in de SDK.

Basaal gebruik

// create an identifier
UnknownIdentifier unknown = new UnknownIdentifier("a raw id that originated in the service");

API-verwijzing