你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Call Connection - Transfer To Participant

将呼叫转接给参与者。

POST {endpoint}/calling/callConnections/{callConnectionId}:transferToParticipant?api-version=2023-10-15

URI 参数

名称 必需 类型 说明
callConnectionId
path True

string

呼叫连接 ID。

endpoint
path True

string

url

Azure 通信资源的终结点。

api-version
query True

string

要调用的 API 的版本。

请求头

名称 必需 类型 说明
Authorization True

string

Azure 通信服务用户访问令牌。

Repeatability-Request-ID

string

uuid

如果指定,则客户端指示请求是可重复的;也就是说,客户端可以使用相同的 Repeatability-Request-Id 多次发出请求,并返回适当的响应,而无需服务器多次执行请求。 Repeatability-Request-Id 的值是一个不透明的字符串,表示客户端为请求生成的唯一标识符。 它是版本 4 (随机) UUID。

Repeatability-First-Sent

string

date-time-rfc1123

如果指定了 Repeatability-Request-ID 标头,则还必须指定 Repeatability-First-Sent 标头。 该值应为首次创建请求的日期和时间,使用 IMF-fixdate 形式的 HTTP-date 表示。 示例:星期日,1994年11月6日 08:49:37 GMT。

请求正文

名称 必需 类型 说明
targetParticipant True

CommunicationIdentifierModel

customCallingContext

CustomCallingContext

客户用于将自定义调用上下文发送到目标

operationCallbackUri

string

设置一个回调 URI,用于替代由 CreateCall/AnswerCall 为此操作设置的默认回调 URI。 此设置是按操作进行的。 如果未设置,将使用 CreateCall/AnswerCall 设置的默认回调 URI。

operationContext

string

客户在调用通话中操作时使用,将请求与响应事件相关联。

transferee

CommunicationIdentifierModel

响应

名称 类型 说明
202 Accepted

TransferCallResponse

服务已接受转移请求,并开始处理该请求。 将在指定的回调 URI 处收到 CallTransferAccepted 或 CallTransferFailed 事件,以更新请求的状态。

Other Status Codes

CommunicationErrorResponse

错误

安全性

Authorization

Azure 通信服务用户访问令牌。

类型: apiKey
在: header

示例

CallConnection_TransferToParticipant

示例请求

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c:transferToParticipant?api-version=2023-10-15

{
  "targetParticipant": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
    }
  },
  "transferee": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
    }
  },
  "operationCallbackUri": "https://app.contoso.com/callback",
  "operationContext": "trasferring call"
}

示例响应

{
  "operationContext": "trasferring call"
}

定义

名称 说明
CustomCallingContext

将发送到目标的自定义调用上下文

TransferCallResponse

用于转移呼叫的响应有效负载。

TransferToParticipantRequest

用于将呼叫转接到参与者的请求有效负载。

CustomCallingContext

将发送到目标的自定义调用上下文

名称 类型 说明
sipHeaders

object

自定义调用上下文 SIP 标头

voipHeaders

object

自定义调用上下文 VoiP 标头

TransferCallResponse

用于转移呼叫的响应有效负载。

名称 类型 说明
operationContext

string

客户端提供的操作上下文。

TransferToParticipantRequest

用于将呼叫转接到参与者的请求有效负载。

名称 类型 说明
customCallingContext

CustomCallingContext

客户用于将自定义调用上下文发送到目标

operationCallbackUri

string

设置一个回调 URI,用于替代由 CreateCall/AnswerCall 为此操作设置的默认回调 URI。 此设置是按操作进行的。 如果未设置,将使用 CreateCall/AnswerCall 设置的默认回调 URI。

operationContext

string

客户在调用通话中操作时使用,将请求与响应事件相关联。

targetParticipant

CommunicationIdentifierModel

transferee

CommunicationIdentifierModel