Get a list of Conference Summaries.

GET /v1/Conferences

Get a list of Conference Summaries.

Query parameters

  • ConferenceSid string

    The SID of the conference.

  • FriendlyName string

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

  • Status string

    Conference status.

  • CreatedAfter string

    Conferences created after the provided timestamp specified in ISO 8601 format

  • CreatedBefore string

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

  • MixerRegion string

    Twilio region where the conference media was mixed.

  • Tags string

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

  • Subaccount string

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

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

  • DetectedIssues string

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

  • EndReason string

    Conference end reason; e.g. last participant left, modified by API, 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
    • conferences array[object]
      Hide conferences attributes Show conferences attributes object
      • 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}$.

      • 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}$.

      • friendly_name string | null

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

      • create_time string(date-time) | null

        Conference creation date and time in ISO 8601 format.

      • start_time string(date-time) | null

        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 string(date-time) | null

        Conference end date and time in ISO 8601 format.

      • duration_seconds integer | null

        Conference duration in seconds.

      • connect_duration_seconds integer | null

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

      • status string | null

        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

        Values are in_progress, not_started, completed, or summary_timeout.

      • max_participants integer | null

        Maximum number of concurrent participants as specified by the configuration.

      • max_concurrent_participants integer | null

        Actual maximum number of concurrent participants in the conference.

      • unique_participants integer | null

        Unique conference participants based on caller ID.

      • end_reason string | null

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

        Values are last_participant_left, conference_ended_via_api, participant_with_end_conference_on_exit_left, last_participant_kicked, or participant_with_end_conference_on_exit_kicked.

      • ended_by string | null

        Call SID of the participant whose actions ended the conference.

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

      • mixer_region string | null

        Twilio region where the conference media was mixed.

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

      • mixer_region_requested string | null

        Twilio region where the conference media was mixed.

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

      • recording_enabled boolean | null

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

      • detected_issues object | null

        Potential issues detected by Twilio during the conference.

      • tags array[string] | null

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

        Values are invalid_requested_region, duplicate_identity, start_failure, region_configuration_issues, quality_warnings, participant_behavior_issues, high_packet_loss, high_jitter, high_latency, low_mos, detected_silence, or no_concurrent_participants.

      • tag_info object | null

        Object. Contains details about conference tags including severity.

      • processing_state string | null

        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.

        Values are complete, in_progress, or timeout.

      • 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)
GET /v1/Conferences
curl \
 --request GET 'https://insights.twilio.com/v1/Conferences' \
 --user "username:password"
{
  "meta": {
    "key": "conferences",
    "url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0",
    "page": 0,
    "page_size": 25,
    "next_page_url": null,
    "first_page_url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0",
    "previous_page_url": null
  },
  "conferences": [
    {
      "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "tags": null,
      "links": {
        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants"
      },
      "status": "completed",
      "end_time": "2021-10-12T18:11:15Z",
      "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "tag_info": null,
      "end_reason": "last_participant_left",
      "start_time": "2021-10-12T18:11:10Z",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "create_time": "2021-10-12T18:11:09Z",
      "mixer_region": "us1",
      "friendly_name": "conference 1",
      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "detected_issues": {
        "call_quality": 1,
        "participant_behavior": 0,
        "region_configuration": 0
      },
      "duration_seconds": 7,
      "max_participants": 250,
      "processing_state": "complete",
      "recording_enabled": false,
      "unique_participants": 2,
      "mixer_region_requested": null,
      "connect_duration_seconds": 5,
      "max_concurrent_participants": 2
    },
    {
      "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
      "tags": [
        "detected_silence",
        "participant_behavior_issues"
      ],
      "links": {
        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Participants"
      },
      "status": "completed",
      "end_time": "2021-10-12T18:09:21Z",
      "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
      "tag_info": null,
      "end_reason": "last_participant_left",
      "start_time": null,
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "create_time": "2021-10-12T18:09:21Z",
      "mixer_region": "us1",
      "friendly_name": "conference 2",
      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
      "detected_issues": {
        "call_quality": 1,
        "participant_behavior": 0,
        "region_configuration": 0
      },
      "duration_seconds": 1,
      "max_participants": 250,
      "processing_state": "complete",
      "recording_enabled": false,
      "unique_participants": 3,
      "mixer_region_requested": null,
      "connect_duration_seconds": 0,
      "max_concurrent_participants": 2
    }
  ]
}
{
  "meta": {
    "key": "conferences",
    "url": "https://insights.twilio.com/v1/Conferences?MixerRegion=au1&Status=completed&PageSize=25&Page=0",
    "page": 0,
    "page_size": 25,
    "next_page_url": null,
    "first_page_url": "https://insights.twilio.com/v1/Conferences?MixerRegion=au1&Status=completed&PageSize=25&Page=0",
    "previous_page_url": null
  },
  "conferences": [
    {
      "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "tags": [
        "region_configuration_issues"
      ],
      "links": {
        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants"
      },
      "status": "completed",
      "end_time": "2021-10-12T18:20:17Z",
      "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "tag_info": null,
      "end_reason": "participant_with_end_conference_on_exit_kicked",
      "start_time": "2021-10-12T18:19:10Z",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "create_time": "2021-10-12T18:19:09Z",
      "mixer_region": "au1",
      "friendly_name": "conference 1",
      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "detected_issues": {
        "call_quality": 0,
        "participant_behavior": 0,
        "region_configuration": 2
      },
      "duration_seconds": 7,
      "max_participants": 250,
      "processing_state": "complete",
      "recording_enabled": true,
      "unique_participants": 2,
      "mixer_region_requested": "au1",
      "connect_duration_seconds": 5,
      "max_concurrent_participants": 2
    },
    {
      "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
      "tags": [
        "detected_silence",
        "region_configuration_issues",
        "participant_behavior_issues"
      ],
      "links": {
        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Participants"
      },
      "status": "completed",
      "end_time": "2021-10-12T18:17:20Z",
      "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
      "tag_info": null,
      "end_reason": "last_participant_left",
      "start_time": "2021-10-12T18:16:53Z",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "create_time": "2021-10-12T18:16:51Z",
      "mixer_region": "au1",
      "friendly_name": "conference 2",
      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
      "detected_issues": {
        "call_quality": 0,
        "participant_behavior": 3,
        "region_configuration": 2
      },
      "duration_seconds": 30,
      "max_participants": 250,
      "processing_state": "complete",
      "recording_enabled": false,
      "unique_participants": 2,
      "mixer_region_requested": null,
      "connect_duration_seconds": 27,
      "max_concurrent_participants": 2
    }
  ]
}
{
  "meta": {
    "key": "conferences",
    "url": "https://insights.twilio.com/v1/Conferences?FriendlyName=outboundConfCallTransferThrice_1&Status=not_started&PageSize=25&Page=0",
    "page": 0,
    "page_size": 25,
    "next_page_url": null,
    "first_page_url": "https://insights.twilio.com/v1/Conferences?FriendlyName=outboundConfCallTransferThrice_1&Status=not_started&PageSize=25&Page=0",
    "previous_page_url": null
  },
  "conferences": [
    {
      "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "tags": [
        "participant_behavior_issues",
        "start_failure"
      ],
      "links": {
        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants"
      },
      "status": "not_started",
      "end_time": "2021-11-18T00:09:52Z",
      "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "tag_info": {
        "start_failure": {
          "reason": "no_concurrent_participants"
        }
      },
      "end_reason": "last_participant_left",
      "start_time": null,
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "create_time": "2021-11-18T00:09:09Z",
      "mixer_region": null,
      "friendly_name": "outboundConfCallTransferThrice_1",
      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "detected_issues": {
        "call_quality": 0,
        "participant_behavior": 0,
        "region_configuration": 0
      },
      "duration_seconds": 7,
      "max_participants": 250,
      "processing_state": "complete",
      "recording_enabled": false,
      "unique_participants": 1,
      "mixer_region_requested": null,
      "connect_duration_seconds": 0,
      "max_concurrent_participants": 1
    }
  ]
}
{
  "meta": {
    "key": "conferences",
    "url": "https://insights.twilio.com/v1/Conferences?Tags=duplicate_identity&PageSize=25&Page=0",
    "page": 0,
    "page_size": 25,
    "next_page_url": null,
    "first_page_url": "https://insights.twilio.com/v1/Conferences?Tags=duplicate_identity&PageSize=25&Page=0",
    "previous_page_url": null
  },
  "conferences": [
    {
      "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "tags": [
        "duplicate_identity",
        "detected_silence",
        "participant_behavior_issues"
      ],
      "links": {
        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants"
      },
      "status": "not_started",
      "end_time": "2021-11-17T16:22:11Z",
      "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "tag_info": null,
      "end_reason": "last_participant_left",
      "start_time": "2021-11-17T16:21:45Z",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "create_time": "2021-11-17T16:21:40Z",
      "mixer_region": "us1",
      "friendly_name": "conference 1",
      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "detected_issues": {
        "call_quality": 0,
        "participant_behavior": 0,
        "region_configuration": 0
      },
      "duration_seconds": 32,
      "max_participants": 250,
      "processing_state": "complete",
      "recording_enabled": false,
      "unique_participants": 4,
      "mixer_region_requested": null,
      "connect_duration_seconds": 27,
      "max_concurrent_participants": 3
    }
  ]
}
{
  "meta": {
    "key": "conferences",
    "url": "https://insights.twilio.com/v1/Conferences?DetectedIssues=call_quality&EndReason=participant_with_end_conference_on_exit_left&PageSize=25&Page=0",
    "page": 0,
    "page_size": 25,
    "next_page_url": null,
    "first_page_url": "https://insights.twilio.com/v1/Conferences?DetectedIssues=call_quality&EndReason=participant_with_end_conference_on_exit_left&PageSize=25&Page=0",
    "previous_page_url": null
  },
  "conferences": [
    {
      "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "tags": [
        "high_packet_loss",
        "low_mos",
        "participant_behavior_issues",
        "quality_warnings",
        "high_jitter",
        "detected_silence"
      ],
      "links": {
        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants"
      },
      "status": "not_started",
      "end_time": "2021-11-17T16:22:11Z",
      "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "tag_info": null,
      "end_reason": "participant_with_end_conference_on_exit_left",
      "start_time": "2021-11-17T16:21:45Z",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "create_time": "2021-11-17T16:21:40Z",
      "mixer_region": "us1",
      "friendly_name": "conference 1",
      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "detected_issues": {
        "call_quality": 3,
        "participant_behavior": 1,
        "region_configuration": 0
      },
      "duration_seconds": 32,
      "max_participants": 250,
      "processing_state": "complete",
      "recording_enabled": false,
      "unique_participants": 3,
      "mixer_region_requested": null,
      "connect_duration_seconds": 27,
      "max_concurrent_participants": 3
    }
  ]
}