Connectors Reference

boomapp connect

'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.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

SMS1 ([Optional]SMS1ParameterBody body)

Sms one-way

SMS2 ([Optional]SMS2ParameterBody body)

Sms two-way

SMS3 ([Optional]SMS3ParameterBody body)

Sms custom number

VOICE ([Optional]VOICEParameterBody body)

Voice

EMAIL ([Optional]EMAILParameterBody body)

Email

 

Triggers:

Name

Summary

GESTRESPONSESTRIGGER ([internal]boolean ignore_previous, [internal]boolean mark_as_read)

On SMS response submission

GETDRSTRIGGER ([internal]boolean ignore_previous, [internal]string drs_after)

On Delivery Confirmed

 

Objects:

Name

Summary

EMAILParameterBody

 

EMAILResponse

 

GESTRESPONSESTRIGGERResponse

 

GETDRSTRIGGERResponse

 

SMS1ParameterBody

 

SMS1Response

 

SMS2ParameterBody

 

SMS2Response

 

SMS3ParameterBody

 

SMS3Response

 

VOICEParameterBody

 

VOICEResponse

 

 

Actions:

SMS1

Summary: Sms one-way

Description: 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.

 

Syntax:

boomappconnect.SMS1 ([Optional]SMS1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

SMS1ParameterBody

 

 

False

 

Returns:

          Type:SMS1Response

 

SMS2

Summary: Sms two-way

Description: 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.

 

Syntax:

boomappconnect.SMS2 ([Optional]SMS2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

SMS2ParameterBody

 

 

False

 

Returns:

          Type:SMS2Response

 

SMS3

Summary: Sms custom number

Description: 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.

 

Syntax:

boomappconnect.SMS3 ([Optional]SMS3ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

SMS3ParameterBody

 

 

False

 

Returns:

          Type:SMS3Response

 

VOICE

Summary: Voice

Description: 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

 

Syntax:

boomappconnect.VOICE ([Optional]VOICEParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

VOICEParameterBody

 

 

False

 

Returns:

          Type:VOICEResponse

 

EMAIL

Summary: Email

Description: 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

 

Syntax:

boomappconnect.EMAIL ([Optional]EMAILParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

EMAILParameterBody

 

 

False

 

Returns:

          Type:EMAILResponse

 

Triggers:

Trigger GESTRESPONSESTRIGGER

Summary: On SMS response submission

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

 

Syntax:

boomappconnect.GESTRESPONSESTRIGGER ([internal]boolean ignore_previous, [internal]boolean mark_as_read)

 

Parameters:

Name

Type

Summary

Required

Related Action

ignore_previous

boolean

 

 

True

mark_as_read

boolean

 

 

True

 

Returns:

          Type:GESTRESPONSESTRIGGERResponse

 

Trigger GETDRSTRIGGER

Summary: On Delivery Confirmed

Description: 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

 

Syntax:

boomappconnect.GETDRSTRIGGER ([internal]boolean ignore_previous, [internal]string drs_after)

 

Parameters:

Name

Type

Summary

Required

Related Action

ignore_previous

boolean

 

Pass 'true' to exclude any DRs that have been retrieved previously

True

drs_after

string

 

Pass 'true' to exclude any DRs that have been retrieved previously

True

 

Returns:

          Type:GETDRSTRIGGERResponse

 


 

EMAILParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

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

string

 

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

message_content

string

 

The content of the outbound message sent to all recipientAddresses.

email_address

array of (string)

 

email_address

validity_period

integer(int32)

 

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

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.  Values: [, ]

email_responses

string

 

An email address to which message responses are forwarded.

push_responses

string

 

A CallBack URL to which message responses are posted.

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

string

 

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

custom_parameter

string

 

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


 

EMAILResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

status

integer(int32)

 

status

message

string

 

message

transactions

array of (TransactionsItem)

 

transactions

 

TransactionsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

transaction_id

string

 

transaction_id

parts_per_message

integer(int32)

 

parts_per_message

email_address

string

 

email_address

 


 

GESTRESPONSESTRIGGERResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

status

integer(int32)

 

status

message

string

 

message

has_more

boolean

 

has_more

replies

array of (RepliesItem)

 

replies

 

RepliesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

transaction_id

string

 

transaction_id

custom_parameter

string

 

custom_parameter

response_id

string

 

response_id

from

string

 

from

response_content

string

 

response_content

is_new

boolean

 

is_new

transaction_date

string

 

transaction_date

response_date

string

 

response_date

 


 

GETDRSTRIGGERResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

status

integer(int32)

 

status

message

string

 

message

has_more

boolean

 

has_more

drs

array of (DrsItem)

 

drs

 

DrsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

transaction_id

string

 

transaction_id

status

string

 

status

status_date

string

 

status_date

destination

string

 

destination

custom_parameter

string

 

custom_parameter

campaign_name

string

 

campaign_name

unique_id

string

 

unique_id

 


 

SMS1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

from

string

 

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

message_content

string

 

The content of the outbound message sent to all recipientAddresses.

recipient_address

array of (Recipient_addressItem)

 

recipient_address

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.  Values: [, ]

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

string

 

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

custom_parameter

string

 

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

 

Recipient_addressItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

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.

 


 

SMS1Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

status

integer(int32)

 

status

message

string

 

message

transactions

array of (TransactionsItem)

 

transactions

 

TransactionsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

transaction_id

string

 

transaction_id

parts_per_message

integer(int32)

 

parts_per_message

telephone_number

string

 

telephone_number

 


 

SMS2ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

conversation_id

string

 

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

message_content

string

 

The content of the outbound message sent to all recipientAddresses.

recipient_address

array of (Recipient_addressItem)

 

recipient_address

validity_period

integer(int32)

 

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

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.  Values: [, ]

email_responses

string

 

An email address to which message responses are forwarded.

push_responses

string

 

A CallBack URL to which message responses are posted.

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.  Values: [, ]

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

string

 

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

custom_parameter

string

 

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

 

Recipient_addressItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

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.

 


 

SMS2Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

status

integer(int32)

 

status

message

string

 

message

transactions

array of (TransactionsItem)

 

transactions

 

TransactionsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

transaction_id

string

 

transaction_id

parts_per_message

integer(int32)

 

parts_per_message

telephone_number

string

 

telephone_number

 


 

SMS3ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

from

string

 

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

message_content

string

 

The content of the outbound message sent to all recipientAddresses.

recipient_address

array of (Recipient_addressItem)

 

recipient_address

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.  Values: [, ]

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

string

 

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

custom_parameter

string

 

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

 

Recipient_addressItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

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.

 


 

SMS3Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

status

integer(int32)

 

status

message

string

 

message

transactions

array of (TransactionsItem)

 

transactions

 

TransactionsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

transaction_id

string

 

transaction_id

parts_per_message

integer(int32)

 

parts_per_message

telephone_number

string

 

telephone_number

 


 

VOICEParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

voice_intro

string

 

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

voice_thank_you

string

 

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

voice_redirect_message

string

 

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

voice_redirect_no

Voice_redirect_no

 

voice_redirect_no

voice_retries

integer(int32)

 

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

voice_delay

integer(int32)

 

Time waited by the system between retries.

message_content

string

 

The content of the outbound message sent to all recipientAddresses.

recipient_address

array of (Recipient_addressItem)

 

recipient_address

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.  Values: [, ]

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

string

 

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

custom_parameter

string

 

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

 

Voice_redirect_no

Summary:

Description: voice_redirect_no

 

          Properties:

Name

Type

Summary

number

string

 

Redirect number

 

Recipient_addressItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

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.

 


 

VOICEResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

status

integer(int32)

 

status

message

string

 

message

transactions

array of (TransactionsItem)

 

transactions

 

TransactionsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

transaction_id

string

 

transaction_id

parts_per_message

integer(int32)

 

parts_per_message

telephone_number

string

 

telephone_number