NAV
shell

Начало

Здравствуйте! Добро пожаловать на страницу документации API проекта verificate.ru! Используя наш API вы можете отправлять смс и звонки, получать их статусы и уведомления о текущем состоянии ресурсов.

Описание

Для авторизации используйте следующий код:

curl "api_endpoint"
  -H "Token: personal_token"

Обязательно замените personal_token на ваш личный токен.

Для доступа к ресурсам API вам необходим токен. Токен это обычная строка-ключ, который выдается пользователю при регистрации и открывает ему доступ к функционалу нашего API. Получить токен вы можете после успешной регистрации на странице личного кабинета.

Полученный ключ можно использовать передав HTTP заголовок с именем token, либо добавив в тело запроса поле token.

Звонок

Создание звонка

curl "http://verificate.ru/api/v1/calls"
  -H "token: 37a6259cc0c1dae299a7866489dff0bd"
  -d '{"recipient":"+89031234567","content":"Тестовый звонок"}'

Запрос возвращает следующую JSON структуру:

{
  "id": 1,
  "recipient": "+89031234567",
  "content": "Тестовый звонок",
  "status": "pending"
}

Эта точка позволяет создать и отправить звонок на номер пользователя.

HTTP запрос

POST http://verificate.ru/api/v1/calls

Параметры JSON тела запроса

Параметр Описание
recipient Номер на который направлен звонок (Номер необходимо указать в международном формате согласно рекомендации E.164)
content Содержание звонка

Звонок по id записи

curl "http://verificate.ru/api/v1/calls/1"
  -H "token: 37a6259cc0c1dae299a7866489dff0bd"

Запрос возвращает следующую JSON структуру:

{
  "id": 1,
  "recipient": "+89031234567",
  "content": "Тестовый звонок",
  "status": "pending"
}

Эта точка позволяет получить информацию о ресурсе по его id.

HTTP запрос

GET http://verificate.ru/api/v1/calls/<id>

Параметры запроса

Параметр Описание
id id смс сообщения

Список звонков

curl "http://verificate.ru/api/v1/calls"
  -H "token: 37a6259cc0c1dae299a7866489dff0bd"

Запрос возвращает следующую JSON структуру:

{
  "data": [
    {
      "id": 15,
      "recipient": "+89037654321",
      "content": "Тестовый звонок",
      "status": "pending"
    },
    {
      "id": 14,
      "recipient": "+31415926534",
      "content": "bazinga",
      "status": "pending"
    },
    ...
    {
      "id": 7,
      "recipient": "+1234567890",
      "content": "Был яркий холодный апрельский день, часы били тринадцать.",
      "status": "created"
    },
    {
      "id": 6,
      "recipient": "+89037654321",
      "content": "Привет мир"
    }
  ],
  "meta": {
    "pagination": {
      "total": 15,
      "count": 10,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 2,
      "links": {
        "next": "http://verificate.ru/api/v1/calls?page=2"
      }
    }
  }
}

Эта точка позволяет получить информацию о всех ресурсах, на странице.

HTTP запрос

GET http://verificate.ru/api/v1/calls

Параметры запроса

Имя параметра Значение по-умолчанию Описание
page 1 Текущая страница

Смс сообщение

Создание смс

curl "http://verificate.ru/api/v1/sms"
  -H "token: 37a6259cc0c1dae299a7866489dff0bd"
  -d '{"recipient":"+89031234567","content":"Тестовое сообщение"}'

Запрос возвращает следующую JSON структуру:

{
  "id": 1,
  "recipient": "+89031234567",
  "content": "Тестовое сообщение",
  "status": "pending"
}

Эта точка позволяет создать и отправить смс сообщение.

HTTP запрос

POST http://verificate.ru/api/v1/sms

Параметры JSON тела запроса

Параметр Описание
recipient Номер куда будет направлено сообщение(Номер необходимо указать в международном формате согласно рекомендации E.164)
content Тело смс сообщения

Смс по id записи

curl "http://verificate.ru/api/v1/sms/1"
  -H "token: 37a6259cc0c1dae299a7866489dff0bd"

Запрос возвращает следующую JSON структуру:

{
  "id": 1,
  "recipient": "+89031234567",
  "content": "Тестовое сообщение",
  "status": "pending"
}

Эта точка позволяет получить информацию о ресурсе по его id.

HTTP запрос

GET http://verificate.ru/api/v1/sms/<id>

Параметры запроса

Параметр Описание
id id смс сообщения

Список смс сообщений

curl "http://verificate.ru/api/v1/sms"
  -H "token: 37a6259cc0c1dae299a7866489dff0bd"

Запрос возвращает следующую JSON структуру:

{
  "data": [
    {
      "id": 15,
      "recipient": "+89037654321",
      "content": "Тестовый звонок",
      "status": "pending"
    },
    {
      "id": 14,
      "recipient": "+31415926534",
      "content": "bazinga",
      "status": "pending"
    },
    ...
    {
      "id": 7,
      "recipient": "+1234567890",
      "content": "Был яркий холодный апрельский день, часы били тринадцать.",
      "status": "created"
    },
    {
      "id": 6,
      "recipient": "+89037654321",
      "content": "Привет мир"
    }
  ],
  "meta": {
    "pagination": {
      "total": 15,
      "count": 10,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 2,
      "links": {
        "next": "http://verificate.ru/api/v1/sms?page=2"
      }
    }
  }
}

Эта точка позволяет получить информацию о всех ресурсах, на странице.

HTTP запрос

GET http://verificate.ru/api/v1/sms

Параметры запроса

Имя параметра Значение по-умолчанию Описание
page 1 Текущая страница

Ошибки и коды ответов

В случае когда ваш запрос не может быть выполнен, ответ API содержит сообщение ошибки.

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

{
  "error_message": "значение ошибки"
}
HTTP код Значение
400 Данный запрос не может быть выполнен
401 Неверный авторизационный токен
404 Запрошенный вами ресурс отсутствует
shell