Latest Legacy

The Participants object

Arguments

Member Idstring

ID for this participant.
Multiparty Call UUIDstring

UUID of the parent multiparty call.
Call UUIDstring

UUID of the call resource. Note that there can be more than one participant entry for the same call UUID if that caller entered/exited the MPC more than once.
Rolestring

The participant’s role. Once a participant's role is set, it cannot be updated.

Allowed values: Agent, Customer, Supervisor
Coach Modeboolean

Only applies to participants with the role Supervisor. Always false for other member roles. Controls whether the supervisor is audible to customers.
Join Timetimestamp

Timestamp at which the member joined the MPC.

Format: YYYY-MM-DD HH:mm:ss+|-hh:mm
Exit Timetimestamp

Timestamp at which the member left the MPC.

Format: YYYY-MM-DD HH:mm:ss+|-hh:mm.
Statusstring

Current status of the MPC. Possible values are:

  • Initialized: The MPC has been initialized.
  • Active: Participants have joined the MPC and the MPC has started.
  • Ended: The MPC has ended.
Durationinteger

Duration in seconds for which the participant was part of the MPC.
Billed Durationinteger

Duration in seconds for which the MPC was billed.
Billed Amountstring

Total amount charged to the customer’s account for the MPC participant.
Mutestring

Indicates whether audio from the participant is muted.

Allowed values: true, false, null

If set to true, audio from this participant will be muted.

Returns null for ended/exited participants.
Holdstring

Indicates whether hold music is played to participants on hold.

Allowed values: true, false, null

If set to true, the participant will be muted and will hear the hold music.

null indicates participant has left the call.
Start MPC On Enterboolean

Indicates whether the MPC should begin when the participant enters the call.
End MPC On Exitboolean

Indicates whether the MPC should end when the participant leaves the call.
Participant Exit Causestring

The reason for this participant’s exit from the MPC.

Possible values are:

  • Participant Call Hangup
  • Kicked Out of Multiparty Call
  • Multiparty Call Ended
  • Participant Call Transferred

This parameter should be null for participants that are still active in an ongoing MPC.

Example object

{
  "billed_amount": null,
  "billed_duration": null,
  "call_uuid": "dd473c48-34a6-4d67-a033-af590b41c23f",
  "coach_mode": false,
  "duration": null,
  "end_mpc_on_exit": false,
  "exit_cause": null,
  "exit_time": null,
  "hold": false,
  "join_time": "2020-12-24 10:01:56+00:00",
  "member_id": "355",
  "mpc_uuid": "4e9ae3f1-a29c-4524-a1b4-4758922e589b",
  "mute": false,
  "resource_uri": "/v1/Account/MAOTE1OWE0MDK0MTLHYW/MultiPartyCall/name_test_mpc_1/Participant/355/",
  "role": "agent",
  "start_mpc_on_enter": true
}