މެސެޖިއޯ އެޕީއައި ކޮމްޕެޓިބިލިޓީ

އެސްއެމްއެސްބީއޭޓީ އިން މެސެޖިއޯ އެޕީއައި އާއި ކޮމްޕެޓިބިލިޓީ ލޭޔަރ އެއް ސަޕޯޓް ކުރެއެވެ. މިއީ މެސާޖިއޯއަށް ފަރުމާކޮށްފައިވާ މިހާރު ހުރި ވައިބަރ އިންޓަގްރޭޝަންތައް ސީދާ އެސްއެމްއެސްބީއޭޓީއަށް މައިގްރޭޓް ކުރެވޭއިރު، ޕޭލޯޑް ސްޓްރަކްޗަރ އަލުން ލިޔަން ނުވަތަ އިންޓަގްރޭޝަން ލޮޖިކް ބަދަލުކުރަން ނުޖެހިއެވެ.

ކަނެކްޝަން ސެޓިންގސް

އެސްއެމްއެސްބީއޭޓީ މެދުވެރިކޮށް ރިކުއެސްޓްތައް ރޫޓް ކުރުމަށްޓަކައި، ތިބާގެ އިންޓަގްރޭޝަންގައި ހުންނަ ބޭސް ޔޫއާރްއެލް އަދި އޮތެންޓިކޭޝަން ކްރެޑެންޝިއަލްސް އަޕްޑޭޓް ކުރާށެވެ:

• ބޭސް ޔޫއާރްއެލް: https://restapi.smsbat.com
• އެންޑްޕޮއިންޓް: POST /api/SendMessage
• ރިކުއެސްޓް ފޯމެޓް: application/x-www-form-urlencoded (ފޯމް ޑޭޓާ)

އޮތެންޓިކޭޝަން އެންޑް ކްރެޑެންޝަލްސް

ރިކުއެސްޓްތައް އޮތެންޓިކޭޓް ކުރެވެނީ ސީދާ ރިކުއެސްޓް ބޮޑީ ފޯމް ޑޭޓާގެ ތެރޭގައި ފޮނުވާ ޕެރެމިޓަރުތައް ބޭނުންކޮށްގެންނެވެ:

ވައިބަރ މެސެޖް ޓައިޕްސް

ވަކި ޕެރެމިޓަރުތައް ބަލާލުމަށް އަދި ވައިބަރ މެސެޖް ސްޓްރަކްޗަރތަކުގެ އެކި ސްޓްރަކްޗަރތަކަށް ޕޭލޯޑް ހޯދުމަށް ތިރީގައިވާ ޓެބެއް ހޮވާށެވެ:

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

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

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

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

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

އިތުރު ޕެރެމިޓަރސް:

| ޕެރެމިޓަރ | ވައްތަރު | ބޭނުންވާ | ތަފްސީލު |
| :--- | :--- | :--- | :--- |
| `ޓެމްޕްލޭޓް.އައިޑީ` | ސްޓްރިންގް | **އާނ** | ކުރިން އެޕްރޫވްކޮށްފައިވާ ވައިބަރ އޯޓީޕީ ޓެމްޕްލޭޓް އައިޑީ. |
| `ޓެމްޕްލޭޓް.ލަންގް` | ސްޓްރިންގް | **އާނ** | ޓެމްޕްލޭޓް ބަހުގެ ކޯޑް (އެބަހީ، `en`، `uk`). |
| `ޓެމްޕްލޭޓް.ޕެރަމްސް.ޕިން` | ސްޓްރިންގް | **އާނ** | ޓެމްޕްލޭޓަށް އިންޖެކްޓް ކުރަންޖެހޭ އޯޓީޕީ ޕިން ވެލިއު. |
| `ޓެމްޕްލޭޓް.ޕެރަމްސް.ބިޒްނަސް_ޕްލެޓްފޯމް_ނަން` | ސްޓްރިންގް | **އާނ** | ޓެމްޕްލޭޓްގައިވާ ވިޔަފާރީގެ ނަން ޕްލޭސްހޯލްޑަރ. |
| `ޓެމްޕްލޭޓް.ޕެރަމްސް.ކޯޑް_ވެލިޑިޓީ_ޓައިމް` | ސްޓްރިންގް | **އާނ** | ޕިން ސައްހަ މުއްދަތު މިނިޓުންނެވެ. |

**ރިކުއެސްޓް ޕޭލޯޑް މިސާލު:**
```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
```

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

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

ޖަވާބު ފޯމެޓް

މެސެޖިއޯ އެޕީއައި ކޮމްޕެޓިބިލިޓީ އެންޑްޕޮއިންޓުން ޖަވާބުތައް އެކްސްއެމްއެލް ފޯމެޓް ގައި އެޗްޓީޓީޕީ 200 އޯކޭ ސްޓޭޓަސް ކޯޑަކާއެކު ރިޓަރން ކުރެއެވެ.

ބަލައިގަނެވޭ (ކާމިޔާބު) ޖަވާބު

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

ކޯލްބެކްސް

ކޯލްބެކް ޔޫއާރްއެލްތައް ތަންފީޒުކޮށް ތިބާގެ ޕްލެޓްފޯމްގައި ހޯސްޓް ކުރަން ޖެހެއެވެ. އެސްއެމްއެސްބީއޭޓީން ޑެލިވަރީ އިވެންޓްތަކާއި، ސާރވޭގެ ޖަވާބުތަކާއި، ޔޫޒަރ ރިޕްލައިތަކާ ގުޅޭގޮތުން ތިބާގެ ސިސްޓަމް އަޕްޑޭޓް ކުރުމަށް އެޗްޓީޓީޕީ ކޯލްބެކްސް ފޮނުވައެވެ.

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 ޔުނިކް މެސެޖް އައިޑީ (GUID) ރިޓަރން ކުރެވެއެވެ.
• ސްޓޭޓަސް: ޑެލިވަރީގެ ނަތީޖާ (ޑެލިވަރޑް، އަންޑެލިވަރޑް، ނުވަތަ ސްޓޭޓަސް ނޭނގޭ).
• type: މެސެޖު ލިބޭ ފަރާތުން ބަލާފައި ވަނިކޮށް seen އަށް ސެޓް ކުރާށެވެ.
• status_extended: ޑެލިވަރ ނުކުރެވި ހުރި ސްޓޭޓަސް އަށް ވަކި ފަންނީ ސަބަބެއް (އެބަހީ VIBER_EXPIRED، VIBER_BLOCKED_BY_USER، VIBER_USER_NOT_FOUND، VIBER_NO_DEVICE).

2. ސާރވޭ ޖަވާބު ކޯލްބެކް

ވައިބަރ ސާރވޭ މެސެޖެއްގައި ޔޫޒަރަކު ރެސްޕޮންސް އޮޕްޝަނެއް ހޮވުމުން ޓްރިގަރ ވެއެވެ.

• ކޮންޓެންޓް-ޓައިޕް: އެޕްލިކޭޝަން/x-www-form-urlencoded
• ގޮތް: ޕޯސްޓް

ރިކުއެސްޓް ޕޭލޯޑް ފޯމެޓް:

msg_id=ORIGINAL_SURVEY_MESSAGE_GUID&text=SELECTED_OPTION_TEXT

3. އިންބައުންޑް ޔޫޒަރ މެސެޖް ކޯލްބެކް

ޓްރިގަރ ކުރެވެނީ ޔޫޒަރަކު ޓެކްސްޓެއް ނުވަތަ މީޑިއާ ރިޕްލައިއެއް އަނބުރާ ތިބާގެ ވައިބަރ ބިޒްނަސް ޚިދުމަތަށް ފޮނުވުމުންނެވެ.

• ކޮންޓެންޓް-ޓައިޕް: އެޕްލިކޭޝަން/ޖޭއެސްއޯއެން
• ގޮތް: ޕޯސްޓް

ރިކުއެސްޓް ޕޭލޯޑް ފޯމެޓް:

{
  "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: އިންބައުންޑް ރިޕްލައިއަށް އުފައްދާ ޔުނިކް މެސެޖް އައިޑީ.
• text: ޔޫޒަރ ފޮނުވާ ޓެކްސްޓް ކޮންޓެންޓް (އެމީހުން ފޮނުވީ ހަމައެކަނި މީޑިއާ ނަމަ null ވެދާނެއެވެ).
• media: ޔޫޒަރ ފޮނުވާ އެއްވެސް މީޑިއާ އެޓޭޗްމަންޓެއް ޑައުންލޯޑް ކުރުމަށް ސީދާ ޔޫ.އާރ.އެލް (އެކަނި ޓެކްސްޓް ނަމަ null ވެދާނެއެވެ).
• ފޯނު: ފޮނުވާ ފަރާތުގެ ފޯނު ނަންބަރު ބައިނަލްއަޤްވާމީ ފޯމެޓުގައި.
• sender_bm_id: ވައިބަރ ބިޒްނަސް ސެންޑަރ އައިޑީ.