1s2u Developers | Get Free Bulk SMS Messaging APIs

Description

Integrate our HTTP API tool to be used as a Bulk SMS Gateway in your custom designed system, or make your own SMSC. HTTP API allows you to get a gateway for bulk SMS messaging. You can setup your own custom designed Bulk SMS Messaging platform, or you can integrate the API in any device to notify you when a certain thing happened.

The default return of data from API is in a simple pipe-delimited (|) format, with no need to use XML parsers. HTTP client library should be used in all calls that use authentication. Username/password should be visible fields in a form, and you have to URL-encode all parameters and use GET or POST requests. When many numbers of recipients is submitted, POST requests is recommended as GET requests may have size limits.

You may get 10 free Bulk SMS Messages upon registering and using our services. Login or Sign up here.

You may have a look at our API Document here.

Overview

Authentication

In order to deliver a message, the gateway needs to authenticate whether the request is coming from a valid source with valid login details.

This authentication is done using various parameters such as:

User: Username of the account.

Pass: Password of the account.

Username and password are provided to the client after registration is made for the HTTP/HTTPS API option.

HTTP Content Type

All API methods expect requests to supply a Content-Type header with the value application/x-www-form-urlencoded. All responses will have the Content-Type header set to text/plain.

SMS API Parameters

Parametres	Value	Description
USERNAME	Username	Your account username
PASSWORD	Password	Your Account Password
MT	0 or 1	Message Type ( English = 0 , Arabic =1 , Unicode & Other Languages =1 )
FL	0 or 1	Sent Message As Flash SMS ( FL=1 ( Flash Message ) , FL=0 (Normal Message ) (GSM 3.38 Character encoding)
SID	Alphanumeric max 11 char	Message Sender Name ( Max Length of 18 if Only Numeric , Max Length of 11 if Alpha numeric ) If you wish plus ('+') should be prefixed to the sender address when the message is displayed on the cell phone, please prefix the plus sign to your sender address while submitting the message (note the plus sign should be URL encoded). Additional restrictions on this field may be enforced by the SMSC
MNO	Mobile number 10 to 18 digit	Mobile Number to which to Send message to (Should not include a ‘+' sign or '00'), multiple mobile numbers can be separated by commas (note the comma (',') should be URL encoded) Max numbers can be submitted is 15 number per submission
IPCL (Ip Addresss)	Your server or your remote IP	A unique string of numbers separated by full stops that identifies each computer using the Internet Protocol to communicate over a network
MSG	English or Unicode message text	The message to send (Can be used for 'long' messages, that is, messages longer than 160 characters for plain text, 140 for flash and 280 for Unicode)For concatenated (long) messages we will be counting as one message for every 153 characters for plain text and 268 characters for Unicode, as the rest of the characters will be used by the system for packing extra information for re-assembling the message on the cell phone. Also in the latter case, to send non-English characters in the message, you only have to directly URL encode them (using UTF-8 character encoding scheme).

Response messages from HTTP/HTTPS API

Status	Return Values
Messages sent successfully.	3fd23425-6edb-4fec-ba91-8d70f5300fc0 Value returned as sms message id, It can be retained for generating CDR reports.
Message not sent.	Error Code

Error Message Table

Error Codes	Description
0000	Service Not Available or Down Temporary
3fd23425-6edb-4fec-ba91-8d70f5300fc0	Message sent successfully.
0005	Invalid server
0010	Username not provided.
0011	Password not provided.
00	Invalid username/password.
0020 / 0	Insufficient Credits
0030	Invalid Sender ID
0040	Mobile number not provided.
0041	Invalid mobile number.
0042	Network not supported.
0050	Invalid message.
0060	Invalid quantity specified.
0066	Network not supported

Note:

Only the above-defined validations are performed at the server side. All other validations for any parameter are required to be handled at the client side explicitly. For example: The mobile number is not validated at the sever end for containing any characters other than numbers or for not being in the international format. In case of Unicode messaging, if the value of message type parameter (mt) is sent as 0 instead of 1, then the message would be sent as simple text message and not Unicode, since no such validation is performed at the server end.

Code Sample

Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports System.Text.RegularExpressions

Namespace Demo
    Public Module Program
        Public Sub Main(args() As String)
            'Your code goes here'


            Dim webClient As New System.Net.WebClient
            Dim result As String = webClient.DownloadString("https://api.1s2u.io/bulksms?username=xxxxxxx&password=xxxxxxxx&mt=0&fl=0&Sid=Test&mno=601xxxxxxxx&msg=Message will be written here")
            Console.WriteLine(result)

        End Sub
    End Module
End Namespace

using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.IO;
using System.Linq;
using System.Net;
using System.Text;
using System.Threading.Tasks;
using System.Web;
using System.Collections.Specialized;
using System.Diagnostics;
using System.Threading;
using System;

namespace Demo
{
    public class Program
    {
        public static void Main(string[] args)
        {
            Stream update_objStream1 = Stream.Null, objStream1 = Stream.Null, objStream = Stream.Null;
            string sURL;
            sURL = "https://api.1s2u.io/bulksms?username=xxxxxxx&password=xxxxxxxx&mt=0&fl=0&Sid=Test&mno=601xxxxxx&msg=Message will be written here";

            WebRequest wrGETURL;
            wrGETURL = WebRequest.Create(sURL);

            WebProxy myProxy = new WebProxy("myproxy", 80);
            myProxy.BypassProxyOnLocal = true;

            try { objStream = wrGETURL.GetResponse().GetResponseStream(); }
            catch (Exception ex)
            {
                // handle exception here

            }
            StreamReader objReader = new StreamReader(objStream);
            string messageId = objReader.ReadLine(); //final message id from stream object
            Console.WriteLine(messageId);

            //note: once done please all connctions.
            //objReader.Close();     
        }
    }
}

/*
* Requirements: your PHP installation needs cUrl support, which not all PHP installations
* include by default.
*
* Substitute your own username, password, mno, Sid, fl, mt, and message in seven_bit_msg
*then run the code:
*/
$username = 'username';
$password = 'password';
$mt = '0';
$fl = '0';
$seven_bit_msg = "Message will be written here";
/*
* Your phone number, including country code, i.e. 60123456756:
*/
$mno = 'Receiver phone number';
$Sid = 'test';
/*
* 
*/
$url = 'https://api.1s2u.io/bulksms';
$post_fields = array(
    'username' => $username,
    'password' => $password,
    'mt' => $mt,
    'fl' => $fl,
    'Sid' => $Sid,
    'mno' => $mno,
    'msg' => $seven_bit_msg
);
$get_url = $url . "?" . http_build_query($post_fields);
/*
* A 7-bit GSM SMS message can contain up to 160 characters (longer messages can be
* achieved using concatenation).
*
* All non-alphanumeric 7-bit GSM characters are included in this example. Note that Greek characters,
* and extended GSM characters (e.g. the caret "^"), may not be supported
* to all networks. Please let us know if you require support for any characters that
* do not appear to work to your network.
*/
/*
* Sending 7-bit message
*/
$post_body = seven_bit_sms( $username, $password, $seven_bit_msg, $mno, $Sid, $fl, $mt);
$result = send_message( $post_body, $get_url );
if( $result['success'] ) {
  print_ln( formatted_server_response( $result ) );
}
else {
  print_ln( formatted_server_response( $result ) );
}
/*
* If you don't see this, and no errors appeared to screen, you should
* check your Web server's error logs for error output:
*/
print_ln("Script completely ran.");
function print_ln($content) {
  if (isset($_SERVER["SERVER_NAME"])) {
    print $content."
";
  }
  else {
    print $content."\n";
  }
}
function formatted_server_response( $result ) {
  $this_result = "";
  if ($result['success']) {
    $this_result .= "Success ID : ".$result['id'];
  }
  else {
    $this_result .= "Fatal error: HTTP status " .$result['http_status_code']. ", API status " .$result['api_status_code']. " Full details " .$result['details'];
  }
  return $this_result;
}
function send_message ( $post_body, $get_url ) {
  $ch = curl_init( );
  curl_setopt ( $ch, CURLOPT_URL, $get_url );
  curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, 1 );
  // Allowing cUrl funtions 20 second to execute
  curl_setopt ( $ch, CURLOPT_TIMEOUT, 20 );
  // Waiting 20 seconds while trying to connect
  curl_setopt ( $ch, CURLOPT_CONNECTTIMEOUT, 20 );
  curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
  curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
  $response_string = curl_exec( $ch );
  $curl_info = curl_getinfo( $ch );
  $sms_result = array();
  $sms_result['success'] = 0;
  $sms_result['details'] = '';
  $sms_result['http_status_code'] = $curl_info['http_code'];
  $sms_result['api_status_code'] = '';
  $sms_result['id'] = $response_string;
  if ( $response_string == FALSE ) {
    $sms_result['details'] .= "cURL error: " . curl_error( $ch ) . "\n";
  } elseif ( $curl_info[ 'http_code' ] != 200 ) {
    $sms_result['details'] .= "Error: non-200 HTTP status code: " . $curl_info[ 'http_code' ] . "\n";
  }
  else {
    $sms_result['details'] .= "Response from server: $response_string\n";
    $api_result = substr($response_string, 0, 2);
    $status_code = $api_result;
    $sms_result['api_status_code'] = $status_code;
    if ( $api_result != 'OK' ) {
      $sms_result['details'] .= "Error: could not parse valid return data from server.\n" . $api_result;
    } else {
      if ($status_code == 'OK') {
        $sms_result['success'] = 1;
      }
    }
  }
  curl_close( $ch );
  return $sms_result;
}
function seven_bit_sms ( $username, $password, $message, $mno, $sid, $fl, $mt) {
  $post_fields = array (
  'username' => $username,
  'password' => $password,
  'mno'   => $mno,
  'sid' => $sid,
  'sfl' => $fl,
  'mt' => $mt,
  'message'  => $message
  );
  return make_post_body($post_fields);
}
function make_post_body($post_fields) {
  $stop_dup_id = make_stop_dup_id();
  if ($stop_dup_id > 0) {
    $post_fields['stop_dup_id'] = make_stop_dup_id();
  }
  $post_body = '';
  foreach( $post_fields as $key => $value ) {
    $post_body .= urlencode( $key ).'='.urlencode( $value ).'&';
  }
  $post_body = rtrim( $post_body,'&' );
  return $post_body;
}
function make_stop_dup_id() {
  return 0;
}

Description

Get full, accurate, and detailed reporting (DLR) for all messages sent status. Upon integrating DLR API, you will know the status of your sent messages. Is it recieved by the end-user or not. Knowing whether the message was delivered will give you all statistics needed to measure the effectiveness of your SMS Bulk Messaging.

Integrate DLR API with your system to real-time check the status of delivery of your messages. With DLR you will be able to receive the status of sending your messages. Check your sent messages and know the status of its delivery.

You may have a look at our API Document here.

Overview

Authentication

Let's assume your web server is located at http://smsexample.com. Below is a snippet to set up a route on your webserver. Now when we send an HTTP request to http://smsexample.com/delivery_report.asp this route will be invoked. This route will be the 'url' parameter when sending an sms using the Message API. Note: For asp, the route will be http:// smsexample.com/delivery_report.asp.

DLR Content Type

All API methods expect requests to supply a Content-Type header with the value application/x-www-form-urlencoded. All responses will have the Content-Type header set to text/plain.

DLR API Parameters

Parametres	Value	Description
mno	mno	The number to which the SMS was sent.
sid	sid	Sender Id/From clause in the SMS message.
msgid	msgid	A unique ID for the message
date	date	The received status date and time
status	status	The status of the message. Possible statuses include 'failed', DELIVRD, UNDELIV, expired or 'rejected'

DLR Response Codes

User can get DLR via Provided Web Link. The URL for each client would look like http://smsexample.com/delivery_report.asp. The method used for posting delivery report onto the client's URL is POST The parameters appended to the URL.

DLR will result the status of the delivery of messages as follows: 'failed', UNDELIV, expired or 'rejected'.

Description

Check your credits balance or make your customers apply for credits through Get Credits API. Customize and integrate all your website's monetary analysis into your system simply by forwarding your username and password parameter to the API.
Note: You can check your balance 2 time in each 1 min , calling the API in higher speed will block your request and server error will be rise.

For example:

https://api.1s2u.io/checkbalance?user=yourusername&pass=yourpassword

Overview

Authentication

In order to deliver a message, the gateway needs to authenticate whether the request is coming from a valid source. Also, an IP validation feature is available for security. However, the IP validation feature can be provided only in the case of clients accessing the gateway via a global IP.

This authentication is done using various parameters such as:

User: Username of the account.

Pass: Password of the account.

Username and password are provided to the client after registration is made for the HTTP/HTTPS API option.

Get Credits Content Type

All API methods expect requests to supply a Content-Type header with the value application/x-www-form-urlencoded. All responses will have the Content-Type header set to text/plain.

SMS API Parameters

Parametres	Value	Description
USER	user	Your account username
PASS	pass	Your Account Password

Response messages from Get Credits API

Return Values	Description
00	Invalid username or password
0 or your account remaining balance	remaining balance

Description

Inbound SMS messaging allows you to send and receive SMS messages with your customer. Integrating Inbound SMS messaging will give you the ability to communicate with your customers right from your own designed platform. Inbound Messages API are sent using a GET HTTP.

In order to get started with Inbound SMS Messaging, you need to have your own virtual number, and integrate it into your Bulk SMS Platform. Check out our virtual number prices here.

You may have a look at our API Document here.

Overview

Authentication

This authentication is done using various parameters such as:

User: Username of the account.

Pass: Password of the account.

Username is provided to the client after registration is made in our system, and user can buy their own virtual number through our website.

Inbound Content Type

All API methods expect requests to supply a Content-Type header with the value application/x-www-form-urlencoded. All responses will have the Content-Type header set to text/plain.

SMS API Parameters

Parametres	Value	Description
VN	Internationl hosted SIM mobile number	Your private virtual number
Username	Username	Your Account username

Response messages from Inbound API

In case of successful, inbound messages information will be given in response body in JSON format.

The API will push only today received messages, you can save the log for your old messages at your side, or you can check our portal for all the received messages within 30 days only. The messages which is older than 30 days will be deleted from our servers for security purpose.

In case of success:

{ "results ":
    [
        {
            "id":"xxxxxxxxxxxx",
            "from":"xxxxx",
            "date":"xxxx",
            "text":"xxxxxx"
        }
    ] 
}

Response nodes:

Id: The ID of the message.
From: the phone number that this inbound message was sent from.
Date: Timestamp representation of message timestamp.
Text: the message body for the inbound message.

Description

Short Message Peer-to-Peer (SMPP) is an open, industry standard protocol designed to provide a flexible data communications interface. With our SMPP API that support SMPP v3.4 protocol, you will be able to design your bulk SMS messaging system and make your own SMSC using the SMPP protocol.

You may get 10 free Bulk SMS Messages upon registering and using our services.

You may read SMPP Protocol Specification at its original document from SMPP Developer Forum here.

Our Cloud SMPP service is available to you after creating an account on our web site. It uses the same core platform and backend connections as our SMPP service. However you need to contact our support to whitelist your account to use the SMPP service and to add your server IP address to our Cloud SMPP Firewall.

Overview

SMPP Version 3.3 or 3.4

Bind Type Transmitter, Receiver or Transceiver

Asynchronous outstanding operations window 10

Maximum allowed sessions 1

Authentication

In order to ensure successful of authentication and meet SMPP specification, please make sure your password is less than 8 characters.

Capabilities & Limitations

SMPP provides a gateway for faster and more Bulk SMS delivery. With SMPP users are empowered with the ability to send more efficient SMS messages. However, SMPP protocol has its own registering criteria before users can have the gateway.

Users have to request from our Support Team to whitelist their account and their ip address. please note that your SMPP password must be lesser t han 8 characters, due to protocol limitation.

Read more the SMPP protocol specification here.

SMS API Parameters

Parametres	Value	Description
Host	smpp.1s2u.io	You can connect to our SMPP host with your given username and password
Port	2779	Make sure to whitelist our SMPP port at your server side
USERNAME	Username	Your account username
PASSWORD	Password	Your Account Password

Description

The Simple Mail Transfer Protocol (SMTP) is an internet standard communication protocol for electronic mail transmission. Mail servers and other message transfer agents use SMTP to send and receive mail messages.

1s2u.com SMTP Service enables you to automatically send and receive SMS text messages from any email sending application.

For more details about our 1s2u.com SMTP service, Please contact us.

Description

Home Location Registration (HLR) provides a direct network check for any GSM mobile number. HLR Lookups is a global technology to check the status of any cell phone number. Through making a query to the Home Location Register.

You are able to use HLR lookup to query mobile networks to find out information about a mobile number. Including:

Whether the mobile number is currently active in a mobile network.
If the mobile number is roaming.
If the number has been ported to another network.
Which ported network the phone number has moved to.
If the mobile has been turned on recently.
What country the mobile was last used.
Check the mobile number is valid.
Check The country code the number belongs to.
The query will also return results information such as the IMSI, MSC, MCC, and MNC.
Indication if there any temporary errors that may impede message delivery.

All checks are remotely performed, this means the user of the mobile does not see anything on their phone.

You may have a look at our API Document here.

Overview

Authentication

Pass the parameter to URL in this format:

yourwebsitelink/?key=xxxx&ref=xxxxx&msisdn=xxxxxxxxxx

HLR Content Type

All API methods expect requests to supply a Content-Type header with the value application/x-www-form-urlencoded. All responses will have the Content-Type header set to text/plain.

SMS API Parameters

Parametres	Value	Description
Key	Key	Your private key you can find it above or in user profile page
MsiSdn (Mobile Number)	MsiSdn	Max 10 numbers use comma between the numbers like 1111222222,333344444,..etc
Ref	Ref	Reference number for HLR Lookup

Error Code Parameters Details:

Parametres	Number	Description
Error Code	00	Invalid Reference Number (Should minimum 6 digit and each time you post the request must have unique number) and must be numeric only.
Error Code	01	Invalid Reference Number (Should minimum 6 digit and each time you post the request must have unique number) and must be numeric only.
Error Code	02	Invalid mobile number, for multi number you can use comma between the numbers maximum 500 numbers each time.
Error Code	03	Insufficient Balance.

Response Details:

In case of successful lookup, number lookup information will be given in response body in JSON format.

In case of success:

{ "results ":[
        {
            "to":"xxxxxxxxxxxx",
            "country":"xxxxx",
            "errdesc":"xxxx",
            "operator":"xxxxxx",
            "mccmnc":"xxxxxxxxxxx",
            "imsi":"xx",
            "errcode":"xxxxx",
            "statusdesc":"xxxxxxxxxxxxxx",
            "msgstatus":"xxxxxxxxxxxxxxxx"
        }
    ] 
}

Err code:

000 DELIVRD
001 UNDELIV Temporarily
002 UNDELIV Permanent
003 REJECTD Temporarily
004 REJECTD Permanent

Response nodes description:

Sr. No.	Node Name	Description
1.	to	MSISDN for number lookup
2.	country	Ported country name if number is ported else original country name
3.	operator	Ported operator name in case of number is ported else original operator name
4.	mccmnc	Mobile Country Code and Mobile Network Code
5.	errcode	000 DELIVRD 001 UNDELIV Temporarily 002 UNDELIV Permanent 003 REJECTD Temporarily 004 REJECTD Permanent
6.	statusdesc	000 DELIVRD 001 UNDELIV Further info, please refer to the table below.
7.	imsi	International Mobile Subscriber Identity, used to uniquely identify the user of a mobile network
8.	errdesc	Please refer the table below.

Error Code types and descriptions:

More Error codes please read our HLR API Document Here.

Error Description	Error Code	Permanent
Absent Subscriber	001	false
Call Barred	001	false
Data Missing	001	false
SMS Facility Not Supported	001	false
HLR Abort	001	false
No Response	001	false
Reject Request	001	false
No Error	001	false
MSISDN Not Found	001	false
Invalid MSISDN	001	false
Request Method Not Allowed	001	false
Request Throttled	001	false
Invalid URL	001	false
System Failure	001	false
SMS Tele Service Not Provisioned	002	true
Time Out	001	false
Unexpected Data Value	001	false
Unknown Subscriber	002	true
Service Failure	003	false
CUG Reject	001	false
SMS Facility Not Supported	001	false
System Failure	001	false
Data Missing	001	false
Unexpected Data Value	001	false
Service Unreachable	003	false
Authentication Error	001	false
Not allowed to use this profile	001	false
Not allowed to use this service	001	false
Unknown user	001	false

Description

Bulk numbers API provide you bulk Mobile numbers for SMS verification. You can receive SMS online and pay by per SMS through our web smscin.com. Get the access and integerate the App Verification API into your system.

You can use the App verification API for capturing new number, getting SMS verification code, or verifying your application.

For more details please visit this link, or create a free account

Overview

Authentication

API URL:

http://www.smscin.com/do.php

App Verification Content Type

All API methods expect requests to supply a Content-Type header with the value application/x-www-form-urlencoded. All responses will have the Content-Type header set to text/plain.

SMS API Parameters

Parametres	Value	Description
USERNAME	Username	you username in our system,like xxx@gmail.com
token	token	show at First Page you login, like 9ac2d96d7134bdfe61cba4724e174423
pid	pid	found at project list which you want use.
mobile	mobile	the mobile number you get, like 8615113875319

Steps for passing the parameters:

Login and got summary
1. Submit: action=login&username=[username]&token=[token]
2. Return: [username]|[balance]|[integral]
3. Example: [email protected]
Get a mobile number
1. Submit: action=getmobile&username=[username]&token=[token]&pid=[pid]&channel=[channel]
2. Return: [mobile]
3. Example: 8615113875319
Get SMS
1. Submit: action=getsms&username=[username]&token=[token]&pid=[pid]&mobile=[mobile]
2. Return: [send from]|[SMS Content]
3. Example: 1|WhatsApp code 123-456.
Add mobile to Black list
1. Submit: action=addblack&username=[username]&token=[token]&pid=[pid]&mobile=[mobile]
2. Return: Message|Had add black list
View Mobile List
1. Submit: action=mobilelist&username=[username]&token=[token]
2. Return: [mobile]|[pid],[mobile]|[pid]
3. Example: 8613790022817|3,8613790042684|3

Oops! There are no items to display here.

Try selecting one of the category on the left. If it doesn't work,
let us know here.

For developers
from developers.

1s2u.com API Integrations

Description

Overview

SMS API Parameters

Response messages from HTTP/HTTPS API

Error Message Table

Code Sample

Description

Overview

DLR API Parameters

DLR Response Codes

Description

Overview

SMS API Parameters

Response messages from Get Credits API

Description

Overview

SMS API Parameters

Response messages from Inbound API

Description

Overview

Authentication

Capabilities & Limitations

SMS API Parameters

Description

Description

Overview

SMS API Parameters

Error Code Parameters Details:

Response nodes description:

Error Code types and descriptions:

Description

Overview

SMS API Parameters

Steps for passing the parameters:

Oops! There are no items to display here.

Related Articles

For developers from developers.

1s2u.com API Integrations

Description

Overview

SMS API Parameters

Response messages from HTTP/HTTPS API

Error Message Table

Code Sample

Description

Overview

DLR API Parameters

DLR Response Codes

Description

Overview

SMS API Parameters

Response messages from Get Credits API

Description

Overview

SMS API Parameters

Response messages from Inbound API

Description

Overview

Authentication

Capabilities & Limitations

SMS API Parameters

Description

Description

Overview

SMS API Parameters

Error Code Parameters Details:

Response nodes description:

Error Code types and descriptions:

Description

Overview

SMS API Parameters

Steps for passing the parameters:

Oops! There are no items to display here.

Related Articles

For developers
from developers.