Skip to content

Latest commit

 

History

History
609 lines (435 loc) · 20.1 KB

ConferencesApi.md

File metadata and controls

609 lines (435 loc) · 20.1 KB

ConferencesApi

All URIs are relative to http://localhost

Method HTTP request Description
downloadConferenceRecording GET /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId}/media Download Conference Recording
getConference GET /accounts/{accountId}/conferences/{conferenceId} Get Conference Information
getConferenceMember GET /accounts/{accountId}/conferences/{conferenceId}/members/{memberId} Get Conference Member
getConferenceRecording GET /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId} Get Conference Recording Information
listConferenceRecordings GET /accounts/{accountId}/conferences/{conferenceId}/recordings Get Conference Recordings
listConferences GET /accounts/{accountId}/conferences Get Conferences
updateConference POST /accounts/{accountId}/conferences/{conferenceId} Update Conference
updateConferenceBxml PUT /accounts/{accountId}/conferences/{conferenceId}/bxml Update Conference BXML
updateConferenceMember PUT /accounts/{accountId}/conferences/{conferenceId}/members/{memberId} Update Conference Member

downloadConferenceRecording

File downloadConferenceRecording()

Downloads the specified recording file.

Example

import {
    ConferencesApi,
    Configuration
} from 'bandwidth-sdk';

const configuration = new Configuration();
const apiInstance = new ConferencesApi(configuration);

let accountId: string; //Your Bandwidth Account ID. (default to undefined)
let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined)
let recordingId: string; //Programmable Voice API Recording ID. (default to undefined)

const { status, data } = await apiInstance.downloadConferenceRecording(
    accountId,
    conferenceId,
    recordingId
);

Parameters

Name Type Description Notes
accountId [string] Your Bandwidth Account ID. defaults to undefined
conferenceId [string] Programmable Voice API Conference ID. defaults to undefined
recordingId [string] Programmable Voice API Recording ID. defaults to undefined

Return type

File

Authorization

Basic, OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: audio/vnd.wave, audio/mpeg, application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
405 Method Not Allowed -
415 Unsupported Media Type -
429 Too Many Requests * Retry-After - When you should try your request again.
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConference

Conference getConference()

Returns information about the specified conference.

Example

import {
    ConferencesApi,
    Configuration
} from 'bandwidth-sdk';

const configuration = new Configuration();
const apiInstance = new ConferencesApi(configuration);

let accountId: string; //Your Bandwidth Account ID. (default to undefined)
let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined)

const { status, data } = await apiInstance.getConference(
    accountId,
    conferenceId
);

Parameters

Name Type Description Notes
accountId [string] Your Bandwidth Account ID. defaults to undefined
conferenceId [string] Programmable Voice API Conference ID. defaults to undefined

Return type

Conference

Authorization

Basic, OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
405 Method Not Allowed -
415 Unsupported Media Type -
429 Too Many Requests * Retry-After - When you should try your request again.
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConferenceMember

ConferenceMember getConferenceMember()

Returns information about the specified conference member.

Example

import {
    ConferencesApi,
    Configuration
} from 'bandwidth-sdk';

const configuration = new Configuration();
const apiInstance = new ConferencesApi(configuration);

let accountId: string; //Your Bandwidth Account ID. (default to undefined)
let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined)
let memberId: string; //Programmable Voice API Conference Member ID. (default to undefined)

const { status, data } = await apiInstance.getConferenceMember(
    accountId,
    conferenceId,
    memberId
);

Parameters

Name Type Description Notes
accountId [string] Your Bandwidth Account ID. defaults to undefined
conferenceId [string] Programmable Voice API Conference ID. defaults to undefined
memberId [string] Programmable Voice API Conference Member ID. defaults to undefined

Return type

ConferenceMember

Authorization

Basic, OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
405 Method Not Allowed -
415 Unsupported Media Type -
429 Too Many Requests * Retry-After - When you should try your request again.
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConferenceRecording

ConferenceRecordingMetadata getConferenceRecording()

Returns metadata for the specified recording.

Example

import {
    ConferencesApi,
    Configuration
} from 'bandwidth-sdk';

const configuration = new Configuration();
const apiInstance = new ConferencesApi(configuration);

let accountId: string; //Your Bandwidth Account ID. (default to undefined)
let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined)
let recordingId: string; //Programmable Voice API Recording ID. (default to undefined)

const { status, data } = await apiInstance.getConferenceRecording(
    accountId,
    conferenceId,
    recordingId
);

Parameters

Name Type Description Notes
accountId [string] Your Bandwidth Account ID. defaults to undefined
conferenceId [string] Programmable Voice API Conference ID. defaults to undefined
recordingId [string] Programmable Voice API Recording ID. defaults to undefined

Return type

ConferenceRecordingMetadata

Authorization

Basic, OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
405 Method Not Allowed -
415 Unsupported Media Type -
429 Too Many Requests * Retry-After - When you should try your request again.
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listConferenceRecordings

Array listConferenceRecordings()

Returns a (potentially empty) list of metadata for the recordings that took place during the specified conference.

Example

import {
    ConferencesApi,
    Configuration
} from 'bandwidth-sdk';

const configuration = new Configuration();
const apiInstance = new ConferencesApi(configuration);

let accountId: string; //Your Bandwidth Account ID. (default to undefined)
let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined)

const { status, data } = await apiInstance.listConferenceRecordings(
    accountId,
    conferenceId
);

Parameters

Name Type Description Notes
accountId [string] Your Bandwidth Account ID. defaults to undefined
conferenceId [string] Programmable Voice API Conference ID. defaults to undefined

Return type

Array

Authorization

Basic, OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
405 Method Not Allowed -
415 Unsupported Media Type -
429 Too Many Requests * Retry-After - When you should try your request again.
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listConferences

Array listConferences()

Returns a max of 1000 conferences, sorted by createdTime from oldest to newest. NOTE: If the number of conferences in the account is bigger than pageSize, a Link header (with format <{url}>; rel=\"next\") will be returned in the response. The url can be used to retrieve the next page of conference records.

Example

import {
    ConferencesApi,
    Configuration
} from 'bandwidth-sdk';

const configuration = new Configuration();
const apiInstance = new ConferencesApi(configuration);

let accountId: string; //Your Bandwidth Account ID. (default to undefined)
let name: string; //Filter results by the `name` field. (optional) (default to undefined)
let minCreatedTime: string; //Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format). (optional) (default to undefined)
let maxCreatedTime: string; //Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format). (optional) (default to undefined)
let pageSize: number; //Specifies the max number of conferences that will be returned. (optional) (default to 1000)
let pageToken: string; //Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. (optional) (default to undefined)

const { status, data } = await apiInstance.listConferences(
    accountId,
    name,
    minCreatedTime,
    maxCreatedTime,
    pageSize,
    pageToken
);

Parameters

Name Type Description Notes
accountId [string] Your Bandwidth Account ID. defaults to undefined
name [string] Filter results by the `name` field. (optional) defaults to undefined
minCreatedTime [string] Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format). (optional) defaults to undefined
maxCreatedTime [string] Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format). (optional) defaults to undefined
pageSize [number] Specifies the max number of conferences that will be returned. (optional) defaults to 1000
pageToken [string] Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. (optional) defaults to undefined

Return type

Array

Authorization

Basic, OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
405 Method Not Allowed -
415 Unsupported Media Type -
429 Too Many Requests * Retry-After - When you should try your request again.
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateConference

updateConference(updateConference)

Update the conference state.

Example

import {
    ConferencesApi,
    Configuration,
    UpdateConference
} from 'bandwidth-sdk';

const configuration = new Configuration();
const apiInstance = new ConferencesApi(configuration);

let accountId: string; //Your Bandwidth Account ID. (default to undefined)
let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined)
let updateConference: UpdateConference; //

const { status, data } = await apiInstance.updateConference(
    accountId,
    conferenceId,
    updateConference
);

Parameters

Name Type Description Notes
updateConference UpdateConference
accountId [string] Your Bandwidth Account ID. defaults to undefined
conferenceId [string] Programmable Voice API Conference ID. defaults to undefined

Return type

void (empty response body)

Authorization

Basic, OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 Conference was successfully modified. -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
405 Method Not Allowed -
415 Unsupported Media Type -
429 Too Many Requests * Retry-After - When you should try your request again.
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateConferenceBxml

updateConferenceBxml(body)

Update the conference BXML document.

Example

import {
    ConferencesApi,
    Configuration
} from 'bandwidth-sdk';

const configuration = new Configuration();
const apiInstance = new ConferencesApi(configuration);

let accountId: string; //Your Bandwidth Account ID. (default to undefined)
let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined)
let body: string; //

const { status, data } = await apiInstance.updateConferenceBxml(
    accountId,
    conferenceId,
    body
);

Parameters

Name Type Description Notes
body string
accountId [string] Your Bandwidth Account ID. defaults to undefined
conferenceId [string] Programmable Voice API Conference ID. defaults to undefined

Return type

void (empty response body)

Authorization

Basic, OAuth2

HTTP request headers

  • Content-Type: application/xml
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 Conference successfully modified. -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
405 Method Not Allowed -
415 Unsupported Media Type -
429 Too Many Requests * Retry-After - When you should try your request again.
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateConferenceMember

updateConferenceMember(updateConferenceMember)

Updates settings for a particular conference member.

Example

import {
    ConferencesApi,
    Configuration,
    UpdateConferenceMember
} from 'bandwidth-sdk';

const configuration = new Configuration();
const apiInstance = new ConferencesApi(configuration);

let accountId: string; //Your Bandwidth Account ID. (default to undefined)
let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined)
let memberId: string; //Programmable Voice API Conference Member ID. (default to undefined)
let updateConferenceMember: UpdateConferenceMember; //

const { status, data } = await apiInstance.updateConferenceMember(
    accountId,
    conferenceId,
    memberId,
    updateConferenceMember
);

Parameters

Name Type Description Notes
updateConferenceMember UpdateConferenceMember
accountId [string] Your Bandwidth Account ID. defaults to undefined
conferenceId [string] Programmable Voice API Conference ID. defaults to undefined
memberId [string] Programmable Voice API Conference Member ID. defaults to undefined

Return type

void (empty response body)

Authorization

Basic, OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 Conference member was successfully modified. -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
405 Method Not Allowed -
415 Unsupported Media Type -
429 Too Many Requests * Retry-After - When you should try your request again.
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]