Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.
Conference Bridges
GET /conferenceBridges/{organizationId}/{id}
Description
Retrieve the specified conferenceBridge within an organization.
Response Class
ConferenceBridgeWrapperInstanceResult
Method
GET
Parameters
Parameter | Mandatory | Type | Default Value | Description |
---|---|---|---|---|
credentials | Yes | String | Basic Authorization header. | |
organizationId | Yes | Long | The ID of the organization containing the conferenceBridge. | |
id | Yes | String | The ID of the conferenceBridge to return. | |
idType | No | String | Whether to search by conferenceBridge.id or conferenceBridge.name. |
PUT /conferenceBridges/{organizationId}/id
Description
Update a conferenceBridge within an organization.
Response Class
RestfulModificationResult
Method
PUT
Parameters
Parameter | Mandatory | Type | Default Value | Description |
---|---|---|---|---|
credentials | Yes | String | Basic Authorization Header. | |
organizationId | Yes | Long | The ID of the organization containing the conferenceBridge. | |
id | Yes | String | The ID of the conferenceBridge to update. | |
idType | No | String | Whether to search by conferenceBridge.id or conferenceBridge.name. | |
conferenceBridge | Yes | ConferenceBridgeWrapper | JSON object describing the updated conferenceBridge. |
DELETE /conferenceBridges/{organizationId}/id
Description
Delete the specified conferenceBridge from an organization.
Response Class
RestfulModificationResult
Method
DELETE
Parameters
Parameter | Mandatory | Type | Default Value | Description |
---|---|---|---|---|
credentials | Yes | String | Basic Authorization Header. | |
organizationId | Yes | Long | The ID of the organization containing the conferenceBridge. | |
id | Yes | String | The ID of the conferenceBridge to delete. | |
idType | No | String | Whether to search by conferenceBridge.id or conferenceBridge.name. |
POST /conferenceBridges/{organizationId}
Description
Create a new conferenceBridge within an organization.
Response Class
RestfulModificationResult
Method
POST
Parameters
Parameter | Mandatory | Type | Default Value | Description |
---|---|---|---|---|
credentials | Yes | String | Basic Authorization Header. | |
organizationId | Yes | Long | The ID of the organization containing the conferenceBridge. | |
conferenceBridge | Yes | ConferenceBridgeWrapper | JSON object describing the new conferenceBridge. |
GET /conferenceBridges/{organizationId}
Description
Retrieve all conferenceBridges for an organization.
Response Class
RestfulCollectionResult
Method
GET
Parameters
Parameter | Mandatory | Type | Default Value | Description |
---|---|---|---|---|
credentials | Yes | String | Basic Authorization Header. | |
organizationId | Yes | Long | The ID of the organization containing the conferenceBridge. | |
pageNumber | No | int | The page number of conferenceBridges to return. |