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

  1. In Neblex open Connect › Connections and click New Connection.
  2. Search for MessageBird and give the connection a clear name.
  3. Fill in the fields. Secret values are encrypted and never shown again.
  4. Click Test, then Create Connection.
FieldWhat to enter
Access keyRequiredSecretA 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.

EventWhat it doesHow
Call eventFires when a Voice Calling webhook posts a created or updated call or leg.Receives a webhook
Conversation eventFires when a Conversations webhook posts a created or updated conversation or message.Receives a webhook
SMS receivedFires 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 reportFires when MessageBird posts a sent message's delivery status to its status report URL.Receives a webhook

Use it in a flow

  1. Open a flow, open the node library and search for MessageBird.
  2. Drag it onto the canvas and choose an Operation and your connection.
  3. Map the operation's fields from earlier steps, or click Map with Matt.
  4. 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 balancegetBalanceGETThe account's payment type and remaining balance.
Back order8
Get a back ordergetBackOrderGETA placed back order's status.
Get a back order productgetBackOrderProductGETA product's prefixes, lead time and requirements.
List required documentslistBackOrderDocumentsGETThe identity documents a back order still needs.
List required end-user detailslistBackOrderEndUserDetailsGETThe end-user details a back order needs.
Place a back orderplaceBackOrderPOSTOrder up to 100 numbers of a product and prefix.
Search back order productssearchBackOrderProductsGETNumber products that can be back ordered, by country, features, prefix and type.
Submit end-user detailssubmitBackOrderEndUserDetailsPOSTSend the end-user details a back order needs, by their ids.
Upload a documentuploadBackOrderDocumentPOSTUpload one required identity document, base64 encoded.
Call11
Add a participantaddCallParticipantPOSTCall another number into an ongoing inbound call.
Change a call's flowupdateCallPUTRun a new call flow, fetched from a URL, on an ongoing call.
Disconnect a legdeleteLegDELETEDisconnect one leg; in a two-party call this ends the call.
Get a callgetCallGETOne call with its status.
Get a leggetLegGETOne leg of a call with its status, duration and cost.
Hang up a calldeleteCallDELETEEnd every leg of a call.
List a call's legslistLegsGETThe inbound and outbound legs of a call, one page at a time.
List callslistCallsGETThe account's calls, one page at a time.
Make a callcreateCallPOSTPlace an outbound call that runs a call flow when answered.
Put a leg on holdholdLegPOSTHold a leg, optionally playing music.
Take a leg off holdunholdLegPOSTBring a held leg back into the call.
Call flow8
Add numbers to a call flowaddCallFlowNumbersPOSTRun a call flow for inbound calls to more of the account's numbers.
Create a call flowcreateCallFlowPOSTCreate the steps (say, play, transfer, record, pause, fetch call flow, hang up) run for a call.
Delete a call flowdeleteCallFlowDELETEDelete a call flow.
Get a call flowgetCallFlowGETOne call flow with its steps.
List a call flow's numberslistCallFlowNumbersGETThe numbers whose inbound calls run a call flow, one page at a time.
List call flowslistCallFlowsGETThe account's call flows, one page at a time (page; pagination.pageCount is the number of pages).
Replace a call flow's numbersreplaceCallFlowNumbersPUTSet exactly which numbers run a call flow for inbound calls.
Update a call flowupdateCallFlowPUTReplace a call flow's steps or recording setting.
Contact5
Create a contactcreateContactPOSTAdd a contact with its number, name and four custom fields.
Delete a contactdeleteContactDELETEDelete a contact.
Get a contactgetContactGETOne contact.
List contactslistContactsGETThe account's contacts.
Update a contactupdateContactPATCHChange a contact's number, name or custom fields.
Conversation10
Archive or reopen a conversationupdateConversationPATCHSet a conversation's status.
Get a conversationgetConversationGETOne conversation with its contact and channels.
Get a messagegetConversationMessageGETOne conversation message with its status.
Get messages by idlistMessagesByIdsGETSeveral conversation messages at once, optionally only those after a time.
List a contact's conversationslistContactConversationsGETThe conversations of one contact, one page at a time.
List a conversation's messageslistConversationMessagesGETThe messages of a conversation, one page at a time.
List conversationslistConversationsGETConversations with the newest messages first, by id or status, one page at a time (limit and offset; totalCount is the total).
Reply in a conversationreplyToConversationPOSTSend a message in an existing conversation, optionally on another channel.
Send a messagesendConversationMessagePOSTSend a message on a channel (WhatsApp, SMS, Messenger, Telegram, LINE, email and others); an existing conversation with the recipient is resumed.
Start a conversationstartConversationPOSTStart a conversation with a contact by sending its first message.
Conversation webhook5
Create a webhookcreateConversationWebhookPOSTHave conversation and message events posted to a URL.
Delete a webhookdeleteConversationWebhookDELETEDelete a conversation webhook.
Get a webhookgetConversationWebhookGETOne conversation webhook.
List webhookslistConversationWebhooksGETThe conversation webhooks, one page at a time.
Update a webhookupdateConversationWebhookPATCHChange a webhook's URL, events, status or settings.
File3
Delete a filedeleteFileDELETEDelete a stored file.
Download a filegetFileGETA stored file's contents.
Upload a fileuploadFilePOSTStore a file of up to 100 MB to send with Conversations messages.
Group8
Add contacts to a groupaddGroupContactsPUTAdd up to 50 contacts to a group.
Create a groupcreateGroupPOSTCreate a contact group.
Delete a groupdeleteGroupDELETEDelete a group; its contacts are kept.
Get a groupgetGroupGETOne contact group.
List a group's contactslistGroupContactsGETThe contacts in a group.
List groupslistGroupsGETThe account's contact groups.
Remove a contact from a groupremoveGroupContactDELETETake a contact out of a group.
Rename a groupupdateGroupPATCHChange a group's name.
HLR3
Get an HLR lookupgetHlrGETOne HLR lookup with its network details.
List HLR lookupslistHlrGETThe account's HLR lookups.
Request an HLR lookuprequestHlrPOSTAsk the home network whether a number is reachable; the result arrives later.
Lookup3
Get a number's HLRgetLookupHlrGETThe latest HLR lookup of a number.
Look up a numberlookupNumberGETA number's type, country and formats (E.164, international, national, RFC 3966).
Request an HLR for a numberrequestLookupHlrPOSTStart an HLR lookup through the Lookup API.
MMS3
Get an MMSgetMmsGETOne MMS with each recipient's status.
List MMSlistMmsGETThe account's MMS messages.
Send an MMSsendMmsPOSTSend a multimedia message with text and media links (US and Canada numbers).
Number6
Buy a numberpurchaseNumberPOSTBuy a number found by the search.
Cancel a numbercancelPurchasedNumberDELETERelease a number from the account.
Get a numbergetPurchasedNumberGETOne of the account's numbers.
List your numberslistPurchasedNumbersGETThe 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 buysearchAvailableNumbersGETNumbers available in a country by pattern, features and type.
Tag a numberupdatePurchasedNumberPATCHSet the tags that group or label a number.
Number pool8
Add numbers to a pooladdPoolNumbersPOSTAttach up to 1,000 numbers to a pool.
Create a number poolcreateNumberPoolPOSTCreate a pool of numbers for a service, such as random caller ids.
Delete a number pooldeleteNumberPoolDELETEDelete a pool and detach its numbers.
Get a number poolgetNumberPoolGETOne number pool.
List a pool's numberslistPoolNumbersGETThe numbers in a pool, one page at a time (limit and offset).
List number poolslistNumberPoolsGETThe account's number pools by name or service, one page at a time (limit and offset).
Remove numbers from a poolremovePoolNumbersDELETEDetach numbers from a pool.
Update a number poolupdateNumberPoolPUTRename a pool or change its configuration.
Omnichannel contact13
Add a contact identifieraddContactIdentifierPOSTLink a phone number, email address or channel id to a contact.
Create an omnichannel contactcreateContactV2POSTCreate a contact profile used across every channel.
Create or update an omnichannel contactupsertContactV2POSTFind a contact by its identifiers and update it, or create it when none matches.
Delete an omnichannel contactdeleteContactV2DELETEDelete a contact with its profiles, conversations and their messages.
Get a contact identifiergetContactIdentifierGETOne identifier of a contact.
Get an import's statusgetContactImportStatusGETWhether a contact import is queued, in progress, completed or failed.
Get an omnichannel contactgetContactV2GETOne contact with its identifiers and channel profiles.
Import contactsimportContactsPOSTImport up to 100,000 contacts from a CSV file (columns phone, email, firstName, lastName, displayName and custom: ).
List a contact's identifierslistContactIdentifiersGETThe phone numbers, email addresses and channel ids of a contact.
List omnichannel contactslistContactsV2GETContacts by id, channel, exact identifier or status, one page at a time (limit and offset; totalCount is the total).
Merge omnichannel contactsmergeContactsV2POSTMerge one contact into another, with its conversations.
Remove a contact identifierdeleteContactIdentifierDELETERemove an identifier and the channel profiles linked to it.
Update an omnichannel contactupdateContactV2PATCHChange a contact; languages are replaced and attributes merged.
Recording7
Delete a recordingdeleteRecordingDELETEDelete a recording.
Download a recordingdownloadRecordingGETA recording's WAV file.
Get a recordinggetRecordingGETOne recording's details and file link.
Get a transcriptiongetTranscriptionGETOne transcription with its status and file links.
List a leg's recordingslistRecordingsGETThe recordings of a leg, one page at a time (limit and offset).
List a recording's transcriptionslistTranscriptionsGETThe transcriptions of a recording.
Transcribe a recordingcreateTranscriptionPOSTRequest a text transcription of a recording; it completes asynchronously.
SMS5
Delete an SMSdeleteSmsDELETEDelete an SMS, which also cancels it when it is still scheduled.
Get an SMSgetSmsGETOne SMS with each recipient's delivery status.
List SMSlistSmsGETSent and received SMS, filtered by sender, direction, type or status (for example scheduled).
Send an SMSsendSmsPOSTSend an SMS to up to 50 numbers or to contact groups, now or at a scheduled time.
Send SMS in a batchsendSmsBatchPOSTSend up to 100 different SMS messages, each to its own recipients, in one request.
Verify5
Check a verification codecheckVerificationCodeGETCheck the code the user entered.
Delete a verificationdeleteVerificationDELETEDelete a verification, which also invalidates its code.
Get a verificationgetVerificationGETOne verification with its status.
Get a verification emailgetVerificationEmailGETThe status of a verification's email message.
Send a verification codecreateVerificationPOSTSend a one-time code by SMS, flash SMS, voice call or email.
Voice message3
Get a voice messagegetVoiceMessageGETOne voice message with each recipient's status.
List voice messageslistVoiceMessagesGETThe account's voice messages.
Send a voice messagesendVoiceMessagePOSTCall numbers and read a text to them with text to speech.
Voice number4
Create a number webhookcreateNumberWebhookPOSTHave call events of one number posted to a URL.
Get a number's call flowgetNumberCallFlowGETThe call flow that inbound calls to a number run.
List a number's webhookslistNumberWebhooksGETThe webhooks attached to one number.
List voice numberslistVoiceNumbersGETThe account's voice-enabled numbers, one page at a time.
Voice webhook5
Create a webhookcreateVoiceWebhookPOSTHave call and leg events posted to a URL.
Delete a webhookdeleteVoiceWebhookDELETEDelete a voice webhook, including one attached to a number.
Get a webhookgetVoiceWebhookGETOne voice webhook.
List webhookslistVoiceWebhooksGETThe account's voice webhooks.
Update a webhookupdateVoiceWebhookPUTChange a voice webhook's URL or token.
WhatsApp template7
Create a WhatsApp templatecreateWhatsAppTemplatePOSTSubmit a WhatsApp message template for approval.
Delete a template languagedeleteWhatsAppTemplateLanguageDELETEDelete one language version of a template.
Delete a WhatsApp templatedeleteWhatsAppTemplatesDELETEDelete a template in every language.
Get a template's languageslistWhatsAppTemplatesByNameGETEvery language version of a template.
Get a WhatsApp templategetWhatsAppTemplateGETA template in one language with its approval status.
List WhatsApp templateslistWhatsAppTemplatesGETThe account's templates, one page at a time (limit and offset; totalCount is the total).
Update a WhatsApp templateupdateWhatsAppTemplatePUTReplace the components of a template in one language.