azure.communication.callautomation.aio.CallConnectionClient.yml

### YamlMime:PythonClass
uid: azure.communication.callautomation.aio.CallConnectionClient
name: CallConnectionClient
fullName: azure.communication.callautomation.aio.CallConnectionClient
module: azure.communication.callautomation.aio
summary: 'A client to interact with an ongoing call. This client can be used to do
  mid-call actions,

  such as Transfer and Play Media. Call must be established to perform these actions.'
constructor:
  syntax: 'CallConnectionClient(endpoint: str, credential: AsyncTokenCredential |
    AzureKeyCredential, call_connection_id: str, *, api_version: str | None = None,
    **kwargs)'
  parameters:
  - name: endpoint
    description: The endpoint of the Azure Communication resource.
    isRequired: true
    types:
    - <xref:str>
  - name: credential
    description: The credentials with which to authenticate.
    isRequired: true
    types:
    - <xref:azure.core.credentials_async.AsyncTokenCredential>
    - <xref:azure.core.credentials.AzureKeyCredential>
  - name: call_connection_id
    description: Call Connection ID of ongoing call.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: api_version
    description: Azure Communication Call Automation API version.
    types:
    - <xref:str>
methods:
- uid: azure.communication.callautomation.aio.CallConnectionClient.add_participant
  name: add_participant
  summary: Add a participant to this call.
  signature: 'async add_participant(target_participant: CommunicationIdentifier, *,
    invitation_timeout: int | None = None, operation_context: str | None = None, source_caller_id_number:
    PhoneNumberIdentifier | None = None, source_display_name: str | None = None, operation_callback_url:
    str | None = None, sip_headers: Dict[str, str] | None = None, voip_headers: Dict[str,
    str] | None = None, **kwargs) -> AddParticipantResult'
  parameters:
  - name: target_participant
    description: The participant being added.
    isRequired: true
    types:
    - <xref:azure.communication.callautomation.CommunicationIdentifier>
  keywordOnlyParameters:
  - name: invitation_timeout
    description: 'Timeout to wait for the invited participant to pickup.

      The maximum value of this is 180 seconds.'
    types:
    - <xref:int>
    - <xref:None>
  - name: operation_context
    description: Value that can be used to track this call and its associated events.
    types:
    - <xref:str>
    - <xref:None>
  - name: source_caller_id_number
    description: 'The source caller Id, a phone number,

      that''s shown to the PSTN participant being invited.

      Required only when calling a PSTN callee.'
    types:
    - <xref:azure.communication.callautomation.PhoneNumberIdentifier>
    - <xref:None>
  - name: source_display_name
    description: Display name of the caller.
    types:
    - <xref:str>
    - <xref:None>
  - name: operation_callback_url
    description: 'Set a callback URL that overrides the default callback URL set

      by CreateCall/AnswerCall for this operation.

      This setup is per-action. If this is not set, the default callback URL set by

      CreateCall/AnswerCall will be used.'
    types:
    - <xref:str>
    - <xref:None>
  - name: sip_headers
    description: Sip Headers for PSTN Call
    types:
    - <xref:typing.Dict>[<xref:str>, <xref:str>]
    - <xref:None>
  - name: voip_headers
    description: Voip Headers for Voip Call
    types:
    - <xref:typing.Dict>[<xref:str>, <xref:str>]
    - <xref:None>
  return:
    description: AddParticipantResult
    types:
    - <xref:azure.communication.callautomation.AddParticipantResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.cancel_add_participant_operation
  name: cancel_add_participant_operation
  summary: Cancel add participant request sent out to a participant.
  signature: 'async cancel_add_participant_operation(invitation_id: str, *, operation_context:
    str | None = None, operation_callback_url: str | None = None, **kwargs) -> CancelAddParticipantOperationResult'
  parameters:
  - name: invitation_id
    description: The invitation ID that was used to add the participant.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: operation_context
    description: Value that can be used to track this call and its associated events.
    types:
    - <xref:str>
  - name: operation_callback_url
    description: 'Set a callback URL that overrides the default callback URL set

      by CreateCall/AnswerCall for this operation.

      This setup is per-action. If this is not set, the default callback URL set by

      CreateCall/AnswerCall will be used.'
    types:
    - <xref:str>
    - <xref:None>
  return:
    description: CancelAddParticipantOperationResult
    types:
    - <xref:azure.communication.callautomation.CancelAddParticipantOperationResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.cancel_all_media_operations
  name: cancel_all_media_operations
  summary: Cancels all the ongoing and queued media operations for this call.
  signature: async cancel_all_media_operations(**kwargs) -> None
  return:
    description: None
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.close
  name: close
  signature: async close() -> None
- uid: azure.communication.callautomation.aio.CallConnectionClient.from_connection_string
  name: from_connection_string
  summary: Create CallConnectionClient from a Connection String.
  signature: 'from_connection_string(conn_str: str, call_connection_id: str, **kwargs)
    -> CallConnectionClient'
  parameters:
  - name: conn_str
    description: A connection string to an Azure Communication Service resource.
    isRequired: true
    types:
    - <xref:str>
  - name: call_connection_id
    description: Call Connection Id of ongoing call.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: CallConnectionClient
    types:
    - <xref:azure.communication.callautomation.CallConnectionClient>
- uid: azure.communication.callautomation.aio.CallConnectionClient.get_call_properties
  name: get_call_properties
  summary: Get the latest properties of this call.
  signature: async get_call_properties(**kwargs) -> CallConnectionProperties
  return:
    description: CallConnectionProperties
    types:
    - <xref:azure.communication.callautomation.CallConnectionProperties>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.get_participant
  name: get_participant
  summary: Get details of a participant in this call.
  signature: 'async get_participant(target_participant: CommunicationIdentifier, **kwargs)
    -> CallParticipant'
  parameters:
  - name: target_participant
    description: The participant to retrieve.
    isRequired: true
    types:
    - <xref:azure.communication.callautomation.CommunicationIdentifier>
  return:
    description: CallParticipant
    types:
    - <xref:azure.communication.callautomation.CallParticipant>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.hang_up
  name: hang_up
  summary: Hangup this call.
  signature: 'async hang_up(is_for_everyone: bool, **kwargs) -> None'
  parameters:
  - name: is_for_everyone
    description: Determine if this call should be ended for all participants.
    isRequired: true
    types:
    - <xref:bool>
  return:
    description: None
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.hold
  name: hold
  summary: Play media to specific participant(s) in this call.
  signature: 'async hold(target_participant: CommunicationIdentifier, *, play_source:
    FileSource | TextSource | SsmlSource | None = None, operation_context: str | None
    = None, operation_callback_url: str | None = None, **kwargs) -> None'
  parameters:
  - name: target_participant
    description: The participant being added.
    isRequired: true
    types:
    - <xref:azure.communication.callautomation.CommunicationIdentifier>
  keywordOnlyParameters:
  - name: play_source
    description: A PlaySource representing the source to play.
    types:
    - <xref:azure.communication.callautomation.FileSource>
    - <xref:azure.communication.callautomation.TextSource>
    - <xref:azure.communication.callautomation.SsmlSource>
  - name: operation_context
    description: Value that can be used to track this call and its associated events.
    types:
    - <xref:str>
    - <xref:None>
  - name: operation_callback_url
    description: 'Set a callback URL that overrides the default callback URL set

      by CreateCall/AnswerCall for this operation.

      This setup is per-action. If this is not set, the default callback URL set by

      CreateCall/AnswerCall will be used.'
    types:
    - <xref:str>
    - <xref:None>
  return:
    description: None
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.list_participants
  name: list_participants
  summary: List all participants in this call.
  signature: list_participants(**kwargs) -> AsyncItemPaged[CallParticipant]
  return:
    description: Async iterable of CallParticipant
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.communication.callautomation.CallParticipant>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.mute_participant
  name: mute_participant
  summary: Mute participant from the call using identifier.
  signature: 'async mute_participant(target_participant: CommunicationIdentifier,
    *, operation_context: str | None = None, **kwargs) -> MuteParticipantResult'
  parameters:
  - name: target_participant
    description: Participant to be muted from the call. Only ACS Users are supported.
    isRequired: true
    types:
    - <xref:azure.communication.callautomation.CommunicationIdentifier>
  keywordOnlyParameters:
  - name: operation_context
    description: 'Used by customers when calling mid-call actions to correlate the
      request to the

      response event.'
    types:
    - <xref:str>
  return:
    description: MuteParticipantResult
    types:
    - <xref:azure.communication.callautomation.MuteParticipantResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.play_media
  name: play_media
  signature: 'async play_media(play_source: ''FileSource'' | ''TextSource'' | ''SsmlSource''
    | List[''FileSource'' | ''TextSource'' | ''SsmlSource''], play_to: List[''CommunicationIdentifier''],
    *, loop: bool = False, operation_context: str | None = None, operation_callback_url:
    str | None = None, **kwargs) -> None'
- uid: azure.communication.callautomation.aio.CallConnectionClient.play_media_to_all
  name: play_media_to_all
  summary: Play media to all participants in this call.
  signature: 'async play_media_to_all(play_source: FileSource | TextSource | SsmlSource
    | List[FileSource | TextSource | SsmlSource], *, loop: bool = False, operation_context:
    str | None = None, operation_callback_url: str | None = None, interrupt_call_media_operation:
    bool = False, **kwargs) -> None'
  parameters:
  - name: play_source
    description: A PlaySource representing the source to play.
    isRequired: true
    types:
    - <xref:azure.communication.callautomation.FileSource>
    - <xref:azure.communication.callautomation.TextSource>
    - <xref:azure.communication.callautomation.SsmlSource>
    - <xref:list>[<xref:azure.communication.callautomation.FileSource>]
    - <xref:list>[<xref:azure.communication.callautomation.TextSource>]
    - <xref:list>[<xref:azure.communication.callautomation.SsmlSource>]
  keywordOnlyParameters:
  - name: loop
    description: Whether the media should be repeated until cancelled.
    types:
    - <xref:bool>
  - name: operation_context
    description: Value that can be used to track this call and its associated events.
    types:
    - <xref:str>
    - <xref:None>
  - name: operation_callback_url
    description: 'Set a callback URL that overrides the default callback URL set

      by CreateCall/AnswerCall for this operation.

      This setup is per-action. If this is not set, the default callback URL set by

      CreateCall/AnswerCall will be used.'
    types:
    - <xref:str>
    - <xref:None>
  - name: interrupt_call_media_operation
    description: 'If set play can barge into other existing

      queued-up/currently-processing requests.'
    types:
    - <xref:bool>
  return:
    description: None
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.remove_participant
  name: remove_participant
  summary: Remove a participant from this call.
  signature: 'async remove_participant(target_participant: CommunicationIdentifier,
    *, operation_context: str | None = None, operation_callback_url: str | None =
    None, **kwargs) -> RemoveParticipantResult'
  parameters:
  - name: target_participant
    description: The participant being removed.
    isRequired: true
    types:
    - <xref:azure.communication.callautomation.CommunicationIdentifier>
  keywordOnlyParameters:
  - name: operation_context
    description: Value that can be used to track this call and its associated events.
    types:
    - <xref:str>
  - name: operation_callback_url
    description: 'Set a callback URL that overrides the default callback URL set

      by CreateCall/AnswerCall for this operation.

      This setup is per-action. If this is not set, the default callback URL set by

      CreateCall/AnswerCall will be used.'
    types:
    - <xref:str>
    - <xref:None>
  return:
    description: RemoveParticipantResult
    types:
    - <xref:azure.communication.callautomation.RemoveParticipantResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.send_dtmf_tones
  name: send_dtmf_tones
  summary: Send Dtmf tones to this call.
  signature: 'async send_dtmf_tones(tones: List[str | DtmfTone], target_participant:
    CommunicationIdentifier, *, operation_context: str | None = None, operation_callback_url:
    str | None = None, **kwargs) -> SendDtmfTonesResult'
  parameters:
  - name: tones
    description: List of tones to be sent to target participant.
    isRequired: true
    types:
    - <xref:list>[<xref:str>
    - <xref:azure.communication.callautomation.DtmfTone>]
  - name: target_participant
    description: Target participant.
    isRequired: true
    types:
    - <xref:azure.communication.callautomation.CommunicationIdentifier>
  keywordOnlyParameters:
  - name: operation_context
    description: The value to identify context of the operation.
    types:
    - <xref:str>
  - name: operation_callback_url
    description: 'Set a callback URL that overrides the default callback URL set

      by CreateCall/AnswerCall for this operation.

      This setup is per-action. If this is not set, the default callback URL set by

      CreateCall/AnswerCall will be used.'
    types:
    - <xref:str>
    - <xref:None>
  return:
    description: SendDtmfTonesResult
    types:
    - <xref:azure.communication.callautomation.SendDtmfTonesResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.start_continuous_dtmf_recognition
  name: start_continuous_dtmf_recognition
  summary: Start continuous Dtmf recognition by subscribing to tones.
  signature: 'async start_continuous_dtmf_recognition(target_participant: CommunicationIdentifier,
    *, operation_context: str | None = None, **kwargs) -> None'
  parameters:
  - name: target_participant
    description: Target participant.
    isRequired: true
    types:
    - <xref:azure.communication.callautomation.CommunicationIdentifier>
  keywordOnlyParameters:
  - name: operation_context
    description: Value that can be used to track this call and its associated events.
    types:
    - <xref:str>
  return:
    description: None
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.start_media_streaming
  name: start_media_streaming
  summary: Starts media streaming in the call.
  signature: 'async start_media_streaming(*, operation_callback_url: str | None =
    None, operation_context: str | None = None, **kwargs) -> None'
  keywordOnlyParameters:
  - name: operation_callback_url
    description: '(Optional) Set a callback URL that overrides the default

      callback URL set by CreateCall/AnswerCall for this operation.

      This setup is per-action. If this is not set, the default callback URL set by

      CreateCall/AnswerCall will be used.'
    types:
    - <xref:str>
    - <xref:None>
  - name: operation_context
    description: (Optional) Value that can be used to track this call and its associated
      events.
    types:
    - <xref:str>
    - <xref:None>
  return:
    description: None
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
    description: If there's an HTTP response error.
- uid: azure.communication.callautomation.aio.CallConnectionClient.start_recognizing_media
  name: start_recognizing_media
  summary: Recognize inputs from specific participant in this call.
  signature: 'async start_recognizing_media(input_type: str | RecognizeInputType,
    target_participant: CommunicationIdentifier, *, initial_silence_timeout: int |
    None = None, play_prompt: FileSource | TextSource | SsmlSource | List[FileSource
    | TextSource | SsmlSource] | None = None, interrupt_call_media_operation: bool
    = False, operation_context: str | None = None, interrupt_prompt: bool = False,
    dtmf_inter_tone_timeout: int | None = None, dtmf_max_tones_to_collect: int | None
    = None, dtmf_stop_tones: List[str | DtmfTone] | None = None, speech_language:
    str | None = None, choices: List[RecognitionChoice] | None = None, end_silence_timeout:
    int | None = None, speech_recognition_model_endpoint_id: str | None = None, operation_callback_url:
    str | None = None, **kwargs) -> None'
  parameters:
  - name: input_type
    description: Determines the type of the recognition.
    isRequired: true
    types:
    - <xref:str>
    - <xref:azure.communication.callautomation.RecognizeInputType>
  - name: target_participant
    description: Target participant of DTMF tone recognition.
    isRequired: true
    types:
    - <xref:azure.communication.callautomation.CommunicationIdentifier>
  keywordOnlyParameters:
  - name: initial_silence_timeout
    description: Time to wait for first input after prompt in seconds (if any).
    types:
    - <xref:int>
  - name: play_prompt
    description: The source of the audio to be played for recognition.
    types:
    - <xref:azure.communication.callautomation.FileSource>
    - <xref:azure.communication.callautomation.TextSource>
    - <xref:azure.communication.callautomation.SsmlSource>
  - name: interrupt_call_media_operation
    description: If set recognize can barge into other existing queued-up/currently-processing
      requests.
    types:
    - <xref:bool>
  - name: operation_context
    description: Value that can be used to track this call and its associated events.
    types:
    - <xref:str>
  - name: interrupt_prompt
    description: Determines if we interrupt the prompt and start recognizing.
    types:
    - <xref:bool>
  - name: dtmf_inter_tone_timeout
    description: 'Time to wait between DTMF inputs to stop recognizing. Will be ignored

      unless input_type is ''dtmf'' or ''speechOrDtmf''.'
    types:
    - <xref:int>
  - name: dtmf_max_tones_to_collect
    description: 'Maximum number of DTMF tones to be collected. Will be ignored

      unless input_type is ''dtmf'' or ''speechOrDtmf''.'
    types:
    - <xref:int>
  - name: dtmf_stop_tones
    description: 'List of tones that will stop recognizing. Will be ignored

      unless input_type is ''dtmf'' or ''speechOrDtmf''.'
    types:
    - <xref:list>[<xref:str>
    - <xref:azure.communication.callautomation.DtmfTone>]
  - name: speech_language
    description: Speech language to be recognized, If not set default is en-US.
    types:
    - <xref:str>
  - name: choices
    description: Defines Ivr choices for recognize. Will be ignored unless input_type
      is 'choices'.
    types:
    - <xref:list>[<xref:azure.communication.callautomation.RecognitionChoice>]
  - name: end_silence_timeout
    description: 'The length of end silence when user stops speaking and cogservice

      send response. Will be ingored unless input_type is ''speech'' or ''speechOrDtmf''.'
    types:
    - <xref:int>
  - name: speech_recognition_model_endpoint_id
    description: Endpoint where the custom model was deployed.
    types:
    - <xref:str>
  - name: operation_callback_url
    description: 'Set a callback URL that overrides the default callback URL set

      by CreateCall/AnswerCall for this operation.

      This setup is per-action. If this is not set, the default callback URL set by

      CreateCall/AnswerCall will be used.'
    types:
    - <xref:str>
    - <xref:None>
  return:
    description: None
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.start_transcription
  name: start_transcription
  summary: Starts transcription in the call.
  signature: 'async start_transcription(*, locale: str | None = None, operation_context:
    str | None = None, speech_recognition_model_endpoint_id: str | None = None, **kwargs)
    -> None'
  keywordOnlyParameters:
  - name: locale
    description: Defines Locale for the transcription e,g en-US.
    types:
    - <xref:str>
  - name: operation_context
    description: The value to identify context of the operation.
    types:
    - <xref:str>
  - name: speech_recognition_model_endpoint_id
    description: Endpoint where the custom model was deployed.
    types:
    - <xref:str>
  return:
    description: None
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.stop_continuous_dtmf_recognition
  name: stop_continuous_dtmf_recognition
  summary: Stop continuous Dtmf recognition by unsubscribing to tones.
  signature: 'async stop_continuous_dtmf_recognition(target_participant: CommunicationIdentifier,
    *, operation_context: str | None = None, operation_callback_url: str | None =
    None, **kwargs) -> None'
  parameters:
  - name: target_participant
    description: Target participant.
    isRequired: true
    types:
    - <xref:azure.communication.callautomation.CommunicationIdentifier>
  keywordOnlyParameters:
  - name: operation_context
    description: The value to identify context of the operation.
    types:
    - <xref:str>
  - name: operation_callback_url
    description: 'Set a callback URL that overrides the default callback URL set

      by CreateCall/AnswerCall for this operation.

      This setup is per-action. If this is not set, the default callback URL set by

      CreateCall/AnswerCall will be used.'
    types:
    - <xref:str>
    - <xref:None>
  return:
    description: None
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.stop_media_streaming
  name: stop_media_streaming
  summary: Stops media streaming in the call.
  signature: 'async stop_media_streaming(*, operation_callback_url: str | None = None,
    operation_context: str | None = None, **kwargs) -> None'
  keywordOnlyParameters:
  - name: operation_callback_url
    description: '(Optional) Set a callback URL that overrides the default

      callback URL set by CreateCall/AnswerCall for this operation.

      This setup is per-action. If this is not set, the default callback URL set by

      CreateCall/AnswerCall will be used.'
    types:
    - <xref:str>
    - <xref:None>
  - name: operation_context
    description: (Optional) Value that can be used to track this call and its associated
      events.
    types:
    - <xref:str>
    - <xref:None>
  return:
    description: None
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
    description: If there's an HTTP response error.
- uid: azure.communication.callautomation.aio.CallConnectionClient.stop_transcription
  name: stop_transcription
  summary: Stops transcription in the call.
  signature: 'async stop_transcription(*, operation_context: str | None = None, **kwargs)
    -> None'
  keywordOnlyParameters:
  - name: operation_context
    description: The value to identify context of the operation.
    types:
    - <xref:str>
  return:
    description: None
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.transfer_call_to_participant
  name: transfer_call_to_participant
  summary: Transfer this call to another participant.
  signature: 'async transfer_call_to_participant(target_participant: CommunicationIdentifier,
    *, operation_context: str | None = None, operation_callback_url: str | None =
    None, transferee: CommunicationIdentifier | None = None, sip_headers: Dict[str,
    str] | None = None, voip_headers: Dict[str, str] | None = None, source_caller_id_number:
    PhoneNumberIdentifier | None = None, **kwargs) -> TransferCallResult'
  parameters:
  - name: target_participant
    description: The transfer target.
    isRequired: true
    types:
    - <xref:azure.communication.callautomation.CommunicationIdentifier>
  keywordOnlyParameters:
  - name: operation_context
    description: Value that can be used to track this call and its associated events.
    types:
    - <xref:str>
  - name: operation_callback_url
    description: 'Set a callback URL that overrides the default callback URL set

      by CreateCall/AnswerCall for this operation.

      This setup is per-action. If this is not set, the default callback URL set by

      CreateCall/AnswerCall will be used.'
    types:
    - <xref:str>
    - <xref:None>
  - name: transferee
    description: Transferee is the participant who is transferred away.
    types:
    - <xref:azure.communication.callautomation.CommunicationIdentifier>
    - <xref:None>
  - name: sip_headers
    description: Custom context for PSTN
    types:
    - <xref:dict>[<xref:str>, <xref:str>]
  - name: voip_headers
    description: Custom context for VOIP
    types:
    - <xref:dict>[<xref:str>, <xref:str>]
  - name: source_caller_id_number
    description: 'The source caller Id, a phone number, that''s will be used as the

      transferor''s(Contoso) caller id when transfering a call a pstn target.'
    types:
    - <xref:azure.communication.callautomation.PhoneNumberIdentifier>
    - <xref:None>
  return:
    description: TransferCallResult
    types:
    - <xref:azure.communication.callautomation.TransferCallResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.unhold
  name: unhold
  summary: Play media to specific participant(s) in this call.
  signature: 'async unhold(target_participant: CommunicationIdentifier, *, operation_context:
    str | None = None, **kwargs) -> None'
  parameters:
  - name: target_participant
    description: The participant being added.
    isRequired: true
    types:
    - <xref:azure.communication.callautomation.CommunicationIdentifier>
  keywordOnlyParameters:
  - name: operation_context
    description: Value that can be used to track this call and its associated events.
    types:
    - <xref:str>
    - <xref:None>
  return:
    description: None
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.communication.callautomation.aio.CallConnectionClient.update_transcription
  name: update_transcription
  summary: API to change transcription language.
  signature: 'async update_transcription(*, locale: str, operation_context: str |
    None = None, speech_recognition_model_endpoint_id: str | None = None, **kwargs)
    -> None'
  keywordOnlyParameters:
  - name: locale
    description: Defines new locale for transcription.
    types:
    - <xref:str>
  - name: operation_context
    description: The value to identify context of the operation.
    types:
    - <xref:str>
  - name: speech_recognition_model_endpoint_id
    description: Endpoint where the custom model was deployed.
    types:
    - <xref:str>
  return:
    description: None
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError