Получить поля почтового сервиса mailservice.fields

Scope: mailservice

Кто может выполнять метод: любой пользователь

Метод mailservice.fields возвращает локализованные названия полей почтового сервиса.

Параметры метода

Без параметров.

Примеры кода

Как использовать примеры в документации

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/mailservice.fields
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"auth": "**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/mailservice.fields
        
try
        {
        	const response = await $b24.callMethod('mailservice.fields', {});
        	console.log(response.getData().result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call('mailservice.fields', []);
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            'mailservice.fields',
            {},
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call('mailservice.fields', []);
        print_r($result);

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "ID": "ID",
                "SITE_ID": "Сайт",
                "ACTIVE": "Активность",
                "NAME": "Название",
                "SERVER": "Адрес сервера",
                "PORT": "Порт",
                "ENCRYPTION": "Защищенное соединение",
                "LINK": "Адрес веб-интерфейса",
                "ICON": "Логотип",
                "SORT": "Сортировка"
            },
            "time": {
                "start": 1710000500.123,
                "finish": 1710000500.200,
                "duration": 0.077,
                "processing": 0.020,
                "date_start": "2024-03-09T10:08:20+03:00",
                "date_finish": "2024-03-09T10:08:20+03:00",
                "operating_reset_at": 1710003600,
                "operating": 0
            }
        }

Возвращаемые данные

Название
тип

Описание

result
object

Объект с названиями полей. Структура объекта подробно описана ниже

time
time

Информация о времени выполнения запроса

Объект result

Название
тип

Описание

ID
string

Название поля идентификатора

SITE_ID
string

Название поля сайта

ACTIVE
string

Название поля активности

NAME
string

Название поля сервиса

SERVER
string

Название поля адреса сервера

PORT
string

Название поля порта

ENCRYPTION
string

Название поля защищенного подключения

LINK
string

Название поля адреса веб-интерфейса

ICON
string

Название поля логотипа

SORT
string

Название поля сортировки

Обработка ошибок

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Удалить почтовый сервис
Следующая
Обзор методов