Help Center އެސްއެމްއެސްބީއޭޓީ ޗެޓްހަބް އެޕީއައި

އެސްއެމްއެސްބީއޭޓީ ޗެޓްހަބް އެޕީއައި

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

ބޭސް ޔޫއާރްއެލް

https://chatapi.smsbat.com

ސްވެގަރ ޑޮކިއުމަންޓޭޝަން

އިންޓަރެކްޓިވް އެޕީއައި ޑޮކިއުމަންޓޭޝަން ލިބެން ހުރީ:

https://chatapi.smsbat.com/index.html

އޮތެންޓިކޭޝަން

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

ގޮތް 1: އޮތޮރައިޒޭޝަން ހެޑަރ

curl -X GET https://chatapi.smsbat.com/api/company/organization \
  -H "Authorization: Bearer your-jwt-token"

ގޮތް 2: އެކްސް-އޮތޮރައިޒޭޝަން-ކީ ހެޑަރ

curl -X GET https://chatapi.smsbat.com/api/company/organization \
  -H "X-Authorization-Key: your-jwt-token"

އޮތެންޓިކޭޝަން ފްލޯ

ޗެޓްހަބްގައި ބޭނުންކުރަނީ ދެ ލެވެލްގެ ޓޯކަން ސިސްޓަމެކެވެ:

  1. ކުންފުނީގެ ޓޯކަން - އޯގަނައިޒޭޝަން ފެންވަރުގެ އެކްސެސް ޓޯކަން
  2. އޮޕަރޭޓަރ ޓޯކަން - ވަކިވަކި އޮޕަރޭޓަރުންނަށް އެކްސެސް ޓޯކަން

ވޯކްފްލޯ

graph LR
    A[Get Company Token] --> B[List Organizations]
    B --> C[List/Add Operators]
    C --> D[Get Operator Token]
    D --> E[Integrate Widget]

މައިގަނޑު އެންޑްޕޮއިންޓްސް

ގޮތްއެންޑްޕޮއިންޓްތަފްސީލު
ޕޯސްޓް/api/company/get-tokenކުންފުނީގެ ހުއްދަ ޓޯކަން ހޯދުން
ގެޓް/api/ކުންފުނި/އޮގަނައިޒޭޝަންއޯގަނައިޒޭޝަން ލިސްޓް ހޯދުން
ގެޓް/api/އޮޕަރޭޓަރއޯގަނައިޒޭޝަންގެ ގޮތުގައި އޮޕަރޭޓަރުން ލިސްޓްކުރުން
ޕޯސްޓް/api/އޮޕަރޭޓަރ/ސިންކްރޮނައިޒްއާ އޮޕަރޭޓަރުން އިތުރުކުރުން
ޕޯސްޓް/api/އޮޕަރޭޓަރ/ސްޓޭޓަސްއޮޕަރޭޓަރުގެ ހާލަތު ބަދަލުކުރުން
ޕޯސްޓް/api/operator/get-tokenއޮޕަރޭޓަރ ޓޯކަން ޖެނެރޭޓްކުރުން (މެކްސް 24h މުއްދަތު ހަމަވުން)
ޕޯސްޓް/api/އޮޕަރޭޓަރ/ވެލިޑޭޓް-ޓޯކަންޓޯކަން ސައްހަކަން ޔަގީންކުރުން

މުހިއްމު ސިފަތައް

ކުންފުނީގެ ޓޯކަން މެނޭޖްމަންޓް

އެޕީއައި އެކްސެސް އަށް އޯގަނައިޒޭޝަން ލެވެލްގެ ޓޯކަންތައް ހޯދައި ބެލެހެއްޓުން.

އޯގަނައިޒޭޝަން މެނޭޖްމަންޓް

  • ހުރިހާ ޖަމިއްޔާތަކެއް ލިސްޓްކުރުން
  • އޯގަނައިޒޭޝަންގެ ތަފްސީލުތައް ހޯދުން
  • އޯގަނައިޒޭޝަން ސެޓިންގސް މެނޭޖްކުރުން

އޮޕަރޭޓަރ މެނޭޖްމަންޓް

  • އޯގަނައިޒޭޝަނަށް ބަލައިގެން އޮޕަރޭޓަރުން ލިސްޓްކުރުން
  • އާ އޮޕަރޭޓަރުން އިތުރުކުރުން
  • އޮޕަރޭޓަރ ސްޓޭޓަސް ބަދަލުކުރުން (އެކްޓިވް/އިންއެކްޓިވް/ޑިލީޓް)
  • އޮޕަރޭޓަރަށް ޚާއްޞަ ޓޯކަންތައް އުފެއްދުން (ގިނަވެގެން 24 ގަޑިއިރު)
  • އޮޕަރޭޓަރ ޓޯކަންތައް ސައްހަކުރުން

ވިޖެޓް އިންޓަގްރޭޝަން

ރިއަލް ޓައިމް ކަސްޓަމަރ ސަޕޯޓަށް ޗެޓްހަބް ވިޖެޓް ވެބް އެޕްލިކޭޝަންތަކަށް އިންޓަގްރޭޓް ކުރުން.

އަވަހަށް ފެށުން

  1. އޮތެންޓިކޭޝަން - ތިމާގެ ކުންފުންޏާއި އޮޕަރޭޓަރުގެ ޓޯކަން ހޯދުން
  2. އޮގަނައިޒޭޝަންތައް - އޯގަނައިޒޭޝަންތައް ބެލެހެއްޓުން
  3. އޮޕަރޭޓަރުން - އޮޕަރޭޓަރުން އިތުރުކޮށް މެނޭޖްކުރުން
  4. ވިޖެޓް އިންޓަގްރޭޝަން - ޗެޓް ވިޖެޓް އިންޓަގްރޭޓްކުރުން

ރިކުއެސްޓް ފޯމެޓް

ހުރިހާ ރިކުއެސްޓްތަކެއްގައިވެސް ބޭނުންކުރަނީ ޖޭއެސްއޯއެން ފޯމެޓް:

{
  "login": "your-login",
  "password": "your-password"
}

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

ކާމިޔާބު ޖަވާބުތައް އަނބުރާ އަންނަނީ:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiration": "2025-01-24T12:00:00Z"
}

އެރަރ ހެންޑްލިންގ

އެޗްޓީޓީޕީ ސްޓޭޓަސް ކޯޑްތައް:

  • 200 އޯކޭ - ރިކުއެސްޓް ކާމިޔާބުވެއްޖެ
  • 400 ނުބައި ރިކުއެސްޓް - ސައްހަ ނޫން ރިކުއެސްޓް ފޯމެޓެއް
  • 401 ހުއްދަ ނެތް - އޮތެންޓިކޭޝަން ފެއިލްވެއްޖެ
  • 403 މަނާ - އެކަށީގެންވާ ހުއްދަ ނުލިބުން
  • 404 ނުފެނޭ - ރިސޯސް ނުފެނެއެވެ
  • 500 އިންޓަރނަލް ސަރވަރ އެރަރ - ސަރވަރ އެރަރ

ޓޯކަން މުއްދަތު ހަމަވުން

ޓޯކަންތަކުގެ މުއްދަތު ހަމަވާ ވަގުތެކެވެ. ޓޯކަންއެއްގެ މުއްދަތު ހަމަވާއިރު:

  1. އެޕީއައި އިން ރިޓަރން ކުރާނީ 401 އަންއޮތޯރައިޒްޑް އެވެ
  2. އޮތެންޓިކޭޝަން އެންޑްޕޮއިންޓް ބޭނުންކޮށްގެން އާ ޓޯކަން އެއް ހޯދުމަށް އެދުމެވެ
  3. އާ ޓޯކަން އިން އެޕްލިކޭޝަން އަޕްޑޭޓް ކުރުން

ދެން އަޅަންޖެހޭ ފިޔަވަޅުތައް