Mass Text Message Marketing by Club Texting

HTTP API Documentation

Choose Which API You'd Like Documentation ForWe offer a REST API and a legacy HTTP API. Please make sure
that you are reading the correct documentation for the set of APIs that
you are using to connect to Club Texting's text messaging gateway.

Looking for information about receiving messages?
Read about the Incoming Message API.

HTTP APIs

We offer easy-to-use HTTP APIs for all core Club Texting functions. Send messages, configure Keywords, buy credits and more.

Continue For HTTP API Documentation

OR

REST APIs

We offer JSON/XML based REST APIs for nearly all core Club Texting functions. Multiple-recipient sending is only available via the REST API.

Click For REST API Documentation


If you are interested in performing a carrier lookup by phone number, please see our Cellular Carrier Lookup API documentation. Carrier Lookup is available via both the HTTP and REST APIs.

Code Samples are available on the navigation bar to the left for all HTTP APIs in multiple languages.

If you would like to send the same message to multiple recipients we strongly urge you to consider using our REST Sending API as you may pass an array of phone numbers and your message in a single request.

HTTP API Documentation

 

Sending SMS Messages
Sends individual SMS text messages via the short code 25827 (212121 In Canada).
Accepts GET or POST requests.

URL
https://app.clubtexting.com/api/sending/
Example call: https://app.clubtexting.com/api/sending/?user=USERNAME&pass=PASSWORD&phonenumber=PHONENUMBER&subject=SUBJECT&message=MESSAGE&express=1

Parameters
User
 (Required) Your Club Texting username
Pass
 (Required) Your Club Texting password
PhoneNumber (Required) 10 digit phone number to send message to
Subject
 (Required) The subject of your message (leave empty if no subject)
Maximum 13 characters!
Message
 (Required) The body of your message
Express (Optional) Use Express delivery method when sending message value = 1. To send Standard Devliery set the value = 0. If you leave this parameter out your message will default to Express Delivery.  What's the difference between Standard & Express delivery?
Note: Values must be properly URL encoded

Note: Our servers impose a limit on the number of simultaneous connections that you may make from your server to ours per second.  To avoid having your IP blocked, please do not attempt to make more than 2 simultaneous HTTP connections per second to our servers.  Please also make sure that you close each connection after opening one when making your HTTP request.  If you are running a multithreaded application please also be aware of the limit that is imposed. If your application exceeds this limit you may receive a rate limiting error, with the HTTP status code 503 in the header and your request will not be processed. If you believe you are being incorrectly rate limited please contact support.

When sending multiple request we strongly suggest using the following logic in order to avoid this limitation:
1) Open Connection
2) Begin Loop
3) Make Request
4) Close Loop
5) Close Connection

If you are sending to a large number of recipients, we strongly urge you to explore our REST APIs which allow easier mass sending. Instead of looping through a message multiple times, to multiple recipients, our REST sending API allows you to pass us an array of phone numbers to deliver the same message to.

Return Values
1
 Message sent
-1
 Invalid user and/or password or API is not allowed for your account
-2
Credit limit reached
-5
Local opt out (the recipient/number is on your opt-out list.)
-7
Invalid message or subject (exceeds 13 characters and/or contains invalid characters - see a list of valid characters below)
-104
 Globally opted out phone number (the phone number has been opted out from all messages sent from our short code)
-106
Incorrectly formatted phone number (number must be 10 digits)
-10
 Unknown error (please contact our support dept.)
Note: Messages sent via Standard delivery cannot exceed 130 characters combined subject and message field, via Express delivery - 160 characters (136 characters in Canada) combined subject and message field. Subjects are always limited to 13 characters
Note: The list of allowed characters for messages and subjects is: a-z, A-Z, 0-9 and these special characters: .,:;!?()~=+-_\/@$#&%'"
Note: The following characters count as two characters when used: \r \n
Note: To opt back in a globally opted out number (return value -104) please text your Keyword to 25827 (212121 In Canada) using that phone.

 




Check Credit Balance

You may check credit balances using our API via an HTTP call to the following web service URL:
https://app.clubtexting.com/api/credits/check/

Parameters (may be passed via GET or POST and values must be properly URL encoded)
User
 (Required) Your Club Texting Username
Pass
 (Required) Your Club Texting Password

 

Return Values
Any non-negative number
 The amount of credits available
-1
 Invalid user or password (make sure your account is API allowed)
-10
 Unknown Error (please contact our support dept.)

Note: Any negative codes represent unsuccessful attempts to check credits amount.





Check Keyword Availability

The keyword availability check API may be accessed via an HTTP call to the following web service URL:
https://app.clubtexting.com/api/keyword/check/

Parameters (may be passed via GET or POST and values must be properly URL encoded)
User
 (Required) Your Club Texting Username
Pass
 (Required) Your Club Texting Password
Keyword (Required) The keyword to be checked

 

Return Values
1
 The keyword is available
0
 The keyword is not available
-1
 Invalid user or password (make sure your account is API enabled)
-2
 Request declined because it is less than $5.00 minimum purchase.
-10
 Unknown Error (please contact our support dept.)

Note: Any negative codes represent unsuccessful attempts to check keyword availability.






Buy More Credits

The credit purchase API may be accessed via an HTTPS call to the following web service URL:
https://app.clubtexting.com/api/credits/buy/

Parameters (must be passed via POST and values must be properly URL encoded)
User
 (Required) Your Club Texting Username
Pass
 (Required) Your Club Texting Password
FirstName (Required) The first name on the card
LastName (Required) The last name on the card
Address (Required) The billing street address
City (Required) The billing address city
State (Required) The billing address state/province
Zip (Required) The billing address zip code
Country (Required) The billing address country
Type (Required) Card type: 'MC' for MasterCard, 'Visa', 'AX' for American Express, 'DS' for Discover, 'JCB'
CCNumber (Required) Card number
CCCode (Required) Card Security Code (CV2)
Expm (Required) Card's expiration month, two digits
Expy (Required) Card's expiration year, two digits
Credits (Required) Amount of credits to buy

 

Return Values
1
 The request succeeded
0
 The request was declined
-1
 Invalid user or password (make sure your account is API allowed)
-10
 Unknown Error (please contact our support dept.)

Note: Any negative codes represent unsuccessful attempts to buy credits.





Rent a Keyword:

The keyword rental API may be accessed via an HTTPS call to the following web service URL:
https://app.clubtexting.com/api/keyword/rent/

Parameters (must be passed via POST and values must be properly URL encoded)
User
 (Required) Your Club Texting Username
Pass
 (Required) Your Club Texting Password
FirstName (Required) The first name on the card
LastName (Required) The last name on the card
Address (Required) The billing street address
City (Required) The billing address city
State (Required) The billing address state/province
Zip (Required) The billing address zip code
Country (Required) The billing address country
Type (Required) Card type: 'MC' for MasterCard, 'Visa', 'AX' for American Express, 'DS' for Discover, 'JCB'
CCNumber (Required) Card number
CCCode (Required) Card Security Code (CV2)
Expm (Required) Card's expiration month, two digits
Expy (Required) Card's expiration year, two digits
Keyword (Required) The keyword to rent

Note: After you rent a Keyword, you may want to update the default autoreply, which is 'Thank you for joining our list.'

 

Return Values
2
 The request succeeded
1
 The keyword is not available
0
 The request was declined
-1
 Invalid user or password (make sure your account is API allowed)
-10
 Unknown Error (please contact our support dept.)

Note: Any negative codes represent unsuccessful attempts to rent a keyword.


 

Configure a Keyword:

The keyword configuration API may be accessed via an HTTPS call to the following web service URL:
https://app.clubtexting.com/api/keyword/setup/

Parameters (must be passed via GET or POST and values must be properly URL encoded)
User
 (Required) Your Club Texting Username
Pass
 (Required) Your Club Texting Password
Keyword (Required) Keyword that you want to configure
Group (Optional) Customers who text in your keyword will be added to the group you provide
Autoreply (Optional) Customers that text in your Keyword to our short code will receive this message. The autoreply is limited to 160 characters. Each confirmation return text that is sent back requires 1 credit. If you do not update this field, we will send out our default autoreply, 'Thank you for joining our list.'
Email (Optional) We will forward incoming messages to the email address for free
URL (Optional) We will call this URL when keyword is received

 

Return Values
1
 Updated Successfully
-1
 Invalid user or password (make sure your account is API allowed)
-2
 Invalid Keyword
-3
 Invalid Group Name
-4
 Invalid Email
-5
 Invalid URL
-7
 Invalid autoreply message (message is blank or message exceeds maximum number of characters or message contains invalid characters)
-10
 Unknown Error (please contact our support dept)

Note: Any negative codes represent unsuccessful attempts to configure a keyword.

 

 

Voice Broadcast Via API

The voice broadcast API may be accessed via an HTTP call to the following web service URL:
https://app.clubtexting.com/api/voicemessages/

Parameters (may be passed via POST and values must be properly URL encoded)
User
 (Required) Your Club Texting Username
Pass
 (Required) Your Club Texting Password
Phonenumbers (Required) Array of 10 digit phone numbers to call to.
Soundfile
 (Optional) Name of the .wav file in your Club Texting account
Soundsource
 (Optional) Address to the .wav file on your server
Callerid (Required) 10 digit phone number

Note: You can either provide name of the file you saved in your Club Texting account (Soundfile) or we can get your .wav file from the URL on your server (Soundsource).

 

Return Values
1
 Campaign Sent
-1
 Invalid user or password (make sure your account is API allowed)
-2
Credit Limit Reached
-3
Invalid Callerid
-4
Invalid array of phone numbers
-5

Invalid Soundfile (make sure you provided the correct file name) 
-6
 Invalid Soundsource (make sure you provided the correct path to the file)
-7

Invalid POST Request (make sure you use the correct names of variables)
-10
 Unknown Error

Note: Any negative codes represent unsuccessful attempts to create a broadcast.