Help Center ސްޕީޗްކޯލް މެސެޖްތައް

ސްޕީޗްކޯލް މެސެޖްތައް

ސްޕީޗްކޯލް އަކީ މެނޫ އޮޕްޝަންތަކާއި ޑީޓީއެމްއެފް (ޑައުއަލް ޓޯން މަލްޓި ފްރީކުއެންސީ) އިންޓަރެކްޝަންތަކާއެކު އޮޓޮމެޓިކް ވޮއިސް ކޯލް ކުރެވޭ އިންޓަރެކްޓިވް ވޮއިސް ރެސްޕޮންސް (އައިވީއާރު) މެސެޖް ޓައިޕެކެވެ.

އޯވަރވިއު

ސްޕީޗްކޯލްގެ ސަބަބުން ވިޔަފާރިތަކަށް:

ކަސްޓަމަރުންނަށް އޮޓޮމެޓިކް ވޮއިސް ކޯލް ކުރުން
ތަޢާރަފް އޯޑިއޯ މެސެޖުތައް ކުޅުން
އިންޓަރެކްޓިވް މެނޫ އޮޕްޝަންތައް ހުށަހެޅުން
ޑީޓީއެމްއެފް ކީޕްރެސް ޖަވާބުތައް (0-9، *، #) ޙަވާލުކުރުން
ސައްހަ ނޫން/ޓައިމްއައުޓް އިންޕުޓްތަކަށް ކަސްޓަމް ބިހޭވިއަރ ކަނޑައެޅުން
ޔޫޒަރ ސެލެކްޝަންތަކަށް ބަލައިގެން ކަސްޓަމް ބޮޑީސް އާއި ހެޑަރސް އާއި އެކު ވެބްހޫކްސް ޓްރިގަރ ކުރުން
ކޯލް ފްލޯ ޑައިނަމިކް ގޮތެއްގައި މެނޭޖްކުރުން (މެނޫތަކުގެ މެދުގައި ދަތުރުކުރުން)

ޔޫސް ކޭސްސް

ކަސްޓަމަރ ސާރވޭސް - ފޯނުގެ މެނޫ އޮޕްޝަންސް މެދުވެރިކޮށް ފީޑްބެކް އެއްކުރުން
އެޕޮއިންޓްމަންޓް ރިމައިންޑަރސް - އަޑު މުޢާމަލާތާއެކު ކޮންފަރމް ނުވަތަ ރީޝެޑިއުލްކުރުން
އޯޑަރ ޓްރެކިންގ - އޯޑަރ ސްޓޭޓަސް އަޕްޑޭޓްސް ފޯރުކޮށްދިނުން
އިންޓަރެކްޓިވް ނޮޓިފިކޭޝަންސް - ފިޔަވަޅު އެޅުމުގެ އިޚްތިޔާރުތަކާއެކު މުހިންމު މަޢުލޫމާތު ފޯރުކޮށްދިނުން
ވޮއިސް ވެރިފިކޭޝަން - ވޮއިސް ކޯލް މެދުވެރިކޮށް މަލްޓި ފެކްޓަރ އޮތެންޓިކޭޝަން

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

އަސާސީ އޮނިގަނޑު

{
  "messages": [
    {
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "text": "ivr",
      "type": "speechcall",
      "menu": [
        {
          "introUrl": "ivr_XXXXX",
          "idleTimeoutMsec": 10000,
          "dtmfActions": {
            "d1": [
              {
                "action": "webhook",
                "url": "https://YourWebhookURL/0",
                "body": {
                  "confirm": true
                },
                "headers": {
                  "test-header": "test"
                }
              },
              {
                "action": "hangup"
              }
            ],
            "d2": [
              {
                "action": "webhook",
                "url": "https://YourWebhookURL/1",
                "body": {
                  "confirm": false
                }
              },
              {
                "action": "hangup"
              }
            ],
            "wrong": [
              {
                "action": "gotoMenu",
                "menu": "1"
              }
            ]
          }
        }
      ]
    }
  ]
}

ޕެރެމިޓަރ ޑިސްކްރިޕްޝަން

ޕެރެމިޓަރ	ވައްތަރު	ބޭނުންވާ	ތަފްސީލު
`އިން`	ސްޓްރިންގް	އާދެ	ސެންޑަރ އައިޑެންޓިފައިޓަރ (އަލްފާ ނަން ނުވަތަ އައިޑީ)
`އަށް`	ސްޓްރިންގް	އާދެ	ލިބޭ ފަރާތުގެ ފޯނު ނަންބަރު ބައިނަލްއަޤްވާމީ ފޯމެޓުގައި
`ޓެކްސްޓް`	ސްޓްރިންގް	އާދެ	ޓެކްސްޓް ވެލިއު، އާންމުކޮށް “ivr” އަށް ސްޕީޗްކޯލް
`ވައްތަރު`	ސްޓްރިންގް	އާދެ	ވާންޖެހޭނީ `"ސްޕީޗްކޯލް"`
`މެނޫ`	އެރޭ	އާދެ	ކޯލް އަށް މެނޫ ކޮންފިގްރޭޝަންތަކުގެ އެރޭ

މެނޫ ކޮންފިގްރޭޝަން

ކޮންމެ މެނޫ އޮބްޖެކްޓެއްގައި ހިމެނެނީ:

ޕެރެމިޓަރ	ވައްތަރު	ބޭނުންވާ	ތަފްސީލު
`އިންޓްރޯއުރލް`	ސްޓްރިންގް	އާދެ	ތަޢާރަފް އޯޑިއޯ ފައިލްގެ ޔޫ.އާރ.އެލް ނުވަތަ އައިޑެންޓިފައިޓަރ
`idleTimeoutMsec`	އިންޓިޖަރ	ނޫން	ކީޕްރެސް އަކަށް އިންތިޒާރު ކުރުމަށް މިލިސެކަންޑްގައި ޓައިމްއައުޓް (އެބަހީ، `10000`). ޔޫޒަރ ޖަވާބު ނުދީފިނަމަ، `ގޯސް` ކީގެ ދަށުން ކޮންފިގްރޭޓް ކުރެވިފައިވާ އަމަލުތައް އެގްޒެކެޓް ކުރެވޭނެ
`dtmfActions`	އެއްޗެއް	އާދެ	ޑީޓީއެމްއެފް ކީސް ޓު އެކްޝަންސްގެ މެޕް

ޑީޓީއެމްއެފްގެ އަމަލުތައް

dtmfActions އޮބްޖެކްޓް ޑީޓީއެމްއެފް ކީސް ނުވަތަ ޚާއްޞަ ޝަރުތުތައް އެކްޝަންތަކުގެ އެރޭތަކަށް މެޕްކުރެއެވެ:

ޑީޓީއެމްއެފް ކީ	ތަފްސީލު
`ދ0`	0 އަށް ފިތާލާށެވެ
`ދ1`	1 އަށް ފިތާލާށެވެ
`ދ2`	2 އަށް ފިތާލާށެވެ
…	…
`ދ9`	ޕްރެސް 9
`ދ*`	ފިއްތާލާ *
`ދ#`	#
`ގޯސް`	ސައްހަ ނޫން ކީއެއް ފިއްތާލުމުން ނުވަތަ އެއްވެސް އިންޕުޓެއް ނެތި `idleTimeoutMsec` އަށް ވާސިލްވުމުން ޓްރިގަރ ކުރެއެވެ

ކޮންމެ ޑީޓީއެމްއެފް ކީ/ކޮންޑިޝަނެއް މެޕް ކުރަނީ ތަރުތީބުން އެގްޒެކެޓް ކުރާނެ ޢަމަލުތަކުގެ އެރޭއަކަށެވެ.

ސަޕޯޓް ކުރެވޭ އަމަލުތައް

ފިޔަވަޅު	ޕެރެމިޓަރސް	ތަފްސީލު
`ވެބްހޫކް`	`url` (ސްޓްރިންގް، ބޭނުންވާ) `ބޮޑީ` (އޮބްޖެކްޓް، އިޚްތިޔާރީ) `ހެޑަރސް` (އޮބްޖެކްޓް، އިޚްތިޔާރީ)	ކަނޑައެޅިފައިވާ ޔޫ.އާރ.އެލް އަށް ޖޭއެސްއޯއެން ފޯމެޓުގައި އެޗްޓީޓީޕީ ޕޯސްޓް ރިކުއެސްޓެއް ފޮނުވައެވެ. ވެބްހޫކް ރިކުއެސްޓްގައިވާ `އެކްޝަން` ފީލްޑްގެ ދަށުން `ބޮޑީ` އޮބްޖެކްޓް ނެސްޓް ކުރެވޭނެއެވެ. ކަސްޓަމް ހެޑަރސް ހިމަނާފައިވަނީ އެޗްޓީޓީޕީ ހެޑަރސްގެ ގޮތުގައެވެ.
`ހެންގްއަޕް`	އެއްވެސް އެއްޗެއް ނެތް	ކޯލް ނިންމާލަނީ
`ގޯޓޯމެނޫ`	`މެނޫ` (ސްޓްރިންގް ނުވަތަ އިންޓިޖަރ)	އޭގެ 0 އަށް ބިނާކޮށްފައިވާ އިންޑެކްސް (އެބަހީ، `"1"`) ބޭނުންކޮށްގެން `މެނޫ` އެރޭގައިވާ އެހެން މެނޫއަކަށް ކޯލް ނެވިގޭޓް ކުރެއެވެ

ތަފްސީލީ ފިޔަވަޅު އެޅުމުގެ ސުލޫކު

ވެބްހޫކް އެކްޝަން (`ވެބްހޫކް`)

webhook އެކްޝަން އިން ކޯލް މެޓަޑޭޓާ އާއި އިޚްތިޔާރީ ކަސްޓަމް ޑޭޓާއާއެކު ތިބާގެ ކޯލްބެކް ޔޫއާރްއެލް އަށް އެޗްޓީޓީޕީ ޕޯސްޓް ރިކުއެސްޓެއް ފޮނުވައެވެ:

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

ހެންގްއަޕް އެކްޝަން (`ހެންގަޕް`)

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

މެނޫ އެކްޝަން (`gotoMenu`) އަށް ދާށެވެ.

gotoMenu އެކްޝަން އިން ކޯލްގެ ފްލޯ ރީޑައިރެކްޓް ކުރަނީ menu އެރޭގެ ތެރޭގައިވާ ތަފާތު މެނޫ ސްޓްރަކްޗަރ އަކަށެވެ. އެއީ ޓާގެޓް މެނޫގެ 0 އަށް ބިނާކޮށްފައިވާ އިންޑެކްސް ކަނޑައަޅާ އެއް ޕެރެމިޓަރ މެނޫ އެއް ނަގައެވެ (އެބަހީ، ދެވަނަ މެނޫއަށް ދިއުމަށް "1"، ނުވަތަ ފުރަތަމަ މެނޫ އަލުން ފެށުމަށް "0").

އިންއެކްޓިވިޓީ އެންޑް އެރަރ ހެންޑްލިންގ (`ގޯސް`)

dtmfActions ގެ ތެރޭގައިވާ ގޯސް ކީ އަކީ ޚާއްޞަ ފޯލްތްރޫ ހެންޑްލަރެކެވެ. އެއީ އޭގެ އެރޭ އޮފް އެކްޝަންސް ސިކުއެންސް ދެ މަންޒަރެއްގައި އެގްޒެކެޓް ކުރާ އެއްޗެކެވެ.

އިންވެލިޑް އިންޕުޓް: ގުޅާ މީހާ ފިއްތާނީ dtmfActions ގައި ކަނޑައެޅިފައި ނުވާ ޑީޓީއެމްއެފް ކީއެއް (މިސާލަކަށް އެމީހުން 3 ފިއްތާ ނަމަވެސް މެނޫއިން ކަނޑައަޅަނީ ހަމައެކަނި d1 އަދި d2) އެވެ.
Idle Timeout: idleTimeoutMsec އިން ކަނޑައަޅާފައިވާ މުއްދަތުގެ ތެރޭގައި ގުޅާ މީހާ އެއްވެސް ކީއަކަށް ފިތާފައެއް ނުވެއެވެ.

ގޯސް މާނަ ނުކުރެވި، ކޯލް ކުރާ މީހާ ސައްހަ ނޫން ކީއެއް ފިއްތާނަމަ ނުވަތަ ޓައިމް އައުޓް ވެއްޖެނަމަ، ކޯލް ފްލޯ ޑިފޯލްޓްކޮށް ހޭންގް އަޕް ވާނެއެވެ. ގޯސް މާނަކުރުމުން ލޫޕް މެނޫތައް ބިލްޑް ކުރެވޭނެ (އެބަހީ، "action": "gotoMenu", "menu": "0" އާއެކު ހަމަ އެ މެނޫއަށް އެނބުރި ދިއުން) ނުވަތަ ޔޫޒަރ ހެލްޕް މެނޫއަކަށް ރީޑައިރެކްޓް ކުރުމެވެ.

ވެބްހޫކް ޑެލިވަރީ ފޯމެޓް

webhook އެކްޝަން ޓްރިގަރ ވުމުން، ސިސްޓަމުން ކޮންފިގްރޭޓް ކުރެވިފައިވާ url އަށް Content-Type: application/json އާއެކު އެޗްޓީޓީޕީ ޕޯސްޓް ރިކުއެސްޓެއް ފޮނުވައެވެ.

ވެބްހޫކް ރިކުއެސްޓް ހެޑަރސް

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

ވެބްހޫކް ރިކުއެސްޓް ބޮޑީ

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

{
  "from": "0443914272",
  "to": "50001",
  "mid": "7748021",
  "action": {
    "confirm": true
  }
}

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

ފުރިހަމަ މިސާލު

ޓައިމްއައުޓް އެންޑް އިންޕުޓް ވެލިޑޭޝަން އާއި އެކު ސިމްޕަލް އައިވީއާރު

{
  "messages": [
    {
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "text": "ivr",
      "type": "speechcall",
      "menu": [
        {
          "introUrl": "ivr_651854",
          "idleTimeoutMsec": 10000,
          "dtmfActions": {
            "d1": [
              {
                "action": "webhook",
                "url": "https://YourWebhookURL/0",
                "body": {
                  "confirm": true
                }
              },
              {
                "action": "hangup"
              }
            ],
            "d2": [
              {
                "action": "webhook",
                "url": "https://YourWebhookURL/1",
                "body": {
                  "confirm": false
                }
              },
              {
                "action": "hangup"
              }
            ],
            "wrong": [
              {
                "action": "hangup"
              }
            ]
          }
        }
      ]
    }
  ]
}

މަލްޓިޕަލް މެނޫތަކާއި ޑީޓީއެމްއެފް ރޫޓިންގ އާއި އެކު ކޮމްޕްލެކްސް އައިވީއާރު

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

{
  "messages": [
    {
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "text": "ivr",
      "type": "speechcall",
      "menu": [
        {
          "introUrl": "ivr_XXXXX",
          "idleTimeoutMsec": 10000,
          "dtmfActions": {
            "d1": [
              {
                "action": "webhook",
                "url": "https://YourWebhookURL/0",
                "body": {
                  "confirm": true
                },
                "headers": {
                  "test-header": "test"
                }
              },
              {
                "action": "hangup"
              }
            ],
            "d2": [
              {
                "action": "webhook",
                "url": "https://YourWebhookURL/1",
                "body": {
                  "confirm": false
                }
              },
              {
                "action": "hangup"
              }
            ],
            "wrong": [
              {
                "action": "gotoMenu",
                "menu": "1"
              }
            ]
          }
        },
        {
          "introUrl": "ivr_651854",
          "idleTimeoutMsec": 10000,
          "dtmfActions": {
            "d1": [
              {
                "action": "webhook",
                "url": "https://YourWebhookURL/0",
                "body": {
                  "confirm": true
                }
              },
              {
                "action": "hangup"
              }
            ],
            "d2": [
              {
                "action": "webhook",
                "url": "https://YourWebhookURL/1",
                "body": {
                  "confirm": false
                }
              },
              {
                "action": "hangup"
              }
            ],
            "wrong": [
              {
                "action": "hangup"
              }
            ]
          }
        }
      ]
    }
  ]
}

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

ކާމިޔާބީގެ ރައްދު

{
  "messages": [
    {
      "messageId": "unique-message-id",
      "recipient": "+380XXXXXXXXX",
      "status": "sent"
    }
  ]
}

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

އެޗްޓީޓީޕީ ސްޓޭޓަސް	ތަފްސީލު
200	ރިކުއެސްޓް ކާމިޔާބު
400 ރުފިޔާ	ސައްހަ ނޫން ރިކުއެސްޓް ފޯމެޓެއް
401 ރުފިޔާ	އޮތެންޓިކޭޝަން ފެއިލްވެއްޖެ
429	ރޭޓް ލިމިޓް ފަހަނައަޅައި ދިޔައީ
500 ރުފިޔާ	އެތެރޭގެ ސަރވަރ އެރަރ

cURL މިސާލު

curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -u "username:password" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "from": "YourSender",
        "to": "+380XXXXXXXXX",
        "text": "ivr",
        "type": "speechcall",
        "menu": [
          {
            "introUrl": "ivr_XXXXX",
            "idleTimeoutMsec": 10000,
            "dtmfActions": {
              "d1": [
                {
                  "action": "webhook",
                  "url": "https://YourWebhookURL/0",
                  "body": {
                    "confirm": true
                  },
                  "headers": {
                    "test-header": "test"
                  }
                },
                {
                  "action": "hangup"
                }
              ],
              "d2": [
                {
                  "action": "webhook",
                  "url": "https://YourWebhookURL/1",
                  "body": {
                    "confirm": false
                  }
                },
                {
                  "action": "hangup"
                }
              ],
              "wrong": [
                {
                  "action": "gotoMenu",
                  "menu": "1"
                }
              ]
            }
          },
          {
            "introUrl": "ivr_651854",
            "idleTimeoutMsec": 10000,
            "dtmfActions": {
              "d1": [
                {
                  "action": "webhook",
                  "url": "https://YourWebhookURL/0",
                  "body": {
                    "confirm": true
                  }
                },
                {
                  "action": "hangup"
                }
              ],
              "d2": [
                {
                  "action": "webhook",
                  "url": "https://YourWebhookURL/1",
                  "body": {
                    "confirm": false
                  }
                },
                {
                  "action": "hangup"
                }
              ],
              "wrong": [
                {
                  "action": "hangup"
                }
              ]
            }
          }
        ]
      }
    ]
  }'

އެންމެ ރަނގަޅު އުސޫލުތައް

އޯޑިއޯ ފައިލްސް - އިންޓްރޯ ޔޫ.އާރ.އެލް ތަކަށް އެކްސެސިބަލް ކަމާއި އޯޑިއޯ ފައިލްތައް ސަޕޯޓް ކުރެވޭ ފޯމެޓްތަކުގައި ހުރިތޯ ޔަޤީންކުރުން
ވެބްހޫކް ރިލަޔަބިލިޓީ - އަވަހަށް ޖަވާބުދާރީވުމަށް ވެބްހޫކް ޑިޒައިންކުރުން (2 ސިކުންތުގެ ތެރޭގައި)
DTMF އޮޕްޝަންސް - ޔޫޒަރ އެކްސްޕީރިއަންސް ރަނގަޅު ކުރުމަށްޓަކައި މެނޫ އޮޕްޝަންސް 4-6 ޗޮއިސް އަށް ލިމިޓް ކުރުން
ޓައިމްއައުޓް ހެންޑްލިންގ - ކަސްޓަމް އިންއެކްޓިވިޓީ ލިމިޓްތައް ކަނޑައެޅުމަށް idleTimeoutMsec ބޭނުންކުރުން (އެބަހީ 10000 މިލިސެންޓް)، އަދި ގޯސް ޑީޓީއެމްއެފް ކީގެ ދަށުން ގްރޭސްފުލް ފޯލްބެކް ކޮންފިގްރޭޓްކުރުން (މެނޫ ތަކުރާރުކުރުން ނުވަތަ ފޯނު ކަނޑާލުން ފަދަ)
މަލްޓި-މެނޫ ކޯލް ފްލޯ - ޔޫޒަރުން އަނބުރާ ކުރީގެ މެނޫތަކަށް ރޫޓް ކުރާއިރު އިންފިނިޓް ލޫޕްސް ހުއްޓުވުމަށްޓަކައި gotoMenu ފަރުވާތެރިކަމާއެކު ބޭނުންކުރުން
ފޯލްބެކް ސްޓްރެޓެޖީ - ޖަވާބު ނުދޭ ނުވަތަ ގުޅުން ކަނޑާލާ ޔޫޒަރުންނަށް ފޯލްބެކް މެސެޖުތައް ބޭނުންކުރުން

ގުޅުންހުރި މައުޟޫޢުތައް

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

Search Results