Resolve contacts segment
curl --request POST \
--url https://services-api.talqui.chat/v1/tenants/{tenantID}/contacts/segment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"channel": "<string>",
"filters": [],
"page": 1,
"perPage": 50
}
'import requests
url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/contacts/segment"
payload = {
"channel": "<string>",
"filters": [],
"page": 1,
"perPage": 50
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({channel: '<string>', filters: [], page: 1, perPage: 50})
};
fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/contacts/segment', 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}/contacts/segment",
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([
'channel' => '<string>',
'filters' => [
],
'page' => 1,
'perPage' => 50
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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}/contacts/segment"
payload := strings.NewReader("{\n \"channel\": \"<string>\",\n \"filters\": [],\n \"page\": 1,\n \"perPage\": 50\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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}/contacts/segment")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"channel\": \"<string>\",\n \"filters\": [],\n \"page\": 1,\n \"perPage\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/contacts/segment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channel\": \"<string>\",\n \"filters\": [],\n \"page\": 1,\n \"perPage\": 50\n}"
response = http.request(request)
puts response.read_body{
"contacts": [
{
"contactBlock": true,
"contactChannels": [
"<string>"
],
"contactEmail": "<string>",
"contactEmailVerified": true,
"contactExternal": {},
"contactFirstname": "<string>",
"contactID": "<string>",
"contactLastSessionID": "<string>",
"contactLastname": "<string>",
"contactMeta": {},
"contactNameVerified": true,
"contactPhone": "<string>",
"contactPhoneVerified": true,
"contactPhoto": "<string>",
"contactSummary": "<string>",
"contactTags": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"organizationID": "<string>",
"tenantID": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"meta": {
"count": 123,
"currentPage": 123,
"hasMore": true,
"perPage": 123,
"totalCount": 123,
"totalPages": 123
}
}{
"contacts": [
{
"contactBlock": true,
"contactChannels": [
"<string>"
],
"contactEmail": "<string>",
"contactEmailVerified": true,
"contactExternal": {},
"contactFirstname": "<string>",
"contactID": "<string>",
"contactLastSessionID": "<string>",
"contactLastname": "<string>",
"contactMeta": {},
"contactNameVerified": true,
"contactPhone": "<string>",
"contactPhoneVerified": true,
"contactPhoto": "<string>",
"contactSummary": "<string>",
"contactTags": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"organizationID": "<string>",
"tenantID": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"meta": {
"count": 123,
"currentPage": 123,
"hasMore": true,
"perPage": 123,
"totalCount": 123,
"totalPages": 123
}
}{
"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": "UnknownError",
"error_code": 5999,
"message": "For some unknown reason your request has not succeeded.",
"statusCode": 500
}
]
}Contacts
Resolve contacts segment
Resolves the paginated contact audience matching the given filter rules and channel — the real backend for the segment builder in the campaign wizard’s recipients step (replaces the client-side-only resolution the frontend uses as a documented stopgap today). Returns HTTP 206 instead of 200 when more pages are available.
POST
/
v1
/
tenants
/
{tenantID}
/
contacts
/
segment
Resolve contacts segment
curl --request POST \
--url https://services-api.talqui.chat/v1/tenants/{tenantID}/contacts/segment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"channel": "<string>",
"filters": [],
"page": 1,
"perPage": 50
}
'import requests
url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/contacts/segment"
payload = {
"channel": "<string>",
"filters": [],
"page": 1,
"perPage": 50
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({channel: '<string>', filters: [], page: 1, perPage: 50})
};
fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/contacts/segment', 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}/contacts/segment",
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([
'channel' => '<string>',
'filters' => [
],
'page' => 1,
'perPage' => 50
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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}/contacts/segment"
payload := strings.NewReader("{\n \"channel\": \"<string>\",\n \"filters\": [],\n \"page\": 1,\n \"perPage\": 50\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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}/contacts/segment")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"channel\": \"<string>\",\n \"filters\": [],\n \"page\": 1,\n \"perPage\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/contacts/segment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channel\": \"<string>\",\n \"filters\": [],\n \"page\": 1,\n \"perPage\": 50\n}"
response = http.request(request)
puts response.read_body{
"contacts": [
{
"contactBlock": true,
"contactChannels": [
"<string>"
],
"contactEmail": "<string>",
"contactEmailVerified": true,
"contactExternal": {},
"contactFirstname": "<string>",
"contactID": "<string>",
"contactLastSessionID": "<string>",
"contactLastname": "<string>",
"contactMeta": {},
"contactNameVerified": true,
"contactPhone": "<string>",
"contactPhoneVerified": true,
"contactPhoto": "<string>",
"contactSummary": "<string>",
"contactTags": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"organizationID": "<string>",
"tenantID": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"meta": {
"count": 123,
"currentPage": 123,
"hasMore": true,
"perPage": 123,
"totalCount": 123,
"totalPages": 123
}
}{
"contacts": [
{
"contactBlock": true,
"contactChannels": [
"<string>"
],
"contactEmail": "<string>",
"contactEmailVerified": true,
"contactExternal": {},
"contactFirstname": "<string>",
"contactID": "<string>",
"contactLastSessionID": "<string>",
"contactLastname": "<string>",
"contactMeta": {},
"contactNameVerified": true,
"contactPhone": "<string>",
"contactPhoneVerified": true,
"contactPhoto": "<string>",
"contactSummary": "<string>",
"contactTags": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"organizationID": "<string>",
"tenantID": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"meta": {
"count": 123,
"currentPage": 123,
"hasMore": true,
"perPage": 123,
"totalCount": 123,
"totalPages": 123
}
}{
"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": "UnknownError",
"error_code": 5999,
"message": "For some unknown reason your request has not succeeded.",
"statusCode": 500
}
]
}Authorizations
Behalf of an Operator (default). A JWT issued by Talqui Core when an operator signs in, scoped to every tenant that operator belongs to. Send as Authorization: Bearer <jwt-token>.
Path Parameters
Body
application/json
The campaign channel URN to check reachability against.
AND-combined filter rules — see ContactSegmentFilter for the wire format.
Show child attributes
Show child attributes
1-indexed page number to fetch.
Required range:
1 <= x <= 9007199254740991Number of contacts per page (max 200).
Required range:
1 <= x <= 200⌘I