Settings
| Setting | What it is |
|---|---|
| ConnectionRequired | The MessageBird connection the step signs in with. |
| Contacts per call | 1 to 100. MessageBird answers 20 by default. |
| Skip | How many contacts to skip. Ignored when Fetch every page is on. |
| Fetch every page | Walks the offset from the start, and refuses past 5,000 contacts rather than answering a short list. |
| Cursor | Paste a previous run's Next cursor to read the page after it. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `messagebird`) |
limit | number, by default 20 |
offset | number, by default 0 |
returnAll | true/false, by default false |
cursor | text |
Output
| Field | Type |
|---|---|
contacts | array |
contactCountContacts in this answer | number |
hasMoreMore contacts are waiting behind this page | boolean |
totalCountContacts MessageBird has in total | number |
nextCursorCursor for the next page | string |
Sample output, and the expression for each field
- contactCount0
- contacts[]
- 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": 20,
"offset": 0,
"returnAll": false
},
"label": "List contacts",
"type": "messagebird.listContacts",
"version": 2
}Older versions
A flow that already has this version keeps running it. A new step always gets the newest.
Version 1
| Setting | What it is |
|---|---|
| ConnectionRequired | The MessageBird connection the step signs in with. |
| Contacts per call | 1 to 100. MessageBird answers 20 by default. |
| Skip | How many contacts to skip. Ignored when Fetch every page is on. |
| Fetch every page | Walks the offset from the start, and refuses past 5,000 contacts rather than answering a short list. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `messagebird`) |
limit | number, by default 20 |
offset | number, by default 0 |
returnAll | true/false, by default false |