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

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

GOSMS.GE API provides programmatic access to our resources. It enables you to integrate our service into your system and easily reach your customers.

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

To use the service, you need to register in our system and add an API key.
For additional questions, please contact us at: [email protected].

BIT24 Unity

Powered by Graey

SMS გაგზავნა Send SMS

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

To send a message using GET method, use the following endpoint
https://api.gosms.ge/api/sendsms

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

Field	Type	Description
api_key	String	Your API key.
from	String	ბრენდ სახელი (გამგზავნის დასახელება)Sender name (brand name)
to	String	მიმღების ნომერი. ფორმატი: 995123456789 Recipient phone number. Format: 995123456789
text	String	სმს შეტყობინეის ტექსტი. მაქსიმალური სიმბოლო: SMS message text. Maximum characters: ლათინური: 918 სიმბოლო, 6 სმს შეტობინება.Latin: 918 characters, 6 SMS segments. უნიკოდი (ქართული): 402 სიმბოლო, 6 სმს შეტყობინება.Unicode (Georgian): 402 characters, 6 SMS segments.
urgent	Boolean	თუ urgent=true, მესიჯი მივა იმ შემთხვევაშიც კი, თუ მიმღებ ნომერს დაბლოკილი აქვს მესიჯების მიღება (გამოიყენება მხოლოდ სისტემური დაგზავნისას და არა სარეკლამო დაგზავნისას) If urgent=true, message will be delivered even if recipient has blocked messages (used only for system messages, not for advertising)


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

To send a message using POST method, use the following endpoint
https://api.gosms.ge/api/sendsms

BODY პარამეტრები JSONBODY Parameters (JSON)

Field	Type	Description
api_key	String	Your API key.
from	String	ბრენდ სახელი (გამგზავნის დასახელება)Sender name (brand name)
to	String	მიმღების ნომერი. ფორმატი: 995123456789 Recipient phone number. Format: 995123456789
text	String	სმს შეტყობინეის ტექსტი. მაქსიმალური სიმბოლო: SMS message text. Maximum characters: ლათინური: 918 სიმბოლო, 6 სმს შეტობინება.Latin: 918 characters, 6 SMS segments. უნიკოდი (ქართული): 402 სიმბოლო, 6 სმს შეტყობინება.Unicode (Georgian): 402 characters, 6 SMS segments.
urgent	Boolean	თუ urgent=true, მესიჯი მივა იმ შემთხვევაშიც კი, თუ მიმღებ ნომერს დაბლოკილი აქვს მესიჯების მიღება (გამოიყენება მხოლოდ სისტემური დაგზავნისას და არა სარეკლამო დაგზავნისას) If urgent=true, message will be delivered even if recipient has blocked messages (used only for system messages, not for advertising)


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
}

Bulk SMS გაგზავნა Send Bulk SMS

მრავალ მიმღებზე ერთდროული SMS შეტყობინების გასაგზავნად გამოიყენეთ:
https://api.gosms.ge/api/sendbulk

To send SMS messages to multiple recipients simultaneously, use:
https://api.gosms.ge/api/sendbulk

შეზღუდვა: მაქსიმუმ 1000 მიმღები ერთ მოთხოვნაში.

Limit: Maximum 1000 recipients per request.

BODY პარამეტრები JSONBODY Parameters (JSON)

Field	Type	Description
api_key	String	Your API key.
from	String	ბრენდ სახელი (გამგზავნის დასახელება)Sender name (brand name)
to	Array[String]	მიმღებების ნომრების მასივი. ფორმატი: ["995123456789", "995987654321"] Array of recipient phone numbers. Format: ["995123456789", "995987654321"]
text	String	სმს შეტყობინეის ტექსტი. მაქსიმალური სიმბოლო: SMS message text. Maximum characters: ლათინური: 918 სიმბოლო, 6 სმს შეტობინება.Latin: 918 characters, 6 SMS segments. უნიკოდი (ქართული): 402 სიმბოლო, 6 სმს შეტყობინება.Unicode (Georgian): 402 characters, 6 SMS segments.
urgent	Boolean	თუ urgent=true, მესიჯი მივა იმ შემთხვევაშიც კი, თუ მიმღებ ნომერს დაბლოკილი აქვს მესიჯების მიღება (გამოიყენება მხოლოდ სისტემური დაგზავნისას და არა სარეკლამო დაგზავნისას) If urgent=true, message will be delivered even if recipient has blocked messages (used only for system messages, not for advertising)
noSmsNumber	String	ნომერი რომელზეც მომხმარებელს შეუძლია გამოაგზავნოს SMS მიღების გასაუქმებლად (რეკლამის შემთხვევაში) Phone number where recipients can send SMS to opt-out from receiving messages (for advertising campaigns)


Request example:
{
  "api_key": "your_api_key",
  "from": "GOSMS.GE",
  "to": ["995555123456", "995598123456", "995599000000"],
  "text": "სატესტო სმს შეტყობინება",
  "urgent": false,
  "noSmsNumber": ""
}


Result example:
{
  "success": true,
  "totalCount": 3,
  "successCount": 2,
  "failedCount": 1,
  "balance": 92,
  "from": "GOSMS.GE",
  "text": "სატესტო სმს შეტყობინება",
  "encode": "unicode",
  "segment": 1,
  "smsCharacters": 23,
  "messages": [
    {
      "messageId": 123,
      "to": "995555123456",
      "success": true
    },
    {
      "messageId": 124,
      "to": "995598123456",
      "success": true
    },
    {
      "messageId": 0,
      "to": "995599000000",
      "success": false,
      "error": "Invalid phone number format"
    }
  ]
}

Response FieldsResponse Fields

Field	Type	Description
success	Boolean	true თუ ერთი მაინც წარმატებით გაიგზავნაtrue if at least one message was sent successfully
totalCount	Integer	მიმღებების საერთო რაოდენობაTotal number of recipients
successCount	Integer	წარმატებით გაგზავნილი შეტყობინებების რაოდენობაNumber of successfully sent messages
failedCount	Integer	წარუმატებელი შეტყობინებების რაოდენობაNumber of failed messages
balance	Integer	დარჩენილი SMS ბალანსიRemaining SMS balance
messages	Array	თითოეული მიმღების დეტალური შედეგიDetailed result for each recipient

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

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

Check the delivery status of sent SMS messages

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

Check message status using GET method:
https://api.gosms.ge/api/checksms

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

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


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

Check message status using POST method:
https://api.gosms.ge/api/checksms

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

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


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 გაგზავნა Send OTP SMS

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

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

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

To send OTP (One-Time Password) messages, you need to add an API key in the system, which you can configure with the following parameters:
- Sender name: The brand name from which the message will be sent
- Application name: Helps the user understand which system the password is for
- Application hash: Used for mobile app identification
- Code validity period: Sets how long the one-time password remains valid

The password sent to users is not stored in the system and can only be viewed by the recipient in the message.

To use the service via POST method:
https://api.gosms.ge/api/otp/send

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

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


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

OTP SMS შემოწმება Verify OTP SMS

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

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

Verify OTP (One-Time Password) validity:

To use the service via POST method:
https://api.gosms.ge/api/otp/verify

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

Field	Type	Description
api_key	String	Your API key.
phone	String	მიმღების ნომერი. ფორმატი: 995123456789 Recipient phone number. Format: 995123456789
hash	String	hash გიბრუნდებათ OTP SMS გაგზავნის მოთხოვნაში hash returned from OTP SMS send request
code	String	კოდი რომელიც მივიდა შეტყობინებით და შეიყვანა მომხმარებელმა Code received via SMS and entered by the user


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

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

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

To use the service via POST method:
https://api.gosms.ge/api/sms-balance

BODY პარამეტრები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

To use the service via GET method:
https://api.gosms.ge/api/sms-balance

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

Field	Type	Description
api_key	String	Your API key.


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

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

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

To use the service via POST method:
https://api.gosms.ge/api/sender

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

Field	Type	Description
api_key	String	Your API key.
name	String	ბრენდ სახელიSender name


Result example :
{
  "success": true
}

შეცდომები Errors

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

The following errors may be returned when using GOSMS.GE API:

HTTP Response Codes

API იყენებს მხოლოდ ორ HTTP სტატუს კოდს:

The API uses only two HTTP status codes:

HTTP Code	Description
`200`	წარმატებული მოთხოვნაSuccessful request
`400`	შეცდომა - დეტალური ინფორმაცია იხილეთ პასუხის `errorCode` ველშიError - see `errorCode` field in response for details

Global Error (ყველა endpoint-ისთვის)Global Error (for all endpoints)

ეს შეცდომა შეიძლება დაბრუნდეს ნებისმიერი endpoint-დან:

This error can be returned from any endpoint:

Error Code	Meaning	Endpoints
100	არარსებული ან არავალიდური `api_key`. ეს შეცდომა ბრუნდება იმ შემთხვევაში თუ არ გადასწემთ API key ან თქვენი API key არავალიდურია. Invalid or missing `api_key`. This error is returned when you don't provide an API key or your API key is invalid.	ყველაAll

Common Errors (საერთო შეცდომები)Common Errors

ეს შეცდომები შეიძლება დაბრუნდეს რამდენიმე endpoint-დან:

These errors can be returned from multiple endpoints:

Error Code	Meaning	Endpoints
101	არავალიდური `from`. შეცდომა ბრუნდება იმ შემთხვევაში თუ ბრენდ სახელი არ არის თვქენ მომხმარებელზე დარეგისტრირებული ან არ არის გააქტიურებული. Invalid `from`. Error returned when sender name is not registered to your account or is not activated.	sendsms, sendbulk, otp/send
102	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც თვქენ GOSMS.GE-ს ბალანსზე არის არასაკმარისი სმს რაოდენობა. Error returned when your GOSMS.GE balance has insufficient SMS credits.	sendsms, sendbulk, otp/send
103	არავალიდური პარამეტრები ან შეტყობინების სიგრძე დაშვებულზე დიდია. Invalid parameters or message length exceeds the limit. ლათინური: 918 სიმბოლო, 6 სმს შეტობინება.Latin: 918 characters, 6 SMS segments. უნიკოდი(ქართული): 402 სიმბოლო 6 სმს შეტყობინება.Unicode (Georgian): 402 characters, 6 SMS segments.	sendsms, sendbulk, checksms, otp/send, otp/verify, sender
105	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც ნომერი არის არასწორი ფორმატის. Error returned when phone number has invalid format.	sendsms, otp/send, otp/verify

Endpoint-Specific Errors

ეს შეცდომები სპეციფიკურია კონკრეტული endpoint-ებისთვის:

These errors are specific to particular endpoints:

Error Code	Meaning	Endpoints
104	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც messageId არ მოიძებნა სისტემაში. Error returned when messageId is not found in the system.	checksms
106	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც OTP კოდის გენერაცია ან გაგზავნა ვერ მოხერხდა. Error returned when OTP code generation or sending failed.	otp/send
107	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც ბრენდ სახელი უკვე არსებობს სისტემაში. Error returned when sender name already exists in the system.	sender
108	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც ბრენდ სახელის შექმნა შეუძლებელია ან API არ არის კონფიგურირებული OTP-სთვის. Error returned when sender name creation is not possible or API is not configured for OTP.	sender, otp/send
109	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც OTP მოთხოვნების რაოდენობა გადაჭარბებულია. გთხოვთ მოიცადოთ. Error returned when OTP request limit is exceeded. Please wait.	otp/send
110	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც ანგარიში დროებით დაბლოკილია ძალიან ბევრი წარუმატებელი მცდელობის გამო. Error returned when account is temporarily locked due to too many failed attempts.	otp/send, otp/verify
111	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც OTP კოდის მოქმედების ვადა ამოიწურა. Error returned when OTP code has expired.	otp/verify
112	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც OTP კოდი უკვე გამოყენებულია. Error returned when OTP code has already been used.	otp/verify
113	შეცდომა ბრუნდება იმ შემთხვევაში როდესაც noSmsNumber პარამეტრი არასწორია ან ნომერი არ არის კონფიგურირებული NoSMS-სთვის. Error returned when noSmsNumber parameter is invalid or number is not configured for NoSMS.	sendsms, sendbulk