Passer au contenu principal
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"
  }
}
'
{
  "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
  }
}

Documentation Index

Fetch the complete documentation index at: https://help.withallo.com/llms.txt

Use this file to discover all available pages before exploring further.

Scope requis : CONVERSATIONS_READ
Cet endpoint est paginé. Utilisez page et size dans le corps de la requête pour contrôler les résultats. Voir Pagination.

Comportement de la recherche

Le champ search 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 demandeValeur 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"
Fonctionnement de la correspondance :
  • 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=RELEVANCE pour classer les résultats par qualité de correspondance plutôt que par date

Notes sur les champs

ChampNull 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_urlEnregistrement désactivé, appel sans réponse, ou éléments SMS
transcriptNon 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

ValeurEffet
transcriptInclure les transcriptions complètes des appels sur chaque élément
Passer une valeur non prise en charge renvoie une erreur 400 avec le code UNSUPPORTED_EXTEND_VALUE.

Autorisations

Authorization
string
header
requis

Corps

application/json
allo_number
string
contact_number
string
user_id
string
direction
enum<string>
Options disponibles:
INBOUND,
OUTBOUND
type
enum<string>
défaut:ALL
Options disponibles:
CALL,
SMS,
ALL
result
enum<string>
Options disponibles:
ANSWERED,
VOICEMAIL,
TRANSFERRED
tags
string[]
unread
boolean
unresponded
boolean

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.

sort
enum<string>
défaut:DATE_DESC
Options disponibles:
DATE_DESC,
DATE_ASC,
RELEVANCE
extend
string
page
integer
défaut:1
size
integer
défaut:20
Plage requise: x <= 100
date
object

Date range to filter by

Réponse

Search results

data
object[]
pagination
object