Метод GetInfo
Примените этот метод для получения информации об услуге обратного звонка в приложении. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.
Точка подключения:
POST: https://api.exolve.ru/callback/v1/GetInfo
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
| Имя | Тип | Описание |
|---|---|---|
| Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
| Параметр | Тип | Описание |
|---|---|---|
| callback_resource_id | uint64 | уникальный идентификатор ресурса обратного звонка |
Выходные параметры
| Параметр | Тип | Описание |
|---|---|---|
| callback_resource_id | string | уникальный идентификатор ресурса обратного звонка |
| callback_name | string | наименование ресурса обратного звонка |
| description | string | описание ресурса обратного звонка |
| created_at | string | дата создания ресурса обратного звонка в формате RFC-3339 / ISO-8601 |
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 401 | Unauthorized | malformed token | не указан / не правильно указан API-ключ приложения |
| 403 | Forbidden | customer not active | нет доступа к услуге обратного звонка из-за статуса аккаунта пользователя (не активирован/заблокирован) |
| 400 | Bad Request | proto: (line 3:20): invalid value for string type: 1 | невалидный запрос |
| 504 | Gateway Timeout | нет ответа от внутренних систем Exolve |
Примеры
Входные параметры:
{
"callback_resource_id": 138873
}
Выходные параметры:
{
"callback": {
"callback_resource_id": "138873",
"callback_name": "Наименование",
"description": "Описание",
"created_at": "2023-03-12T12:20:41.112301Z"
}
}