List inboxes

curl --request GET \
  --url https://services-api.talqui.chat/v1/tenants/{tenantID}/inboxes

const options = {method: 'GET'};

fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/inboxes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://services-api.talqui.chat/v1/tenants/{tenantID}/inboxes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://services-api.talqui.chat/v1/tenants/{tenantID}/inboxes"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/inboxes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": {
    "inboxes": [
      {
        "__inboxOperatorIDs": [
          "<string>"
        ],
        "__inboxVisibility": "visible",
        "inboxFilters": [
          {
            "criterion": "<string>",
            "operator": "<string>",
            "query": [
              "<unknown>"
            ],
            "schema": "<string>",
            "enforced": true,
            "id": "<string>"
          }
        ],
        "inboxID": "<string>",
        "inboxMetadata": {},
        "inboxName": "<string>",
        "inboxPriority": 123,
        "inboxStatus": "active",
        "inboxVisibility": "visible",
        "createdAt": "2023-11-07T05:31:56Z",
        "inboxAutoRouting": true,
        "tenantID": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

{
  "errors": [
    {
      "error": "MissingTenantIDError",
      "error_code": 1001,
      "message": "tenantID is required.",
      "statusCode": 400
    }
  ]
}

{
  "errors": [
    {
      "error": "UnauthorizedError",
      "error_code": 1003,
      "message": "You are not authorized to perform this request.",
      "statusCode": 401
    }
  ]
}

{
  "errors": [
    {
      "error": "ForbiddenError",
      "error_code": 1004,
      "message": "You do not have access to this resource.",
      "statusCode": 403
    }
  ]
}

{
  "errors": [
    {
      "error": "TenantNotFoundError",
      "error_code": 1062,
      "message": "Tenant not found.",
      "statusCode": 404
    }
  ]
}

{
  "errors": [
    {
      "error": "UnknownError",
      "error_code": 5999,
      "message": "For some unknown reason your request has not succeeded.",
      "statusCode": 500
    }
  ]
}

Inboxes

List inboxes

Lists the inboxes the calling operator may see — the conversation sidebar.

The result mixes the tenant’s own inboxes with the four universal defaults (“Acontecendo agora”, “Fila”, “Meus atendimentos”, “Histórico”), which are synthesised rather than stored and always sort first.

Each row carries two visibilities: inboxVisibility is what the tenant configured, __inboxVisibility is what this operator sees after their role and access grants are applied. Owners, managers and superusers see every inbox; everyone else sees the public and locked ones plus whatever they were granted explicitly. Rows that resolve to hidden are omitted.

GET

tenants

{tenantID}

inboxes

List inboxes

curl --request GET \
  --url https://services-api.talqui.chat/v1/tenants/{tenantID}/inboxes

const options = {method: 'GET'};

fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/inboxes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://services-api.talqui.chat/v1/tenants/{tenantID}/inboxes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://services-api.talqui.chat/v1/tenants/{tenantID}/inboxes"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/inboxes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": {
    "inboxes": [
      {
        "__inboxOperatorIDs": [
          "<string>"
        ],
        "__inboxVisibility": "visible",
        "inboxFilters": [
          {
            "criterion": "<string>",
            "operator": "<string>",
            "query": [
              "<unknown>"
            ],
            "schema": "<string>",
            "enforced": true,
            "id": "<string>"
          }
        ],
        "inboxID": "<string>",
        "inboxMetadata": {},
        "inboxName": "<string>",
        "inboxPriority": 123,
        "inboxStatus": "active",
        "inboxVisibility": "visible",
        "createdAt": "2023-11-07T05:31:56Z",
        "inboxAutoRouting": true,
        "tenantID": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

{
  "errors": [
    {
      "error": "MissingTenantIDError",
      "error_code": 1001,
      "message": "tenantID is required.",
      "statusCode": 400
    }
  ]
}

{
  "errors": [
    {
      "error": "UnauthorizedError",
      "error_code": 1003,
      "message": "You are not authorized to perform this request.",
      "statusCode": 401
    }
  ]
}

{
  "errors": [
    {
      "error": "ForbiddenError",
      "error_code": 1004,
      "message": "You do not have access to this resource.",
      "statusCode": 403
    }
  ]
}

{
  "errors": [
    {
      "error": "TenantNotFoundError",
      "error_code": 1062,
      "message": "Tenant not found.",
      "statusCode": 404
    }
  ]
}

{
  "errors": [
    {
      "error": "UnknownError",
      "error_code": 5999,
      "message": "For some unknown reason your request has not succeeded.",
      "statusCode": 500
    }
  ]
}

Path Parameters

tenantID

string<uuid>

required

The tenant whose inboxes are being listed.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

inboxStatus

enum<string>

default:active

Which inboxes to list. Defaults to the ones in use.

Available options:

active,

archived

Response

Response for status 200.

data

object

required

Show child attributes

⌘I

Real Time API

Services API

Helpdesk API

List inboxes

Path Parameters

Query Parameters

Response