Retrieve a list of Conferences

GET /v1/Conferences

TODO: Resource-level docs

Retrieve a list of Conferences.

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.

  • 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

    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.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • conferences array[object]
      Hide conferences attributes Show conferences attributes
      • account_sid string | null

        Account SID.

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

      • conference_sid string | null

        Conference SID.

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

      • connect_duration_seconds integer | null

        Duration of the conference in seconds.

      • create_time string(date-time) | null

        Conference creation date/time.

      • detected_issues

        Potential issues detected during the conference.

      • duration_seconds integer | null

        Conference duration in seconds.

      • end_reason string | null

        Conference end reason.

        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.

      • end_time string(date-time) | null

        Conference end date/time.

      • ended_by string | null

        Call SID that ended the conference.

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

      • friendly_name string | null

        Custom label for the conference.

      • links object(uri-map) | null

        Nested resource URLs.

      • max_concurrent_participants integer | null

        Actual maximum concurrent participants.

      • max_participants integer | null

        Max participants specified in config.

      • mixer_region string | null

        Region where the conference was mixed.

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

      • mixer_region_requested string | null

        Configuration-requested conference mixer region.

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

      • processing_state string | null

        Processing state for the Conference Summary resource.

        Values are complete, in_progress, or timeout.

      • recording_enabled boolean | null

        Boolean. Indicates whether recording was enabled.

      • start_time string(date-time) | null

        Timestamp in ISO 8601 format when the conference started.

      • status string | null

        Status of conference

        Values are in_progress, not_started, completed, or summary_timeout.

      • tag_info

        Object. Contains details about conference tags.

      • tags array[string] | null

        Tags for detected conference conditions and participant behaviors.

        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, or detected_silence.

      • unique_participants integer | null

        Unique conference participants.

      • url string(uri) | null

        The URL of this resource.

    • meta object
      Hide meta attributes Show meta attributes
GET /v1/Conferences 
curl \
 -X GET https://insights.twilio.com/v1/Conferences \
 --user "username:password"
Response examples (200) 
{
  "conferences": [
    {
      "account_sid": "string",
      "conference_sid": "string",
      "connect_duration_seconds": 42,
      "create_time": "2023-05-04T09:42:00+00:00",
      "duration_seconds": 42,
      "end_reason": "last_participant_left",
      "end_time": "2023-05-04T09:42:00+00:00",
      "ended_by": "string",
      "friendly_name": "string",
      "links": {},
      "max_concurrent_participants": 42,
      "max_participants": 42,
      "mixer_region": "us1",
      "mixer_region_requested": "us1",
      "processing_state": "complete",
      "recording_enabled": true,
      "start_time": "2023-05-04T09:42:00+00:00",
      "status": "in_progress",
      "tags": [
        "invalid_requested_region"
      ],
      "unique_participants": 42,
      "url": "https://example.com"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}