Vinix· docs

List queue recipients

Sandbox is coming soon

Today, requests on this page run against your live account. A hosted sandbox with simulated PSTN is on the roadmap — until then, use a non-production user or callflow when experimenting.

Details
GET
/accounts/{account_id}/qubicle_queues/{queue_id}/recipients

Authorization

AuthToken
X-Auth-Token<token>

Obtain via PUT /v2/user_auth or PUT /v2/api_auth. See Authentication.

In: header

Path Parameters

account_id*string

Vinix account identifier.

queue_id*string
Formatuuid

Response Body

application/json

application/json

curl -X GET "https://example.com/accounts/string/qubicle_queues/497f6eca-6276-4993-bfeb-53cbbbba6f08/recipients"
{
  "data": [
    {
      "recipient_id": "b6731cb5-d462-49ea-afb8-7933b670b560",
      "roles": [
        "string"
      ]
    }
  ]
}
{
  "message": "string",
  "request_id": "string"
}