Get helpdesk catalog

curl --request GET \
  --url https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/catalog \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/catalog"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/catalog', 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://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/catalog",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/catalog"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/catalog")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "articles": [
    {
      "articleDescription": "<string>",
      "articleFeatured": true,
      "articleID": "<string>",
      "articleOrder": 123,
      "articleSlug": "<string>",
      "articleTitle": "<string>",
      "articleUrl": "<string>",
      "categoryID": "<string>",
      "publishedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "articlesTotal": 123,
  "categories": [
    {
      "categoryID": "<string>",
      "categoryOrder": 123,
      "categorySlug": "<string>",
      "categoryTitle": "<string>"
    }
  ],
  "helpdeskBaseUrl": "<string>",
  "helpdeskID": "<string>",
  "helpdeskStatus": "draft",
  "truncated": true
}

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

{
  "errors": [
    {
      "error": "HelpdeskNotFoundError",
      "error_code": 1107,
      "message": "No help center answers on this address.",
      "statusCode": 404
    }
  ]
}

{
  "errors": [
    {
      "error": "TenantNotConnectedError",
      "error_code": 1000,
      "message": "This tenant is not connected to the plugin.",
      "statusCode": 422
    }
  ]
}

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

Helpdesk

Get helpdesk catalog

The published catalog of the tenant’s help center — categories, articles and each article’s absolute public URL — in one call, for a caller that needs to pick an article and paste its link.

Only published articles, always: this is read by operators in the middle of an attendance, and a draft has no address to send anyone to. A help center that is itself still in draft answers with an empty catalog rather than links that would 404 in front of the customer.

GET

tenants

{tenantID}

helpdesk

catalog

Get helpdesk catalog

curl --request GET \
  --url https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/catalog \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/catalog"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/catalog', 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://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/catalog",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/catalog"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/catalog")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "articles": [
    {
      "articleDescription": "<string>",
      "articleFeatured": true,
      "articleID": "<string>",
      "articleOrder": 123,
      "articleSlug": "<string>",
      "articleTitle": "<string>",
      "articleUrl": "<string>",
      "categoryID": "<string>",
      "publishedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "articlesTotal": 123,
  "categories": [
    {
      "categoryID": "<string>",
      "categoryOrder": 123,
      "categorySlug": "<string>",
      "categoryTitle": "<string>"
    }
  ],
  "helpdeskBaseUrl": "<string>",
  "helpdeskID": "<string>",
  "helpdeskStatus": "draft",
  "truncated": true
}

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

{
  "errors": [
    {
      "error": "HelpdeskNotFoundError",
      "error_code": 1107,
      "message": "No help center answers on this address.",
      "statusCode": 404
    }
  ]
}

{
  "errors": [
    {
      "error": "TenantNotConnectedError",
      "error_code": 1000,
      "message": "This tenant is not connected to the plugin.",
      "statusCode": 422
    }
  ]
}

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

Authorizations

Authorization

string

header

required

Behalf of an Operator. The JWT issued by Talqui Core when an operator signs in. Send as Authorization: Bearer <jwt-token>.

Path Parameters

tenantID

string<uuid>

required

The tenant the help center belongs to.

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)$

Response

Response for status 200.

articles

object[]

required

Show child attributes

articlesTotal

number

required

Real Time API

Services API

Helpdesk API

Get helpdesk catalog

Authorizations

Path Parameters

Response