Server Calling - Create Call

Referência

Serviço:: Communication

Versão da API:: 2022-04-07-preview

Crie uma chamada de saída.

POST {endpoint}/calling/callConnections?api-version=2022-04-07-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (url)	O ponto de extremidade do recurso de Comunicação do Azure.
api-version	query	True	string	Versão da API a ser invocada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Repeatability-Request-ID		string (uuid)	Se especificado, o cliente direciona que a solicitação seja repetível; ou seja, que o cliente pode fazer a solicitação várias vezes com a mesma RepetiçãoRequest-Id e obter uma resposta apropriada sem que o servidor execute a solicitação várias vezes. O valor daRequest-Id de Repetição é uma cadeia de caracteres opaca que representa um identificador exclusivo gerado pelo cliente para a solicitação. É uma UUID versão 4 (aleatória).
Repeatability-First-Sent		string	Se o cabeçalho repeatability-Request-ID for especificado, o cabeçalhoFirst-Sent de repetição também deverá ser especificado. O valor deve ser a data e a hora em que a solicitação foi criada pela primeira vez, expressa usando a forma fixada pelo FMI de data HTTP. Exemplo: Dom, 06 Nov 1994 08:49:37 GMT.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
callbackUri	True	string	O URI de retorno de chamada.
source	True	CallSource	A origem da chamada.
targets	True	CommunicationIdentifierModel[]	Os destinos da chamada.
mediaStreamingConfiguration		MediaStreamingConfiguration	Configuração de Streaming de Mídia.
operationContext		string	Um valor de conjunto de clientes usado para acompanhar o atendimento de uma chamada.

Respostas

Nome	Tipo	Description
201 Created	CallConnectionProperties	Retorna a resposta de criação de chamada.
Other Status Codes	CommunicationErrorResponse	Erro

Exemplos

Create an outbound call.

Solicitação de exemplo

HTTP

POST https://contoso.communications.azure.com/calling/callConnections?api-version=2022-04-07-preview

{
  "source": {
    "identifier": {
      "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"
      }
    }
  ],
  "operationContext": "Reminder call",
  "callbackUri": "https://app.contoso.com/callback",
  "mediaStreamingConfiguration": {
    "transportUrl": "wss://contoso.websocket.server/",
    "transportType": "websocket",
    "contentType": "audio",
    "audioChannelType": "mixed"
  }
}

Resposta de exemplo

Código de status:: 201

{
  "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
  "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA",
  "source": {
    "callerId": {
      "value": "+18440123456"
    },
    "identifier": {
      "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"
      }
    },
    {
      "kind": "phoneNumber",
      "phoneNumber": {
        "value": "+14250123456"
      }
    }
  ],
  "callConnectionState": "connected",
  "callbackUri": "https://app.contoso.com/callback",
  "mediaSubscriptionId": "6431f20a-1235-4a74-j632-asas8h6f999s"
}

Definições

Nome	Description
CallConnectionProperties	Propriedades de uma conexão de chamada
CallConnectionStateModel	O estado da conexão de chamada.
CallSource	O chamador.
CommunicationCloudEnvironmentModel
CommunicationError
CommunicationErrorResponse	A resposta de erro dos Serviços de Comunicação
CommunicationIdentifierModel
CommunicationIdentifierModelKind	Tipo de CommunicationIdentifierModel.
CommunicationUserIdentifierModel
CreateCallRequest	O conteúdo da solicitação para criar a chamada.
MediaStreamingAudioChannelType	Tipo de canal de áudio a ser transmitido, por exemplo. áudio sem mistura, áudio misto
MediaStreamingConfiguration	Configuração do streaming de mídia.
MediaStreamingContentType	Tipo de conteúdo a ser transmitido, por exemplo. áudio, áudio/vídeo
MediaStreamingTransportType	O tipo de transporte a ser usado para streaming de mídia, por exemplo. Websocket
MicrosoftTeamsUserIdentifierModel
PhoneNumberIdentifierModel

CallConnectionProperties

Objeto

Propriedades de uma conexão de chamada

Nome	Tipo	Description
callConnectionId	string	A ID da conexão de chamada.
callConnectionState	CallConnectionStateModel	O estado da conexão de chamada.
callbackUri	string	O URI de retorno de chamada.
mediaSubscriptionId	string	SubscriptionId para streaming de mídia
serverCallId	string	A ID da chamada do servidor.
source	CallSource	A origem da chamada, que é o chamador.
targets	CommunicationIdentifierModel[]	Os destinos da chamada.

CallConnectionStateModel

Enumeração

O estado da conexão de chamada.

Valor	Description
connected
connecting
disconnected
disconnecting
transferAccepted
transferring
unknown

CallSource

Objeto

O chamador.

Nome	Tipo	Description
callerId	PhoneNumberIdentifierModel	A ID do chamador de origem, um número de telefone, que é mostrado para o participante PSTN que está sendo convidado. Necessário somente ao chamar um destinatário de chamada PSTN.
displayName	string	Nome de exibição da chamada se estiver discando para um número pstn
identifier	CommunicationIdentifierModel	O identificador da origem da chamada

CommunicationCloudEnvironmentModel

Enumeração

Valor	Description
dod
gcch
public

CommunicationError

Objeto

Nome	Tipo	Description
code	string
details	CommunicationError[]
innererror	CommunicationError
message	string
target	string

CommunicationErrorResponse

Objeto

A resposta de erro dos Serviços de Comunicação

Nome	Tipo	Description
error	CommunicationError

CommunicationIdentifierModel

Objeto

Nome	Tipo	Description
communicationUser	CommunicationUserIdentifierModel	O usuário de comunicação.
kind	CommunicationIdentifierModelKind	Tipo de CommunicationIdentifierModel.
microsoftTeamsUser	MicrosoftTeamsUserIdentifierModel	O usuário do Microsoft Teams.
phoneNumber	PhoneNumberIdentifierModel	O número de telefone.
rawId	string	ID completa do identificador.

CommunicationIdentifierModelKind

Enumeração

Tipo de CommunicationIdentifierModel.

Valor	Description
communicationUser
microsoftTeamsUser
phoneNumber
unknown

CommunicationUserIdentifierModel

Objeto

Nome	Tipo	Description
id	string

CreateCallRequest

Objeto

O conteúdo da solicitação para criar a chamada.

Nome	Tipo	Description
callbackUri	string	O URI de retorno de chamada.
mediaStreamingConfiguration	MediaStreamingConfiguration	Configuração de Streaming de Mídia.
operationContext	string	Um valor de conjunto de clientes usado para acompanhar o atendimento de uma chamada.
source	CallSource	A origem da chamada.
targets	CommunicationIdentifierModel[]	Os destinos da chamada.

MediaStreamingAudioChannelType

Enumeração

Tipo de canal de áudio a ser transmitido, por exemplo. áudio sem mistura, áudio misto

Valor	Description
mixed
unmixed

MediaStreamingConfiguration

Objeto

Configuração do streaming de mídia.

Nome	Tipo	Description
audioChannelType	MediaStreamingAudioChannelType	Tipo de canal de áudio a ser transmitido, por exemplo. áudio sem mistura, áudio misto
contentType	MediaStreamingContentType	Tipo de conteúdo a ser transmitido, por exemplo. áudio, áudio/vídeo
transportType	MediaStreamingTransportType	O tipo de transporte a ser usado para streaming de mídia, por exemplo. Websocket
transportUrl	string	URL de transporte para streaming de mídia

MediaStreamingContentType

Enumeração

Tipo de conteúdo a ser transmitido, por exemplo. áudio, áudio/vídeo

Valor	Description
audio

MediaStreamingTransportType

Enumeração

O tipo de transporte a ser usado para streaming de mídia, por exemplo. Websocket

Valor	Description
websocket

MicrosoftTeamsUserIdentifierModel

Objeto

Nome	Tipo	Description
cloud	CommunicationCloudEnvironmentModel
isAnonymous	boolean
userId	string

PhoneNumberIdentifierModel

Objeto

Nome	Tipo	Description
value	string

Compartilhar via

Server Calling - Create Call

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Exemplos

Create an outbound call.

Solicitação de exemplo

Resposta de exemplo

Definições

CallConnectionProperties

CallConnectionStateModel

CallSource

CommunicationCloudEnvironmentModel

CommunicationError

CommunicationErrorResponse

CommunicationIdentifierModel

CommunicationIdentifierModelKind

CommunicationUserIdentifierModel

CreateCallRequest

MediaStreamingAudioChannelType

MediaStreamingConfiguration

MediaStreamingContentType

MediaStreamingTransportType

MicrosoftTeamsUserIdentifierModel

PhoneNumberIdentifierModel