Public
Documentation Settings
No Environment
Double Column
cURL - cURL
Blinkage API
Introduction
Send SMS
Black List
Sender
User information
Short URL

Blinkage API

use this API endpoint to send SMS messages

Send SMS

POSTsend-sms

https://www.blinkage.com/send-sms/api
Bodyurlencoded
password

123456789a

your blinkage password

user_id

XXXXXXXXXXXXXXXX

User id. you can retrieve it from the website.

message

Hi {firstName}, transaction number: {transactionNumber} is success, please visit our website for more information.

text message, you can insert categories with this format "{category_name}"

recipients

[{"phone_number": "+972540000000","firstName": "Avi", "transactionNumber":"123456789"},{"phone_number": "+972500000000", "firsName": "David""transactionNumber":"123456788"},{"phone_number": "+972520000000", "firsName": "David""transactionNumber":"123456787"}]

array of objects, etch object must contain "phone_number", with the option to insert recipient categories

sender_id

Blinkage

sender id, will be displayed in the sms title, 11 chars maximum - for phone number sender you must verify the number first

delivery_delay

0

delivery delay in minutes

unique_id

50005d0dfffxc

transaction unique id, you can use it to identify this transation

channel

sms

use "sms" to send sms messages

webhook_url

https://yoursite.com/webhook

optional - your custome endpoint url to get webhook updates of your transactions you can find the transaction by the unique_id - maximum 255 chars length

is_short_link

true

optional - will replace all the links you have in the message to short link

Example Request
send-sms
curl
curl --location 'https://www.blinkage.com/send-sms/api' \
--data-urlencode 'password=123456789a' \
--data-urlencode 'user_id=XXXXXXXXXXXXXXXX' \
--data-urlencode 'message=Hi {firstName}, transaction number: {transactionNumber} is success, please visit our website for more information.' \
--data-urlencode 'recipients=[{"phone_number": "+972540000000","firstName": "Avi", "transactionNumber":"123456789"},{"phone_number": "+972500000000", "firsName": "David""transactionNumber":"123456788"},{"phone_number": "+972520000000", "firsName": "David""transactionNumber":"123456787"}]' \
--data-urlencode 'sender_id=Blinkage' \
--data-urlencode 'delivery_delay=0' \
--data-urlencode 'unique_id=50005d0dfffxc' \
--data-urlencode 'channel=sms' \
--data-urlencode 'webhook_url=https://yoursite.com/webhook' \
--data-urlencode 'is_short_link=true'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POSTsearch by phone

https://www.blinkage.com/management/api/get-tx-details
Bodyurlencoded
user_id

XXXXXXXXXXXXXXXXXX

Your Blinkage user id

password

123456789a

Your Blinkage password

phone

+10000000

Phone number you wish to search

Example Request
search by phone
curl
curl --location 'https://www.blinkage.com/management/api/get-tx-details' \
--data-urlencode 'user_id=XXXXXXXXXXXXXXXXXX' \
--data-urlencode 'password=123456789a' \
--data-urlencode 'phone=+10000000'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POSTwebhook example

https://your.web/webhook-url
Bodyraw (json)
json
{
    "id": "0717481a-2d9d-47ab-b3f1-cab637r02ddc", // Blinkage unique ID
    "createdAt": "2022-12-06 18:04:24.689",
    "errorCode": 0,
    "errorMessage": "OK",
    "status": "DELIVERED",
    "isSuccess": true,
    "sentTime": "2022-12-06 18:04:24.989",
    "channel": "SMS",
    "webhookUrl": "https://your.web/webhook-url",
    "uniqueId": "cdb798cf-d3b6-4a4a-ad6e-95644bfd8845", // your unique id
    "recipients": "+972501234567"
}
Example Request
webhook example
curl
curl --location 'https://your.web/webhook-url' \
--data '{
    "id": "0717481a-2d9d-47ab-b3f1-cab637r02ddc", // Blinkage unique ID
    "createdAt": "2022-12-06 18:04:24.689",
    "errorCode": 0,
    "errorMessage": "OK",
    "status": "DELIVERED",
    "isSuccess": true,
    "sentTime": "2022-12-06 18:04:24.989",
    "channel": "SMS",
    "webhookUrl": "https://your.web/webhook-url",
    "uniqueId": "cdb798cf-d3b6-4a4a-ad6e-95644bfd8845", // your unique id
    "recipients": "+972501234567"
}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers