Wipple CPaaS
Menu
REST API / List conferences

List conferences

GEThttps://{API_ENDPOINT}/v1/Accounts/{AccountSid}/Conferences

Authentication

  • Authorization header (bearer token, required) — Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Path parameters

  • AccountSidstringrequired

Query parameters

  • expandenumoptionalWhen set to "participants", returns live rooms with duration and per-member details (call_sid, label, memberTag) instead of a plain list of conference names. Only in-progress call legs are included.
  • Allowed values: participants

Response

200

list of conferences for a specified account. A plain array of conference names by default; an array of ConferenceRoom objects when expand=participants.

  • Conferences_listConferences_Response_200

Errors

500 Internal Server Error

system error

  • msgstringrequired

Examples

Request

{}

Response

[
  "conf_9f8b7c6d5e4a3b2c1d0e"
]

cURL

curl -X GET "https://{API_ENDPOINT}/v1/Accounts/AccountSid/Conferences" \
  -H "Authorization: Bearer <token>"

Python

import requests

url = "https://{API_ENDPOINT}/v1/Accounts/AccountSid/Conferences"

headers = {
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.json())

JavaScript

const url = 'https://{API_ENDPOINT}/v1/Accounts/AccountSid/Conferences';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}