Menu

Expand
Rate this page:

Participant Summary Resource

Fetch a Conference Participant Summary

The Participant Summary resource provides an overview of metadata and quality metrics for a single conference participant. A completed participant summary may take up to 30 minutes to generate following the end of the conference.

GET https://insights.twilio.com/v1/Conferences/{Conference_SID}/Participants/{Participant_SID}
        
        
        
        Resource Properties in REST API format
        participant_sid
        sid<CP> Not PII

        SID for this participant.

        label

        The user-specified label of this participant.

        conference_sid
        sid<CF> Not PII

        The unique SID identifier of the Conference.

        call_sid
        sid<CA> Not PII

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

        account_sid
        sid<AC> Not PII

        The unique SID identifier of the Account.

        call_direction
        enum:call_direction Not PII

        Call direction of the participant; inbound or outbound.

        from

        Caller ID of the calling party.

        to

        Called party.

        call_status
        enum:call_status Not PII

        Call status of the call that generated the participant.

        country_code
        string Not PII

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

        is_moderator
        boolean Not PII

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

        join_time
        date_time<iso8601> Not PII

        ISO 8601 timestamp of participant join event.

        leave_time
        date_time<iso8601> Not PII

        ISO 8601 timestamp of participant leave event.

        duration_seconds
        integer? Not PII

        Participant durations in seconds.

        outbound_queue_length
        integer? Not PII

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

        outbound_time_in_queue
        integer? Not PII

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

        jitter_buffer_size
        enum:jitter_buffer_size Not PII

        The Jitter Buffer Size of this Conference Participant. One of large, small, medium or off.

        is_coach
        boolean Not PII

        Boolean. Indicated whether participant was a coach.

        coached_participants
        string[] Not PII

        Call SIDs coached by this participant.

        participant_region
        enum:region Not PII

        Twilio region where the participant media originates.

        conference_region
        enum:region Not PII

        The Conference Region of this Conference Participant. One of us1, us2, au1, br1, ie1, jp1, sg1 or de1.

        call_type
        enum:call_type Not PII

        The Call Type of this Conference Participant. One of carrier, client or sip.

        processing_state
        enum:processing_state Not PII

        Processing state of the Participant Summary. Will be in_progress while data is being aggregated, timeout if Twilio couldn't process the summary in 24hrs, and complete once aggregations and analysis has ended.

        properties
        object Not PII

        Participant properties and metadata.

        events
        object Not PII

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

        metrics
        object Not PII

        Object. Contains participant call quality metrics.

        url
        url Not PII

        The URL of this resource.

        Rate this page:

        Need some help?

        We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              Refer us and get $10 in 3 simple steps!

              Step 1

              Get link

              Get a free personal referral link here

              Step 2

              Give $10

              Your user signs up and upgrade using link

              Step 3

              Get $10

              1,250 free SMSes
              OR 1,000 free voice mins
              OR 12,000 chats
              OR more