Create a new call queue

This action will create a new call queue in the given unit.

Try this request in your browser

/api/ /call_queues/create

Headers

X-Auth-App
X-Auth-Token
X-Auth-Secret
X-Auth-Extension
X-Auth-Password
X-Proxy-Auth-Token
X-Proxy-Auth-Secret

Parameters

unit_id Integer
name String
strategy String
maximum_size Integer
max_wait_time Integer
periodic_announce_frequency Integer
noanswer_destination_type String
noanswer_destination_id Integer
play_ringing Integer
wrapuptime Integer
ring_busy_members Boolean
member_timeout Integer
pre_queue_audio_file_id Integer
post_queue_audio_file_id Integer
periodic_audio_file_id Integer
members Array

The request output will be shown here...

URL

https://connectapi.dial9.co.uk/api/v2/call_queues/create

Access

Must be authenticated as a user or API token. If not authorised, a AccessDenied error will be returned.

Parameters

Parameter Type Default

unit_id

The ID of the unit

Integer null

name

The name of the call queue

String null

strategy

The strategy to use for routing calls to members

String null

maximum_size

The maximum number of callers in the call queue

Integer null

max_wait_time

The maximum length of time to stay in queue before going to the no answer destination (seconds)

Integer null

periodic_announce_frequency

How frequently should the periodic audio file be played to callers

Integer null

noanswer_destination_type

The type of the no answer destination

String null

noanswer_destination_id

The ID of the no answer destination

Integer null

play_ringing

Whether or not to a play a ring tone rather than music on hold

Integer null

wrapuptime

How long after a call before an extension is available again

Integer null

ring_busy_members

Should members ring even if they're already on another call?

Boolean null

member_timeout

How long to ring a member before considering it to be unavailable

Integer null

pre_queue_audio_file_id

The ID of the audio file to use as the pre queue audio file

Integer null

post_queue_audio_file_id

The ID of the audio file to use as the post queue audio file

Integer null

periodic_audio_file_id

The ID of the audio file to use as the periodic audio file

Integer null

members

An array of all members for this object

Array null

Errors

Error Attributes

UnitNotFound

The given unit was not found

  • id

    The provided ID

InvalidPreQueueAudioFile

The pre queue audio file ID is invalid

  • id

    The ID that was looked up

InvalidPostQueueAudioFile

The post queue audio file ID is invalid

  • id

    The ID that was looked up

InvalidPeriodicAudioFile

The periodic audio file ID is invalid

  • id

    The ID that was looked up

InvalidMembers

The members array provided was not valid

  • issue_message

    A message describing the issue

ValidationError

A validation error occurred

  • errors

    An array of errors

Response Data

This action will return a call queue structure.

You'll receive all attributes for this structure (basic and extended attributes). You'll receive all expansions for this stucture.