uBill proqramçıları REST API · v1 İş mühiti

Tam API sənədləri

SMS və billinq API resursları bir yerdə: dəqiq endpoint-lər, tam Postman təsvirləri, başlıqlar, sorğu gövdələri, cavab nümunələri və hazır kod.

24 endpoint API açarı ilə giriş JSON / XML
POST /v1/sms/send
1curl --request POST \2  --url api.ubill.dev/v1/sms/send \3  --header 'key: ••••••••'
200 OK{ "statusID": 0, "message": "SMS Sent" }
BAŞLANĞIC

uBill API ilə iş

UBill API resurslarımıza proqram vasitəsilə çıxış verir. Xidməti sisteminizə inteqrasiya edib müştərilərlə rahat əlaqə qurun.

API nümunələri

Müxtəlif mənbələrdən fərqli proqramlaşdırma dillərində API tətbiqləri.

Postman-a üstünlük verirsiniz?

Sənədlər və API sorğuları ilə uBill-in açıq Postman kolleksiyasında da tanış olun.

Postman-da aç
Əsas URL https://api.ubill.dev
Versiya v1
Protokol HTTPS
Kodlaşdırma UTF-8
01
TƏHLÜKƏSİZLİK

Autentifikasiya

Qorunan endpoint sorğularında şirkətinizin məxfi API açarı olmalıdır. Əksəriyyəti onu bu başlıqda qəbul edir: key başlığında; bəzi köhnə GET/XML endpoint-ləri istifadə edir: key sorğu parametrindən.

API açarınızı açıqlamayın

Açarı server mühit dəyişənində saxlayın. Frontend JavaScript, mobil tətbiq və ya açıq Git repozitoriyasına daxil etməyin.

Sorğu başlıqları
key: YOUR_API_KEY
Content-Type: application/json
02
QAYDALAR

Formatlar və statuslar

API əsasən JSON cavabları qaytarır. statusID sahəsi nəticəni bildirir; uğurlu sorğunun dəyəri 0 . XML endpoint XML cavabı qaytarır.

0 SMS göndərildi
1 Alındı
2 Çatdırılmadı
3 Status gözlənilir
4 Xəta
API ARAYIŞI

Bütün resurslar və endpoint-lər

Aşağıdakı məlumat açıq Postman kolleksiyasının son versiyası ilə sinxronlaşdırılıb.

API QRUPU

SMS API

11 endpoint

SMS API / Göndərən adı yarat

Göndərən adı yarat

API açarı · Başlıq
POST https://api.ubill.dev /v1/sms/brandNameCreate

Cavab statusu

statusID Təsvir
0 Göndərən adı yaradıldı
10 brandName sahəsi boşdur
20 brandName 2–11 simvoldan ibarət olmalıdır
30 brandName icazəsiz işarələr ehtiva edir
40 brandName artıq əlavə olunub
50 Son əlavə olunmuş brandName təsdiqini gözləyin
60The description field is required. Specify your website, Facebook/Instagram page or application and how you will use the brandName.
61The description must not exceed 500 characters
90 JSON xətası
99 Ümumi xəta

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Sorğu gövdəsi JSON

Sorğu gövdəsi
{
    "brandName" : "test"
}

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request POST \
  --url 'https://api.ubill.dev/v1/sms/brandNameCreate' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "brandName" : "test"
}'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/sms/brandNameCreate',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => <<<'BODY'
{
    "brandName" : "test"
}
BODY,
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/sms/brandNameCreate',
  {
  method: 'POST',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: "{\n    \"brandName\" : \"test\"\n}"
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

1 nümunə
Göndərən adı yarat Nümunə
Cavab · JSON
{
    "statusID": 0,
    "brandID": 1,
    "message": "BrandName Created"
}
SMS API / Göndərən adını sil

Göndərən adını sil

API açarı · Başlıq
POST https://api.ubill.dev /v1/sms/brandNameDelete

Cavab statusu

statusID Təsvir
0 Göndərən adı silindi
10 Göndərən adı tapılmadı
90 JSON xətası
99 Ümumi xəta

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Sorğu gövdəsi JSON

Sorğu gövdəsi
{
    "brandID": 2
}

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request POST \
  --url 'https://api.ubill.dev/v1/sms/brandNameDelete' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "brandID": 2
}'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/sms/brandNameDelete',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => <<<'BODY'
{
    "brandID": 2
}
BODY,
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/sms/brandNameDelete',
  {
  method: 'POST',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: "{\n    \"brandID\": 2\n}"
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

1 nümunə
Göndərən adını sil Nümunə
Cavab · JSON
{
    "statusID": 0,
    "brandID": "2",
    "message": "BrandName Deleted"
}
SMS API / Bütün göndərən adlarını al

Bütün göndərən adlarını al

API açarı · Başlıq
GET https://api.ubill.dev /v1/sms/brandNames
Bu endpoint-in Postman kolleksiyasında ayrıca təsviri yoxdur.

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request GET \
  --url 'https://api.ubill.dev/v1/sms/brandNames' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/sms/brandNames',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/sms/brandNames',
  {
  method: 'GET',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

1 nümunə
Bütün göndərən adlarını al Nümunə
Cavab · JSON
{
    "statusID": 0,
    "data": [
        {
            "id": "1",
            "name": "test",
            "authorized": "1",
            "createdAt": "2020-11-14 20:42:44"
        },
        {
            "id": "2",
            "name": "test2",
            "authorized": "2",
            "createdAt": "2021-03-27 00:22:38"
        }
    ]
}
SMS API / SMS göndər

SMS göndər

API açarı · Sorğu
GET https://api.ubill.dev /v1/sms/send?key=YOUR_API_KEY&brandID=1&numbers=9955XXXXXXXX,9955XXXXXXXX&text=message&stopList=false

Məcburi parametrlər

Parametr Təsvir
key Sorğuların təsdiqi üçün məxfi API açarı. Şirkət parametrlərində baxın və idarə edin.
brandID Sistemdə unikal brend identifikatoru.
numbers Vergüllə ayrılmış mobil nömrələr. Beynəlxalq format tələb olunur olmadan 00 və ya +.
text SMS mətni. Bütün Unicode simvolları dəstəklənir.

İxtiyari parametrlər

Parametr Təsvir
stopList stopList=false — stop-siyahı yoxlamasını söndürür. Nömrə siyahıda olsa belə mesaj göndərilir.
otp otp=true — mesajı OTP (birdəfəlik şifrə / təsdiq kodu) kimi işarələyir.
OTP mesajları ən yüksək prioritetlə emal olunur.
⚠️ İstifadə olunmalıdır yalnız giriş təsdiqi kodları üçün.
sendTime Planlı SMS çatdırılma vaxtı.
Format: Y-m-d H:i (məsələn: 2026-02-01 23:30).
Göstərilən vaxt gələcəkdə olmalıdır.
Göstərilməzsə dərhal göndərilir.
callbackUrl Bu SMS sorğusu üçün fərdi callback URL-i. Yalnız API tətbiqində qlobal standart callback URL-i təyin olunubsa işləyir.

Qeydlər

  • OTP yalnız giriş, təsdiq və şifrə sıfırlama kimi autentifikasiya prosesləri üçündür.

  • Yanlış istifadə olunan otp parametri çatdırılma və ya hesab məhdudiyyətlərinə səbəb ola bilər.


Cavab statusu

statusID Təsvir
0 SMS göndərildi
10 brandID tapılmadı
20 Nömrələr tapılmadı
30 Mesaj mətni boşdur
40 SMS balansı kifayət deyil
50 Etibarlı nömrələr tapılmadı
60 sendTime formatı yanlışdır. Y-m-d H:i istifadə edin
90 JSON xətası
99 Ümumi xəta

⚠️ GET metodunun məhdudiyyətləri

  • API sərt limit qoymur alıcı nömrələrinin sayına.

  • Faktiki məhdudiyyətləri yaradır: URL və HTTP başlıq ölçü hədləri (Cloudflare, proksilər, brauzerlər).

Praktik hədlər

  • ✅ Sorğuda təxminən 1500 nömrəyədək etibarlı işləyir.

  • ⚠️ Təxminən 2000-dən çox nömrə yarada bilər: Header overflow xətaları.

  • Bu xətalar yaranır sorğu API-yə çatmazdan əvvəl , HTTP / proksi səviyyəsində.

Tövsiyə

  • İstifadə edin: GET yalnız kiçik və orta sorğular üçün.

  • Böyük alıcı siyahılarında həmişə istifadə edin: POST.

URL parametrləri 5

keyqueryYOUR_API_KEY
brandIDquery1
numbersquery9955XXXXXXXX,9955XXXXXXXX
textquerymessage
stopListqueryfalse

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request GET \
  --url 'https://api.ubill.dev/v1/sms/send?key=YOUR_API_KEY&brandID=1&numbers=9955XXXXXXXX,9955XXXXXXXX&text=message&stopList=false'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/sms/send?key=YOUR_API_KEY&brandID=1&numbers=9955XXXXXXXX,9955XXXXXXXX&text=message&stopList=false',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET'
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/sms/send?key=YOUR_API_KEY&brandID=1&numbers=9955XXXXXXXX,9955XXXXXXXX&text=message&stopList=false',
  {
  method: 'GET'
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

1 nümunə
SMS göndər Nümunə
Cavab · JSON
{
    "statusID": 0,
    "smsID": "117345",
    "message": "SMS Sent"
}
SMS API / SMS göndər

SMS göndər

API açarı · Başlıq
POST https://api.ubill.dev /v1/sms/send

Başlıqlar

Açar Dəyər
key Məxfi API açarınız
Content-Type application/json

Məcburi parametrlər (JSON gövdəsi)

Parametr Təsvir
brandID Sistemdə unikal brend identifikatoru.
numbers Mobil nömrələr massivi. Beynəlxalq format tələb olunur olmadan 00 və ya + . Nümunə: ["9955XXXXXXXX","9955XXXXXXXX"]
text SMS mətni. Bütün Unicode simvolları dəstəklənir.

İxtiyari parametrlər (JSON gövdəsi)

Parametr Təsvir
stopList false — stop-siyahı yoxlamasını söndürür. Nömrə siyahıda olsa belə mesaj göndərilir.
otp true — mesajı OTP (birdəfəlik şifrə / təsdiq kodu) kimi işarələyir.
OTP mesajları ən yüksək prioritetlə emal olunur.
⚠️ İstifadə olunmalıdır yalnız giriş təsdiqi kodları üçün.
sendTime Planlı SMS çatdırılma vaxtı. Format: Y-m-d H:i (məsələn: "2026-02-01 23:30" ). Gələcəkdə olmalıdır. Verilməzsə dərhal göndərilir.
callbackUrl Bu SMS sorğusu üçün fərdi callback URL-i. Yalnız API tətbiqində qlobal standart callback URL-i təyin olunubsa işləyir.

Qeydlər

  • OTP yalnız giriş, təsdiq və şifrə sıfırlama kimi autentifikasiya prosesləri üçündür.

  • Yanlış istifadə olunan otp parametri çatdırılma və ya hesab məhdudiyyətlərinə səbəb ola bilər.

Cavab statusu

statusID Təsvir
0 SMS göndərildi
10 brandID tapılmadı
20 Nömrələr tapılmadı
30 Mesaj mətni boşdur
40 SMS balansı kifayət deyil
50 Etibarlı nömrələr tapılmadı
60 sendTime formatı yanlışdır. Y-m-d H:i istifadə edin
90 JSON xətası
99 Ümumi xəta

⚠️ Hədlər və qeydlər

  • Maksimum sorğu gövdəsi: 100 MB → Daha böyük sorğular rədd edilir.

  • Cloudflare proksi gözləmə həddi: 100 saniyə → Daha uzun sorğular 524 Timeout qaytarır.

  • Gözləmə və yaddaş problemlərini önləmək üçün böyük SMS sorğularını kiçik hissələrə bölün.

  • İstifadə edin: stopList bloklanmış nömrələrə göndərişin qarşısını almaq üçün.

Sınaqdan praktik müşahidə:

Sınaqlarımızda uğurla göndərilib: bir sorğuda 500 000 nömrəyə qədər . Daha çoxu yaddaş, gözləmə və sorğu ölçüsü problemləri yarada bilər. Faktiki hədlər mətn uzunluğu, kodlaşdırma və server yükündən asılıdır.

Tövsiyə:

Təhlükəsiz və etibarlı iş üçün sorğuları məhdudlaşdırın: hər paketdə təxminən 100 000 nömrə .

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Sorğu gövdəsi JSON

Sorğu gövdəsi
{
    "brandID": 1,
    "numbers": [
        9955XXXXXXXX,
        9955XXXXXXXX
    ],
    "text": "Message",
    "stopList": false, // Enable/disable checking numbers in the stop list
    "sendTime": "2026-02-01 23:01" // sendTime (optional)
}

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request POST \
  --url 'https://api.ubill.dev/v1/sms/send' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "brandID": 1,
    "numbers": [
        9955XXXXXXXX,
        9955XXXXXXXX
    ],
    "text": "Message",
    "stopList": false, // Enable/disable checking numbers in the stop list
    "sendTime": "2026-02-01 23:01" // sendTime (optional)
}'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/sms/send',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => <<<'BODY'
{
    "brandID": 1,
    "numbers": [
        9955XXXXXXXX,
        9955XXXXXXXX
    ],
    "text": "Message",
    "stopList": false, // Enable/disable checking numbers in the stop list
    "sendTime": "2026-02-01 23:01" // sendTime (optional)
}
BODY,
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/sms/send',
  {
  method: 'POST',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: "{\n    \"brandID\": 1,\n    \"numbers\": [\n        9955XXXXXXXX,\n        9955XXXXXXXX\n    ],\n    \"text\": \"Message\",\n    \"stopList\": false, // Enable/disable checking numbers in the stop list\n    \"sendTime\": \"2026-02-01 23:01\" // sendTime (optional)\n}"
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

1 nümunə
SMS göndər Nümunə
Cavab · JSON
{
    "statusID": 0,
    "smsID": 111,
    "message": "SMS Sended"
}
SMS API / SMS göndər — fərqli mətnlər

SMS göndər — fərqli mətnlər

API açarı · Başlıq
POST https://api.ubill.dev /v1/sms/send

Başlıqlar

Açar Dəyər
key Məxfi API açarınız
Content-Type application/json

Məcburi parametrlər (JSON gövdəsi)

Parametr Təsvir
brandID Sistemdə unikal brend identifikatoru.
numbers Mobil nömrələr massivi. Beynəlxalq format tələb olunur olmadan 00 və ya + . Nümunə: ["9955XXXXXXXX","9955XXXXXXXX"]
text SMS mətni. Bütün Unicode simvolları dəstəklənir.

İxtiyari parametrlər (JSON gövdəsi)

Parametr Təsvir
stopList false — stop-siyahı yoxlamasını söndürür. Nömrə siyahıda olsa belə mesaj göndərilir.
otp true — mesajı OTP (birdəfəlik şifrə / təsdiq kodu) kimi işarələyir.
OTP mesajları ən yüksək prioritetlə emal olunur.
⚠️ İstifadə olunmalıdır yalnız giriş təsdiqi kodları üçün.
sendTime Planlı SMS çatdırılma vaxtı. Format: Y-m-d H:i (məsələn: "2026-02-01 23:30" ). Gələcəkdə olmalıdır. Verilməzsə dərhal göndərilir.
callbackUrl Bu SMS sorğusu üçün fərdi callback URL-i. Yalnız API tətbiqində qlobal standart callback URL-i təyin olunubsa işləyir.

Qeydlər

  • OTP yalnız giriş, təsdiq və şifrə sıfırlama kimi autentifikasiya prosesləri üçündür.

  • Yanlış istifadə olunan otp parametri çatdırılma və ya hesab məhdudiyyətlərinə səbəb ola bilər.


Cavab statusu

statusID Təsvir
0 SMS göndərildi
10 brandID tapılmadı
20 Nömrələr tapılmadı
30 Mesaj mətni boşdur
40 SMS balansı kifayət deyil
50 Etibarlı nömrələr tapılmadı
60 sendTime formatı yanlışdır. Y-m-d H:i istifadə edin
90 JSON xətası
99 Ümumi xəta

⚠️ Hədlər və qeydlər

  • Maksimum sorğu gövdəsi: 100 MB → Daha böyük sorğular rədd edilir.

  • Cloudflare proksi gözləmə həddi: 100 saniyə → Daha uzun sorğular 524 Timeout qaytarır.

  • Gözləmə və yaddaş problemlərini önləmək üçün böyük SMS sorğularını kiçik hissələrə bölün.

  • İstifadə edin: stopList bloklanmış nömrələrə göndərişin qarşısını almaq üçün.

Sınaqdan praktik müşahidə:

Alıcıya düşən SMS Sorğuda maksimum nömrə sayı
1 400,000
2 200,000
3 150,000
4 120,000
5 100,000
6 50,000

Faktiki hədlər mətn uzunluğu, kodlaşdırma və server yükündən asılıdır.

Tövsiyə:

Etibarlı iş üçün birləşdirilmiş SMS sayına uyğun yuxarıda göstərilən nömrə hədlərinə riayət edin.

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Sorğu gövdəsi JSON

Sorğu gövdəsi
{
    "brandID": 1,
    "numbers": [
        {
            "number": 9955XXXXXXXX,
            "text": "Hello, Nicholas"
        },
        {
            "number": 9955XXXXXXXX,
            "text": "Hello, George"
        }
    ],
    "stopList": false, // Enable/disable checking numbers in the stop list
    "sendTime": "2026-02-01 23:01" // sendTime (optional)
}

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request POST \
  --url 'https://api.ubill.dev/v1/sms/send' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "brandID": 1,
    "numbers": [
        {
            "number": 9955XXXXXXXX,
            "text": "Hello, Nicholas"
        },
        {
            "number": 9955XXXXXXXX,
            "text": "Hello, George"
        }
    ],
    "stopList": false, // Enable/disable checking numbers in the stop list
    "sendTime": "2026-02-01 23:01" // sendTime (optional)
}'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/sms/send',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => <<<'BODY'
{
    "brandID": 1,
    "numbers": [
        {
            "number": 9955XXXXXXXX,
            "text": "Hello, Nicholas"
        },
        {
            "number": 9955XXXXXXXX,
            "text": "Hello, George"
        }
    ],
    "stopList": false, // Enable/disable checking numbers in the stop list
    "sendTime": "2026-02-01 23:01" // sendTime (optional)
}
BODY,
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/sms/send',
  {
  method: 'POST',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: "{\n    \"brandID\": 1,\n    \"numbers\": [\n        {\n            \"number\": 9955XXXXXXXX,\n            \"text\": \"Hello, Nicholas\"\n        },\n        {\n            \"number\": 9955XXXXXXXX,\n            \"text\": \"Hello, George\"\n        }\n    ],\n    \"stopList\": false, // Enable/disable checking numbers in the stop list\n    \"sendTime\": \"2026-02-01 23:01\" // sendTime (optional)\n}"
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

1 nümunə
SMS göndər — fərqli mətnlər Nümunə
Cavab · JSON
{
    "statusID": 0,
    "smsID": 111,
    "message": "SMS Sended"
}
SMS API / XML ilə SMS göndər

XML ilə SMS göndər

API açarı · Sorğu
POST https://api.ubill.dev /v1/sms/sendXml?key=YOUR_API_KEY

Cavab statusu

statusID Təsvir
0 SMS göndərildi
10 brandID tapılmadı
20 Nömrələr tapılmadı
30 Mesaj mətni boşdur
40 SMS balansı kifayət deyil
50 Etibarlı nömrələr tapılmadı
90 JSON xətası
99 Ümumi xəta

⚠️ Hədlər və qeydlər

  • Maksimum sorğu gövdəsi: 100 MB → Daha böyük sorğular rədd edilir.

  • Cloudflare proksi gözləmə həddi: 100 saniyə → Daha uzun sorğular qaytarır: 524 Timeout.

  • Böyük SMS sorğularını kiçik hissələrə bölərək gözləmə və yaddaş problemlərini önləyin.

  • İstifadə edin: stopList bloklanmış nömrələrə göndərişin qarşısını almaq üçün.

URL parametrləri 1

keyqueryYOUR_API_KEY

Sorğu gövdəsi XML

Sorğu gövdəsi
<?xml version="1.0" encoding="UTF-8"?>
<request>
    <brandID>1</brandID>
    <numbers>9955XXXXXXXX</numbers>
    <text>test</text>
    <stopList>false</stopList> <!-- Enable/disable checking numbers in the stop list -->
</request>

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request POST \
  --url 'https://api.ubill.dev/v1/sms/sendXml?key=YOUR_API_KEY' \
  --data '<?xml version="1.0" encoding="UTF-8"?>
<request>
    <brandID>1</brandID>
    <numbers>9955XXXXXXXX</numbers>
    <text>test</text>
    <stopList>false</stopList> <!-- Enable/disable checking numbers in the stop list -->
</request>'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/sms/sendXml?key=YOUR_API_KEY',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => <<<'BODY'
<?xml version="1.0" encoding="UTF-8"?>
<request>
    <brandID>1</brandID>
    <numbers>9955XXXXXXXX</numbers>
    <text>test</text>
    <stopList>false</stopList> <!-- Enable/disable checking numbers in the stop list -->
</request>
BODY
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/sms/sendXml?key=YOUR_API_KEY',
  {
  method: 'POST',
  body: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request>\n    <brandID>1</brandID>\n    <numbers>9955XXXXXXXX</numbers>\n    <text>test</text>\n    <stopList>false</stopList> <!-- Enable/disable checking numbers in the stop list -->\n</request>"
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

1 nümunə
XML ilə SMS göndər Nümunə
Cavab · XML
<?xml version="1.0" encoding="UTF-8"?>
<response>
    <statusID>0</statusID>
    <smsID>11574</smsID>
    <message>SMS Sent</message>
</response>
SMS API / Çatdırılma hesabatı

Çatdırılma hesabatı

API açarı · Başlıq
GET https://api.ubill.dev /v1/sms/report/{smsID}

Statuslar

statusID Təsvir
0 Göndərildi
1 Alındı
2 Çatdırılmadı
3 Status gözlənilir
4 Xəta

URL parametrləri 1

smsIDpath{smsID}

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request GET \
  --url 'https://api.ubill.dev/v1/sms/report/{smsID}' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/sms/report/{smsID}',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/sms/report/{smsID}',
  {
  method: 'GET',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

1 nümunə
Çatdırılma hesabatı Nümunə
Cavab · JSON
{
    "statusID": 0,
    "result": [
        {
            "number": "9955XXXXXXXX",
            "statusID": "0"
        },
        {
            "number": "9955XXXXXXXX",
            "statusID": "0"
        }
    ]
}
SMS API / SMS balansını al

SMS balansını al

API açarı · Sorğu
GET https://api.ubill.dev /v1/sms/balance?key=YOUR_API_KEY
Bu endpoint-in Postman kolleksiyasında ayrıca təsviri yoxdur.

URL parametrləri 1

keyqueryYOUR_API_KEY

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request GET \
  --url 'https://api.ubill.dev/v1/sms/balance?key=YOUR_API_KEY'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/sms/balance?key=YOUR_API_KEY',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET'
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/sms/balance?key=YOUR_API_KEY',
  {
  method: 'GET'
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

1 nümunə
SMS balansını al Nümunə
Cavab · JSON
{
    "statusID": 0,
    "sms": 5000
}
SMS API / API hadisələrinin geri çağırışları

API hadisələrinin geri çağırışları

API açarı · Sorğu
GET https://example.com/callback?key=YourCallbackKey&event=sms.brand.activated&brandID=12&brandName=MyBrand&authorized=1&date=2026-08-10 15:30:00

API hadisələrinin geri çağırışları

API tətbiqinin parametrlərində bir ortaq ünvan var: HTTPS callback URL-i . Çatdırılma hesabatları, SMS brend aktivləşməsi və gələcək API hadisələri eyni ünvana göndərilir: GET sorğusu .

İstifadə edin: event parametrini bildiriş növünü müəyyən etmək üçün. Uğurlu emaldan sonra qaytarın: 2xx uğurlu HTTP statusu.

Ümumi parametrlər

Parametr Təsvir
key API tətbiqindəki callback yoxlama açarı
event Hadisə növü
date Hadisə vaxtı ( Y-m-d H:i:s)

Dəstəklənən hadisələr

Hadisə Əlavə parametrlər
sms.delivery.updatedsmsID, number, statusID
sms.brand.activatedbrandID, brandName, authorized=1

SMS brend aktivləşməsi nümunəsi

https://example.com/callback?key=YourCallbackKey&event=sms.brand.activated&brandID=12&brandName=MyBrand&authorized=1&date=2026-08-10%2015:30:00

URL parametrləri 6

keyqueryYourCallbackKey
eventquerysms.brand.activated
brandIDquery12
brandNamequeryMyBrand
authorizedquery1
datequery2026-08-10 15:30:00

Kod nümunələri

cURL · PHP · JavaScript

Cavab nümunələri

0 nümunə
Bu endpoint üçün cavab nümunəsi yoxdur.
SMS API / SMS çatdırılma geri çağırışı

SMS çatdırılma geri çağırışı

API açarı · Sorğu
GET https://example.com/callback?key=YourCallbackKey&event=sms.delivery.updated&smsID=12345678&number=9955XXXXXXXX&statusID=1&date=2026-02-01 12:02:02

Avtomatik mesaj statusu (Callback)

SMS API göndərilmiş mesajların statusunu serverinizdə avtomatik almağa imkan verir: Geri çağırış mexanizmi.

Mesajın statusu dəyişdikdə (göndərildi, alındı, çatdırılmadı və s.) sistem göndərir: GET sorğusu təyin etdiyiniz ünvana HTTPS ünvanı .

Callback URL tələbləri:

  • Bununla başlamalıdır: https://

  • Metod: GET

  • Şirkətin API parametrlərində təyin olunur

Parametrlər

Parametr Təsvir
key Serverinizin callback yoxlama açarı
smsID Mesajın unikal identifikatoru
number Alıcının mobil nömrəsi (beynəlxalq format)
statusID Mesajın cari status kodu
date Statusun yenilənmə vaxtı ( Y-m-d H:i:s)

Status kodları

statusID Təsvir
0 Göndərildi
1 Alındı
2 Çatdırılmadı
3 Status gözlənilir
4 Xəta

Callback emalı nümunəsi (PHP)

$key    = $_GET['key'] ?? null;
$smsID    = $_GET['smsID'] ?? null;
$number   = $_GET['number'] ?? null;
$statusID = $_GET['statusID'] ?? null;
$date     = $_GET['date'] ?? null;

// Validation: ensure the key matches your callback key
if ($key !== 'YourCallbackKey') {
    http_response_code(403);
    echo 'Forbidden';
    exit;
}

// Process the received status in your system
http_response_code(200);
echo 'OK';
?>

URL parametrləri 6

keyqueryYourCallbackKey
eventquerysms.delivery.updated
smsIDquery12345678
numberquery9955XXXXXXXX
statusIDquery1
datequery2026-02-01 12:02:02

Kod nümunələri

cURL · PHP · JavaScript

Cavab nümunələri

0 nümunə
Bu endpoint üçün cavab nümunəsi yoxdur.
API QRUPU

Billinq API

13 endpoint

RESURS

Müştərilər

5 endpoint

Billinq API / Müştərilər / Bütün müştəriləri al

Bütün müştəriləri al

API açarı · Başlıq
GET https://api.ubill.dev /v1/customers
Bu endpoint-in Postman kolleksiyasında ayrıca təsviri yoxdur.

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request GET \
  --url 'https://api.ubill.dev/v1/customers' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/customers',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/customers',
  {
  method: 'GET',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

0 nümunə
Bu endpoint üçün cavab nümunəsi yoxdur.
Billinq API / Müştərilər / Müştəri yarat

Müştəri yarat

API açarı · Başlıq
POST https://api.ubill.dev /v1/customers/create

Telefon nömrələri ilə birlikdə yeni müştəri yaradır. Müştəri nömrəsi ( id cavabda, cID daxili olaraq) avtomatik yaradılır və şirkət daxilində unikaldır.

Tələb olunan icazə: customers.create . Sorğu gövdəsi JSON olmalıdır və Content-Type: application/json başlığı məcburidir.

Sorğu gövdəsi

Sahə Növ Məcburi Təsvir
typeID tam ədəd bəli Müştərinin hüquqi növü uBill növ siyahısında olmalıdır ( 1 = fiziki şəxs).
name sətir, maksimum 50 xeyr Müştəri adı.
personalNo sətir, maksimum 11 xeyr Şəxsi nömrə və ya şirkət kodu, yalnız hərf və rəqəmlər.
email sətir xeyr Verildikdə etibarlı e-poçt ünvanı olmalıdır.
birthDate sətir xeyr Tarix bu formatda: YYYY-MM-DD formatında.
lang sətir xeyr Bunlardan biri: ka, en, ru . Standart olaraq şirkətdə təyin olunan müştəri dili götürülür.
address sətir, maksimum 50 xeyr Müştəri ünvanı.
column1, column2 sətir, maksimum 50 xeyr Sərbəst əlavə sahələr.
numbers massiv bəli Müştərinin telefonları, ən azı biri məcburidir.

numbers[] obyekti

Sahə Növ Təsvir
number sətir Ölkə kodu olmadan yerli nömrə, 6–15 rəqəm.
mobile sətir Tam beynəlxalq nömrə. Bu açar işlədildikdə ölkə kodu nömrənin əvvəlindən çıxarılır.
countryCode sətir Ölkə kodu, standart: +995.
isPrimary 0 və ya 1 Əsas nömrəni işarələyir. Seçilməzsə, siyahının birinci nömrəsi əsas olur.
smsEnabled 0 və ya 1 Nömrənin SMS bildirişləri alması, standart: 1.
note sətir, maksimum 100 Nömrə üçün sərbəst qeyd.

Bir nömrə qısa formada da göndərilə bilər: {"mobile": "9955XXXXXXXX", "countryCode": "+995"} bunun əvəzinə: numbers massivi. Təkrarlar xəbərdarlıq olmadan silinir; eyni şirkətdə başqa müştəriyə aid nömrə rədd olunur.

Cavablar

HTTPstatusID Təsvir
2010 Müştəri yaradıldı, data yeni müştərini ehtiva edir.
400400 Yoxlama uğursuzdur, errors obyekti hər yanlış sahəni göstərir.
50099 Müştəri saxlanmadı, heç nə yazılmadı.

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Sorğu gövdəsi JSON

Sorğu gövdəsi
{
    "typeID": 1,
    "name": "გიორგი მაისურაძე",
    "personalNo": "XXXXXXXXXXX",
    "email": "[email protected]",
    "birthDate": "1990-05-17",
    "lang": "ka",
    "address": "ვაჟა-ფშაველას 1",
    "column1": "",
    "column2": "",
    "numbers": [
        {
            "number": "5XXXXXXXX",
            "countryCode": "+995",
            "isPrimary": 1,
            "smsEnabled": 1,
            "note": "პირადი"
        },
        {
            "mobile": "9955XXXXXXXX",
            "smsEnabled": 0,
            "note": "ბიოს"
        }
    ]
}

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request POST \
  --url 'https://api.ubill.dev/v1/customers/create' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "typeID": 1,
    "name": "გიორგი მაისურაძე",
    "personalNo": "XXXXXXXXXXX",
    "email": "[email protected]",
    "birthDate": "1990-05-17",
    "lang": "ka",
    "address": "ვაჟა-ფშაველას 1",
    "column1": "",
    "column2": "",
    "numbers": [
        {
            "number": "5XXXXXXXX",
            "countryCode": "+995",
            "isPrimary": 1,
            "smsEnabled": 1,
            "note": "პირადი"
        },
        {
            "mobile": "9955XXXXXXXX",
            "smsEnabled": 0,
            "note": "ბიოს"
        }
    ]
}'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/customers/create',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => <<<'BODY'
{
    "typeID": 1,
    "name": "გიორგი მაისურაძე",
    "personalNo": "XXXXXXXXXXX",
    "email": "[email protected]",
    "birthDate": "1990-05-17",
    "lang": "ka",
    "address": "ვაჟა-ფშაველას 1",
    "column1": "",
    "column2": "",
    "numbers": [
        {
            "number": "5XXXXXXXX",
            "countryCode": "+995",
            "isPrimary": 1,
            "smsEnabled": 1,
            "note": "პირადი"
        },
        {
            "mobile": "9955XXXXXXXX",
            "smsEnabled": 0,
            "note": "ბიოს"
        }
    ]
}
BODY,
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/customers/create',
  {
  method: 'POST',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: "{\n    \"typeID\": 1,\n    \"name\": \"გიორგი მაისურაძე\",\n    \"personalNo\": \"XXXXXXXXXXX\",\n    \"email\": \"[email protected]\",\n    \"birthDate\": \"1990-05-17\",\n    \"lang\": \"ka\",\n    \"address\": \"ვაჟა-ფშაველას 1\",\n    \"column1\": \"\",\n    \"column2\": \"\",\n    \"numbers\": [\n        {\n            \"number\": \"5XXXXXXXX\",\n            \"countryCode\": \"+995\",\n            \"isPrimary\": 1,\n            \"smsEnabled\": 1,\n            \"note\": \"პირადი\"\n        },\n        {\n            \"mobile\": \"9955XXXXXXXX\",\n            \"smsEnabled\": 0,\n            \"note\": \"ბიოს\"\n        }\n    ]\n}"
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

3 nümunə
Müştəri yaradıldı 201
Cavab · JSON
{
    "statusID": 0,
    "message": "Customer created",
    "data": {
        "id": 100001,
        "typeID": 1,
        "name": "გიორგი მაისურაძე",
        "mobile": "9955XXXXXXXX",
        "numbers": [
            {
                "mobile": "9955XXXXXXXX",
                "countryCode": "+995",
                "number": "5XXXXXXXX",
                "isPrimary": 1,
                "smsEnabled": 1,
                "note": "პირადი"
            },
            {
                "mobile": "9955XXXXXXXX",
                "countryCode": "+995",
                "number": "5XXXXXXXX",
                "isPrimary": 0,
                "smsEnabled": 0,
                "note": "ბიოს"
            }
        ],
        "personalNo": "XXXXXXXXXXX",
        "email": "[email protected]",
        "birthDate": "1990-05-17",
        "address": "ვაჟა-ფშაველას 1",
        "lang": "ka",
        "column1": "",
        "column2": "",
        "createdAt": "2026-08-26 13:19:02"
    }
}
Yoxlama uğursuzdur 400
Cavab · JSON
{
    "statusID": 400,
    "message": "Validation failed",
    "data": null,
    "errors": {
        "typeID": "typeID does not exist",
        "birthDate": "birthDate must be a valid date in YYYY-MM-DD format",
        "email": "Email is invalid",
        "numbers": "Phone number is invalid"
    }
}
Nömrə artıq istifadə olunur 400
Cavab · JSON
{
    "statusID": 400,
    "message": "Validation failed",
    "data": null,
    "errors": {
        "numbers": "+9955XXXXXXXX is already assigned to another customer"
    }
}
Billinq API / Müştərilər / Müştərini al

Müştərini al

API açarı · Başlıq
GET https://api.ubill.dev /v1/customers/100001
Bu endpoint-in Postman kolleksiyasında ayrıca təsviri yoxdur.

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request GET \
  --url 'https://api.ubill.dev/v1/customers/100001' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/customers/100001',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/customers/100001',
  {
  method: 'GET',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

0 nümunə
Bu endpoint üçün cavab nümunəsi yoxdur.
Billinq API / Müştərilər / Müştəri axtarışı

Müştəri axtarışı

API açarı · Başlıq
GET https://api.ubill.dev /v1/customers/search?type=mobile&value=9955XXXXXXXX
Bu endpoint-in Postman kolleksiyasında ayrıca təsviri yoxdur.

URL parametrləri 2

typequerymobile
valuequery9955XXXXXXXX

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request GET \
  --url 'https://api.ubill.dev/v1/customers/search?type=mobile&value=9955XXXXXXXX' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/customers/search?type=mobile&value=9955XXXXXXXX',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/customers/search?type=mobile&value=9955XXXXXXXX',
  {
  method: 'GET',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

0 nümunə
Bu endpoint üçün cavab nümunəsi yoxdur.
Billinq API / Müştərilər / Müştəri hesabları

Müştəri hesabları

API açarı · Başlıq
GET https://api.ubill.dev /v1/customers/accounts/100001
Bu endpoint-in Postman kolleksiyasında ayrıca təsviri yoxdur.

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request GET \
  --url 'https://api.ubill.dev/v1/customers/accounts/100001' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/customers/accounts/100001',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/customers/accounts/100001',
  {
  method: 'GET',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

1 nümunə
Müştəri hesabları Nümunə
Cavab · JSON
{
    "statusID": 0,
    "message": "Success",
    "draw": 0,
    "recordsTotal": 3,
    "recordsFiltered": 3,
    "data": [
        {
            "id": "170115",
            "name": "Example Customer",
            "mobile": "5XXXXXXXX",
            "personalNo": "XXXXXXXXXXX",
            "birthDate": "1991-12-08",
            "areaID": "1",
            "area": "ბათუმი - ბათუმი",
            "address": "",
            "column1": "",
            "column2": "",
            "tariffID": null,
            "tariffName": null,
            "tariffPrice": null,
            "balance": "0.00",
            "statusID": "1",
            "statusName": "აქტიური",
            "shutdownDate": null,
            "creditDate": null,
            "mac": null,
            "ip": null,
            "createdAt": "2023-12-02 11:41:37"
        },
        {
            "id": "170114",
            "name": "Example Customer",
            "mobile": "5XXXXXXXX",
            "personalNo": "XXXXXXXXXXX",
            "birthDate": "1991-12-08",
            "areaID": "1",
            "area": "ბათუმი - ბათუმი",
            "address": "",
            "column1": "",
            "column2": "",
            "tariffID": "1",
            "tariffName": "test2",
            "tariffPrice": "30.00",
            "balance": "-2.00",
            "statusID": "2",
            "statusName": "პასიური",
            "shutdownDate": null,
            "creditDate": null,
            "mac": null,
            "ip": null,
            "createdAt": "2023-11-20 23:56:52"
        },
        {
            "id": "100001",
            "name": "Example Customer",
            "mobile": "5XXXXXXXX",
            "personalNo": "XXXXXXXXXXX",
            "birthDate": "1991-12-08",
            "areaID": "2",
            "area": "თბილისი - თბილისი",
            "address": "Example Address",
            "column1": "",
            "column2": "",
            "tariffID": "1",
            "tariffName": "test2",
            "tariffPrice": "30.00",
            "balance": "-9.71",
            "statusID": "2",
            "statusName": "პასიური",
            "shutdownDate": "2022-07-13",
            "creditDate": null,
            "mac": "Cc:2d:21:0e:c9:41",
            "ip": "192.168.5.2",
            "createdAt": "2020-07-01 21:32:31"
        }
    ]
}
RESURS

Hesablar

5 endpoint

Billinq API / Hesablar / Bütün hesabları al

Bütün hesabları al

API açarı · Başlıq
GET https://api.ubill.dev /v1/accounts
Bu endpoint-in Postman kolleksiyasında ayrıca təsviri yoxdur.

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request GET \
  --url 'https://api.ubill.dev/v1/accounts' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/accounts',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/accounts',
  {
  method: 'GET',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

1 nümunə
Bütün hesabları al Nümunə
Cavab · JSON
{
    "statusID": 0,
    "message": "Success",
    "draw": 0,
    "recordsTotal": 70114,
    "recordsFiltered": 70114,
    "data": [
        {
            "id": "170115",
            "name": "Example Customer",
            "mobile": "5XXXXXXXX",
            "personalNo": "XXXXXXXXXXX",
            "birthDate": "1991-12-08",
            "areaID": "1",
            "area": "თბილისი - თბილისი",
            "address": "",
            "column1": "",
            "column2": "",
            "tariffID": null,
            "tariffName": null,
            "tariffPrice": null,
            "balance": "0.00",
            "statusID": "1",
            "statusName": "აქტიური",
            "shutdownDate": null,
            "creditDate": null,
            "mac": null,
            "ip": null,
            "createdAt": "2023-12-02 11:41:37"
        },
        {
            "id": "170114",
            "name": "Example Customer",
            "mobile": "5XXXXXXXX",
            "personalNo": "XXXXXXXXXXX",
            "birthDate": "1991-12-08",
            "areaID": "1",
            "area": "ბათუმი - ბათუმი",
            "address": "",
            "column1": "",
            "column2": "",
            "tariffID": "1",
            "tariffName": "test2",
            "tariffPrice": "30.00",
            "balance": "-2.00",
            "statusID": "2",
            "statusName": "პასიური",
            "shutdownDate": null,
            "creditDate": null,
            "mac": null,
            "ip": null,
            "createdAt": "2023-11-20 23:56:52"
        }
    ]
}
Billinq API / Hesablar / Hesab yarat

Hesab yarat

API açarı · Başlıq
POST https://api.ubill.dev /v1/accounts/create

Mövcud müştəri üçün yeni hesab (xidmət) yaradır. Hesab nömrəsi ( id cavabda) uBill veb interfeysində olduğu kimi şirkətin cID parametrlərindən yaradılır.

Tələb olunan icazə: accounts.create . Sorğu gövdəsi JSON olmalıdır və Content-Type: application/json başlığı məcburidir.

Sorğu gövdəsi

Sahə Növ Məcburi Təsvir
customerID tam ədəd bəli Hesabın aid olduğu müştəri nömrəsi, eyni id müştəri endpoint-lərinin qaytardığı dəyər.
name sətir, maksimum 50 xeyr Hesab adı.
birthDate sətir xeyr Tarix bu formatda: YYYY-MM-DD formatında.
areaID tam ədəd xeyr uBill rayon siyahısındakı yaşayış məntəqəsi ID-si.
address sətir, maksimum 50 xeyr Xidmət ünvanı.
geoLocation sətir, maksimum 100 xeyr Koordinatlar bu formatda: 41.732438,44.7688134 formatında.
column1, column2 sətir, maksimum 50 xeyr Sərbəst əlavə sahələr.
tariffID tam ədəd xeyr Şirkətin tarif nömrəsi.
groupID tam ədəd xeyr Şirkətin qrup və ya filial nömrəsi.
tagsID tam ədədlər massivi xeyr Hesaba əlavə olunan şirkət etiketlərinin nömrələri.
numbers massiv xeyr Hesab telefonları müştəri kimi təsvir olunur. Müştəridən fərqli olaraq hesab nömrəsiz yaradıla bilər.

Moduldan asılı sahələr

Bu sahələr yalnız şirkətdə uyğun modul aktivdirsə oxunur.

Sahə Modul Məcburi Təsvir
mac Şəbəkə bəli Cihazın MAC ünvanı, şirkət daxilində unikal.
onuMac Şəbəkə xeyr ONU MAC ünvanı, şirkət daxilində unikal.
ipRangeID Şəbəkə bəli NAS IP diapazonunun nömrəsi. İlk boş ünvan avtomatik hesaba verilir və belə qaytarılır: ip.
stbMacIPTV xeyr STB MAC ünvanı, şirkət daxilində unikal.
gpsProviderIDGPS track bəli Şirkətin GPS provayder nömrəsi.
gpsTrackIdentifierGPS track xeyr Cihaz identifikatoru, şirkət daxilində unikal.

SMS bildirişi

Şirkətdə hesab əlavə etmə SMS-i aktivdirsə, yeni hesabın SMS aktiv bütün nömrələrinə mesaj göndərilir və şirkətin SMS balansından tutulur. Balans çatmasa da hesab yaradılır, cavaba əlavə olunur: warning sahəsi.

Cavablar

HTTPstatusID Təsvir
2010 Hesab yaradıldı, data yeni hesabı ehtiva edir.
400400 Yoxlama uğursuzdur, errors obyekti hər səhv sahəni göstərir. Təkrar MAC və nömrələr eyni qaydada bildirilir.
50099 Hesab saxlanmadı, heç nə yazılmadı.

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Sorğu gövdəsi JSON

Sorğu gövdəsi
{
    "customerID": 100001,
    "name": "ბინა - ვაჟა-ფშაველას 1",
    "birthDate": "1990-05-17",
    "areaID": 1,
    "address": "ვაჟა-ფშაველას 1",
    "geoLocation": "41.732438,44.7688134",
    "column1": "",
    "column2": "",
    "tariffID": 2,
    "groupID": 1,
    "tagsID": [1, 3],
    "mac": "00:11:22:33:44:55",
    "onuMac": "AA:BB:CC:DD:EE:FF",
    "ipRangeID": 1,
    "numbers": [
        {
            "number": "5XXXXXXXX",
            "countryCode": "+995",
            "isPrimary": 1,
            "smsEnabled": 1
        }
    ]
}

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request POST \
  --url 'https://api.ubill.dev/v1/accounts/create' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "customerID": 100001,
    "name": "ბინა - ვაჟა-ფშაველას 1",
    "birthDate": "1990-05-17",
    "areaID": 1,
    "address": "ვაჟა-ფშაველას 1",
    "geoLocation": "41.732438,44.7688134",
    "column1": "",
    "column2": "",
    "tariffID": 2,
    "groupID": 1,
    "tagsID": [1, 3],
    "mac": "00:11:22:33:44:55",
    "onuMac": "AA:BB:CC:DD:EE:FF",
    "ipRangeID": 1,
    "numbers": [
        {
            "number": "5XXXXXXXX",
            "countryCode": "+995",
            "isPrimary": 1,
            "smsEnabled": 1
        }
    ]
}'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/accounts/create',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => <<<'BODY'
{
    "customerID": 100001,
    "name": "ბინა - ვაჟა-ფშაველას 1",
    "birthDate": "1990-05-17",
    "areaID": 1,
    "address": "ვაჟა-ფშაველას 1",
    "geoLocation": "41.732438,44.7688134",
    "column1": "",
    "column2": "",
    "tariffID": 2,
    "groupID": 1,
    "tagsID": [1, 3],
    "mac": "00:11:22:33:44:55",
    "onuMac": "AA:BB:CC:DD:EE:FF",
    "ipRangeID": 1,
    "numbers": [
        {
            "number": "5XXXXXXXX",
            "countryCode": "+995",
            "isPrimary": 1,
            "smsEnabled": 1
        }
    ]
}
BODY,
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/accounts/create',
  {
  method: 'POST',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: "{\n    \"customerID\": 100001,\n    \"name\": \"ბინა - ვაჟა-ფშაველას 1\",\n    \"birthDate\": \"1990-05-17\",\n    \"areaID\": 1,\n    \"address\": \"ვაჟა-ფშაველას 1\",\n    \"geoLocation\": \"41.732438,44.7688134\",\n    \"column1\": \"\",\n    \"column2\": \"\",\n    \"tariffID\": 2,\n    \"groupID\": 1,\n    \"tagsID\": [1, 3],\n    \"mac\": \"00:11:22:33:44:55\",\n    \"onuMac\": \"AA:BB:CC:DD:EE:FF\",\n    \"ipRangeID\": 1,\n    \"numbers\": [\n        {\n            \"number\": \"5XXXXXXXX\",\n            \"countryCode\": \"+995\",\n            \"isPrimary\": 1,\n            \"smsEnabled\": 1\n        }\n    ]\n}"
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

4 nümunə
Hesab yaradıldı 201
Cavab · JSON
{
    "statusID": 0,
    "message": "Account created",
    "data": {
        "id": 100001,
        "customerID": 100001,
        "name": "ბინა - ვაჟა-ფშაველას 1",
        "mobile": "9955XXXXXXXX",
        "numbers": [
            {
                "mobile": "9955XXXXXXXX",
                "countryCode": "+995",
                "number": "5XXXXXXXX",
                "isPrimary": 1,
                "smsEnabled": 1,
                "note": null
            }
        ],
        "personalNo": "XXXXXXXXXXX",
        "birthDate": "1990-05-17",
        "areaID": 1,
        "area": "თბილისი",
        "address": "ვაჟა-ფშაველას 1",
        "geoLocation": "41.732438,44.7688134",
        "column1": "",
        "column2": "",
        "groupID": 1,
        "tagsID": [1, 3],
        "tariffID": 2,
        "balance": "0.00",
        "statusID": 1,
        "createdAt": "2026-08-26 13:19:39",
        "mac": "00:11:22:33:44:55",
        "onuMac": "AA:BB:CC:DD:EE:FF",
        "ipRangeID": 1,
        "ip": "192.168.5.21"
    }
}
SMS balansı olmadan yaradıldı 201
Cavab · JSON
{
    "statusID": 0,
    "message": "Account created",
    "data": {
        "id": 100002,
        "customerID": 100001,
        "name": "მეორე ბინა",
        "mobile": "9955XXXXXXXX",
        "numbers": [
            {
                "mobile": "9955XXXXXXXX",
                "countryCode": "+995",
                "number": "5XXXXXXXX",
                "isPrimary": 1,
                "smsEnabled": 1,
                "note": null
            }
        ],
        "personalNo": "XXXXXXXXXXX",
        "birthDate": null,
        "areaID": null,
        "area": "არ არის მითითებული",
        "address": "",
        "geoLocation": null,
        "column1": "",
        "column2": "",
        "groupID": null,
        "tagsID": [],
        "tariffID": null,
        "balance": "0.00",
        "statusID": 1,
        "createdAt": "2026-08-26 13:20:11"
    },
    "warning": "account was created, but the notification sms was not sent - not enough messages on the balance"
}
Yoxlama uğursuzdur 400
Cavab · JSON
{
    "statusID": 400,
    "message": "Validation failed",
    "data": null,
    "errors": {
        "customerID": "Customer not found",
        "geoLocation": "geoLocation must look like 41.732438,44.7688134",
        "tariffID": "tariffID does not exist",
        "mac": "mac is required",
        "ipRangeID": "ipRangeID is required"
    }
}
MAC artıq istifadə olunur 400
Cavab · JSON
{
    "statusID": 400,
    "message": "Account creation failed",
    "data": null,
    "errors": {
        "account": [
            "ეს MAC მისამართი უკვე მითითებულია სხვა ანგარიშზე"
        ]
    }
}
Billinq API / Hesablar / Hesabı al

Hesabı al

API açarı · Başlıq
GET https://api.ubill.dev /v1/accounts/100001
Bu endpoint-in Postman kolleksiyasında ayrıca təsviri yoxdur.

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request GET \
  --url 'https://api.ubill.dev/v1/accounts/100001' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/accounts/100001',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/accounts/100001',
  {
  method: 'GET',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

1 nümunə
Hesabı al Nümunə
Cavab · JSON
{
    "statusID": 0,
    "message": "Success",
    "data": [
        {
            "id": "100001",
            "name": "Example Customer",
            "mobile": "5XXXXXXXX",
            "personalNo": "XXXXXXXXXXX",
            "birthDate": "1991-12-08",
            "areaID": "2",
            "area": "თბილისი",
            "address": "Example Address",
            "column1": "",
            "column2": "",
            "tariffID": "1",
            "tariffName": "test2",
            "tariffPrice": "30.00",
            "balance": "-9.00",
            "statusID": "2",
            "statusName": "პასიური",
            "shutdownDate": null,
            "creditDate": null,
            "mac": "Cc:2d:21:0e:c9:41",
            "ip": "192.168.5.2",
            "createdAt": "2020-07-01 21:32:31"
        }
    ]
}
Billinq API / Hesablar / Hesab axtarışı

Hesab axtarışı

API açarı · Başlıq
GET https://api.ubill.dev /v1/accounts/search?type=mobile&value=9955XXXXXXXX
Bu endpoint-in Postman kolleksiyasında ayrıca təsviri yoxdur.

URL parametrləri 2

typequerymobile
valuequery9955XXXXXXXX

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request GET \
  --url 'https://api.ubill.dev/v1/accounts/search?type=mobile&value=9955XXXXXXXX' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/accounts/search?type=mobile&value=9955XXXXXXXX',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/accounts/search?type=mobile&value=9955XXXXXXXX',
  {
  method: 'GET',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

0 nümunə
Bu endpoint üçün cavab nümunəsi yoxdur.
Billinq API / Hesablar / Kredit təyin et

Kredit təyin et

API açarı · Başlıq
POST https://api.ubill.dev /v1/accounts/setCredit
Bu endpoint-in Postman kolleksiyasında ayrıca təsviri yoxdur.

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Sorğu gövdəsi JSON

Sorğu gövdəsi
{
    "accountID": 170114,
    "date": "2023-12-10"
}

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request POST \
  --url 'https://api.ubill.dev/v1/accounts/setCredit' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountID": 170114,
    "date": "2023-12-10"
}'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/accounts/setCredit',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => <<<'BODY'
{
    "accountID": 170114,
    "date": "2023-12-10"
}
BODY,
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/accounts/setCredit',
  {
  method: 'POST',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: "{\n    \"accountID\": 170114,\n    \"date\": \"2023-12-10\"\n}"
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

1 nümunə
Kredit təyin et Nümunə
Cavab · JSON
{
    "statusID": 0,
    "message": "Success"
}
RESURS

Ödənişlər

3 endpoint

Billinq API / Ödənişlər / Ödənişləri al

Ödənişləri al

API açarı · Başlıq
GET https://api.ubill.dev /v1/payments
Bu endpoint-in Postman kolleksiyasında ayrıca təsviri yoxdur.

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request GET \
  --url 'https://api.ubill.dev/v1/payments' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/payments',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/payments',
  {
  method: 'GET',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

1 nümunə
Ödənişləri al Nümunə
Cavab · JSON
{
    "status": true,
    "draw": 0,
    "recordsTotal": 9,
    "recordsFiltered": 9,
    "data": [
        {
            "id": "9",
            "accountID": "100001",
            "balance": "0.29",
            "sum": "-10.00",
            "comment": "",
            "transactionID": null,
            "paySystem": null,
            "apiStatus": "0",
            "typeID": "2",
            "typeName": "კორექტირება",
            "admin": "Example Customer",
            "date": "2022-06-11 10:07:13"
        },
        {
            "id": "8",
            "accountID": "100001",
            "balance": "-0.71",
            "sum": "1.00",
            "comment": "",
            "transactionID": null,
            "paySystem": null,
            "apiStatus": "0",
            "typeID": "1",
            "typeName": "დამატება",
            "admin": "Example Customer",
            "date": "2022-06-10 22:24:14"
        },
        {
            "id": "7",
            "accountID": "170099",
            "balance": "-1.00",
            "sum": "20.00",
            "comment": "",
            "transactionID": null,
            "paySystem": null,
            "apiStatus": "0",
            "typeID": "2",
            "typeName": "კორექტირება",
            "admin": "Example Customer",
            "date": "2022-01-29 16:39:50"
        },
        {
            "id": "6",
            "accountID": "170099",
            "balance": "0.00",
            "sum": "-1.00",
            "comment": "",
            "transactionID": null,
            "paySystem": null,
            "apiStatus": "0",
            "typeID": "2",
            "typeName": "კორექტირება",
            "admin": "Example Customer",
            "date": "2022-01-29 16:39:39"
        },
        {
            "id": "5",
            "accountID": "100001",
            "balance": "39.06",
            "sum": "10.00",
            "comment": "",
            "transactionID": null,
            "paySystem": null,
            "apiStatus": "0",
            "typeID": "1",
            "typeName": "დამატება",
            "admin": "Example Customer",
            "date": "2021-12-22 17:16:43"
        },
        {
            "id": "4",
            "accountID": "100001",
            "balance": "-0.94",
            "sum": "20.00",
            "comment": "",
            "transactionID": null,
            "paySystem": null,
            "apiStatus": "0",
            "typeID": "1",
            "typeName": "დამატება",
            "admin": "Example Customer",
            "date": "2021-12-22 17:14:57"
        },
        {
            "id": "3",
            "accountID": "100001",
            "balance": "0.06",
            "sum": "1.00",
            "comment": null,
            "transactionID": "t1",
            "paySystem": "TBCPAY",
            "apiStatus": "0",
            "typeID": "5",
            "typeName": "ჩარიცხვა",
            "admin": null,
            "date": "2021-11-13 15:26:53"
        },
        {
            "id": "2",
            "accountID": "100001",
            "balance": "-0.94",
            "sum": "1.00",
            "comment": "",
            "transactionID": null,
            "paySystem": null,
            "apiStatus": "0",
            "typeID": "1",
            "typeName": "დამატება",
            "admin": "Example Customer",
            "date": "2021-01-18 10:31:32"
        },
        {
            "id": "1",
            "accountID": "100001",
            "balance": "-1.94",
            "sum": "1.00",
            "comment": "",
            "transactionID": null,
            "paySystem": null,
            "apiStatus": "0",
            "typeID": "1",
            "typeName": "დამატება",
            "admin": "Example Customer",
            "date": "2021-01-18 10:31:14"
        }
    ]
}
Billinq API / Ödənişlər / Hesaba görə ödənişləri al

Hesaba görə ödənişləri al

API açarı · Başlıq
GET https://api.ubill.dev /v1/payments/account/100001
Bu endpoint-in Postman kolleksiyasında ayrıca təsviri yoxdur.

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request GET \
  --url 'https://api.ubill.dev/v1/payments/account/100001' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/payments/account/100001',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/payments/account/100001',
  {
  method: 'GET',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

1 nümunə
Hesaba görə ödənişləri al Nümunə
Cavab · JSON
{
    "statusID": 0,
    "message": "Success",
    "data": [
        {
            "id": "89",
            "accountID": null,
            "balance": "-1.94",
            "sum": "1",
            "comment": "",
            "transactionID": null,
            "paySystem": null,
            "apiStatus": "0",
            "typeID": "1",
            "typeName": "დამატება",
            "admin": "Example Customer",
            "date": "2021-01-18 10:31:14"
        },
        {
            "id": "90",
            "accountID": null,
            "balance": "-0.94",
            "sum": "1",
            "comment": "",
            "transactionID": null,
            "paySystem": null,
            "apiStatus": "0",
            "typeID": "1",
            "typeName": "დამატება",
            "admin": "Example Customer",
            "date": "2021-01-18 10:31:32"
        },
        {
            "id": "537",
            "accountID": null,
            "balance": "0.06",
            "sum": "1",
            "comment": null,
            "transactionID": "t1",
            "paySystem": "TBCPAY",
            "apiStatus": "0",
            "typeID": "5",
            "typeName": "ჩარიცხვა",
            "admin": null,
            "date": "2021-11-13 15:26:53"
        },
        {
            "id": "641",
            "accountID": null,
            "balance": "-0.94",
            "sum": "20",
            "comment": "",
            "transactionID": null,
            "paySystem": null,
            "apiStatus": "0",
            "typeID": "1",
            "typeName": "დამატება",
            "admin": "Example Customer",
            "date": "2021-12-22 17:14:57"
        },
        {
            "id": "642",
            "accountID": null,
            "balance": "39.06",
            "sum": "10",
            "comment": "",
            "transactionID": null,
            "paySystem": null,
            "apiStatus": "0",
            "typeID": "1",
            "typeName": "დამატება",
            "admin": "Example Customer",
            "date": "2021-12-22 17:16:43"
        },
        {
            "id": "1720",
            "accountID": null,
            "balance": "-0.7057142857142757",
            "sum": "1",
            "comment": "",
            "transactionID": null,
            "paySystem": null,
            "apiStatus": "0",
            "typeID": "1",
            "typeName": "დამატება",
            "admin": "Example Customer",
            "date": "2022-06-10 22:24:14"
        },
        {
            "id": "1729",
            "accountID": null,
            "balance": "0.29428571428572",
            "sum": "-10",
            "comment": "",
            "transactionID": null,
            "paySystem": null,
            "apiStatus": "0",
            "typeID": "2",
            "typeName": "კორექტირება",
            "admin": "Example Customer",
            "date": "2022-06-11 10:07:13"
        }
    ]
}
Billinq API / Ödənişlər / Ödəniş əlavə et

Ödəniş əlavə et

API açarı · Başlıq
POST https://api.ubill.dev /v1/payments/add
Bu endpoint-in Postman kolleksiyasında ayrıca təsviri yoxdur.

Sorğu başlıqları 2

Açar Dəyər Mənbə
keyYOUR_API_KEY Autentifikasiya
Content-Typeapplication/json Başlıq

Sorğu gövdəsi JSON

Sorğu gövdəsi
{
    "accountID" : 170114,
    "sum" : 1,
    "comment": "text",
    "paySystem": "WEB"
}

Kod nümunələri

cURL · PHP · JavaScript
cURL
curl --request POST \
  --url 'https://api.ubill.dev/v1/payments/add' \
  --header 'key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountID" : 170114,
    "sum" : 1,
    "comment": "text",
    "paySystem": "WEB"
}'
PHP
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ubill.dev/v1/payments/add',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => <<<'BODY'
{
    "accountID" : 170114,
    "sum" : 1,
    "comment": "text",
    "paySystem": "WEB"
}
BODY,
    CURLOPT_HTTPHEADER => [
        'key: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo $response;
JavaScript
const response = await fetch(
  'https://api.ubill.dev/v1/payments/add',
  {
  method: 'POST',
  headers: {
    'key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: "{\n    \"accountID\" : 170114,\n    \"sum\" : 1,\n    \"comment\": \"text\",\n    \"paySystem\": \"WEB\"\n}"
  }
);

const data = await response.json();
console.log(data);

Cavab nümunələri

1 nümunə
Ödənişlər əlavə et Nümunə
Cavab · JSON
{
    "statusID": 0,
    "message": "Success",
    "data": {
        "id": "11521"
    }
}
KÖMƏK LAZIMDIR?

İnteqrasiya dəstəyi

uBill komandası API inteqrasiyası suallarında kömək edər.

Bizimlə əlaqə
İnfrastruktur və texnologiyalar

Qabaqcıl və etibarlı texnologiyalardan istifadə edirik

uBill sabitlik, təhlükəsizlik və rahat miqyaslanma təmin edən müasir alətlər üzərində qurulub

Yuxarı qayıt