Любые вызовы авторизуются с помощью параметра api_key, различающегося для каждой группы функциональности (например, отправка СМС и исходящий звонок будут иметь разные api_key).
Любой вызов может быть сделан как методом GET, так и методом POST, так что два нижеприведенных вызова будут эквиваленты:
curl "https://verifier.team/api/auth/call_in_digits/?api_key=мойключ&phone=79030000000"
curl -X POST "https://verifier.team/api/auth/call_in_digits/" \
-F "api_key=мойключ"
-F "phone=79030000000"
Ответы на запрос всегда возвращаются в формате JSON, при этом корректные запросы содержат поля "ok":1, а некорректные - "error":"описание ошибки", например:
Всегда включают поле "ok":1, остальные поля являются опциональными и зависят от конкретного API-вызова
{
"ok":1,
"fid":"01j1pzq9k0m36y4ta3gxzz2dgp",
"from":"74993212156",
"code":"2156"
}
Всегда включают поле "error":"описание ошибки", остальные поля являются опциональными и зависят от конкретного API-вызова
{
"error":"api key not found"
}
Поле | Тип данных | Обязательный | Описание |
---|---|---|---|
api_key | varchar | да | Авторизационный ключ |
Поле | Тип данных | Обязательный | Описание |
---|---|---|---|
ok | integer | да* | В случае успешного вызова равен 1 |
error | varchar | да* | В случае ошибки вызова содержит описание |