Allo

Créer une boîte de réception

Crée une boîte de réception appartenant à l'appelant et la retourne avec un 201 . Envoyez user id dans le corps JSON pour la créer pour un coéquipier : la…

POST/v2/api/inboxes

Comportement

Crée une boîte de réception appartenant à l'appelant et la retourne avec un 201. Envoyez user_id dans le corps JSON pour la créer pour un coéquipier : la boîte appartient alors au coéquipier et apparaît dans son sélecteur de boîtes. Seuls les admins et managers de l'espace de travail du coéquipier peuvent le faire.

Chaque ligne source doit être accessible au propriétaire de la boîte, avec les mêmes règles d'accès aux lignes que dans l'app. Une source avec une liste conditions vide couvre toute la ligne. Construisez les sources à partir de la source des suggestions de boîtes, ou de la condition des options de menu.

Les conditions de menu ne sont acceptées que sur une ligne dont la liste d'options de menu n'est pas vide. Sur toute autre ligne, utilisez une source sur toute la ligne.

Chaque ligne apparaît une seule fois dans sources. Pour couvrir plusieurs options de menu d'une ligne, mettez tous leurs chemins dans les branches d'une seule condition MENU_BRANCH.

Erreurs

StatutCodeQuand
400INBOX_NAME_REQUIREDname est manquant ou vide
400INVALID_INBOX_SOURCEUne source, une condition ou une touche est nulle ou invalide, un chemin de menu n'est pas dans les options de menu de cette ligne, deux sources ont le même allo_number, ou une boîte de coéquipier n'aurait plus aucune ligne dans l'espace de travail de l'appelant
400INVALID_REQUEST_BODYname dépasse 80 caractères, emoji dépasse 16, plus de 100 sources, ou plus de 10 conditions dans une source. field_errors nomme chaque champ
400INVALID_INBOX_FILTERSfilters contient une clé inconnue ou une valeur invalide
400INBOX_LIMIT_REACHEDLe propriétaire de la boîte a déjà 50 boîtes
403FORBIDDENuser_id est renseigné et l'appelant n'est ni admin ni manager de l'espace de travail de ce coéquipier
403ALLO_NUMBER_FORBIDDENUne ligne source n'est pas accessible au propriétaire de la boîte, ou, avec user_id, n'est pas dans un espace de travail que l'appelant gère

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Corps

namestringrequis

Required and non-blank.

emojistring | null
sourcesobject[]requis
2 champs
allo_numberstringrequis

Allo line (E.164). Each line appears once in sources.

conditionsobject[]

Empty or absent means every conversation on the line.

filtersobject

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_mutedboolean
user_idstring

Create the inbox for this teammate (usr-*). The caller must be an admin or manager of that teammate's workspace.

Réponses

201Inbox created
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.

400
401
403
429