Skip to content

call-queues.md

Latest commit

 

History

History
81 lines (55 loc) · 2.62 KB

call-queues.md

File metadata and controls

81 lines (55 loc) · 2.62 KB

freeclimb call-queues

Queues are the primary means of keeping callers waiting. Queues can be created ahead of time and are deleted automatically when they change state from populated to empty.

freeclimb call-queues:create

Create a Queue within the specified account.

USAGE
  $ freeclimb call-queues:create

OPTIONS
  -M, --maxSize=maxSize  Maximum number of Calls this queue can hold. Default is 1000. Maximum is 1000.
  -a, --alias=alias      A description for this Queue. Max length is 64 characters.
  -h, --help             show CLI help

See code: src/commands/call-queues/create.ts

freeclimb call-queues:get QUEUEID

Retrieve a representation of the specified Queue.

USAGE
  $ freeclimb call-queues:get QUEUEID

ARGUMENTS
  QUEUEID  A string that uniquely identifies this queue resource.

OPTIONS
  -h, --help  show CLI help

See code: src/commands/call-queues/get.ts

freeclimb call-queues:list

Retrieve a list of active Queues associated with the specified account.

USAGE
  $ freeclimb call-queues:list

OPTIONS
  -a, --alias=alias  Return only the Queue resources with aliases that exactly match this name.
  -h, --help         show CLI help
  -n, --next         Displays the next page of output.

See code: src/commands/call-queues/list.ts

freeclimb call-queues:update QUEUEID

Update the properties of the specified queue.

USAGE
  $ freeclimb call-queues:update QUEUEID

ARGUMENTS
  QUEUEID  A string that uniquely identifies this Queue resource.

OPTIONS
  -M, --maxSize=maxSize  Maximum number of calls this queue can hold. Default is 100. Maximum is 1000. Note: Reducing
                         the maxSize of a Queue causes the Queue to reject incoming requests until it shrinks below the
                         new value of maxSize.

  -a, --alias=alias      Description for this Queue. Max length is 64 characters.

  -h, --help             show CLI help

See code: src/commands/call-queues/update.ts