Поделиться через

Communication Identity - Create

Служба:
Communication
Версия API:
2025-06-30

Создайте новое удостоверение и при необходимости маркер доступа.

POST {endpoint}/identities?api-version=2025-06-30

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string (url)

Ресурс связи, например https://my-resource.communication.azure.com
api-version
 query True

string

Версия API для вызова.

Текст запроса

Имя Тип Описание
createTokenWithScopes

CommunicationIdentityTokenScope[]

Также создайте маркер доступа для созданного удостоверения.
expiresInMinutes

integer (int32)

minimum: 60
maximum: 1440

Необязательный срок действия маркера в пределах [60 1440] минут. Если это не указано, будет использоваться значение по умолчанию 1440 минут (24 часа).

Ответы

Имя Тип Описание
201 Created

CommunicationIdentityAccessTokenResult

Создано — возвращает созданное удостоверение.
Other Status Codes

CommunicationErrorResponse

Ошибка

Примеры

Create an Identity and optionally an access token with custom expiration time within the [60-1440] minutes range. If expiration time is not specified, the default value of 1440 minutes (24 hours) will be used.

Образец запроса

POST https://my-resource.communication.azure.com/identities?api-version=2025-06-30

{
  "createTokenWithScopes": [
    "chat",
    "voip",
    "chat.join",
    "chat.join.limited",
    "voip.join"
  ],
  "expiresInMinutes": 60
}

Пример ответа

Код состояния:
201 
{
  "identity": {
    "id": "8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081"
  },
  "accessToken": {
    "token": "token",
    "expiresOn": "2025-07-10T21:39:39.3244584+00:00"
  }
}

Определения

Имя Описание
CommunicationError

Ошибка служб коммуникации.
CommunicationErrorResponse

Ошибка служб коммуникации.
CommunicationIdentity

Удостоверение связи.
CommunicationIdentityAccessToken

Маркер доступа.
CommunicationIdentityAccessTokenResult

Удостоверение связи с маркером доступа.
CommunicationIdentityCreateRequest
CommunicationIdentityTokenScope

Список областей для маркера доступа.

CommunicationError

Object

Ошибка служб коммуникации.

Имя Тип Описание
code

string

Код ошибки.
details

CommunicationError[]

Дополнительные сведения об определенных ошибках, которые привели к этой ошибке.
innererror

CommunicationError

Внутренняя ошибка, если она есть.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

CommunicationErrorResponse

Object

Ошибка служб коммуникации.

Имя Тип Описание
error

CommunicationError

Ошибка служб коммуникации.

CommunicationIdentity

Object

Удостоверение связи.

Имя Тип Описание
id

string

Идентификатор удостоверения.

CommunicationIdentityAccessToken

Object

Маркер доступа.

Имя Тип Описание
expiresOn

string (date-time)

Время истечения срока действия маркера.
token

string

Маркер доступа, выданный для удостоверения.

CommunicationIdentityAccessTokenResult

Object

Удостоверение связи с маркером доступа.

Имя Тип Описание
accessToken

CommunicationIdentityAccessToken

Маркер доступа.
identity

CommunicationIdentity

Удостоверение связи.

CommunicationIdentityCreateRequest

Object
Имя Тип Default value Описание
createTokenWithScopes

CommunicationIdentityTokenScope[]

Также создайте маркер доступа для созданного удостоверения.
expiresInMinutes

integer (int32)

minimum: 60
maximum: 1440 		1440

Необязательный срок действия маркера в пределах [60 1440] минут. Если это не указано, будет использоваться значение по умолчанию 1440 минут (24 часа).

CommunicationIdentityTokenScope

Перечисление

Список областей для маркера доступа.

Значение Описание
chat

Используйте это для полного доступа к API чата.
voip

Используйте это для полного доступа к api-интерфейсам вызова.
chat.join

Доступ к API чата, но без авторизации для создания, удаления или обновления потоков чата.
chat.join.limited

Более ограниченная версия chat.join, которая не позволяет добавлять или удалять участников. Используйте эту область, если носитель маркеров не является полностью доверенным, например в гостевых сценариях.
voip.join

Доступ к api вызовам, но без авторизации для запуска новых вызовов.