Создание телефонного справочника

Метод phonebook-create предназначен для создания телефонного справочника, который в дальнейшем может применяться для создания массовых рассылок.

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

Параметр	Тип	Обязательный	Описание
name	string	Да	Название справочника
entries	array	Да	Массив записей справочника
entries.*.phone	string	Да	Номер телефона в международном формате
entries.*.last_name	string	Нет	Фамилия абонента
entries.*.first_name	string	Нет	Имя абонента
entries.*.middle_name	string	Нет	Отчество абонента
entries.*.birthday	string	Нет	Дата рождения абонента в формате 1970-01-31
entries.*.gender	string	Нет	Пол абонента. Допустимые значения: male female

Формат записи справочника

{
    "phone": string,
    "last_name": string,
    "first_name": string,
    "middle_name": string,
    "birthday": string,
    "gender": "male|female"
}

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

{
    "api_key": "541eab8c-3e2f-5c47-3278-37206b391dd0",
    "action": "phonebook-create",
    "data": {
        "name": "Клиенты",
        "entries": [
            {
                "phone": "+79401234567",
            },
            {
                "phone": "+79409876543",
                "last_name": "Иванов",
                "first_name": "Иван",
                "middle-name": "Иванович",
                "birthday": "1970-01-31",
                "gender": "male"
            }
        ]
    }
}

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

Параметр	Тип	Описание
id	string	Идентификатор справочника
created	datetime	Дата и время создания в формате ISO 8601
updated	datetime	Дата и время обновления в формате ISO 8601
name	string	Название справочника
num	integer	Количество записей в справочнике

Пример ответа

{
    "success": true,
    "data": {
        "id": "5d59b4c6-19b6-47b4-ba19-0a25ab599f80",
        "created": "2024-01-31T12:41:28+03:00",
        "updated": "2024-01-31T12:41:28+03:00",
        "name": "Клиенты",
        "num": 2
    }
}

Возможные ошибки

Ошибка	Описание
PHONEBOOK-CREATE-NAME-REQUIRED	Не указан параметр name
PHONEBOOK-CREATE-NAME-INVALID-TYPE	Параметр name имеет недопустимый тип
PHONEBOOK-CREATE-NAME-INVALID-FORMAT	Параметр name не соответствует формату
PHONEBOOK-CREATE-NAME-EXISTS	Справочник с таким названием уже существует
PHONEBOOK-CREATE-ENTRIES-REQUIRED	Не указан параметр entries
PHONEBOOK-CREATE-ENTRIES-INVALID-TYPE	Параметр entries имеет недопустимый тип
PHONEBOOK-CREATE-ENTRY-INVALID-TYPE	Элемент параметра entries имеет недопустимый тип
PHONEBOOK-CREATE-ENTRY-INVALID-FORMAT	Элемент параметра entries не соответствует формату
PHONEBOOK-CREATE-ENTRY-PHONE-REQUIRED	Не указан параметр phone
PHONEBOOK-CREATE-ENTRY-PHONE-INVALID-TYPE	Параметр phone имеет недопустимый тип
PHONEBOOK-CREATE-ENTRY-PHONE-INVALID-FORMAT	Параметр phone не соответствует формату
PHONEBOOK-CREATE-ENTRY-LAST-NAME-INVALID-TYPE	Параметр last_name имеет недопустимый тип
PHONEBOOK-CREATE-ENTRY-LAST-NAME-INVALID-FORMAT	Параметр last_name не соответствует формату
PHONEBOOK-CREATE-ENTRY-FIRST-NAME-INVALID-TYPE	Параметр first_name имеет недопустимый тип
PHONEBOOK-CREATE-ENTRY-FIRST-NAME-INVALID-FORMAT	Параметр first_name не соответствует формату
PHONEBOOK-CREATE-ENTRY-MIDDLE-NAME-INVALID-TYPE	Параметр middle_name имеет недопустимый тип
PHONEBOOK-CREATE-ENTRY-MIDDLE-NAME-INVALID-FORMAT	Параметр middle_name не соответствует формату
PHONEBOOK-CREATE-ENTRY-BIRTHDAY-INVALID-TYPE	Параметр birthday имеет недопустимый тип
PHONEBOOK-CREATE-ENTRY-BIRTHDAY-INVALID-FORMAT	Параметр birthday не соответствует формату
PHONEBOOK-CREATE-ENTRY-GENDER-INVALID-TYPE	Параметр gender имеет недопустимый тип
PHONEBOOK-CREATE-ENTRY-GENDER-NOT-SUPPORTED	Параметр gender имеет недопустимое значение