Cet endpoint est paginé. Utilisez les paramètres de requête page et size pour contrôler les résultats. Voir Pagination.
Ligne ou boîte de réception
Envoyez exactement un des deux paramètres allo_number ou inbox_id. Envoyer les deux, ou aucun, retourne une erreur 400 avec le code INVALID_REQUEST.
allo_numberliste les conversations d'une ligne Allo. Une ligne à laquelle l'appelant n'a pas accès retourne une erreur403avec le codeALLO_NUMBER_FORBIDDEN.inbox_idliste les conversations d'une de vos boîtes de réception, avec des conversations de plusieurs lignes (chaque ligne de résultat a un seulallo_number). Les sources et filtres enregistrés de la boîte s'appliquent, mais pas les onglets À traiter et Les miennes de l'app. "Non lues uniquement" n'est pas enregistré sur une boîte : passez le paramètre de requêteunread. Une boîte qui n'est pas la vôtre retourne une erreur404avec le codeINBOX_NOT_FOUND.
Chaque conversation a un champ allo_number, la ligne Allo sur laquelle elle se trouve. Utilisez-le pour épingler ou répondre quand vous listez par boîte.
Erreurs liées aux boîtes et aux épingles
| Statut | Code | Quand |
|---|---|---|
400 | INVALID_REQUEST | allo_number et inbox_id sont envoyés tous les deux, ou aucun |
400 | INVALID_PARAMETER | Un paramètre de requête est mal formé, par exemple pinned=yes. param le nomme |
400 | FEATURE_NOT_SUPPORTED | Lister par inbox_id ou avec pinned n'est pas encore disponible. param indique lequel |
400 | CONTACT_FILTER_NOT_SUPPORTED | La boîte a des filtres de contacts enregistrés et l'espace de travail utilise encore l'ancien modèle de contacts. Retirez contact_ids et contact_list_ids des filtres de la boîte |
403 | ALLO_NUMBER_FORBIDDEN | L'appelant n'a pas accès à la ligne allo_number |
404 | INBOX_NOT_FOUND | Aucune boîte avec cet ID pour l'appelant. Juste après une création, l'erreur peut être passagère : si retryable vaut true, réessayez une fois |
422 | CONTACT_FILTER_TOO_LARGE | Les filtres de contacts de la boîte correspondent à trop de numéros, ou contiennent plus de 50 IDs de contacts ou 10 IDs de listes. Le type de l'erreur est validation_error |
Conversations épinglées
Chaque conversation a un champ pinned. Passez pinned=true pour lister seulement les conversations épinglées, ou pinned=false pour les exclure. Épinglez et désépinglez avec Épingler une conversation et Désépingler une conversation.
Notes sur les champs
| Champ | Null quand |
|---|---|
last_item.summary | Éléments SMS, ou appels dont le résumé IA n'est pas encore disponible |
last_item.duration | Éléments SMS (s'applique uniquement aux appels) |
last_item.result | Éléments SMS (s'applique uniquement aux appels) |
last_item.recording_url | Enregistrement désactivé, appel sans réponse, ou éléments SMS |
last_item.recording_duration | Enregistrement désactivé, appel sans réponse, ou éléments SMS |
last_item.transcript | Non demandé via extend=transcript, ou éléments SMS |
last_item.content | Éléments d'appel (s'applique uniquement aux SMS) |
last_item.status | Éléments d'appel (s'applique uniquement aux SMS) |
last_item.attachments | Éléments d'appel. Un SMS sans photo ni fichier renvoie un tableau vide. Voir Fichiers joints aux MMS. |
last_item.page_count | Appels, messages qui ne sont pas des fax, ou fax dont le nombre de pages n'est pas encore connu |
last_item.contacts | Tableau vide lorsqu'aucun contact correspondant n'existe dans le carnet d'adresses |
last_item.duration est la durée totale de l'appel en secondes, sonnerie incluse. last_item.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 last_item.duration.
Paramètre extend
Le paramètre de requête extend accepte une liste de champs optionnels séparés par des virgules. Actuellement pris en charge :
| Valeur | Effet |
|---|---|
transcript | Inclure les transcriptions complètes des appels sur les éléments de conversation |
Passer une valeur non prise en charge renvoie une erreur 400 avec le code UNSUPPORTED_EXTEND_VALUE.