Retrieve a Conference

View as MarkdownOpen in Claude
Retrieves one voice conference by SID so you can inspect a known conference and its current activity. Use [List All Conferences](/docs/compatibility-api/rest/conferences/list-all-conferences) to discover SIDs; Video Conferences are separate hosted video resources. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account that created this conference.
SidstringRequiredformat: "uuid"
The unique identifier for this conference.

Response

The request has succeeded.
sidstringformat: "uuid"
The unique identifier for this conference.
account_sidstringformat: "uuid"
The unique identifier for the account that created this conference.
date_createdstring
The date, in RFC 2822 format, this conference was created.
date_updatedstring
The date, in RFC 2822 format, this conference was updated.
friendly_namestring
A description, up to 64 characters, of the conference room.
statusenum
The status of this conference.
api_versionstring
The version of the SignalWire API.
regionstring
The region where this conference audio was mixed.
uristring
The URI for this conference.
subresource_urisobject
The links to associated subresources.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error