Allo

Obtenir un élément de conversation

- Les ID d'appels commencent par cll- (ex. cll-abc123 ) - Les ID de messages commencent par msg- (ex. msg-def456 )

GET/v2/api/conversations/items/{id}

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)

Passer un ID avec un préfixe non reconnu renvoie une erreur 400 avec le code INVALID_ITEM_ID.

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)
detected_outbound_voicemailAppels entrants, éléments SMS, ou appels sortants sans détection
voicemail_leftAppels entrants, éléments SMS, ou appels sortants pour lesquels ce n'est pas déterminé
recording_urlEnregistrement désactivé, appel sans réponse, éléments SMS, ou comptes vendus sous la marque d'un partenaire en marque blanche
recording_download_urlComptes qui n'ont pas été créés par un partenaire, appels d'une équipe HIPAA, appels sans enregistrement, utilisateur de la clé qui ne peut pas écouter l'enregistrement, ou éléments SMS
recording_download_expires_atMêmes cas que recording_download_url
recording_durationEnregistrement désactivé, appel sans réponse, ou éléments SMS
transcriptNon demandé via extend=transcript, ou éléments SMS
extracted_dataÉléments SMS, ou appels qu'Allo n'a pas analysés (non transcrits, ou analyse en cours)
data_collectedÉléments SMS
contentÉléments d'appel (s'applique uniquement aux SMS)
statusÉléments d'appel (s'applique uniquement aux SMS)
attachmentsÉléments d'appel. Un SMS sans photo ni fichier renvoie un tableau vide.
page_countAppels, messages qui ne sont pas des fax, ou fax dont le nombre de pages n'est pas encore connu

duration est la durée totale de l'appel en secondes, sonnerie incluse. recording_duration est la durée de conversation, celle affichée dans l'application Allo pour les appels enregistrés. Pour les appels sans enregistrement, l'application utilise duration.

Liens vers l'enregistrement

Un appel peut porter deux liens vers son enregistrement :

  • recording_url est le lien Allo vers l'enregistrement. Il ouvre une page à la marque Allo pour toute personne non connectée à Allo. Il est donc absent sur les comptes vendus sous la marque d'un partenaire en marque blanche : utilisez recording_download_url sur ces comptes.
  • recording_download_url télécharge le fichier de l'enregistrement sans connexion à Allo. Il reste valable 48 heures, jusqu'à recording_download_expires_at. Allo ne le renvoie que sur les lignes des comptes créés par un partenaire, et seulement si l'utilisateur de la clé peut écouter l'enregistrement. Il n'est jamais renvoyé pour un appel d'une équipe HIPAA.

Pour un nouveau lien valable 60 minutes, appelez Obtenir le lien de téléchargement d'un enregistrement.

Fichiers joints aux MMS

attachments liste les photos et autres fichiers envoyés avec un message, dans leur ordre d'envoi :

"attachments": [
  {
    "file_name": "IMG_0412.jpg",
    "content_type": "image/jpeg",
    "file_size": 245760,
    "download_url": "https://...IMG_0412.jpg?X-Amz-Expires=1800&X-Amz-Signature=...",
    "download_expires_at": "2026-11-05T14:30:00Z"
  }
]

download_url télécharge le fichier sans connexion à Allo. Il reste valable 30 minutes, jusqu'à download_expires_at. Enregistrez le fichier, pas le lien. Pour un nouveau lien, récupérez à nouveau l'élément : chaque réponse en signe un nouveau.

download_url et download_expires_at valent null pour un message d'une équipe HIPAA, ou quand Allo n'a pas pu signer le lien. Le nom, le type et la taille du fichier sont toujours renvoyés.

Fax

Un fax est un élément de type SMS avec message_type FAX. attachments contient le PDF du fax, et page_count son nombre de pages. page_count vaut null tant que le nombre de pages n'est pas connu, par exemple juste après l'envoi d'un fax.

Valeurs du résultat

result vaut ANSWERED, VOICEMAIL, TRANSFERRED_AI, TRANSFERRED_EXTERNAL, BLOCKED, FAILED, FAILED_EXTERNAL, RECEIVED ou CLOSED. Elles ont le même sens que dans le webhook call.completed. Gérez les valeurs inconnues sans erreur : de nouveaux résultats peuvent être ajoutés.

Données extraites

Une fois l'appel transcrit, l'IA d'Allo lit la conversation et relève les coordonnées données par l'interlocuteur. extracted_data les contient :

"extracted_data": {
  "contact": {
    "name": "Marie Dupont",
    "company": "Vibrant Events",
    "job_title": "Office manager",
    "website": "vibrantevents.com",
    "address": "12 rue de la Paix, Paris",
    "emails": ["[email protected]"]
  }
}

Une information que personne n'a mentionnée est une chaîne vide, ou une liste emails vide. Ces valeurs sont ce que l'IA a entendu : vérifiez-les avant de les écrire dans votre CRM. extracted_data est renseigné une fois par appel et ne change pas quand un résumé est modifié.

data_collected est un champ historique conservé pour compatibilité. C'est un objet vide sur les appels actuels.

Paramètre extend

ValeurEffet
transcriptInclure les transcriptions complètes des appels

Passer une valeur non prise en charge renvoie une erreur 400 avec le code UNSUPPORTED_EXTEND_VALUE.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

idstringrequis

Item ID (cll-* for calls, msg-* for messages)

Paramètres de requête

extendstring

Comma-separated optional fields. Supported: transcript

Réponses

200Conversation item
dataobject
26 champs
idstring
typeenum<string>

CALL for a call, SMS for a message. Faxes are SMS items with message_type set to FAX.

CALLSMS

directionenum<string>

INBOUNDOUTBOUND

allo_numberstring
contact_numberstring
contactsobject[]
4 champs
idstring
namestring
companyobject | null
2 champs
idstring
namestring
dealsobject[]
3 champs
idstring
namestring
statusenum<string>

OPENWONLOST

userobject
3 champs
idstring
namestring
emailstring
datestring<date-time>
durationinteger | null

Total call length in seconds, from when the call starts (ringing included) to when it ends. For the talk time shown in the Allo app, use recording_duration.

resultenum<string>

Call outcome. Null for SMS items. An outbound call that reached voicemail reports VOICEMAIL. FAILED_EXTERNAL only appears on older calls. New values may be added: handle unknown values gracefully.

ANSWEREDVOICEMAILTRANSFERRED_AITRANSFERRED_EXTERNALBLOCKEDFAILEDFAILED_EXTERNALRECEIVEDCLOSED

detected_outbound_voicemailboolean | null

Outbound calls only. true when the call was answered by an answering machine, false when a human answered, null when no detection ran for this call (never set on inbound calls or SMS). Note that result stays ANSWERED for these calls — the carrier considers a machine pickup an answer.

voicemail_leftboolean | null

Outbound calls only. true when a message was actually left on the voicemail, false when the caller hung up without leaving one, null when not determined. Independent of detected_outbound_voicemail: either can be set without the other.

recording_urlstring | null

Link to the call recording. Absent when the call was not recorded, and for accounts sold under a white-label partner's brand: use recording_download_url there.

recording_download_urlstring | null

Signed link that downloads the recording with no login, valid for 48 hours. Returned only for lines of accounts created by a partner, never for a call on a HIPAA-enabled team, and only when the key's user can play the recording. For a fresh link, call GET /v2/api/conversations/items/{id}/recording.

recording_download_expires_atstring<date-time> | null

When recording_download_url stops working.

recording_durationinteger | null

Length of the call recording in seconds: the talk time, excluding ringing. This is the duration shown in the Allo app for recorded calls. null when the call was not recorded.

summarystring | null
tagsstring[]
extracted_dataobject | null

Contact details Allo's AI picked up from the call transcript, under a contact object: name, company, job_title, website, address (strings, empty when not mentioned) and emails (array). Null for SMS items and for calls Allo has not analyzed.

1 champs
contactobject
6 champs
namestring
companystring
job_titlestring
websitestring
addressstring
emailsstring[]
data_collectedobject | null

Legacy field kept for compatibility. An empty object on current calls. Null for SMS items.

transcriptobject[]
3 champs
sourceenum<string>

USEREXTERNAL

timestring<date-time>
textstring
contentstring | null
statusenum<string>

PENDINGSENTDELIVEREDFAILED

message_typeenum<string>

SMSMMSWHATSAPPFAX

attachmentsobject[]

Photos and other files sent with the message, in the order they were sent. For a fax, the faxed PDF. An empty array for a message with no files, and null for a call.

5 champs
file_namestring
content_typestring

MIME type of the file.

file_sizeinteger<int64> | null

Size of the file in bytes.

download_urlstring | null

Signed link that downloads the file with no login, valid for 30 minutes. null for a message on a HIPAA-enabled team. For a fresh link, fetch the item again.

download_expires_atstring<date-time> | null

When download_url stops working.

page_countinteger | null

Number of pages of a fax. null for calls, for messages that are not faxes, and for a fax whose page count is not known yet.

401
404
429