Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Queue

Kick a queue call by reference ID

Removes the queue call associated with the given reference ID from the queue.

post/queuecalls/reference_id/{id}/kick

Path parameters

idstring required

The reference ID of the queue call.

Response

Successfully kicked the queue call by reference ID.

idstring uuid

The unique identifier of the queuecall. Returned from the GET /queuecalls response.

customer_idstring uuid

The unique identifier of the customer who owns this queuecall. Returned from the GET /customers response.

reference_type'call'
reference_idstring uuid

The unique identifier of the referenced resource (e.g., a call). Returned from the corresponding resource endpoint.

status'initiating' | 'waiting' | 'connecting' | 'kicking' | 'service' | 'done' | 'abandoned'
service_agent_idstring uuid

The unique identifier of the agent handling this queuecall. Returned from the GET /agents response.

duration_waitinginteger

Duration for waiting in milliseconds

duration_serviceinteger

Duration for service in milliseconds

tm_createstring date-time

The creation timestamp.

tm_servicestring date-time

Timestamp when the queue call started service.

tm_updatestring date-time

The last update timestamp.

tm_deletestring date-time

The deletion timestamp.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "reference_type": "call",
  "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "waiting",
  "service_agent_id": "c3d4e5f6-a7b8-9c0d-1e2f-3a4b5c6d7e8f",
  "duration_waiting": 45000,
  "duration_service": 180000,
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_service": "2026-01-15T09:35:00.000000Z",
  "tm_update": "2026-01-16T14:20:00.000000Z",
  "tm_delete": "2026-01-17T18:45:00.000000Z"
}