Create Call - Create Call

Ссылка

Служба:: Communication

Версия API:: 2025-05-15

Создайте исходящий вызов.

POST {endpoint}/calling/callConnections?api-version=2025-05-15

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (url)	Конечная точка ресурса связи Azure.
api-version	query	True	string	Версия API для вызова.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Authorization	True	string	Маркер доступа пользователей служб коммуникации Azure.
Repeatability-Request-ID		string (uuid)	Если задано, клиент указывает, что запрос повторяется; т. е. клиент может несколько раз выполнять запрос с одной и той же повторяемостью,Request-Id и возвращать соответствующий ответ без выполнения запроса несколько раз. Значение повторяемостиRequest-Id является непрозрачной строкой, представляющей созданный клиентом уникальный идентификатор запроса. Это UUID версии 4 (случайный).
Repeatability-First-Sent		string (date-time-rfc1123)	Если задано значение "Повторяемость-Request-ID заголовка", необходимо также указать заголовок "Повторяемость-First-Sent". Значение должно быть датой и временем создания запроса, выраженным с помощью формы HTTP-даты, исправленной МВФ. Пример: Sun, 06 ноября 1994 08:49:37 GMT.

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

Имя	Обязательно	Тип	Описание
callbackUri	True	string	Универсальный код ресурса (URI) обратного вызова.
targets	True	CommunicationIdentifierModel[]	Целевые объекты вызова.
callIntelligenceOptions		CallIntelligenceOptions	Параметры искусственного интеллекта для вызова.
mediaStreamingOptions		MediaStreamingOptions: WebSocketMediaStreamingOptions	Параметры потоковой передачи мультимедиа.
operationContext		string	Значение набора клиента, используемое для отслеживания ответа на вызов.
source		CommunicationUserIdentifierModel
sourceCallerIdNumber		PhoneNumberIdentifierModel
sourceDisplayName		string	Отображаемое имя звонка при звонке по номеру ТСОП
transcriptionOptions		TranscriptionOptions: WebSocketTranscriptionOptions	Параметры транскрибирования.

Ответы

Имя	Тип	Описание
201 Created	CallConnectionProperties	Возвращает сведения о свойствах вызова после получения запроса CreateCall службой. Событие CallConnected будет получено по указанному URI обратного вызова после подключения.
Other Status Codes	CommunicationErrorResponse	Ошибка

Безопасность

Authorization

Маркер доступа пользователей служб коммуникации Azure.

Тип: apiKey
В: header

Примеры

CreateCall

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

HTTP

POST https://contoso.communications.azure.com/calling/callConnections?api-version=2025-05-15

{
  "targets": [
    {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9"
      }
    }
  ],
  "callbackUri": "https://app.contoso.com/callback",
  "operationContext": "string",
  "callIntelligenceOptions": {
    "cognitiveServicesEndpoint": "string"
  },
  "mediaStreamingOptions": {
    "audioChannelType": "mixed",
    "transportUrl": "string",
    "transportType": "websocket",
    "contentType": "audio",
    "startMediaStreaming": true,
    "enableBidirectional": true,
    "audioFormat": "pcm16KMono",
    "enableDtmfTones": true
  },
  "transcriptionOptions": {
    "locale": "en-US",
    "transportUrl": "string",
    "transportType": "websocket",
    "speechModelEndpointId": "string",
    "startTranscription": true,
    "enableIntermediateResults": true
  }
}

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

Код состояния:: 201

{
  "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
  "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA",
  "source": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
    }
  },
  "targets": [
    {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9"
      }
    }
  ],
  "callConnectionState": "connected",
  "callbackUri": "https://app.contoso.com/callback",
  "mediaStreamingSubscription": {
    "id": "23dea47f-b081-4107-9a5c-4300819d2caa",
    "state": "active",
    "subscribedContentTypes": [
      "audio"
    ]
  },
  "transcriptionSubscription": {
    "id": "45dea47f-b081-4107-9a5c-4300819d2caa",
    "state": "active",
    "subscribedResultTypes": [
      "final"
    ]
  },
  "answeredFor": {
    "value": "+11234567890"
  }
}

Определения

Имя	Описание
AudioFormat	Формат звука, используемый для кодирования, включая частоту дискретизации и тип канала. Значение по умолчанию — Pcm16KMono.
CallConnectionProperties	Свойства подключения к вызову
CallConnectionStateModel	Состояние подключения к вызову.
CallIntelligenceOptions	Параметры искусственного интеллекта для вызова.
CreateCallRequest	Полезные данные запроса для создания вызова.
MediaStreamingAudioChannelType	Тип аудиоканала для потоковой передачи, например, немикшированное аудио, смешанное аудио.
MediaStreamingContentType
MediaStreamingSubscription	Объект подписки потоковой передачи мультимедиа.
MediaStreamingSubscriptionState	Состояние подписки потоковой передачи мультимедиа.
StreamingTransportType	Определяет тип транспорта, используемого для потоковой передачи. Обратите внимание, что в будущем могут быть введены значения, которые в настоящее время не задокументированы.
TranscriptionResultType
TranscriptionSubscription	Объект подписки транскрибирования.
TranscriptionSubscriptionState	Состояние подписки транскрибирования.
WebSocketMediaStreamingOptions	Представляет варианты для транспорта WebSocket.
WebSocketTranscriptionOptions	Представляет варианты для транспорта WebSocket.

AudioFormat

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

Формат звука, используемый для кодирования, включая частоту дискретизации и тип канала. Значение по умолчанию — Pcm16KMono.

Значение	Описание
pcm16KMono
pcm24KMono

CallConnectionProperties

Object

Свойства подключения к вызову

Имя	Тип	Описание
answeredBy	CommunicationUserIdentifierModel
answeredFor	PhoneNumberIdentifierModel
callConnectionId	string	Идентификатор подключения вызова.
callConnectionState	CallConnectionStateModel	Состояние подключения к вызову.
callbackUri	string	Универсальный код ресурса (URI) обратного вызова.
correlationId	string	Идентификатор корреляции.
mediaStreamingSubscription	MediaStreamingSubscription	Состояние подписки потоковой передачи мультимедиа для вызова
serverCallId	string	Идентификатор вызова сервера.
source	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	Отображаемое имя звонка при вызове по номеру ТСОП.
targets	CommunicationIdentifierModel[]	Целевые объекты вызова.
transcriptionSubscription	TranscriptionSubscription	Подписка транскрибирования.

CallConnectionStateModel

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

Состояние подключения к вызову.

Значение	Описание
connected
connecting
disconnected
disconnecting
transferAccepted
transferring
unknown

CallIntelligenceOptions

Object

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

Имя	Тип	Описание
cognitiveServicesEndpoint	string	Идентификатор ресурса Cognitive Service, назначенного этому вызову.

CreateCallRequest

Object

Полезные данные запроса для создания вызова.

Имя	Тип	Описание
callIntelligenceOptions	CallIntelligenceOptions	Параметры искусственного интеллекта для вызова.
callbackUri	string	Универсальный код ресурса (URI) обратного вызова.
mediaStreamingOptions	MediaStreamingOptions: WebSocketMediaStreamingOptions	Параметры потоковой передачи мультимедиа.
operationContext	string	Значение набора клиента, используемое для отслеживания ответа на вызов.
source	CommunicationUserIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	Отображаемое имя звонка при звонке по номеру ТСОП
targets	CommunicationIdentifierModel[]	Целевые объекты вызова.
transcriptionOptions	TranscriptionOptions: WebSocketTranscriptionOptions	Параметры транскрибирования.

MediaStreamingAudioChannelType

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

Тип аудиоканала для потоковой передачи, например, немикшированное аудио, смешанное аудио.

Значение	Описание
mixed
unmixed

MediaStreamingContentType

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

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

MediaStreamingSubscription

Object

Объект подписки потоковой передачи мультимедиа.

Имя	Тип	Описание
id	string	Идентификатор подписки.
state	MediaStreamingSubscriptionState	Состояние подписки потоковой передачи мультимедиа.
subscribedContentTypes	MediaStreamingContentType[]	Подписанные типы контента потоковой передачи мультимедиа.

MediaStreamingSubscriptionState

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

Состояние подписки потоковой передачи мультимедиа.

Значение	Описание
active
disabled
inactive

StreamingTransportType

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

Определяет тип транспорта, используемого для потоковой передачи. Обратите внимание, что в будущем могут быть введены значения, которые в настоящее время не задокументированы.

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

TranscriptionResultType

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

Значение	Описание
final
intermediate

TranscriptionSubscription

Object

Объект подписки транскрибирования.

Имя	Тип	Описание
id	string	Идентификатор подписки.
locale	string	Указывает языковой стандарт, используемый для транскрипции, например, en-CA или en-AU.
state	TranscriptionSubscriptionState	Состояние подписки транскрибирования.
subscribedResultTypes	TranscriptionResultType[]	Подписанные типы результатов транскрибирования.

TranscriptionSubscriptionState

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

Состояние подписки транскрибирования.

Значение	Описание
active
disabled
inactive

WebSocketMediaStreamingOptions

Object

Представляет варианты для транспорта WebSocket.

Имя	Тип	Описание
audioChannelType	MediaStreamingAudioChannelType	Тип аудиоканала для потоковой передачи, например, немикшированное аудио, смешанное аудио.
audioFormat	AudioFormat	Формат звука, используемый для кодирования, включая частоту дискретизации и тип канала. Значение по умолчанию — Pcm16KMono.
contentType	MediaStreamingContentType
enableBidirectional	boolean	Значение, указывающее, включена ли двунаправленная потоковая передача.
enableDtmfTones	boolean	Значение, указывающее, следует ли выполнять потоковую передачу тональных сигналов DTMF.
startMediaStreaming	boolean	Значение, указывающее, должна ли потоковая передача мультимедиа начинаться сразу после ответа на вызов.
transportType	string: websocket	Определяет тип транспорта, используемого для потоковой передачи. Обратите внимание, что в будущем могут быть введены значения, которые в настоящее время не задокументированы.
transportUrl	string	Транспортный URL-адрес для потоковой передачи мультимедиа.

WebSocketTranscriptionOptions

Object

Представляет варианты для транспорта WebSocket.

Имя	Тип	Описание
enableIntermediateResults	boolean	Включает промежуточные результаты для транскрибированного распознавания речи.
locale	string	Указывает языковой стандарт, используемый для транскрипции, например, en-CA или en-AU.
speechModelEndpointId	string	Идентификатор развернутой пользовательской модели в формате GUID. GUID создается Azure Speech Studio, например a259c255-1cdw-4ed7-a693-dd58563b6f6a.
startTranscription	boolean	Указывает, следует ли начинать расшифровку сразу после ответа на вызов.
transportType	string: websocket	Определяет тип транспорта, используемого для потоковой передачи. Обратите внимание, что в будущем могут быть введены значения, которые в настоящее время не задокументированы.
transportUrl	string	URL-адрес, используемый для передачи транскрипции в реальном времени.

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

Create Call - Create Call

Параметры URI

Заголовок запроса

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

Ответы

Безопасность

Authorization

Примеры

CreateCall

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

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

Определения

AudioFormat

CallConnectionProperties

CallConnectionStateModel

CallIntelligenceOptions

CreateCallRequest

MediaStreamingAudioChannelType

MediaStreamingContentType

MediaStreamingSubscription

MediaStreamingSubscriptionState

StreamingTransportType

TranscriptionResultType

TranscriptionSubscription

TranscriptionSubscriptionState

WebSocketMediaStreamingOptions

WebSocketTranscriptionOptions