uBill ծրագրավորողներ REST API · v1 Աշխատանքային միջավայր

Ամբողջական API փաստաթղթեր

SMS և բիլինգ API-ի ռեսուրսները մեկ տեղում՝ ճշգրիտ վերջնակետեր, Postman-ի ամբողջական նկարագրություններ, վերնագրեր, հարցման մարմիններ, պատասխանների օրինակներ և պատրաստի կոդ։

24 վերջնակետ API բանալիով նույնականացում 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" }
ՄԵԿՆԱՐԿ

uBill API-ի հետ աշխատանք

UBill API-ն տրամադրում է ծրագրային մուտք մեր ռեսուրսներին։ Կարող եք ծառայությունը միացնել ձեր համակարգին և հեշտությամբ կապվել հաճախորդների հետ։

API օրինակներ

Տարբեր աղբյուրների API իրականացումներ՝ տարբեր ծրագրավորման լեզուներով։

Նախընտրո՞ւմ եք Postman

Փաստաթղթերին և API հարցումներին ծանոթացեք նաև uBill-ի հանրային Postman հավաքածուում։

Բացել Postman-ում
Հիմնական URL https://api.ubill.dev
Տարբերակ v1
Արձանագրություն HTTPS
Կոդավորում UTF-8
01
ԱՆՎՏԱՆԳՈՒԹՅՈՒՆ

Նույնականացում

Պաշտպանված վերջնակետերի հարցումները պետք է պարունակեն ընկերության գաղտնի API բանալին։ Մեծ մասում այն փոխանցվում է հետևյալ վերնագրով՝ key վերնագրում, իսկ որոշ հին GET/XML վերջնակետեր օգտագործում են key հարցման պարամետրը։

Մի բացահայտեք API բանալին

Բանալին պահեք սերվերի միջավայրի փոփոխականում։ Մի տեղադրեք frontend JavaScript-ում, բջջային հավելվածում կամ հանրային Git պահոցում։

Հարցման վերնագրեր
key: YOUR_API_KEY
Content-Type: application/json
02
ԿԱՆՈՆՆԵՐ

Ձևաչափեր և կարգավիճակներ

API-ն հիմնականում վերադարձնում է JSON պատասխաններ։ statusID դաշտը ցույց է տալիս արդյունքը․ հաջող հարցման արժեքն է 0 ։ XML վերջնակետը վերադարձնում է XML պատասխան։

0 SMS-ն ուղարկված է
1 Ստացված
2 Չառաքված
3 Կարգավիճակի սպասում
4 Սխալ
API ՏԵՂԵԿԱՏՈՒ

Բոլոր ռեսուրսներն ու վերջնակետերը

Ստորև տեղեկությունը համաժամացված է հանրային Postman հավաքածուի վերջին տարբերակի հետ։

API ԽՈՒՄԲ

SMS API

11 վերջնակետ

SMS API / Ստեղծել ուղարկողի անուն

Ստեղծել ուղարկողի անուն

API բանալի · Վերնագիր
POST https://api.ubill.dev /v1/sms/brandNameCreate

Պատասխանի կարգավիճակ

statusID Նկարագրություն
0 Ուղարկողի անունը ստեղծված է
10 brandName դաշտը դատարկ է
20 brandName-ը պետք է ունենա 2–11 նիշ
30 brandName-ը պարունակում է չթույլատրված նշաններ
40 brandName-ն արդեն ավելացված է
50 Սպասեք վերջին ավելացված brandName-ի հաստատմանը
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 սխալ
99 Ընդհանուր սխալ

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Հարցման մարմին JSON

Հարցման մարմին
{
    "brandName" : "test"
}

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

1 օրինակ
Ստեղծել ուղարկողի անուն Օրինակ
Պատասխան · JSON
{
    "statusID": 0,
    "brandID": 1,
    "message": "BrandName Created"
}
SMS API / Ջնջել ուղարկողի անունը

Ջնջել ուղարկողի անունը

API բանալի · Վերնագիր
POST https://api.ubill.dev /v1/sms/brandNameDelete

Պատասխանի կարգավիճակ

statusID Նկարագրություն
0 Ուղարկողի անունը ջնջված է
10 Ուղարկողի անունը չի գտնվել
90 JSON սխալ
99 Ընդհանուր սխալ

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Հարցման մարմին JSON

Հարցման մարմին
{
    "brandID": 2
}

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

1 օրինակ
Ջնջել ուղարկողի անունը Օրինակ
Պատասխան · JSON
{
    "statusID": 0,
    "brandID": "2",
    "message": "BrandName Deleted"
}
SMS API / Ստանալ բոլոր ուղարկողի անունները

Ստանալ բոլոր ուղարկողի անունները

API բանալի · Վերնագիր
GET https://api.ubill.dev /v1/sms/brandNames
Այս վերջնակետը Postman հավաքածուում առանձին նկարագրություն չունի։

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

1 օրինակ
Ստանալ բոլոր ուղարկողի անունները Օրինակ
Պատասխան · 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

Ուղարկել SMS

API բանալի · Հարցում
GET https://api.ubill.dev /v1/sms/send?key=YOUR_API_KEY&brandID=1&numbers=9955XXXXXXXX,9955XXXXXXXX&text=message&stopList=false

Պարտադիր պարամետրեր

Պարամետր Նկարագրություն
key Հարցումների նույնականացման գաղտնի API բանալի։ Դիտեք և կառավարեք ընկերության կարգավորումներում։
brandID Ապրանքանիշի եզակի նույնացուցիչը համակարգում։
numbers Ստորակետով բաժանված բջջային համարներ։ Պետք է լինեն միջազգային ձևաչափով առանց 00 կամ +.
text SMS բովանդակությունը։ Աջակցվում են Unicode-ի բոլոր նիշերը։

Ընտրովի պարամետրեր

Պարամետր Նկարագրություն
stopList stopList=false — անջատում է արգելափակման ցանկի ստուգումը․ հաղորդագրությունը կուղարկվի նաև ցանկում եղած համարին։
otp otp=true — հաղորդագրությունը նշում է որպես OTP (մեկանգամյա գաղտնաբառ / հաստատման կոդ)։
OTP հաղորդագրությունները մշակվում են ամենաբարձր առաջնահերթությամբ։
⚠️ Պետք է կիրառվի միայն նույնականացման կոդերի համար։
sendTime SMS-ի պլանավորված առաքման ժամանակը։
Ձևաչափը՝ Y-m-d H:i (օրինակ՝ 2026-02-01 23:30).
Նշված ժամանակը պետք է լինի ապագայում։
Չնշվելու դեպքում ուղարկվում է անմիջապես։
callbackUrl Այս SMS հարցման անհատական callback URL-ը։ Գործում է միայն API հավելվածում ընդհանուր լռելյայն callback URL սահմանված լինելու դեպքում։

Նշումներ

  • OTP հաղորդագրությունները միայն նույնականացման համար են՝ մուտք, հաստատում, գաղտնաբառի վերականգնում։

  • Հետևյալի սխալ կիրառումը՝ otp պարամետրի, կարող է բերել առաքման կամ հաշվի սահմանափակումների։


Պատասխանի կարգավիճակ

statusID Նկարագրություն
0 SMS-ն ուղարկված է
10 brandID-ն չի գտնվել
20 Համարները չեն գտնվել
30 Հաղորդագրության տեքստը դատարկ է
40 SMS մնացորդը բավարար չէ
50 Վավեր համարներ չեն գտնվել
60 sendTime ձևաչափը սխալ է։ Օգտագործեք Y-m-d H:i
90 JSON սխալ
99 Ընդհանուր սխալ

⚠️ GET մեթոդի սահմանափակումներ

  • API-ն խիստ սահմանափակում չի կիրառում ստացող համարների քանակի վրա։

  • Փաստացի սահմանափակումները պայմանավորված են URL-ի և HTTP վերնագրերի չափի սահմաններով (Cloudflare, պրոքսիներ, զննարկիչներ)։

Գործնական սահմաններ

  • ✅ Մեկ հարցման մոտ 1500 համարն աշխատում է հուսալի։

  • ⚠️ Մոտ 2000-ից ավելի համարները կարող են առաջացնել Header overflow սխալներ։

  • Այս սխալներն առաջանում են մինչև հարցումը API-ին հասնելը ՝ HTTP / պրոքսի մակարդակում։

Խորհուրդ

  • Օգտագործեք GET միայն փոքր և միջին հարցումների համար։

  • Մեծ ցանկերի համար միշտ օգտագործեք POST.

URL պարամետրեր 5

keyqueryYOUR_API_KEY
brandIDquery1
numbersquery9955XXXXXXXX,9955XXXXXXXX
textquerymessage
stopListqueryfalse

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

1 օրինակ
Ուղարկել SMS Օրինակ
Պատասխան · JSON
{
    "statusID": 0,
    "smsID": "117345",
    "message": "SMS Sent"
}
SMS API / Ուղարկել SMS

Ուղարկել SMS

API բանալի · Վերնագիր
POST https://api.ubill.dev /v1/sms/send

Վերնագրեր

Բանալի Արժեք
key Ձեր գաղտնի API բանալին
Content-Type application/json

Պարտադիր պարամետրեր (JSON մարմին)

Պարամետր Նկարագրություն
brandID Ապրանքանիշի եզակի նույնացուցիչը համակարգում։
numbers Բջջային համարների զանգված։ Պետք է լինեն միջազգային ձևաչափով առանց 00 կամ + ։ Օրինակ՝ ["9955XXXXXXXX","9955XXXXXXXX"]
text SMS բովանդակությունը։ Աջակցվում են Unicode-ի բոլոր նիշերը։

Ընտրովի պարամետրեր (JSON մարմին)

Պարամետր Նկարագրություն
stopList false — անջատում է արգելափակման ցանկի ստուգումը․ հաղորդագրությունը կուղարկվի նաև ցանկում եղած համարին։
otp true — հաղորդագրությունը նշում է որպես OTP (մեկանգամյա գաղտնաբառ / հաստատման կոդ)։
OTP հաղորդագրությունները մշակվում են ամենաբարձր առաջնահերթությամբ։
⚠️ Պետք է կիրառվի միայն նույնականացման կոդերի համար։
sendTime SMS-ի պլանավորված առաքման ժամանակ։ Ձևաչափը՝ Y-m-d H:i (օրինակ՝ "2026-02-01 23:30" )։ Պետք է լինի ապագայում։ Չնշվելու դեպքում ուղարկվում է անմիջապես։
callbackUrl Այս SMS հարցման անհատական callback URL-ը։ Գործում է միայն API հավելվածում ընդհանուր լռելյայն callback URL սահմանված լինելու դեպքում։

Նշումներ

  • OTP հաղորդագրությունները միայն նույնականացման համար են՝ մուտք, հաստատում, գաղտնաբառի վերականգնում։

  • Հետևյալի սխալ կիրառումը՝ otp պարամետրի, կարող է բերել առաքման կամ հաշվի սահմանափակումների։

Պատասխանի կարգավիճակ

statusID Նկարագրություն
0 SMS-ն ուղարկված է
10 brandID-ն չի գտնվել
20 Համարները չեն գտնվել
30 Հաղորդագրության տեքստը դատարկ է
40 SMS մնացորդը բավարար չէ
50 Վավեր համարներ չեն գտնվել
60 sendTime ձևաչափը սխալ է։ Օգտագործեք Y-m-d H:i
90 JSON սխալ
99 Ընդհանուր սխալ

⚠️ Սահմաններ և նշումներ

  • Հարցման մարմնի առավելագույն չափ՝ 100 MB → Ավելի մեծ հարցումները մերժվում են։

  • Cloudflare պրոքսիի սպասման սահման՝ 100 վայրկյան → Ավելի երկար հարցումները վերադարձնում են 524 Timeout։

  • Մեծ SMS խմբաքանակների հարցումները բաժանեք՝ սպասման և հիշողության խնդիրներից խուսափելու համար։

  • Օգտագործեք stopList ՝ արգելափակված համարներին չուղարկելու համար։

Փորձարկման գործնական դիտարկում՝

Մեր փորձարկումներում SMS-ները հաջողությամբ ուղարկվել են մինչև 500 000 համարի՝ մեկ հարցմամբ ։ Ավելի մեծ քանակը կարող է առաջացնել հիշողության, սպասման կամ հարցման չափի խնդիրներ։ Փաստացի սահմանները կախված են տեքստի երկարությունից, կոդավորումից և սերվերի բեռնվածությունից։

Խորհուրդ՝

Անվտանգ և հուսալի աշխատանքի համար խորհուրդ է տրվում սահմանափակվել մոտ 100 000 համարով յուրաքանչյուր խմբաքանակում .

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Հարցման մարմին JSON

Հարցման մարմին
{
    "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)
}

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

1 օրինակ
Ուղարկել SMS Օրինակ
Պատասխան · JSON
{
    "statusID": 0,
    "smsID": 111,
    "message": "SMS Sended"
}
SMS API / Ուղարկել SMS՝ տարբեր տեքստեր

Ուղարկել SMS՝ տարբեր տեքստեր

API բանալի · Վերնագիր
POST https://api.ubill.dev /v1/sms/send

Վերնագրեր

Բանալի Արժեք
key Ձեր գաղտնի API բանալին
Content-Type application/json

Պարտադիր պարամետրեր (JSON մարմին)

Պարամետր Նկարագրություն
brandID Ապրանքանիշի եզակի նույնացուցիչը համակարգում։
numbers Բջջային համարների զանգված։ Պետք է լինեն միջազգային ձևաչափով առանց 00 կամ + ։ Օրինակ՝ ["9955XXXXXXXX","9955XXXXXXXX"]
text SMS բովանդակությունը։ Աջակցվում են Unicode-ի բոլոր նիշերը։

Ընտրովի պարամետրեր (JSON մարմին)

Պարամետր Նկարագրություն
stopList false — անջատում է արգելափակման ցանկի ստուգումը․ հաղորդագրությունը կուղարկվի նաև ցանկում եղած համարին։
otp true — հաղորդագրությունը նշում է որպես OTP (մեկանգամյա գաղտնաբառ / հաստատման կոդ)։
OTP հաղորդագրությունները մշակվում են ամենաբարձր առաջնահերթությամբ։
⚠️ Պետք է կիրառվի միայն նույնականացման կոդերի համար։
sendTime SMS-ի պլանավորված առաքման ժամանակ։ Ձևաչափը՝ Y-m-d H:i (օրինակ՝ "2026-02-01 23:30" )։ Պետք է լինի ապագայում։ Չնշվելու դեպքում ուղարկվում է անմիջապես։
callbackUrl Այս SMS հարցման անհատական callback URL-ը։ Գործում է միայն API հավելվածում ընդհանուր լռելյայն callback URL սահմանված լինելու դեպքում։

Նշումներ

  • OTP հաղորդագրությունները միայն նույնականացման համար են՝ մուտք, հաստատում, գաղտնաբառի վերականգնում։

  • Հետևյալի սխալ կիրառումը՝ otp պարամետրի, կարող է բերել առաքման կամ հաշվի սահմանափակումների։


Պատասխանի կարգավիճակ

statusID Նկարագրություն
0 SMS-ն ուղարկված է
10 brandID-ն չի գտնվել
20 Համարները չեն գտնվել
30 Հաղորդագրության տեքստը դատարկ է
40 SMS մնացորդը բավարար չէ
50 Վավեր համարներ չեն գտնվել
60 sendTime ձևաչափը սխալ է։ Օգտագործեք Y-m-d H:i
90 JSON սխալ
99 Ընդհանուր սխալ

⚠️ Սահմաններ և նշումներ

  • Հարցման մարմնի առավելագույն չափ՝ 100 MB → Ավելի մեծ հարցումները մերժվում են։

  • Cloudflare պրոքսիի սպասման սահման՝ 100 վայրկյան → Ավելի երկար հարցումները վերադարձնում են 524 Timeout։

  • Մեծ SMS խմբաքանակների հարցումները բաժանեք՝ սպասման և հիշողության խնդիրներից խուսափելու համար։

  • Օգտագործեք stopList ՝ արգելափակված համարներին չուղարկելու համար։

Փորձարկման գործնական դիտարկում՝

SMS՝ մեկ ստացողին Հարցման առավելագույն համարների քանակ
1 400,000
2 200,000
3 150,000
4 120,000
5 100,000
6 50,000

Փաստացի սահմանները կախված են տեքստի երկարությունից, կոդավորումից և սերվերի բեռնվածությունից։

Խորհուրդ՝

Հուսալի աշխատանքի համար պահպանեք վերևի համարների սահմանը՝ ըստ միավորված SMS-ների քանակի։

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Հարցման մարմին JSON

Հարցման մարմին
{
    "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)
}

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

1 օրինակ
Ուղարկել SMS՝ տարբեր տեքստեր Օրինակ
Պատասխան · JSON
{
    "statusID": 0,
    "smsID": 111,
    "message": "SMS Sended"
}
SMS API / Ուղարկել SMS՝ XML-ով

Ուղարկել SMS՝ XML-ով

API բանալի · Հարցում
POST https://api.ubill.dev /v1/sms/sendXml?key=YOUR_API_KEY

Պատասխանի կարգավիճակ

statusID Նկարագրություն
0 SMS-ն ուղարկված է
10 brandID-ն չի գտնվել
20 Համարները չեն գտնվել
30 Հաղորդագրության տեքստը դատարկ է
40 SMS մնացորդը բավարար չէ
50 Վավեր համարներ չեն գտնվել
90 JSON սխալ
99 Ընդհանուր սխալ

⚠️ Սահմաններ և նշումներ

  • Հարցման մարմնի առավելագույն չափ՝ 100 MB → Ավելի մեծ հարցումները մերժվում են։

  • Cloudflare պրոքսիի սպասման սահման՝ 100 վայրկյան → Ավելի երկար հարցումները վերադարձնում են 524 Timeout.

  • Մեծ SMS հարցումները բաժանեք փոքր մասերի՝ սպասման և հիշողության խնդիրներից խուսափելու համար։

  • Օգտագործեք stopList ՝ արգելափակված համարներին չուղարկելու համար։

URL պարամետրեր 1

keyqueryYOUR_API_KEY

Հարցման մարմին XML

Հարցման մարմին
<?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>

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

1 օրինակ
Ուղարկել SMS՝ XML-ով Օրինակ
Պատասխան · XML
<?xml version="1.0" encoding="UTF-8"?>
<response>
    <statusID>0</statusID>
    <smsID>11574</smsID>
    <message>SMS Sent</message>
</response>
SMS API / Առաքման հաշվետվություն

Առաքման հաշվետվություն

API բանալի · Վերնագիր
GET https://api.ubill.dev /v1/sms/report/{smsID}

Կարգավիճակներ

statusID Նկարագրություն
0 Ուղարկված
1 Ստացված
2 Չառաքված
3 Կարգավիճակի սպասում
4 Սխալ

URL պարամետրեր 1

smsIDpath{smsID}

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

1 օրինակ
Առաքման հաշվետվություն Օրինակ
Պատասխան · JSON
{
    "statusID": 0,
    "result": [
        {
            "number": "9955XXXXXXXX",
            "statusID": "0"
        },
        {
            "number": "9955XXXXXXXX",
            "statusID": "0"
        }
    ]
}
SMS API / Ստանալ SMS մնացորդը

Ստանալ SMS մնացորդը

API բանալի · Հարցում
GET https://api.ubill.dev /v1/sms/balance?key=YOUR_API_KEY
Այս վերջնակետը Postman հավաքածուում առանձին նկարագրություն չունի։

URL պարամետրեր 1

keyqueryYOUR_API_KEY

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

1 օրինակ
Ստանալ SMS մնացորդը Օրինակ
Պատասխան · JSON
{
    "statusID": 0,
    "sms": 5000
}
SMS API / API իրադարձությունների հետադարձ կանչեր

API իրադարձությունների հետադարձ կանչեր

API բանալի · Հարցում
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 իրադարձությունների հետադարձ կանչեր

API հավելվածի կարգավորումներում կա մեկ ընդհանուր HTTPS հետադարձ կանչի URL ։ Առաքման հաշվետվությունները, SMS բրենդի ակտիվացման ծանուցումներն ու ապագա API իրադարձություններն ուղարկվում են նույն հասցեին՝ GET հարցմամբ .

Օգտագործեք event պարամետրը՝ ծանուցման տեսակը որոշելու համար։ Հաջող մշակումից հետո վերադարձեք ցանկացած 2xx HTTP կարգավիճակ։

Ընդհանուր պարամետրեր

Պարամետր Նկարագրություն
key API հավելվածի կարգավորումների callback ստուգման բանալի
event Իրադարձության տեսակ
date Իրադարձության ժամանակը ( Y-m-d H:i:s)

Աջակցվող իրադարձություններ

Իրադարձություն Լրացուցիչ պարամետրեր
sms.delivery.updatedsmsID, number, statusID
sms.brand.activatedbrandID, brandName, authorized=1

SMS բրենդի ակտիվացման օրինակ

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

URL պարամետրեր 6

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

Կոդի օրինակներ

cURL · PHP · JavaScript

Պատասխանների օրինակներ

0 օրինակ
Այս վերջնակետի պատասխանի օրինակ չկա։
SMS API / SMS առաքման հետադարձ կանչ

SMS առաքման հետադարձ կանչ

API բանալի · Հարցում
GET https://example.com/callback?key=YourCallbackKey&event=sms.delivery.updated&smsID=12345678&number=9955XXXXXXXX&statusID=1&date=2026-02-01 12:02:02

Հաղորդագրության ավտոմատ կարգավիճակ (Callback)

SMS API-ն թույլ է տալիս ձեր սերվերում ավտոմատ ստանալ ուղարկված հաղորդագրությունների կարգավիճակը՝ Հետադարձ կանչ մեխանիզմը։

Երբ կարգավիճակը փոխվում է (ուղարկված, ստացված, չառաքված և այլն), համակարգն ուղարկում է GET հարցմամբ ձեր նշած հասցեին HTTPS հասցե .

Callback URL-ի պահանջները՝

  • Պետք է սկսվի հետևյալով՝ https://

  • Մեթոդը՝ GET

  • Սահմանվում է ընկերության API կարգավորումներում

Պարամետրեր

Պարամետր Նկարագրություն
key Ձեր սերվերի callback ստուգման բանալին
smsID Հաղորդագրության եզակի նույնացուցիչը
number Ստացողի բջջային համարը (միջազգային ձևաչափ)
statusID Հաղորդագրության ընթացիկ կարգավիճակի կոդը
date Կարգավիճակի թարմացման ժամանակը ( Y-m-d H:i:s)

Կարգավիճակի կոդեր

statusID Նկարագրություն
0 Ուղարկված
1 Ստացված
2 Չառաքված
3 Կարգավիճակի սպասում
4 Սխալ

Callback մշակման օրինակ (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 պարամետրեր 6

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

Կոդի օրինակներ

cURL · PHP · JavaScript

Պատասխանների օրինակներ

0 օրինակ
Այս վերջնակետի պատասխանի օրինակ չկա։
API ԽՈՒՄԲ

Բիլինգ API

13 վերջնակետ

ՌԵՍՈՒՐՍ

Հաճախորդներ

5 վերջնակետ

Բիլինգ API / Հաճախորդներ / Ստանալ բոլոր հաճախորդներին

Ստանալ բոլոր հաճախորդներին

API բանալի · Վերնագիր
GET https://api.ubill.dev /v1/customers
Այս վերջնակետը Postman հավաքածուում առանձին նկարագրություն չունի։

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

0 օրինակ
Այս վերջնակետի պատասխանի օրինակ չկա։
Բիլինգ API / Հաճախորդներ / Ստեղծել հաճախորդ

Ստեղծել հաճախորդ

API բանալի · Վերնագիր
POST https://api.ubill.dev /v1/customers/create

Ստեղծում է նոր հաճախորդ՝ հեռախոսահամարների հետ։ Հաճախորդի համարը ( id պատասխանում, cID ներքին համակարգում) ստեղծվում է ավտոմատ և եզակի է ընկերության ներսում։

Պահանջվող թույլտվություն՝ customers.create ։ Հարցման մարմինը պետք է լինի JSON, իսկ Content-Type: application/json վերնագիրը պարտադիր է։

Հարցման մարմին

Դաշտ Տեսակ Պարտադիր Նկարագրություն
typeID ամբողջ թիվ այո Հաճախորդի իրավական տեսակը պետք է լինի uBill-ի տեսակների ցանկում ( 1 = ֆիզիկական անձ)։
name տող, առավելագույնը 50 ոչ Հաճախորդի անունը։
personalNo տող, առավելագույնը 11 ոչ Անձնական համար կամ ընկերության կոդ՝ միայն տառեր և թվեր։
email տող ոչ Ուղարկելիս պետք է լինի վավեր էլփոստի հասցե։
birthDate տող ոչ Ամսաթիվ՝ YYYY-MM-DD ձևաչափով։
lang տող ոչ Հետևյալներից մեկը՝ ka, en, ru ։ Լռելյայն՝ ընկերության հաճախորդի լեզվի կարգավորումը։
address տող, առավելագույնը 50 ոչ Հաճախորդի հասցեն։
column1, column2 տող, առավելագույնը 50 ոչ Ազատ լրացուցիչ դաշտեր։
numbers զանգված այո Հաճախորդի հեռախոսահամարները․ առնվազն մեկը պարտադիր է։

numbers[] օբյեկտ

Դաշտ Տեսակ Նկարագրություն
number տող Տեղական համար՝ առանց երկրի կոդի, 6–15 թվանշան։
mobile տող Լրիվ միջազգային համար։ Այս բանալին օգտագործելիս երկրի կոդը հեռացվում է համարի սկզբից։
countryCode տող Երկրի կոդը, լռելյայն՝ +995.
isPrimary 0 կամ 1 Նշում է հիմնական համարը։ Եթե նշված չէ, ցանկի առաջին համարն է դառնում հիմնական։
smsEnabled 0 կամ 1 Համարը SMS ծանուցումներ ստանո՞ւմ է, լռելյայն՝ 1.
note տող, առավելագույնը 100 Համարի ազատ նշում։

Մեկ համար կարելի է ուղարկել նաև կարճ ձևով՝ {"mobile": "9955XXXXXXXX", "countryCode": "+995"} հետևյալի փոխարեն՝ numbers զանգվածի։ Կրկնվողները հեռացվում են առանց ծանուցման, իսկ նույն ընկերության այլ հաճախորդի համարը մերժվում է։

Պատասխաններ

HTTPstatusID Նկարագրություն
2010 Հաճախորդը ստեղծված է, data պարունակում է նոր հաճախորդին։
400400 Ստուգումը ձախողվել է, errors օբյեկտը նշում է բոլոր անվավեր դաշտերը։
50099 Հաճախորդը չի պահպանվել․ ոչինչ չի գրանցվել։

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Հարցման մարմին JSON

Հարցման մարմին
{
    "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": "ბიოს"
        }
    ]
}

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

3 օրինակ
Հաճախորդը ստեղծված է 201
Պատասխան · 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"
    }
}
Ստուգումը ձախողվել է 400
Պատասխան · 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"
    }
}
Համարն արդեն օգտագործվում է 400
Պատասխան · JSON
{
    "statusID": 400,
    "message": "Validation failed",
    "data": null,
    "errors": {
        "numbers": "+9955XXXXXXXX is already assigned to another customer"
    }
}
Բիլինգ API / Հաճախորդներ / Ստանալ հաճախորդին

Ստանալ հաճախորդին

API բանալի · Վերնագիր
GET https://api.ubill.dev /v1/customers/100001
Այս վերջնակետը Postman հավաքածուում առանձին նկարագրություն չունի։

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

0 օրինակ
Այս վերջնակետի պատասխանի օրինակ չկա։
Բիլինգ API / Հաճախորդներ / Հաճախորդի որոնում

Հաճախորդի որոնում

API բանալի · Վերնագիր
GET https://api.ubill.dev /v1/customers/search?type=mobile&value=9955XXXXXXXX
Այս վերջնակետը Postman հավաքածուում առանձին նկարագրություն չունի։

URL պարամետրեր 2

typequerymobile
valuequery9955XXXXXXXX

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

0 օրինակ
Այս վերջնակետի պատասխանի օրինակ չկա։
Բիլինգ API / Հաճախորդներ / Հաճախորդի հաշիվներ

Հաճախորդի հաշիվներ

API բանալի · Վերնագիր
GET https://api.ubill.dev /v1/customers/accounts/100001
Այս վերջնակետը Postman հավաքածուում առանձին նկարագրություն չունի։

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

1 օրինակ
Հաճախորդի հաշիվներ Օրինակ
Պատասխան · 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"
        }
    ]
}
ՌԵՍՈՒՐՍ

Հաշիվներ

5 վերջնակետ

Բիլինգ API / Հաշիվներ / Ստանալ բոլոր հաշիվները

Ստանալ բոլոր հաշիվները

API բանալի · Վերնագիր
GET https://api.ubill.dev /v1/accounts
Այս վերջնակետը Postman հավաքածուում առանձին նկարագրություն չունի։

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

1 օրինակ
Ստանալ բոլոր հաշիվները Օրինակ
Պատասխան · 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"
        }
    ]
}
Բիլինգ API / Հաշիվներ / Ստեղծել հաշիվ

Ստեղծել հաշիվ

API բանալի · Վերնագիր
POST https://api.ubill.dev /v1/accounts/create

Գոյություն ունեցող հաճախորդի համար ստեղծում է նոր հաշիվ (ծառայություն)։ Հաշվի համարը ( id պատասխանում) գեներացվում է ընկերության cID կարգավորումներից՝ ինչպես uBill վեբ միջերեսում։

Պահանջվող թույլտվություն՝ accounts.create ։ Հարցման մարմինը պետք է լինի JSON, իսկ Content-Type: application/json վերնագիրը պարտադիր է։

Հարցման մարմին

Դաշտ Տեսակ Պարտադիր Նկարագրություն
customerID ամբողջ թիվ այո Հաշվի տիրոջ՝ հաճախորդի համարը, նույն id արժեքը, որը վերադարձնում են հաճախորդի վերջնակետերը։
name տող, առավելագույնը 50 ոչ Հաշվի անունը։
birthDate տող ոչ Ամսաթիվ՝ YYYY-MM-DD ձևաչափով։
areaID ամբողջ թիվ ոչ uBill շրջանների ցանկի բնակավայրի նույնացուցիչը։
address տող, առավելագույնը 50 ոչ Ծառայության հասցեն։
geoLocation տող, առավելագույնը 100 ոչ Կոորդինատները՝ 41.732438,44.7688134 ձևաչափով։
column1, column2 տող, առավելագույնը 50 ոչ Ազատ լրացուցիչ դաշտեր։
tariffID ամբողջ թիվ ոչ Ընկերության սակագնի համարը։
groupID ամբողջ թիվ ոչ Ընկերության խմբի կամ մասնաճյուղի համարը։
tagsID ամբողջ թվերի զանգված ոչ Հաշվին կցված ընկերության պիտակների համարները։
numbers զանգված ոչ Հաշվի հեռախոսները նկարագրվում են հաճախորդի նույն ձևով։ Ի տարբերություն հաճախորդի՝ հաշիվը կարելի է ստեղծել առանց համարի։

Մոդուլից կախված դաշտեր

Այս դաշտերը կարդացվում են միայն համապատասխան մոդուլի ակտիվացման դեպքում։

Դաշտ Մոդուլ Պարտադիր Նկարագրություն
mac Ցանց այո Սարքի MAC հասցեն՝ եզակի ընկերության ներսում։
onuMac Ցանց ոչ ONU MAC հասցեն՝ եզակի ընկերության ներսում։
ipRangeID Ցանց այո NAS IP միջակայքի համարը։ Առաջին ազատ հասցեն ավտոմատ տրվում է հաշվին և վերադարձվում որպես ip.
stbMacIPTV ոչ STB MAC հասցեն՝ եզակի ընկերության ներսում։
gpsProviderIDGPS track այո Ընկերության GPS մատակարարի համարը։
gpsTrackIdentifierGPS track ոչ Սարքի նույնացուցիչը՝ եզակի ընկերության ներսում։

SMS ծանուցում

Եթե ընկերության կարգավորումներում միացված է հաշվի ավելացման SMS-ը, այն ուղարկվում է նոր հաշվի բոլոր SMS ակտիվ համարներին՝ գանձվելով ընկերության մնացորդից։ Անբավարար մնացորդի դեպքում հաշիվը միևնույն է ստեղծվում է, իսկ պատասխանում կա լրացուցիչ warning դաշտ։

Պատասխաններ

HTTPstatusID Նկարագրություն
2010 Հաշիվը ստեղծված է, data պարունակում է նոր հաշիվը։
400400 Ստուգումը ձախողվել է, errors օբյեկտը նշում է սխալ դաշտերը։ Կրկնվող MAC-ներն ու հեռախոսները հաղորդվում են նույն կերպ։
50099 Հաշիվը չի պահպանվել․ ոչինչ չի գրանցվել։

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Հարցման մարմին JSON

Հարցման մարմին
{
    "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
        }
    ]
}

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

4 օրինակ
Հաշիվը ստեղծված է 201
Պատասխան · 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 մնացորդի 201
Պատասխան · 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"
}
Ստուգումը ձախողվել է 400
Պատասխան · 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-ն արդեն օգտագործվում է 400
Պատասխան · JSON
{
    "statusID": 400,
    "message": "Account creation failed",
    "data": null,
    "errors": {
        "account": [
            "ეს MAC მისამართი უკვე მითითებულია სხვა ანგარიშზე"
        ]
    }
}
Բիլինգ API / Հաշիվներ / Ստանալ հաշիվը

Ստանալ հաշիվը

API բանալի · Վերնագիր
GET https://api.ubill.dev /v1/accounts/100001
Այս վերջնակետը Postman հավաքածուում առանձին նկարագրություն չունի։

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

1 օրինակ
Ստանալ հաշիվը Օրինակ
Պատասխան · 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"
        }
    ]
}
Բիլինգ API / Հաշիվներ / Հաշիվների որոնում

Հաշիվների որոնում

API բանալի · Վերնագիր
GET https://api.ubill.dev /v1/accounts/search?type=mobile&value=9955XXXXXXXX
Այս վերջնակետը Postman հավաքածուում առանձին նկարագրություն չունի։

URL պարամետրեր 2

typequerymobile
valuequery9955XXXXXXXX

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

0 օրինակ
Այս վերջնակետի պատասխանի օրինակ չկա։
Բիլինգ API / Հաշիվներ / Սահմանել վարկ

Սահմանել վարկ

API բանալի · Վերնագիր
POST https://api.ubill.dev /v1/accounts/setCredit
Այս վերջնակետը Postman հավաքածուում առանձին նկարագրություն չունի։

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Հարցման մարմին JSON

Հարցման մարմին
{
    "accountID": 170114,
    "date": "2023-12-10"
}

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

1 օրինակ
Սահմանել վարկ Օրինակ
Պատասխան · JSON
{
    "statusID": 0,
    "message": "Success"
}
ՌԵՍՈՒՐՍ

Վճարումներ

3 վերջնակետ

Բիլինգ API / Վճարումներ / Ստանալ վճարումները

Ստանալ վճարումները

API բանալի · Վերնագիր
GET https://api.ubill.dev /v1/payments
Այս վերջնակետը Postman հավաքածուում առանձին նկարագրություն չունի։

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

1 օրինակ
Ստանալ վճարումները Օրինակ
Պատասխան · 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"
        }
    ]
}
Բիլինգ API / Վճարումներ / Ստանալ վճարումները ըստ հաշվի

Ստանալ վճարումները ըստ հաշվի

API բանալի · Վերնագիր
GET https://api.ubill.dev /v1/payments/account/100001
Այս վերջնակետը Postman հավաքածուում առանձին նկարագրություն չունի։

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

1 օրինակ
Ստանալ վճարումները ըստ հաշվի Օրինակ
Պատասխան · 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"
        }
    ]
}
Բիլինգ API / Վճարումներ / Ավելացնել վճարում

Ավելացնել վճարում

API բանալի · Վերնագիր
POST https://api.ubill.dev /v1/payments/add
Այս վերջնակետը Postman հավաքածուում առանձին նկարագրություն չունի։

Հարցման վերնագրեր 2

Բանալի Արժեք Աղբյուր
keyYOUR_API_KEY Նույնականացում
Content-Typeapplication/json Վերնագիր

Հարցման մարմին JSON

Հարցման մարմին
{
    "accountID" : 170114,
    "sum" : 1,
    "comment": "text",
    "paySystem": "WEB"
}

Կոդի օրինակներ

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);

Պատասխանների օրինակներ

1 օրինակ
Ավելացնել վճարումներ Օրինակ
Պատասխան · JSON
{
    "statusID": 0,
    "message": "Success",
    "data": {
        "id": "11521"
    }
}
ՕԳՆՈՒԹՅՈ՞ՒՆ Է ՊԵՏՔ

Ինտեգրման աջակցություն

uBill թիմը կօգնի API ինտեգրման ցանկացած հարցում։

Կապվել մեզ հետ
Ենթակառուցվածք և տեխնոլոգիաներ

Օգտագործում ենք առաջատար և հուսալի տեխնոլոգիաներ

uBill-ը կառուցված է կայունություն, անվտանգություն և հեշտ ընդլայնում ապահովող ժամանակակից գործիքներով

Վերև