SMSC.net client API v2

Version 2.0.0

SMSC.net helps you verifying the quality of your messaging connections by combining a plug and play management interface and an extensive network of end-user devices globally located.

Verify SenderID support, MNP accuracy, content changes, UDH and all SMS properties.

The SMSC.net API allows you to integrate directly with your SMS system and use it in your UI. It is organized around HTTP REST API. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTPs response codes, authentication, and verbs.

First thing is to create your SMSC.net API account. In order to activate your account, we would need further information regarding your business and how our SMSC.net Platform will be of help to your services.

GET YOUR API-KEY

Once your account is activated you are ready to go live and using SMSC.net API.

BASE URL

https://nds.agiletelecom.com/v2

GET

List of available Network.

Use to get available networks for test and all test scenarios including (ported numbers). From returned list, most important attributes are:

real_mcc: Carrier Country code
real_mnc: Carrier Code
lcr_mcc: If different from real_mcc use to request ported number
lcr_mnc: If different from lcr_mnc use to request ported number (original carrier)

These parameters are necessary to obtain the recipient number and test code (to be placed before the message text)

Response example

[
    {
        "real_mcc": "603",
        "real_mnc": "01",
        "real_country": "Algeria",
        "real_carrier_name": "Mobilis",
        "lcr_mcc": "603",
        "lcr_mnc": "01",
        "lcr_country": "Algeria",
        "lcr_carrier_name": "Mobilis",
        "type": "pure"
    },
...
]

Request example

Python

import http.client
import http.client
import mimetypes
conn = http.client.HTTPSConnection("nds.agiletelecom.com")
payload = ''
headers = {
  'x-api-key': 'YOUR-API-KEY',
  'Content-Type': 'application/json'
}
conn.request("GET", "/v2/get-available-networks", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

PHP

import http.client
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://nds.agiletelecom.com/v2/get-available-networks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "x-api-key: YOUR-API-KEY",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Nodejs

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://nds.agiletelecom.com/v2/get-available-networks',
  'headers': {
    'x-api-key': 'YOUR-API-KEY',
    'Content-Type': 'application/json'
  }
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});

JAVA


OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://nds.agiletelecom.com/v2/get-available-networks")
  .method("GET", null)
  .addHeader("x-api-key", "YOUR-API-KEY")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

GET

Create test

Use this request to create a test, the target number requirements must be specified in the body.

If a callback_url is specified, the test results will be sent via POST, otherwise if you want to obtain via API leave the field empty.

In body:
{
“real_mcc”: “222”,
“real_mnc”: “01”,
“lcr_mcc”: “222”,
“lcr_mnc”: “01”,
“callback_url”: “http://www.example.com”
}

Response example

{
    "msisdn": "+393316143771",
    "real_mcc": "222",
    "real_mnc": "01",
    "lcr_mcc": "222",
    "lcr_mnc": "01",
    "active": true,
    "last_phone_check": "2020-05-21T14:25:08+00:00",
    "lcr_carrier_name": "TIM",
    "lcr_country": "Italy",
    "type": "pure",
    "id_test": "24df29368da8",
    "ttl": 1590330424
}

Once the test is created, it will remain available for 3 days, after which all test data will be automatically deleted from the system

Request example

Python

import http.client
import http.client
import mimetypes
conn = http.client.HTTPSConnection("nds.agiletelecom.com")
payload = "{\n\t\"real_mcc\": \"222\",
\n\t\"real_mnc\": \"01\",
\n\t\"lcr_mcc\": \"222\",
\n    \"lcr_mnc\": \"01\",
\n    \"callback_url\": \"http://www.example.com\"\n}"
headers = {
  'x-api-key': 'YOUR-API-KEY',
  'Content-Type': 'application/json',
  'Content-Type': 'text/plain'
}
conn.request("GET", "/v2/numbers", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

PHP

import http.client
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://nds.agiletelecom.com/v2/numbers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS =>"{\n\t\"real_mcc\": \"222\",\n\t\"real_mnc\": \"01\",\n\t\"lcr_mcc\": \"222\",\n    \"lcr_mnc\": \"01\",\n    \"callback_url\": \"http://www.example.com\"\n}",
  CURLOPT_HTTPHEADER => array(
    "x-api-key: YOUR-API-KEY",
    "Content-Type: application/json",
    "Content-Type: text/plain"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Nodejs


var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://nds.agiletelecom.com/v2/numbers',
  'headers': {
    'x-api-key': 'YOUR-API-KEY',
    'Content-Type': ['application/json', 'text/plain']
  },
  body: "{\n\t\"real_mcc\": \"222\",\n\t\"real_mnc\": \"01\",\n\t\"lcr_mcc\": \"222\",\n    \"lcr_mnc\": \"01\",\n    \"callback_url\": \"http://www.example.com\"\n}"

};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});

JAVA


OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://nds.agiletelecom.com/v2/numbers")
  .method("GET", null)
  .addHeader("x-api-key", "YOUR-API-KEY")
  .addHeader("Content-Type", "application/json")
  .addHeader("Content-Type", "text/plain")
  .build();
Response response = client.newCall(request).execute();

Send test

At this point, you can send a test with your own sms sending systems, specifying the number in msisdn as the recipient and prefixing the message value with the id_test value

POST

Get test result

In Body:

{
“id_test_number”: “24df29368da8”
}

Response example

{
    "created_at": "2020-04-27 10:39:44.165637",
    "id_test_number": "24df29368da8",
    "real_country": "Italy",
    "lcr_country": "Italy",
    "received_at": "2020-04-27 10:40:46.684359",
    "ttl": 1588243184.0,
    "test_status": "POSITIVE",
    "smsc": "+393205957500",
    "real_carrier_name": "TIM",
    "smsSender": "TEST",
    "sms_text": "19416c151d03 TEST",
    "lcr_carrier_name": "TIM",
    "msisdn": "+393316143771",
    "lcr_mnc": "01",
    "callback_url": "http://www.example.com",
    "type": "pure"
}

Request example

Python

import http.client
import mimetypes
conn = http.client.HTTPSConnection("nds.agiletelecom.com")
payload = "{\n\t\"id_test_number\": \"24df29368da8\"\n}"
headers = {
  'x-api-key': 'YOUR-API-KEY',
  'Content-Type': 'application/json',
  'Content-Type': 'text/plain'
}
conn.request("POST", "/v2/get-test-result", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

PHP

 "https://nds.agiletelecom.com/v2/get-test-result",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>"{\n\t\"id_test_number\": \"24df29368da8\"\n}",
  CURLOPT_HTTPHEADER => array(
    "x-api-key: YOUR-API-KEY",
    "Content-Type: application/json",
    "Content-Type: text/plain"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Nodejs


var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://nds.agiletelecom.com/v2/get-test-result',
  'headers': {
    'x-api-key': 'YOUR-API-KEY',
    'Content-Type': ['application/json', 'text/plain']
  },
  body: "{\n\t\"id_test_number\": \"24df29368da8\"\n}"

};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});

JAVA


OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json,text/plain");
RequestBody body = RequestBody.create(mediaType, "{\n\t\"id_test_number\": \"24df29368da8\"\n}");
Request request = new Request.Builder()
  .url("https://nds.agiletelecom.com/v2/get-test-result")
  .method("POST", body)
  .addHeader("x-api-key", "YOUR-API-KEY")
  .addHeader("Content-Type", "application/json")
  .addHeader("Content-Type", "text/plain")
  .build();
Response response = client.newCall(request).execute();

SMSC.net client API v2

Authentication

/get-available-networks

/numbers

/get-test-result