Skip to content

Latest commit

 

History

History
15 lines (11 loc) · 1.63 KB

Enqueue.md

File metadata and controls

15 lines (11 loc) · 1.63 KB

freeclimb.Model.Enqueue

The Enqueue command adds the current Call to a call Queue. If the specified Queue does not exist, it is created and then the Call is added to it. The default maximum length of the queue is 100. This can be modified using the REST API.

Properties

Name Type Description Notes
Command string Name of PerCL Command (this is automatically derived from mapping configuration and should not be manually supplied in any arguments) [optional]
ActionUrl string A request is made to this URL when the Call leaves the Queue, which can occur if enqueue of the Call fails or when the call is dequeued via the `Dequeue` command, the REST API (POST to Queue Member resource), or the caller hangs up.
NotificationUrl string URL to be invoked when the call enters the queue. The request to the URL contains the standard request parameters.This is a notification only; any PerCL returned will be ignored. [optional]
QueueId string ID of the Queue to which to add the Call. If the Queue does not exist, it will be created. The ID must start with QU followed by 40 hex characters.
WaitUrl string A request is made to this URL when the Call leaves the Queue, which can occur if enqueue of the Call fails or when the call is dequeued via the `Dequeue` command, the REST API (POST to Queue Member resource), or the caller hangs up.

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