Zoom Public API Documentation
List sessions
GET {{baseUrl}}/videosdk/sessions?type=live&from=2021-10-11&to=2021-10-11&page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82
Use this API to display the total live or past sessions that occurred during a specified period of time. You can specify a monthly date range for this data using the The overview response displays whether features such as audio, video, screensharing, and recording were used during the session. Rate Limit Label: Prerequisites:
* A Video SDK accountfrom and to query parameters. The month should fall within the last six months.Resource-intensive
Body
PARAM
| Key | Datatype | Required | Description |
type
|
string | The type of session to query: * `past` — A past session that occurred during the specified date range. * `live` — A live sessions. This parameter defaults to `live`. | |
from
|
string | (Required) The start date to query, in `yyyy-mm-dd` format. The ranges defined in the `from` and `to` parameters should **only** be a one month range. This is because the report only includes one month's worth of data. | |
to
|
string | (Required) The end date to query, in `yyyy-mm-dd` format. The ranges defined in the `from` and `to` parameters should **only** be a one month range. This is because the report only includes one month's worth of data. | |
page_size
|
number | The number of records returned within a single API call. | |
next_page_token
|
string | The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"from": "2021-10-11",
"to": "2021-10-11",
"page_size": 50,
"next_page_token": "suQA5LvDBnH5No5OYD7mqpJuFzJqUOHK8U2",
"sessions": [
{
"id": "sfk/aOFJSJSYhGwk1hnxgw==",
"session_name": "My session",
"start_time": "2021-12-07T05:42:28Z",
"end_time": "2021-12-07T05:42:28Z",
"duration": "30:00",
"user_count": 2,
"has_voip": true,
"has_video": true,
"has_screen_share": true,
"has_recording": true,
"has_pstn": true,
"session_key": "my_session_key"
},
{
"id": "sfk/aOFJSJSYhGwk1hnxgw==",
"session_name": "My session",
"start_time": "2021-12-07T05:42:28Z",
"end_time": "2021-12-07T05:42:28Z",
"duration": "30:00",
"user_count": 2,
"has_voip": true,
"has_video": true,
"has_screen_share": true,
"has_recording": true,
"has_pstn": true,
"session_key": "my_session_key"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/videosdk/sessions?type=live&from=2021-10-11&to=2021-10-11&page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82?type=live&from=2021-10-11&to=2021-10-11&page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82' -H 'Accept: application/json'
ENDPOINTS