Skip to content

Notif+ Platform

ICOSNET Notif+ platform is our global messaging platform that bills in Dinars.

Notif+ Platform - Message Submission API

This document details sending single or multiple messages using the Message Submission API.

GET

https://<servername>/bulksms/bulksms

Exemple usage

https://smsapi.icosnet.com:8443/bulksms/bulksms?username=X&password=Y&type=Y&dlr=Z&destination=Q&source=R&message=S

Paramètre

Field Type Description
username string Username of the user.
password string Password of the user.
type string 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)
dlr string Indicates whether the client wants delivery report for this message. The values for "dlr" include:
0: No delivery report required
1: Delivery report required
destination string Mobile number to which the message is to be sent (may or may not include a plus [+] sign). Multiple mobile numbers need to be separated by a comma (,) (the comma should be URL encoded).
source string 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.
message string The message to be sent. It 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 every 153 characters are counted as one message for plain text and 268 characters for Unicode. The system uses the rest of the characters for packing extra information for reassembling the message on the mobile phone.

Success Code

Field Description
1701 Success. Message submitted successfully. Response will be in below format :
1701 "CELL_NO" "MESSAGE_ID" You can then use the message ID later to map the delivery report to the message.

Success response

1701|Destination:Messageid

Error Codes

Nom Description
1702 Invalid URL. This means that one of the parameters was not provided or left blank.
1703 Invalid value in username or password field.
1704 Invalid message type.
1705 Invalid message.
1706 Invalid destination.
1707 Invalid source (Sender ID).
1708 Invalid dlr value.
1709 User validation has failed.
1710 Internal error.
1715 Response timeout.
1025 Insufficient credit.
1032 DND reject.
1028 Spam message.

Exemple Request

import requests

url = "http://<host>:port/bulksms/bulksms?username=X&password=Y&type=Y&dlr=Z&destination=Q&source=R&message=S"

payload={}
headers = {}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

var settings = {
  "url": "http://<host>:port/bulksms/bulksms?username=X&password=Y&type=Y&dlr=Z&destination=Q&source=R&message=S",
  "method": "GET",
  "timeout": 0,
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'http://<host>:port/bulksms/bulksms?username=X&password=Y&type=Y&dlr=Z&destination=Q&source=R&message=S&ip=x',
  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',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

curl --location --request GET 'http://<server>:port/bulksms/bulksms?username=X&password=Y&type=Y&dlr=Z&destination=Q&source=R&message=S'

SMS Scheduler API

GET

https://<servername>/bulksms/schedulesms

Exemple usage

https://smsapi.icosnet.com:8443/bulksms/schedulesms?username=X&password=X&message=X&type=X&dlr=X&source=X&destination=X&date=X&time=X&gmt=X

Paramètre

Champ Type Description
username string Username of the user.
password string Password of the user.
message string The message to be sent.
destination string Mobile number to which the message is to be sent. More than one destination needs to be separated by a comma (,).
type string Value for type include: 0 : Text 1 : Flash 2 : Unicode 6 : Unicode Flash
source string Sender ID of the message.
date string Scheduled date for the message. Date needs to be in the following format : MM/DD/YYYY MM : Examples of month : 01,12 DD : Examples of date : 01,18,30 YYYY : Example of year : 2013 Example of scheduledate : 03/03/2013
time string Scheduled time for the message. Time needs to be in the following format : hh:mm am/pm hh : Hours range from 00 to 12 mm : Examples of minutes : 00, 15,30 am/pm : one of (am) or (pm) Example of scheduletime : 03:45 am OR 11:51 pm
gmt string GMT +hh:mm OR GMT -hh:mm OR +hh:mm OR -hh:mm hh : Hours range from 0 to 12 mm : Examples of minutes : 00 or 30 Example : GMT +1:30 OR -10:00
dlr string Indicates whether client wants delivery report for this message. 0 : No delivery report required 1 : Delivery report required)

Success Code

Field Description
1701 Success, Message scheduled successfully.

Success response

1701|JobID

Error Codes

Nom Description
1702 One of the parameter missing.
1703 User authentication has failed.
1704 Invalid message type.
1705 Invalid message.
1706 Invalid destination.
1707 Invalid sender.
1710 Internal error.
1712 Bad DB connection.
1713 Too many destinations.
1901 Invalid XML content.
1902 Bad schedule date.
1903 Invalid GMT.
1904 Bad schedule time.
1905 Invalid date and time.