وثائق واجهة برمجة التطبيقات

For authorization, pass Bearer Token in the headers

Headers

KeyValue
Authorization: BearerApi token

Endpoint: https://reg-sms.org/resellers/v1/user/balance

Response

{
  "balance": 102
}

Error Statuses

{
  "message": "Unauthenticated."
}

Endpoint: https://reg-sms.org/resellers/v1/providers

Response

{
  "data": [
    {
      "id": 1,
      "active": true
    }
  ]
}

Endpoint: https://reg-sms.org/resellers/v1/countries

Response

{
  "data": [
    {
      "id": 1,
      "slug": "nepal",
      "title": "Nepal",
      "code": "np"
    }
  ]
}

Endpoint: https://reg-sms.org/resellers/v1/services

Response

{
  "data": [
    {
      "id": 1,
      "slug": "budweiser",
      "title": "Budweiser",
      "code": "zt",
      "icon": "https://reg-sms.org/resellers/v1/storage/images/SocialImage-8f5d2055-ff6b-43a3-a3c8-54d0e9d02623.webp"
    },
    {
      "id": 2,
      "slug": "hinge-dating",
      "title": "Hinge Dating",
      "code": "aii",
      "icon": "https://reg-sms.org/resellers/v1/storage/images/SocialImage-fa9c8ae9-9e51-4d5c-be4e-4a0f213cbe70.webp"
    }
  ]
}

Endpoint: https://reg-sms.org/resellers/v1/service/countries

Parameters

KeyValue
service_idrequired
country_slugoptional
country_titleoptional

Response

{
"data": {
  "id": 567,
  "slug": "facebook",
  "title": "Facebook",
  "code": "fb",
  "icon": "https://reg-sms.org/resellers/v1/storage/images/SocialImage-f3e71be7-a446-4143-adb4-b22834a8cfd4.webp"
},
"countries": [
    {
      "id": 88,
      "slug": "russia",
      "title": "Russia",
      "code": "ru",
      "price": "3.00",
      "quantity": 22824
    },
    {
      "id": 119,
      "slug": "canada",
      "title": "Canada",
      "code": "ca",
      "price": "7.47",
      "quantity": 52865
    }
  ]
}

Endpoint: https://reg-sms.org/resellers/v1/number/buy

Parameters

KeyValue
provider_idrequired
service_idrequired
country_idsometimes
refsometimes (referral or soft ID)

Response

{
  {
  "message": "Success",
  "status": "SUCCESS",
    "data": {
      "id": 6,
      "number": "79910674053"
    }
}

Error Statuses

{
  "message": "No numbers available for this country.",
  "status": "NO_NUMBERS"
}
{
  "message": "Provider not found!",
  "status": "PROVIDER_NOT_FOUND"
}
{
  "message": "Purchase of a number is temporarily suspended!",
  "status": "TEMPORARILY_SUSPENDED"
}
{
  "message": "The service id field is required.",
  "errors": {
    "service_id": [
      "The service id field is required."
    ]
  }
}

Endpoint: https://reg-sms.org/resellers/v1/number/status

Parameters

KeyValue
number_idrequired

Response

{
  "status": "waiting"
}
{
  "status": "waiting_resend",
  "message":"11111" (is last message)
}
{
  "status": "cancelled"
}
{
  "status": "activated",
  "message":"22222"
}
{
  "status": "bad_status"
}

Error Statuses

{
  "message": "The number id field is required.",
    "errors": {
      "number_id": [
          "The number id field is required."
      ]
    }
}

Endpoint: https://reg-sms.org/resellers/v1/number/messages

Parameters

KeyValue
number_idrequired

Response

{
  "id": 32,
  "message": "Your verification code is 664214"
  "code": 664214
}

Error Statuses

{
  "message": "The number id field is required.",
    "errors": {
      "number_id": [
          "The number id field is required."
      ]
    }
}

Endpoint: https://reg-sms.org/resellers/v1/number/resend

Parameters

KeyValue
number_idrequired

Response

{
  "data": [
    "status": "waiting_resend",
    "number": {
       "id": 1,
       "number": 15197553123,
       "price": 19.5,
       "status": waiting,
       "time": 2024-06-29 22:24:45
    }
  ]
}

Error Statuses

{
  "success": false,
  "message":"Failed to send repeat SMS!"
}
{
  "message": "The number id field is required.",
    "errors": {
      "number_id": [
          "The number id field is required."
      ]
    }
}

Endpoint: https://reg-sms.org/resellers/v1/number/return

Parameters

KeyValue
number_idrequired

Response

{
  "data": [
    "status": "cancelled",
    "number": {
       "id": 1,
       "number": 15197553123,
       "price": 19.5,
       "status": waiting,
       "time": 2024-06-29 22:24:45
    }
  ]
}

Error Statuses

{
  "success": false,
  "message": EARLY_CANCEL_DENIED
}
{
  "success": false,
  "message":"Number is not returned!"
}
{
  "message": "The number id field is required.",
    "errors": {
      "number_id": [
          "The number id field is required."
      ]
    }
}

Endpoint: https://reg-sms.org/resellers/v1/number/confirm

Parameters

KeyValue
number_idrequired

Response

{
  "data": [
    "status": "activated",
    "number": {
       "id": 1,
       "number": 15197553123,
       "price": 19.5,
       "status": waiting,
       "time": 2024-06-29 22:24:45
    }
  ]
}

Error Statuses

{
  "success": false,
  "message":"Failed to confirm SMS!"
}
{
  "message": "The number id field is required.",
    "errors": {
      "number_id": [
          "The number id field is required."
      ]
    }
}
Telegram