Connectors
Communication, Email & Calendar
MessageBird
Omnichannel messaging and voice: conversations, calls, call flows, contacts, and numbers
- Signs in with
- Connection fields
- Runs on
- Cloud or On-Prem Worker
- Operations
- 131
- Ready-made triggers
- 4
Connect MessageBird
- In Neblex open Connect › Connections and click New Connection.
- Search for MessageBird and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| Access keyRequiredSecret | A live or test access key from the MessageBird dashboard (Developers > API access). |
Triggers
For events that arrive as a webhook, add a Webhook trigger and enter its Webhook URL in MessageBird's webhook settings.
| Event | What it does | How |
|---|---|---|
| Call event | Fires when a Voice Calling webhook posts a created or updated call or leg. | Receives a webhook |
| Conversation event | Fires when a Conversations webhook posts a created or updated conversation or message. | Receives a webhook |
| SMS received | Fires when MessageBird forwards an SMS received on one of the account's numbers to the flow URL set on the number. | Receives a webhook |
| SMS status report | Fires when MessageBird posts a sent message's delivery status to its status report URL. | Receives a webhook |
Use it in a flow
- Open a flow, open the node library and search for MessageBird.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
Operations
131 operations in 22 groups. Each one is a step you can add to a flow.
Account1
Get the balancegetBalance | GET | The account's payment type and remaining balance. |
Back order8
Get a back ordergetBackOrder | GET | A placed back order's status. |
Get a back order productgetBackOrderProduct | GET | A product's prefixes, lead time and requirements. |
List required documentslistBackOrderDocuments | GET | The identity documents a back order still needs. |
List required end-user detailslistBackOrderEndUserDetails | GET | The end-user details a back order needs. |
Place a back orderplaceBackOrder | POST | Order up to 100 numbers of a product and prefix. |
Search back order productssearchBackOrderProducts | GET | Number products that can be back ordered, by country, features, prefix and type. |
Submit end-user detailssubmitBackOrderEndUserDetails | POST | Send the end-user details a back order needs, by their ids. |
Upload a documentuploadBackOrderDocument | POST | Upload one required identity document, base64 encoded. |
Call11
Add a participantaddCallParticipant | POST | Call another number into an ongoing inbound call. |
Change a call's flowupdateCall | PUT | Run a new call flow, fetched from a URL, on an ongoing call. |
Disconnect a legdeleteLeg | DELETE | Disconnect one leg; in a two-party call this ends the call. |
Get a callgetCall | GET | One call with its status. |
Get a leggetLeg | GET | One leg of a call with its status, duration and cost. |
Hang up a calldeleteCall | DELETE | End every leg of a call. |
List a call's legslistLegs | GET | The inbound and outbound legs of a call, one page at a time. |
List callslistCalls | GET | The account's calls, one page at a time. |
Make a callcreateCall | POST | Place an outbound call that runs a call flow when answered. |
Put a leg on holdholdLeg | POST | Hold a leg, optionally playing music. |
Take a leg off holdunholdLeg | POST | Bring a held leg back into the call. |
Call flow8
Add numbers to a call flowaddCallFlowNumbers | POST | Run a call flow for inbound calls to more of the account's numbers. |
Create a call flowcreateCallFlow | POST | Create the steps (say, play, transfer, record, pause, fetch call flow, hang up) run for a call. |
Delete a call flowdeleteCallFlow | DELETE | Delete a call flow. |
Get a call flowgetCallFlow | GET | One call flow with its steps. |
List a call flow's numberslistCallFlowNumbers | GET | The numbers whose inbound calls run a call flow, one page at a time. |
List call flowslistCallFlows | GET | The account's call flows, one page at a time (page; pagination.pageCount is the number of pages). |
Replace a call flow's numbersreplaceCallFlowNumbers | PUT | Set exactly which numbers run a call flow for inbound calls. |
Update a call flowupdateCallFlow | PUT | Replace a call flow's steps or recording setting. |
Contact5
Create a contactcreateContact | POST | Add a contact with its number, name and four custom fields. |
Delete a contactdeleteContact | DELETE | Delete a contact. |
Get a contactgetContact | GET | One contact. |
List contactslistContacts | GET | The account's contacts. |
Update a contactupdateContact | PATCH | Change a contact's number, name or custom fields. |
Conversation10
Archive or reopen a conversationupdateConversation | PATCH | Set a conversation's status. |
Get a conversationgetConversation | GET | One conversation with its contact and channels. |
Get a messagegetConversationMessage | GET | One conversation message with its status. |
Get messages by idlistMessagesByIds | GET | Several conversation messages at once, optionally only those after a time. |
List a contact's conversationslistContactConversations | GET | The conversations of one contact, one page at a time. |
List a conversation's messageslistConversationMessages | GET | The messages of a conversation, one page at a time. |
List conversationslistConversations | GET | Conversations with the newest messages first, by id or status, one page at a time (limit and offset; totalCount is the total). |
Reply in a conversationreplyToConversation | POST | Send a message in an existing conversation, optionally on another channel. |
Send a messagesendConversationMessage | POST | Send a message on a channel (WhatsApp, SMS, Messenger, Telegram, LINE, email and others); an existing conversation with the recipient is resumed. |
Start a conversationstartConversation | POST | Start a conversation with a contact by sending its first message. |
Conversation webhook5
Create a webhookcreateConversationWebhook | POST | Have conversation and message events posted to a URL. |
Delete a webhookdeleteConversationWebhook | DELETE | Delete a conversation webhook. |
Get a webhookgetConversationWebhook | GET | One conversation webhook. |
List webhookslistConversationWebhooks | GET | The conversation webhooks, one page at a time. |
Update a webhookupdateConversationWebhook | PATCH | Change a webhook's URL, events, status or settings. |
File3
Delete a filedeleteFile | DELETE | Delete a stored file. |
Download a filegetFile | GET | A stored file's contents. |
Upload a fileuploadFile | POST | Store a file of up to 100 MB to send with Conversations messages. |
Group8
Add contacts to a groupaddGroupContacts | PUT | Add up to 50 contacts to a group. |
Create a groupcreateGroup | POST | Create a contact group. |
Delete a groupdeleteGroup | DELETE | Delete a group; its contacts are kept. |
Get a groupgetGroup | GET | One contact group. |
List a group's contactslistGroupContacts | GET | The contacts in a group. |
List groupslistGroups | GET | The account's contact groups. |
Remove a contact from a groupremoveGroupContact | DELETE | Take a contact out of a group. |
Rename a groupupdateGroup | PATCH | Change a group's name. |
HLR3
Get an HLR lookupgetHlr | GET | One HLR lookup with its network details. |
List HLR lookupslistHlr | GET | The account's HLR lookups. |
Request an HLR lookuprequestHlr | POST | Ask the home network whether a number is reachable; the result arrives later. |
Lookup3
Get a number's HLRgetLookupHlr | GET | The latest HLR lookup of a number. |
Look up a numberlookupNumber | GET | A number's type, country and formats (E.164, international, national, RFC 3966). |
Request an HLR for a numberrequestLookupHlr | POST | Start an HLR lookup through the Lookup API. |
MMS3
Get an MMSgetMms | GET | One MMS with each recipient's status. |
List MMSlistMms | GET | The account's MMS messages. |
Send an MMSsendMms | POST | Send a multimedia message with text and media links (US and Canada numbers). |
Number6
Buy a numberpurchaseNumber | POST | Buy a number found by the search. |
Cancel a numbercancelPurchasedNumber | DELETE | Release a number from the account. |
Get a numbergetPurchasedNumber | GET | One of the account's numbers. |
List your numberslistPurchasedNumbers | GET | The numbers the account owns, by type, feature, tags, region or locality, one page at a time (limit and offset; totalCount is the total). |
Search numbers to buysearchAvailableNumbers | GET | Numbers available in a country by pattern, features and type. |
Tag a numberupdatePurchasedNumber | PATCH | Set the tags that group or label a number. |
Number pool8
Add numbers to a pooladdPoolNumbers | POST | Attach up to 1,000 numbers to a pool. |
Create a number poolcreateNumberPool | POST | Create a pool of numbers for a service, such as random caller ids. |
Delete a number pooldeleteNumberPool | DELETE | Delete a pool and detach its numbers. |
Get a number poolgetNumberPool | GET | One number pool. |
List a pool's numberslistPoolNumbers | GET | The numbers in a pool, one page at a time (limit and offset). |
List number poolslistNumberPools | GET | The account's number pools by name or service, one page at a time (limit and offset). |
Remove numbers from a poolremovePoolNumbers | DELETE | Detach numbers from a pool. |
Update a number poolupdateNumberPool | PUT | Rename a pool or change its configuration. |
Omnichannel contact13
Add a contact identifieraddContactIdentifier | POST | Link a phone number, email address or channel id to a contact. |
Create an omnichannel contactcreateContactV2 | POST | Create a contact profile used across every channel. |
Create or update an omnichannel contactupsertContactV2 | POST | Find a contact by its identifiers and update it, or create it when none matches. |
Delete an omnichannel contactdeleteContactV2 | DELETE | Delete a contact with its profiles, conversations and their messages. |
Get a contact identifiergetContactIdentifier | GET | One identifier of a contact. |
Get an import's statusgetContactImportStatus | GET | Whether a contact import is queued, in progress, completed or failed. |
Get an omnichannel contactgetContactV2 | GET | One contact with its identifiers and channel profiles. |
Import contactsimportContacts | POST | Import up to 100,000 contacts from a CSV file (columns phone, email, firstName, lastName, displayName and custom: ). |
List a contact's identifierslistContactIdentifiers | GET | The phone numbers, email addresses and channel ids of a contact. |
List omnichannel contactslistContactsV2 | GET | Contacts by id, channel, exact identifier or status, one page at a time (limit and offset; totalCount is the total). |
Merge omnichannel contactsmergeContactsV2 | POST | Merge one contact into another, with its conversations. |
Remove a contact identifierdeleteContactIdentifier | DELETE | Remove an identifier and the channel profiles linked to it. |
Update an omnichannel contactupdateContactV2 | PATCH | Change a contact; languages are replaced and attributes merged. |
Recording7
Delete a recordingdeleteRecording | DELETE | Delete a recording. |
Download a recordingdownloadRecording | GET | A recording's WAV file. |
Get a recordinggetRecording | GET | One recording's details and file link. |
Get a transcriptiongetTranscription | GET | One transcription with its status and file links. |
List a leg's recordingslistRecordings | GET | The recordings of a leg, one page at a time (limit and offset). |
List a recording's transcriptionslistTranscriptions | GET | The transcriptions of a recording. |
Transcribe a recordingcreateTranscription | POST | Request a text transcription of a recording; it completes asynchronously. |
SMS5
Delete an SMSdeleteSms | DELETE | Delete an SMS, which also cancels it when it is still scheduled. |
Get an SMSgetSms | GET | One SMS with each recipient's delivery status. |
List SMSlistSms | GET | Sent and received SMS, filtered by sender, direction, type or status (for example scheduled). |
Send an SMSsendSms | POST | Send an SMS to up to 50 numbers or to contact groups, now or at a scheduled time. |
Send SMS in a batchsendSmsBatch | POST | Send up to 100 different SMS messages, each to its own recipients, in one request. |
Verify5
Check a verification codecheckVerificationCode | GET | Check the code the user entered. |
Delete a verificationdeleteVerification | DELETE | Delete a verification, which also invalidates its code. |
Get a verificationgetVerification | GET | One verification with its status. |
Get a verification emailgetVerificationEmail | GET | The status of a verification's email message. |
Send a verification codecreateVerification | POST | Send a one-time code by SMS, flash SMS, voice call or email. |
Voice message3
Get a voice messagegetVoiceMessage | GET | One voice message with each recipient's status. |
List voice messageslistVoiceMessages | GET | The account's voice messages. |
Send a voice messagesendVoiceMessage | POST | Call numbers and read a text to them with text to speech. |
Voice number4
Create a number webhookcreateNumberWebhook | POST | Have call events of one number posted to a URL. |
Get a number's call flowgetNumberCallFlow | GET | The call flow that inbound calls to a number run. |
List a number's webhookslistNumberWebhooks | GET | The webhooks attached to one number. |
List voice numberslistVoiceNumbers | GET | The account's voice-enabled numbers, one page at a time. |
Voice webhook5
Create a webhookcreateVoiceWebhook | POST | Have call and leg events posted to a URL. |
Delete a webhookdeleteVoiceWebhook | DELETE | Delete a voice webhook, including one attached to a number. |
Get a webhookgetVoiceWebhook | GET | One voice webhook. |
List webhookslistVoiceWebhooks | GET | The account's voice webhooks. |
Update a webhookupdateVoiceWebhook | PUT | Change a voice webhook's URL or token. |
WhatsApp template7
Create a WhatsApp templatecreateWhatsAppTemplate | POST | Submit a WhatsApp message template for approval. |
Delete a template languagedeleteWhatsAppTemplateLanguage | DELETE | Delete one language version of a template. |
Delete a WhatsApp templatedeleteWhatsAppTemplates | DELETE | Delete a template in every language. |
Get a template's languageslistWhatsAppTemplatesByName | GET | Every language version of a template. |
Get a WhatsApp templategetWhatsAppTemplate | GET | A template in one language with its approval status. |
List WhatsApp templateslistWhatsAppTemplates | GET | The account's templates, one page at a time (limit and offset; totalCount is the total). |
Update a WhatsApp templateupdateWhatsAppTemplate | PUT | Replace the components of a template in one language. |