База знаний

Контакты

Создание контакта

POST /sms/v1/contacts/save

обязательные поля

    /**
     * 0 - Мужчины
     * 1 - Женщины
     * 2 - Все
     */
    gender - пол
    groupId - идентификатор группы контактов
    phone - телефон получателя

не обязательные поля

    showName - имя для отображения в UI
    firstname - имя
    lastname - фамилия
    patronymic - отчество
    birthday - день рождения, в формате YYYY.MM.DD
    post - должность
    email
    field1 - поле для произвольного значения
    field2 - поле для произвольного значения
    annotation - примечение

Обновление контакта

PUT /sms/v1/contacts/update/<ID>

ID - идентификатор контакта

при обновлении передаются поля, которе необходимо обновить


Получение данных контакта

GET /sms/v1/contacts/getContact/<ID>

ID - идентификатор контакта

в ответе выводится список полей, который перечислен для создания контакта


Получение списка контактов

GET /sms/v1/contacts/getList/<GID>?page=<PAGE_NUM>&limit=<LIMIT>

GID - идентификатор группы контактов
PAGE_NUM - номер страницы, по умолчанию 1
LIMIT - кол-во записей за запрос, максимум 100

ответ

{
    list: [
        {
            _id - идентификатор контакта
            firstname - имя
            lastname - фамилия
            patronymic - отчество
            gender - пол (числовое значение)
            phone - телефон получателя
            showName - имя для отображения
        }
    ],
    total - общее кол-во контактов в группе
}

Удаление контакта

DELETE /sms/v1/contacts/remove/<ID>

ID - идентификатор контакта


Возврат к списку