Allo

Lister les boîtes de réception

Retourne les boîtes de réception de l'appelant. Passez le paramètre de requête user id pour lister celles d'un coéquipier. Seuls les admins et managers de…

GET/v2/api/inboxes

Comportement

Retourne les boîtes de réception de l'appelant. Passez le paramètre de requête user_id pour lister celles d'un coéquipier. Seuls les admins et managers de l'espace de travail du coéquipier peuvent le faire. La liste ne montre alors que les boîtes du coéquipier ayant au moins une source dans un espace de travail que l'appelant gère, et seulement ces sources.

filters est toujours retourné avec toutes ses clés. Les sources sur une ligne à laquelle le propriétaire de la boîte n'a plus accès sont absentes de sources.

Erreurs

StatutCodeQuand
403FORBIDDENuser_id est renseigné et l'appelant n'est ni admin ni manager de l'espace de travail de ce coéquipier

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de requête

user_idstring

Act on a teammate's inbox (usr-*). The caller must be an admin or manager of that teammate's workspace, and only reaches inboxes and sources in workspaces they manage. Omit to act on your own inboxes.

Réponses

200The inboxes
dataobject[]
7 champs
idstringrequis
namestringrequis
emojistring | nullrequis
sourcesobject[]requis
2 champs
allo_numberstringrequis

Allo line (E.164).

conditionsobject[]requis

Empty means every conversation on the line.

filtersobjectrequis

Saved filters, with the same meaning as the conversation list filters in the app. "Unread only" is not saved on an inbox: use the unread query parameter of List conversations.

5 champs
typesenum<string>[]

INBOUND_CALLOUTBOUND_CALLTRANSFERREDINBOUND_TEXT_MESSAGEOUTBOUND_TEXT_MESSAGEVOICEMAILAI_ASSISTANT

user_idsstring[]

Teammates (usr-*), up to 50.

contact_idsstring[]

Contacts, up to 50.

contact_list_idsstring[]

Contact lists, up to 10.

tag_keysstring[]

Call tag keys (AI or manual tags, from GET /v2/api/tags), up to 20. A conversation matches when any of its calls on the inbox's lines has one of these tags, not only the last call. Each key must be a tag of your workspace.

notifications_mutedbooleanrequis
favorited_atstring<date-time> | nullrequis

When the owner starred the inbox, null when it is not a favorite. Favorites show first in the app's inbox switcher, oldest star first.

401
403
429