Multiparty call
The Multiparty Call Object
Arguments
Parameter | Type | Required | Description |
---|---|---|---|
UUID | string | No | UUID of this MPC object. |
Account Id | string | No | Account/subaccount associated with the MPC. |
Subaccount Id | string | No | Subaccount associated with the MPC. |
Creation Time | timestamp | No | Date and time at which the MPC was created. Format: `YYYY-MM-DD HH:mm:ss+|-hh:mm`. |
Start Time | timestamp | No | Timestamp of when this MPC was started. Format: `YYYY-MM-DD HH:mm:ss+|-hh:mm`. |
End Time | timestamp | No | Timestamp of when this MPC ended. This is null if the MPC has not ended. |
Friendly Name | string | No | User-given name for this MPC. Must be unique per account across all live MPCs. |
Status | string | No | Current status of the MPC: - Initialized – MPC initialized- Active – Participants have joined- Ended – MPC has ended |
Max Participants | string | No | Maximum number of participants allowed in the MPC at any time. |
Max Duration | string | No | Maximum duration (in seconds) the MPC can run from initiation. |
Stay Alone | boolean | No | Whether any participant can remain alone in the MPC. |
Duration | string | No | Total duration of the MPC. null if the MPC has not ended. |
Wait Music URL | string | No | Music URL played for waiting participants if the MPC has not started. |
Wait Music Method | string | No | HTTP verb (e.g., GET or POST) used to invoke the wait_music_url . |
Agent Hold Music URL | string | No | Hold music URL for participants with role Agent when on hold. |
Agent Hold Music Method | string | No | HTTP verb used to invoke agent_hold_music_url . |
Customer Hold Music URL | string | No | Hold music URL for participants with role Customer when on hold. |
Customer Hold Music Method | string | No | HTTP verb used to invoke customer_hold_music_url . |
Duration (duplicate) | string | No | Total duration in seconds of the MPC from start to end. This value is null if the MPC has not ended. (Duplicate field) |
Billed Duration | string | No | Duration in seconds for which all participants were billed. null if the MPC has not ended. |
Billed Amount | string | No | Amount billed for this MPC (all participants) in USD. null if not ended. |
Termination Cause | string | No | Reason for the MPC termination. See Plivo Hangup Causes for details. |
Termination Cause Code | string | No | Unique code for the termination cause. See Plivo Hangup Causes for a full list. |
Participants | string | No | URL pointing to the list of participants in this MPC. |