REST API Docs (Via XML/JSON)

Note: Values must be properly URL encoded

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 88202 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&Groups[]=honey lovers&Subject=From Winnie&Message=I am a Bear of Very Little Brain, and long words bother me&StampToSend=1305582245' https://app.tellmycell.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>
        <Groups>
            <Group>Honey lovers</Group>
        </Groups>
    </Entry>
</Response>
                    

JSON Example And Response:

curl -d 'User=winnie&Password=the-pooh&PhoneNumbers[]=2123456785&PhoneNumbers[]=2123456786&PhoneNumbers[]=2123456787&PhoneNumbers[]=2123456788&Groups[]=honey lovers&Subject=From Winnie&Message=I am a Bear of Very Little Brain, and long words bother me&StampToSend=1305582245' https://app.tellmycell.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"
            ],
            "Groups":[
                "Honey lovers"
            ]
        }
    }
}                    

<?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>404</Code>
    <Errors>
        <Error>Sorry, nothing was found</Error>
    </Errors>
</Response>
                    

XML Example

curl -X DELETE -v 'https://app.tellmycell.com/incoming-messages/123?format=xml&User=winnie&Password=the-pooh'
						

HTTP/1.1 204 No Content
Date: Wed, 25 Jan 2012 16:13:51 GMT
Content-Length: 0
Content-Type: application/xml

                    

JSON Example

curl -X DELETE -v 'https://app.tellmycell.com/incoming-messages/123?format=json&User=winnie&Password=the-pooh'
						

HTTP/1.1 204 No Content
Date: Wed, 25 Jan 2012 16:15:19 GMT
Content-Length: 0
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

curl 'https://app.tellmycell.com/incoming-messages?format=xml&User=winnie&Password=the-pooh'
						

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>200</Code>
    <Entries>
        <Entry>
            <ID>123</ID>
            <PhoneNumber>3312943691</PhoneNumber>
            <Subject />
            <Message>test</Message>
            <New>0</New>
            <FolderID>13</FolderID>
            <ContactID />
            <ReceivedOn>10-04-2012 9:06 AM</ReceivedOn>
        </Entry>
        <Entry>
            <ID>124</ID>
            <PhoneNumber>5512943691</PhoneNumber>
            <Subject />
            <Message>test 2</Message>
            <New>1</New>
            <FolderID />
            <ContactID>506ae688734fad2125000001</ContactID>
            <ReceivedOn>10-04-2012 9:06 AM</ReceivedOn>
        </Entry>
    </Entries>
</Response>
                    

JSON Example

curl 'https://app.tellmycell.com/incoming-messages?format=json&User=winnie&Password=the-pooh'
						

{
    "Response":{
        "Status":"Success",
        "Code":200,
        "Entries":[
            {
                "ID":123,
                "PhoneNumber":"3312943691",
                "Subject":"",
                "Message":"test",
                "New":"0",
                "FolderID":"13",
                "ContactID":"",
                "ReceivedOn":"10-04-2012 9:06 AM"
           },
           {
                "ID":124,
                "PhoneNumber":"5512943691",
                "Subject":"",
                "Message":"test 2",
                "New":"1",
                "FolderID":"",
                "ContactID":"506ae688734fad2125000001",
                "ReceivedOn":"10-04-2012 9:06 AM"
           }
        ]
    }
}
                    

<?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>404</Code>
    <Errors>
        <Error>Sorry, nothing was found</Error>
    </Errors>
</Response>
                    

XML Example

curl 'https://app.tellmycell.com/incoming-messages/123?format=xml&User=winnie&Password=the-pooh'
						

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>200</Code>
    <Entry>
        <ID>123</ID>
        <PhoneNumber>3312943691</PhoneNumber>
        <Subject />
        <Message>test</Message>
        <New>0</New>
        <FolderID>13</FolderID>
        <ContactID />
        <ReceivedOn>10-04-2012 9:06 AM</ReceivedOn>
    </Entry>
</Response>
                    

JSON Example

curl 'https://app.tellmycell.com/incoming-messages/123?format=json&User=winnie&Password=the-pooh'
						

{
    "Response":{
        "Status":"Success",
        "Code":200,
        "Entry": {
            "ID":123,
            "PhoneNumber":"3312943691",
            "Subject":"",
            "Message":"test",
            "New":"0",
            "FolderID":"13",
            "ContactID":"",
            "ReceivedOn":"10-04-2012 9:06 AM"
        }
    }
}
                    

<?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>400</Code>
    <Errors>
        <Error>Sorry, wrong FolderID parameter</Error>
    </Errors>
</Response>
                    

XML Example

curl -d 'User=winnie&Password=the-pooh&ID[]=1&ID[]=2&FolderID=57' https://app.tellmycell.com/incoming-messages?format=xml
						

HTTP/1.1 200 OK
Date: Wed, 25 Jan 2012 16:13:51 GMT
Content-Length: 0
Content-Type: application/xml
                    

JSON Example

curl -d 'User=winnie&Password=the-pooh&ID[]=1&ID[]=2&FolderID=57' https://app.tellmycell.com/incoming-messages?format=json
						

HTTP/1.1 200 OK
Date: Wed, 25 Jan 2012 16:13:51 GMT
Content-Length: 0
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 version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Failure</Status>
    <Code>400</Code>
    <Errors>
        <Error>Missing folder name</Error>
    </Errors>
</Response>
                    

XML Example

curl -d 'User=winnie&Password=the-pooh&Name=Customers' https://app.tellmycell.com/messages-folders?format=xml
						

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>201</Code>
    <Entry>
        <ID>123</ID>
    </Entry>
</Response>
                    

JSON Example

curl -d 'User=winnie&Password=the-pooh&Name=Customers' https://app.tellmycell.com/messages-folders?format=json
						

{
    "Response":{
        "Status":"Success",
        "Code":201,
        "Entry":{
            "ID":123,
        }
    }
}
                    

<?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>400</Code>
    <Errors>
        <Error>Missing folder name</Error>
    </Errors>
</Response>
                    

XML Example

curl -d 'User=winnie&Password=the-pooh&Name=Customers' https://app.tellmycell.com/messages-folders/123?format=xml
						

HTTP/1.1 200 OK
Date: Wed, 25 Jan 2012 16:13:51 GMT
Content-Length: 0
Content-Type: application/xml

                    

JSON Example

curl -d 'User=winnie&Password=the-pooh&Name=Customers' https://app.tellmycell.com/messages-folders/123?format=json
						

HTTP/1.1 200 OK
Date: Wed, 25 Jan 2012 16:15:19 GMT
Content-Length: 0
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 version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Failure</Status>
    <Code>404</Code>
    <Errors>
        <Error>Sorry, nothing was found</Error>
    </Errors>
</Response>
                    

XML Example

curl -X DELETE -v 'https://app.tellmycell.com/messages-folders/123?format=xml&User=winnie&Password=the-pooh'
						

HTTP/1.1 204 No Content
Date: Wed, 25 Jan 2012 16:13:51 GMT
Content-Length: 0
Content-Type: application/xml

                    

JSON Example

curl -X DELETE -v 'https://app.tellmycell.com/messages-folders/123?format=json&User=winnie&Password=the-pooh'
						

HTTP/1.1 204 No Content
Date: Wed, 25 Jan 2012 16:15:19 GMT
Content-Length: 0
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

curl 'https://app.tellmycell.com/messages-folders?format=xml&User=winnie&Password=the-pooh'
						

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>200</Code>
    <Entries>
        <Entry>
            <ID>1</ID>
            <Name>Customers</Name>
        </Entry>
        <Entry>
            <ID>2</ID>
            <Name>Fans</Name>
        </Entry>
    </Entries>
</Response>
                    

JSON Example

curl 'https://app.tellmycell.com/messages-folders?format=json&User=winnie&Password=the-pooh'
						

{
    "Response":{
        "Status":"Success",
        "Code":200,
        "Entries":[
            {
                "ID":1,
                "Name":"Customers"
            },
            {
                "ID":2,
                "Name":"Fans"
            }
        ]
    }
}
                    

<?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>404</Code>
    <Errors>
        <Error>Sorry, nothing was found</Error>
    </Errors>
</Response>
                    

XML Example

curl 'https://app.tellmycell.com/messages-folders/123?format=xml&User=winnie&Password=the-pooh'
						

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>200</Code>
    <Entry>
        <Name>Customers</Name>
    </Entry>
</Response>
                    

JSON Example

curl 'https://app.tellmycell.com/messages-folders/123?format=json&User=winnie&Password=the-pooh'
						

{
    "Response":{
        "Status":"Success",
        "Code":200,
        "Entry":{
            "Name":"Customers"
        }
    }
}
                    

<?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.tellmycell.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.tellmycell.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 Credit Card)

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

XML Example
(Non-Stored Credit 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=New York&Zip=12345&Country=US&CreditCardTypeID=Visa&Number=4111111111111111&SecurityCode=123&ExpirationMonth=10&ExpirationYear=2017' https://app.tellmycell.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.tellmycell.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=New York&Zip=12345&Country=US&CreditCardTypeID=Visa&Number=4111111111111111&SecurityCode=123&ExpirationMonth=10&ExpirationYear=2017' https://app.tellmycell.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.tellmycell.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.tellmycell.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.tellmycell.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.tellmycell.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.tellmycell.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.tellmycell.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 Credit Card):

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

XML Example
(Non-Stored Credit 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=New York&Zip=12345&Country=US&CreditCardTypeID=Visa&Number=4111111111111111&SecurityCode=123&ExpirationMonth=10&ExpirationYear=2017' https://app.tellmycell.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 Credit Card):

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

JSON Example
(Non-Stored Credit 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=New York&Zip=12345&Country=US&CreditCardTypeID=Visa&Number=4111111111111111&SecurityCode=123&ExpirationMonth=10&ExpirationYear=2017' https://app.tellmycell.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
        }
    }
}
                    

<?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>PhoneNumber: '(123)45-67' contains characters which are not digits</Error>
        <Error>FirstName: 'A Very Small Animal' is more than 10 characters long</Error>
        <Error>Email: 'piglet@small-animals-alliance' is not a valid email address</Error>
    </Errors>
</Response>
                    

XML Example

curl -d 'User=winnie&Password=the-pooh&PhoneNumber=2123456785&FirstName=Piglet&Email=piglet@small-animals-alliance.org &Note=It is hard to be brave, when you are only a Very Small Animal.&Groups[]=Friends&Groups[]=Neighbors' https://app.tellmycell.com/contacts?format=xml
						

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>201</Code>
    <Entry>
        <ID>4f0b52fd734fada068000000</ID>
        <PhoneNumber>2123456785</PhoneNumber>
        <FirstName>Piglet</FirstName>
        <LastName />
        <Email>piglet@small-animals-alliance.org</Email>
        <Note>It is hard to be brave, when you are only a Very Small Animal.</Note>
        <Source>API</Source>
        <Groups>
            <Group>Friends</Group>
            <Group>Neighbors</Group>
        </Groups>
        <CreatedAt>01-17-2012</CreatedAt>
    </Entry>
</Response>
                    

JSON Example

curl -d 'User=winnie&Password=the-pooh&PhoneNumber=2123456785&FirstName=Piglet&Email=piglet@small-animals-alliance.org &Note=It is hard to be brave, when you are only a Very Small Animal.&Groups[]=Friends&Groups[]=Neighbors' https://app.tellmycell.com/contacts?format=json
						

{
    "Response":{
        "Status":"Success",
        "Code":201,
        "Entry":{
            "ID":4f0b52fd734fada068000000,
            "PhoneNumber":"2123456785",
            "FirstName":"Piglet",
            "LastName":"",
            "Email":"piglet@small-animals-alliance.org",
            "Note":"It is hard to be brave, when you are only a Very Small Animal.",
            "Source":"API",
            "Groups":[
                "Friends",
                "Neighbors"
            ],
            "CreatedAt":"01-17-2012"
        }
    }
}
                    

<?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>PhoneNumber: '(123)45-67' contains characters which are not digits</Error>
        <Error>FirstName: 'A Very Small Animal' is more than 10 characters long</Error>
        <Error>Email: 'piglet@small-animals-alliance' is not a valid email address</Error>
    </Errors>
</Response>
                    

XML Example

curl -d 'User=winnie&Password=the-pooh&PhoneNumber=2123456785&FirstName=Piglet&Email=piglet@small-animals-alliance.org &Note=It is hard to be brave, when you are only a Very Small Animal.&Groups[]=Friends&Groups[]=Neighbors' https://app.tellmycell.com/contacts/4f0b5720734fada368000000?format=xml
						

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>200</Code>
    <Entry>
        <ID>4f0b5720734fada368000000</ID>
        <PhoneNumber>2123456785</PhoneNumber>
        <FirstName>Piglet</FirstName>
        <LastName />
        <Email>piglet@small-animals-alliance.org</Email>
        <Note>It is hard to be brave, when you are only a Very Small Animal.</Note>
        <Source>API</Source>
        <Groups>
            <Group>Friends</Group>
            <Group>Neighbors</Group>
        </Groups>
        <CreatedAt>01-17-2012</CreatedAt>
    </Entry>
                    

JSON Example

curl -d 'User=winnie&Password=the-pooh&PhoneNumber=2123456785&FirstName=Piglet&Email=piglet@small-animals-alliance.org &Note=It is hard to be brave, when you are only a Very Small Animal.&Groups[]=Friends&Groups[]=Neighbors' https://app.tellmycell.com/contacts/4f0b5720734fada368000000?format=json
						

{
    "Response":{
        "Status":"Success",
        "Code":200,
        "Entry":{
            "ID":4f0b5720734fada368000000,
            "PhoneNumber":"2123456785",
            "FirstName":"Piglet",
            "LastName":"",
            "Email":"piglet@small-animals-alliance.org",
            "Note":"It is hard to be brave, when you are only a Very Small Animal.",
            "Source":"API",
            "Groups":[
                "Friends",
                "Neighbors"
            ],
            "CreatedAt":"01-17-2012"
        }
    }
}
                    

<?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

curl -X DELETE -v 'https://app.tellmycell.com/contacts/4f0b52fd734fada068000000?format=xml&User=winnie&Password=the-pooh'
						

HTTP/1.1 204 No Content
Date: Mon, 09 Jan 2012 22:05:11 GMT
Content-Length: 0
Connection: close
Content-Type: application/xml
                    

JSON Example

curl -X DELETE -v 'https://app.tellmycell.com/contacts/4f0b52fd734fada068000000?format=json&User=winnie&Password=the-pooh'
						

HTTP/1.1 204 No Content
Date: Mon, 09 Jan 2012 22:10:11 GMT
Content-Length: 0
Connection: close
Content-Type: application/json
                    

Note: The return value OptOut is only provided for contacts that are opted out. If a contact is opted out, this value will be True.

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

XML Example

curl 'https://app.tellmycell.com/contacts?format=xml&User=winnie&Password=the-pooh'
						

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>200</Code>
    <Entries>
        <Entry>
            <ID>4f0b52fd734fada068000000</ID>
            <PhoneNumber>2123456785</PhoneNumber>
            <FirstName>Piglet</FirstName>
            <LastName />
            <Email>piglet@small-animals-alliance.org</Email>
            <Note>It is hard to be brave, when you are only a Very Small Animal.</Note>
            <Source>API</Source>
            <OptOut>true</OptOut>
            <Groups>
                <Group>Friends</Group>
                <Group>Neighbors</Group>
            </Groups>
            <CreatedAt>01-17-2012</CreatedAt>
        </Entry>
        <Entry>
            <ID>4f0b536c734fad9968000000</ID>
            <PhoneNumber>2123456786</PhoneNumber>
            <FirstName>Winnie</FirstName>
            <LastName>T. Pooh</LastName>
            <Email>winnie@weightwatchers.com</Email>
            <Note>A bear, however hard he tries, grows tubby without exercise</Note>
            <Source>Upload</Source>
            <Groups />
            <CreatedAt>01-15-2012</CreatedAt>
        </Entry>
    </Entries>
</Response>
                    

JSON Example

curl 'https://app.tellmycell.com/contacts?format=json&User=winnie&Password=the-pooh'
						

{
    "Response":{
        "Status":"Success",
        "Code":200,
        "Entries":[
            {
                "ID":4f0b52fd734fada068000000,
                "PhoneNumber":"2123456785",
                "FirstName":"Piglet",
                "LastName":"",
                "Email":"piglet@small-animals-alliance.org",
                "Note":"It is hard to be brave, when you are only a Very Small Animal.",
                "Source":"API",
                "OptOut":true,
                "Groups":[
                    "Friends",
                    "Neighbors"
                ],
                "CreatedAt":"01-17-2012"
           },
           {
                "ID":4f0b536c734fad9968000000,
                "PhoneNumber":"2123456786",
                "FirstName":"Winnie",
                "LastName":"T. Pooh",
                "Email":"winnie@weightwatchers.com",
                "Note":"A bear, however hard he tries, grows tubby without exercise",
                "Source":"Upload",
                "Groups":[
                ],
                "CreatedAt":"01-15-2012"
           }
        ]
    }
}
                    

Note: The return value OptOut is only provided for contacts that are opted out. If a contact is opted out, this value will be 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>Sorry, nothing was found</Error>
    </Errors>
</Response>
                    

XML Example

curl 'https://app.tellmycell.com/contacts/4f0b52fd734fada068000000?format=xml&User=winnie&Password=the-pooh'
						

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>200</Code>
    <Entry>
        <ID>4f0b52fd734fada068000000</ID>
        <PhoneNumber>2123456785</PhoneNumber>
        <FirstName>Piglet</FirstName>
        <LastName />
        <Email>piglet@small-animals-alliance.org</Email>
        <Note>It is hard to be brave, when you are only a Very Small Animal.</Note>
        <Source>API</Source>
        <OptOut>true</OptOut>
        <Groups>
            <Group>Friends</Group>
            <Group>Neighbors</Group>
        </Groups>
        <CreatedAt>01-17-2012</CreatedAt>
    </Entry>
</Response>
                    

JSON Example

curl 'https://app.tellmycell.com/contacts/4f0b52fd734fada068000000?format=json&User=winnie&Password=the-pooh'
						

{
    "Response":{
        "Status":"Success",
        "Code":200,
        "Entry":{
            "ID":4f0b52fd734fada068000000,
            "PhoneNumber":"2123456785",
            "FirstName":"Piglet",
            "LastName":"",
            "Email":"piglet@small-animals-alliance.org",
            "Note":"It is hard to be brave, when you are only a Very Small Animal.",
            "Source":"API",
            "OptOut":true,
            "Groups":[
                "Friends",
                "Neighbors"
            ],
            "CreatedAt":"01-17-2012"
        }
    }
}
                    

<?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>Name: &apos;Small Animals&apos; is more than 12 characters long</Error>
    </Errors>
</Response>
                    

XML Example

curl -d 'User=winnie&Password=the-pooh&Name=Tubby Bears&Note=A bear, however hard he tries, grows tubby without exercise' https://app.tellmycell.com/groups?format=xml
						

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>201</Code>
    <Entry>
        <ID>162467</ID>
        <Name>Tubby Bears</Name>
        <Note>A bear, however hard he tries, grows tubby without exercise</Note>
        <ContactCount>0</ContactCount>
    </Entry>
</Response>
                    

JSON Example

curl -d 'User=winnie&Password=the-pooh&Name=Tubby Bears&Note=A bear, however hard he tries, grows tubby without exercise' https://app.tellmycell.com/groups?format=json
						

{
    "Response":{
        "Status":"Success",
        "Code":201,
        "Entry":{
            "ID":162467,
            "Name":"Tubby Bears",
            "Note":"A bear, however hard he tries, grows tubby without exercise",
            "ContactCount":0
        }
    }
}
                    

<?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>Name: &apos;Small Animals&apos; is more than 12 characters long</Error>
    </Errors>
</Response>
                    

XML Example

curl -d 'User=winnie&Password=the-pooh&Name=Tubby Bears&Note=A bear, however hard he tries, grows tubby without exercise' https://app.tellmycell.com/groups/162467?format=xml
						

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>200</Code>
    <Entry>
        <ID>162467</ID>
        <Name>Tubby Bears</Name>
        <Note>A bear, however hard he tries, grows tubby without exercise</Note>
        <ContactCount>3</ContactCount>
    </Entry>
</Response>
                    

JSON Example

curl -d 'User=winnie&Password=the-pooh&Name=Tubby Bears&Note=A bear, however hard he tries, grows tubby without exercise' https://app.tellmycell.com/groups/162467?format=json
						

{
    "Response":{
        "Status":"Success",
        "Code":200,
        "Entry":{
            "ID":162467,
            "Name":"Tubby Bears",
            "Note":"A bear, however hard he tries, grows tubby without exercise",
            "ContactCount":3
        }
    }
}
                    

<?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

curl -X DELETE -v 'https://app.tellmycell.com/groups/162467?format=xml&User=winnie&Password=the-pooh'
						

HTTP/1.1 204 No Content
Date: Wed, 25 Jan 2012 16:13:51 GMT
Content-Length: 0
Content-Type: application/xml
                    

JSON Example

curl -X DELETE -v 'https://app.tellmycell.com/groups/162467?format=json&User=winnie&Password=the-pooh'
						

HTTP/1.1 204 No Content
Date: Wed, 25 Jan 2012 16:15:19 GMT
Content-Length: 0
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

curl 'https://app.tellmycell.com/groups?format=xml&User=winnie&Password=the-pooh'
						

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>200</Code>
    <Entries>
        <Entry>
            <ID>127012</ID>
            <Name>Honey lovers</Name>
            <Note />
            <ContactCount>0</ContactCount>
        </Entry>
        <Entry>
            <ID>162467</ID>
            <Name>Tubby Bears</Name>
            <Note>A bear, however hard he tries, grows tubby without exercise</Note>
            <ContactCount>3</ContactCount>
        </Entry>
    </Entries>
</Response>
                    

JSON Example

curl 'https://app.tellmycell.com/contacts?format=json&User=winnie&Password=the-pooh'
						

{
    "Response":{
        "Status":"Success",
        "Code":200,
        "Entries":[
            {
                "ID":127012,
                "Name":"Honey lovers",
                "Note":"",
                "ContactCount":0
            },
            {
                "ID":162467,
                "Name":"Tubby Bears",
                "Note":"A bear, however hard he tries, grows tubby without exercise",
                "ContactCount":3
            }
        ]
    }
}
                    

<?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

curl 'https://app.tellmycell.com/groups/162467?format=xml&User=winnie&Password=the-pooh'
						

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Status>Success</Status>
    <Code>200</Code>
    <Entry>
        <ID>162467</ID>
        <Name>Tubby Bears</Name>
        <Note>A bear, however hard he tries, grows tubby without exercise</Note>
        <ContactCount>3</ContactCount>
    </Entry>
</Response>
                    

JSON Example

curl 'https://app.tellmycell.com/groups/162467?format=json&User=winnie&Password=the-pooh'
						

{
    "Response":{
        "Status":"Success",
        "Code":200,
        "Entry":{
            "ID":162467,
            "Name":"Tubby Bears",
            "Note":"A bear, however hard he tries, grows tubby without exercise",
            "ContactCount":3
        }
    }
}