Allo

Get inbox suggestions

Ready-made inbox sources ranked from the caller's recent calls and texts, including phone-menu branches. Each suggestion carries a source to put in sources…

GET/v2/api/inboxes/suggestions

Behavior

Returns ready-made inbox sources for the caller, best first, ranked from the caller's recent calls and texts. This endpoint takes no user_id: suggestions are always the caller's.

Each suggestion carries a source. Put it in the sources of Create inbox as it is:

  • A suggestion with branch: null covers the whole line, and its source has empty conditions.
  • A suggestion with a branch covers one phone-menu path, and its source holds a MENU_BRANCH condition for that path.

To put several suggestions of the same line in one inbox, merge them into one source: concatenate the branches of their MENU_BRANCH conditions.

name and description are suggested labels for menu branches. A whole-line suggestion (branch: null) always has name and description set to null, and they can also be null for a branch when no label could be generated.

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Responses

200Suggestions, best first
dataobject[]
9 fields
allo_numberstringrequired
namestring | nullrequired

Suggested inbox name. Always null for a whole-line suggestion (branch: null).

descriptionstring | nullrequired

Always null for a whole-line suggestion (branch: null).

branchobject[]required

Phone-menu path, or null for the whole line.

2 fields
node_idstringrequired

ID of the phone-menu node in the line's published call flow.

digitstringrequired

Key pressed at that menu.

answeredintegerrequired

Calls the caller answered from this source recently.

rungintegerrequired

Calls that rang the caller from this source recently.

textedintegerrequired

Texts the caller exchanged on this source recently.

scoreintegerrequired

Ranking score. Higher first.

sourceobjectrequired
2 fields
allo_numberstringrequired

Allo line (E.164).

conditionsobject[]required

Empty means every conversation on the line.

401
403
429