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

Communication Identity - Issue Access Token

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

Выдача нового маркера для удостоверения.

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

Параметры URI

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

string (url)

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

string

Идентификатор удостоверения для выдачи маркера.
api-version
 query True

string

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

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

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

CommunicationIdentityTokenScope[]

Список областей, подключенных к маркеру.
expiresInMinutes

integer (int32)

minimum: 60
maximum: 1440

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

Ответы

Имя Тип Описание
200 OK

CommunicationIdentityAccessToken

Успех
Other Status Codes

CommunicationErrorResponse

Ошибка

Примеры

Issue an access token. Optionally specify a custom expiration time within the [60-1440] minutes range. In case an expiration time is not specified, the default value of 1440 minutes (24 hours) will be used.

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

POST https://my-resource.communication.azure.com/identities/8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081/:issueAccessToken?api-version=2025-06-30

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

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

Код состояния:
200 
{
  "token": "token",
  "expiresOn": "2025-07-10T21:39:39.3244584+00:00"
}

Определения

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

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

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

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

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

CommunicationError

Object

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

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

string

Код ошибки.
details

CommunicationError[]

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

CommunicationError

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

string

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

string

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

CommunicationErrorResponse

Object

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

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

CommunicationError

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

CommunicationIdentityAccessToken

Object

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

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

string (date-time)

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

string

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

CommunicationIdentityAccessTokenRequest

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

integer (int32)

minimum: 60
maximum: 1440 		1440

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

CommunicationIdentityTokenScope[]

Список областей, подключенных к маркеру.

CommunicationIdentityTokenScope

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

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

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

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

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

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

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

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