Skip to main content
A user (U1) can transfer a call with a member (U2) of a multiparty call to another user (U3). With a warm transfer, the user who initiates the transfer (U1) and the user to whom the call is transferred to (U3) can speak privately before U2 is added to the call.

​
API Endpoint

POST
https://phlorunner.plivo.com/v1/phlo/{phlo_id}/multi_party_call/{node_id}

​
Arguments

​
URL Params

ParamTypeDescription/Allowed Values
phlo_id (Required)stringUnique identifier of a PHLO. PHLO IDs are listed on the PHLO page of the console.
node_id (Required)stringUnique identifier of the node. The ID is available in the configuration section of the corresponding multiparty call node in the PHLO.

​
Payload

ParamDescription/Allowed Values
action (Required)Value is always warm_transfer.
to (Required)Phone number or SIP endpoint address of the user to which the call is to be transferred.
role (Required)Role of the user added to the multiparty call.
Allowed values: customer, agent
Defaults to agent.
trigger_source (Required)Phone number or SIP endpoint address of the user (agent) initiating the transfer.
import plivo

auth_id = '<auth_id>'
auth_token = '<auth_token>'
phlo_id = '<phlo_id>'
node_id = '<node_id>'
phlo_client = plivo.phlo.RestClient(auth_id=auth_id, auth_token=auth_token)
phlo = phlo_client.phlo.get(phlo_id)

trigger_source = '<member_address>'
to = '<target_address>'

response = phlo.multi_party_call(node_id).warm_transfer(trigger_source, to)
print (str(response))

​
Response

{
    "api_id": "faad0293-f5f0-487e-8ff7-b45ba6c45b25",
    "error": ""
}