Skip to main content
Places a member in the multiparty call on hold. When a member places the call on hold, the member will be muted and the other members will hear the hold music. You can configure agent hold music and customer hold music in the node.

​
API Endpoint

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

​
Arguments

​
URL Params

ParamTypeDescription
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 node, available in the configuration section of the corresponding multiparty call node in the PHLO.
member_address (Required)Phone number or SIP endpoint address of the member to put on hold.
import plivo

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

#Hold:
response = phlo.multi_party_call(node_id).member(member_address).hold()

print str(response)

​
Response

HTTP Status Code: 201
{
    "api_id": "11d8c251-d7bf-4aba-9763-985f21bcb455",
    "error": ""
}