Skip to main content

Queue

Sent when the call enters a call queue. From this moment on the call waits to be routed to a suitable agent according to the distribution rules of the queue.

Use it to monitor queue load, to show the waiting call on a wallboard or to start measuring wait time.

Sample body

scenario: Queue
{
"queue_name": "8501234567-queue-destek",
"pbx_num": "8501234567",
"unique_id": "sip1-1767225600.10001",
"incoming_number": "8501234567",
"scenario": "Queue",
"customer_num": "05551112233",
"timestamp": "1767225602000"
}
Send this body to your own address

The sample body above is sent to the address below as a POST request. The request goes from your browser, so the response cannot be read if the receiving endpoint sends no CORS header; the request itself still arrives. Use the cURL equivalent to try it from the server side.

cURL equivalent:

curl -X POST 'https://your-address.example/webhook' \
-H 'Content-Type: application/json' \
-d '{"queue_name":"8501234567-queue-destek","pbx_num":"8501234567","unique_id":"sip1-1767225600.10001","incoming_number":"8501234567","scenario":"Queue","customer_num":"05551112233","timestamp":"1767225602000"}'

Fields

FieldTypeDescription
scenariostringAlways Queue.
queue_namestringFull name of the queue. It has the form <pbx>-queue-<queue>; in the sample the queue name is destek.
pbx_numstringYour PBX number.
unique_idstringUnique identifier of the call.
incoming_numberstringYour number that was dialed.
customer_numstringCalling subscriber number.
timestampstringEvent time (ms, Unix epoch).
Parsing the queue name

The queue_name field is prefixed with the PBX number. If you only want the queue's own name, take the part after the -queue- separator.

The call leaving the queue is reported by the QueueLeave event; the wait time arrives there in the holdtime field.