Passer au contenu principal
POST
/
v2
/
api
/
conversations
/
items
/
batch
Get many conversation items
curl --request POST \
  --url https://api.withallo.com/v2/api/conversations/items/batch \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "cll-abc123",
    "cll-def456",
    "cll-ghi789"
  ]
}
'
{
  "data": [
    {
      "id": "cll-abc123",
      "type": "CALL",
      "direction": "INBOUND",
      "allo_number": "+14155550100",
      "contact_number": "+14155551234",
      "contacts": [
        {
          "id": "cnt-abc123",
          "name": "Sarah Johnson",
          "company": {
            "id": "com-xyz789",
            "name": "Acme Corp"
          },
          "deals": [
            {
              "id": "dea-def456",
              "name": "Enterprise Plan",
              "status": "OPEN"
            }
          ]
        }
      ],
      "user": {
        "id": "usr-abc123",
        "name": "John",
        "email": "[email protected]"
      },
      "date": "2023-11-07T05:31:56Z",
      "duration": 123,
      "result": "ANSWERED",
      "recording_url": "<string>",
      "summary": "<string>",
      "tags": [
        "<string>"
      ],
      "transcript": [
        {
          "source": "USER",
          "time": "2023-11-07T05:31:56Z",
          "text": "<string>"
        }
      ],
      "content": "<string>",
      "status": "PENDING",
      "message_type": "SMS"
    }
  ]
}

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

Limites

  • Maximum 100 éléments par requête batch
  • Dépasser cette limite renvoie une erreur 400 avec le code BATCH_TOO_LARGE

Format des ID d’éléments

  • Les ID d’appels commencent par cll- (ex. cll-abc123)
  • Les ID de messages commencent par msg- (ex. msg-def456)
Les éléments qui n’existent pas sont silencieusement omis de la réponse.

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)

Paramètre extend

ValeurEffet
transcriptInclure les transcriptions complètes des appels pour tous les éléments d’appel du batch
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
ids
string[]
requis

Array of conversation item IDs (max 100)

Maximum array length: 100

Réponse

Conversation items

data
object[]