Create Call - Create Call

Referentie

Service:: Communication

API-versie:: 2024-09-15

Maak een uitgaande oproep.

POST {endpoint}/calling/callConnections?api-version=2024-09-15

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string url	Het eindpunt van de Azure Communication-resource.
api-version	query	True	string	De versie van de API die moet worden aangeroepen.

Aanvraagkoptekst

Name	Vereist	Type	Description
Authorization	True	string	Een Azure Communication Services-toegangstoken voor gebruikers.
Repeatability-Request-ID		string uuid	Indien opgegeven, stuurt de client aan dat de aanvraag herhaalbaar is; dat wil gezegd dat de client de aanvraag meerdere keren kan indienen met dezelfde herhaalbaarheid-Request-Id en een geschikt antwoord kan krijgen zonder dat de server de aanvraag meerdere keren uitvoert. De waarde van de herhaalbaarheid-Request-Id is een ondoorzichtige tekenreeks die een door de client gegenereerde unieke id voor de aanvraag vertegenwoordigt. Het is een UUID van versie 4 (willekeurig).
Repeatability-First-Sent		string date-time-rfc1123	Als herhaalbaarheid-Request-ID koptekst is opgegeven, moet ookFirst-Sent header worden opgegeven. De waarde moet de datum en tijd zijn waarop de aanvraag voor het eerst is gemaakt, uitgedrukt in de vorm van de IMF-fixdate van HTTP-datum. Voorbeeld: Zon, 06 nov 1994 08:49:37 GMT.

Aanvraagbody

Name	Vereist	Type	Description
callbackUri	True	string	De callback-URI.
targets	True	CommunicationIdentifierModel[]	De doelen van de oproep.
callIntelligenceOptions		CallIntelligenceOptions	AI-opties voor de aanroep.
operationContext		string	Een door de klant ingestelde waarde die wordt gebruikt om het beantwoorden van een gesprek bij te houden.
source		CommunicationUserIdentifierModel
sourceCallerIdNumber		PhoneNumberIdentifierModel
sourceDisplayName		string	Weergavenaam van het gesprek als u naar een PSTN-nummer belt

Antwoorden

Name	Type	Description
201 Created	CallConnectionProperties	Retourneert details van de oproepeigenschappen zodra de CreateCall-aanvraag is ontvangen door de service. U ontvangt de gebeurtenis CallConnected op de opgegeven callback-URI zodra de oproep is verbonden.
Other Status Codes	CommunicationErrorResponse	Fout

Beveiliging

Authorization

Een Azure Communication Services-toegangstoken voor gebruikers.

Type: apiKey
In: header

Voorbeelden

CreateCall

Voorbeeldaanvraag

HTTP

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

{
  "targets": [
    {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9"
      }
    }
  ],
  "callbackUri": "https://app.contoso.com/callback"
}

Voorbeeldrespons

Statuscode:: 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"
}

Definities

Name	Description
CallConnectionProperties	Eigenschappen van een oproepverbinding
CallConnectionStateModel	De status van de oproepverbinding.
CallIntelligenceOptions	AI-opties voor de aanroep.
CreateCallRequest	De nettolading van de aanvraag voor het maken van de aanroep.

CallConnectionProperties

Eigenschappen van een oproepverbinding

Name	Type	Description
answeredBy	CommunicationUserIdentifierModel
answeredFor	PhoneNumberIdentifierModel
callConnectionId	string	De oproepverbindings-id.
callConnectionState	CallConnectionStateModel	De status van de oproepverbinding.
callbackUri	string	De callback-URI.
correlationId	string	De correlatie-id.
serverCallId	string	De id van de serveroproep.
source	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	Weergavenaam van het gesprek als u naar een PSTN-nummer belt.
targets	CommunicationIdentifierModel[]	De doelen van de oproep.

CallConnectionStateModel

De status van de oproepverbinding.

Name	Type	Description
connected	string
connecting	string
disconnected	string
disconnecting	string
transferAccepted	string
transferring	string
unknown	string

CallIntelligenceOptions

AI-opties voor de aanroep.

Name	Type	Description
cognitiveServicesEndpoint	string	De id van de Cognitive Service-resource die aan deze aanroep is toegewezen.

CreateCallRequest

De nettolading van de aanvraag voor het maken van de aanroep.

Name	Type	Description
callIntelligenceOptions	CallIntelligenceOptions	AI-opties voor de aanroep.
callbackUri	string	De callback-URI.
operationContext	string	Een door de klant ingestelde waarde die wordt gebruikt om het beantwoorden van een gesprek bij te houden.
source	CommunicationUserIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	Weergavenaam van het gesprek als u naar een PSTN-nummer belt
targets	CommunicationIdentifierModel[]	De doelen van de oproep.

Delen via