Messagio API თავსებადობა

SMSBAT მხარს უჭერს თავსებადობის ფენას Messagio API-თან. ეს საშუალებას გაძლევთ გადაიტანოთ თქვენი არსებული Viber ინტეგრაციები, რომლებიც შექმნილია Messagio-სთვის პირდაპირ SMSBAT-ზე, თქვენი დატვირთვის სტრუქტურის გადაწერის ან ინტეგრაციის ლოგიკის შეცვლის გარეშე.

---

კავშირის პარამეტრები

SMSBAT-ის მეშვეობით მოთხოვნების გადასატანად, განაახლეთ საბაზისო URL და ავთენტიფიკაციის სერთიფიკატები თქვენს ინტეგრაციაში:

• ** საბაზისო URL: ** https://restapi.smsbat.com
• ბოლო წერტილი: POST /api/SendMessage
• ** მოთხოვნის ფორმატი: ** აპლიკაცია/x-www-form-urlencoded (ფორმის მონაცემები)

---

ავთენტიფიკაცია და რწმუნებათა სიგელები

მოთხოვნები ავთენტიფიცირებულია პარამეტრების გამოყენებით, რომლებიც გაგზავნილია უშუალოდ მოთხოვნის სხეულის ფორმის მონაცემებში:

პარამეტრი	ტიპი	საჭირო	აღწერა
მომხმარებელი	სიმებიანი	დიახ	თქვენი SMSBAT ანგარიშის შესვლა ან მომხმარებლის იდენტიფიკატორი.
ნიშანი	სიმებიანი	დიახ	API საიდუმლო ან ხელმოწერა რეგისტრირებულია გამგზავნის სახელზე.
დან	სიმებიანი	დიახ	რეგისტრირებული გამგზავნის ალფა სახელი.
გაგზავნის_მეთოდი	სიმებიანი	დიახ	არხის ტიპი. გამოიყენეთ viber რეგულარული Viber Business შეტყობინებებისთვის ან viber_otp Viber OTP შაბლონებისთვის.
ტელეფონი	სიმებიანი	დიახ	მიმღების ტელეფონის ნომერი საერთაშორისო ფორმატში (მაგ., 380501234567).

---

Viber შეტყობინების ტიპები

აირჩიეთ ქვემოთ მოცემული ჩანართი, რომ ნახოთ კონკრეტული პარამეტრები და მოითხოვოთ დატვირთვები სხვადასხვა Viber შეტყობინების სტრუქტურისთვის:

ტექსტური შეტყობინებატექსტი + ღილაკისურათის შეტყობინებატექსტი + სურათი + ღილაკივიდეო შეტყობინებაOTP შაბლონი

უგზავნის მარტივ ტექსტურ შეტყობინებას.

დამატებითი პარამეტრები:

პარამეტრი	ტიპი	საჭირო	აღწერა
txt	სიმებიანი	დიახ	შეტყობინების ტექსტი.

** მოითხოვეთ დატვირთვის მაგალითი: **

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Hello+from+SMSBAT%21

აგზავნის ტექსტურ შეტყობინებას ინტერაქტიული მოწოდების ღილაკით.

დამატებითი პარამეტრები:

პარამეტრი	ტიპი	საჭირო	აღწერა
txt	სიმებიანი	დიახ	შეტყობინების ტექსტი.
ღილაკი_ტექსტი	სიმებიანი	დიახ	ღილაკზე ნაჩვენები ტექსტი.
ღილაკის_ბმული	სიმებიანი	დიახ	დანიშნულების URL, როდესაც დააჭირეთ ღილაკს.

** მოითხოვეთ დატვირთვის მაგალითი: **

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Check+our+latest+offers%21&button_text=Open&button_link=https%3A%2F%2Fwww.example.com

აგზავნის საჯარო გამოსახულების ფაილს.

დამატებითი პარამეტრები:

პარამეტრი	ტიპი	საჭირო	აღწერა
სურათის_ლინკი	სიმებიანი	დიახ	სურათის საჯარო HTTPS URL.
txt	სიმებიანი	არა	სურვილისამებრ წარწერის ტექსტი გამოსახულების ქვემოთ გამოსატანად.

** მოითხოვეთ დატვირთვის მაგალითი: **

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&image_link=https%3A%2F%2Fwww.example.com%2Fimage.png

აგზავნის მდიდარ ბარათს, რომელიც შეიცავს ტექსტს, სურათს და ღილაკს.

დამატებითი პარამეტრები:

პარამეტრი	ტიპი	საჭირო	აღწერა
txt	სიმებიანი	დიახ	წარწერის ტექსტი.
სურათის_ლინკი	სიმებიანი	დიახ	სურათის საჯარო HTTPS URL.
ღილაკი_ტექსტი	სიმებიანი	დიახ	ღილაკზე ნაჩვენები ტექსტი.
ღილაკის_ბმული	სიმებიანი	დიახ	დანიშნულების URL, როდესაც დააჭირეთ ღილაკს.

** მოითხოვეთ დატვირთვის მაგალითი: **

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Hot+deals+inside%21&image_link=https%3A%2F%2Fwww.example.com%2Fimage.png&button_text=Open&button_link=https%3A%2F%2Fwww.example.com

აგზავნის ვიდეო ფაილს არასავალდებულო ტექსტური წარწერით და მოქმედების ღილაკებით.

დამატებითი პარამეტრები:

პარამეტრი	ტიპი	საჭირო	აღწერა
video.url	სიმებიანი	დიახ	ვიდეო ფაილის საჯარო HTTPS URL.
ვიდეო.მინიატურა	სიმებიანი	დიახ	ვიდეოს გადახედვის სურათის საჯარო HTTPS URL.
video.size_mb	მთელი რიცხვი	დიახ	ვიდეო ფაილის სავარაუდო ზომა მეგაბაიტებში.
ვიდეო.ხანგრძლივობა_წმ	მთელი რიცხვი	დიახ	ვიდეოს ხანგრძლივობა წამებში.
txt	სიმებიანი	არა	არჩევითი აღწერილობის ტექსტი.
ღილაკი_ტექსტი	სიმებიანი	არა	არჩევითი ღილაკის ტექსტი (შეიძლება იმოქმედოს როგორც წარწერა ან ბმული).
ღილაკის_ბმული	სიმებიანი	არა	არჩევითი ღილაკის ბმული URL.

** მოითხოვეთ დატვირთვის მაგალითი: **

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Watch+this+tutorial%21&video.url=https%3A%2F%2Fwww.example.com%2Fvideo.mp4&video.thumbnail=https%3A%2F%2Fwww.example.com%2Fvideo-thumbnail.png&video.size_mb=1&video.duration_sec=3&button_text=Open&button_link=https%3A%2F%2Fwww.example.com

აგზავნის Viber-ის ერთჯერადი პაროლებს (OTP) წინასწარ დამტკიცებული შაბლონის გამოყენებით.

შენიშვნა

OTP შეტყობინებების გაგზავნისას, თქვენ უნდა დააყენოთ sending_method, როგორც viber_otp.

დამატებითი პარამეტრები:

| პარამეტრი | ტიპი | საჭირო | აღწერა |
| :--- | :--- | :--- | :--- |
| `template.id` | სიმებიანი | **დიახ** | წინასწარ დამტკიცებული Viber OTP შაბლონის ID. |
| `თარგი.ენა` | სიმებიანი | **დიახ** | შაბლონის ენის კოდი (მაგ., `en`, `uk`). |
| `template.params.pin` | სიმებიანი | **დიახ** | OTP პინის მნიშვნელობა შაბლონში შესატანად. |
| `template.params.business_platform_name` | სიმებიანი | **დიახ** | ბიზნესის სახელის ადგილი შაბლონში. |
| `template.params.code_validity_time` | სიმებიანი | **დიახ** | PIN-ის მოქმედების პერიოდი წუთებში. |

** მოითხოვეთ დატვირთვის მაგალითი: **
```http
POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber_otp&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&template.id=otp_template_123&template.lang=en&template.params.pin=123456&template.params.business_platform_name=SMSBAT&template.params.code_validity_time=7
```

კარუსელის შეტყობინებაგამოკითხვის შეტყობინება

აგზავნის ინტერაქტიული შეტყობინების ბარათს, რომელიც შეიცავს მრავალ სლაიდს (ბარათებს), რომელთა მეშვეობითაც მომხმარებელს შეუძლია გადაფურცვლა.

დამატებითი პარამეტრები:

პარამეტრი	ტიპი	საჭირო	აღწერა
txt	სიმებიანი	დიახ	კარუსელის სათაურის ტექსტი.
კარუსელი[N].სათაური	სიმებიანი	დიახ	ბარათის სათაური N (დაწყებული 0-დან).
კარუსელი[N].image_url	სიმებიანი	დიახ	ბარათის N საჯარო HTTPS სურათის URL.
კარუსელი[N].პირველადი_ეტიკეტი	სიმებიანი	დიახ	ბარათის მთავარი ღილაკის წარწერა N.
კარუსელი[N].primary_url	სიმებიანი	დიახ	"N" ბარათის მთავარი ღილაკის ბმული URL.
კარუსელი[N].მეორადი_ეტიკეტი	სიმებიანი	არა	ბარათის მეორადი ღილაკის წარწერა N.
კარუსელი[N].secondary_url	სიმებიანი	არა	მეორადი ღილაკის ბმული ბარათის N.

** მოითხოვეთ დატვირთვის მაგალითი: **

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Top+picks+for+you&carousel%5B0%5D.title=First+Offer&carousel%5B0%5D.image_url=https%3A%2F%2Fwww.example.com%2Fitem-1.png&carousel%5B0%5D.primary_label=Open&carousel%5B0%5D.primary_url=https%3A%2F%2Fwww.example.com%2Fitem-1&carousel%5B0%5D.secondary_label=Details&carousel%5B0%5D.secondary_url=https%3A%2F%2Fwww.example.com%2Fitem-1%2Fdetails&carousel%5B1%5D.title=Second+Offer&carousel%5B1%5D.image_url=https%3A%2F%2Fwww.example.com%2Fitem-2.png&carousel%5B1%5D.primary_label=Open&carousel%5B1%5D.primary_url=https%3A%2F%2Fwww.example.com%2Fitem-2

აგზავნის შეტყობინებას ინტერაქტიული გამოკითხვის ან გამოკითხვის კითხვის შემცველობით.

დამატებითი პარამეტრები:

პარამეტრი	ტიპი	საჭირო	აღწერა
txt	სიმებიანი	დიახ	გამოკითხვის კითხვის ტექსტი.
გამოკითხვის_ოფციები[N]	სიმებიანი	დიახ	გამოკითხვის ვარიანტის ტექსტი პუნქტისთვის N (ინდექსი იწყება 0-დან). მინიმუმ 2 ვარიანტია საჭირო.
ოპციის_ტიპი	მთელი რიცხვი	დიახ	ამომრჩევის ტიპი: 1 (რადიო ღილაკები) ან 2 (ჩვეულებრივი ღილაკები).

** მოითხოვეთ დატვირთვის მაგალითი: **

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Please+rate+our+service&survey_options%5B0%5D=Excellent&survey_options%5B1%5D=Good&survey_options%5B2%5D=Average&option_type=1

---

პასუხის ფორმატი

Messagio API თავსებადობის საბოლოო წერტილი აბრუნებს პასუხებს XML ფორმატში HTTP 200 OK სტატუსის კოდით.

მიღებული (წარმატებული) პასუხი

<response>
  <code>0</code>
  <tech_message>OK</tech_message>
  <msg_id phone="380501234567">MESSAGE_GUID</msg_id>
</response>

შეცდომის პასუხები

თუ მოთხოვნის პარამეტრების ვალიდაცია ვერ მოხერხდა ან ავთენტიფიკაცია ვერ მოხერხდა, პასუხი დააბრუნებს არანულოვან კოდს.

ხელმოწერა აკლიაარაავტორიზებული

<response>
  <code>-1</code>
  <tech_message>PARAM ERROR (sign)</tech_message>
</response>

<response>
  <code>-2</code>
  <tech_message>ERROR(unauthorized)</tech_message>
</response>

---

გამოძახებები

Callback URL-ები უნდა განხორციელდეს და განთავსდეს თქვენს პლატფორმაზე. SMSBAT აგზავნის HTTP გამოხმაურებას თქვენი სისტემის განახლებისთვის მიწოდების მოვლენებთან, გამოკითხვის პასუხებთან და მომხმარებლის პასუხებთან დაკავშირებით.

1. მიწოდების სტატუსის დაბრუნება

გაგზავნილია, როდესაც შეტყობინება გადადის სტატუსის (მიწოდებული, წაკითხული, წარუმატებელი).

• ** შინაარსის ტიპი: ** აპლიკაცია/x-www-form-urlencoded
• მეთოდი: POST

** მოითხოვეთ დატვირთვის ფორმატები: **

მიწოდება:

msg_id=MESSAGE_GUID&status=delivered

* ნახული/წაკითხული:

msg_id=MESSAGE_GUID&status=delivered&type=seen

* მიუწოდებელი / ვერ მოხერხდა:

msg_id=MESSAGE_GUID&status=undelivered&status_extended=REASON

** ველების აღწერა:**

• msg_id: SMSBAT შეტყობინების ID (GUID) დაბრუნდა SendMessage პასუხში.
• სტატუსები: მიწოდების შედეგი (`მიწოდებული“, „მიუწოდებელი“ ან „სტატუსები უცნობია“).
• type: დააყენეთ seen, როდესაც შეტყობინება ნახულია მიმღების მიერ.
• სტატუსები_გაფართოებული: კონკრეტული ტექნიკური მიზეზი მიუწოდებელი სტატუსისთვის (მაგ. VIBER_EXPIRED, VIBER_BLOCKED_BY_USER, VIBER_USER_NOT_FOUND, VIBER_NO_DEVICE).

---

2. გამოკითხვის პასუხი გამოძახებით

ამოქმედდება, როდესაც მომხმარებელი ირჩევს პასუხის ვარიანტს Viber Survey შეტყობინებაში.

• ** შინაარსის ტიპი: ** აპლიკაცია/x-www-form-urlencoded
• მეთოდი: POST

** მოითხოვეთ დატვირთვის ფორმატი: **

msg_id=ORIGINAL_SURVEY_MESSAGE_GUID&text=SELECTED_OPTION_TEXT

---

3. შემომავალი მომხმარებლის შეტყობინება გამოძახება

ამოქმედდება, როდესაც მომხმარებელი უგზავნის ტექსტურ ან მედია პასუხს თქვენს Viber Business სერვისზე.

• ** შინაარსის ტიპი: ** აპლიკაცია/json
• მეთოდი: POST

** მოითხოვეთ დატვირთვის ფორმატი: **

{
  "msg_id": "INBOUND_MESSAGE_GUID",
  "text": "Hello, I have a question",
  "media": "https://example.com/user-attachment.png",
  "phone": "380501234567",
  "sender_bm_id": "12345"
}

** ველების აღწერა:**

• msg_id: უნიკალური შეტყობინების ID, რომელიც გენერირებულია შემომავალი პასუხისთვის.
• ტექსტი: მომხმარებლის მიერ გაგზავნილი ტექსტური შინაარსი (შეიძლება იყოს null, თუ მათ მხოლოდ მედია გაგზავნეს).
• მედია: პირდაპირი URL მომხმარებლის მიერ გაგზავნილი ნებისმიერი მედია დანართისთვის (შეიძლება იყოს null მხოლოდ ტექსტის შემთხვევაში).
• ტელეფონი: გამგზავნის ტელეფონის ნომერი საერთაშორისო ფორმატში.
• sender_bm_id: Viber Business გამგზავნის ID.