Menu

Expand
Rate this page:

Conference Summary Resource

Fetch a Conference Summary

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

GET https://insights.twilio.com/v1/Conferences/{Conference_SID}
Loading Code Sample...
        
        

        Get a Conference Summary

        Resource Properties in REST API format
        conference_sid
        sid<CF> Not PII

        The unique SID identifier of the Conference.

        account_sid
        sid<AC> Not PII

        The unique SID identifier of the Account.

        friendly_name

        Custom label for the conference resource, up to 64 characters.

        create_time
        date_time<iso8601> Not PII

        Conference creation date and time in ISO 8601 format.

        start_time
        date_time<iso8601> Not PII

        Timestamp in ISO 8601 format when the conference started. Conferences do not start until at least two participants join, at least one of whom has startConferenceOnEnter=true.

        end_time
        date_time<iso8601> Not PII

        Conference end date and time in ISO 8601 format.

        duration_seconds
        integer? Not PII

        Conference duration in seconds.

        connect_duration_seconds
        integer? Not PII

        Duration of the between conference start event and conference end event in seconds.

        status
        enum:conference_status Not PII

        Status of this Conference; in_progress, not_started, completed or summary_timeout. if Twilio don't receive last_participant_left event, summary will be timeout after 24 hours

        max_participants
        integer? Not PII

        Maximum number of concurrent participants as specified by the configuration.

        max_concurrent_participants
        integer? Not PII

        Actual maximum number of concurrent participants in the conference.

        unique_participants
        integer? Not PII

        Unique conference participants based on caller ID.

        end_reason
        enum:conference_end_reason Not PII

        Conference end reason; e.g. last participant left, modified by API, etc.

        ended_by
        sid<CA> Not PII

        Call SID of the participant whose actions ended the conference.

        mixer_region
        enum:region Not PII

        Twilio region where the conference media was mixed.

        mixer_region_requested
        enum:region Not PII

        Twilio region where conference mixed was specified to be mixed in configuration.

        recording_enabled
        boolean Not PII

        Boolean. Indicates whether recording was enabled at the conference mixer.

        detected_issues
        object Not PII

        Potential issues detected by Twilio during the conference.

        tags
        enum:tag[] Not PII

        Tags for detected conference conditions and participant behaviors which may be of interest.

        tag_info
        object Not PII

        Object. Contains details about conference tags including severity.

        processing_state
        enum:processing_state Not PII

        Processing state for the Conference Summary resource. 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.

        url
        url Not PII

        The URL of this resource.

        links
        uri_map Not PII

        Contains a dictionary of URL links to nested resources of this Conference.

        Read multiple Conference Summary resources

        The Conference Summary list API allows results to be filtered by date, friendly name, region, and other dimensions. By default, the Conference Summary list API returns a list of conferences hosted in the last 24 hours. To read multiple Conference Summaries of Conferences hosted prior to the last 24 hours, specify the CreatedAfter and/or CreatedBefore query params.

        Parameters in REST API format
        conference_sid
        Optional
        get string Not PII

        The SID of the conference.

        friendly_name
        Optional
        get string PII MTL: 30 DAYS

        Custom label for the conference resource, up to 64 characters.

        status
        Optional
        get string Not PII

        Conference status.

        created_after
        Optional
        get string Not PII

        Conferences created after the provided timestamp specified in ISO 8601 format

        created_before
        Optional
        get string Not PII

        Conferences created before the provided timestamp specified in ISO 8601 format.

        mixer_region
        Optional
        get string Not PII

        Twilio region where the conference media was mixed.

        tags
        Optional
        get string Not PII

        Tags applied by Twilio for common potential configuration, quality, or performance issues.

        subaccount
        Optional
        get sid<AC> Not PII

        Account SID for the subaccount whose resources you wish to retrieve.

        detected_issues
        Optional
        get string Not PII

        Potential configuration, behavior, or performance issues detected during the conference.

        end_reason
        Optional
        get string Not PII

        Conference end reason; e.g. last participant left, modified by API, etc.

        GET https://insights.twilio.com/v1/Conferences
        Loading Code Sample...
              
              

              Read multiple Conference Summaries

              Loading Code Sample...
                    
                    

                    Read multiple Conference Summaries from a subaccount

                    Loading Code Sample...
                          
                          

                          Read multiple Conference Summaries in ie1 with call quality detected issues

                          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.

                          Loading Code Sample...
                                
                                
                                

                                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!

                                thanks-feedback-gif