REST API Documentation

Note: Values must be properly URL encoded

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 please text Your Keyword to 25827 (212121 In Canada) using that phone.

  <?xml version="1.0" encoding="UTF-8"?>
  <Response>
      <Status>Failure</Status>
      <Code>401</Code>
      <Errors>
          <Error>Authorization Required</Error>
      </Errors>
  </Response>
                

  <?xml version="1.0" encoding="UTF-8"?>
  <Response>
      <Status>Failure</Status>
      <Code>403</Code>
      <Errors>
          <Error>PhoneNumbers: '(123)45-67' contains characters which are not digits</Error>
          <Error>Subject: Your subject must be under 13 characters.</Error>
          <Error>Message: Your message contains characters that are not supported.</Error>
      </Errors>
  </Response>
                

XML Example And Response:

curl -d   'user=winnie&password=the-pooh&PhoneNumbers[]=2123456785&PhoneNumbers[]=2123456786&PhoneNumbers[]=2123456787&PhoneNumbers[]=2123456788&Subject=From   Winnie&Message=I am a Bear of Very Little Brain, and long words  bother me&StampToSend=1305582245' https://app.clubtexting.com/sending/messages?format=xml
                  		

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>201</Code>
    <Entry>
        <ID>6419</ID>
        <Subject>From Winnie</Subject>
        <Message>I am a Bear of Very Little Brain, and long words bother me</Message>
        <MessageTypeID>1</MessageTypeID>
        <RecipientsCount>3</RecipientsCount>
        <Credits>6</Credits>
        <StampToSend>05-16-2011 5:44 PM</StampToSend>
        <PhoneNumbers>
            <PhoneNumber>2123456787</PhoneNumber>
            <PhoneNumber>2123456788</PhoneNumber>
        </PhoneNumbers>
        <LocalOptOuts>
            <PhoneNumber>2123456786</PhoneNumber>
        </LocalOptOuts>
        <GlobalOptOuts>
            <PhoneNumber>2123456785</PhoneNumber>
        </GlobalOptOuts>
    </Entry>
</Response>
                

JSON Example And Response:

curl -d   'User=winnie&Password=the-pooh&PhoneNumbers[]=2123456785&PhoneNumbers[]=2123456786&PhoneNumbers[]=2123456787&PhoneNumbers[]=2123456788&Subject=From   Winnie&Message=I am a Bear of Very Little Brain, and long words   bother me&StampToSend=1305582245' https://app.clubtexting.com/sending/messages?format=json
						

{
    "Response":{
        "Status":"Success",
        "Code":201,
        "Entry":{
            "ID":6417853,
            "Subject":"From Winnie",
            "Message":"I am a Bear of Very Little Brain, and long words bother me.",
            "MessageTypeID":1,
            "RecipientsCount":3,
            "Credits":6,
            "StampToSend":"05-16-2011 5:44 PM",
            "PhoneNumbers":[
                "2123456787",
                "2123456788" 
            ],
            "LocalOptOuts":[
                "2123456786" 
            ],
            "GlobalOptOuts":[
                "2123456785" 
            ]
        }
    }
}
                

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Failure</Status>
    <Code>401</Code>
    <Errors>
        <Error>Authorization Required</Error>
    </Errors>
</Response>
                

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Failure</Status>
    <Code>403</Code>
    <Errors>
        <Error>Keyword: Keywords can not contain spaces or the following characters: ?, @, ., !, [, ], {, }, -, +, #, $, %, &amp;, &apos;, (, ), *, /, \, :, ;, &lt;, &gt;, =, ^, `, |, ~</Error>
    </Errors>
</Response>
                

XML Example And Response:

curl "https://app.clubtexting.com/keywords/new?Keyword=honey&User=winnie&Password=the-pooh&format=xml"
                  		

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>200</Code>
    <Entry>
        <Keyword>honey</Keyword>
        <Available>1</Available>
    </Entry>
</Response>
                

JSON Example And Response:

curl "https://app.clubtexting.com/keywords/new?Keyword=honey&User=winnie&Password=the-pooh&format=json"
						

{
    "Response":{
        "Status":"Success",
        "Code":200,
        "Entry":{
            "Keyword":"honey",
            "Available":true
        }
    }
}
                

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Failure</Status>
    <Code>401</Code>
    <Errors>
        <Error>Authorization Required</Error>
    </Errors>
</Response>
                

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Failure</Status>
    <Code>403</Code>
    <Errors>
        <Error>Keyword: Keywords can not contain spaces or the following characters: ?, @, ., !, [, ], {, }, -, +, #, $, %, &amp;, &apos;, (, ), *, /, \, :, ;, &lt;, &gt;, =, ^, `, |, ~</Error>
        <Error>FirstName: Value is required and can't be empty</Error>
        <Error>LastName: Value is required and can't be empty</Error>
        <Error>Number: '123456' contains an invalid amount of digits</Error>
    </Errors>
</Response>
                

XML Example
(Stored Card):

curl -d 'User=winnie&Password=the-pooh&Keyword=honey&StoredCreditCard=1111' https://app.clubtexting.com/keywords?format=xml
						  

XML Example
( Non-Stored Card):

curl -d 'User=winnie&Password=the-pooh&Keyword=honey&FirstName=Winnie&LastName=The Pooh&Street=Hollow tree, under the name of Mr. Sanders&City=Hundred Acre Woods&State=East Sussex&Zip=12345&Country=UK&CreditCardTypeID=Visa&Number=4111111111111111&SecurityCode=123&ExpirationMonth=10&ExpirationYear=2017' https://app.clubtexting.com/keywords?format=xml
						

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>201</Code>
    <Entry>
        <ID>147258369</ID>
        <Keyword>honey</Keyword>
        <EnableDoubleOptIn>0</EnableDoubleOptIn>
        <ConfirmMessage>Reply Y to join</ConfirmMessage>
        <JoinMessage>Thank you for joining our list</JoinMessage>
        <ForwardEmail />
        <ForwardUrl />
        <ContactGroupIDs />
    </Entry>
</Response>
                

JSON Example
(Stored Card):

curl -d 'User=winnie&Password=the-pooh&Keyword=honey&StoredCreditCard=1111' https://app.clubtexting.com/keywords?format=json
						  

JSON Example
(Non-Stored Card):

curl -d 'User=winnie&Password=the-pooh&Keyword=honey&FirstName=Winnie&LastName=The Pooh&Street=Hollow tree, under the name of Mr. Sanders&City=Hundred Acre Woods&State=East Sussex&Zip=12345&Country=UK&CreditCardTypeID=Visa&Number=4111111111111111&SecurityCode=123&ExpirationMonth=10&ExpirationYear=2017' https://app.clubtexting.com/keywords?format=json
						

{
    "Response":{
        "Status":"Success",
        "Code":201,
        "Entry":{
            "ID":147258369,
            "Keyword":"honey",
            "EnableDoubleOptIn":false,
            "ConfirmMessage":"Reply Y to join",
            "JoinMessage":"Thank you for joining our list",
            "ForwardEmail":"",
            "ForwardUrl":"",
            "ContactGroupIDs":[]
        }
    }
}
                

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Failure</Status>
    <Code>401</Code>
    <Errors>
        <Error>Authorization Required</Error>
    </Errors>
</Response>
                

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Failure</Status>
    <Code>403</Code>
    <Errors>
        <Error>JoinMessage: Value is required and can't be empty</Error>
        <Error>ForwardEmail: 'honey@bear-alliance' is not a valid email address</Error>
        <Error>ForwardUrl: 'bear-alliance.co.uk/honey-donations' is not a valid URI</Error>
    </Errors>
</Response>
                

XML Example And Response:

curl -d 'User=winnie&Password=the-pooh&EnableDoubleOptIn=1&ConfirmMessage=Reply Y to join our sweetest list&JoinMessage=The only reason for being a bee that I know of, is to make honey. And the only reason for making honey, is so as I can eat it.&ForwardEmail=honey@bear-alliance.co.uk &ForwardUrl=http://bear-alliance.co.uk/honey-donations/&ContactGroupIDs[]=honey lovers' https://app.clubtexting.com/keywords/honey?format=xml
		          

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>200</Code>
    <Entry>
        <ID>147258369</ID>
        <Keyword>honey</Keyword>
        <EnableDoubleOptIn>1</EnableDoubleOptIn>
        <ConfirmMessage>Reply Y to join our sweetest list</ConfirmMessage>
        <JoinMessage>The only reason for being a bee that I know of, is to make honey. And the only reason for making honey, is so as I can eat it.</JoinMessage>
        <ForwardEmail>honey@bear-alliance.co.uk</ForwardEmail>
        <ForwardUrl>http://bear-alliance.co.uk/honey-donations/</ForwardUrl>
        <ContactGroupIDs>
            <Group>honey lovers</Group>
        </ContactGroupIDs>
    </Entry>
</Response>
                

JSON Example And Response:

curl -d 'User=winnie&Password=the-pooh&EnableDoubleOptIn=1&ConfirmMessage=Reply Y to join our sweetest list&JoinMessage=The only reason for being a bee that I know of, is to make honey. And the only reason for making honey, is so as I can eat it.&ForwardEmail=honey@bear-alliance.co.uk &ForwardUrl=http://bear-alliance.co.uk/honey-donations/&ContactGroupIDs[]=honey lovers' https://app.clubtexting.com/keywords/honey?format=json
						

{
    "Response":{
        "Status":"Success",
        "Code":200,
        "Entry":{
            "ID":147258369,
            "Keyword":"honey",
            "EnableDoubleOptIn":true,
            "ConfirmMessage":"Reply Y to join our sweetest list",
            "JoinMessage":"The only reason for being a bee that I know of, is to make honey. And the only reason for making honey, is so as I can eat it.",
            "ForwardEmail":"honey@bear-alliance.co.uk",
            "ForwardUrl":"http://bear-alliance.co.uk/honey-donations/",
            "ContactGroupIDs":[
                "honey lovers" 
            ]
        }
    }
}
                

Note: There are no return values for this API!

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Failure</Status>
    <Code>401</Code>
    <Errors>
        <Error>Authorization Required</Error>
    </Errors>
</Response>
                

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Failure</Status>
    <Code>403</Code>
    <Errors>
        <Error>Sorry, nothing was found</Error>
    </Errors>
</Response>
                

XML Example And Response:

curl -X DELETE "https://app.clubtexting.com/keywords/honey?format=xml&User=winnie&Password=the-pooh"
		          

HTTP/1.1 204 No Content
Date: Fri, 10 Jun 2011 17:03:19 GMT
Content-Length: 0
Connection: close
Content-Type: application/xml
                

JSON Example And Response:

curl -X DELETE "https://app.clubtexting.com/keywords/honey?format=json&User=winnie&Password=the-pooh"
		          

HTTP/1.1 204 No Content
Date: Fri, 10 Jun 2011 17:05:14 GMT
Content-Length: 0
Connection: close
Content-Type: application/json
                

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Failure</Status>
    <Code>401</Code>
    <Errors>
        <Error>Authorization Required</Error>
    </Errors>
</Response>
                

XML Example And Response:

curl "https://app.clubtexting.com/billing/credits/get?User=winnie&Password=the-pooh&format=xml"
			      

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>200</Code>
    <Entry>
        <PlanCredits>15</PlanCredits>
        <AnytimeCredits>138</AnytimeCredits>
        <TotalCredits>153</TotalCredits>
    </Entry>
</Response>
                

JSON Example And Response:

curl "https://app.clubtexting.com/billing/credits/get?User=winnie&Password=the-pooh&format=json"					
				  

{
    "Response":{
        "Status":"Success",
        "Code":200,
        "Entry":{
            "PlanCredits":15,
            "AnytimeCredits":138,
            "TotalCredits":153
        }
    }
}
                

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Failure</Status>
    <Code>401</Code>
    <Errors>
        <Error>Authorization Required</Error>
    </Errors>
</Response>
                

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Failure</Status>
    <Code>403</Code>
    <Errors>
        <Error>NumberOfCredits: '10,000' contains characters which are not digits</Error>
        <Error>FirstName: Value is required and can't be empty</Error>
        <Error>LastName: Value is required and can't be empty</Error>
        <Error>Number: '123456' contains an invalid amount of digits</Error>
    </Errors>
</Response>
                

XML Example
(Stored Card):

curl -d 'User=winnie&Password=the-pooh&NumberOfCredits=1000&StoredCreditCard=1111' https://app.clubtexting.com/billing/credits?format=xml
						  

XML Example
(Non-Stored Card):

curl -d 'User=winnie&Password=the-pooh&NumberOfCredits=1000&FirstName=Winnie&LastName=The Pooh&Street=Hollow tree, under the name of Mr. Sanders&City=Hundred Acre Woods&State=East Sussex&Zip=12345&Country=UK&CreditCardTypeID=Visa&Number=4111111111111111&SecurityCode=123&ExpirationMonth=10&ExpirationYear=2017' https://app.clubtexting.com/billing/credits?format=xml
						

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>201</Code>
    <Entry>
        <BoughtCredits>1000</BoughtCredits>
        <Amount>9.45</Amount>
        <Discount>0.55</Discount>
        <PlanCredits>10</PlanCredits>
        <AnytimeCredits>1200</AnytimeCredits>
        <TotalCredits>1210</TotalCredits>
    </Entry>
</Response>
                

JSON Example
(Stored Card):

curl -d 'User=winnie&Password=the-pooh&NumberOfCredits=1000&StoredCreditCard=1111' https://app.clubtexting.com/billing/credits?format=json
						  

JSON Example
(Non-Stored Card):

curl -d 'User=winnie&Password=the-pooh&NumberOfCredits=1000&FirstName=Winnie&LastName=The Pooh&Street=Hollow tree, under the name of Mr. Sanders&City=Hundred Acre Woods&State=East Sussex&Zip=12345&Country=UK&CreditCardTypeID=Visa&Number=4111111111111111&SecurityCode=123&ExpirationMonth=10&ExpirationYear=2017' https://app.clubtexting.com/billing/credits?format=json
						

{
    "Response":{
        "Status":"Success",
        "Code":201,
        "Entry":{
            "BoughtCredits":1000,
            "Amount":9.45,
            "Discount":0.55,
            "PlanCredits":10,
            "AnytimeCredits":1200,
            "TotalCredits":1210
        }
    }
}