Here's a summary of the different calls available, if you are building y= our own client.
| Resource | Method | Action |
|---|---|---|
| sms&= nbsp; | POST | Send an SMS |
| sm= s/<scheduledID> | DELETE | Delete a previously scheduled SMS |
| a= ccount | GET | Retrieve account details on your own account |
| a= ccount/<account ID> | GET | Retrieve account details on your own account = or an account you created |
| a= ccount/sub | PUT | Create a sub-account |
| = account | POST | Modify account details |
| c= redits | GET | Get the number of credits on the account <= /td> |
| = credits | POST | Transfer a number of credits to another accou= nt |
| deliveryReports | GET | Get a list of delivery reports available <= /td> |
| deliveryReport/<name> | GET 1 | Get the contents of a delivery report whose n= ame is '<name>'. Using a name of 'all' retrieves all reports. |
| deliveryReport/<name>/<from>/<to> | GET | Same as 1 above, but for specific dates/times |
| deliveryReport/<name>/custom/<tag> | GET 2 | Same as 1 above, but restricts results to a s= pecific custom string tag (specified when you send the SMS) |
| GET | Same as 2 above, but for specific dates/times | |
| = keywords/<keyword> | GET | Check the availability of the keyword '<ke= yword>' |
| gr= oups | GET | Get a list of the available send groups |
| gr= oup/<group name or ID> | POST | Add number(s) to a given send group |
| gro= up/<group name or ID> | PUT | Create a group with the given name |
| gro= up/<group name or ID> | GET | Get group details including numbers in a group |
The API is accessed at the following URL (and alternatively withou= t SSL):
https://api.textmarketer.co.uk/se= rvices/rest/<resource (see table)>
=20
e.g., the credits resource can be accessed via the URL:
https://ap= i.textmarketer.co.uk/services/rest/credits
=20
There is also a sand= box service available via the URL (not available via SSL/https):
http://sandbox.textmarketer.biz/s= ervices/rest/
=20
See more about here.
Authentication is handled by passing your API username/password as GET/P= OST arguments, or you can use HTTP Basic= Authentication.
See more on Authentication.