Find contacts by i ds
curl --request POST \
--url https://services-api.talqui.chat/v1/tenants/{tenantID}/contacts/by-ids \
--header 'Content-Type: application/json' \
--data '
{
"contactIDs": [
"<string>"
]
}
'import requests
url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/contacts/by-ids"
payload = { "contactIDs": ["<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({contactIDs: ['<string>']})
};
fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/contacts/by-ids', 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/by-ids",
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([
'contactIDs' => [
'<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}/contacts/by-ids"
payload := strings.NewReader("{\n \"contactIDs\": [\n \"<string>\"\n ]\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}/contacts/by-ids")
.header("Content-Type", "application/json")
.body("{\n \"contactIDs\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/contacts/by-ids")
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 \"contactIDs\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"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
}
}{
"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
Find contacts by i ds
Reads the tenant’s contacts among a list of ids — e.g. rehydrating the recipients a campaign draft persisted. POST because the id list does not fit a query string. Ids that match no contact are absent from the answer.
POST
/
v1
/
tenants
/
{tenantID}
/
contacts
/
by-ids
Find contacts by i ds
curl --request POST \
--url https://services-api.talqui.chat/v1/tenants/{tenantID}/contacts/by-ids \
--header 'Content-Type: application/json' \
--data '
{
"contactIDs": [
"<string>"
]
}
'import requests
url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/contacts/by-ids"
payload = { "contactIDs": ["<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({contactIDs: ['<string>']})
};
fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/contacts/by-ids', 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/by-ids",
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([
'contactIDs' => [
'<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}/contacts/by-ids"
payload := strings.NewReader("{\n \"contactIDs\": [\n \"<string>\"\n ]\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}/contacts/by-ids")
.header("Content-Type", "application/json")
.body("{\n \"contactIDs\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/contacts/by-ids")
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 \"contactIDs\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"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
}
}{
"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
}
]
}Path Parameters
The tenant whose contacts are read.
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)$Body
application/json
Contact ids to read (1 to 200); duplicates are harmless.
Required array length:
1 - 200 elementsMinimum string length:
1⌘I