Get Conference Details
Get the details of the conference. An empty JSON object body is returned if there is no conference.
GET/v1/telephony/conference
Response Properties
state
Conference State Enum
The state of the conference.
connected
string
held
string
disconnected
string
appearance
number
The appearance index for the conference leg. Only present when the conference has an appearance value assigned.
created
string
The conference start time in ISO 8601 format.
muted
boolean
Indicates if the host of the conference has been muted.
type
Conference Type Enum
The type of conference for a non-standard conference.
bargeIn
string
silentMonitoring
string
coaching
string
participants
array[Conference Participant]
The participants in the conference.
callId
string
The callId of the call.
muted
boolean
Indicates if the participant has been muted.
deafened
boolean
Indicates if the participant has been deafened (i.e. media stream is not being transmitting to the participant)
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
GET
/v1/telephony/conference
Log in to try the API.
Header
200 / OK
{
"state": "connected",
"appearance": 3,
"created": "2023-03-02T15:00:00.000Z",
"muted": false,
"participants": [
{
"callId": "Y2lzY29zcGFyazovL3VzL0NBTEwvQkNMRC9jYWxsaGFsZi00ODg6MA",
"muted": false,
"deafened": false
},
{
"callId": "Y2lzY29zcGFyazovL3VzL0NBTEwvQkNMRC9jYWxsaGFsZi00ODg6MQ",
"muted": false,
"deafened": false
}
]
}