Dela via


MessageBird SMS (Independent Publisher) (Preview)

messagebird's SMS service allows you to send and receive SMS messages to and from any country in the world.

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
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connector Metadata
Publisher Troy Taylor
Website https://messagebird.com/
Privacy policy https://messagebird.com/legal/terms
Categories Communication

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Access Key (in the form "AccessKey yourAccessKey") securestring The Access Key (in the form "AccessKey yourAccessKey") for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

List messages

Retrieve a list of all inbound and outbound SMS messages.

Send a batch SMS

Sends a batch of SMS messages.

Send SMS

Create and send a SMS message.

View a message

Retrieve the information of an existing inbound or outbound SMS message.

List messages

Retrieve a list of all inbound and outbound SMS messages.

Parameters

Name Key Required Type Description
Originator
originator string

The originator.

Recipient
recipient string

The recipient.

Direction
direction string

The direction.

Limit
limit string

The limit.

Offset
offset integer

The offset.

Search terms
searchterm string

The search terms.

Type
type string

The type.

Contact ID
contact_id integer

The contact identifier.

Status
status string

The status.

From
from string

The from.

Until
until string

The until.

Returns

Name Path Type Description
Offset
offset integer

The offset.

Limit
limit integer

The limit.

Count
count integer

The count.

Total Count
totalCount integer

The total count.

First
links.first string

The first.

Previous
links.previous string

The previous.

Next
links.next string

The next.

Last
links.last string

The last.

Items
items array of object
ID
items.id string

The identifier.

HREF
items.href string

The HREF.

Direction
items.direction string

The direction.

Type
items.type string

The type.

Originator
items.originator string

The originator.

Body
items.body string

The body.

Reference
items.reference string

The reference.

Validity
items.validity string

The validity.

Gateway
items.gateway integer

The gateway.

Data Coding
items.datacoding string

The data coding.

Message Class
items.mclass integer

The message class.

Scheduled Datetime
items.scheduledDatetime string

The scheduled datetime.

Created Datetime
items.createdDatetime string

When created datetime.

Total Count
items.recipients.totalCount integer

The total count.

Total Sent Count
items.recipients.totalSentCount integer

The total sent count.

Total Delivered Count
items.recipients.totalDeliveredCount integer

The total delivered count.

Total Delivery Failed Count
items.recipients.totalDeliveryFailedCount integer

The total delivery failed count.

Items
items.recipients.items array of object
Recipient
items.recipients.items.recipient integer

The recipient.

Originator
items.recipients.items.originator string

The originator.

Status
items.recipients.items.status string

The status.

Status Reason
items.recipients.items.statusReason string

The status reason.

Status Error Code
items.recipients.items.statusErrorCode string

The status error code.

Status Datetime
items.recipients.items.statusDatetime string

The status datetime.

Recipient Country
items.recipients.items.recipientCountry string

The recipient country.

Recipient Country Prefix
items.recipients.items.recipientCountryPrefix integer

The recipient country prefix.

Recipient Operator
items.recipients.items.recipientOperator string

The recipient operator.

MCCMNC
items.recipients.items.mccmnc string

The code of the operator of the message sender.

MCC
items.recipients.items.mcc string

The MCC.

MNC
items.recipients.items.mnc string

The MNC.

Message Length
items.recipients.items.messageLength integer

The message length.

Message Part Count
items.recipients.items.messagePartCount integer

The message part count.

Amount
items.recipients.items.price.amount float

The amount.

Currency
items.recipients.items.price.currency string

The currency.

Send a batch SMS

Sends a batch of SMS messages.

Parameters

Name Key Required Type Description
Recipients
recipients array of string

The recipients.

Originator
originator string

The originator.

Body
body string

The body.

Returns

Name Path Type Description
array of object
ID
id string

The identifier.

HREF
href string

The HREF.

Direction
direction string

The direction.

Type
type string

The type.

Originator
originator string

The originator.

Body
body string

The body.

Reference
reference string

The reference.

Validity
validity string

The validity.

Gateway
gateway integer

The gateway.

Data Coding
datacoding string

The data coding.

Message Class
mclass integer

The message class.

Scheduled Datetime
scheduledDatetime string

The schedule datetime.

Created Datetime
createdDatetime string

When created datetime.

Total Count
recipients.totalCount integer

The total count.

Total Sent Count
recipients.totalSentCount integer

The total sent count.

Total Delivered Count
recipients.totalDeliveredCount integer

The total delivered count.

Total Delivery Failed Count
recipients.totalDeliveryFailedCount integer

The total delivery failed count.

Items
recipients.items array of object
Recipient
recipients.items.recipient integer

The recipient.

Status
recipients.items.status string

The status.

Status Datetime
recipients.items.statusDatetime string

The status datetime.

Send SMS

Create and send a SMS message.

Parameters

Name Key Required Type Description
Recipients
recipients True array of string

The recipients.

Originator
originator True string

The originator.

Shortcode
shortcode integer

The shortcode.

Body
body True string

The message body.

Group IDs
groupIds array of string

The group identifiers.

Type
type string

The type.

Reference
reference string

The reference.

Report URL
reportUrl string

The report URL address.

Validity
validity integer

The validity.

Gateway
gateway integer

The gateway.

Data Coding
datacoding string

The data coding.

Message Class
mclass integer

The message class.

Shorten URLs
shortenUrls boolean

Whether the URLs are shortened.

Scheduled Datetime
scheduledDatetime string

The scheduled datetime.

Created Datetime
createdDatetime string

When created datetime.

Returns

Name Path Type Description
ID
id string

The identifier.

HREF
href string

The HREF.

Direction
direction string

The direction.

Type
type string

The type.

Originator
originator string

The originator.

Body
body string

The message body.

Reference
reference string

The reference.

Validity
validity string

The validity.

Gateway
gateway integer

The gateway.

Data Coding
datacoding string

The data coding.

Message Class
mclass integer

The message class.

Scheduled Datetime
scheduledDatetime string

The scheduled datetime.

Created Datetime
createdDatetime string

When created datetime.

Total Count
recipients.totalCount integer

The total count.

Total Sent Count
recipients.totalSentCount integer

The total sent count.

Total Delivered Count
recipients.totalDeliveredCount integer

The total delivered count.

Total Delivery Failed Count
recipients.totalDeliveryFailedCount integer

The total delivery failed count.

Items
recipients.items array of object
Recipient
recipients.items.recipient integer

The recipient.

Status
recipients.items.status string

The status.

Status Datetime
recipients.items.statusDatetime string

The status datetime.

View a message

Retrieve the information of an existing inbound or outbound SMS message.

Parameters

Name Key Required Type Description
Message ID
messageId True string

The message identifier.

Returns

Name Path Type Description
ID
id string

The identifier.

HREF
href string

The HREF.

Direction
direction string

The direction.

Type
type string

The type.

Originator
originator string

The originator.

Body
body string

The message body.

Reference
reference string

The reference.

Validity
validity string

The validity.

Gateway
gateway integer

The gateway.

Data Coding
datacoding string

The data coding.

Message Class
mclass integer

The message class.

Scheduled Datetime
scheduledDatetime string

The scheduled datetime.

Created Datetime
createdDatetime string

When created datetime.

Total Count
recipients.totalCount integer

The total count.

Total Sent Count
recipients.totalSentCount integer

The total sent count.

Total Delivered Count
recipients.totalDeliveredCount integer

The total delivered count.

Total Delivery Failed Count
recipients.totalDeliveryFailedCount integer

The total delivery failed count.

Items
recipients.items array of object
Recipient
recipients.items.recipient integer

The recipient.

Status
recipients.items.status string

The status.

Status Reason
recipients.items.statusReason string

The status reason.

Status Error Code
recipients.items.statusErrorCode string

The status error code.

Status Datetime
recipients.items.statusDatetime string

The status datetime.

Recipient Country
recipients.items.recipientCountry string

The recipient country.

Recipient Country Prefix
recipients.items.recipientCountryPrefix integer

The recipient country prefix.

Recipient Operator
recipients.items.recipientOperator string

The recipient operator.

MCCMNC
recipients.items.mccmnc string

The MCCMNC.

MCC
recipients.items.mcc string

The MCC.

MNC
recipients.items.mnc string

The MNC.

Message Length
recipients.items.messageLength integer

The message length.

Message Part Count
recipients.items.messagePartCount integer

The message part count.

Amount
recipients.items.price.amount float

The amount.

Currency
recipients.items.price.currency string

The currency.