HTTP API V5.
Integration Manual
INTRODUCTION
This document provides the guidelines on how to use the HTTP(s) SMS API interface for sending a
single SMS or bulk SMS to valid Mobile phone numbers.
Users should submit all requests over HTTPs to the host: [Link]
The parameters used for sending the SMS messages are described in the following:
• Username : Represents the username of the created account
• Password : Use apikey provided from Diginov
• MSISDN : Valid mobile number where the SMS is to be sent / Valid email address
• Sender : Registered Sender ID.
• Message : Body of the message.
• Channel : Messaging channel , Option are : 1 = sms, 2=whatsapp, 5 = email
• Msgtemp : Registered Whatsapp template
• Attachment : Whatsapp / Email file attachment, please provide valid file url.
The parameters used for receiving DLRs are described in the following:
• Messageid : message id to be use in case if any enquiry about the message
• Msisdn : Pushed phone number / Email
• Sender: Pushed sender id
• Dlrstatus : message status (Delivered, Undelivered, Failed)
• Description : dlrstatus description
• Date : date message received
1. Sending Message
The messages are submitted by HTTP(s) post request via the following URI:
[Link]
The JSON HTTP Body request contains the following parameters :
• Username
• Password
• Msisdn
• Message
• Sender
• Channel
• Msgtemp
• Attachment
Example of SMS HTTP(s) post request:
{
"username":"userid",
"password":"API KEY",
"msisdn":"6281192020900",
"message":"Hi This IS Your Message",
"sender":"BUKALAPAK",
"channel":1
}
Example of Whatsapp HTTP(s) post request:
{
"username":"userid",
"password":"API KEY",
"msisdn":"6281192020900",
"message":"Hi This IS Your Message",
"sender":"BUKALAPAK",
"channel":2,
"msgtemp":"otp_1",
"attachment":"[Link]
}
Example of Email HTTP(s) post request:
{
"username":"userid",
"password":"API KEY",
"msisdn":"someone@[Link]",
"message":"Hi This IS Your Message",
"sender":"BUKALAPAK",
"subject":"Email Subject",
"channel":2,
"msgtemp":"Marketing Promotion",
"attachment":"[Link]
After submitting the HTTP request using get or post method, you will get a response containing
the following parameters:
• ErrorCode : State of the message
• Description : ErrorCode description
• Id : message id to be use in case if any enquiry about the message
• Sender : Alpha/Numneric/AlphaNumeric source of the Message(Sender ID)
• Destination : Mobile Destination Number
• MessageCount : The number of sent messages
Error Code Description
- 0 : ok
- 1 : Invalid Credential
- 2 : Invalid MSISDN / Invalid Email / Invalid Sender(sender not registered)
- 3 : Invalid Message (message empty)
- 4 : Ip Blocked (Please contact us to release the block)
- 5 : Empty Quota / Period Over
Example of http response :
{
"ErrorCode":0,
"Description":"Ok",
"sms":
{
"Id":241050,
"Sender":"BUKALAPAK",
"Destination":"6282210508808",
"MessageCount":1
}
}
2. Delivery Report
After you have sent some messages, you will be able to check if the messages successfully
delivered or not by providing a webhook at our dashboard.
Please login to [Link] and select setting->webhook.
Input webhook url and also header authentication if needed.
We will push the Delivery Report using HTTP get protocol mechanism through public internet.
Pushed Parameter :
- messageid : message id to be use in case if any enquiry about the message
- msisdn : Pushed phone number
- sender: Pushed sender id
- dlrstatus : message status (Delivered, Sent, Failed)
- description : Undelivered, Expired, Invalid MSISDN, Balance Empty, Read
- date : date message received
Example of pushed DR without header authentication:
curl --location
'[Link]
r=clientsid&dlrstatus=Failed&description=Invalid+MSISDN&date=%202020-07-
09%09%3A54%3A30' \
Example of pushed DR with header authentication:
curl --location
‘[Link]
r=clientsid&dlrstatus=Failed&description=Invalid+MSISDN&date=%202020-07-
09%09%3A54%3A30' \ --header 'Authorization: oubyvDYsJG0nv6ikGjIOL6ilQxanhdbq'
3. Check Balance & Period
3.1 By Email
We will send your balance notification based on credit limit warning you requested, ie: credit
limit warning at IDR 1 Million, this means that we will send you email notification when your
balance hit 1 million and bellow.
3.2 Balance API
You can check you balance periodically by using our API. Submit your request to this url :
[Link]
with this json body format :
{"username":"Youruserid","password":"yourpassword"}.
Request Return :
{ "ErrorCode": 0, "Description": "Ok", "BalanceDetail": { "Currency": "IDR", "Balance": "160",
"Period": "2020-10-09 14:08:38" } }