Latest Legacy

Retrieve a multiparty call

API Endpoint

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

Arguments

URL Params

Param Description/Allowed Values
phlo_idRequiredstring

Unique identifier for the PHLO. PHLO IDs are listed on the PHLO page of the console.
node_idRequiredstring

Unique identifier for the node. Node ID is available in the configuration section of the corresponding multiparty call node in the PHLO. See the screenshot below.

Node ID

Payload

Param Description/Allowed Values
actionRequired

Value is always call.
toRequired

Phone number or SIP endpoint address of the user to add to the multiparty call.
roleRequired

Role of the user added to the multiparty call.

Allowed values: customer, agent
Defaults to agent.
trigger_sourceRequired

Phone number or SIP endpoint address of the user (agent) initiating the trigger.

Returns

Returns a MultiPartyCall object.

Response

HTTP Status Code: 200

{
    "api_id": "2163e3fb-d6d0-46fb-a4ce-2d24a6b0b89f",
    "node_id": "b4b48fc2-f47a-4a93-97c3-749ed9a40fa8",
    "phlo_id": "73d6ab01-a2f6-4a84-850f-21e1d46b30bf",
    "name": "Multi-Party Call_1",
    "node_type": "multi_party_call",
    "created_on": "2020-08-01 09:05:11.846982+00:00"
}