Refresh helpdesk domain
curl --request POST \
--url https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/domains/{domainHostname}/refresh \
--header 'Authorization: Bearer <token>'import requests
url = "https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/domains/{domainHostname}/refresh"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/domains/{domainHostname}/refresh', 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/domains/{domainHostname}/refresh",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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/domains/{domainHostname}/refresh"
req, _ := http.NewRequest("POST", 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))
}HttpResponse<String> response = Unirest.post("https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/domains/{domainHostname}/refresh")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/domains/{domainHostname}/refresh")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"cnameTarget": "<string>",
"domain": {
"domainCloudflareID": "<string>",
"domainHostname": "<string>",
"domainStatus": "pending",
"lastCheckedAt": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"statusReason": "<string>"
}{
"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": "DomainRefreshThrottledError",
"error_code": 1121,
"message": "This domain was verified a moment ago. Wait a few seconds and try again.",
"statusCode": 429
}
]
}{
"errors": [
{
"error": "UnknownError",
"error_code": 5999,
"message": "For some unknown reason your request has not succeeded.",
"statusCode": 500
}
]
}{
"errors": [
{
"error": "DomainProvisioningError",
"error_code": 1122,
"message": "The domain provisioning provider failed to answer. Try again in a moment.",
"statusCode": 502
}
]
}Domains
Refresh helpdesk domain
Re-checks the domain’s provisioning state against Cloudflare on demand —
the “Verify again” button. Idempotent: while the CNAME is not in place the
domain stays pending with a pt-BR statusReason explaining what is
missing; once Cloudflare reports the hostname and its certificate active,
the domain turns active and verifiedAt is stamped. Throttled
server-side to one check per domain every 10 seconds.
POST
/
v1
/
tenants
/
{tenantID}
/
helpdesk
/
domains
/
{domainHostname}
/
refresh
Refresh helpdesk domain
curl --request POST \
--url https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/domains/{domainHostname}/refresh \
--header 'Authorization: Bearer <token>'import requests
url = "https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/domains/{domainHostname}/refresh"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/domains/{domainHostname}/refresh', 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/domains/{domainHostname}/refresh",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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/domains/{domainHostname}/refresh"
req, _ := http.NewRequest("POST", 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))
}HttpResponse<String> response = Unirest.post("https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/domains/{domainHostname}/refresh")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk/domains/{domainHostname}/refresh")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"cnameTarget": "<string>",
"domain": {
"domainCloudflareID": "<string>",
"domainHostname": "<string>",
"domainStatus": "pending",
"lastCheckedAt": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"statusReason": "<string>"
}{
"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": "DomainRefreshThrottledError",
"error_code": 1121,
"message": "This domain was verified a moment ago. Wait a few seconds and try again.",
"statusCode": 429
}
]
}{
"errors": [
{
"error": "UnknownError",
"error_code": 5999,
"message": "For some unknown reason your request has not succeeded.",
"statusCode": 500
}
]
}{
"errors": [
{
"error": "DomainProvisioningError",
"error_code": 1122,
"message": "The domain provisioning provider failed to answer. Try again in a moment.",
"statusCode": 502
}
]
}Authorizations
operatorAuthpluginConnectionAuthpluginAuth
Behalf of an Operator. The JWT issued by Talqui Core when an operator signs in. Send as Authorization: Bearer <jwt-token>.
Path Parameters
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)$The custom domain hostname, exactly as it was registered.
Required string length:
1 - 253⌘I