Send SMS (v1)

The HTTP API enables you to send SMS quickly. To send an SMS, simply call the following URL with the relevant parameters appended to the URL, as shown below:

https://sms.textcus.com/api/send?destination={recipient}&source={sender}&dlr={0}&type={0}&message={message}

NB: Please remove the curly bracket in the URL when testing

API v1.0 has been discontinued and will no longer be supported. Please use API v2.0.

Endpoint

GET https://sms.textcus.com/api/send

Request Parameters

Below is a list of parameters when issuing an HTTP Request.

Parameters	Type	Description
type	Required	It indicates the type of message. Values for "type" include: 0 : Plain text (GSM 3.38 Character encoding) 1 : Flash (GSM 3.38 Character encoding) 2 : Unicode 3 : Reserved 5 : Plain text (ISO-8859-1 Character encoding) 6 : Unicode Flash 7 : Flash (ISO-8859-1 Character encoding)
source	Required	The source address that should appear in the message. - Max Length of 18 if numeric. - Max Length of 11 if alphanumeric. To prefix the plus sign (+) to the sender’s address when the message is displayed on their mobile phone, please prefix the plus sign to your sender’s address while submitting the message. Note: You need to URL encode the plus sign. The SMSC may enforce additional restrictions on this field.
destination	Required	Recipient phone number Must be a valid MSIDSN Must be in the international telephone number format (may or may not include a plus [+] sign) symbol. e.g. 233241234567 or [phone] Multiple mobile numbers need to be separated by a comma (,) (the comma should be URL encoded).
dlr	Required	Indicates whether the client wants a delivery report for this message. The values for "dlr" include: 0 : No delivery report required 1 : Delivery report required
message	Required	The message to be sent. Must be URL encoded.
time	Optional	To schedule the message to be sent sometime or date in the future Format: YYYY-MM-DD HH:MM:SS or UNIX TIMESTAMP The Scheduled time must be at least 10 minutes ahead of the current time in UTC

Sample Requests

PHP

<?php

//defining the parameters
$apiKey = '63f113a2d1d06b27ebd33a4ui63e71902al3'; //Remember to put your account API Key here
$recipient = 23324xxxxxxx; //International format (233) excluding the (+)
$sender = 'TextCus'; //11 Characters maximum
$msg = "Hello, TextCus SMS is the best!";

//encode the message
$message = urlencode($msg);

$url = 'https://sms.textcus.com/api/send?apikey=' . $apiKey . '&destination=' . $recipient . '&source=' . $sender . '&dlr=0&type=0' . '&message=' . $message . '';

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

?>

Sample Response

Success

{
    "status": 200,
    "message": "Message sent successfully"
}

Errors

{
    "status": 401,
    "error": "Authentication invalid"
}, 

{
    "status": 401,
    "error": "Unauthorized: Invalid API Key"
}