API ინტეგრაციის შესახებ

GOSMS.GE API გთავაზობთ პროგრამულ წვდომას ჩვენს რესურსებთან. შესაძლებლობას გაძლებთ მოახდინოთ ჩვენი სერვისის ინტეგრაცია თვქნს სისტემაში და მართივად მიაწვდინოთ ხმა მომხმარებელს.

სერვისის გამოსაყენებლად დაგჭირდებათ ჩვენს სისტემაში რეგისტრაცია და შემდგომ დამატებული API key.
დამატებითი კითვების შენთხვევაში გთხოვთ მოგვმართოთ საკონტაქტო ელ.ფოსტაზე: [email protected].

BIT24 Unity

Powered by Graey

SMS გაგზავნა

GET მეთოდით შეტყობინების გასაგზავნათ მიმართეთ შემდეგ მისამართს
https://api.gosms.ge/api/sendsms

QUERY პარამეტრები

Field	Type	Description
api_key	String	Your API key.
from	String	ბრენდ სახელი(გამგზავნის დასახელება)
to	String	მიმღების ნომერი. ფორმატი: 995123456789
text	String	სმს შეტყობინეის ტექსტი. მაქსიმალური სიმბოლო. ლათინური: 918 სიმბოლო, 6 სმს შეტობინება. უნიკოდი(ქართული): 402 სიმბოლო 6 სმს შეტყობინება.
urgent	Boolean	თუ urgent=true, მესიჯი მივა იმ შემთხვევაშიც კი, თუ მიმღებ ნომერს დაბლოკილი აქვს მესიჯების მიღება (გამოიყენება მხოლოდ სისტემური დაგზავნისას და არა სარეკლამო დაგზავნისას)


Result example :
{
  "success": true,
  "messageId": 1,
  "from": "GOSMS.GE",
  "to": "995123456789",
  "text": "სატესტო სმს შეტყობინება",
  "sendAt": "2020-05-23T08:36:57.255Z",
  "balance": 94,
  "encode": "unicode",
  "segment": 1,
  "smsCharacters": 23
}

POST მეთოდით შეტყობინების გასაგზავნათ მიმართეთ შემდეგ მისამართს
https://api.gosms.ge/api/sendsms

BODY პარამეტრები JSON

Field	Type	Description
api_key	String	Your API key.
from	String	ბრენდ სახელი(გამგზავნის დასახელება)
to	String	მიმღების ნომერი. ფორმატი: 995123456789
text	String	სმს შეტყობინეის ტექსტი. მაქსიმალური სიმბოლო. ლათინური: 918 სიმბოლო, 6 სმს შეტობინება. უნიკოდი(ქართული): 402 სიმბოლო 6 სმს შეტყობინება.
urgent	Boolean	თუ urgent=true, მესიჯი მივა იმ შემთხვევაშიც კი, თუ მიმღებ ნომერს დაბლოკილი აქვს მესიჯების მიღება (გამოიყენება მხოლოდ სისტემური დაგზავნისას და არა სარეკლამო დაგზავნისას)


Result example :
{
  "success": true,
  "messageId": 1,
  "from": "GOSMS.GE",
  "to": "995123456789",
  "text": "სატესტო სმს შეტყობინება",
  "sendAt": "2020-05-23T08:36:57.255Z",
  "balance": 94,
  "encode": "unicode",
  "segment": 1,
  "smsCharacters": 23
}

SMS სტატუსის შემოწმება

გაგზავნილი სმს შეტყობინების სტატუსის გადამოწმება

GET მეთოდით შეტყობინების სტატუსის გადამოწმება:
https://api.gosms.ge/api/checksms

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your API key.
messageId	String	`messageId` რომელიც გიბრუნდებათ შეტობინების წარმატებით გაგზავნის შემთხვევაში


Result example :
{
  "success": true,
  "messageId": 1,
  "from": "GOSMS.GE",
  "to": "995123456789",
  "text": "სატესტო სმს შეტყობინება",
  "sendAt": "2020-05-23T08:36:57.255Z",
  "encode": "unicode",
  "segment": 1,
  "smsCharacters": 23,
  "status": 'DELIVERED',
}

POST მეთოდით შეტყობინების სტატუსის გადამოწმება:
https://api.gosms.ge/api/checksms

BODY PARAMETERS

Field	Type	Description
api_key	String	Your API key.
messageId	String	`messageId` რომელიც გიბრუნდებათ შეტობინების წარმატებით გაგზავნის შემთხვევაში


Result example :
{
  "success": true,
  "messageId": 1,
  "from": "GOSMS.GE",
  "to": "995123456789",
  "text": "სატესტო სმს შეტყობინება",
  "sendAt": "2020-05-23T08:36:57.255Z",
  "encode": "unicode",
  "segment": 1,
  "smsCharacters": 23,
  "status": 'DELIVERED',
}

OTP SMS გაგზავნა

OTP(ერთჯერადი დროებითი პაროლი) შეტყობინების გასაგზავნათ აუცილებელია სისტემაში დაამატოთ API key, რომელსაც შეგიძლიათ მიუთითოთ პარამეტრად:
- ბრენდ სახელი: რომლითაც გაიგზავნება შეტყობინება
- აპლიკაციის სახელი: მომხმარებლისთვის მარტივად მისახვედრათ თუ რომელ სისტემაში შეუძლია გამოიყენოს პაროლი
- აპლიკაციის ხელმოწერის კოდი: გამოიყენება მობილურის აპლიკაციის შემთხვევაში აპლიკაციის იდენტიფიკაციისთვის.
- კოდის მოქმედების ვადა: უთითებთ ერთჯერადი პაროლის მოქმედების ვადას, რის მერეც პაროლი ხდება არავალიდური.

მომხმარებელთან გაგზავნილი პაროლი არ ინახება სისტემაში და მხოლოდ შეტყობინებაში შეუძლია ნახოს მომღებმა მომხმარებელმა.

POST მეთოდით სერვისის გამოსაყენებლად გამოიყენეთ:
https://api.gosms.ge/api/otp/send

BODY PARAMETERS

Field	Type	Description
api_key	String	Your API key.
phone	String	მიმღების ნომერი. ფორმატი: 995123456789


Result example :
{
  "success": true,
  "hash": "hashkey",
  "to": "995123456789",
  "sendAt": "2020-05-24T09:56:02.449Z",
  "encode": "default",
  "segment": 1,
  "smsCharacters": 57
}

OTP SMS შემოწმება

OTP(ერთჯერადი დროებითი პაროლი) ვალიდურობის შემოწმება:

POST მეთოდით სერვისის გამოსაყენებლად გამოიყენეთ:
https://api.gosms.ge/api/otp/verify

BODY PARAMETERS

Field	Type	Description
api_key	String	Your API key.
phone	String	მიმღების ნომერი. ფორმატი: 995123456789
hash	String	hash გიბრუნდებათ OTP SMS გაგზავნის მოთხოვნაში
code	String	კოდი რომელიც მივიდა შეტყობინებით და შეიყვანა მომმხარებელმა


Result example :
{
  "success": true,
  "verify": true
}

SMS ბალანსის შემოწმება

POST მეთოდით სერვისის გამოსაყენებლად გამოიყენეთ:
https://api.gosms.ge/api/sms-balance

BODY PARAMETERS

Field	Type	Description
api_key	String	Your API key.


Result example :
{
  "success": true,
  "balance": 1
}

GET მეთოდით სერვისის გამოსაყენებლად გამოიყენეთ:
https://api.gosms.ge/api/sms-balance

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your API key.


Result example :
{
  "success": true,
  "balance": 1
}

ბრენდ სახელი შექმნა

POST მეთოდით სერვისის გამოსაყენებლად გამოიყენეთ:
https://api.gosms.ge/api/sender

BODY PARAMETERS

Field	Type	Description
api_key	String	Your API key.
name	String	Sender name


Result example :
{
  "success": true
}

Errors

GOSMS.GE API გამოყენებისას ბრუნდება შემდეგი შეცდომები:

Error Code	Meaning
100	არარსებული ან არავალიდური `api_key`. ეს შეცდომა ბრუნდება იმ შემთხვევაში თუ არ გადასწემთ API key ან თქვენი API key არავალიდურია.
101	არავალიდური `from`. შეცდომა ბრუნდება იმ შემთხვევაში თუ ბრენდ სახელი არ არის თვქენ მომხმარებელზე დარეგისტრირებული ან არ არის გააქტიურებული
102	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც თვქენ GOSMS.GE-ს ბალანსზე არის არასაკმარისი სმს რაოდენობა.
103	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც შეტყობინების სიგრძე არის დაშვებულზე დიდი. ლათინური: 918 სიმბოლო, 6 სმს შეტობინება. უნიკოდი(ქართული): 402 სიმბოლო 6 სმს შეტყობინება.
104	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც messageId არ მოიძებნა სისტემაში.
105	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც ნომერი არის არასწორი ფორმატის.
106	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც ნომერი არის ბლოკირებული.
107	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც ბრენდ სახელი უკვე არსებობს სისტემაში.
108	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც ბრენდ სახელის შექმა შეუძლებელია.