Infinito Unified API Guide v1
Infinito Unified API Guide v1
Unified API
Integration Guide
1
2
Table of Contents
Overview of Service ........................................................................................................................ 3
Character Set Support .................................................................................................................... 3
Message Length ............................................................................................................................. 3
End Point (URL) ............................................................................................................................. 4
Supported Authentication Methods ................................................................................................. 4
API sample using query parameters ............................................................................................... 5
API Sample using JSON payload ................................................................................................... 5
Extended Parameters ..................................................................................................................... 8
Submission Status Codes ............................................................................................................. 10
DLR URL ...................................................................................................................................... 12
DLR Status Codes ........................................................................................................................ 13
3
Overview of Service
GSM network supports GSM character set. Other than this Infinito
HTTPS API supports sending messages in Unicode using Unicode-
16 Big-Ending and UTF-8 format.
Message Length
▪ https://api.goinfinito.me/unified/v2/send
▪ https://meapi.goinfinito.me/unified/v2/send
1. Header
Send client id and password using x-client-id and x-client-
password headers
x-client-id: VFClientc6a31cf8dae
x-client-password: vwr46h499lloeyj9873kduwq
2. Query Parameters
Works with Query parameter API call
clientid=[xxxxxxxxxx]&clientpassword=[xxxxxxxxxx]
3. Basic Auth
Client id: VFClientc6a31cf8dae
Client Password: vwr46h499lloeyj9873kduwq
Generate Concatenated string:
VFClientc6a31cf8dae:vwr46h499lloeyj9873kduwq
Create Base64 encoded string:
QWxhZGRpbjpvcGVuU2VzYW1luyywe687RYlOD56HAY671
Send the encoded string using Authorization header
parameter
5
Authorization: Basic
QWxhZGRpbjpvcGVuU2VzYW1luyywe687RYlOD56HAY671
4. Bearer Token
Token:
QWxhZGRpbjpvcGVuU2VzYW1luyywe687RYlOD56HAY671
Send the Token string using Authorization header parameter
Authorization: Bearer
QWxhZGRpbjpvcGVuU2VzYW1luyywe687RYlOD56HAY671
{EndPointURL}?clientid=[xxxxxxxxxx]&clientpassword=[xxxxxxxxxx]
&to=[xxxxxxxxxx]&from=[xxxxxxxxxx]&dlr-
url=[xxxxxxxxxx]&category=[xxxxxxxxxx]&text=[xxxxxxxxxx]
Sample Responses:
Success:
guid=km68c2931604a1f1400007bk6sABHISHEKPY&mobilenumbe
r=XXXX&statuscode=0&statustext=Success
Failure:
guid=km68e4711159a1f140000fd1yqABHISHEKPY&mobilenumber
=XXXX&statuscode=28682&statustext=Invalid Mobile Number
guid=km68e4802368a1f140000lvg3fABHISHEKPY&mobilenumber
=XXXX&statuscode=28680&statustext=Invalid Sender ID
{
"apiver": "1.0",
"sms": {
"ver": "2.0",
"dlr": {
6
"url": ""
},
"messages": [
{
"udh": "0",
"text": "This is a test SMS",
"property": 0,
"id": "1",
"addresses": [
{
"from": "INFINITO",
"to": "XXXX",
"seq": "1",
"tag": "Clients optional information"
}
]
}
]
}
}
Sample Responses:
Success:
{
"status": "Success",
"statuscode": 200,
"statustext": "OK",
"messageack": {
"guids": [
{
"guid": "km7lf1242336a1f130010j766vSAMREEN9T0",
"submitdate": "2022-07-21 15:12:42",
"id": "1"
}
]
}
}
Failure:
7
{
"status": "Error",
"statuscode": 57090,
"statustext": "User Credit Expired"
}
.....................................................................
{
"status": "Success",
"statuscode": 200,
"statustext": "OK",
"messageack": {
"guids": [
{
"guid": "kl3a8194512311f442000x61t7",
"submitdate": "2021-03-10 08:19:45",
"id": "id105",
"errors": [
{
"errorcode": 28682,
"errortext": "Invalid ReceiverId",
"seq": "seqid112"
}
]
}
]
}
}
Following are the required parameters:
Parameter Description
clientid Client ID for authentication
clientpassword Client Password for authentication
to Recipient number.
8
Extended Parameters
Following are the extended parameters that are supported by the
Infinito HTTPS API. Please note that all variables are in small case.
Variable Type Description
Name
charset String Charset of text message. Used to convert
to a format suitable for
7 bits or to UCS-2. Defaults to WINDOWS-
1252 if coding is 7bits and UTF-16BE if
coding is UCS-2.
udh String Optional User Data Header (UDH) part of
the message.
User-defined data header. The data header
is used for long messages as well as
sending binary content. If you need to send
message to specific port (for j2me
application to receive), you may specify the
information in udh parameters.
Must be URL encoded.
mclass Number Optional. Sets the Message Class in DCS
field. Accepts
Values between 0 and 3, for Message
9
8: Delivered to SMSC,
16: Non-Delivered to SMSC.
Must set dlr-url on sendsms-user group or
use the dlr
url CGI variable.
dlr-url String Optional. Specify the path on which
URL Delivery report need to be returned. This is
a path on your server, which shall be called
in when a delivery report is received from
the Operator against an outgoing message.
(Must be url-encoded)
alt-dcs Number Optional. If unset, Kannel uses the alt-dcs
defined on
SMSC configuration or 0X per default. If
equals to 1,
uses FX.
If equals to 0, force 0X.
rpi Number Optional. Sets the Return Path Indicator
(RPI) value.
(See ETSI Documentation).
priority Number Optional. Sets the Priority value (Range 0-
number 3 is allowed).
DLR URL
Customer can use following sample URL for receiving the DLR: