HTTP SMS API – EgoSms Documentation

Tutorials

Introduction

Authentication

SENDING SMS

BALANCE INQUIRY

SENDING SMS

Using HTTP

Overview

This method provides a way to send the message (SMS) via HTTP using account details.

Send SMS through your application by making an HTTP GET request to the following endpoints:

LIVE URL:https://www.egosms.co/api/v1/plain/

SANDBOX URL:http://sandbox.egosms.co/api/v1/plain/

HTTP Request Parameters

These are the standard request parameters that are needed when using the HTTP method of the EgoSMS Api.

The parameters should be separated using the ‘&’ sign just like in a normal http get.

username String Required

The API callers username used to login to Egosms.

password String Required

The URL encoded password to your Ego Sms Account

number String Required

The API callers password used to login to Egosms.

message String Required

This represents the URL encoded SMS you are sending out. The message source must have a maximum of 160 characters.

sender String Required

This represents who the message is coming from. Sender can have a maximum of 11 characters and needs to be URL encoded too.

Example

https://www.egosms.co/api/v1/plain/?number=%2B256788200915&message= My+First+Message+Through+Egosms& username=Egosmstest& password=egotest&sender=Egosms

The above link will send a message “My first message through Egosms” to the number “256788200915” using and Egosms Account whose username is “EgosmsTest” and password “egotest”

System Feedback

Once your message has been successfully sent to the network the system will show ‘Ok’ otherwise it will show error.

Possible Errors

Wrong UserName Or Password

This is returned if either the provided password or username is wrong.

One Of The Values Is Empty

This is if returned any of the fields (username / password / number / message / ‘senderid) is empty.

Money Not Enough To Send This Batch of Msgs.

Occurs if there are insuffient funds of your Egosms Account.

That user does not exist or user not active

Occurs if the account being used does not exist or is inactive or if the username is not set.

Programming Example

				
					<?php
function SendSMS($username, $password, $sender, $number, $message)
{

    $url = "www.egosms.co/api/v1/plain/?";

    $parameters = "number=[number]&message=[message]&username=[username]&password=[password]&sender=[sender]";
    $parameters = str_replace("[message]", urlencode($message) , $parameters);
    $parameters = str_replace("[sender]", urlencode($sender) , $parameters);
    $parameters = str_replace("[number]", urlencode($number) , $parameters);
    $parameters = str_replace("[username]", urlencode($username) , $parameters);
    $parameters = str_replace("[password]", urlencode($password) , $parameters);
    $live_url = "https://" . $url . $parameters;
    $parse_url = file($live_url);
    $response = $parse_url[0];
    return $response;
}
$username = "Egosmstest";
$password = "egotest";
$sender = "Egosms";
$number = "+256788200915";
$message = "My First Message through Egosms";
echo SendSMS($username, $password, $sender, $number, $message);
?>

				
					# importing the requests library
import json
import requests
import html

# The api url
url = "https://www.egosms.co/api/v1/plain/"

# The parameters to be sent to the ego sms api
password = "xxxxxx"
username = "egotest"
sender = "Egosms"
number = "256707811113"
message = "This is a message"

parameters = {
    'username': html.escape(username),
    'password': html.escape(password),
    'number': html.escape(number),
    'message': html.escape(message),
    'sender': html.escape(sender)
}

timeout = 5

# Check for the internet connection and make the request
try:
    # sending post request and saving response as response object
    r = requests.get(url=url, params=parameters, timeout=timeout)

    # extracting response text
    response = r.text

    print(response)

except(requests.ConnectionError, requests.Timeout) as exception:
    print("Check your internet connection")

				
					package http;

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLConnection;
import java.net.URLEncoder;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.StringJoiner;

public class SendHttp {
    public static void main(String[] args) {
        try {
            //Parameters to add to the URL
            LinkedHashMap<String,String> params = new LinkedHashMap<>();
            params.put("number", "256788200915");
            params.put("message", "My first message through Egosms");
            params.put("username", "EgosmsTest");
            params.put("password", "egotest");
            params.put("sender", "Egosms");
            StringJoiner sj = new StringJoiner("&");

            //Encoding the above parameters
            for(Map.Entry<String,String> entry : params.entrySet())
                sj.add(URLEncoder.encode(entry.getKey(), "UTF-8") + "="
                        + URLEncoder.encode(entry.getValue(), "UTF-8"));
            String encoded_params = sj.toString();

            //URL with necessary parameters added
            String urlParams = "https://www.egosms.co/api/v1/plain/?"+encoded_params;

            //Sending Http request to above composed URL
            URL url = new URL(urlParams);
            URLConnection con = url.openConnection();
            HttpURLConnection http = (HttpURLConnection)con;
            http.setRequestMethod("GET");
            http.setDoOutput(true);
            http.setRequestProperty("Content-Type", "text/plain; charset=UTF-8");

            //Receiving response
            BufferedReader in = new BufferedReader(new InputStreamReader(http.getInputStream()));
            String line = null;
            while((line = in.readLine()) != null) {
                System.out.println(line);
            }
        }catch(Exception e) {
            e.printStackTrace();
        }
    }
}