Skip to main content
A user (U1) can transfer a call with a member (U2) on a multiparty call to another user (U3). With a cold transfer, user U2 is connected directly to the user to whom the call is transferred (U3) and the user initiating the cold transfer (U1) is disconnected from the multiparty 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 the PHLO. PHLO IDs are listed on the PHLO page of the console.
node_id (Required)stringUnique identifier of the multiparty call. 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 cold_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 = '<from_endpoint>'
to = '<to_endpoint>'

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

{
    "api_id": "8c77b816-d621-4028-afc8-1aeab1d497a8",
    "error": ""
}