Allo

Modifier une boîte de réception

Modifie seulement les champs envoyés et retourne la boîte. Envoyer sources remplace toute la liste. Envoyer filters remplace les filtres enregistrés, et…

PATCH/v2/api/inboxes/{inbox_id}

Comportement

Modifie seulement les champs envoyés et retourne la boîte. Envoyer sources remplace toute la liste. Envoyer filters remplace les filtres enregistrés, et "filters": null les efface. Les réglages À traiter et Les miennes de la boîte dans l'app sont conservés dans les deux cas. Envoyer "emoji": "" efface l'emoji. Un emoji absent ou null le conserve.

Pour couper les notifications d'une boîte, envoyez {"notifications_muted": true}. Pour les réactiver, envoyez false.

Pour mettre une boîte en favori, envoyez {"favorite": true}. Les boîtes favorites s'affichent en premier dans le sélecteur de boîtes de l'app, de la plus ancienne à la plus récente, et la réponse contient favorited_at. Remettre en favori une boîte qui l'est déjà conserve son premier favorited_at. Pour la retirer des favoris, envoyez false : favorited_at repasse à null.

Envoyez user_id dans le corps JSON pour modifier la boîte d'un coéquipier. Seuls les admins et managers de l'espace de travail du coéquipier peuvent le faire. Une boîte sans source dans un espace de travail que l'appelant gère retourne une erreur 404. Envoyer sources remplace seulement les lignes des espaces de l'appelant : les lignes du coéquipier dans d'autres espaces sont conservées.

Erreurs

StatutCodeQuand
400INBOX_NAME_REQUIREDname est envoyé 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
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
404INBOX_NOT_FOUNDAucune boîte avec cet ID n'appartient au propriétaire, ou, avec user_id, elle n'a aucune source dans un espace de travail que l'appelant gère

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

inbox_idstringrequis

Inbox ID (inb-*).

Corps

namestring

Cannot be blank.

emojistring | null

"" clears the emoji. Absent or null keeps it.

sourcesobject[]

Replaces the whole list. With user_id, only the lines in the caller's workspaces are replaced.

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
favoriteboolean

true stars the inbox (starring it again keeps its first favorited_at), false unstars it. Absent keeps it.

user_idstring

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

Réponses

200Inbox updated
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
404
429