Conference
You may explore this data model via the API Playground, by clicking here
Description
The conference model represents an active conference, currently running with connected participants in the domain.
Properties
| Property | Type | Editable | Description |
|---|---|---|---|
name | String | No | The name of the conference as specified by the voice application's <Conference> CXML dial noun. |
members | Number | No | The number of participants currently in the conference. |
domain | Domain | No | The domain account object that this conference belongs to. |
tenant | Tenant | No | The customer account object that this conference belongs to. |
API Reference
Base Path /customers/{customer}/domains/{domain}/conferences[/{name}]
The conference endpoint allows listing all of the active conferences in the domain, retrieving a conference by name or
deleting (ending) a conference. Conferences may only be created by a voice application executing the <Conference> CXML dial noun.
List Conferences
GET /customers/{customer}/domains/{domain}/conferences
Retrieve the list of active conferences as a JSON array of Conference model objects.
$ curl 'https://api.cloudonix.io/customers/self/domains/example.com/conferences' \
--header 'Authorization: Bearer XI•••••••••••••••' -s
Retrieve a Conference
GET /customers/{customer}/domains/{domain}/conferences/{name}
Retrieve a single active conference by name. If the specified conference name does not map to an existing active
conference (with 1 or more participants), the result will be a 404 Not Found error.
Delete a Conference
DELETE /customers/{customer}/domains/{domain}/conferences/{name}
Terminate a currently active conference call - the named conference will end for all participants by causing the
participant's voice application's <Conference> noun to end. If a participant's voice application has additional CXML
commands, or their <Dial> action returns another CXML voice application - their call will continue with those operations,
otherwise the participant's call will be hanged up.
Additional Endpoints
The above endpoints may also be accessed via the following canonical endpoint URLs:
GET /calls/{domain}/conferences[/{name}]
DELETE /calls/{domain}/conferences/{name}
As a BEST PRACTICE, we recommend using fully specified canonical URLs (the first option) when developing server side operations. When working with front-end applications, you may use the shorter notation, to prevent leakage of potentially private or restricted information.