SmartDialog

SmartDialog enables organizations to send and receive SMS and WhatsApp messages through automated workflows. It supports message templates, delivery tracking, and conversational interactions. Requires a SmartDialog account with API access and configured channels. Delivery depends on carrier and WhatsApp policies. Some features require specific subscription tiers.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio 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)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   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)
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)
Contact
Name Arena Interactive Support
URL https://www.arenainteractive.fi/contact
Email support@arenainteractive.fi
Connector Metadata
Publisher Arena Interactive Oy
Website https://www.arenainteractive.fi
Privacy policy https://www.arenainteractive.fi/privacypolicy
Categories Communication;Collaboration

SmartDialog Connector

This connector can be used to send and recieve SMS messages using the SmartDialog platform.

Prerequisites

  1. A SmartDialog subscription and account. Please be in contact with sales@arenainteractive.fi
  2. OAuth needs to be enabled for your account and a client secret needs to be requested. This can be done by sending us an email at support@arenainteractive.fi.

Setup

  1. Please follow the instructions in Create a custom connector from an OpenAPI definition.
  2. Create a Flow or PowerApp and add a SmartDialog action from the custom section. Sign in with your SmartDialog account.

Supported Actions

  • New Message (Trigger for recieving messages)
  • Send Message
  • Send WhatsApp Message
  • Send Discussion Reply Message
  • Send Reply Message
  • WhatsApp Opt In
  • WhatsApp Opt Out
  • Create WhatsApp Template
  • Get Group Contact
  • Create Group Contact
  • Update Group Contact
  • Delete Group Contact
  • Delete All Group Contacts

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create group contact

Create group contact
Create WhatsApp template

Create a new WhatsApp template.
Delete All Group Contacts

Delete All Group Contacts
Delete Group Contact

Delete group contact using phone number.
Get Group Contact

Get Group Contact
Send Discussion Reply Message

Send a Discussion Reply Message to recipients.
Send Message

Send a Message to recipients.
Send Reply Message

Send a Replymessage to recipients.
Send WhatsApp Message

Send WhatsApp template message.
Update Group Contact

Update Group Contact
WhatsApp Opt In (deprecated) [DEPRECATED]

WhatsApp Opt In for sender and recipient. (deprecated)
WhatsApp Opt Out (deprecated) [DEPRECATED]

WhatsApp Opt Out for sender and recipient. (deprecated)

Create group contact

Operation ID:
CreateGroupContact

Create group contact

Parameters

Name Key Required Type Description
Customer
 Customer True string

The Customer to fetch Group Services for.
Group Service
 Group Service True string

The Group Service to use.
Active
 active boolean

Flag that indicates if the Contact is Active.
Phone
 phone True string

Phone number of the Contact.
Email
 email string

Email address of the Contact.
Firstname
 firstName string

Firstname of the Contact.
Lastname
 lastName string

Lastname of the Contact.
Gender
 gender string

Gender of the Contact.
Birth Year
 birthYear integer

Birth Year of the Contact.
Street Address
 streetAddress string

Street Address of the Contact.
Zip Code
 zipCode string

Zip Code of the Contact.
City
 city string

City of the Contact.
Country Code
 countryCode string

3-letter Country Code of the Contact.
Name
 name string

Custom property name.
Value
 value string

Custom property value.
Phonenumber Regions
 phoneNumberRegions array of string

Phonenumber regions to use for parsing numbers. Defaults to Finland if left empty.

Returns

Unique Id of the created Contact.

Contact Id
uuid

Create WhatsApp template

Operation ID:
CreateWhatsappTemplate

Create a new WhatsApp template.

Parameters

Name Key Required Type Description
Customer
 Customer-Id True string

The Customer to create the Template for.
IdentityNumber
 IdentityNumber True string

WhatsApp IdentityNumber used for the template.
Displayname
 DisplayName True string

Template Displayname.
Content
 RawContent True string

Template content.
Template Category
 Category True string

Template category.
Template Language
 Language True string

2-character code for template language.
Button Type
 Type string

Type of Button.
Button Label
 Label string

Button Label.
Button Data
 Data string

Button data. Url (Url), phone number (Call) or text (QuickReply). Max length is 2000 for Url, and 20 for phone number and text.
Attachment Url
 AttachmentUrl string

URL to an example attachment.

Delete All Group Contacts

Operation ID:
DeleteAllGroupContacts

Delete All Group Contacts

Parameters

Name Key Required Type Description
Customer
 Customer True string

The Customer to fetch Group Services for.
Group Service
 Group Service True string

The Group Service to use.

Returns

response
boolean

Delete Group Contact

Operation ID:
DeleteGroupContact

Delete group contact using phone number.

Parameters

Name Key Required Type Description
Customer
 Customer True string

The Customer to fetch Group Services for.
Group Service
 Group Service True string

The Group Service to use.
Phone
 Phone True string

The Phone number of the contact to Delete.

Returns

response
boolean

Get Group Contact

Operation ID:
GetGroupContact

Get Group Contact

Parameters

Name Key Required Type Description
Customer
 Customer True string

The Customer to fetch Group Services for.
Group Service
 Group Service True string

The Group Service to use.
Phone
 Phone True string

The Phone number of the Contact.
Region
 Region string

Optional Phonenumber region to use for parsing the Phone number.

Returns

Name Path Type Description
Phone
 phone string

Phone number of the Contact.
Email
 email string

Email address of the Contact.
Firstname
 firstName string

Firstname of the Contact.
Lastname
 lastName string

Lastname of the Contact.
Gender
 gender string

Gender of the Contact.
Birth Year
 birthYear integer

Birth Year of the Contact.
Street Address
 streetAddress string

Street Address of the Contact.
Zip Code
 zipCode string

Zip Code of the Contact.
City
 city string

City of the Contact.
Country Code
 countryCode string

Country Code of the Contact.
Failed Messages
 failedMessages integer

Number of failed messages for the Contact.
Custom Properties
 customContactProperties array of object

Custom Contact Property collection saved for the Contact.
Name
 customContactProperties.name string

Custom contact property name.
Value
 customContactProperties.value string

Custom contact property value.

Send Discussion Reply Message

Operation ID:
SendDiscussionReplyMessage

Send a Discussion Reply Message to recipients.

Parameters

Name Key Required Type Description
Customer
 CustomerId True string

The Customer to use for sending.
Thread Id
 ThreadId True string

Id of the existing Thread to reply to.
Message Content
 Content True string

The content of the message.
Customer Data
 CustomerData string

Billing/grouping data for this message, optional.

Returns

Name Path Type Description
Message Id
 MessageId string

Newly created message's identifier.
Message Part Count
 MessagePartCount integer

Approximated number of message parts for this message.
Recipients
 Recipients array of object

Recipients
Recipient Address
 Recipients.Address string

Recipient address (phone number/email/user id etc.).
Recipient Id
 Recipients.Id string

Recipient identifier used for receiving delivery status information.
ThreadId
 ThreadId string

Identifier of Thread that the message was sent to.

Send Message

Operation ID:
SendMessage

Send a Message to recipients.

Parameters

Name Key Required Type Description
Customer
 Customer-Id True string

The Customer to use for sending.
Service
 Service-Id True string

The Service to use for sending.
Message Sender
 Sender True string

The sender of the message, can be alphanumeric, long code or short code (restrictions apply).
Message Content
 Content True string

The content of the message.
Message Protocol
 Protocol True string

The protocol to use for sending the message.
Send Datetime
 SendDateTime date-time

The date and time to send the message. Leave empty to send instantly.
Address
 Address True string

Message recipient address.
Attachment Uri
 AttachmentUri string

Attachment Uri to be used when sending WhatsApp message that contains an attachment.
Customer Data
 CustomerData string

Billing/grouping data for this message, optional.
Ad Message
 AdMessage boolean

Optional overriding flag for marking the message as an ad message
Dlr Url
 DlrUrl string

Url for Delivery status callback via http-get. You may add querystring values to url, they will be preserved.
Request Id
 RequestId string

Optional unique request id that can be used to identify duplicate requests. If a duplicate request id is detected, sending is cancelled. There is no guarantee that requests with duplicate request ids will be blocked in high throughput/traffic situations. The given requestId will be "remembered" for 7 days.
Unicode Character Handling Policy
 UnicodeCharacterHandlingPolicy string

Policy to handle Unicode characters (SMS protocol only). Default is None (do not validate or replace), Strict will result in a validation failure if there are Unicode characters present in the message content, and Replace will replace Unicode characters with look-alike characters and question marks (?)

Returns

Name Path Type Description
Message Id
 MessageId string

Newly created message's identifier.
Message Part Count
 MessagePartCount integer

Approximated number of message parts for this message.
Recipients
 Recipients array of object

Recipients
Recipient Address
 Recipients.Address string

Recipient address (phone number/email/user id etc.).
Recipient Id
 Recipients.Id string

Recipient identifier used for receiving delivery status information.

Send Reply Message

Operation ID:
SendReplyMessage

Send a Replymessage to recipients.

Parameters

Name Key Required Type Description
ParentMessage Id
 ParentMessageId True string

The Parent message Id to reply to.
Customer
 Customer-Id True string

The Customer to use for sending.
Service
 Service-Id True string

The Service to use for sending.
Message Sender
 Sender True string

The sender of the message, can be alphanumeric, long code or short code (restrictions apply).
Message Content
 Content True string

The content of the message.
Message Protocol
 Protocol True string

The protocol to use for sending the message.
Send Datetime
 SendDateTime date-time

The date and time to send the message. Leave empty to send instantly.
Address
 Address True string

Message recipient address.
Attachment Uri
 AttachmentUri string

Attachment Uri to be used when sending WhatsApp message that contains an attachment.
Customer Data
 CustomerData string

Billing/grouping data for this message, optional.
Ad Message
 AdMessage boolean

Optional overriding flag for marking the message as an ad message
Dlr Url
 DlrUrl string

Url for Delivery status callback via http-get. You may add querystring values to url, they will be preserved.
Request Id
 RequestId string

Optional unique request id that can be used to identify duplicate requests. If a duplicate request id is detected, sending is cancelled. There is no guarantee that requests with duplicate request ids will be blocked in high throughput/traffic situations. The given requestId will be "remembered" for 7 days.
Unicode Character Handling Policy
 UnicodeCharacterHandlingPolicy string

Policy to handle Unicode characters (SMS protocol only). Default is None (do not validate or replace), Strict will result in a validation failure if there are Unicode characters present in the message content, and Replace will replace Unicode characters with look-alike characters and question marks (?)

Returns

Name Path Type Description
Message Id
 MessageId string

Newly created message's identifier.
Message Part Count
 MessagePartCount integer

Approximated number of message parts for this message.
Recipients
 Recipients array of object

Recipients
Recipient Address
 Recipients.Address string

Recipient address (phone number/email/user id etc.).
Recipient Id
 Recipients.Id string

Recipient identifier used for receiving delivery status information.

Send WhatsApp Message

Operation ID:
SendWhatsappTemplateMessage

Send WhatsApp template message.

Parameters

Name Key Required Type Description
Customer
 Customer-Id True string

The Customer to use for sending.
Service
 Service-Id True string

The Service to use for sending.
WhatsApp Template
 TemplateName True string

The Template to use for sending.
Address
 Address True string

Message recipient address.
BodyParameters
 BodyParameters array of string

BodyParameters
HeaderParameters
 HeaderParameters array of string

HeaderParameters
Type
 Type string

The button type. Only one type per template, may contain multiple of the same type.
Text
 Data string

The text of the button.
Send Datetime
 SendDateTime string

The date and time to send the message. Leave empty to send instantly.
Attachment Uri
 AttachmentUri string

The Attachment Uri if the template contains an attachment.
Use SMS Fallback
 UseSmsFallback boolean

Should SMS be used as fallback.
Dlr Url
 DlrUrl string

Delivery report Url that will recieve a callback when the sendprocess completes.
Customer Data
 CustomerData string

Billing/grouping data for this message, optional.
Request Id
 RequestId string

Optional unique request id that can be used to identify duplicate requests. If a duplicate request id is detected, sending is cancelled. There is no guarantee that requests with duplicate request ids will be blocked in high throughput/traffic situations. The given requestId will be "remembered" for 7 days.

Returns

Name Path Type Description
Message Id
 messageId string

Newly created message's identifier.
Message Part Count
 messagePartCount integer

Approximated number of message parts for this message.
recipients
 recipients array of object

recipients
Recipient Address
 recipients.address string

Recipient address (phone number/email/user id etc.).
Recipient Id
 recipients.id string

Recipient identifier used for receiving delivery status information.

Update Group Contact

Operation ID:
UpdateGroupContact

Update Group Contact

Parameters

Name Key Required Type Description
Customer
 Customer True string

The Customer to fetch Group Services for.
Group Service
 Group Service True string

The Group Service to use.
Phone
 Phone True string

The Phone number of the contact to update.
Active
 active boolean

Flag that indicates if the Contact is Active.
Email
 email string

Email address of the Contact.
Firstname
 firstName string

Firstname of the Contact.
Lastname
 lastName string

Lastname of the Contact.
Gender
 gender string

Gender of the Contact.
Birth Year
 birthYear integer

Birth Year of the Contact.
Street Address
 streetAddress string

Street Address of the Contact.
Zip Code
 zipCode string

Zip Code of the Contact.
City
 city string

City of the Contact.
Country Code
 countryCode string

3-letter Country Code of the Contact.
Name
 name string

Custom contact property name.
Value
 value string

Custom contact property value.
Phonenumber Regions
 phoneNumberRegions array of string

Phonenumber regions to use for parsing numbers. Defaults to Finland if left empty.

Returns

response
boolean

WhatsApp Opt In (deprecated) [DEPRECATED]

Operation ID:
WhatsAppOptIn

WhatsApp Opt In for sender and recipient. (deprecated)

Parameters

Name Key Required Type Description
Sender address
 Sender True string

Registered Whatsapp identity number to opt-in to.
Recipient address
 Recipient True string

Recipient number to opt-in.

WhatsApp Opt Out (deprecated) [DEPRECATED]

Operation ID:
WhatsAppOptOut

WhatsApp Opt Out for sender and recipient. (deprecated)

Parameters

Name Key Required Type Description
Sender address
 Sender True string

Registered Whatsapp identity number to opt-out from.
Recipient address
 Recipient True string

Recipent number to remove from opt-in.

Triggers

New Message

When a new message arrives to a 2-Way service.

New Message

Operation ID:
NewMessage

When a new message arrives to a 2-Way service.

Parameters

Name Key Required Type Description
Customer
 Customer True string

The Customer to use.
Service
 Service True string

The 2-Way service to use.

Returns

Name Path Type Description
Message Sender
 sender string

The message sender.
Message Recipient
 recipient string

The recipient of the message.
Message Content
 content string

The content of the received message.
Message Timestamp
 timestamp date-time

The timestamp of the message.
Message Protocol
 protocol string

The protocol of the received message.
attachments
 attachments array of object

attachments
Attachment Filename
 attachments.name string

The filename of the attachment.
Attachment Mime Type
 attachments.mimeType string

The mime type of the attachment.
Attachment Resource Location
 attachments.resourceLocation string

The attachment resource location.
Message Id
 messageId string

The unique message Id of the received message.

Definitions

uuid

Unique Id of the created Contact.

Unique Id of the created Contact.

Contact Id
uuid

boolean

This is the basic data type 'boolean'.