Skip to main content
POST
/
api
/
call_queue_entries
POST /api/call_queue_entries
curl --request POST \
  --url https://api.sippet.ai/api/call_queue_entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "relationships": {},
    "type": "CallQueueEntry"
  }
}
'
{
  "data": {
    "id": "<string>",
    "type": "<string>",
    "attributes": {
      "call_uuid": "<string>",
      "queue_name": "<string>",
      "abandoned_at": "<unknown>",
      "agent_name": "<string>",
      "answered_at": "<unknown>",
      "caller_id_name": "<string>",
      "caller_id_number": "<string>",
      "completed_at": "<unknown>",
      "state": "waiting",
      "wait_started_at": "<unknown>"
    },
    "relationships": {
      "organisation": {
        "data": {
          "id": "<string>",
          "type": "<string>",
          "meta": {}
        }
      }
    }
  },
  "included": [
    "<unknown>"
  ],
  "meta": {}
}

Documentation Index

Fetch the complete documentation index at: https://sippet.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT for bearer authentication

Query Parameters

​
include
string

Relationship paths to include in the response

Pattern: ^()(,())*$
​
fields
object

Limits the response fields to only those listed for each type

Example:
{
  "CallQueueEntry": "id,call_uuid,queue_name,caller_id_number,caller_id_name,state,agent_name,wait_started_at,answered_at,completed_at,abandoned_at"
}

Body

application/vnd.api+json

Request body for the /call_queue_entries operation on CallQueueEntry resource

​
data
object
required

Response

Success

​
data
object

A "Resource object" representing a CallQueueEntry

​
included
any[]
​
meta
object