UltraSMSScript provides HTTP SMS APIs

API calls can be executed from nearly any popular programming language. Through our API you can access the most core features of the UltraSMSScript platform. Adding and retrieving contacts, sending/scheduling bulk SMS to groups, sending/scheduling SMS to a specific contact, message delivery reports, retrieving your SMS/Voice credit balance, and adding contact appointments are available at the moment. More will be added in the future, but these 8 were requested the most and are most useful when extending the functionality of your own platform.

Check out the list of available APIs below and each of the API’s parameters, return values, and sample API JSON responses. Integrating the UltraSMSScript API into your application will enable you to extend the functionality of the platform into your own app!

Description

URL

$url = 'http://{YOUR_URL_HERE}/apis/addcontact/';
$fields = array('apikey' => $api_key,
'group' => $group_name,
'number' => $number,
'name' => $name,
'email' => $email,
'bday' => $bday,
);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($fields));
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/x-www-form-urlencoded'));
$result = curl_exec($ch);
return $result;
       

Parameters

Include country code in the number
US Example: 12025248725 UK Example: 447481340516

Return Values

Example API Response (data is returned in universal and lightweight JSON format)

{
"status":"-7",
"msg":"Number is already subscribed for home"
}

Description

URL

$url = 'http://{YOUR_URL_HERE}/apis/getcontacts/';
$fields = array('apikey' => $api_key,
'name' => $name,
);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($fields));
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/x-www-form-urlencoded'));
$result = curl_exec($ch);
return $result;
       

Parameters

Return Values

Example API Response (data is returned in universal and lightweight JSON format)

{ 
    "status":"0",
    "contacts": [
    {
        "id": "23",
        "name": "John Doe",
        "birthday": "1974-03-23",
        "email": "johndoe@gmail.com",
        "number": "14154009186",
        "group": "Group One",
        "subscriber": "Yes",
        "source": "SMS",
        "carrier":"Sprint",
        "date": "2017-03-12 11:02:04"
        },
    {
        "id": "24",
        "name": "John Smith",
        "birthday": "1978-01-13",
        "email": "",
        "number": "18159819712",
        "group": "Group Two",
        "subscriber": "Yes",
        "source": "Kiosk",
        "carrier":"",
        "date": "2016-12-17 13:12:04"
        }
    ]
}

Description

URL

$url = 'http://{YOUR_URL_HERE}/apis/smsgroup/';
$fields = array('apikey' => $api_key,
'from' => $from,
'to' => $to,
'message' => $message,
'rotate' => $rotate,
);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($fields));
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/x-www-form-urlencoded'));
$result = curl_exec($ch);
return $result;
       

Parameters

NOTE: Messages containing non-GSM(unicode) characters will be charged 1 credit for each 70 character segment.

Alphanumeric SenderID requirements: Any combination of 1 to 11 letters(A-Z/a-z) and numbers(0-9). 1 letter and no more than 11 alphanumeric characters may be used.

Format: DD-MM-YYYY HH:MM
Example: 20-03-2017 19:30

Format: DD-MM-YYYY HH:MM
Example: 20-03-2017 19:30

Return Values

Example API Response (data is returned in universal and lightweight JSON format)

{
"status":"-4",
"msg":"There was no message passed in to be sent."
}

Description

URL

$url = 'http://{YOUR_URL_HERE}/apis/getbulksmsdeliveryreport/';
$fields = array('apikey' => $api_key,
'groupsmsid' => $groupsmsid,
);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($fields));
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/x-www-form-urlencoded'));
$result = curl_exec($ch);
return $result;
       

Parameters

Return Values

Example API Response (data is returned in universal and lightweight JSON format)

{
"successful":"145",
"failed":"7"
}

Description

URL

$url = 'http://{YOUR_URL_HERE}/apis/smscontact/';
$fields = array('apikey' => $api_key,
'from' => $from,
'to' => $to,
'message' => $message,
);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($fields));
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/x-www-form-urlencoded'));
$result = curl_exec($ch);
return $result;
       

Parameters

Example: 18159819712
NO spaces, dashes, or parentheses in phone numbers. Include country code in the number

NOTE: Messages containing non-GSM(unicode) characters will be charged 1 credit for each 70 character segment.

Alphanumeric SenderID requirements: Any combination of 1 to 11 letters(A-Z/a-z) and numbers(0-9). 1 letter and no more than 11 alphanumeric characters may be used.

Format: DD-MM-YYYY HH:MM
Example: 20-03-2017 19:30

Format: DD-MM-YYYY HH:MM
Example: 20-03-2017 19:30

Return Values

Example API Response (data is returned in universal and lightweight JSON format)

{
"status":"-3",
"msg":"The 'from' number passed in doesn't exist in your account or isn't SMS-enabled."
}

Description

URL

$url = 'http://{YOUR_URL_HERE}/apis/getcontactsmsdeliveryreport/';
$fields = array('apikey' => $api_key,
'number' => $number,
);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($fields));
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/x-www-form-urlencoded'));
$result = curl_exec($ch);
return $result;
       

Parameters

Include country code in the number
US Example: 12025248725 UK Example: 447481340516

Return Values

Example API Response (data is returned in universal and lightweight JSON format)

{
"smsstatus":"delivered",
"errormsg":""
}

Description

URL

$url = 'http://{YOUR_URL_HERE}/apis/getcreditbalance/';
$fields = array('apikey' => $api_key,
'type' => $type,
);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($fields));
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/x-www-form-urlencoded'));
$result = curl_exec($ch);
return $result;
       

Parameters

Return Values

Example API Response (data is returned in universal and lightweight JSON format)

{
"creditbalancenumber":"145",
"msg":"Your credit balance is returned on successful API call"
}

Description

URL

$url = 'http://{YOUR_URL_HERE}/apis/addappointment/';
$fields = array('apikey' => $api_key,
'number' => $number,
'apptdate' => $apptdate,
'status' => $status,
);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($fields));
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/x-www-form-urlencoded'));
$result = curl_exec($ch);
return $result;
       

Parameters

Include country code in the number
US Example: 12025248725 UK Example: 447481340516

Format: DD-MM-YYYY HH:MM
Example: 20-03-2017 19:30

0=>Unconfirmed, 1=>Confirmed, 2=>Cancelled, 3=>Rescheduled

Return Values

Example API Response (data is returned in universal and lightweight JSON format)

{
"status":"-2",
"msg":"There was no contact number passed in."
}