Club Texting Bulk Text Messaging API Documentation:
If you are interested in performing a carrier lookup by phone number, please see our Cellular Carrier Lookup API documentation.
- Sending SMS Messages Via API
- Understanding The Two Incoming Message APIs
- Check Amount of Credits Via API
- Check Keyword Availability Via API
- Buy More Credits Via API
- Rent a Keyword Via API
- Setup a Keyword Via API
- Voice Broadcast Via API
Sending SMS Messages Via API:The text (sms) message sending API may be accessed via an HTTP call to the following web service URL:
https://app.clubtexting.com/api/sending/
Parameters (may be passed via GET or POST and values must be properly URL encoded)
(Required) Your Club Texting Username (Required) Your Club Texting Password PhoneNumber (Required) 10 digit phone number to send message to. (Required) The subject of your message (leave null if no subject) (Required) The body of your message (cannot exceed 130 characters and contain single or double quotes) (Express messages cannot exceed 160 characters) 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? The following are the codes that a send message API call can return.
Any negative codes represent unsuccessful attempts to send messages.
Message Sent Invalid user or password (make sure your account is API allowed) Credit Limit Reached Local Opt Out (the recipient/number is on your opt-out list.) Invalid Message (message exceeds 130 characters (160 for express) or contains single or double quotes or other invalid characters - see a list of valid characters below this table) Globally Opted Out Phone Number (the phone number has been opted out from all messages sent from our short code). To opt this number in please text DEMO or Your Keyword to 25827 using that phone. Incorrectly Formatted Phone Number (number must be 10 digits) Unknown Error (please contact our support dept.)
Please 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.
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 ConnectionThe list of allowed characters for messages and subjects is: a-z, A-Z, 0-9 and these special characters: .,:;!?()~=+-_\/@$#&%
The following characters count as two characters when used: ~ @ # % + = / \ \r\n
Understanding The Difference Between
The Keyword Submission API And The Inbox Replies APIClub Texting allows you to implement your own APIs to receive and/or forward incoming messages to your server. Please check out the list of parameters which Club Texting sends to your server, which your APIs must accept.
When someone sends in your keyword [space] message or just replies without a keyword within 3 hours of you sending a message to them, the Inbox Reply API is used where the variable is called from. If someone sends in only your keyword then the Keyword API is invoked and that variable is called Phone Number.
**Please note that if you are testing your API implementation with the same phone number again and again, when you send in your keyword submission and you get a reply back then the keyword reply is considered as an outgoing message. Consequently, if you send in keyword [space] message again through the same phone number, The Inbox Reply API will be invoked and NOT the Keyword API.
Many of our API clients use different scripts to process forwarded messages (messages that are replies or keyword [space] message) vs just keywords. This is the cause of the difference between the name of the variables.
If you have Send Unique Requests Checked then your Keyword URL will only be called once and not your Forwarding URL in cases when a message is considered to be a keyword submission and not a reply to an outbound message from your account.
If you have Wait for Response From My Server Checked then the system will wait for output to send back to the person who texted in. We suggest that you have both these Checked as it would work for most applications.
Receiving Keyword Submissions Via APIThe club Texting SMS Server allows SMS messages to be received using HTTP through the means of keywords on our short code 25827 (or 212121 for Canada). This page details the format of the HTTP requests which are send by the club Texting SMS Server to allow the receipt of SMS text messages by external software systems.
The club Texting SMS Server will push received SMS messages by making an HTTP GET to the provided URL to indicate the receipt of an SMS message. You can input this URL on the Keywords section of your club Texting account.
Example URL:
http://www.yourdomain.com/receivesms.php
Message Format
On receipt of an SMS we will send an HTTP GET request to your server, using the parameters included in the table below:
PhoneNumber 10 digit phone number message originated from. The body of your message that was texted in by the originating phone number prefaced by your keyword. Example Request Sent:
http://www.yourdomain.com/receivesms.php?PhoneNumber=5554443333&Message=Hello%20my%20friendResponse To The Server
When the GET post is made to your server, your script must output your sms response in plain text format (max 130 characters or 160 for express) that will be sent back to the originating phone number through our 25827 (or 212121 for Canada) shared short code. 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.The list of allowed characters for messages and subjects is: a-z, A-Z, 0-9 and these special characters: .,:;!?()~=+-_\/@$#&%
The following characters count as two characters when used: ~ @ # % + = / \ \r\n
Receiving SMS Responses From Your Inbox
You may have replies that go into your Inbox sent to your server via the Forwarding option located on the left navigation of your clubtexting.com. You may specify a URL to send your responses to.
Receiving Inbox Message Replies API:
All replies to your inbox will be forwarding to the URL you specify. The Club Texting SMS Server will push received SMS messages by making an HTTP GET to the provided URL.
Example URL:
http://www.yourdomain.com/sms.phpExample Request Sent:
We will send an HTTP GET request to your server, using the parameters:
10 digit phone number message originated from. The body of receiving message that was texted in by the originating phone number. http://www.yourdomain.com/sms.php?from=5554443333&message=Hello%20World
Options:
Send unique request: Check this if you have both keyword URL and forwarding URLs setup and you do not wish to receive duplicate message forwards.
Wait for response from my server: If you require an incoming reply to have an auto-reply, select this option. We will send this response as an auto-reply via HTTP GET and charge 2 credits accordingly.The list of allowed characters for messages and subjects is: a-z, A-Z, 0-9 and these special characters: .,:;!?()~=+-_\/@$#&%
The following characters count as two characters when used: ~ @ # % + = / \ \r\n
Please note: If you have a keyword and both the keyword URL and forwarding URLs are setup with the same URL, you should click "Send Unique Request" so we only send one GET request.
Check Amount of Credits Via API:
The amount of credits check API may be accessed 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)
(Required) Your club Texting Username (Required) Your club Texting Password The following are the codes that a send message API call can return. Any negative codes represent unsuccessful attempts to check credits amount.
The amount of credits available Invalid user or password (make sure your account is API allowed) Unknown Error (please contact our support dept.)
Check Keyword Availability Via API: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)
(Required) Your club Texting Username (Required) Your club Texting Password Keyword (Required) The keyword to be checked The following are the codes that a send message API call can return. Any negative codes represent unsuccessful attempts to check keyword availability.
The keyword is available The keyword is not available Invalid user or password (make sure your account is API allowed) Unknown Error (please contact our support dept.)
Buy More Credits Via API:The credits purchasing 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)
(Required) Your club Texting Username (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 The following are the codes that a send message API call can return. Any negative codes represent unsuccessful attempts to buy credits.
The request is succeed The request is declined Invalid user or password (make sure your account is API allowed) Unknown Error (please contact our support dept.)
Rent a Keyword Via API:The keyword rent 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)
(Required) Your club Texting Username (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 Please note: After you rent a Keyword, you may want to update the default autoreply, which is 'Thank you for joining our list.'
The following are the codes that a send message API call can return. Any negative codes represent unsuccessful attempts to rent a keyword.
The request is succeed The keyword is not available The request is declined Invalid user or password (make sure your account is API allowed) Unknown Error (please contact our support dept.)
Setup a Keyword Via API:
The keyword setup 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)
(Required) Your Club Texting Username (Required) Your Club Texting Password Keyword (Required) Keyword that you want to setup 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 25827 will receive this message. Each confirmation return text that is sent back requires 2 credits. If you do not update this field, we will send out our default autoreply, 'Thank you for joining our list.' (Optional) We will forward incoming messages to the email address for free URL (Optional) We will call this URL when keyword is received The following are the codes that a send message API call can return. Any negative codes represent unsuccessful attempts to rent a keyword.
Updated Successfully Invalid user or password (make sure your account is API allowed) Invalid Keyword Invalid Group Name Invalid Email Invalid URL Unknown Error (please contact our support dept)
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)
(Required) Your club Texting Username (Required) Your club Texting Password Phonenumbers (Required) Array of 10 digit phone numbers to call to. (Optional) Name of the .wav file in your club Texting account (Optional) Address to the .wav file on your server Callerid (Required) 10 digit phone number 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).
The following are the codes that the voice broadcast API call can return. Any negative codes represent unsuccessful attempts to create broadcast.
Campaign Sent Invalid user or password (make sure your account is API allowed) Credit Limit Reached Invalid Callerid Invalid array of phone numbers Invalid Soundfile (make sure you provided the correct file name)
Invalid Soundsource (make sure you provided the correct path to the file) Invalid POST Request (make sure you use the correct names of variables)
Unknown Error
Developer Center
·Developer Center Home·Bulk SMS API Documentation
·Frequently Asked Questions
Code Examples
·C#
·Java
·Perl
·PHP
·Python
·Ruby
LIVE SALES & SUPPORT
(Monday to Friday, 9am - 7pm EST
Get Started With Our Text
Message Marketing Video
CLUB TEXTING CLIENTS
Read What Our Clients
Are Saying About Us!
CERTIFICATIONS
