Path parameters

• ConferenceSid string Required

  The unique SID identifier of the Conference.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CF[0-9a-fA-F]{32}$.

Query parameters

• ParticipantSid string

  The unique SID identifier of the Participant.

• Label string

  User-specified label for a participant.

• Events string

  Conference events generated by application or participant activity; e.g. hold, mute, etc.

• PageSize integer(int64)

  How many resources to return in each list page. The default is 50, and the maximum is 1000.

  Minimum value is 1, maximum value is 1000.

• Page integer

  The page index. This value is simply for client state.

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • participants array[object]
    Hide participants attributes Show participants attributes object

    • participant_sid string | null

      SID for this participant.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CP[0-9a-fA-F]{32}$.

    • label string | null

      The user-specified label of this participant.

    • conference_sid string | null

      The unique SID identifier of the Conference.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CF[0-9a-fA-F]{32}$.

    • call_sid string | null

      Unique SID identifier of the call that generated the Participant resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CA[0-9a-fA-F]{32}$.

    • account_sid string | null

      The unique SID identifier of the Account.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • call_direction string

      Values are inbound or outbound.

    • from string | null

      Caller ID of the calling party.

    • to string | null

      Called party.

    • call_status string

      Values are answered, completed, busy, fail, noanswer, ringing, or canceled.

    • country_code string | null

      ISO alpha-2 country code of the participant based on caller ID or called number.

    • is_moderator boolean | null

      Boolean. Indicates whether participant had startConferenceOnEnter=true or endConferenceOnExit=true.

    • join_time string(date-time) | null

      ISO 8601 timestamp of participant join event.

    • leave_time string(date-time) | null

      ISO 8601 timestamp of participant leave event.

    • duration_seconds integer | null

      Participant durations in seconds.

    • outbound_queue_length integer | null

      Add Participant API only. Estimated time in queue at call creation.

    • outbound_time_in_queue integer | null

      Add Participant API only. Actual time in queue in seconds.

    • jitter_buffer_size string

      Values are large, small, medium, or off.

    • is_coach boolean | null

      Boolean. Indicated whether participant was a coach.

    • coached_participants array[string] | null

      Call SIDs coached by this participant.

    • participant_region string

      Values are us1, us2, au1, br1, ie1, jp1, sg1, de1, or in1.

    • conference_region string

      Values are us1, us2, au1, br1, ie1, jp1, sg1, de1, or in1.

    • call_type string

      Values are carrier, client, or sip.

    • processing_state string

      Values are complete, in_progress, or timeout.

    • properties object | null

      Participant properties and metadata.

    • events object | null

      Object containing information of actions taken by participants. Contains a dictionary of URL links to nested resources of this Conference Participant.

    • metrics object | null

      Object. Contains participant call quality metrics.

    • url string(uri) | null

      The URL of this resource.

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri) | null
    • page integer
    • page_size integer
    • previous_page_url string(uri) | null
    • url string(uri)