Свернуть содержание

API —  это протокол взаимодействия между вашим ПО и нашим сервером активаций. API нужен для автоматизации процесса получение смс сообщений на вашей стороне

Наше API совместимо с API sms-activate

Во всех запросах должен присутствовать API ключ в виде параметра api_key

API активаций
Запрос номера
https://api.7grizzlysms.com/stubs/handler_api.php?api_key=$api_key&action=getNumber&service=$service&country=$country

&action=getNumber
$api_key — ваш API-ключ (см. раздел Настройки в Личном кабинете)
$service — код сервиса. См. раздел «Коды сервисов»
$country — код страны. См. раздел «Коды стран»
Если не указано, то по умолчанию будет выбран номер России.

Возможные ошибки
BAD_KEY — неверный API-ключ
NO_NUMBERS — нет номеров
номер не выдан — повторите запрос или выберите другую страну

Пример успешного ответа:

ACCESS_NUMBER:38496653:66846426435

Где 38496653 — это id активации, а 66846426435 — номер телефона

API активаций
Изменения статуса активации

https://api.7grizzlysms.com/stubs/handler_api.php?api_key=$api_key&action=setStatus&status=$status&id=$id

&action=setStatus
$api_key — ваш API-ключ (см. раздел Настройки в Личном кабинете)
$id — id активации
$status — статус активации
-1 — отменить активацию;
1 — сообщить о готовности номера (смс на номер отправлено);
3 — сообщить об ожидании нового кода на тот же номер;
6 — завершить активацию;
8 — отменить активацию.

Возможные ошибки
ACCESS_READY — готовность номера подтверждена
ACCESS_RETRY_GET — ожидание нового смс
ACCESS_ACTIVATION — сервис успешно активирован
ACCESS_CANCEL — активация отменена

Возможные ошибки
ERROR_SQL — ошибка SQL-сервера
NO_ACTIVATION — id активации не существует
BAD_SERVICE — некорректное наименование сервиса
BAD_STATUS — некорректный статус
BAD_KEY — Неверный API-ключ
BAD_ACTION — некорректное действие

API активаций
Получить код или статус активации

https://api.7grizzlysms.com/stubs/handler_api.php?api_key=$api_key&action=getStatus&id=$id

&action = getStatus
$api_key — ваш API-ключ (см. раздел Настройки в Личном кабинете)
$id — id активации

Ответы сервиса:
STATUS_WAIT_CODE — ожидание смс
STATUS_WAIT_RETRY:$lastcode — ожидание уточнения кода (где $lastcode - прошлый, неподошедший код)
STATUS_WAIT_RESEND — ожидание повторной отправки смс (софт должен нажать повторно выслать смс и выполнить изменение статуса на 6)
STATUS_CANCEL — активация отменена
STATUS_OK:$code — код получен (где $code — код активации)

Возможные ошибки:
NO_ACTIVATION — id активации не существует
BAD_KEY — Неверный API-ключ
BAD_ACTION — некорректное действие

API активаций
Запрос баланса
https://api.7grizzlysms.com/stubs/handler_api.php?api_key=$api_key&action=getBalance

&action=getBalance
$api_key — ваш API-ключ (см. раздел Настройки в Личном кабинете).

Ответ сервиса

ACCESS_BALANCE:$balance

Возможная ошибка

BAD_KEY — Неверный API-ключ
API активаций
Получить актуальные цены по странам
https://api.7grizzlysms.com/stubs/handler_api.php?api_key=$api_key&action=getPrices&service=$service&country=$country

&action=getPrices
$api_key — ваш API-ключ (см. раздел Настройки в Личном кабинете);
$service — код сервиса. См. раздел «Коды сервисов»;
$country — код страны. Если не указано, то по умолчанию будет выбран номер России. См. раздел «Коды стран».

Ответы сервиса в формате

{
  "Страна": {
    "Сервис": {
      "cost": Стоимость,
      "count": Количество
    }
  }
}
API аренды
Запрос номера в аренду
https://api.7grizzlysms.com/stubs/handler_api.php?api_key=$api_key&action=getRentNumber&service=$service&country=$country&rent_time=$time

$api_key - ваш API-ключ (см. раздел Настройки в Личном кабинете);
$service – код сервиса (см. раздел “Коды сервисов”);
$country – код страны. Если не указано, то по умолчанию будет выбран номер России (см. раздел “Коды стран”);
$time - время аренды часах (минимум 4 часа).

Ответ сервиса будет в json формате

{
  "status": "статус",
  "phone": {
    "id": ”id аренды”,
    “endDate”: ”дата завершения аренды”,
    “number”:”номер телефона”
  }
}

Пример успешного ответа

{
  "status": "success",
  "phone": {
    "id": ”38496653”,
    “endDate”: ”2023-12-31T19:30:52”,
    “number”: ”66846426435”
  }
}

Пример ответа с ошибкой:

{
  "status": "error",
  "error": "BAD_KEY"
}

Возможные ошибки
BAD_KEY – некорректный API-ключ;
BAD_COUNTRY – некорректный код страны;
BAD_SERVICE – некорректный код сервиса;
INVALID_TIME – некорректное количество часов;
NO_BALANCE – недостаточно денежных средств на счету;
NO_NUMBERS – нет номеров; номер не выдан – повторите запрос или выберите другую страну;
SERVER_ERROR – ошибка сервера, повторите запрос позже.

API аренды
Продлить аренду
https://api.7grizzlysms.com/stubs/handler_api.php?api_key=$api_key&action=continueRentNumber&id=$id&rent_time=$time

$api_key - ваш API-ключ (см. раздел Настройки в Личном кабинете);
$time - время аренды часах (минимум 4 часа).

Ответ сервиса будет в json формате

{
  "status": "статус",
  "phone": {
    "id": ”id аренды”,
    “endDate”: ”дата завершения аренды”,
    “number”: ”номер телефона”
  }
}

Пример успешного ответа

{
  "status": "success",
  "phone": {
    "id": ”38496653”,
    “endDate”: ”2023-12-31T19:30:52”,
    “number”: ”66846426435”
  }
}

Пример ответа с ошибкой:

{
  "status": "error",
  "error":"BAD_KEY"
}

Возможные ошибки
BAD_KEY – некорректный API-ключ;
INVALID_TIME – некорректное количество часов;
NO_ID_RENT – некорректный id аренды;
NO_BALANCE – недостаточно денежных средств на счету;
RENT_DIE – данный номер больше недоступен, выберите новый номер;
SERVER_ERROR – ошибка сервера, повторите запрос позже.

API аренды
История аренды
https://api.7grizzlysms.com/stubs/handler_api.php?api_key=$api_key&action=getRentHistory&id=$id

$api_key – ваш API-ключ (см. раздел Настройки в Личном кабинете);
$id – id аренды.

Ответ сервиса будет в json формате:

{
  "status": "статус",
  "quantity": "количество раз аренды",
  "values": {
    “1”: {
      “date”: ”дата начала аренды”,
      “price”: стоимостьАренды,
      “hours”:длительностьАренды
    }
  }

Пример успешного ответа:

{
  "status": "success",
  "quantity": ”2”,
  "values": {
    “1”: {
      “date”: ”2023-10-26 11:03:39”,
      “price”: 3.6,
      “hours”: 4
    },
    “2”: {
      “date”:” 2023-10-25 11:02:31”,
      “price”: 4,
      “hours”: 5
    }
  }
}

Пример успешного ответа с пустым количеством:

{
  "status": "success",
  "values": {}
}

Пример ответа с ошибкой:

{
  "status": "error",
  "error": "SQL_ERROR"
}

Возможные ошибки:
BAD_KEY – некорректный API-ключ;
NO_ID_RENT – некорректный id аренды;
SQL_ERROR – SQL ошибка сервера, повторите запрос позже.

API аренды
Изменение статуса аренды
https://api.7grizzlysms.com/stubs/handler_api.php?api_key=$api_key&action=setRentStatus&id=$id&status=$status

$api_key – ваш API-ключ (см. раздел Настройки в Личном кабинете);
$id – id аренды;
$status – статус аренды:
1– завершить аренду;
2 – отменить аренду.

Ответ сервиса будет в json формате:

{
  "status": "статус"
}

Пример успешного ответа:

{
  "status": "success"
}

Пример ответа с ошибкой:

{
  "status": "error",
  "error": "CANT_CANCEL"
}

Возможные ошибки:
BAD_KEY – некорректный API-ключ;
NO_ID_RENT – некорректный id аренды;
INVALID_PHONE – id аренды не существует;
INCORECT_STATUS – некорректный статус аренды;
ALREADY_FINISH – аренда уже завершена;
ALREADY_CANCEL – аренда уже отменена;
CANT_CANCEL – невозможно отменить (получено СМС или прошло 20 минут);
SQL_ERROR – SQL ошибка сервера, повторите запрос позже;
SERVER_ERROR – ошибка сервера, повторите запрос позже.

API аренды
Получить список кодов или статус аренды
https://api.7grizzlysms.com/stubs/handler_api.php?api_key=$api_key&action=getRentStatus&id=$id

$api_key – ваш API-ключ (см. раздел Настройки в Личном кабинете);
$id – id аренды.

Ответ сервиса будет в json формате:

{
  "status": "статус",
  "quantity": "количество кодов",
  "values": {
     "0": {
       "phoneFrom": "номер телефона",
       "service": "код сервиса",
       "text": "код смс",
       "date": "дата получения смс"
    }
  }
}

Пример успешного ответа:

{
  "status": "success",
  "quantity": "2 ",
  "values": {
    "0 ": {
      "phoneFrom": "66846426435",
      "service": "tg",
      "test": "123456",
      "date": "2023-10-26 11:03:39"
    },
    "1": {
      "phoneFrom ": "66846426435",
      "service": "tg",
      "test": "224444",
      "date": "2023-10-26 11:02:31"
    }
  }
}

Пример успешного ответа с пустым список кодов:

{
  "status": "success",
  "values":{}
}

Пример ответа с ошибкой:

{
  "status": "error",
  "error": "NO_ID_RENT"
}

Возможные ошибки:
BAD_KEY – некорректный API-ключ;
NO_ID_RENT – некорректный id аренды;
INVALID_PHONE – id аренды не существует;
SERVER_ERROR – ошибка сервера, повторите запрос позже.

API аренды
Получить актуальные цены аренды по странам
https://api.7grizzlysms.com/stubs/handler_api.php?api_key=$api_key&action=getRentPrices&service=$service&country=$country&rent_time=$time

$api_key – ваш API-ключ (см. раздел Настройки в Личном кабинете);
$service – код сервиса (см. раздел “Коды сервисов”);
$country – код страны. Если не указано, то по умолчанию будет выбран номер России (см. раздел “Коды стран”);
$time - время аренды часах (минимум 4 часа).

Ответ сервиса будет в json формате:

{
  "status": "статус",
  "values": {
    "Страна": {
      "Сервис": {
        "cost": Стоимость,
        "count": Количество,
        "max_hours": МаксимальноеЧасовАренды
      }
    }
  }
}

Пример успешного ответа:

{
  "status": "success",
  "values": {
    "0": {
      "tg": {
        "cost": 12,
        "max_hours": 10,
        "count": 15
      }
    }
  }
}

Пример ответа с ошибкой:

{
  "status": "error",
  "error": "INVALID_TIME"
}

Возможные ошибки:
BAD_KEY – некорректный API-ключ;
BAD_COUNTRY – некорректный код страны;
BAD_SERVICE – некорректный код сервиса;
INVALID_TIME – некорректное количество часов;
NO_NUMBERS – нет номеров; номер не выдан – повторите запрос или выберите другую страну;
SERVER_ERROR – ошибка сервера, повторите запрос позже.