Search all conversations
curl --request POST \
--url https://api.withallo.com/v2/api/conversations/items/search \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"search": "billing issues",
"type": "CALL",
"sort": "RELEVANCE",
"date": {
"from": "2026-01-01",
"to": "2026-04-21"
}
}
'import requests
url = "https://api.withallo.com/v2/api/conversations/items/search"
payload = {
"search": "billing issues",
"type": "CALL",
"sort": "RELEVANCE",
"date": {
"from": "2026-01-01",
"to": "2026-04-21"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
search: 'billing issues',
type: 'CALL',
sort: 'RELEVANCE',
date: {from: '2026-01-01', to: '2026-04-21'}
})
};
fetch('https://api.withallo.com/v2/api/conversations/items/search', 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://api.withallo.com/v2/api/conversations/items/search",
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([
'search' => 'billing issues',
'type' => 'CALL',
'sort' => 'RELEVANCE',
'date' => [
'from' => '2026-01-01',
'to' => '2026-04-21'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.withallo.com/v2/api/conversations/items/search"
payload := strings.NewReader("{\n \"search\": \"billing issues\",\n \"type\": \"CALL\",\n \"sort\": \"RELEVANCE\",\n \"date\": {\n \"from\": \"2026-01-01\",\n \"to\": \"2026-04-21\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://api.withallo.com/v2/api/conversations/items/search")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"search\": \"billing issues\",\n \"type\": \"CALL\",\n \"sort\": \"RELEVANCE\",\n \"date\": {\n \"from\": \"2026-01-01\",\n \"to\": \"2026-04-21\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/conversations/items/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"search\": \"billing issues\",\n \"type\": \"CALL\",\n \"sort\": \"RELEVANCE\",\n \"date\": {\n \"from\": \"2026-01-01\",\n \"to\": \"2026-04-21\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "cll-abc123",
"type": "CALL",
"direction": "INBOUND",
"allo_number": "+14155550100",
"contact_number": "+14155551234",
"contacts": [
{
"id": "cnt-abc123",
"name": "Sarah Johnson"
}
],
"user": {
"id": "usr-abc123",
"name": "Alex Kim"
},
"date": "2026-04-21T14:30:00Z",
"duration": 145,
"result": "ANSWERED",
"recording_url": "https://storage.withallo.com/recordings/cll-abc123.mp3",
"summary": "Customer called about a billing issue on their last invoice.",
"tags": [
"billing",
"support"
]
}
],
"pagination": {
"page": 1,
"size": 20,
"total_count": 1,
"total_pages": 1,
"has_more": false
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Conversations
Rechercher des éléments de conversation
Search and filter items across all conversations. Supports keyword search across transcripts, summaries, and message content.
POST
/
v2
/
api
/
conversations
/
items
/
search
Search all conversations
curl --request POST \
--url https://api.withallo.com/v2/api/conversations/items/search \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"search": "billing issues",
"type": "CALL",
"sort": "RELEVANCE",
"date": {
"from": "2026-01-01",
"to": "2026-04-21"
}
}
'import requests
url = "https://api.withallo.com/v2/api/conversations/items/search"
payload = {
"search": "billing issues",
"type": "CALL",
"sort": "RELEVANCE",
"date": {
"from": "2026-01-01",
"to": "2026-04-21"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
search: 'billing issues',
type: 'CALL',
sort: 'RELEVANCE',
date: {from: '2026-01-01', to: '2026-04-21'}
})
};
fetch('https://api.withallo.com/v2/api/conversations/items/search', 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://api.withallo.com/v2/api/conversations/items/search",
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([
'search' => 'billing issues',
'type' => 'CALL',
'sort' => 'RELEVANCE',
'date' => [
'from' => '2026-01-01',
'to' => '2026-04-21'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.withallo.com/v2/api/conversations/items/search"
payload := strings.NewReader("{\n \"search\": \"billing issues\",\n \"type\": \"CALL\",\n \"sort\": \"RELEVANCE\",\n \"date\": {\n \"from\": \"2026-01-01\",\n \"to\": \"2026-04-21\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://api.withallo.com/v2/api/conversations/items/search")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"search\": \"billing issues\",\n \"type\": \"CALL\",\n \"sort\": \"RELEVANCE\",\n \"date\": {\n \"from\": \"2026-01-01\",\n \"to\": \"2026-04-21\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/conversations/items/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"search\": \"billing issues\",\n \"type\": \"CALL\",\n \"sort\": \"RELEVANCE\",\n \"date\": {\n \"from\": \"2026-01-01\",\n \"to\": \"2026-04-21\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "cll-abc123",
"type": "CALL",
"direction": "INBOUND",
"allo_number": "+14155550100",
"contact_number": "+14155551234",
"contacts": [
{
"id": "cnt-abc123",
"name": "Sarah Johnson"
}
],
"user": {
"id": "usr-abc123",
"name": "Alex Kim"
},
"date": "2026-04-21T14:30:00Z",
"duration": 145,
"result": "ANSWERED",
"recording_url": "https://storage.withallo.com/recordings/cll-abc123.mp3",
"summary": "Customer called about a billing issue on their last invoice.",
"tags": [
"billing",
"support"
]
}
],
"pagination": {
"page": 1,
"size": 20,
"total_count": 1,
"total_pages": 1,
"has_more": false
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Scope requis :
CONVERSATIONS_READpage et size dans le corps de la requête pour contrôler les résultats. Voir Pagination.
Comportement de la recherche
Le champsearch est une recherche par mots-clés, pas une requête en langage naturel. Extrayez les mots-clés de la question de l’utilisateur avant de les transmettre.
| L’utilisateur demande | Valeur de search |
|---|---|
| ”Trouver les appels où les clients se sont plaints de la facturation” | "billing complaint" |
| ”Qu’avons-nous discuté à propos de la politique de remboursement ?” | "refund policy" |
| ”Montrer les conversations mentionnant la tarification entreprise” | "enterprise pricing" |
- Les termes sont combinés avec AND —
"billing refund"correspond aux éléments contenant les deux mots - La correspondance par préfixe est utilisée —
"bill"correspond à “billing”, “billed”, etc. - La recherche porte sur : les transcriptions d’appels, les résumés d’appels et le contenu des messages SMS
- Utilisez
sort=RELEVANCEpour classer les résultats par qualité de correspondance plutôt que par date
Notes sur les champs
| Champ | Null quand |
|---|---|
summary | Éléments SMS, ou appels dont le résumé IA n’est pas encore disponible |
duration | Éléments SMS (s’applique uniquement aux appels) |
result | Éléments SMS (s’applique uniquement aux appels) |
recording_url | Enregistrement désactivé, appel sans réponse, ou éléments SMS |
transcript | Non demandé via extend=transcript, ou éléments SMS |
content | Éléments d’appel (s’applique uniquement aux SMS) |
status | Éléments d’appel (s’applique uniquement aux SMS) |
tags | Éléments SMS (les tags s’appliquent uniquement aux appels) |
Paramètre extend
| Valeur | Effet |
|---|---|
transcript | Inclure les transcriptions complètes des appels sur chaque élément |
400 avec le code UNSUPPORTED_EXTEND_VALUE.Autorisations
Corps
application/json
Options disponibles:
INBOUND, OUTBOUND Options disponibles:
CALL, SMS, ALL Options disponibles:
ANSWERED, VOICEMAIL, TRANSFERRED Keyword search (not natural language). Extract keywords from the user's question. Terms are AND'd with prefix matching — 'billing refund' matches items containing both words, 'bill' matches 'billing'. Searches across call transcripts, summaries, and SMS content.
Options disponibles:
DATE_DESC, DATE_ASC, RELEVANCE Plage requise:
x <= 100Date range to filter by
Show child attributes
Show child attributes
Cette page vous a-t-elle été utile ?