ޖީއެމްއެސް އެޕީއައި ކޮމްޕެޓިބިލިޓީ
އެސްއެމްއެސްބީއޭޓީ އިން ޖީއެމްއެސް އެޕީއައި އާއި ކޮމްޕެޓިބިލިޓީ ލޭޔަރ އެއް ސަޕޯޓް ކުރެއެވެ. މިއީ ޖީއެމްއެސްއަށް ފަރުމާކޮށްފައިވާ މިހާރު ހުރި އިންޓަގްރޭޝަންތައް ސީދާ އެސްއެމްއެސްބީއޭޓީއަށް މައިގްރޭޓް ކުރެވޭނީ މެސެޖް ރޫޓިން ސްކީމާތަކާއި، ޕޭލޯޑް ސްޓްރަކްޗަރތަކާއި، ނުވަތަ ކޯލްބެކް ލިސްނަރުންނަށް ބަދަލު ނުގެންނެވެ.
ކަނެކްޝަން ސެޓިންގސް
އެސްއެމްއެސްބީއޭޓީ މެދުވެރިކޮށް ރިކުއެސްޓްތައް ރޫޓް ކުރުމަށްޓަކައި، ތިބާގެ އިންޓަގްރޭޝަންގައި ހުންނަ ބޭސް ޔޫއާރްއެލް އަދި އޮތެންޓިކޭޝަން ކްރެޑެންޝިއަލްސް އަޕްޑޭޓް ކުރާށެވެ:
- ބޭސް ޔޫއާރްއެލް:
https://restapi.smsbat.com - އެންޑްޕޮއިންޓް:
ޕޯސްޓް /api/GMSMessage/send_message - ރިކުއެސްޓް ފޯމެޓް:
އެޕްލިކޭޝަން/ޖޭއެސްއޯއެން - އޮތެންޓިކޭޝަން: އެޗްޓީޓީޕީ ބޭސިކް އޮތެންޓިކޭޝަން (ތިޔަބޭފުޅުންގެ އެސްއެމްއެސްބީއޭޓީ އެޕީއައި ކްރެޑެންޝިއަލްސް ބޭނުންކުރެއެވެ)
ރިކުއެސްޓް ޕެރެމިޓަރސް
ޖީއެމްއެސް ކޮމްޕެޓިބިލިޓީ އެޕީއައި އިން ތިރީގައިވާ މަތީ ފެންވަރުގެ ޕެރެމިޓަރުތަކާއެކު ޖޭއެސްއޯއެން އޮބްޖެކްޓެއް ބަލައިގަނެއެވެ.
| ޕެރެމިޓަރ | ވައްތަރު | ބޭނުންވާ | ތަފްސީލު |
|---|---|---|---|
ފޯނު_ނަންބަރު | ސްޓްރިންގް | އާނ | ބައިނަލްއަޤްވާމީ ފޯމެޓުގައި ލިބޭ ފަރާތުގެ ފޯނު ނަންބަރު (އެބަހީ، 380501234567). |
ޓެގް | ސްޓްރިންގް | އާނ | ރަޖިސްޓްރީކޮށްފައިވާ ފޮނުވާ ފަރާތުގެ ނަން / އަލްފާ ނަން. |
ޗެނަލްތައް | އެރޭ | އާނ | ޓްރައި ކުރަންޖެހޭ ޗެނަލްތަކުގެ ލިސްޓް، އިސްކަންދޭ ތަރުތީބުން. ސަޕޯޓް ކުރެވޭ އަގުތައް: viber، sms، push. މިސާލަކަށް، ["ވައިބަރ"، "އެސްއެމްއެސް"]. |
ޗެނަލް_އޮޕްޝަންސް | އެއްޗެއް | އާނ | ކޮންމެ އެކްޓިވް ޗެނަލަކަށް އޮޕްޝަންތައް ހިމެނޭ މެޕް (ތިރީގައި ބަލާށެވެ). |
އެކްސްޓްރާ_އައިޑީ | ސްޓްރިންގް | ނޫން | ތިބާގެ އެތެރޭގެ ކަސްޓަމަރ ސައިޑް މެސެޖް އައިޑީ. |
ކޯލްބެކް_އުރލް | ސްޓްރިންގް | ނޫން | ޑެލިވަރީ ސްޓޭޓަސް ކޯލްބެކްސް ލިބޭނެ ގޮތަށް ސިސްޓަމްގައި ހުންނަ އެންޑްޕޮއިންޓް ޔޫ.އާރ.އެލް. |
ޑިވިޝަން_ކޯޑް | ސްޓްރިންގް | ނޫން | އިޚްތިޔާރީ ޑިވިޝަން ކޯޑް އައިޑެންޓިފައިޓަރ (ޑިފޯލްޓް ކޮށްފައިވަނީ main އަށެވެ). |
ޗެނަލް އޮޕްޝަންސް ސެޓިންގސް
channel_options އޮބްޖެކްޓްގައި ޗެނަލް އަށް ޚާއްޞަ ކޮންފިގްރޭޝަންތައް ހިމެނެއެވެ.
chanels އެރޭގައި viber ލިސްޓްކޮށްފައި ހުންނައިރު ބޭނުންކުރެއެވެ.
| ޕެރެމިޓަރ | ވައްތަރު | ބޭނުންވާ | ތަފްސީލު |
|---|---|---|---|
ޓެކްސްޓް | ސްޓްރިންގް | އާނ | މެސެޖް ބޮޑީ ޓެކްސްޓް. |
ttl | އިންޓިޖަރ | އާނ | ޓައިމް-ޓު-ލައިވް ސިކުންތުކޮޅެއްގެ ތެރޭގައި. |
އިމްގް | ސްޓްރިންގް | ނޫން | ދައްކާނެ ތަސްވީރުގެ ޕަބްލިކް އެޗްޓީޓީޕީއެސް ޔޫއާރްއެލް. |
ކެޕްޝަން | ސްޓްރިންގް | ނޫން | ބަޓަން ޓެކްސްޓް ލޭބަލް. |
އަމަލު | ސްޓްރިންގް | ނޫން | ބަޓަން ކްލިކް ކުރާއިރު މަންޒިލް ޔޫ.އާރ.އެލް. |
ސާރވޭ_އޮޕްޝަންސް | އެރޭ | ނޫން | ސާރވޭ އޮޕްޝަންސްގެ ގޮތުގައި ދައްކާލުމަށް ސްޓްރިންގްސް (2 އިން 5 އަށް) ގެ އެރޭ. |
ކެރޮސެލް_އައިޓަމްސް | އެރޭ | ނޫން | ވައިބަރ ކެރޮސެލްއެއްގެ ގޮތުގައި ދައްކާލުމަށް ސްލައިޑް އޮބްޖެކްޓްތަކުގެ އެރޭ (ޓެބްގައިވާ ސްޓްރަކްޗަރ ބައްލަވާ) . |
ވައިބަރ ރިކުއެސްޓް މިސާލު:
{
"phone_number": "380501234567",
"tag": "MySender",
"channels": ["viber"],
"channel_options": {
"viber": {
"text": "Hello from SMSBAT!",
"ttl": 60,
"img": "https://www.example.com/image.png",
"caption": "Open",
"action": "https://www.example.com"
}
}
}
ޖަވާބު ފޯމެޓް
އެންޑްޕޮއިންޓުން ޖަވާބުތައް ޖޭއެސްއޯއެން ފޯމެޓް ގައި އެޗްޓީޓީޕީ 200 އޯކޭ ސްޓޭޓަސް ކޯޑަކާއެކު ރިޓަރން ކުރެއެވެ.
ކާމިޔާބު ރައްދު
{
"MessageId": "6f0d5e28-7f3a-4df3-91a2-3d58d9e09b9a",
"ErrorCode": null,
"ErrorText": null
}
އެރަރ ރެސްޕޮންސްސް
ވެލިޑޭޝަން ނުވަތަ ޕްރޮސެސިންގ ފޭލްވެއްޖެނަމަ، ނޮން-ނަލް ErrorCode އާއި ތަފްސީލީ ErrorText އެއް އެކުލެވޭ އެރަރ ރެސްޕޮންސްއެއް ލިބޭނެއެވެ.
{
"MessageId": "00000000-0000-0000-0000-000000000000",
"ErrorCode": 10221,
"ErrorText": "This type of Message is not supported by the system"
}
ކޯލްބެކް ޑެލިވަރީ ފޯމެޓް
ރިކުއެސްޓްގައި callback_url ކަނޑައެޅިފައިވާނަމަ، އެސްއެމްއެސްބީއޭޓީން ޑެލިވަރީ ސްޓޭޓަސް އަޕްޑޭޓްތައް ޖޭއެސްއޯއެން ޕޯސްޓް ޕޭލޯޑެއްގެ ގޮތުގައި ތިބާގެ އެންޑްޕޮއިންޓަށް ފޮނުވައެވެ.
ކޯލްބެކް ރިކުއެސްޓް މިސާލު
POST /your-callback-endpoint HTTP/1.1
Host: yoursystem.com
Content-Type: application/json
{
"number": "380501234567",
"time": 1719237600000,
"status": 2,
"substatus": 23,
"hyber_status": 23033,
"message_id": "6f0d5e28-7f3a-4df3-91a2-3d58d9e09b9a",
"extra_id": "ORDER-12345",
"sent_via": "viber",
"matching_template_id": 0
}
ކޯލްބެކް ފީލްޑްސް ޑިސްކްރިޕްޝަން
| ދަނޑު | ވައްތަރު | ތަފްސީލު |
|---|---|---|
ނަންބަރު | ސްޓްރިންގް | ލިބޭ ފަރާތުގެ ފޯނު ނަންބަރެވެ. |
ވަގުތު | ނަންބަރު | ޔުނިކްސް މިލިސެކަންޑްގައި އިވެންޓް ޓައިމްސްޓޭމްޕް. |
ސްޓޭޓަސް | ނަންބަރު | ސިމްޕްލިފައިޑް ސްޓޭޓަސް އައިޑެންޓިފައިޓަރ (ސްޓޭޓަސް ކޯޑް ޓޭބަލް ބައްލަވާ) . |
ސަބްސްޓޭޓަސް | ނަންބަރު | ތަފްސީލީ ސްޓޭޓަސް އައިޑެންޓިފައިޓަރ (ސަބްސްޓޭޓަސް ކޯޑް ޓޭބަލް ބައްލަވާ) . |
ހައިބަރ_ސްޓޭޓަސް | ނަންބަރު | ތަފްސީލީ އެސްއެމްއެސްބީއޭޓީގެ އިންޓަރނަލް ސްޓޭޓަސް ކޯޑް (ހައިބަރ ސްޓޭޓަސް ޓޭބަލް ބައްލަވާ) . |
މެސެޖް_އައިޑީ | ސްޓްރިންގް | ފޮނުވުމުން އުފެދޭ އެސްއެމްއެސްބީއޭޓީ މެސެޖް އައިޑީ (ޖީއައިޑީ) އެވެ. |
އެކްސްޓްރާ_އައިޑީ | ސްޓްރިންގް | އަސްލު ރިކުއެސްޓްގައި ފޯރުކޮށްދީފައިވާ ކަސްޓަމަރ ސައިޑް އައިޑީ. |
ފޮނުވި_ވިއާ | ސްޓްރިންގް | މެސެޖު ޕްރޮސެސްކުރި ޗެނަލް: viber، sms، ނުވަތަ rcs. |
މެޗިންގ_ޓެމްޕްލޭޓް_އައިޑީ | ނަންބަރު | ވައިބަރ ޓެމްޕްލޭޓް މެޗް ސްޓޭޓަސް (އެކަށީގެންވާ ތަންތަނުގައި) . |
ސްޓޭޓަސް މެޕިންގސް
1. ސިމްޕްލިފައިޑް ސްޓޭޓަސް (ސްޓޭޓަސް) .
| ކޯޑް | މާނަ |
|---|---|
1 | މެސެޖު ބަލައިގަނެ ނުވަތަ ޑެލިވަރީ ކުރަމުންދާ. |
2 | މެސެޖެއް ޑެލިވަރީ ކޮށްފިއެވެ. |
3 | ޕްރޮސެސިންގ ނުވަތަ ޑެލިވަރީ އެރަރ. |
2. ތަފްސީލީ ހާލަތު (substatus)
| ކޯޑް | މާނަ |
|---|---|
12 | ޕްރޮސެސިންގ އަށް ބަލައިގަނެވޭނެއެވެ. |
23 | ފޯރުކޮށްދިނުން. |
24 | ފެނިފައި/ކިޔައިފި. |
35 | ޓީޓީއެލްގެ ތެރޭގައި ޑެލިވަރީ ނުކުރެވޭ (މުއްދަތު ހަމަވެފައިވާ) އެވެ. |
36 | ޑެލިވަރީ އެރަރ. |
3. ޗެނަލް ވައްތަރު (sent_via)
| ޗެނަލް | ތަފްސީލު |
|---|---|
ވައިބަރ | ސްޓޭޓަސް ޕްރޮޑިއުސްކޮށްފައިވަނީ ވައިބަރ ޗެނަލުންނެވެ. |
އެސްއެމްއެސް | އެސްއެމްއެސް ޗެނަލުން އުފައްދާ ސްޓޭޓަސް. |
rcs | އާރުސީއެސް ޗެނަލުން އުފައްދާފައިވާ ސްޓޭޓަސް. |
4. ތަފްސީލީ އެސްއެމްއެސްބީއޭޓީ ސްޓޭޓަސް (hyber_status)
| ކޯޑް | ޗެނަލް | ސްޓޭޓަސް | ސަބްސްޓޭޓަސް | މާނަ |
|---|---|---|---|---|
| 23033 | ވައިބަރ | 2 | 23 | ވައިބާ މެސެޖް ޑެލިވަރީ ކޮށްފިއެވެ. |
| 24013 | ވައިބަރ | 2 | 24 | ވައިބަރ މެސެޖު ކިޔުނީ ލިބޭ ފަރާތުން (ފެންނަނީ) އެވެ. |
| 36013 | ވައިބަރ | 3 | 36 | ވައިބާގެ އެތެރޭގެ ގޯހެއް. |
| 36023 | ވައިބަރ | 3 | 36 | ވައިބަރ ސާވިސް އައިޑީ ސައްހަ ނޫން ނުވަތަ ނުލިބޭ. |
| 36033 | ވައިބަރ | 3 | 36 | ވައިބަރ ޕޭލޯޑް ޑޭޓާ ސައްހަ ނޫން. |
| 36037 | ވައިބަރ | 3 | 36 | ވައިބަރ އިމޭޖް ޔޫއާރްއެލް މާ ދިގު. |
| 36038 | ވައިބަރ | 3 | 36 | ވައިބަރ އިމޭޖް ޔޫއާރްއެލް ސައްހަ ނޫން. |
| 36039 | ވައިބަރ | 3 | 36 | ވައިބަރ ޓެކްސްޓް މާ ދިގު. |
| 36044 | ވައިބަރ | 3 | 36 | ހުސް ވައިބަރ ޓެކްސްޓެއް. |
| 36053 | ވައިބަރ | 3 | 36 | ސަޕޯޓް ނުކުރާ ވައިބަރ މެސެޖް ޓައިޕް. |
| 36063 | ވައިބަރ | 3 | 36 | ސައްހަ ނޫން ވައިބަރ ޕެރެމިޓަރސް. |
| 36073 | ވައިބަރ | 3 | 36 | ވައިބަރ ޕްރޮވައިޑަރ ޓައިމްއައުޓް. |
| 36083 | ވައިބަރ | 3 | 36 | ވައިބަރ ސެންޑަރ ބްލޮކް ކޮށްފައިވަނީ ރިސީވަރެވެ. |
| 36093 | ވައިބަރ | 3 | 36 | ލިބޭ ފަރާތަކީ ވައިބަރ ޔޫޒަރެއްގެ ގޮތުގައި ރަޖިސްޓްރީކޮށްފައިވާ ފަރާތެއް ނޫނެވެ. |
| 36103 | ވައިބަރ | 3 | 36 | ވައިބަރ ސަޕޯޓް ލިބިފައިވާ އެންޑްރޮއިޑް/އައިއޯއެސް ޑިވައިސްއެއް ނުފެނެއެވެ. |
| 36113 | ވައިބަރ | 3 | 36 | ވައިބަރ ފޮނުވުމަށް ހުއްދަ ނެތް އައިޕީ އެޑްރެސް. |
| 36123 | ވައިބަރ | 3 | 36 | ޑަބިލިކޭޓް ވައިބަރ މެސެޖު ފެނިއްޖެއެވެ. |
| 36143 | ވައިބަރ | 3 | 36 | ވައިބަރ ބިލިންގ އެރަރ. |
| 36153 | ވައިބަރ | 3 | 36 | ޕްލެޓްފޯމް ބްލެކްލިސްޓުން މެސެޖެއް ބްލޮކްކޮށްފައި. |
| 36163 | ވައިބަރ | 3 | 36 | ވައިބަރ ޕްލެޓްފޯމް އިންޓަރނަލް ޕްރޮސެސިންގ އެރަރ. |
| 36173 | ވައިބަރ | 3 | 36 | ގޯސް ނުވަތަ ގެއްލިފައިވާ ވައިބަރ ލޭބަލް. |
| 36183 | ވައިބަރ | 3 | 36 | ސައްހަ ނޫން ވައިބަރ ޓީޓީއެލް ވެލިއު. |
| 12011 | sms / rcs | 1 | 12 | އެސްއެމްއެސް/އާރުސީއެސް ބަލައިގަނެވޭނެއެވެ. |
| 36011 | sms / rcs | 1 | 12 | އެސްއެމްއެސް/އާރުސީއެސް އެންރޫޓް. |
| 23011 | sms / rcs | 2 | 23 | އެސްއެމްއެސް/އާރުސީއެސް ޑެލިވަރީ ކޮށްފިއެވެ. |
| 35015 | sms / rcs | 3 | 35 | އެސްއެމްއެސް/އާރުސީއެސް މުއްދަތު ހަމަވެފައިވާ (ޓީޓީއެލްގެ ތެރޭގައި ޑެލިވަރީ ނުކުރެވޭ) އެވެ. |
| 36021 | sms / rcs | 3 | 36 | އެސްއެމްއެސް/އާރުސީއެސް މެސެޖު ޑިލީޓް ކޮށްފިއެވެ. |
| 36031 | sms / rcs | 3 | 36 | އެސްއެމްއެސް/އާރުސީއެސް ޑެލިވަރީ ނުކުރެވޭނެއެވެ. |
| 36041 | sms / rcs | 3 | 36 | އެސްއެމްއެސް/އާރުސީއެސް ޑެލިވަރީގެ ހާލަތު ނޭނގޭ. |
| 36051 | sms / rcs | 3 | 36 | އެސްއެމްއެސް/އާރުސީއެސް މެސެޖު ރިޖެކްޓް. |