Get a specific Conference Summary.

GET /v1/Conferences/{ConferenceSid}

Get a specific Conference Summary.

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

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

GET /v1/Conferences/{ConferenceSid}
curl \
 --request GET 'https://insights.twilio.com/v1/Conferences/{ConferenceSid}' \
 --user "username:password"
Response examples (200)
{
  "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": "completed",
  "end_time": "2021-10-08T03:00:02Z",
  "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "tag_info": null,
  "end_reason": "last_participant_left",
  "start_time": "2021-10-08T02:58:51Z",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "create_time": "2021-10-08T02:58:47Z",
  "mixer_region": "us1",
  "friendly_name": "conference1",
  "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "detected_issues": {
    "call_quality": 1,
    "participant_behavior": 3,
    "region_configuration": 0
  },
  "duration_seconds": 76,
  "max_participants": 250,
  "processing_state": "complete",
  "recording_enabled": false,
  "unique_participants": 4,
  "mixer_region_requested": "us1",
  "connect_duration_seconds": 72,
  "max_concurrent_participants": 4
}