ClickSend REST API

This is the official API documentation for ClickSend.com Below you will find a current list of the available methods for clicksend. NOTE : You will need to create a free account to use the API. You can [ Register Here ](https://dashboard.clicksend.com/ /signup/step1/). API URL The API should always be accessed over SSL. Base URL: https://rest.clicksend.com/v3/ Authentication Basic HTTP authentication should be used in the header. Either: username : Your API username password : Your API key You can get your API credentials by clicking 'API Credentials' on the top right of the dashboard. OR username : Your account username password : Your account password These are the same credentials that you use to login to the dashboard. Authorization Header The Authorization header is constructed as follows: 1. Username and password are combined into a string username:password 1. The resulting string is then encoded using Base64 encoding 1. The authorization method and a space i.e. "Basic " is then put before the encoded string. For example, if the user uses Aladdin as the username and open sesame as the password then the header is formed as follows: Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== PHP Authentication Header Example (using cURL) curl setopt($ch, CURLOPT HTTPHEADER, ['Authorization: Basic ' . base64 encode("$username:$password")]); Verbs The API uses restful verbs. Verb Description --- --- GET Select one or more items. Success returns 200 status code. POST Create a new item. Success returns 200 status code. PUT Update an item. Success returns 200 status code. DELETE Delete an item. Success returns 200 status code. Status Codes The API will respond with one of the following HTTP status codes. Code Response Description --- --- --- 200 SUCCESS Request completed successfully. 400 BAD REQUEST The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 401 UNAUTHORIZED Authentication credentials were missing or incorrect. 403 FORBIDDEN The request is understood, but it has been refused or access is not allowed. An accompanying error message will explain why. 404 NOT FOUND The URI requested is invalid or the resource requested does not exists. 405 NOT FOUND Method doesn't exist or is not allowed. 429 TOO MANY REQUESTS Rate Limit Exceeded. Returned when a request cannot be served due to the application’s rate limit having been exhausted for the resource. See Rate Limiting. 500 INTERNAL SERVER ERROR Something is broken Application Status Codes The following status codes can be returned in addition to the HTTP status code. For example, when using the Send SMS endpoint: Response Description --- --- SUCCESS Message added to queue OK. Use delivery reports to get an update on the delivery status. MISSING CREDENTIALS Not enough information has been supplied for authentication. Please ensure that your Username and Unique Key are supplied in your request. ACCOUNT NOT ACTIVATED Your account has not been activated. INVALID RECIPIENT The destination mobile number is invalid. THROTTLED Identical message body recently sent to the same recipient. Please try again in a few seconds. INVALID SENDER ID Invalid Sender ID. Please ensure Sender ID is no longer than 11 characters (if alphanumeric), and contains no spaces. INSUFFICIENT CREDIT You have reached the end of your message credits. You will need to purchase more message credits. INVALID CREDENTIALS Your Username or Unique Key is incorrect. ALREADY EXISTS The resource you're trying to add already exists. EMPTY MESSAGE Message is empty. TOO MANY RECIPIENTS Too many recipients. MISSING REQUIRED FIELDS Some required fields are missing. INVALID SCHEDULE The schedule specified is invalid. Use a unix timestamp e.g. 1429170372. NOT ENOUGH PERMISSION TO LIST ID Don't have enough privilege to access or send to a list id. INTERNAL ERROR Internal error. INVALID LANG An invalid language option has been provided. INVALID VOICE An invalid voice (gender) option has…