curl --request POST \
--url https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}/redeem \
--header 'Content-Type: application/json' \
--data '
{
"usedByContactID": "<string>",
"usedSessionID": "<string>"
}
'import requests
url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}/redeem"
payload = {
"usedByContactID": "<string>",
"usedSessionID": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({usedByContactID: '<string>', usedSessionID: '<string>'})
};
fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}/redeem', 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}/redeem",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'usedByContactID' => '<string>',
'usedSessionID' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}/redeem"
payload := strings.NewReader("{\n \"usedByContactID\": \"<string>\",\n \"usedSessionID\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}/redeem")
.header("Content-Type", "application/json")
.body("{\n \"usedByContactID\": \"<string>\",\n \"usedSessionID\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}/redeem")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"usedByContactID\": \"<string>\",\n \"usedSessionID\": \"<string>\"\n}"
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": "ForbiddenError",
"error_code": 1004,
"message": "You do not have access to this resource.",
"statusCode": 403
}
]
}{
"errors": [
{
"error": "HandoffLinkNotRedeemableError",
"error_code": 1601,
"message": "This handoff link has already been used or has expired.",
"statusCode": 409
}
]
}{
"errors": [
{
"error": "UnknownError",
"error_code": 5999,
"message": "For some unknown reason your request has not succeeded.",
"statusCode": 500
}
]
}Redeem handoff link
Consumes a handoff link and returns the contact it was issued for, so the caller can attach the new conversation to that existing contact instead of creating a duplicate.
Single-use is enforced atomically: the second call on the same token fails, even if it arrives concurrently with the first. Expired links fail the same way — the check is on the stored expiry, not on MongoDB’s TTL sweep, which lags by up to a minute.
Like ReadSupportTokenController, this accepts any identity
useOperatorAuth recognizes rather than requiring tenant membership: the
usual caller is Talqui Core reacting to an inbound message, authenticating
as a plugin with no operator session of its own.
curl --request POST \
--url https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}/redeem \
--header 'Content-Type: application/json' \
--data '
{
"usedByContactID": "<string>",
"usedSessionID": "<string>"
}
'import requests
url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}/redeem"
payload = {
"usedByContactID": "<string>",
"usedSessionID": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({usedByContactID: '<string>', usedSessionID: '<string>'})
};
fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}/redeem', 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}/redeem",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'usedByContactID' => '<string>',
'usedSessionID' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}/redeem"
payload := strings.NewReader("{\n \"usedByContactID\": \"<string>\",\n \"usedSessionID\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}/redeem")
.header("Content-Type", "application/json")
.body("{\n \"usedByContactID\": \"<string>\",\n \"usedSessionID\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/handoff-links/{handoffLinkToken}/redeem")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"usedByContactID\": \"<string>\",\n \"usedSessionID\": \"<string>\"\n}"
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": "ForbiddenError",
"error_code": 1004,
"message": "You do not have access to this resource.",
"statusCode": 403
}
]
}{
"errors": [
{
"error": "HandoffLinkNotRedeemableError",
"error_code": 1601,
"message": "This handoff link has already been used or has expired.",
"statusCode": 409
}
]
}{
"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.
^([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.
1Body
Response
Response for status 200.
Show child attributes
Show child attributes