SMS API Banner

Trumpia HTTP API (Ver. 2)
Technical Guidelines

(Last Updated: 06/29/2016)
Contact
Add Contact Adds a new contact to your database and associate it with an existing distribution list.
Update Contact Data Update contact information by referencing contact ID.
Add Contact to List Adds an existing contact to a list using the contact ID.
Remove Contact Remove a contact from a distribution list.
Delete Contact Permanently delete a contact from your database and any associated lists.
Get Contact Data Retrieve contact information including tools and associated lists.
Get Contact ID Retrieve the contact ID to identify a specific contact.
List
Create List Create a distribution list.
Rename List Rename a list.
Delete List Delete a list.
Message
Send to List Send an SMS, and/or email to all contacts on a list.
Send to Contact Send an SMS, and/or email to a single contact.
Keyword
Check Keyword Check the availability of a mobile keyword.
Create Keyword Create a mobile keyword.
Update Keyword Update a mobile keyword.
Delete Keyword Delete a mobile keyword.
Response
Check Response Check the response for a request.

Contact

The following section provides the parameters and template for making requests to manage subscriptions, or contacts. Example response from the system is also provided.

Add Contact /http/v2/addcontact
Update Contact Data /http/v2/updatecontactdata
Add Contact to List /http/v2/addcontacttolist
Remove Contact /http/v2/removecontact
Delete Contact /http/v2/deletecontact
Get Contact Data /http/v2/getcontactdata
Get Contact ID /http/v2/getcontactid
Add Contact

Add a new contact to your database and to a distribution list. At the beginning of your request, you must specify the URL of the resource: http://api.trumpia.com/http/v2/addcontact. Once the request is completed, a request ID is returned. There can be only one instance of a tool, such as a unique mobile number, on a list; however, the same contact or some of the same contact information may exist on multiple lists.

Body Parameters * required parameters
apikey *
Your unique API key must be passed in. This will be matched with the IP address.
list_name *
List to add the contact to.
first_name *
First name of the contact.
last_name
Last name of the contact.
email
Email address of the contact.
country_code
Mobile phone number's country code. If left blank then it will be assumed to be a U.S. number. (Default : 1)
mobile_number
For U.S., the 10-digit number without the leading 0 or 1. For some international numbers, the leading 0 or 1 must be omitted. No symbols or spaces.
send_verification
TRUE or FALSE. If set to TRUE, this sends a verification message to each tool before they are added to your distribution list. If the tool is not verified, they will be marked as not verified and cannot be used. If set to FALSE, the verification step is bypassed and contacts will be added directly into your distribution list. A verification is omitted for an international phone number (not U.S.). (Default : FALSE)
custom_verification_msg
Character limit of 60 characters.

Default verification message: Reply OK to start. Msg&Data rates may apply. Upto 30msg/mo.
Request Example:
<form method = "post" action = "http://api.trumpia.com/http/v2/addcontact">
  <input type="text" name="apikey" value="1234567890">
  <input type="text" name="list_name" value="listname">
  <input type="text" name="first_name" value="firstname">
  <input type="text" name="last_name" value="lastname">
  <input type="text" name="email" value="abc@abc.com">
  <input type="text" name="country_code" value="1">
  <input type="text" name="mobile_number" value="1234567890"> 
  <input type="text" name="send_verification" value="TRUE">
  <input type="text" name="custom_verification_msg" value="custom verify message">
</form>
Response Example:
{
  "requestID" : "123123123123123123123"
}
TOP
Update Contact Data

This function allows you to update an existing contact record. At the beginning of your request, you must specify the URL of the resource: http://api.trumpia.com/http/v2/updatecontactdata. The contact ID must be provided to update the contact. Keep in mind that the same contact can exist on multiple lists.

Body Parameters * required parameters
apikey *
Your unique API key must be passed in. This will be matched with the IP address.
contact_id *
Unique ID of contact.
first_name
First name of the contact.
last_name
Last name of the contact.
email
Email address of the contact.
country_code
Mobile phone number's country code. If left blank then it will be assumed to be a U.S. number. Default : 1
mobile_number
For U.S., the 10-digit number without the leading 0 or 1. For some international numbers, the leading 0 or 1 must be omitted. No symbols or spaces.
send_verification
TRUE or FALSE. If set to TRUE, this sends a verification message to each tool before they are added to your distribution list. If the tool is not verified, they will be marked as not verified and cannot be used. If set to FALSE, the verification step is bypassed and contacts will be added directly into your distribution list. A verification is omitted for an international phone number (not U.S.). Default : FALSE.
custom_verification_msg
Character limit of 60 characters.

Default verification message: Reply OK to start. Msg&Data rates may apply. Upto 30msg/mo.
Request Example:
<form method = "post" action = "http://api.trumpia.com/http/v2/updatecontactdata">
  <input type="text" name="apikey" value="1234567890">
  <input type="text" name="contact_id" value="123456">
  <input type="text" name="first_name" value="firstname">
  <input type="text" name="last_name" value="lastname">
  <input type="text" name="email" value="abc@abc.com">
  <input type="text" name="country_code" value="1">
  <input type="text" name="mobile_number" value="1234657890">
  <input type="text" name="send_verification" value="TRUE">
  <input type="text" name="custom_verification_msg" value="custom verify message">
</form>
Response Example:
{
  "requestID" : "123123123123123123123"
}
TOP
Add Contact to List

This function adds an existing contact to a list using contact ID. At the beginning of your request, you must specify the URL of the resource: http://api.trumpia.com/http/v2/addcontacttolist. You can copy the contact or use a pointer. Contacts with duplicate tool data, such as mobile phone number, cannot be added to the same list.

Body Parameters * required parameters
apikey *
Your unique API key must be passed in. This will be matched with the IP address.
contact_id *
The unique contact ID of the contact you would like to add to a particular list.
list_name *
The list to add the contact to.
Request Example:
<form method = "post" action = "http://api.trumpia.com/http/v2/addcontacttolist">
  <input type="text" name="apikey" value="1234567890">
  <input type="text" name="contact_id" value="123456">
  <input type="text" name="list_name" value="TestList">
</form>
Response Example:
{
  "requestID" : "123123123123123123123"
}
TOP
Remove Contact

This function removes a contact from one or all associated distribution lists by the contact's actual information instead of the contact ID. At the beginning of your request, you must specify the URL of the resource: http://api.trumpia.com/http/v2/removecontact.

Note:

If you omit a list_name and set remove_all to true, then all subscriptions for the tool provided will be deleted.
Body Parameters * required parameters
apikey *
Your unique API key must be passed in. This will be matched with the IP address.
tool *
Email address, or mobile number, depending on the tool_type selected.
tool_type *
Contact information type.
Value Tool Type
1 Email
2 Mobile
remove_all
TRUE or FALSE. By setting this flag to TRUE, all other tools related to the specified tools will be deleted. In other words the whole subscription will be deleted. (Default : FALSE)
list_name
Distribution list name. If remove_all is TRUE, then the contact will be removed from the particular distribution list. If no distribution list is specified, then the contact will be removed from all lists.
Request Example:
<form method = "post" action ="http://api.trumpia.com/http/v2/removecontact">
  <input type="text" name="apikey" value="1234567890">
  <input type="text" name="tool" value="abc@abc.com">
  <input type="text" name="tool_type" value="1">
  <input type="text" name="remove_all" value="TRUE">
  <input type="text" name="list_name" value="TestList">
</form>
Request Example:
{
  "requestID" : "123123123123123123123"
}
TOP
Delete Contact

Permanently delete a contact from your database and any distribution lists it was on. At the beginning of your request, you must specify the URL of the resource:
http://api.trumpia.com/http/v2/deletecontact.

Body Parameters * required parameters
apikey *
Your unique API key must be passed in. This will be matched with the IP address.
contact_id *
Unique ID of contact.
Request Example:
<form method = "post" action = "http://api.trumpia.com/http/v2/deletecontact">
  <input type="text" name="apikey" value="1234567890">
  <input type="text" name="contact_id" value="123456">
</form>
Response Example:
{
  "requestID" : "123123123123123123123"
}
TOP
Get Contact Data

This function returns the contact's information and registered tools along with the tool's verification status. At the beginning of your request, you must specify the URL of the resource:
http://api.trumpia.com/http/v2/getcontactdata.

Body Parameters * required parameters
apikey *
Your unique API key must be passed in. This will be matched with the IP address.
contact_id *
Unique ID of contact.
Request Example:
<form method = "post" action = "http://api.trumpia.com/http/v2/getcontactdata">
  <input type="text" name="apikey" value="1234567890">
  <input type="text" name="contact_id" value="123456">
</form>
Response Example:
{
  "message" : "Query Success",
  "contactcode" : "aaa111bbb222",
  "contactdata" :
  {
    "tools" :
    {
      "mobilephone" :
      {
        "verify" : "1",
        "value" : "1234567890",
        "country_code" : "1"
      },
      "email" :
      {
        "verify" : "1",
        "value" : "email@email.com"
      }
    },
    "lastname" : "doe",
    "firstname" : "jane"
  },
  "statuscode" : "1"
}
TOP
Get Contact ID

This function can be used to find a contact record within a distribution list, searching by email address, or phone number. At the beginning of your request, you must specify the URL of the resource: http://api.trumpia.com/http/v2/getcontactid. Only one contact ID will be returned since a tool is unique within a list.

Note:

A good tip to remember is that you should store each contact's contact ID locally to avoid having to call this function.
Body Parameters * required parameters
apikey *
Your unique API key must be passed in. This will be matched with the IP address.
list_name *
List to search in.
tool_type *
Contact information type.
Input Value Tool Type
1 Email
2 Mobile
tool_data *
Email address, or mobile number depending on the tool type selected.
Request Example:
<form method = "post" action = "http://api.trumpia.com/http/v2/getcontactid">
  <input type="text" name="apikey" value="1234567890">
  <input type="text" name="list_name" value="listname">
  <input type="text" name="tool_type" value="1">
  <input type="text" name="tool_data" value="abc@abc.com">
</form>
Response Example:
{
  "statuscode" : "1",
  "message" : "Query Success",
  "contactid" : "1234567"
}
TOP

List

The following section provides the parameters ad template for making requests to manage distribution lists. Example response from the system is also provided.

Create List /http/v2/createlist
Rename List /http/v2/renamelist
Delete List /http/v2/deletelist
Create List

This function creates a new list. At the beginning of your request, you must specify the URL of the resource: http://api.trumpia.com/http/v2/createlist.

Body Parameters * required parameters
apikey *
Your unique API key must be passed in. This will be matched with the IP address.
list_name *
Enter the name of your list. List name is case-insensitive but must contain only alphanumeric characters. The maximum length for a list name is 32 characters.
display_name *
The display name will be the name that your subscriptions will see when signing up for your distribution list. As this name is public, make sure it makes sense to your future subscriptions.
frequency *
The frequency of messages your subscriptions receive each month must be disclosed, according to mobile industry regulations.
description *
The description of the kind of messages your subscriptions will receive when they opt into this list must be disclosed.
Request Example:
<form method = "post" action = "http://api.trumpia.com/http/v2/createlist">
  <input type="text" name="apikey" value="1234567890">
  <input type="text" name="list_name" value="TestList">
  <input type="text" name="display_name" value="TestDisplay">
  <input type="text" name="frequency" value="3">
  <input type="text" name="description" value="Promotions">
</form>
Response Example:
{
  "message" : "Create List Success",
  "statuscode" : "1",
  "listname" : "TestList",
  "displayname" : "TestDisplay",
  "frequency" : "3",
  "description" : "Promotions"
}
TOP
Rename List

This function renames an existing distribution list. At the beginning of your request, you must specify the URL of the resource: http://api.trumpia.com/http/v2/renamelist.

Body Parameters * required parameters
apikey *
Your unique API key must be passed in. This will be matched with the IP address.
list_name *
The distribution list to be renamed.
new_list_name *
The new name of the distribution list.
Request Example:
<form method = "post" action = "http://api.trumpia.com/http/v2/renamelist">
  <input type="text" name="apikey" value="1234567890">
  <input type="text" name="list_name" value="TestList">
  <input type="text" name="new_list_name" value="NewList">
</form>
Response Example:
{
  "requestID" : "123123123123123123123"
}
TOP
Delete List

This function deletes a list. At the beginning of your request, you must specify the URL of the resource: http://api.trumpia.com/http/v2/deletelist.

Body Parameters * required parameters
apikey *
Your unique API key must be passed in. This will be matched with the IP address.
list_name *
The distribution list you wish to delete.
delete_contact
TRUE or FALSE. Setting this to TRUE will delete all contacts on the list; contact data cannot be restored. (Default: FALSE)
Request Example:
<form method = "post" action = "http://api.trumpia.com/http/v2/deletelist">
  <input type="text" name="apikey" value="1234567890">
  <input type="text" name="list_name" value="TestList">
  <input type="text" name="delete_contact" value="TRUE">
</form>
Response Example:
{
  "requestID" : "123123123123123123123"
}
TOP

Message

The following section provides the parameters and template for making requests to send messages via mobile text (SMS), and/or email. Example response from the system is also provided.

Send to List /http/v2/sendtolist
Send to Contact /http/v2/sendtocontact
Send to List

This function sends a message to all the contacts in the specified list. At the beginning of your request, you must specify the URL of the resource: http://api.trumpia.com/http/v2/sendtolist. SMS, email, or any combination of the three can be sent with one function call using the relevant mode parameters. Multiple lists can be selected by passing multiple list names separated by commas. Messages can also be scheduled to be sent automatically at a later date and time enabling the later_time parameter.

Body Parameters * required parameters
apikey *
Your unique API key must be passed in. This will be matched with the IP address.
email_mode *
Value must be TRUE or FALSE. Used for sending your message via email.
sms_mode *
Value must be TRUE or FALSE. Used for sending your message via mobile text (SMS).
description *
Description of message for your reference.
email_subject
Required if email_mode or sb_mode is TRUE. Subject line for email. Plain text only.
email_message
Required if email_mode is TRUE. Email message body with support for basic HTML.
sms_message
Required if sms_mode is TRUE. SMS message body must be in plain text. Supported Character Set

Character limits vary per country. The maximum length for a message is 160 characters as default. For instance, SMS messages for Canadian accounts are limited to 140 characters. Although a 160 character message can be sent in full to US mobile numbers, Canadian mobile devices will only receive the first 140 characters.

Also, please note that the SMS header and footer are counted as part of the message and should be taken into consideration when composing a message.
change_org_name
This parameter is for SMS. By setting this parameter, you can temporarily change your organization name for this message blast. But you can use only registered organization names. You can register organization names via the website (Sign in > Account > Organization Profile).

The default structure of a SMS message is as follows:

<Organization Name>: <your message content> Txt STOP to OptOut
list_names *
Enter the list_names to send the message to. You can specify up to 100 list_names. You will have to separate multiple lists with commas (ex: name1, name2, name3...).
mail_merge_first_name
Mail merge replacement for null values if email content contains mail merge variables.
mail_merge_last_name
See mail merge feature online in compose email.
later_time
Enable to schedule blast for a later date and time. The format is: YYYY-MM-DD HH:MM:SS (ex : 2011-10-01 08:32:00)
Request Example:
<form method = "post" action = "http://api.trumpia.com/http/v2/sendtolist">
  <input type="text" name="apikey" value="1234567890">
  <input type="text" name="email_mode" value="TRUE">
  <input type="text" name="sms_mode" value="TRUE">
  <input type="text" name="description" value="test message">
  <input type="text" name="email_subject" value="test subject">
  <input type="text" name="email_message" value="test message">
  <input type="text" name="sms_message" value="test message">
  <input type="text" name="change_org_name" value="">
  <input type="text" name="list_names" value="TestList">
  <input type="text" name="mail_merge_first_name" value="">
  <input type="text" name="mail_merge_last_name" value="">
  <input type="text" name="later_time" value="2009-04-22 14:10:32">
</form>
Response Example:
{
  "requestID" : "123123123123123123123"
}
TOP
Send to Contact

This function is used to send a message to a single contact or multiple selected contacts using their contact ID numbers. At the beginning of your request, you must specify the URL of the resource: http://api.trumpia.com/http/v2/sendtocontact.

Body Parameters * required parameters
apikey *
Your unique API key must be passed in. This will be matched with the IP address.
email_mode *
Value must be TRUE or FALSE. Used for sending your message via email.
sms_mode *
Value must be TRUE or FALSE. Used for sending your message via mobile text (SMS).
description *
Description of message for your reference.
email_subject
Required if email_mode or sb_mode is TRUE. Subject line for email. Plain text only.
email_message
Required if email_mode is TRUE. Email message body with support for basic HTML.
sms_message
Required if sms_mode is TRUE. SMS message body must be in plain text. Supported Character Set

Character limits vary per country. The maximum length for a message is 160 characters as default. For instance, SMS messages for Canadian accounts are limited to 140 characters. Although a 160 character message can be sent in full to US mobile numbers, Canadian mobile devices will only receive the first 140 characters.

Also, please note that the SMS header and footer are counted as part of the message and should be taken into consideration when composing a message.
change_org_name
This parameter is for SMS. By setting this parameter, you can temporarily change your organization name for this message blast. But you can use only registered organization names. You can register organization names via the website (Sign in > Account > Organization Profile).

The default structure of a SMS message is as follows: 

<Organization Name>: <your message content> Txt STOP to OptOut
contact_ids *
Enter the contact_ids to send the message to. You can specify up to 500 contact_ids. You will have to separate multiple contact_ids with commas (ex: contact_id1, contact_id2, contact_id3...).
mail_merge_first_name
Mail merge replacement for null values if email content contains mail merge variables.
mail_merge_last_name
See mail merge feature online in compose email.
Request Example:
<form method = "post" action = "http://api.trumpia.com/http/v2/sendtocontact">
  <input type="text" name="apikey" value="1234567890">
  <input type="text" name="email_mode" value="TRUE">
  <input type="text" name="sms_mode" value="TRUE">
  <input type="text" name="description" value="test message">
  <input type="text" name="email_subject" value="test subject">
  <input type="text" name="email_message" value="test message">
  <input type="text" name="sms_message" value="test message">
  <input type="text" name="contact_ids" value="111111,111112">
  <input type="text" name="mail_merge_first_name" value="">
  <input type="text" name="mail_merge_last_name" value="">
</form>
Response Example:
{
  "requestID" : "123123123123123123123"
}
TOP

Keyword

The following section provides the parameters and template for making requests to manage mobile keywords. Example response from the system is also provided.

Check Keyword /http/v2/checkkeyword
Create Keyword /http/v2/createkeyword
Update Keyword /http/v2/updatekeyword
Delete Keyword /http/v2/deletekeyword
Check Keyword

This function returns whether a keyword is available or not. At the beginning of your request, you must specify the URL of the resource: http://api.trumpia.com/http/v2/checkkeyword.

Body Parameters * required parameters
apikey *
Your unique API key must be passed in. This will be matched with the IP address.
keyword *
The keyword you want to check the availability of.
Request Example:
<form method = "post" action = "http://api.trumpia.com/http/v2/checkkeyword">
  <input type="text" name="apikey" value="1234567890">
  <input type="text" name="keyword" value="TestKeyword">
</form>
Response Example (keyword is available):
{
  "statuscode" : "1",
  "message" : "Query Success",
  "isavailable" : "AVAILABLE"
}
Response Example (keyword is unavailable):
{
  "statuscode" : "1",
  "message" : "Query Success",
  "isavailable" : "UNAVAILABLE"
}
TOP
Create Keyword

This function creates a new mobile keyword. At the beginning of your request, you must specify the URL of the resource: http://api.trumpia.com/http/v2/createkeyword.

Body Parameters * required parameters
apikey *
Your unique API key must be passed in. This will be matched with the IP address.
keyword *
The keyword to create. Check availability before creating.
list_names *
Enter the names of the lists you want to associate the keyword with. Separate multiple list names with commas: name1,name2,name3...
user_response *
TRUE or FALSE. This enables users to add an optional message or response after the keyword. This message will be sent to your Inbox.
keyword_message *
This is the automated message sent to someone who texts in the keyword. The message body must be in plain text. Supported Character Set

Character limits vary per country. The maximum length for a message is 160 characters as default. For instance, SMS messages for Canadian accounts are limited to 140 characters. Although a 160 character message can be sent in full to US mobile numbers, Canadian mobile devices will only receive the first 140 characters.

Also, please note that the SMS header and footer are counted as part of the message and should be taken into consideration when composing a message.
send_alternate
TRUE or FALSE. If send_auto_response is not '1', send an alternate auto response after the first time. This is sent only if the subscriber already exists in your contact database. (Default : FALSE)
alternate_message
Enter the body content of the alternate message that will be sent if send_alternate is TRUE. The message body must be in plain text. Supported Character Set

Character limits vary per country. The maximum length for a message is 160 characters as default. For instance, SMS messages for Canadian accounts are limited to 140 characters. Although a 160 character message can be sent in full to US mobile numbers, Canadian mobile devices will only receive the first 140 characters.

Also, please note that the SMS header and footer are counted as part of the message and should be taken into consideration when composing a message.
change_org_name
By setting this parameter, you can temporarily change your organization name in the keyword_message and alternate_message responses. But you can use only registered organization names. You can register organization names via the website (Sign in > Account > Organization Profile).

The default structure of a mobile-text message is as follows: 

<Organization Name>: <your message content> Txt STOP to OptOut
send_auto_response
Input Value Send Auto Response
1 Only once per mobile number
2 (Default) Every time
3 Only once every minute
4 Only once every hour
5 Only once every day
6 Only once every week
7 Only once every month
8 Only once every year
use_notify
TRUE or FALSE. When someone texts in this keyword, send a notification. (Default : FALSE)
notify_email
Email address to where a notification will be sent when someone signs up via this keyword.
notify_mobile
Mobile phone numbers to where a notification will be sent when someone signs up via this keyword.
notify_type1
TRUE or FALSE. If user_response is TRUE and use_notify is TRUE, notify me when someone texts in this keyword without an optional message. (Default : FALSE)
notify_type2
TRUE or FALSE. If user_response is TRUE, use_notify is TRUE, and notify_type1 is TRUE, notify me only when the keyword subscriber's mobile number is new to my contact database. (Default : FALSE)
notify_type3
TRUE or FALSE. If user_response is TRUE and use_notify is TRUE, notify me when someone texts in this keyword with an optional message. (Default : FALSE)
notify_type4
TRUE or FALSE. If user_response is TRUE, use_notify is TRUE, and notify_type3 is TRUE, notify me only when the keyword subscriber's mobile number is new to my contact database. (Default : FALSE)
notify_type5
TRUE or FALSE. If user_response is TRUE and use_notify is TRUE, notify me only when the keyword subscriber's mobile number is new to my contact database. (Default : FALSE)
optin_type
The opt-in types for keyword sign-up. You can change the default value at Sign In > Account > General Default Setting. The default opt-in type is used if this parameter is not specified.
Value Description
1 Single Opt-In: The subscriber only needs to text in a keyword to complete their sign-up.
2 Double Opt-In: After a subscriber texts in a keyword, they will be asked to reply yes or no to verify their sign-up. If they reply yes, their sign-up is complete.
Request Example:
<form method = "post" action = "http://api.trumpia.com/http/v2/createkeyword">
  <input type="text" name="apikey" value="1234567890">
  <input type="text" name="keyword" value="TestKeyword">
  <input type="text" name="list_names" value="TestList1,TestList2">
  <input type="text" name="user_response" value="TRUE">
  <input type="text" name="keyword_message" value="test message">
  <input type="text" name="send_alternate" value="TRUE">
  <input type="text" name="alternate_message" value="test message">
  <input type="text" name="change_org_name" value="orgname">
  <input type="text" name="send_auto_response" value="2">
  <input type="text" name="use_notify" value="TRUE">
  <input type="text" name="notify_email" value="abc@abc.com">
  <input type="text" name="notify_mobile" value="1234567890">
  <input type="text" name="notify_type1" value="TRUE">
  <input type="text" name="notify_type2" value="TRUE">
  <input type="text" name="notify_type3" value="TRUE">
  <input type="text" name="notify_type4" value="TRUE">
  <input type="text" name="notify_type5" value="">
</form>
Response Example:
{
  "requestID" : "123123123123123123123"
}
TOP
Update Keyword

This function allows you to update an existing keyword. At the beginning of your request, you must specify the URL of the resource: http://api.trumpia.com/http/v2/updatekeyword.

Body Parameters * required parameters
apikey *
Your unique API key must be passed in. This will be matched with the IP address.
keyword *
The keyword you wish to delete.
list_names *
Enter the names of the lists you want to associate the keyword with. Separate multiple list names with commas: name1,name2,name3...
user_response *
TRUE or FALSE. This enables users to add an optional message or response after the keyword. This message will be sent to your Inbox.
keyword_message *
This is the automated message sent to someone who texts in the keyword. The message body must be in plain text. Supported Character Set

Character limits vary per country. The maximum length for a message is 160 characters as default. For instance, SMS messages for Canadian accounts are limited to 140 characters. Although a 160 character message can be sent in full to US mobile numbers, Canadian mobile devices will only receive the first 140 characters.

Also, please note that the SMS header and footer are counted as part of the message and should be taken into consideration when composing a message.
send_alternate
TRUE or FALSE. If send_auto_response is not '1', send an alternate auto response after the first time. This is sent only if the subscriber already exists in your contact database. (Default : FALSE)
alternate_message
Enter the body content of the alternate message that will be sent if send_alternate is TRUE. The message body must be in plain text. Supported Character Set

Character limits vary per country. The maximum length for a message is 160 characters as default. For instance, SMS messages for Canadian accounts are limited to 140 characters. Although a 160 character message can be sent in full to US mobile numbers, Canadian mobile devices will only receive the first 140 characters.

Also, please note that the SMS header and footer are counted as part of the message and should be taken into consideration when composing a message.
change_org_name
By setting this parameter, you can temporarily change your organization name in the keyword_message and alternate_message responses. But you can use only registered organization names. You can register organization names via the website (Sign in > Account > Organization Profile).

The default structure of a mobile-text message is as follows:

<Organization Name>: <your message content> Txt STOP to OptOut
send_auto_response
Input Value Send Auto Response
1 Only once per mobile number
2 (Default) Every time
3 Only once every minute
4 Only once every hour
5 Only once every day
6 Only once every week
7 Only once every month
8 Only once every year
use_notify
TRUE or FALSE. When someone texts in this keyword, send a notification. (Default : FALSE)
notify_email
Email address to where a notification will be sent when someone signs up via this keyword.
notify_mobile
Mobile phone numbers to where a notification will be sent when someone signs up via this keyword.
notify_type1
TRUE or FALSE. If user_response is TRUE and use_notify is TRUE, notify me when someone texts in this keyword without an optional message. (Default : FALSE)
notify_type2
TRUE or FALSE. If user_response is TRUE, use_notify is TRUE, and notify_type1 is TRUE, notify me only when the keyword subscriber's mobile number is new to my contact database. (Default : FALSE)
notify_type3
TRUE or FALSE. If user_response is TRUE and use_notify is TRUE, notify me when someone texts in this keyword with an optional message. (Default : FALSE)
notify_type4
TRUE or FALSE. If user_response is TRUE, use_notify is TRUE, and notify_type3 is TRUE, notify me only when the keyword subscriber's mobile number is new to my contact database. (Default : FALSE)
notify_type5
TRUE or FALSE. If user_response is TRUE and use_notify is TRUE, notify me only when the keyword subscriber's mobile number is new to my contact database. (Default : FALSE)
optin_type
The opt-in types for keyword sign-up.
Value Description
1 Single Opt-In: The subscriber only needs to text in a keyword to complete their sign-up.
2 Double Opt-In: After a subscriber texts in a keyword, they will be asked to reply yes or no to verify their sign-up. If they reply yes, their sign-up is complete.
Request Example:
<form method = "post" action = "http://api.trumpia.com/http/v2/updatekeyword">
  <input type="text" name="apikey" value="1234567890">
  <input type="text" name="keyword" value="TestKeyword">
  <input type="text" name="list_names" value="TestList1,TestList2">
  <input type="text" name="user_response" value="TRUE">
  <input type="text" name="keyword_message" value="test message">
  <input type="text" name="send_alternate" value="TRUE">
  <input type="text" name="alternate_message" value="test message">
  <input type="text" name="change_org_name" value="orgname">
  <input type="text" name="send_auto_response" value="2">
  <input type="text" name="use_notify" value="TRUE">
  <input type="text" name="notify_email" value="abc@abc.com">
  <input type="text" name="notify_mobile" value="1234567890">
  <input type="text" name="notify_type1" value="TRUE">
  <input type="text" name="notify_type2" value="TRUE">
  <input type="text" name="notify_type3" value="TRUE">
  <input type="text" name="notify_type4" value="TRUE">
  <input type="text" name="notify_type5" value="">
</form>
Response Example:
{
  "requestID" : "123123123123123123123"
}
TOP
Delete Keyword

This function deletes a mobile keyword. By doing so, that keyword is available for use by other users. At the beginning of your request, you must specify the URL of the resource:
http://api.trumpia.com/http/v2/deletekeyword.

Body Parameters * required parameters
apikey *
Your unique API key must be passed in. This will be matched with the IP address.
keyword *
The keyword you wish to delete.
Request Example:
<form method = "post" action = "http://api.trumpia.com/http/v2/deletekeyword">
  <input type="text" name="apikey" value="1234567890">
  <input type="text" name="keyword" value="TestKeyword">
</form>
Response Example:
{
  "requestID" : "123123123123123123123"
}
TOP

Response

Check the response of any previous API request by looking up the unique request ID.

Check Response /http/v2/checkresponse
Check Response

Checking the response of a request will return the status as having been completed or failed. You will also be provided with the credit process ID and task ID.

Body Parameters * required parameters
request_id *
The request ID is the unique identifier for the API request you would like to check the response for.
Request Example:
<form method = "post" action ="http://api.trumpia.com/http/v2/checkresponse">
  <input type="text" name="request_id" value="1234567890">
</form>
Response Example:
{
  "statuscode" : "1",
  "message" : "Send Success",
  "creditProcessID" : "12345",
  "taskID" : "123456"
}
* Status code indicates the failure or success of your API request: 0 - Failure, 1 - Success TOP
PUSH Notification Inbound Message