# mailservice.fields

URL: https://chugunov.pro/api-bitrix24/mailservice/mailservice-fields/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить поля почтового сервиса
Scope: `mailservice`
Кто может выполнять метод: любой пользователь

## Описание

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

## Ответ

HTTP-статус: 200

```json
{
    "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`. Объект с названиями полей. Структура объекта подробно описана [ниже](#fields-map)
- `time` `time`. Информация о времени выполнения запроса

## Примеры запроса

### cURL (Webhook)

```bash
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 (OAuth)

```bash
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
```

### JS (TS)

```ts
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type MailserviceFieldsResult = Record<string, string>

try {
  const response = await $b24.actions.v2.call.make<MailserviceFieldsResult>({
    method: 'mailservice.fields',
    params: {},
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Field labels:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getMailserviceFields() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'mailservice.fields',
        params: {},
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Field labels:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getMailserviceFields)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.mailservice.fields().response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call('mailservice.fields', []);

    $result = $response->getResponseData()->getResult();
    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'mailservice.fields',
    {},
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());
        }
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call('mailservice.fields', []);
print_r($result);
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "mailservice.fields", nil, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("mailservice.fields: %w", err)
}

var item struct {
	ID     string `json:"ID"`
	SiteID string `json:"SITE_ID"`
	Active string `json:"ACTIVE"`
	Name   string `json:"NAME"`
	Server string `json:"SERVER"`
	Port   string `json:"PORT"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.SiteID)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/mailservice/mailservice-fields.html