---
title: "Transfer the call to a participant."
method: POST
path: "/calling/callConnections/{callConnectionId}:transferToParticipant"
tags: ["MidConnections"]
---

# Transfer the call to a participant.

`POST /calling/callConnections/{callConnectionId}:transferToParticipant`

## Request

- Base URL: `https://contoso.communication.azure.com`
- URL: `https://contoso.communication.azure.com/calling/callConnections/{callConnectionId}:transferToParticipant`
- Auth: API key in header `Authorization`

Transfer the call to a participant.

## Path parameters

- `callConnectionId` string, required

## Query parameters

- `api-version` string, required

## Headers

- `Repeatability-Request-ID` string, uuid
- `Repeatability-First-Sent` string, date-time-rfc1123

## Request body

- TransferToParticipantRequest: The request payload for transferring call to a participant.
  - `targetParticipant` CommunicationIdentifierModel, required: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value.
    - `kind` 'unknown' | 'communicationUser' | 'phoneNumber' | 'microsoftTeamsUser' | 'microsoftTeamsApp' | 'teamsExtensionUser': The identifier kind, for example 'communicationUser' or 'phoneNumber'.
    - `rawId` string: Raw Id of the identifier. Optional in requests, required in responses.
    - `communicationUser` CommunicationUserIdentifierModel2: A user that got created with an Azure Communication Services resource.
      - `id` string, required: The Id of the communication user.
    - `phoneNumber` PhoneNumberIdentifierModel2: A phone number.
      - `value` string, required: The phone number, usually in E.164 format.
      - `isAnonymous` boolean: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.
      - `assertedId` string: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.
    - `microsoftTeamsUser` MicrosoftTeamsUserIdentifierModel2: A Microsoft Teams user.
      - `userId` string, required: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.
      - `isAnonymous` boolean: True if the Microsoft Teams user is anonymous. By default false if missing.
      - `cloud` 'public' | 'dod' | 'gcch': The cloud that the identifier belongs to.
    - `microsoftTeamsApp` MicrosoftTeamsAppIdentifierModel2: A Microsoft Teams application.
      - `appId` string, required: The Id of the Microsoft Teams application.
      - `cloud` 'public' | 'dod' | 'gcch': The cloud that the identifier belongs to.
    - `teamsExtensionUser` TeamsExtensionUserIdentifierModel2: A Microsoft Teams Phone user who is using a Communication Services resource to extend their Teams Phone set up.
      - `userId` string, required: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user.
      - `tenantId` string, required: The tenant Id of the Microsoft Teams Extension user.
      - `resourceId` string, required: The Communication Services resource Id.
      - `cloud` 'public' | 'dod' | 'gcch': The cloud that the identifier belongs to.
  - `operationContext` string: Used by customers when calling mid-call actions to correlate the request to the response event.
  - `transferee` CommunicationIdentifierModel: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value.
    - `kind` 'unknown' | 'communicationUser' | 'phoneNumber' | 'microsoftTeamsUser' | 'microsoftTeamsApp' | 'teamsExtensionUser': The identifier kind, for example 'communicationUser' or 'phoneNumber'.
    - `rawId` string: Raw Id of the identifier. Optional in requests, required in responses.
    - `communicationUser` CommunicationUserIdentifierModel2: A user that got created with an Azure Communication Services resource.
      - `id` string, required: The Id of the communication user.
    - `phoneNumber` PhoneNumberIdentifierModel2: A phone number.
      - `value` string, required: The phone number, usually in E.164 format.
      - `isAnonymous` boolean: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.
      - `assertedId` string: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.
    - `microsoftTeamsUser` MicrosoftTeamsUserIdentifierModel2: A Microsoft Teams user.
      - `userId` string, required: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.
      - `isAnonymous` boolean: True if the Microsoft Teams user is anonymous. By default false if missing.
      - `cloud` 'public' | 'dod' | 'gcch': The cloud that the identifier belongs to.
    - `microsoftTeamsApp` MicrosoftTeamsAppIdentifierModel2: A Microsoft Teams application.
      - `appId` string, required: The Id of the Microsoft Teams application.
      - `cloud` 'public' | 'dod' | 'gcch': The cloud that the identifier belongs to.
    - `teamsExtensionUser` TeamsExtensionUserIdentifierModel2: A Microsoft Teams Phone user who is using a Communication Services resource to extend their Teams Phone set up.
      - `userId` string, required: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user.
      - `tenantId` string, required: The tenant Id of the Microsoft Teams Extension user.
      - `resourceId` string, required: The Communication Services resource Id.
      - `cloud` 'public' | 'dod' | 'gcch': The cloud that the identifier belongs to.
  - `operationCallbackUri` string: Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
  - `customCallingContext` CustomCallingContext: The custom calling context which will be sent to the target
    - `voipHeaders` object: Custom calling context VoiP headers
    - `sipHeaders` object: Custom calling context SIP headers
    - `teamsPhoneCallDetails` TeamsPhoneCallDetails: The call details which will be sent to the target
      - `teamsPhoneCallerDetails` TeamsPhoneCallerDetails: Container for details relating to the original caller of the call
        - `caller` CommunicationIdentifierModel, required: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value.
          - `kind` 'unknown' | 'communicationUser' | 'phoneNumber' | 'microsoftTeamsUser' | 'microsoftTeamsApp' | 'teamsExtensionUser': The identifier kind, for example 'communicationUser' or 'phoneNumber'.
          - `rawId` string: Raw Id of the identifier. Optional in requests, required in responses.
          - `communicationUser` CommunicationUserIdentifierModel2: A user that got created with an Azure Communication Services resource.
            - `id` string, required: The Id of the communication user.
          - `phoneNumber` PhoneNumberIdentifierModel2: A phone number.
            - `value` string, required: The phone number, usually in E.164 format.
            - `isAnonymous` boolean: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.
            - `assertedId` string: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.
          - `microsoftTeamsUser` MicrosoftTeamsUserIdentifierModel2: A Microsoft Teams user.
            - `userId` string, required: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.
            - `isAnonymous` boolean: True if the Microsoft Teams user is anonymous. By default false if missing.
            - `cloud` 'public' | 'dod' | 'gcch': The cloud that the identifier belongs to.
          - `microsoftTeamsApp` MicrosoftTeamsAppIdentifierModel2: A Microsoft Teams application.
            - `appId` string, required: The Id of the Microsoft Teams application.
            - `cloud` 'public' | 'dod' | 'gcch': The cloud that the identifier belongs to.
          - `teamsExtensionUser` TeamsExtensionUserIdentifierModel2: A Microsoft Teams Phone user who is using a Communication Services resource to extend their Teams Phone set up.
            - `userId` string, required: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user.
            - `tenantId` string, required: The tenant Id of the Microsoft Teams Extension user.
            - `resourceId` string, required: The Communication Services resource Id.
            - `cloud` 'public' | 'dod' | 'gcch': The cloud that the identifier belongs to.
        - `name` string, required: Caller's name
        - `phoneNumber` string, required: Caller's phone number
        - `recordId` string: Caller's record ID (ex in CRM)
        - `screenPopUrl` string: Caller's screen pop URL
        - `isAuthenticated` boolean: Flag indicating whether the caller was authenticated
        - `additionalCallerInformation` object: A set of key value pairs (max 10, any additional entries would be ignored) which a bot author wants to pass to the Teams Client for display to the agent
      - `teamsPhoneSourceDetails` TeamsPhoneSourceDetails: Container for details relating to the entity responsible for the creation of these call details
        - `source` CommunicationIdentifierModel, required: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value.
          - `kind` 'unknown' | 'communicationUser' | 'phoneNumber' | 'microsoftTeamsUser' | 'microsoftTeamsApp' | 'teamsExtensionUser': The identifier kind, for example 'communicationUser' or 'phoneNumber'.
          - `rawId` string: Raw Id of the identifier. Optional in requests, required in responses.
          - `communicationUser` CommunicationUserIdentifierModel2: A user that got created with an Azure Communication Services resource.
            - `id` string, required: The Id of the communication user.
          - `phoneNumber` PhoneNumberIdentifierModel2: A phone number.
            - `value` string, required: The phone number, usually in E.164 format.
            - `isAnonymous` boolean: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.
            - `assertedId` string: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.
          - `microsoftTeamsUser` MicrosoftTeamsUserIdentifierModel2: A Microsoft Teams user.
            - `userId` string, required: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.
            - `isAnonymous` boolean: True if the Microsoft Teams user is anonymous. By default false if missing.
            - `cloud` 'public' | 'dod' | 'gcch': The cloud that the identifier belongs to.
          - `microsoftTeamsApp` MicrosoftTeamsAppIdentifierModel2: A Microsoft Teams application.
            - `appId` string, required: The Id of the Microsoft Teams application.
            - `cloud` 'public' | 'dod' | 'gcch': The cloud that the identifier belongs to.
          - `teamsExtensionUser` TeamsExtensionUserIdentifierModel2: A Microsoft Teams Phone user who is using a Communication Services resource to extend their Teams Phone set up.
            - `userId` string, required: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user.
            - `tenantId` string, required: The tenant Id of the Microsoft Teams Extension user.
            - `resourceId` string, required: The Communication Services resource Id.
            - `cloud` 'public' | 'dod' | 'gcch': The cloud that the identifier belongs to.
        - `language` string, required: Language of the source entity passing along the call details, passed in the ISO-639 standard
        - `status` string, required: Status of the source entity passing along the call details
        - `intendedTargets` object: Intended targets of the source entity passing along the call details
      - `sessionId` string: Id to exclusively identify this call session. IVR will use this for their telemetry/reporting.
      - `intent` string: The intent of the call
      - `callTopic` string: A very short description (max 48 chars) of the reason for the call. To be displayed in Teams CallNotification
      - `callContext` string: A summary of the call thus far. It will be displayed on a side panel in the Teams UI
      - `transcriptUrl` string: Url for fetching the transcript of the call
      - `callSentiment` string: Sentiment of the call thus far
      - `suggestedActions` string: Recommendations for resolving the issue based on the customer's intent and interaction history
  - `sourceCallerIdNumber` PhoneNumberIdentifierModel: A phone number.
    - `value` string, required: The phone number, usually in E.164 format.
    - `isAnonymous` boolean: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.
    - `assertedId` string: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.

## Response `202`

The service has accepted the transfer request and will begin processing it. You will receive either CallTransferAccepted or CallTransferFailed event at your specified callback URI to update you on the status of the request.

- TransferCallResponse: The response payload for transferring the call.
  - `operationContext` string: The operation context provided by client.

## Other responses

- `default`: Error

## Changes

- **2026-07-13** (2022-04-07-preview) `d4d02a642780`: 1 info
  - api operation id `CallConnections_TransferToParticipant` removed and replaced with `CallConnection_TransferToParticipant`

[Operation history](https://skmtc.dev/azure/apis/communication-callautomation/changes/calling/callConnections/:callConnectionId:transferToParticipant/post.md)

---

[API](https://skmtc.dev/azure/apis/communication-callautomation.md) - [All operations](https://skmtc.dev/azure/apis/communication-callautomation/llms.txt) - [OpenAPI document](https://skmtc.dev/azure/apis/communication-callautomation/revisions/956a07c67cf4?raw)
