Participants
The Participants object
Arguments
Field | Type | Description |
---|---|---|
member_id | string | ID for this participant. |
multiparty_call_uuid | string | UUID of the parent multiparty call. |
call_uuid | string | UUID of the call resource. There can be more than one participant entry for the same call UUID if that caller entered/exited the MPC more than once. |
role | string | The participant’s role. Once set, it cannot be updated. Allowed values: Agent , Customer , Supervisor |
coach_mode | boolean | Applies only to participants with the role Supervisor . Always false for others. Controls whether the supervisor is audible to customers. |
join_time | timestamp | Time the member joined the MPC. Format: YYYY-MM-DD HH:mm:ss±hh:mm |
exit_time | timestamp | Time the member left the MPC. Format: YYYY-MM-DD HH:mm:ss±hh:mm |
status | string | Current status of the MPC. Possible values: Initialized , Active , Ended |
duration | integer | Duration (in seconds) the participant was part of the MPC. |
billed_duration | integer | Duration (in seconds) the MPC was billed. |
billed_amount | string | Total amount charged to the customer’s account for this participant. |
mute | string | Whether the participant’s audio is muted. Allowed values: true , false , null true means muted; null for exited participants. |
hold | string | Whether hold music is played to the participant. Allowed values: true , false , null true means muted with hold music; null if participant left. |
start_mpc_on_enter | boolean | Whether the MPC should begin when the participant enters. |
end_mpc_on_exit | boolean | Whether the MPC should end when the participant leaves. |
participant_exit_cause | string | Reason for the participant’s exit. Possible values: Participant Call Hangup , Kicked Out of Multiparty Call , Multiparty Call Ended , Participant Call Transferred Should be null if still active. |