Skip to content

conferences.md

Latest commit

 

History

History
100 lines (66 loc) · 3.78 KB

conferences.md

File metadata and controls

100 lines (66 loc) · 3.78 KB

freeclimb conferences

A Conference represents a call between two or more participants.

freeclimb conferences:create

Create an empty Conference within the specified account.

USAGE
  $ freeclimb conferences:create

OPTIONS
  -a, --alias=alias                          A description for this Conference. Maximum 64 characters.

  -b, --playBeep=playBeep                    Controls when a beep is played. Valid values: always, never, entryOnly,
                                             exitOnly.

  -h, --help                                 show CLI help

  -r, --record=true|false                    Setting to true records the entire Conference.

  -s, --statusCallbackUrl=statusCallbackUrl  This URL is invoked when the status of the Conference changes.

  -w, --waitUrl=waitUrl                      If specified, a URL for the audio file that provides custom hold music for
                                             the Conference when it is in the populated state. Otherwise, FreeClimb uses
                                             a system default audio file. This is always fetched using HTTP GET and is
                                             fetched just once - when the Conference is created.

See code: src/commands/conferences/create.ts

freeclimb conferences:get CONFERENCEID

Retrieve a representation of the specified conference.

USAGE
  $ freeclimb conferences:get CONFERENCEID

ARGUMENTS
  CONFERENCEID  A string that uniquely identifies this conference resource.

OPTIONS
  -h, --help  show CLI help

See code: src/commands/conferences/get.ts

freeclimb conferences:list

Retrieve a list of Conferences associated with the specified account, sorted by creation date, newest to oldest.

USAGE
  $ freeclimb conferences:list

OPTIONS
  -D, --dateUpdated=dateUpdated  Only show Conferences that were last updated on the specified date, in the form
                                 YYYY-MM-DD.

  -S, --status=status            Only show conferences that currently have the specified status. Valid values: empty,
                                 populated, inProgress, or terminated.

  -a, --alias=alias              List Conferences whose alias exactly matches this string.

  -d, --dateCreated=dateCreated  Only show Conferences that were created on the specified date, in the form YYYY-MM-DD.

  -h, --help                     show CLI help

  -n, --next                     Displays the next page of output.

See code: src/commands/conferences/list.ts

freeclimb conferences:update CONFERENCEID

Update the properties of the specified conference.

USAGE
  $ freeclimb conferences:update CONFERENCEID

ARGUMENTS
  CONFERENCEID  String that uniquely identifies this conference resource.

OPTIONS
  -S, --status=status      New status of the conference. Valid values: empty or terminated.
  -a, --alias=alias        Description for this conference. Maximum 64 characters.
  -b, --playBeep=playBeep  Controls when a beep is played. Valid values: always, never, entryOnly, exitOnly.
  -h, --help               show CLI help

See code: src/commands/conferences/update.ts