Create a new call queue
This action will create a new call queue in the given unit.
Try this request in your browser
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 |
|
InvalidPreQueueAudioFile The pre queue audio file ID is invalid |
|
InvalidPostQueueAudioFile The post queue audio file ID is invalid |
|
InvalidPeriodicAudioFile The periodic audio file ID is invalid |
|
InvalidMembers The members array provided was not valid |
|
ValidationError A validation error occurred |
|
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.