calls

Creates, updates, deletes, gets or lists a calls resource.

Overview

Name	calls
Type	Resource
Id	azure.communication_call_automation.calls

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_call	insert	endpoint, targets, callbackUri		Create an outbound call. Create an outbound call.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )

INSERT examples

create_call

Create an outbound call. Create an outbound call.

INSERT INTO azure.communication_call_automation.calls (
targets,
sourceCallerIdNumber,
sourceDisplayName,
source,
operationContext,
callbackUri,
callIntelligenceOptions,
mediaStreamingOptions,
transcriptionOptions,
teamsAppSource,
endpoint
)
SELECT 
'{{ targets }}' /* required */,
'{{ sourceCallerIdNumber }}',
'{{ sourceDisplayName }}',
'{{ source }}',
'{{ operationContext }}',
'{{ callbackUri }}' /* required */,
'{{ callIntelligenceOptions }}',
'{{ mediaStreamingOptions }}',
'{{ transcriptionOptions }}',
'{{ teamsAppSource }}',
'{{ endpoint }}'
RETURNING
answeredBy,
answeredFor,
callConnectionId,
callConnectionState,
callbackUri,
correlationId,
mediaStreamingSubscription,
serverCallId,
source,
sourceCallerIdNumber,
sourceDisplayName,
targets,
transcriptionSubscription
;

Manifest

# Description fields are for documentation purposes
- name: calls
props:
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the calls resource.
  - name: targets
    description: |
      The targets of the call. Required.
    value:
      - kind: "{{ kind }}"
        rawId: "{{ rawId }}"
        communicationUser:
          id: "{{ id }}"
        phoneNumber:
          value: "{{ value }}"
          isAnonymous: {{ isAnonymous }}
          assertedId: "{{ assertedId }}"
        microsoftTeamsUser:
          userId: "{{ userId }}"
          isAnonymous: {{ isAnonymous }}
          cloud: "{{ cloud }}"
        microsoftTeamsApp:
          appId: "{{ appId }}"
          cloud: "{{ cloud }}"
        teamsExtensionUser:
          userId: "{{ userId }}"
          tenantId: "{{ tenantId }}"
          resourceId: "{{ resourceId }}"
          cloud: "{{ cloud }}"
  - name: sourceCallerIdNumber
    description: |
      A phone number.
    value:
      value: "{{ value }}"
      isAnonymous: {{ isAnonymous }}
      assertedId: "{{ assertedId }}"
  - name: sourceDisplayName
    value: "{{ sourceDisplayName }}"
    description: |
      Display name of the call if dialing out to a pstn number.
  - name: source
    description: |
      A user that got created with an Azure Communication Services resource.
    value:
      id: "{{ id }}"
  - name: operationContext
    value: "{{ operationContext }}"
    description: |
      A customer set value used to track the answering of a call.
  - name: callbackUri
    value: "{{ callbackUri }}"
    description: |
      The callback URI. Required.
  - name: callIntelligenceOptions
    description: |
      AI options for the call.
    value:
      cognitiveServicesEndpoint: "{{ cognitiveServicesEndpoint }}"
  - name: mediaStreamingOptions
    description: |
      Options for media streaming.
    value:
      transportType: "{{ transportType }}"
      audioChannelType: "{{ audioChannelType }}"
  - name: transcriptionOptions
    description: |
      Options for live transcription.
    value:
      transportType: "{{ transportType }}"
      locale: "{{ locale }}"
  - name: teamsAppSource
    description: |
      A Microsoft Teams application.
    value:
      appId: "{{ appId }}"
      cloud: "{{ cloud }}"