Документация YeSMS

Оформление

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

phonebook-create · POST /api/json/2020-01-01 · Все действия

Справочник доступен во всех проектах пользователя. Дополнительные поля записи не принимаются. Поля имени, даты и пола необязательны. JSON API принимает записи в JSON; загрузка CSV относится к кабинету.

Запрос ​

ПолеТипОбязательноПравило
namestringДаНазвание: 1–50 символов после trim; уникально у пользователя.
entriesarray<object>ДаОт 1 до 500000 записей; общая граница тела запроса — 2 МиБ.
entries[].phonestringДаЗнак + и 9–15 цифр. Дубликат номера отклоняет весь запрос.
entries[].last_namestringНетФамилия: 1–50 символов после trim.
entries[].first_namestringНетИмя: 1–50 символов после trim.
entries[].middle_namestringНетОтчество: 1–50 символов после trim.
entries[].birthdaystringНетРеальная календарная дата YYYY-MM-DD, год 1900–2100.
entries[].genderstringНетmale или female.

Иллюстративный запрос (ключ и ID замените собственными):

json
{
  "api_key": "00000000-0000-0000-0000-000000000001",
  "action": "phonebook-create",
  "data": {
    "name": "Клиенты",
    "entries": [
      {
        "phone": "+79401234567",
        "first_name": "Иван",
        "birthday": "1970-01-31",
        "gender": "male"
      },
      {
        "phone": "+79409876543",
        "first_name": "Анна"
      }
    ]
  }
}

Результат ​

data — объект; поля описаны в общем контракте результатов.

json
{
  "success": true,
  "data": {
    "id": "000000000000000000000003",
    "created": "2026-10-11T12:00:00+00:00",
    "updated": "2026-10-11T12:00:00+00:00",
    "name": "Клиенты",
    "num": 2
  }
}

Отказы ​

Общие ошибки запроса и доступа применяются ко всем действиям. Неизвестные поля отклоняются; проверяйте success даже при HTTP 200.

КодПричина
PHONEBOOK-CREATE-ENTRIES-INVALID-RANGEСлишком много записей в списке получателей
PHONEBOOK-CREATE-ENTRIES-INVALID-TYPEЗаписи имееют недопустимый тип значения
PHONEBOOK-CREATE-ENTRIES-REQUIREDЗаписи не указаны
PHONEBOOK-CREATE-ENTRY-BIRTHDAY-INVALID-FORMATДень рождения имеет недопустимый формат
PHONEBOOK-CREATE-ENTRY-BIRTHDAY-INVALID-TYPEДень рождения имеет недопустимый тип значения
PHONEBOOK-CREATE-ENTRY-FIRST-NAME-INVALID-FORMATИмя имеет недопустимый формат
PHONEBOOK-CREATE-ENTRY-FIRST-NAME-INVALID-TYPEИмя имеет недопустимый тип значения
PHONEBOOK-CREATE-ENTRY-GENDER-INVALID-TYPEПол имеет недопустимый тип значения
PHONEBOOK-CREATE-ENTRY-GENDER-NOT-SUPPORTEDПол имеет недопустимое значение
PHONEBOOK-CREATE-ENTRY-INVALID-FORMATЗапись имеет недопустимый формат
PHONEBOOK-CREATE-ENTRY-INVALID-TYPEЗапись имеет недопустимый тип значения
PHONEBOOK-CREATE-ENTRY-LAST-NAME-INVALID-FORMATФамилия имеет недопустимый формат
PHONEBOOK-CREATE-ENTRY-LAST-NAME-INVALID-TYPEФамилия имеет недопустимый тип значения
PHONEBOOK-CREATE-ENTRY-MIDDLE-NAME-INVALID-FORMATОтчество имеет недопустимый формат
PHONEBOOK-CREATE-ENTRY-MIDDLE-NAME-INVALID-TYPEОтчество имеет недопустимый тип значения
PHONEBOOK-CREATE-ENTRY-PHONE-DUPLICATEНомер телефона уже существует
PHONEBOOK-CREATE-ENTRY-PHONE-INVALID-FORMATНомер телефона имеет недопустимый формат
PHONEBOOK-CREATE-ENTRY-PHONE-INVALID-TYPEНомер телефона имеет недопустимый тип значения
PHONEBOOK-CREATE-ENTRY-PHONE-REQUIREDНомер телефона не указан
PHONEBOOK-CREATE-NAME-EXISTSЗапись с таким названием уже существует
PHONEBOOK-CREATE-NAME-INVALID-FORMATНазвание имеет недопустимый формат
PHONEBOOK-CREATE-NAME-INVALID-TYPEНазвание имеет недопустимый тип значения
PHONEBOOK-CREATE-NAME-REQUIREDНазвание не указано