Skip to main content

Retrieve a conference

GET 
/conferences/:id

Retrieve an existing conference

Request​

Path Parameters

    id stringrequired

    Uniquely identifies the conference by id

Responses​

200: Successful response with details about a conference.

Schema

    data

    object

    record_type stringrequired

    Possible values: [conference]

    id stringrequired

    Uniquely identifies the conference

    name stringrequired

    Name of the conference

    created_at stringrequired

    ISO 8601 formatted date of when the conference was created

    expires_at stringrequired

    ISO 8601 formatted date of when the conference will expire

    updated_at string

    ISO 8601 formatted date of when the conference was last updated

    region string

    Region where the conference is hosted

    status string

    Possible values: [init, in_progress, completed]

    Status of the conference

    end_reason string

    Possible values: [all_left, ended_via_api, host_left, time_exceeded]

    Reason why the conference ended

    ended_by

    object

    IDs related to who ended the conference. It is expected for them to all be there or all be null

    call_control_id string

    Call Control ID which ended the conference

    call_session_id string

    Call Session ID which ended the conference

    IDs related to who ended the conference. It is expected for them to all be there or all be null

    connection_id string

    Identifies the connection associated with the conference

404: Conference does not exist

Loading...