FlowmageDocs

List conversations

BetaReads dataVersion 2

Fetches the conversations on your WhatsApp and other channels.

Settings

SettingWhat it is
ConnectionRequiredThe MessageBird connection the step signs in with.
Conversations per call1 to 20 — MessageBird's own maximum here. It answers 10 by default.
SkipHow many conversations to skip. Ignored when Fetch every page is on.
Fetch every pageWalks the offset from the start. Pages here hold at most 20 rows, so this is many calls — it refuses past 1,000 conversations.
CursorPaste a previous run's Next cursor to read the page after it.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `messagebird`)
limitnumber, by default 10
offsetnumber, by default 0
returnAlltrue/false, by default false
cursortext

Output

FieldType
conversationsarray
conversationCountConversations in this answernumber
hasMoreMore conversations are waiting behind this pageboolean
totalCountConversations MessageBird has in totalnumber
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • conversationCount0
  • conversations[]
  • hasMorefalse
  • totalCount0

Errors

When a step of this node stops a run, the run page shows a code. Look it up:

Example step

The step as a flow file holds it. Replace each value in <…>.

{
  "config": {
    "connection": "<connection id>",
    "cursor": "",
    "limit": 10,
    "offset": 0,
    "returnAll": false
  },
  "label": "List conversations",
  "type": "messagebird.listConversations",
  "version": 2
}

Older versions

A flow that already has this version keeps running it. A new step always gets the newest.

Version 1
SettingWhat it is
ConnectionRequiredThe MessageBird connection the step signs in with.
Conversations per call1 to 20 — MessageBird's own maximum here. It answers 10 by default.
SkipHow many conversations to skip. Ignored when Fetch every page is on.
Fetch every pageWalks the offset from the start. Pages here hold at most 20 rows, so this is many calls — it refuses past 1,000 conversations.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `messagebird`)
limitnumber, by default 10
offsetnumber, by default 0
returnAlltrue/false, by default false