boomapp connect (Preview)

'Intelligent' global 2-way, Email, Voice, SMS and Push Messaging. Supercharge any Power Platform applications with boomapp connect to build truly automated multi-channel conversational communications workflows (uniquely driven by subject). Fully interactive comms workflows based on a recipient’s response allows the delivery of seamless and frictionless interactions without forcing behavioural change through the engagement. For further detail and to set up a free trial account, see our website.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Contact
Name Boomerang Support
URL https://www.boomerangmessaging.com/products/boomApp/msconnector
Email support@boomcomms.com
Connector Metadata
Publisher AlfaPeople UK Ltd
Website https://www.boomerangmessaging.com/products/boomApp/msconnector
Privacy policy https://boomerangmessaging.com/privacy/
Categories Communication;Productivity

Pre-requisites

You will need the following to proceed:

  • A Microsoft Power Automate plan with custom connector feature
  • A Boomerang Subscription
  • Boomerang API authentication details.

Create an account with Boomerang

  • website - Further details on how to create Boomerang accounts.

Support and documentation:

You can find the documentation here.

Creating a connection

The connector supports the following authentication types:

Default Required parameters for creating connection. All regions

Default

Applicable: All regions

Required parameters for creating connection.

Name Type Description
username securestring The username for this api
password securestring The password for this api

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Email

Send single or bulk email messages. Emails are sent from the domain @boomerangui.com and it is possible to customise the Subject and to override the 'From' address. It is also possible to forward responses to an email address and / or a URL

Sms custom number

SMS messages are delivered using the number specified in the request so that any replies are returned to that number. Customers using Boomerang's Campaign feature can use a number associated to a Campaign, which allows inbound replies to to be accessed from the Campaign reporting section within Boomerang UI. However, unlike the SMS 2-way method, replies are not tracked against the outbound message. See https://boomerangmessaging.com/docs/sending-sms-messages for more information.

Sms one-way

SMS messages are delivered using an alpha-numeric originator (such as a company name) which must contain a maximum of 11 characters, and a recipient cannot respond to a message sent using an alpha numeric originator. Please also note that in destinations where delivery of messages with alpha-numeric originator is not supported (due to local restrictions), this may be replaced with a numeric originator, to ensure that the message is delivered.

Sms two-way

This method allows replies to be tracked directly against each outbound transaction and is used to manage conversations between your system and the end user. Replies can be forwarded to an email address and customers with Boommail can send an email-2-SMS message back to the responder. See https://boomerangmessaging.com/docs/sending-sms-messages, for more information regarding 2-way and conversational messaging.

Voice

A fixed number is used as the originator for a Text-To-Speech (TTS) voice call. Keystrokes ‘1’ and ‘2’ are used to accept or decline the message, ‘9’ is used to redirect the call. See https://boomerangmessaging.com/docs/sending-delivering-voice-messages for more information

Email

Send single or bulk email messages. Emails are sent from the domain @boomerangui.com and it is possible to customise the Subject and to override the 'From' address. It is also possible to forward responses to an email address and / or a URL

Parameters

Name Key Required Type Description
from
from string

Pass the content to be used as the From address. If blank the default value will be taken from your account settings

email_subject
email_subject string

Subject to be displayed by default when the email is received in the recipient's inbox

message_content
message_content string

The content of the outbound message sent to all recipientAddresses.

email_address
email_address string

An email address. A single address or an array of up to 10,000 addresses can be passed.

validity_period
validity_period integer

The period of time during which the number used to send the message will be active. Replies to the message will not be delivered after the validity period expires. For two- way messages, the minimum validity period is 1 day.

open_ticket
open_ticket boolean

By default all messages are sent a single ticket which means that the message is closed on receipt of the first response. To match multiple responses to the same originating message, use open ticket by passing true.

email_responses
email_responses string

An email address to which message responses are forwarded.

push_responses
push_responses string

A CallBack URL to which message responses are posted.

unique_identifier
unique_identifier string

Unique identifier for each transaction. This is used to safeguard against duplication of messages, as Boomerang will ignore any transactions with an Id that has been used previously.

campaign_name
campaign_name string

Optional identifier that can be used to group messages by specific campaigns and batched messages.

custom_parameter
custom_parameter string

Parameter used for custom reference. This could be used for example as a Campaign reference, job reference, batch Id etc.

Returns

Name Path Type Description
status
status integer

status

message
message string

message

transactions
transactions array of object

transactions

transaction_id
transactions.transaction_id string

transaction_id

parts_per_message
transactions.parts_per_message integer

parts_per_message

email_address
transactions.email_address string

email_address

Sms custom number

SMS messages are delivered using the number specified in the request so that any replies are returned to that number. Customers using Boomerang's Campaign feature can use a number associated to a Campaign, which allows inbound replies to to be accessed from the Campaign reporting section within Boomerang UI. However, unlike the SMS 2-way method, replies are not tracked against the outbound message. See https://boomerangmessaging.com/docs/sending-sms-messages for more information.

Parameters

Name Key Required Type Description
from
from string

The sending Id associated to a message this could be an Inbound campaign number currently associated to an active Campaign.

message_content
message_content string

The content of the outbound message sent to all recipientAddresses.

The recipient's destination address
number string

The recipient's destination address; A mobile phone number that must contain a minimum of 11 digits (excluding + or leading '0') and a maximum of 16 digits (excluding a + where this is used as a pre-fix to the number itself). A single number or an array of up to 10,000 numbers can be passed.

priority
priority boolean

Optional parameter used to set a priority status to a message. Any messages sent with ‘priority’ will override ‘Social Hours’ configured against an account. Pass true to set priority.

unique_identifier
unique_identifier string

Unique identifier for each transaction. This is used to safeguard against duplication of messages, as Boomerang will ignore any transactions with an Id that has been used previously.

campaign_name
campaign_name string

Optional Identifier that can be used to group messages by specific campaigns and batched messages.

custom_parameter
custom_parameter string

Parameter used for custom reference. This could be used for example as a Campaign reference, job reference, batch Id etc.

Returns

Name Path Type Description
status
status integer

status

message
message string

message

transactions
transactions array of object

transactions

transaction_id
transactions.transaction_id string

transaction_id

parts_per_message
transactions.parts_per_message integer

parts_per_message

telephone_number
transactions.telephone_number string

telephone_number

Sms one-way

SMS messages are delivered using an alpha-numeric originator (such as a company name) which must contain a maximum of 11 characters, and a recipient cannot respond to a message sent using an alpha numeric originator. Please also note that in destinations where delivery of messages with alpha-numeric originator is not supported (due to local restrictions), this may be replaced with a numeric originator, to ensure that the message is delivered.

Parameters

Name Key Required Type Description
from
from string

Originating Id for a 1-way message. An alpha numeric value containing a maximum of 11 characters.

message_content
message_content string

The content of the outbound message sent to all recipientAddresses.

The recipient's destination address
number string

The recipient's destination address; A mobile phone number that must contain a minimum of 11 digits (excluding + or leading '0') and a maximum of 16 digits (excluding a + where this is used as a pre-fix to the number itself). A single number or an array of up to 10,000 numbers can be passed.

priority
priority boolean

Optional parameter used to set a priority status to a message. Any messages sent with ‘priority’ will override ‘Social Hours’ configured against an account. Pass true to set priority.

unique_identifier
unique_identifier string

Unique identifier for each transaction. This is used to safeguard against duplication of messages, as Boomerang will ignore any transactions with an Id that has been used previously.

campaign_name
campaign_name string

Optional Identifier that can be used to group messages by specific campaigns and batched messages.

custom_parameter
custom_parameter string

Parameter used for custom reference. This could be used for example as a Campaign reference, job reference, batch Id etc.

Returns

Name Path Type Description
status
status integer

status

message
message string

message

transactions
transactions array of object

transactions

transaction_id
transactions.transaction_id string

transaction_id

parts_per_message
transactions.parts_per_message integer

parts_per_message

telephone_number
transactions.telephone_number string

telephone_number

Sms two-way

This method allows replies to be tracked directly against each outbound transaction and is used to manage conversations between your system and the end user. Replies can be forwarded to an email address and customers with Boommail can send an email-2-SMS message back to the responder. See https://boomerangmessaging.com/docs/sending-sms-messages, for more information regarding 2-way and conversational messaging.

Parameters

Name Key Required Type Description
conversation_id
conversation_id string

Define a conversation ID to group all messages (including replies) part of the same conversation

message_content
message_content string

The content of the outbound message sent to all recipientAddresses.

The recipient's destination address
number string

The recipient's destination address; A mobile phone number that must contain a minimum of 11 digits (excluding + or leading '0') and a maximum of 16 digits (excluding a + where this is used as a pre-fix to the number itself). A single number or an array of up to 10,000 numbers can be passed.

validity_period
validity_period integer

The period of time during which the number used to send the message will be active. Replies to the message will not be delivered after the validity period expires. For two- way messages, the minimum validity period is 1 day.

open_ticket
open_ticket boolean

By default all messages are sent a single ticket which means that the message is closed on receipt of the first response. To match multiple responses to the same originating message, use open ticket by passing true.

email_responses
email_responses string

An email address to which message responses are forwarded.

push_responses
push_responses string

A CallBack URL to which message responses are posted.

priority
priority boolean

Optional parameter used to set a priority status to a message. Any messages sent with ‘priority’ will override ‘Social Hours’ configured against an account. Pass true to set priority.

unique_identifier
unique_identifier string

Unique identifier for each transaction. This is used to safeguard against duplication of messages, as Boomerang will ignore any transactions with an Id that has been used previously.

campaign_name
campaign_name string

Optional Identifier that can be used to group messages by specific campaigns and batched messages.

custom_parameter
custom_parameter string

Parameter used for custom reference. This could be used for example as a Campaign reference, job reference, batch Id etc.

Returns

Name Path Type Description
status
status integer

status

message
message string

message

transactions
transactions array of object

transactions

transaction_id
transactions.transaction_id string

transaction_id

parts_per_message
transactions.parts_per_message integer

parts_per_message

telephone_number
transactions.telephone_number string

telephone_number

Voice

A fixed number is used as the originator for a Text-To-Speech (TTS) voice call. Keystrokes ‘1’ and ‘2’ are used to accept or decline the message, ‘9’ is used to redirect the call. See https://boomerangmessaging.com/docs/sending-delivering-voice-messages for more information

Parameters

Name Key Required Type Description
voice_intro
voice_intro string

The message played when the voice call is answered. The Message content will be played right after it.

voice_thank_you
voice_thank_you string

The message played at the end of the voice call after the message content has been played.

voice_redirect_message
voice_redirect_message string

The message played at the end of the voice call after the message content has been played.

number
number string

Redirect number

voice_retries
voice_retries integer

Number of attempts made if the voice call is not answered the first time.

voice_delay
voice_delay integer

Time waited by the system between retries.

message_content
message_content string

The content of the outbound message sent to all recipientAddresses.

number
number string

The recipient's destination address; A mobile phone number that must contain a minimum of 11 digits (excluding + or leading '0') and a maximum of 16 digits (excluding a + where this is used as a pre-fix to the number itself). A single number or an array of up to 10,000 numbers can be passed.

priority
priority boolean

Optional parameter used to set a priority status to a message. Any messages sent with ‘priority’ will override ‘Social Hours’ configured against an account. Pass true to set priority.

unique_identifier
unique_identifier string

Unique identifier for each transaction. This is used to safeguard against duplication of messages, as Boomerang will ignore any transactions with an Id that has been used previously.

campaign_name
campaign_name string

Optional Identifier that can be used to group messages by specific campaigns and batched messages.

custom_parameter
custom_parameter string

Parameter used for custom reference. This could be used for example as a Campaign reference, job reference, batch Id etc.

Returns

Name Path Type Description
status
status integer

status

message
message string

message

transactions
transactions array of object

transactions

transaction_id
transactions.transaction_id string

transaction_id

parts_per_message
transactions.parts_per_message integer

parts_per_message

telephone_number
transactions.telephone_number string

telephone_number

Triggers

On Delivery Confirmed

Triggered by end user delivery status update. Updates the transaction with the delivery status returned by the end user's network operator. See https://boomerangmessaging.com/docs for more information

On SMS response submission

Triggered by inbound replies which are automatically mapped to the associated outbound messages when sent as an Intelligent 2-way / conversational message

On Delivery Confirmed

Triggered by end user delivery status update. Updates the transaction with the delivery status returned by the end user's network operator. See https://boomerangmessaging.com/docs for more information

Returns

Name Path Type Description
status
status integer

status

message
message string

message

has_more
has_more boolean

has_more

drs
drs array of object

drs

transaction_id
drs.transaction_id string

transaction_id

status
drs.status string

status

status_date
drs.status_date string

status_date

destination
drs.destination string

destination

custom_parameter
drs.custom_parameter string

custom_parameter

campaign_name
drs.campaign_name string

campaign_name

unique_id
drs.unique_id string

unique_id

On SMS response submission

Triggered by inbound replies which are automatically mapped to the associated outbound messages when sent as an Intelligent 2-way / conversational message

Returns

Name Path Type Description
status
status integer

status

message
message string

message

has_more
has_more boolean

has_more

replies
replies array of object

replies

transaction_id
replies.transaction_id string

transaction_id

custom_parameter
replies.custom_parameter string

custom_parameter

response_id
replies.response_id string

response_id

from
replies.from string

from

response_content
replies.response_content string

response_content

is_new
replies.is_new boolean

is_new

transaction_date
replies.transaction_date string

transaction_date

response_date
replies.response_date string

response_date