SimpleTexting SMS API and REST API Documentation

Through our SMS API you can access many different features of the SimpleTexting platform. Browse them below and check out the list of available SMS API functions and their parameters. To use our SMS API, you must first open an SimpleTexting and request token access. No additional SMS API activation steps needed.

Send SMS Message

Description
Send SMS text messages via SMPP or SMTP gateway.
Accepts GET or POST requests.
URL
https://app.simpletexting.com/v1/send
Parameters
token (Required) Your SimpleTexting API token
phone (Required) 10 digit phone number to send message to
message (Required) The body of your message

Note: Messages sent cannot exceed 160 characters.

Return values
1 The request succeeded
-1 Invalid API token or API is not allowed for your account
-3 Required parameter is not specified
-10 Unknown error (please contact our support dept.)
-300 Incorrectly formatted phone number
-303 Credit limit reached
-304 Invalid message text (exceeds maximum number of characters and/or contains invalid characters)
-305 Sending via api is only available to paid customers
0 Globally opted out phone number (the phone number has been opted out from all messages sent from our short code)

Receiving Inbox Messages

Description
All incoming text messages are forwarded to the URL you specify. The SimpleTexting Server pushes received SMS messages by making an HTTP GET request to the provided URL.
Example URL
http://www.yourdomain.com/receivesms.php?phone=5554443333&message=Hello%20my%20friend
Parameters
phone 10 digit phone number message originated from.
message The body of receiving message that was texted in by the originating phone number
Return data
When GET request is sent to your server, your script COULD output SMS response in plain text format (max 160 characters, keyword will be prefaced automatically) that will be sent back to the originating phone number through our shared short code 555888. This response takes precedence over auto reply. If the response is empty no SMS will be sent in reply. This response must be given in a timely manner (sub 60 seconds) or it will be abandoned. No additional calls to our servers are necessary.

Check Messages Count

Description
Check messages count on your account.
Accepts GET or POST requests.
URL
https://app.simpletexting.com/v1/messaging/check
Parameters
token (Required) Your SimpleTexting API token
Return values
Any non-negative number - The count of available messages
-1 Invalid API token or API is not allowed for your account
-3 Required parameter is not specified
-10 Unknown error (please contact our support dept.)

Check Keyword Availability

Description
Check if keyword is available to rent on our shared short code 555888
Accepts GET or POST requests.
URL
https://app.simpletexting.com/v1/keyword/check
Parameters
token (Required) Your SimpleTexting API token
keyword (Required) The keyword to be checked
Parameters
1 The keyword is available
0 The keyword is not available
-1 Invalid API token or API is not allowed for your account
-3 Required parameter is not specified
-10 Unknown error (please contact our support dept.)

Rent a Keyword

Description
Rent a Keyword on our shared short code 555888
Accepts GET or POST requests.
URL
https://app.simpletexting.com/v1/keyword/rent
Parameters
token (Required) Your SimpleTexting API token
keyword (Required) The keyword to rent
Return values
1 The request succeeded
-1 Invalid API token or API is not allowed for your account
-3 Required parameter is not specified
-102 New keyword is invalid or not available
-202 The request was declined by payment system
-203 No payment profile
-10 Unknown error (please contact our support dept.)

Configure a Keyword

Description
Configure/Update settings for a Keyword belonging to your account.
Accepts GET or POST requests.
URL
https://app.simpletexting.com/v1/keyword/configure
Parameters
token (Required) Your SimpleTexting API token
keyword (Required) Keyword that you want to configure
autoreply (Optional) Customers that text keyword to 555888 will receive this message on subscription. If you do not update this field, we will send out our default autoreply.
optinsemail (Optional) Email for opt-ins forwarding
Return values
1 Updated successfully
-1 Invalid API token or API is not allowed for your account
-2 Invalid optional parameter
-101 Keyword with this name doesn’t exists
-103 Invalid autoreply message (message exceeds maximum number of characters or message contains invalid characters)
-104 Invalid email for opt-ins forwarding
-10 Unknown error (please contact our support dept.)

Remove Keyword

Description
Remove your keyword.
URL
https://app.simpletexting.com/v1/keyword/remove
Parameters
token (Required) Your SimpleTexting API token
keyword (Required) The keyword to remove
Return values
1 The request succeeded
-1 Invalid API token or API is not allowed for your account
-3 Required parameter is not specified
-101 Keyword with this name doesn’t exists
-10 Unknown error (please contact our support dept.)

List All Keywords

Description
List of all keywords
Accepts GET or POST requests.
URL
https://app.simpletexting.com/v1/keyword/list
Parameters
token (Required) Your SimpleTexting API token
Return values
1 Retrieved list successfully
-1 Invalid API token or API is not allowed for your account
-3 Required parameter is not specified
-10 Unknown error (please contact our support dept.)
Return data
Each keyword will contain the next fields
keyword Keyword name
createdate The date when keyword was created
autoreply Customers that text keyword to 555888 will receive this message on subscription.

Configure Forwarding

Description
Configure/Update settings for forwarding to your account.

Accepts GET or POST requests.
URL
https://app.simpletexting.com/v1/forward/setup
Parameters
token (Required) Your SimpleTexting API token
email (Optional) We will forward incoming messages to the email address for free
url (Optional) We will forward incoming messages to this URL
phone (Optional) We will forward incoming messages to this mobile number
Return values
1 The request succeeded
-1 Invalid API token or API is not allowed for your account
-3 Required parameter is not specified
-400 Invalid Email
-401 Invalid URL
-300 Incorrectly formatted phone number
-10 Unknown error (please contact our support dept.)

List All Contacts

Description
List All Contacts

Accepts GET or POST requests.
URL
https://app.simpletexting.com/v1/group/contact/list/
Parameters
token (Required) Your SimpleTexting API token
group (Required) list name
Return values
1 The request succeeded
-1 Invalid API token or API is not allowed for your account
-3 Required parameter is not specified
-600 Invalid list name
-10 Unknown error (please contact our support dept.)

Add Contact To List

Description
Add contact to list

Accepts GET or POST requests.
URL
https://app.simpletexting.com/v1/group/contact/add
Parameters
token (Required) Your SimpleTexting API token
group (Required) list name
phone (Required) phone
Return values
1 The request succeeded
-1 Invalid API token or API is not allowed for your account
-3 Required parameter is not specified
-600 Invalid list name
-601 Contact hasn't been added to the list. Please contact our support
-604 Invalid phone number
-606 Contact hasn't been added to the list. List should have 'Import/Manual' type
-607 Contact is already in this list
-10 Unknown error (please contact our support dept.)

Delete Contact From List

Description
Remove contact form list

Accepts GET or POST requests.
URL
https://app.simpletexting.com/v1/group/contact/remove
Parameters
token (Required) Your SimpleTexting API token
group (Required) list name
id (required) Contact id
Return values
1 The request succeeded
-1 Invalid API token or API is not allowed for your account
-3 Required parameter is not specified
-600 Invalid list name
-603 Contact hasn't been removed. Please contact our support
-605 Invalid contact ID
-10 Unknown error (please contact our support dept.)

List All Sent Messages

Description
List of all sent messages to date

Accepts GET or POST requests.
URL
https://app.simpletexting.com/v1/messaging/sent/list
Parameters
token (Required) Your SimpleTexting API token
datefrom (Optional) Date from (Format: YYYY-MM-DD)
dateto (Optional) Date to (Format: YYYY-MM-DD)
date (Optional) Date (Format: YYYY-MM-DD)
Return values
1 The request succeeded
-1 Invalid API token or API is not allowed for your account
-3 Required parameter is not specified
-803 Invalid date format, date format must be YYYY-MM-DD or YYYY-MM-DD-HH:MM
-10 Unknown error (please contact our support dept.)

List All Scheduled Messages

Description
List of all scheduled messages

Accepts GET or POST requests.
URL
https://app.simpletexting.com/v1/messaging/scheduled/list
Parameters
token (Required) Your SimpleTexting API token
Return values
1 The request succeeded
-1 Invalid API token or API is not allowed for your account
-3 Required parameter is not specified
-10 Unknown error (please contact our support dept.)

Show Message Info

Description
Show message info

Accepts GET or POST requests.
URL
https://app.simpletexting.com/v1/messaging/message
Parameters
token (Required) Your SimpleTexting API token
id (Required) Message id
Return values
1 The request succeeded
-1 Invalid API token or API is not allowed for your account
-3 Required parameter is not specified
-802 Invalid message Id
-10 Unknown error (please contact our support dept.)

Remove message by Id

Description
Remove message by Id

Accepts GET or POST requests.
URL
https://app.simpletexting.com/v1/messaging/delete
Parameters
token (Required) Your SimpleTexting API token
id (Required) Message id
Return values
1 The request succeeded
-1 Invalid API token or API is not allowed for your account
-3 Required parameter is not specified
-801 Message hasn't been removed. Please contact our support
-802 Invalid message Id
-10 Unknown error (please contact our support dept.)