-
What is the difference between list_name and display_name for Distribution List?
List_name is used for the API and when you use the “send from phone” feature. The display_name is displayed to the public when used with online sign-up pages.
-
How do I edit or update a distribution list, subscription, and/or keyword?
POST method can be used to edit and update distribution lists, subscriptions, and keywords. This function requires only the parameters that need to be updated. For example, if you are updating a subscription for inclusion on a new list, you will need to include only the “list_name” parameter with the desired lists.
-
How do I change the organization name at the beginning of my text message?
Additional organization names can be verified through the platform or API. Access to organization names can be gained through the platform under Account -> Edit Org. Profile. The REST API Organization function will allow you to create, edit, and delete organization names.
-
How do I send a picture or video message?
Use PUT Message and the “mms” parameter. See PUT Message.
-
How do I disable the system automated response for a keyword?
Disabling the automated response that is created with the mobile keyword can be done within API Settings -> Disable Keyword Auto-Responses. Be sure to activate the Inbound PUSH URL to receive notifications via API.
-
How do I disable the compliance message when a subscriber opts in?
A subscriber will receive an automated compliance message from the system when a keyword is texted. This message can be disabled if you wish to use mobile keywords to send a one-time message. Disabling this message will also remove the automated opt-in feature with mobile keywords. Turn off this option by going to API Settings -> Disable Keyword Signup.
-
How do I send a message directly to a mobile number?
Use the REST Direct SMS functionality to send a message to a mobile number. Using this function will automatically add the contact to a list and send the message. It does not require you to manage the subscription.
-
What are the default fields for a subscription?
The default fields are first name, last name, email address, mobile number, and landline. Additional fields can be created using Custom Data Fields.
-
How do I add additional fields to a subscription?
First, use the PUT Custom Data Fields to create the additional fields you need. It is recommended to use text field to collect open-ended questions.
-
How do I check the status of my API request?
- After submitting an API request, a request_id is immediately returned. It is important to check the status of the request using GET Report or PUSH notifications.
- Get Report checks the request_id and returns the status - whether successful or not. If it was unsuccessful, it will give the reason(s) for it.
- PUSH Notifications automates this process and eliminates the need to manually check by using GET Report. The API servers will automatically PUSH the status’ to a web endpoint.
-
What is status code MPCE4001?
This status code is returned when the system is still processing the API request. It is recommended to put a 200-millisecond pause before using GET Report. This allows the system some time to process the API request.
-
How do I send my first message?
PUT Message allows you to send a message to one or more subscriptions or distribution lists. A distribution list is required before a subscription can be added. You will need to add a subscription to the list and save the subscription_id. Then use PUT Message to send out your message.
-
How many contacts can be in a list?
There is no limit to the number of mobile numbers that can be added to the database. There can be a limit on email contacts depending on your plan. Check account details under Account -> Account Settings -> by scrolling down to Monthly Plan Details.
-
What is considered a unique subscription?
A subscription is unique based on the mobile number or email. Subscriptions can have the same first name, last name, and custom data fields. Subscriptions cannot have duplicate mobile numbers or emails.
-
How do I get a notification when my credit balance is low?
An email and/or text notification can be sent when a credit threshold has been reached. Set up this notification by going to Account -> Account Settings. Scroll down toward the bottom to Notifications.
-
How do I receive inbound messages?
Set up a web endpoint that can receive XML notifications. More information can be found
here.
-
Why am I not receiving any notifications to my Inbound and PUSH URLs?
The API servers have a built-in "activity" checker that will send empty HTTP POSTs and GETs to the URL. It is important to allow these empty requests to be received and a 200 OK response is to be returned.
-
Can I use HTTPS for inbound messages and PUSH notification URLS?
Yes! We can provide a secure connection to your API endpoint. Provide the public key to the support team via email:
apisupport@mytrum.com.
-
What's the difference between PUT Message and PUT SMS?
PUT Message requires the subscriber to be added to the database before a message can be sent. It also allows you to send messages to one or more individuals and distribution lists. PUT SMS will allow you to send a message to the subscriber without having to add the subscriber. It is important to comply with CTIA and TCPA regulations regarding opt-in.
-
What is 2-Factor Authentication? Why do I need it?
2-Factor Authentication confirms a user's identity two different ways.
In addition to knowing the passcode for logging in, users will be required to confirm their identity via text, email, or voice verification. 2-Factor Authentication provides added security that helps prevent fraudulent log-ins to your system. For more information, click here:
https://www.trumpia.com/api/two-factor-authentication
-
How do I send a message via a landline?
Provision a landline phone number by logging in to the account and going to Manage -> Utilities -> Register Phone Number. Once a phone number is registered, you can send landline texts using REST SMS.
-
What is the SMTP API?
SMTP API allows you to send text messages using email.
-
Why do I need to sign a contract?
The API certification goes over the legalities and regulations of mass text and email. It discloses the laws and guidelines of the TCPA, CTIA, MMA, and CAN-SPAM Act. This helps educate you about best practices and usage. For more information, click here:
https://www.trumpia.com/resources/tcpa-and-ctia
-
What is the TCPA and CTIA?
-
What is status code MPCE0101?
The request failed to authenticate. Check that the API Request URL and REST Headers are properly set and correct. The REST Headers should include the Content-Type and X-Apikey.
-
What is the rate limit?
There is no real rate limit on how many requests you can submit via API. That is a major advantage of asynchronous connections! The requests will be queued in our system and processed in the order in which they have been received.
-
What software can you integrate with?
We can integrate with most software that supports sending and receiving HTTP requests. Internal CRM software will require a web server to connect to Trumpia's API.