Enqueue RCML
The verb enqueues the current call in a Call Queue. Enqueued calls wait on hold until the call is dequeued by another caller via the verb for the same Queue

Attributes

Attribute
Description
waitUrl
Attribute takes a URL as the argument. The URL points to a RCML document that will be executed while the caller (Agent) is put in the queue waiting for the next caller (Customer) to join . The waitUrl RCML only supports the Say, Play, and Redirect verbs. Once the waitUrl RCML flow runs out of verbs to execute, the Call Queue will start over, essentially looping hold music indefinitely. verb can be used for calling RCML document again and the Application can add some dynamic business logic that can change in the next loop. The Call Queue will pass the parameters explained in Request Parameters in its request to the value of the waitUrl attribute.
waitUrlMethod
This method attribute takes the value 'GET' or 'POST' and tells the Call Queue whether to request the waitUrl above via HTTP GET or POST. This attribute is modeled after the HTML form method attribute. The default value is 'POST'.
joinUrl
This attribute takes a URL as an argument. The URL points to a RCML document that will be executed on the caller’s end when the caller (Agent) is about to be connected to the next available queued customer. The joinUrl RCML only supports Say, Play, and Redirect verbs. The Call Queue will pass the parameters explained in Request Parameters in its request to the value of the joinUrl attribute.
joinUrlMethod
The method attribute takes the value of 'GET' or 'POST'. This tells the Call Queue whether to request the joinUrl above via HTTP GET or POST. This attribute is modeled after the HTML form method attribute. 'POST' is the default value.
rejoin
When the Agent finishes the call with a Customer and the Customer hangs up, if this attribute is true and there are no more Customers in the queue. The Agent will be enqueued again and hear onhold music until the next Customer joins. If this attribute is false, the Agent’s call will be dropped if there are no more Customers in queue.

Request Parameters

Parameter
Description
CallSid
The unique identifier for this call.
AccountSid
Your account sid.
From
Caller’s phone number.
To
Phone number receiving the call.
CallStatus
Status of call. Possible values are queued, ringing, in-progress, completed, busy, failed and no-answer.

Example

The example below shows how RCML is formed.
1
<Response>
2
<Enqueue waitUrl="http://www.mocky.io/v2/5dadc1ce2d00006e00e4bcba" joinUrl="http://www.mocky.io/v2/5d92ee853000005b001b70ea" rejoin="true">support</Enqueue>
3
</Response>
Copied!
Mocky.io returns the following RCML.
1
<Response>
2
<Say>
3
There are no customers in Queue. Please hold your line.
4
</Say>
5
<Play>
6
https://yourcompany.com/teleapi/music/electronica/teru_-_110_Downtempo_Electronic_4.wav
7
</Play>
8
</Response>
Copied!
Mocky.io returns below RCML.
1
<Response>
2
<Say>You will now be connected to Customer</Say>
3
</Response>
Copied!