Read handoff link
curl --request GET \
--url https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}import requests
url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}', 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}/handoff-links/{handoffLinkToken}",
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}/handoff-links/{handoffLinkToken}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}")
.asString();require 'uri'
require 'net/http'
url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}")
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{
"handoffLink": {
"contactID": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"handoffLinkID": "<string>",
"handoffLinkToken": "<string>",
"handoffLinkURL": "<string>",
"sourceChannel": "<string>",
"sourceSessionID": "<string>",
"status": "PENDING",
"targetChannel": "<string>",
"targetPluginConnectionID": "<string>",
"tenantID": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"usedAt": "2023-11-07T05:31:56Z",
"usedByContactID": "<string>",
"usedSessionID": "<string>"
}
}{
"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": "HandoffLinkNotFoundError",
"error_code": 1600,
"message": "Handoff link not found.",
"statusCode": 404
}
]
}{
"errors": [
{
"error": "UnknownError",
"error_code": 5999,
"message": "For some unknown reason your request has not succeeded.",
"statusCode": 500
}
]
}Handoff links
Read handoff link
Reads a handoff link without consuming it, so an operator can re-open the link they generated or a caller can check whether a token was already used.
Redeeming is a separate, deliberately non-idempotent call — a GET must never burn the token.
GET
/
v1
/
tenants
/
{tenantID}
/
handoff-links
/
{handoffLinkToken}
Read handoff link
curl --request GET \
--url https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}import requests
url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}', 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}/handoff-links/{handoffLinkToken}",
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}/handoff-links/{handoffLinkToken}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}")
.asString();require 'uri'
require 'net/http'
url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}")
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{
"handoffLink": {
"contactID": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"handoffLinkID": "<string>",
"handoffLinkToken": "<string>",
"handoffLinkURL": "<string>",
"sourceChannel": "<string>",
"sourceSessionID": "<string>",
"status": "PENDING",
"targetChannel": "<string>",
"targetPluginConnectionID": "<string>",
"tenantID": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"usedAt": "2023-11-07T05:31:56Z",
"usedByContactID": "<string>",
"usedSessionID": "<string>"
}
}{
"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": "HandoffLinkNotFoundError",
"error_code": 1600,
"message": "Handoff link not found.",
"statusCode": 404
}
]
}{
"errors": [
{
"error": "UnknownError",
"error_code": 5999,
"message": "For some unknown reason your request has not succeeded.",
"statusCode": 500
}
]
}Path Parameters
The tenant that owns the handoff link.
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 single-use token carried by the link.
Minimum string length:
1Response
Response for status 200.
Show child attributes
Show child attributes
⌘I