TrueDialog SMS
TrueDialog SMS connector gives an ability to send mass and individual text messages via long code and short code.
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 | TrueDialog Support |
| URL | https://www.truedialog.com/help/ |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | TrueDialog Dynamics |
| Website | https://www.truedialog.com/ |
| Privacy policy | https://www.truedialog.com/privacy-policy/ |
| Categories | Communication |
TrueDialog's SMS API is enterprise-grade with more pre-built features than any other SMS software. Built for developers, our SMS API is highly reliable, secure and includes a pre-built ISO 9001 database for extra opt-out and compliance protection. Also available through our full-featured Enterprise-Grade SMS Texting Software.
Prerequisites
You will need these credentials to proceed:
- A Microsoft Power Apps or Power Automate plan
- A TrueDialog Account and Plan and your TrueDialog API key and Secret Code for your account. Click HERE to register.
How to get credentials
Click HERE to register. When you register for TrueDialog, the API key and Secret Code will be in your credentials email. For help getting started, please contact our team. Our world-class Client Services team will walk you through registration and choosing the best account for your company’s needs.
CONTACT US:
| [email protected] | |
|---|---|
| Live Chat | https://www.truedialog.com/ |
| Phone | 512-501-5940 |
Get started with TrueDialog connector
Once you have your credentials you can start using the connector.
Actions
Send SMS
The most valuable action is "Send SMS". It allows sending SMS to single or multiple recipients. This action has several required fields:
- Account ID – could be used from the Get Current User Info response or could be hardcoded.
- Channel – leave default value 22 for using the default associated phone number.
- Targets – valid US phone number without formatting (ex.: +15125453809)
- Message – the message itself.
- Execute – leave default value True if you don’t want to postpone sending.
Triggers
The list of the callbacks registered for an account can be found here: https://ui.truedialog.com/Callbacks
Incoming Message Received
The most important trigger. This operation triggers a flow whenever the end-user texts into the associated phone number.
Account ID is required to register the trigger. You can get an Account Id via TD Portal, it's located next to the account name in the top right corner.
Incoming message contains message text and other necessary fields.
Stop Message Received
This operation triggers a flow whenever end user texts in STOP or synonym. It also automatically opts-out contact in TrueDialog system. To send a message to the opted-out contact, set the flag forceOptIn to True when sending SMS. Please use this ForceOptIt feature with caution and make sure that you keep track of the opted-out records.
Provide users with a step-by-step process for getting started with your connector. This is where you should highlight common use cases, such as your expected popular triggers and actions, and how they can help in automation scenarios. Include images where possible.
Delivery Notice Received
This operation triggers a flow for each delivery notice receipt. Please note that not all mobile carriers send a notice receipt.
Invalid Targets
When one of the target phones is invalid, or blacklisted, it’s still possible to send SMS and don’t get an error. For doing this you should set property “IgnoreInvalidTargets” to true when send a message. If invalid phone numbers were presented in sent SMS recipients list, this operation triggers a Flows.
Known issues and limitations
TrueDialog API has more capabilities, compared to the custom connector
FAQ
To get the most recent description of the undrlying API please visit HERE
Provide a breakdown of frequently asked questions and their respective answers here. This can cover FAQs about interacting with the underlying service or about the connector itself.
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 |
|---|---|---|---|
| username | securestring | The username for this api | True |
| password | securestring | The password for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Contact Create |
Create a contact record in TrueDialog |
| Contact Search |
Searches for a contact via a phone number or email address. |
| Contact Update |
Update contact |
| Get Account Info |
Get information about account |
| Get Current User Info |
Get information about User, whose credentials were used in Connection |
| Send SMS |
Send SMS to a single or multiple recipients |
Contact Create
Create a contact record in TrueDialog
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account ID
|
accountId | True | string |
Account ID that would be used as parent account for created contact |
|
PhoneNumber
|
PhoneNumber | string |
Mobile number if available. Either this or the Email field are REQUIRED |
|
|
Email
|
string |
Email address of the contact. Either this or the PhoneNumber field are REQUIRED. |
||
|
FirstName
|
FirstName | string |
First name of the contact. |
|
|
LastName
|
LastName | string |
Last name of the contact. |
Returns
- Body
- ContactResponse
Contact Search
Searches for a contact via a phone number or email address.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account ID for subscription
|
accountId | True | string |
The account to which the contact is visible to. |
|
Phone number to search
|
phone | True | string |
Find existing contacts with the passed phone number or email. |
Returns
- Items
- ContactSearchRequest
Contact Update
Update contact
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account ID
|
accountId | True | string |
Account ID that would be used as parent account for updated contact |
|
Contact ID
|
contactid | True | string |
ID of the Contact that would be updated |
|
PhoneNumber
|
PhoneNumber | string |
Mobile number if available. Either this or the Email field are REQUIRED |
|
|
Email
|
string |
Email address of the contact. Either this or the PhoneNumber field are REQUIRED. |
||
|
FirstName
|
FirstName | string |
First name of the contact. |
|
|
LastName
|
LastName | string |
Last name of the contact. |
Returns
- Body
- ContactResponse
Get Account Info
Get information about account
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID of the account, that should be retrieved
|
accountId | True | string |
Account Id |
Returns
- Body
- AccountResponse
Get Current User Info
Send SMS
Send SMS to a single or multiple recipients
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account ID
|
accountId | True | string |
Account ID that would be used for sending SMS |
|
Channels
|
Channels | True | array of string |
Channels |
|
Targets
|
Targets | True | array of string |
Targets |
|
ContactListIds
|
ContactListIds | array of string |
Contact List Ids |
|
|
ExcludeListIds
|
ExcludeListIds | array of string |
Exclude List Ids |
|
|
Media ID
|
MediaId | integer |
Media Id |
|
|
Message
|
Message | True | string |
Message |
|
Ignore Single Use
|
IgnoreSingleUse | boolean |
Ignore Single Use |
|
|
ForceOptIn
|
ForceOptIn | boolean |
Force Opt-In |
|
|
Schedules
|
Schedules | array of string |
The list of schedules associated with the action |
|
|
Execute
|
Execute | True | boolean |
Set true if the action should be executed on creation |
|
IgnoreInvalidTargets
|
IgnoreInvalidTargets | boolean |
Indicates if invalid numbers should be ignored |
Returns
- Body
- PushCampaignResponse
Triggers
| Delivery Notice Received |
This operation triggers a flow for each delivery notice receipt |
| Incoming Message Received |
This operation triggers a flow whenever end user texts in |
| Invalid Targets |
This operation triggers a flow if targets have been filtered out during sending SMS |
| Keyword Received |
This operation triggers a flow whenever end user texts in a keyword |
| Stop Message Received |
This operation triggers a flow whenever end user texts in STOP or synonym |
Delivery Notice Received
This operation triggers a flow for each delivery notice receipt
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account ID for subscription
|
accountId | True | string |
Use Root Account ID in most cases to subscribe for notifications. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Callback Timestamp
|
CallbackTimestamp | string |
Date and time the callback has been sent. Format: yyyy-MM-ddTHH:mm:ss |
|
CallbackToken
|
CallbackToken | string |
Callback Token |
|
TransactionId
|
TransactionId | string |
Transaction Id |
|
AccountId
|
AccountId | integer |
Account Id |
|
Account Name
|
AccountName | string |
The name of the account the callback is associated to |
|
Status Id
|
StatusId | integer |
2 = Delivered; 3 = Undelivered; 7 = Unknown |
|
Status
|
Status | string |
Delivery code - OK for delivered message or error code. For undelivered - null |
|
ChannelId
|
ChannelId | integer |
Channel Id |
|
Channel Code
|
ChannelCode | string |
Code of the channel the message has been sent over (the actual phone number for long codes) |
|
MessageId
|
MessageId | string |
MessageId |
|
PhoneNumber
|
PhoneNumber | string |
Phone Number |
|
ContactId
|
ContactId | integer |
Contact Id |
|
ActionId
|
ActionId | integer |
Action Id |
|
Message
|
Message | string |
The actual message text |
Incoming Message Received
This operation triggers a flow whenever end user texts in
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account ID for subscription
|
AccountId | True | string |
Use Root Account ID in most cases to subscribe for notifications. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Account Name
|
AccountName | string |
The name of the account the callback is associated to |
|
Channel Code
|
ChannelCode | string |
Code of the channel the message has been sent over (the actual phone number for long codes) |
|
ChannelId
|
ChannelId | integer |
ID of the channel the message has been sent over |
|
ContactId
|
ContactId | integer |
Contact ID if any (null for unknown contacts) |
|
Message
|
Message | string |
The actual message text |
|
PhoneNumber
|
PhoneNumber | string |
Target phone number |
|
AccountId
|
AccountId | integer |
The ID of the account the callback is associated to |
|
Callback Timestamp
|
CallbackTimestamp | string |
Date and time the callback has been sent. Format: yyyy-MM-ddTHH:mm:ss |
|
CallbackToken
|
CallbackToken | string |
Callback Token |
|
TransactionId
|
TransactionId | string |
Unique token |
Invalid Targets
This operation triggers a flow if targets have been filtered out during sending SMS
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account ID for subscription
|
accountId | True | string |
Use Root Account ID in most cases to subscribe for notifications. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Callback Timestamp
|
CallbackTimestamp | string |
Date and time the callback has been sent. Format: yyyy-MM-ddTHH:mm:ss |
|
CallbackURL
|
CallbackURL | string |
Callback URL |
|
TransactionId
|
TransactionId | string |
Transaction Id |
|
AccountId
|
AccountId | integer |
Account Id |
|
ActionId
|
ActionId | integer |
Action Id |
|
RunId
|
RunId | integer |
Run Id |
|
InvalidTargets
|
InvalidTargets | array of object |
Invalid Targets |
|
Target
|
InvalidTargets.Target | string |
The target that has been filtered out |
|
ReasonId
|
InvalidTargets.ReasonId | integer |
ID of the reason. 0 - Invalid, 1 - Opted Out, 2 - Duplicate, 3 - Blocked, 4 - Undeliverable, 5 - Single Use |
|
Reason
|
InvalidTargets.Reason | string |
Short description of a reason |
Keyword Received
This operation triggers a flow whenever end user texts in a keyword
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account ID for subscription
|
accountId | True | string |
Use Root Account ID in most cases to subscribe for notifications. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Callback Timestamp
|
CallbackTimestamp | string |
Date and time the callback has been sent Format: yyyy-MM-ddTHH:mm:ss |
|
CallbackToken
|
CallbackToken | string |
Callback Token |
|
TransactionId
|
TransactionId | string |
Transaction Id |
|
AccountId
|
AccountId | integer |
The ID of the account the callback is associated to |
|
Account Name
|
AccountName | string |
The name of the account the callback is associated to |
|
CampaignId
|
CampaignId | integer |
Campaign Id |
|
ChannelId
|
ChannelId | integer |
Channel Id |
|
Channel Code
|
ChannelCode | string |
Code of the channel the message has been sent over (the actual phone number for long codes) |
|
ContactId
|
ContactId | integer |
ID of the contact that submitted the keyword |
|
Keyword
|
Keyword | string |
The actual keyword that has been submitted |
|
KeywordId
|
KeywordId | integer |
ID of the keyword that has been submitted |
|
Message
|
Message | string |
The actual message text |
|
PhoneNumber
|
PhoneNumber | string |
The phone number of the end user that submitted the keyword |
Stop Message Received
This operation triggers a flow whenever end user texts in STOP or synonym
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account ID for subscription
|
accountId | True | string |
Use Root Account ID in most cases to subscribe for notifications. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Callback Timestamp
|
CallbackTimestamp | string |
Date and time the callback has been sent. Format: yyyy-MM-ddTHH:mm:ss |
|
CallbackToken
|
CallbackToken | string |
Callback Token |
|
TransactionId
|
TransactionId | string |
Transaction Id |
|
AccountId
|
AccountId | integer |
Account Id |
|
Account Name
|
AccountName | string |
The name of the account the callback is associated to |
|
ChannelId
|
ChannelId | integer |
Channel Id |
|
Channel Code
|
ChannelCode | string |
Code of the channel the message has been sent over (the actual phone number for long codes) |
|
ContactId
|
ContactId | integer |
Contact Id |
|
ContactAccountId
|
ContactAccountId | integer |
The ID of the account that owns the contact record |
|
ContactAccountName
|
ContactAccountName | string |
The name of the account that owns the contact record |
|
PhoneNumber
|
PhoneNumber | string |
The phone number of the end user that has been opted out |
Definitions
AccountResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
The ID of the account. |
|
status
|
status | integer |
The current status of the account. |
|
parentId
|
parentId | integer |
The identifier of the account that is the parent of this account. |
|
name
|
name | string |
The name of the account |
|
created
|
created | string |
When the account was created. |
|
allowCallback
|
allowCallback | boolean |
Set if this account is allowed to use the callback mechanism. |
|
callbackToken
|
callbackToken | string |
Callback Token |
|
type
|
type | integer |
Account Type (master or subaccount) |
|
accountType
|
accountType | integer |
Account type name |
|
isApproved
|
isApproved | boolean |
Account is Approved or not |
ContactResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
accountId
|
accountId | integer |
Account Id |
|
phoneNumber
|
phoneNumber | string |
Phone Number |
|
email
|
string |
|
|
|
preferredLanguageId
|
preferredLanguageId | string |
preferred Language Id |
|
preferredLanguage
|
preferredLanguage | string |
preferred Language |
|
assignedId
|
assignedId | string |
assigned Id |
|
firstName
|
firstName | string |
First Name |
|
lastName
|
lastName | string |
Last Name |
|
phoneStatusId
|
phoneStatusId | integer |
phone Status Id |
|
phoneStatus
|
phoneStatus | integer |
phone Status |
|
phoneHardErrorCount
|
phoneHardErrorCount | integer |
phone Hard Error Count |
|
phoneSoftErrorCount
|
phoneSoftErrorCount | integer |
phone Soft Error Count |
|
phoneTotalHardErrorCount
|
phoneTotalHardErrorCount | integer |
phone Total Hard Error Count |
|
phoneTotalSoftErrorCount
|
phoneTotalSoftErrorCount | integer |
phone Total Soft Error Count |
|
phoneLastHardError
|
phoneLastHardError | string |
phone Last Hard Error |
|
phoneLastSoftError
|
phoneLastSoftError | string |
phone Last Soft Error |
|
phoneHardErrorSince
|
phoneHardErrorSince | string |
phone Hard Error Since |
|
phoneSoftErrorSince
|
phoneSoftErrorSince | string |
phone Soft Error Since |
|
statusId
|
statusId | integer |
status Id |
|
created
|
created | string |
created |
|
modified
|
modified | string |
modified |
|
createdBy
|
createdBy | string |
created By |
|
modifiedBy
|
modifiedBy | string |
modified By |
|
id
|
id | integer |
id |
ContactSearchRequest
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
id |
|
accountId
|
accountId | integer |
Account Id |
|
statusId
|
statusId | integer |
status Id |
|
phoneNumber
|
phoneNumber | string |
Phone Number |
|
email
|
string |
|
|
|
assignedId
|
assignedId | string |
assigned Id |
|
firstName
|
firstName | string |
First Name |
|
lastName
|
lastName | string |
Last Name |
|
subscriptions
|
subscriptions | array of |
subscriptions |
|
attributes
|
attributes | array of |
attributes |
|
phoneStatusId
|
phoneStatusId | integer |
phone Status Id |
|
created
|
created | string |
created |
|
createdBy
|
createdBy | string |
created By |
|
modified
|
modified | string |
modified |
|
modifiedBy
|
modifiedBy | string |
modified By |
PushCampaignResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
channels
|
channels | array of |
channels |
|
targets
|
targets | array of string |
targets |
|
targetsUrl
|
targetsUrl | string |
targets Url |
|
targetsColumn
|
targetsColumn | string |
targets Column |
|
contactListIds
|
contactListIds | array of |
contact List Ids |
|
excludeListIds
|
excludeListIds | array of |
exclude List Ids |
|
campaignId
|
campaignId | integer |
campaign Id |
|
mediaId
|
mediaId | string |
media Id |
|
message
|
message | string |
message |
|
from
|
from | string |
from |
|
subject
|
subject | string |
subject |
|
ignoreSingleUse
|
ignoreSingleUse | boolean |
ignore Single Use |
|
forceOptIn
|
forceOptIn | boolean |
force Opt-In |
|
statusId
|
statusId | integer |
status Id |
|
roundRobinById
|
roundRobinById | boolean |
round Robin By Id |
|
globalRoundRobin
|
globalRoundRobin | boolean |
global Round Robin |
|
status
|
status | string |
status |
|
id
|
id | integer |
id |
|
accountId
|
accountId | integer |
Account Id |
|
created
|
created | string |
created |
|
modified
|
modified | string |
modified |
|
createdBy
|
createdBy | string |
created By |
|
modifiedBy
|
modifiedBy | string |
modified By |
|
schedules
|
schedules | array of |
schedules |
UserResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
userName
|
userName | string |
userName |
|
accountId
|
accountId | integer |
Account Id |
|
email
|
string |
|
|
|
firstName
|
firstName | string |
First Name |
|
lastName
|
lastName | string |
Last Name |
|
phoneNumber
|
phoneNumber | string |
Phone Number |
|
isAdmin
|
isAdmin | boolean |
is Admin |
|
key
|
apiKey.key | string |
key |
|
secret
|
apiKey.secret | string |
secret |
|
lastActivity
|
apiKey.lastActivity | string |
last Activity |
|
typeId
|
apiKey.typeId | integer |
type Id |
|
type
|
apiKey.type | integer |
type |
|
label
|
apiKey.label | string |
label |
|
userName
|
apiKey.userName | string |
userName |
|
validTo
|
apiKey.validTo | string |
valid To |
|
accountId
|
apiKey.accountId | integer |
Account Id |
|
id
|
apiKey.id | integer |
id |
|
isChatUser
|
isChatUser | boolean |
is Chat User |
|
reportOnly
|
reportOnly | boolean |
report Only |
|
requestNumber
|
requestNumber | boolean |
request Number |
|
canCreateContact
|
canCreateContact | boolean |
can Create Contact |
|
isAlertAgent
|
isAlertAgent | boolean |
is Alert Agent |
|
agreed
|
agreed | boolean |
agreed |
|
comment
|
comment | string |
comment |
|
isApproved
|
isApproved | boolean |
is Approved |
|
isLockedOut
|
isLockedOut | boolean |
is Locked Out |
|
lastLockoutDate
|
lastLockoutDate | string |
last Lockout Date |
|
creationDate
|
creationDate | string |
creation Date |
|
lastLoginDate
|
lastLoginDate | string |
last Login Date |
|
lastActivityDate
|
lastActivityDate | string |
last Activity Date |
|
lastPasswordChangedDate
|
lastPasswordChangedDate | string |
last Password Changed Date |