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 հաղորդագրությունների կառուցվածքների համար օգտակար բեռներ պահանջելու համար.

=== «Տեքստային հաղորդագրություն»

Ուղարկում է պարզ տեքստային հաղորդագրություն:

**Լրացուցիչ պարամետրեր.**

| Պարամետր | Տեսակ | Պահանջվում է | Նկարագրություն |
| :--- | :--- | :--- | :--- |
| «txt» | լարային | **Այո** | Հաղորդագրության տեքստ: |

**Պահանջել օգտակար բեռի օրինակ.**
```http
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, երբ սեղմվում է կոճակը: |

**Պահանջել օգտակար բեռի օրինակ.**
```http
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» | լարային | Ոչ | Լրացուցիչ տեքստ՝ պատկերի տակ ցուցադրելու համար: |

**Պահանջել օգտակար բեռի օրինակ.**
```http
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, երբ սեղմվում է կոճակը: |

**Պահանջել օգտակար բեռի օրինակ.**
```http
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: |
| «video.tubnail» | լարային | **Այո** | Տեսանյութի նախադիտման պատկերի հանրային HTTPS URL: |
| «video.size_mb» | ամբողջ թիվ | **Այո** | Վիդեո ֆայլի մոտավոր չափը մեգաբայթերով: |
| «video.duration_sec» | ամբողջ թիվ | **Այո** | Տեսանյութի տևողությունը վայրկյաններով։ |
| «txt» | լարային | Ոչ | Նկարագրության կամընտիր տեքստ: |
| «կոճակ_տեքստ» | լարային | Ոչ | Ընտրովի կոճակի տեքստ (կարող է հանդես գալ որպես վերնագիր կամ հղում): |
| «կոճակ_հղում» | լարային | Ոչ | Կամընտիր կոճակի հղման URL: |

** Պահանջել բեռի օրինակ՝ **
```http
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
```

=== «OTP Կաղապար»

Ուղարկում է Viber-ի մեկանգամյա գաղտնաբառեր (OTP)՝ օգտագործելով նախապես հաստատված ձևանմուշ:

!!! նշում
    OTP հաղորդագրություններ ուղարկելիս «send_method»-ը պետք է սահմանեք «viber_otp»:

Լրացուցիչ պարամետրեր.

| Պարամետր | Տեսակ | Պահանջվում է | Նկարագրություն |
| :--- | :--- | :--- | :--- |
| «template.id» | լարային | **Այո** | Նախապես հաստատված Viber OTP ձևանմուշի ID: |
| «template.lang» | լարային | **Այո** | Կաղապարի լեզվի կոդը (օրինակ՝ «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].primary_label» | լարային | **Այո** | «N» քարտի հիմնական կոճակի վերնագիր: |
| `կարուսել[N].primary_url` | լարային | **Այո** | «N» քարտի հիմնական կոճակի հղումը: |
| `կարուսել[N].երկրորդական_պիտակ` | լարային | Ոչ | «N» քարտի երկրորդական կոճակի վերնագիր: |
| `կարուսել[N].secondary_url` | լարային | Ոչ | «N» քարտի երկրորդական կոճակի հղումը: |

** Պահանջել բեռի օրինակ՝ **
```http
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» (RadioButtons) կամ «2» (սովորական կոճակներ): |

** Պահանջել բեռի օրինակ՝ **
```http
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>

Հետզանգեր

Հետ կանչի URL-ները պետք է ներդրվեն և տեղադրվեն ձեր հարթակում: SMSBAT-ն ուղարկում է HTTP զանգեր՝ ձեր համակարգը թարմացնելու առաքման իրադարձությունների, հարցման պատասխանների և օգտատերերի պատասխանների վերաբերյալ:

1. Առաքման կարգավիճակի հետզանգ

Ուղարկվում է, երբ հաղորդագրությունը փոխում է կարգավիճակը (առաքվել է, կարդացվել է, ձախողվել է):

Բովանդակության տեսակը. «հավելված/x-www-form-urlencoded»
Մեթոդ. «ՓՈՍՏ».

** Պահանջել բեռի ձևաչափեր. **

Առաքված է:
```
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-ի պատասխանում:
«կարգավիճակ». առաքման արդյունք («առաքված», «չառաքված» կամ «կարգավիճակը անհայտ է»:
«տեսակ». սահմանել «տեսանելի», երբ հաղորդագրությունը դիտվել է ստացողի կողմից:
«status_extended». Չառաքված կարգավիճակի հատուկ տեխնիկական պատճառ (օրինակ՝ «VIBER_EXPIRED», «VIBER_BLOCKED_BY_USER», «VIBER_USER_NOT_FOUND», «VIBER_NO_DEVICE»):

2. Հարցման պատասխանը հետզանգ

Գործարկվում է, երբ օգտատերն ընտրում է պատասխանի տարբերակ Viber Survey հաղորդագրության մեջ:

Բովանդակության տեսակը. «հավելված/x-www-form-urlencoded»
Մեթոդ. «ՓՈՍՏ».

** Պահանջել բեռի ձևաչափը. **

msg_id=ORIGINAL_SURVEY_MESSAGE_GUID&text=SELECTED_OPTION_TEXT

3. Օգտատիրոջ մուտքային հաղորդագրության հետ կանչ

Գործարկվում է, երբ օգտատերը տեքստային կամ մեդիա պատասխան է ուղարկում ձեր Viber Business ծառայությանը:

Բովանդակության տեսակ. «հավելված/json»:
Մեթոդ. «ՓՈՍՏ».

** Պահանջել բեռի ձևաչափը. **

{
  "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-ն: