> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes. # List conference logs GET https://%7BYour_Space_Name%7D.signalwire.com/api/logs/conferences Lists historical voice conferences and Video Room or Conference sessions across the project. Use it for usage reporting and auditing across conference types, not for live control. Use Compatibility [Conferences](/docs/compatibility-api/rest/conferences/list-all-conferences) to inspect or control live voice conferences, or [Video Conferences](/docs/apis/rest/video/video-conferences/list-video-conferences) to manage hosted video conference configurations. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_ or _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space). Reference: https://signalwire.com/docs/apis/rest/conference-logs/list-conferences ## Authentication - `Authorization` header (basic auth, required) — 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) ``` ## Request ### Query parameters - `include_deleted` (boolean, optional) — Include logs for deleted activity. - `created_on` (string, optional) — Return logs for activity on this date. Accepts a date (YYYY-MM-DD) or ISO 8601 timestamp. - `created_before` (string, optional) — Return logs for activity prior to this date. Accepts a date (YYYY-MM-DD) or ISO 8601 timestamp. - `created_after` (string, optional) — Return logs for activity after this date. Accepts a date (YYYY-MM-DD) or ISO 8601 timestamp. - `page_number` (integer, optional, default: 0) — The page number to retrieve (0-indexed). - `page_size` (integer, optional, default: 50) — Specify the number of results to return on a single page. The default page size is `50` and the maximum is `1000`. - `page_token` (string, optional) — Token for cursor-based pagination. Required when `page_number` > 0. ## Response ### 200 The request has succeeded. - `links` (Logs.ConferenceLogPaginationLinks, required) — Pagination links. - `data` (list of LogsConferencesResponseDataItems, required) — A list of conference logs. ## Errors ### 401 Unauthorized Error Access is unauthorized. - `error` (enum, required) - Allowed values: `Unauthorized` ### 422 Unprocessable Entity Error The request contains invalid parameters. See errors for details. - `errors` (list of Types.StatusCodes.RestApiErrorItem, required) — List of validation errors. ### 500 Internal Server Error An internal server error occurred. - `error` (enum, required) - Allowed values: `Internal Server Error` ## Types ### Logs.ConferenceLogPaginationLinks Pagination links for conference log list responses. - `self` (string, required) — Link to the current page. - `first` (string, required) — Link to the first page. - `next` (string, optional) — Link to the next page. Only present when there are more results. - `prev` (string, optional) — Link to the previous page. Only present when not on the first page. ### LogsConferencesResponseDataItems ### Types.StatusCodes.RestApiErrorItem Details about a specific error. - `type` (string, required) — The category of error. - `code` (string, required) — A specific error code. - `message` (string, required) — A description of what caused the error. - `url` (string, required) — A link to documentation about this error. - `attribute` (string, optional, nullable) — The request parameter that caused the error, if applicable. ### Logs.CxmlConference Core conference object. - `id` (string, required) — Unique identifier for the conference. - `created_at` (datetime, required) — Creation timestamp. - `project_id` (string, required) — Project ID of the conference. - `region` (string, required) — Region of the conference. - `name` (string, required, nullable) — Name of the conference. - `status` (string, required, nullable) — Status of the conference. - `max_size` (integer, required, nullable) — Maximum size of the conference. - `current_participants` (integer, required) — Current participants in the conference. - `updated_at` (datetime, required) — Updated timestamp. - `type` (enum, required) — Type of the conference. - Allowed values: `cxml_conference` ### Logs.RelayConference Core conference object. - `id` (string, required) — Unique identifier for the conference. - `created_at` (datetime, required) — Creation timestamp. - `project_id` (string, required) — Project ID of the conference. - `region` (string, required) — Region of the conference. - `name` (string, required, nullable) — Name of the conference. - `status` (string, required, nullable) — Status of the conference. - `max_size` (integer, required, nullable) — Maximum size of the conference. - `current_participants` (integer, required) — Current participants in the conference. - `updated_at` (datetime, required) — Updated timestamp. - `type` (enum, required) — Type of the conference. - Allowed values: `relay_conference` - `recording_url` (string, required, nullable) — Recording URL of the conference. - `recording_duration` (integer, required, nullable) — Recording duration of the conference. - `recording_file_size` (integer, required, nullable) — Recording file size of the conference. ### Logs.VideoRoomSessionConference Core conference object. - `id` (string, required) — Unique identifier for the conference. - `created_at` (datetime, required) — Creation timestamp. - `source` (string, required) — Source of the conference. - `type` (enum, required) — Type of the conference. - Allowed values: `video_conference_session`, `video_room_session` - `url` (string, required) — URL of the conference room session. - `room_name` (string, required, nullable) — Name of the conference room. - `status` (string, required, nullable) — Status of the conference. - `locked` (boolean, required) — Whether the conference is locked. - `started_at` (datetime, required, nullable) — Timestamp when the conference started. - `ended_at` (datetime, required, nullable) — Timestamp when the conference ended. - `charge` (string, required) — Total charge amount of the conference in dollars. - `charge_details` (list of Logs.ChargeDetails, required) — Details on charges associated with this conference. ### Logs.ChargeDetails - `description` (string, required) — Description for this charge. - `charge` (string, required) — Charge amount in dollars. ## Examples **Response** ```json { "links": { "self": "https://example.signalwire.com/api/logs/conferences?page_number=0&page_size=50", "first": "https://example.signalwire.com/api/logs/conferences?page_size=50", "next": "https://example.signalwire.com/api/logs/conferences?page_number=1&page_size=50&page_token=PAb9028451-b1d3-4690-b5d3-37b19d25f573", "prev": "https://example.signalwire.com/api/logs/conferences?page_number=0&page_size=50&page_token=PBb9028451-b1d3-4690-b5d3-37b19d25f573" }, "data": [ { "created_at": "2025-03-11T01:49:49.630Z", "current_participants": 1, "id": "b9028451-b1d3-4690-b5d3-37b19d25f573", "max_size": 2, "name": "conference", "project_id": "a77ce7d0-6ae8-4b33-a7a6-0bf1750d1e19", "region": "us1", "status": "in-progress", "type": "cxml_conference", "updated_at": "2025-03-12T01:49:49.630Z" } ] } ``` **SDK Code** ```python import requests url = "https://{your_space_name}.signalwire.com/api/logs/conferences" response = requests.get(url, auth=("", "")) print(response.json()) ``` ```javascript const url = 'https://{your_space_name}.signalwire.com/api/logs/conferences'; const credentials = btoa(":"); const options = {method: 'GET', headers: {Authorization: `Basic ${credentials}`}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://{your_space_name}.signalwire.com/api/logs/conferences" req, _ := http.NewRequest("GET", url, nil) req.SetBasicAuth("", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://{your_space_name}.signalwire.com/api/logs/conferences") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request.basic_auth("", "") response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://{your_space_name}.signalwire.com/api/logs/conferences") .basicAuth("", "") .asString(); ``` ```php request('GET', 'https://{your_space_name}.signalwire.com/api/logs/conferences', [ 'headers' => [ ], 'auth' => ['', ''], ]); echo $response->getBody(); ``` ```csharp using RestSharp; using RestSharp.Authenticators; var client = new RestClient("https://{your_space_name}.signalwire.com/api/logs/conferences"); client.Authenticator = new HttpBasicAuthenticator("", ""); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let credentials = Data(":".utf8).base64EncodedString() let headers = ["Authorization": "Basic \(credentials)"] let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/logs/conferences")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```