API — документация для разработчиков

Чтобы вы могли из своей системы (сайта, интернет-магазина, CRM, 1С, мобильного приложения) полностью управлять своими контактами, совершать одиночные и массовые рассылки СМС и Email, Арамба предоставляет доступ практически ко всем своим функциям через RESTful API (обмен данными в JSON-формате через защищенный протокол HTTPS).

Скачать PHP класс

Оглавление

Авторизация

Для того, чтобы вызвать любую функцию API Арамбы, вам необходимо сформировать GET/POST/PUT/DELETE запрос, обязательно используя полученный в личном кабинете API-ключ (раздел Профиль).
API-ключ можно передавать тремя разными способами:

  1. С помощью HTTP-заголовка Authorization (предпочтительный способ). Для этого в набор HTTP-заголовков запроса вам необходимо добавить

    Authorization: ApiKey xxx-xxxxxxxxxxxxxxx, где xxx-xxxxxxxxxxxxxxx — ваш API-ключ

  2. Передать как один из параметров в строке запроса. Например, если вам необходимо получить текущий баланс, то вам необходимо выполнить следующие GET-запрос:

    https://api.aramba.ru/balance?apiKey=xxx-xxxxxxxxxxxxxxx, где xxx-xxxxxxxxxxxxxxx — ваш API-ключ

  3. Передать как один из параметров в POST-запросе в виде
    {"apiKey" : "xxx-xxxxxxxxxxxxxxx" }, где xxx-xxxxxxxxxxxxxxx - ваш API-ключ

Формат передачи данных

  • используется кодировка UTF-8
  • в методах POST и PUT данные передаются в теле запроса как JSON-объект, т.е. в виде
    { "data1" : 123, "data2" : "data3" }
  • в запросах необходимо добавлять HTTP-заголовки Accept: application/json и Content-Type: application/json
  • все значения даты-времени указываются в формате RFC3339, например 2013-04-12T23:20:50.52Z

Возможные ответы от сервера

В случае успешного выполнения функции в ответ будет возвращен HTTP-код 200 (OK) или 201 (Created). Если запрос по каким-либо причинам не удалось выполнить, то API может вернуть следующие HTTP-коды:

  • 400 (Bad Request) — не верно сформированный запрос, обычно эта ошибка связана с опечатками в запрос, неверными идентификаторами и т.п.;
  • 401 (Unauthorized) — в запросе не был указан API-ключ;
  • 402 (Payment Required) — для выполнения запрос недостаточно средств на балансе, например для запуска СМС рассылки;
  • 403 (Forbidden) — доступ к выполнению той или иной функции запрещён (для указанного API-ключа);
  • 404 (Not Found) — указанный объект (например, СМС или email рассылка, контакт и т.п.) не найден, обычно это связано с тем, что был указан неверный идентификатор;
  • 409 (Conflict) — такой объект, например имя отправителя или субаккаунт с аналогичным логином, уже существует в Арамбе и новый не может быть добавлен;
  • 500 (Internal Server Error) — произошла ошибка на сервер по независящим от пользователя причинам, если в течении долгого времени ошибка не проходит, то мы рекомендуем обратиться в нашу службу поддержки.

В теле ответа, помимо HTTP-кода будет указана более подробная причина ошибки.

В случае получения HTTP-кода 201 (Created), например при создании контактной группы или новой рассылки, в полученном ответе в HTTP-заголовке Location будет указана ссылка на созданный объект. Выполнив GET-запрос по этому адресу можно будет получить подробную информацию о созданном объекте.

Список методов

  1. POST: /autoSmsSendings

    Создать новую автоматическую СМС рассылку

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

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

    Параметр Описание Тип
    ContactGroupId Идентификатор группы контактов, по которой будет проводиться автоматическая СМС рассылка. Его можно получить с помощью метода GET: /contactGroups string
    FilterId Идентификатор сохраненного в группе фильтра по контактам. Если не указан, рассылка будет производиться по всем контактам группы.
    Его можно получить с помощью метода GET: /contactGroups    		 string
    Event Название колонки, которая будет являться событием, по которому будет проводиться автоматическая СМС рассылка.
    Список все колонок можно получить с помощью метода GET: /contactGroups/{id}/columns    		 string
    SendTime Время отправки СМС timespan
    SendType Направление смещения времени отправки СМС сообщений enum — JustInTime, Before, After
    SmsSenderId Имя отправителя СМС. Доступные имена отправителя можно получить с помощью метода GET: /smsSenderIds string
    SmsTemplate Шаблон (текст) СМС string
    AlternativeSmsTemplate Альтернативный шаблон (текст) string
    LocalTimeZone Часовой пояс, по которому будет проводиться СМС рассылка enum — MSK, YEKT, OMST, KRAT, IRKT, YAKT, VLAT, MAGT, UZS
    UseRecepientTimeZone True — если следует отправлять СМС по местному времени абонента boolean
    MustTransliterate True — если необходимо транслитерировать текст СМС перед отправкой boolean
    SendTimeOffset Количество дней, недель или месяцев, на которое надо смещать время отправки СМС int32
    SendTimeOffsetType Единица измерения смещения времени отправки СМС enum — Day, Week, Month

    Ответ

    Параметр Описание Тип
    ContactGroupName Название группы контактов, по которой проводиться автоматическая СМС рассылка string
    ContactGroupId Идентификатор группы контактов, по которой проводиться автоматическая СМС рассылка string
    Status Статус одиночной автоматической СМС рассылки, принимает значения: Active или Paused string
    SmsSenderId Имя отправителя string
    Id Идентификатор автоматической СМС рассылки. string
    Event Название колонки, которая является событием, по которому проводиться автоматическая СМС рассылка string
    SmsTemplate Шаблон (текст) СМС string
    AlternativeSmsTemplate Альтернативный шаблон (текст) СМС string
    Price Стоимость СМС рассылки, руб. decimal
    MessageSegmentsDelivered Количество доставленных сегментов СМС int32
    MessagesDelivered Количество доставленных СМС int32
    MessageSegmentsSent Количество отправленных сегментов СМС int32
    MessagesSent Количество отправленных СМС int32
    SendType Направление смещения времени отправки СМС enum — JustInTime, Before, After
    SendTime Время отправки СМС timespan
    SendTimeOffset Количество дней, недель или месяцев, на которое надо смещать время отправки СМС int32
    SendTimeOffsetType Единица измерения смещения времени отправки СМС enum — Day, Week, Month
    UseRecepientTimeZone True — если СМС отправляются по местному времени абонента boolean
    MustTransliterate True — если текст СМС транслитерируется перед отправкой boolean
    StartingFromDate Дата, начиная с которой должна начинать работать рассылка datetime, может быть null

    Параметры
    apiKey api-Ключ
    ContactGroupId Идентификатор группы контактов, по которой будет проводиться автоматическая СМС рассылка
    FilterId Идентификатор сохраненного в группе фильтра по контактам
    Event Название колонки, которая будет являться событием, по которому будет проводиться автоматическая СМС рассылка
    SendTime Время отправки СМС
    SendType Направление смещения времени отправки СМС сообщений
    SmsSenderId Имя отправителя СМС
    SmsTemplate Шаблон (текст) СМС
    AlternativeSmsTemplate Альтернативный шаблон (текст)
    LocalTimeZone Часовой пояс, по которому будет проводиться СМС рассылка
    UseRecepientTimeZone True — если следует отправлять СМС по местному времени абонента
    MustTransliterate True — если необходимо транслитерировать текст СМС перед отправкой
    SendTimeOffset Количество дней, недель или месяцев, на которое надо смещать время отправки СМС
    SendTimeOffsetType Единица измерения смещения времени отправки СМС


  2. GET: /autoSmsSendings

    Получить информацию об автоматических СМС рассылках в порядке от новых к старым

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

    Параметры фильтра, передаваемые через строку запроса

    Параметр Описание Тип
    Offset Количество начальных элементов в результате, которые надо пропустить uint32
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50) uint32

    Ответ

    Параметр Описание Тип
    Items Выбранное подмножество элементов
    ContactGroupName Название группы контактов, по которой проводиться автоматическая СМС рассылка string
    ContactGroupId Идентификатор группы контактов, по которой проводиться автоматическая СМС рассылка string
    Status Статус одиночной автоматической СМС рассылки, принимает значения: Active или Paused string
    SmsSenderId Имя отправителя string
    Id Идентификатор автоматической СМС рассылки string
    Event Название колонки, которая является событием, по которому проводиться автоматическая СМС рассылка string
    SmsTemplate Шаблон (текст) СМС string
    AlternativeSmsTemplate Альтернативный шаблон (текст) СМС string
    Price Стоимость СМС рассылки, руб. decimal
    MessageSegmentsDelivered Количество доставленных сегментов СМС int32
    MessagesDelivered Количество доставленных СМС int32
    MessageSegmentsSent Количество отправленных сегментов СМС int32
    MessagesSent Количество отправленных СМС int32
    SendType Направление смещения времени отправки СМС enum — JustInTime, Before, After
    SendTime Время отправки СМС timespan
    SendTimeOffset Количество дней, недель или месяцев, на которое надо смещать время отправки СМС int32
    SendTimeOffsetType Единица измерения смещения времени отправки СМС enum — Day, Week, Month
    UseRecepientTimeZone True — если СМС отправляются по местному времени абонента boolean
    MustTransliterate True — если текст СМС транслитерируется перед отправкой boolean
    Total Общее количество элементов int32

    Параметры
    apiKey api-Ключ
    Offset Количество начальных элементов в результате, которые надо пропустить
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50)


  3. PUT: /autoSmsSendings/{id}

    Изменить статус у существующей автоматической СМС рассылки

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор автоматической СМС рассылки. Его можно получить при помощи метода GET: /autoSmsSendings string

    Параметры, передаваемые через тело запроса

    Параметр Описание Тип
    Status Статус одиночной автоматической СМС рассылки, принимает значения: Active или Paused string

    Параметры
    apiKey api-Ключ
    Id Идентификатор автоматической СМС рассылки
    Status Статус одиночной автоматической СМС рассылки, принимает значения: Active или Paused


  4. POST: /autoSmsSendings/{id}

    Изменить статус у существующей автоматической СМС рассылки

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор автоматической СМС рассылки. Его можно получить при помощи метода GET: /autoSmsSendings string

    Параметры, передаваемые через тело запроса

    Параметр Описание Тип
    Status Статус одиночной автоматической СМС рассылки, принимает значения: Active или Paused string

    Параметры
    apiKey api-Ключ
    Id Идентификатор автоматической СМС рассылки
    Status Статус одиночной автоматической СМС рассылки, принимает значения: Active или Paused


  5. GET: /autoSmsSendings/{id}

    Получить информацию о конкретной автоматической СМС рассылке

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор автоматической СМС рассылки. Его можно получить при помощи метода GET: /autoSmsSendings string

    Ответ

    Параметр Описание Тип
    ContactGroupName Название группы контактов, по которой проводиться автоматическая СМС рассылка string
    ContactGroupId Идентификатор группы контактов, по которой проводиться автоматическая СМС рассылка string
    Status Статус одиночной автоматической СМС рассылки, принимает значения: Active или Paused string
    SmsSenderId Имя отправителя string
    Id Идентификатор автоматической СМС рассылки string
    Event Название колонки, которая является событием, по которому проводиться автоматическая СМС рассылка string
    SmsTemplate Шаблон (текст) СМС string
    AlternativeSmsTemplate Альтернативный шаблон (текст) СМС string
    Price Стоимость СМС рассылки, руб. decimal
    MessageSegmentsDelivered Количество доставленных сегментов СМС int32
    MessagesDelivered Количество доставленных СМС int32
    MessageSegmentsSent Количество отправленных сегментов СМС int32
    MessagesSent Количество отправленных СМС int32
    SendType Направление смещения времени отправки СМС enum — JustInTime, Before, After
    SendTime Время отправки СМС timespan
    SendTimeOffset Количество дней, недель или месяцев, на которое надо смещать время отправки СМС int32
    SendTimeOffsetType Единица измерения смещения времени отправки СМС enum — Day, Week, Month
    UseRecepientTimeZone True — если СМС отправляются по местному времени абонента boolean
    MustTransliterate True — если текст СМС транслитерируется перед отправкой boolean

    Параметры
    apiKey api-Ключ
    Id Идентификатор автоматической СМС рассылки


  6. PUT: /autoSmsSendings/{id}/changeTime

    Изменить время отправки СМС у существующей СМС-рассылки. Изменения не повлияют на ближайший день рассылки, но повлияют на все последующие дни.

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор автоматической СМС рассылки. Его можно получить при помощи метода GET: /autoSmsSendings string

    Сведения об изменениях, передаваемые в теле запроса

    Параметр Описание Тип
    SendTime Время отправки СМС timespan

    Ответ

    Параметр Описание Тип
    ContactGroupName Название группы контактов, по которой проводиться автоматическая СМС рассылка string
    ContactGroupId Идентификатор группы контактов, по которой проводиться автоматическая СМС рассылка string
    Status Статус одиночной автоматической СМС рассылки, принимает значения: Active или Paused string
    SmsSenderId Имя отправителя string
    Id Идентификатор автоматической СМС рассылки string
    Event Название колонки, которая является событием, по которому проводиться автоматическая СМС рассылка string
    SmsTemplate Шаблон (текст) СМС string
    AlternativeSmsTemplate Альтернативный шаблон (текст) СМС string
    Price Стоимость СМС рассылки, руб. decimal
    MessageSegmentsDelivered Количество доставленных сегментов СМС int32
    MessagesDelivered Количество доставленных СМС int32
    MessageSegmentsSent Количество отправленных сегментов СМС int32
    MessagesSent Количество отправленных СМС int32
    SendType Направление смещения времени отправки СМС enum — JustInTime, Before, After
    SendTime Время отправки СМС timespan
    SendTimeOffset Количество дней, недель или месяцев, на которое надо смещать время отправки СМС int32
    SendTimeOffsetType Единица измерения смещения времени отправки СМС enum — Day, Week, Month
    UseRecepientTimeZone True — если СМС отправляются по местному времени абонента boolean
    MustTransliterate True — если текст СМС транслитерируется перед отправкой boolean

    Параметры
    apiKey api-Ключ
    Id Идентификатор автоматической СМС рассылки
    SentTime Время отправки СМС


  7. POST: /autoSmsSendings/{id}/changeTime

    Изменить время отправки СМС у существующей СМС-рассылки. Изменения не повлияют на ближайший день рассылки, но повлияют на все последующие дни.

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор автоматической СМС рассылки. Его можно получить при помощи метода GET: /autoSmsSendings string

    Сведения об изменениях, передаваемые в теле запроса

    Параметр Описание Тип
    SendTime Время отправки СМС timespan

    Ответ

    Параметр Описание Тип
    ContactGroupName Название группы контактов, по которой проводиться автоматическая СМС рассылка string
    ContactGroupId Идентификатор группы контактов, по которой проводиться автоматическая СМС рассылка string
    Status Статус одиночной автоматической СМС рассылки, принимает значения: Active или Paused string
    SmsSenderId Имя отправителя string
    Id Идентификатор автоматической СМС рассылки string
    Event Название колонки, которая является событием, по которому проводиться автоматическая СМС рассылка string
    SmsTemplate Шаблон (текст) СМС string
    AlternativeSmsTemplate Альтернативный шаблон (текст) СМС string
    Price Стоимость СМС рассылки, руб. decimal
    MessageSegmentsDelivered Количество доставленных сегментов СМС int32
    MessagesDelivered Количество доставленных СМС int32
    MessageSegmentsSent Количество отправленных сегментов СМС int32
    MessagesSent Количество отправленных СМС int32
    SendType Направление смещения времени отправки СМС enum — JustInTime, Before, After
    SendTime Время отправки СМС timespan
    SendTimeOffset Количество дней, недель или месяцев, на которое надо смещать время отправки СМС int32
    SendTimeOffsetType Единица измерения смещения времени отправки СМС enum — Day, Week, Month
    UseRecepientTimeZone True — если СМС отправляются по местному времени абонента boolean
    MustTransliterate True — если текст СМС транслитерируется перед отправкой boolean

    Параметры
    apiKey api-Ключ
    Id Идентификатор автоматической СМС рассылки
    SentTime Время отправки СМС


  8. GET: /balance

    Получить текущее значение баланса в рублях

    Ответ

    Параметр Описание Тип
    Текущее значение баланса в рублях decimal

    Параметры
    apiKey api-Ключ


  9. GET: /balance/payments

    Получить историю заказов/платежей, начиная с недавних

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

    Параметры фильтра, передаваемые через строку запроса

    Параметр Описание Тип
    Offset Количество начальных элементов в результате, которые надо пропустить uint32
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50) uint32

    Ответ

    Параметр Описание Тип
    Items Выбранное подмножество элементов
    PaymentDate Дата оплаты счёта datetime, может быть null
    Type Способ оплаты, принимает значения: BankwireTransfer, RobokassaVisaMasterCard, RobokassaQiwi, RobokassaWebMoneyR, RobokassaYandexMoneyR, RobokassaWebMoneyZ string
    Amount Сумма счёта decimal
    BonusAmount Сумма бонуса decimal
    BillNo Номер счёта string
    CreationDate Дата создания счёта datetime
    State Состояние счёта, принимает значения: Advanced, Paid, SentDocuments, ReceivedAct string
    Total Общее количество элементов int32

    Параметры
    apiKey api-Ключ
    Offset Количество начальных элементов в результате, которые надо пропустить
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50)


  10. GET: /balance/tariff

    Получить текущий тариф

    Ответ

    Параметр Описание Тип
    Title Название тарифа string
    PricePerSms Цена за 1 СМС, руб. decimal
    PricePerEmail Цена за 1 email, руб. decimal
    MinPayment Минимальная сумма платежа для установки тарифа decimal

    Параметры
    apiKey api-Ключ


  11. GET: /balance/tariffs

    Получить все тарифы, доступные пользователю

    Ответ

    Параметр Описание Тип
    Items Выбранное подмножество элементов
    Title Название тарифа string
    PricePerSms Цена за 1 СМС, руб. decimal
    PricePerEmail Цена за 1 email, руб. decimal
    MinPayment Минимальная сумма платежа для установки тарифа decimal
    Total Общее количество элементов int32

    Параметры
    apiKey api-Ключ


  12. GET: /blackListEmailAddresses

    Получить информацию об email-адресах в чёрном списке, начиная с недавно добавленных

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

    Параметры фильтра, передаваемые через строку запроса

    Параметр Описание Тип
    StartUtcDateTime Фильтр по дате добавления, нижняя граница (UTC) datetime, может быть null
    EndUtcDateTime Фильтр по дате добавления, верхняя граница (UTC) datetime, может быть null
    SearchString Строка поиска по email-адресам string
    Offset Количество начальных элементов в результате, которые надо пропустить uint32
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50) uint32

    Ответ

    Параметр Описание Тип
    Items Выбранное подмножество элементов
    Email Email-адрес, занесённый в чёрный список string
    UtcDateAdded Дата занесения email-адреса в чёрный список (UTC) datetime
    Comments Комментарий к записи в чёрном списке string
    Reason Причина по который email-адрес был занесён в чёрный список, принимает значения: CustomerAdded, UnsubscribedByEmailLink string
    Total Общее количество элементов int32

    Параметры
    apiKey api-Ключ
    StartUtcDateTime Фильтр по дате добавления, нижняя граница (UTC)
    EndUtcDateTime Фильтр по дате добавления, верхняя граница (UTC)
    SearchString Строка поиска по email-адресам
    Offset Количество начальных элементов в результате, которые надо пропустить
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50)


  13. POST: /blackListEmailAddresses

    Добавить email-адрес в чёрный список

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

    Сведения об email-адресе, передаваемые в теле запроса

    Параметр Описание Тип
    Email Email-адрес, подлежащий занесению в чёрный список string
    Comments Комментарий к записи в чёрном списке (максимум — 100 символов) string

    Ответ

    Параметр Описание Тип
    Email Email-адрес, занесённый в чёрный список string
    UtcDateAdded Дата занесения email-адреса в чёрный список (UTC) datetime
    Comments Комментарий к записи в чёрном списке string
    Reason Причина по который email-адрес был занесён в чёрный список, принимает значения: CustomerAdded, UnsubscribedByEmailLink string

    Параметры
    apiKey api-Ключ
    Email Email-адрес, подлежащий занесению в чёрный список
    Comments Комментарий к записи в чёрном списке (максимум — 100 символов)


  14. GET: /blackListPhoneNumbers

    Получить информацию о телефонных номерах в чёрном списке начиная с недавно добавленных

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

    Параметры фильтра, передаваемые через строку запроса

    Параметр Описание Тип
    StartUtcDateTime Фильтр по дате добавления, нижняя граница (UTC) datetime, может быть null
    EndUtcDateTime Фильтр по дате добавления, верхняя граница (UTC) datetime, может быть null
    SearchString Строка поиска по номеру телефона string
    Offset Количество начальных элементов в результате, которые надо пропустить uint32
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50) uint32

    Ответ

    Параметр Описание Тип
    Items Выбранное подмножество элементов
    PhoneNumber Номер телефона, занесённый в чёрный список string
    UtcDateAdded Дата занесения в чёрный список (UTC) datetime
    Comments Комментарий к записи в чёрном списке string
    Reason Причина занесения в чёрный список, принимает значения: CustomerAdded, SmsnenadoAdded string
    Total Общее количество элементов int32

    Параметры
    apiKey api-Ключ
    StartUtcDateTime Фильтр по дате добавления, нижняя граница (UTC)
    EndUtcDateTime Фильтр по дате добавления, верхняя граница (UTC)
    SearchString Строка поиска по номеру телефона
    Offset Количество начальных элементов в результате, которые надо пропустить
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50)


  15. POST: /blackListPhoneNumbers

    Добавить телефонный номер в чёрный список

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

    Сведения об email-адресе, передаваемые в теле запроса

    Параметр Описание Тип
    PhoneNumber Номер телефона, подлежащий занесению в чёрный список string
    Comments Комментарий к записи в чёрном списке (максимум — 100 символов) string

    Ответ

    Параметр Описание Тип
    PhoneNumber Номер телефона, занесенённый в чёрный список string
    UtcDateAdded Дата занесения в чёрный список (UTC) datetime
    Comments Комментарий к записи в чёрном списке string
    Reason Причина по который email-адрес был занесён в чёрный список, принимает значения: CustomerAdded, UnsubscribedByEmailLink string

    Параметры
    apiKey api-Ключ
    PhoneNumber Номер телефона, подлежащий занесению в чёрный список
    Comments Комментарий к записи в чёрном списке (максимум — 100 символов)


  16. GET: /blackListEmailAddresses/{email}

    Получить информацию о конкретном email-адресе из чёрного списка

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Email Email-адрес, по которому нужно получить информацию string

    Ответ

    Параметр Описание Тип
    Email Email-адрес, занесённый в чёрный список string
    UtcDateAdded Дата занесения email-адреса в чёрный список (UTC) datetime
    Comments Комментарий к записи в чёрном списке string
    Reason Причина по который email-адрес был занесён в чёрный список, принимает значения: CustomerAdded, UnsubscribedByEmailLink string

    Параметры
    apiKey api-Ключ
    Email Email-адрес, по которому нужно получить информацию


  17. POST: /blackListEmailAddresses/{email}

    Изменить запись об email-адресе в чёрном списке

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Email Email-адрес, сведения о котором нужно изменить string

    Сведения, подлежащие изменению, передаваемые в теле запроса

    Параметр Описание Тип
    Comments Комментарий к записи в чёрном списке (максимум — 100 символов) string

    Ответ

    Параметр Описание Тип
    Email Email-адрес, занесённый в чёрный список string
    UtcDateAdded Дата занесения email-адреса в чёрный список (UTC) datetime
    Comments Комментарий к записи в чёрном списке string
    Reason Причина по который email-адрес был занесён в чёрный список, принимает значения: CustomerAdded, UnsubscribedByEmailLink string

    Параметры
    apiKey api-Ключ
    Email Email-адрес, сведения о котором нужно изменить
    Comments Комментарий к записи в чёрном списке (максимум — 100 символов)


  18. PUT: /blackListEmailAddresses/{email}

    Изменить запись об email-адресе в чёрном списке

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Email Email-адрес, сведения о котором нужно изменить string

    Сведения, подлежащие изменению, передаваемые в теле запроса

    Параметр Описание Тип
    Comments Комментарий к записи в чёрном списке (максимум — 100 символов) string

    Ответ

    Параметр Описание Тип
    Email Email-адрес, занесённый в чёрный список string
    UtcDateAdded Дата занесения email-адреса в чёрный список (UTC) datetime
    Comments Комментарий к записи в чёрном списке string
    Reason Причина по который email-адрес был занесён в чёрный список, принимает значения: CustomerAdded, UnsubscribedByEmailLink string

    Параметры
    apiKey api-Ключ
    Email Email-адрес, сведения о котором нужно изменить
    Comments Комментарий к записи в чёрном списке (максимум — 100 символов)


  19. DELETE: /blackListEmailAddresses/{email}

    Исключить email-адрес из чёрного списка

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Email Email-адрес, подлежащий исключению из чёрного списка string

    Параметры
    apiKey api-Ключ
    Email Email-адрес, подлежащий исключению из чёрного списка


  20. POST: /blackListEmailAddresses/{email}/delete

    Исключить email-адрес из чёрного списка

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Email Email-адрес, подлежащий исключению из чёрного списка string

    Параметры
    apiKey api-Ключ
    Email Email-адрес, подлежащий исключению из чёрного списка


  21. POST: /blackListPhoneNumbers/{phoneNumber}

    Изменить запись о телефоне в чёрном списке

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    PhoneNumber Телефонный номер, сведения о котором нужно изменить string

    Сведения, подлежащие изменению, передаваемые в теле запроса

    Параметр Описание Тип
    Comments Комментарий к записи в чёрном списке string

    Ответ

    Параметр Описание Тип
    PhoneNumber Номер телефона, засенённый в чёрный список string
    UtcDateAdded Дата занесения в чёрный список (UTC) datetime
    Comments Комментарий к записи в чёрном списке string
    Reason Причина занесения в чёрный список, принимает значения: CustomerAdded, SmsnenadoAdded string

    Параметры
    apiKey api-Ключ
    PhoneNumber Телефонный номер, сведения о котором нужно изменить
    Comments Комментарий к записи в чёрном списке


  22. PUT: /blackListPhoneNumbers/{phoneNumber}

    Изменить запись о телефоне в чёрном списке

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    PhoneNumber Телефонный номер, сведения о котором нужно изменить string

    Сведения, подлежащие изменению, передаваемые в теле запроса

    Параметр Описание Тип
    Comments Комментарий к записи в чёрном списке string

    Ответ

    Параметр Описание Тип
    PhoneNumber Номер телефона, засенённый в чёрный список string
    UtcDateAdded Дата занесения в чёрный список (UTC) datetime
    Comments Комментарий к записи в чёрном списке string
    Reason Причина занесения в чёрный список, принимает значения: CustomerAdded, SmsnenadoAdded string

    Параметры
    apiKey api-Ключ
    PhoneNumber Телефонный номер, сведения о котором нужно изменить
    Comments Комментарий к записи в чёрном списке


  23. DELETE: /blackListPhoneNumbers/{phoneNumber}

    Исключить номер телефона из чёрного списка

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    PhoneNumber Телефонный номер, подлежащий исключению из чёрного списка string

    Параметры
    apiKey api-Ключ
    PhoneNumber Телефонный номер, подлежащий исключению из чёрного списка


  24. GET: /blackListPhoneNumbers/{phoneNumber}

    Получить информацию о конкретном телефонном номере из чёрного списка

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    PhoneNumber Телефонный номер, по которому нужно получить информацию string

    Ответ

    Параметр Описание Тип
    PhoneNumber Номер телефона, засенённый в чёрный список string
    UtcDateAdded Дата занесения в чёрный список (UTC) datetime
    Comments Комментарий к записи в чёрном списке string
    Reason Причина занесения в чёрный список, принимает значения: CustomerAdded, SmsnenadoAdded string

    Параметры
    apiKey api-Ключ
    PhoneNumber Телефонный номер, по которому нужно получить информацию


  25. POST: /blackListPhoneNumbers/{phoneNumber}/delete

    Исключить номер телефона из чёрного списка

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    PhoneNumber Телефонный номер, подлежащий исключению из чёрного списка string

    Параметры
    apiKey api-Ключ
    PhoneNumber Телефонный номер, подлежащий исключению из чёрного списка


  26. POST: /contactGroups

    Создать новую контактную группу

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

    Сведения о создаваемой группе контактов, передаваемые в теле запроса

    Параметр Описание Тип
    Name Название группы контактов (от 3 до 25 символов) string

    Ответ

    Параметр Описание Тип
    Id Идентификатор группы контактов string
    Name Название группы контактов string
    TotalContacts Количество записей в группе int32, может быть null
    LastAddedContactDateTime Дата и время добавления последнего контакта datetime, может быть null
    LastSmsSendingDateTime Дата и время последней СМС-рассылки по группе контактов datetime, может быть null
    LastEmailSendingDateTime Дата и время последней email-рассылки по группе контактов datetime, может быть null
    TotalContactsWithPhoneNumber Количество записей, содержащих номер телефона int32, может быть null
    TotalContactsWithEmail Количество записей, содержащих email-адрес int32, может быть null
    Filters Информация о фильтрах
    Id Идентификатор фильтра string
    Name Название фильтра string
    Expressions Условия фильтра
    Field Поле для фильтрации string
    Operator Логический оператор enum — Eq, Neq, Contains, Startswith, EndsWith, Gte, Gt, Lte, Lt, ThisDayOfYear, ThisMonth, Between
    Value Значение фильтра string
    Preset True — если фильтр является предустановленным и не может быть изменён boolean
    Columns Информация о колонках
    Title Название колонки string
    Type Тип колонки enum — String, Number, Bool, Date, Decimal
    State Текущее состояние колонки enum — Hidden, Visible
    Index Индекс колонки, с отсчётом от нуля int32
    Preset True — если колонка является предустановленной и не может быть переименована boolean

    Параметры
    apiKey api-Ключ
    Name Название группы контактов (от 3 до 25 символов)


  27. GET: /contactGroups

    Получить информацию о группах контактов в порядке их создания

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

    Параметры выборки, передаваемые через строку запроса

    Параметр Описание Тип
    SearchQuery Поисковая фраза string
    Offset Количество начальных элементов в результате, которые надо пропустить uint32
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50) uint32
    IncludeStatistics True — если следует включать в ответ статистику по группе boolean
    IncludeFilters True — если следует включать в ответ фильтры группы boolean
    IncludeColumns True — если следует включать в результат колонки группы boolean

    Ответ

    Параметр Описание Тип
    Items Выбранное подмножество элементов
    Id Идентификатор группы контактов. Не изменяется при переименовании группы. string
    Name Название группы контактов string
    TotalContacts Количество записей в группе int32, может быть null
    LastAddedContactDateTime Дата и время добавления последнего контакта datetime, может быть null
    LastSmsSendingDateTime Дата и время последней СМС-рассылки по группе контактов datetime, может быть null
    LastEmailSendingDateTime Дата и время последней email-рассылки по группе контактов datetime, может быть null
    TotalContactsWithPhoneNumber Количество записей, содержащих номер телефона int32, может быть null
    TotalContactsWithEmail Количество записей, содержащих email-адрес int32, может быть null
    Filters Информация о фильтрах
    Id Идентификатор фильтра string
    Name Название фильтра string
    Expressions Условия фильтра
    Field Поле для фильтрации string
    Operator Логический оператор enum — Eq, Neq, Contains, Startswith, EndsWith, Gte, Gt, Lte, Lt, ThisDayOfYear, ThisMonth, Between
    Value Значение фильтра string
    Preset True — если фильтр является предустановленным и не может быть изменён boolean
    Columns Информация о колонках
    Title Название колонки string
    Type Тип колонки enum — String, Number, Bool, Date, Decimal
    State Текущее состояние колонки enum — Hidden, Visible
    Index Индекс колонки, с отсчётом от нуля int32
    Preset True — если колонка является предустановленной и не может быть переименована boolean
    Total Общее количество элементов int32

    Параметры
    apiKey api-Ключ
    SearchQuery Поисковая фраза
    Offset Количество начальных элементов в результате, которые надо пропустить
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50)
    IncludeStatistics True — если следует включать в ответ статистику по группе
    IncludeFilters True — если следует включать в ответ фильтры группы
    IncludeColumns True — если следует включать в результат колонки группы


  28. PUT: /contactGroups/{Id}

    Переименовать контактную группу

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Id Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string

    Сведения о группе контактов, подлежащие изменению, передаваемые в теле запроса

    Параметр Описание Тип
    Name Название группы контактов (от 3 до 25 символов) string

    Ответ

    Параметр Описание Тип
    Id Идентификатор группы контактов string
    Name Название группы контактов string
    TotalContacts Количество записей в группе int32, может быть null
    LastAddedContactDateTime Дата и время добавления последнего контакта datetime, может быть null
    LastSmsSendingDateTime Дата и время последней СМС-рассылки по группе контактов datetime, может быть null
    LastEmailSendingDateTime Дата и время последней email-рассылки по группе контактов datetime, может быть null
    TotalContactsWithPhoneNumber Количество записей, содержащих номер телефона int32, может быть null
    TotalContactsWithEmail Количество записей, содержащих email-адрес int32, может быть null
    Filters Информация о фильтрах
    Id Идентификатор фильтра string
    Name Название фильтра string
    Expressions Условия фильтра
    Field Поле для фильтрации string
    Operator Логический оператор enum — Eq, Neq, Contains, Startswith, EndsWith, Gte, Gt, Lte, Lt, ThisDayOfYear, ThisMonth, Between
    Value Значение фильтра string
    Preset True — если фильтр является предустановленным и не может быть изменён boolean
    Columns Информация о колонках
    Title Название колонки string
    Type Тип колонки enum — String, Number, Bool, Date, Decimal
    State Текущее состояние колонки enum — Hidden, Visible
    Index Индекс колонки, с отсчётом от нуля int32
    Preset True — если колонка является предустановленной и не может быть переименована boolean

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы контактов
    Name Название группы контактов (от 3 до 25 символов)


  29. POST: /contactGroups/{Id}

    Переименовать контактную группу

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Id Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string

    Сведения о группе контактов, подлежащие изменению, передаваемые в теле запроса

    Параметр Описание Тип
    Name Название группы контактов (от 3 до 25 символов) string

    Ответ

    Параметр Описание Тип
    Id Идентификатор группы контактов string
    Name Название группы контактов string
    TotalContacts Количество записей в группе int32, может быть null
    LastAddedContactDateTime Дата и время добавления последнего контакта datetime, может быть null
    LastSmsSendingDateTime Дата и время последней СМС-рассылки по группе контактов datetime, может быть null
    LastEmailSendingDateTime Дата и время последней email-рассылки по группе контактов datetime, может быть null
    TotalContactsWithPhoneNumber Количество записей, содержащих номер телефона int32, может быть null
    TotalContactsWithEmail Количество записей, содержащих email-адрес int32, может быть null
    Filters Информация о фильтрах
    Id Идентификатор фильтра string
    Name Название фильтра string
    Expressions Условия фильтра
    Field Поле для фильтрации string
    Operator Логический оператор enum — Eq, Neq, Contains, Startswith, EndsWith, Gte, Gt, Lte, Lt, ThisDayOfYear, ThisMonth, Between
    Value Значение фильтра string
    Preset True — если фильтр является предустановленным и не может быть изменён boolean
    Columns Информация о колонках
    Title Название колонки string
    Type Тип колонки enum — String, Number, Bool, Date, Decimal
    State Текущее состояние колонки enum — Hidden, Visible
    Index Индекс колонки, с отсчётом от нуля int32
    Preset True — если колонка является предустановленной и не может быть переименована boolean

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы контактов
    Name Название группы контактов (от 3 до 25 символов)


  30. DELETE: /contactGroups/{id}

    Удалить контактную группу

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы контактов


  31. GET: /contactGroups/{id}

    Получить информацию о конкретной группе контактов

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

    Параметры выборки, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string
    IncludeStatistics True — если следует включать в ответ статистику по группе boolean
    IncludeFilters True — если следует включать в ответ фильтры группы boolean
    IncludeColumns True — если следует включать в результат колонки группы boolean

    Ответ

    Параметр Описание Тип
    Id Идентификатор группы контактов string
    Name Название группы контактов string
    TotalContacts Количество записей в группе int32, может быть null
    LastAddedContactDateTime Дата и время добавления последнего контакта datetime, может быть null
    LastSmsSendingDateTime Дата и время последней СМС-рассылки по группе контактов datetime, может быть null
    LastEmailSendingDateTime Дата и время последней email-рассылки по группе контактов datetime, может быть null
    TotalContactsWithPhoneNumber Количество записей, содержащих номер телефона int32, может быть null
    TotalContactsWithEmail Количество записей, содержащих email-адрес int32, может быть null
    Filters Информация о фильтрах
    Id Идентификатор фильтра string
    Name Название фильтра string
    Expressions Условия фильтра
    Field Поле для фильтрации string
    Operator Логический оператор enum — Eq, Neq, Contains, Startswith, EndsWith, Gte, Gt, Lte, Lt, ThisDayOfYear, ThisMonth, Between
    Value Значение фильтра string
    Preset True — если фильтр является предустановленным и не может быть изменён boolean
    Columns Информация о колонках
    Title Название колонки string
    Type Тип колонки enum — String, Number, Bool, Date, Decimal
    State Текущее состояние колонки enum — Hidden, Visible
    Index Индекс колонки, с отсчётом от нуля int32
    Preset True — если колонка является предустановленной и не может быть переименована boolean

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы контактов
    IncludeStatistics True — если следует включать в ответ статистику по группе
    IncludeFilters True — если следует включать в ответ фильтры группы
    IncludeColumns True — если следует включать в результат колонки группы


  32. POST: /contactGroups/{id}/delete

    Удалить контактную группу

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы контактов


  33. GET: /contactGroups/{groupId}/typos

    Получить информацию об опечатках в конкретной контактной группе

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

    Параметры выборки, передаваемые через строку запроса

    Параметр Описание Тип
    GroupId Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string
    SearchQuery Поисковая фраза string
    OrderBy Порядок сортировки string
    OrderDestination Направление сортировки enum — ASC, DESC, может быть null
    Offset Количество начальных элементов в результате, которые надо пропустить uint32
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50) uint32

    Ответ

    Параметр Описание Тип
    Items Выбранное подмножество элементов
    ContactId Идентификатор контакта string
    SourceFirstName Исходное имя string
    SourceLastName Исходная фамилия string
    SourceMiddleName Исходное отчество string
    SourceSex Исходный пол, true — мужской пол, false — женский boolean, может быть null
    CleanedFirstName Исправленное имя string
    CleanedLastName Исправленная фамилия string
    CleanedMiddleName Исправленное отчество string
    CleanedSex Исправленный пол, true — мужской пол, false — женский boolean, может быть null
    Total Общее количество элементов int32

    Параметры
    apiKey api-Ключ
    GroupId Идентификатор группы контактов
    SearchQuery Поисковая фраза
    OrderBy Порядок сортировки
    OrderDestination Порядок сортировки
    Offset Количество начальных элементов в результате, которые надо пропустить
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50)


  34. GET: /contactGroups/{groupId}/typos/{id}

    Получить информацию о конкретной опечатке в конкретной контактной группе

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор контакта. Идентификатор контакта с опечаткой можно получить с помощью метода GET: /contactGroups/{groupId}/typos string
    GroupId Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string

    Ответ

    Параметр Описание Тип
    ContactId Идентификатор контакта string
    SourceFirstName Исходное имя string
    SourceLastName Исходная фамилия string
    SourceMiddleName Исходное отчество string
    SourceSex Исходный пол, true — мужской пол, false — женский boolean, может быть null
    CleanedFirstName Исправленное имя string
    CleanedLastName Исправленная фамилия string
    CleanedMiddleName Исправленное отчество string
    CleanedSex Исправленный пол, true — мужской пол, false — женский boolean, может быть null

    Параметры
    apiKey api-Ключ
    Id Идентификатор контакта
    GroupId Идентификатор группы контактов


  35. POST: /contactGroups/{groupId}/typos/{id}/approve

    Подтвердить исправления опечатки, предложенные Арамбой

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор контакта. Идентификатор контакта с опечаткой можно получить с помощью метода GET: /contactGroups/{groupId}/typos string
    GroupId Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string

    Параметры
    apiKey api-Ключ
    Id Идентификатор контакта
    GroupId Идентификатор группы контактов


  36. POST: /contactGroups/{groupId}/typos/{id}/custom

    Исправить опечатки самостоятельно, игнорируя предложенные Арамбой исправления

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор контакта. Идентификатор контакта с опечаткой можно получить с помощью метода GET: /contactGroups/{groupId}/typos string
    GroupId Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string

    Исправленные данные контакта, передаваемые в теле запроса

    Параметр Описание Тип
    CleanedFirstName Исправленное имя string
    CleanedLastName Исправленная фамилия string
    CleanedMiddleName Исправленное отчество string
    CleanedSex Исправленный пол, true — мужской пол, false — женский boolean, может быть null

    Параметры
    apiKey api-Ключ
    Id Идентификатор контакта
    GroupId Идентификатор группы контактов
    CleanedFirstName Исправленное имя
    CleanedLastName Исправленная фамилия
    CleanedMiddleName Исправленное отчество
    CleanedSex Исправленный пол, true — мужской пол, false — женский


  37. POST: /contactGroups/{id}/columns

    Создать новую колонку в группе контактов

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string

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

    Параметр Описание Тип
    Type Тип колонки enum — String, Number, Bool, Date, Decimal
    Title Название колонки string
    Index Индекс колонки, с отсчётом от нуля int32, может быть null

    Ответ

    Параметр Описание Тип
    Title Название колонки string
    Type Тип колонки enum — String, Number, Bool, Date, Decimal
    State Текущее состояние колонки enum — Hidden, Visible
    Index Индекс колонки, с отсчётом от нуля int32
    Preset True — если колонка является предустановленной и не может быть переименована boolean

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы контактов
    Type Тип колонки
    Title Название колонки
    Index Индекс колонки, с отсчётом от нуля


  38. GET: /contactGroups/{id}/columns

    Получить информацию обо всех колонках группы контактов в порядке их индекса

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string

    Ответ

    Параметр Описание Тип
    Items Выбранное подмножество элементов
    Title Название колонки string
    Type Тип колонки enum — String, Number, Bool, Date, Decimal
    State Текущее состояние колонки enum — Hidden, Visible
    Index Индекс колонки, с отсчётом от нуля int32
    Preset True — если колонка является предустановленной и не может быть переименована boolean
    Total Общее количество элементов int32

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы контактов


  39. DELETE: /contactGroups/{id}/columns/{index}

    Удалить колонку из группы контактов

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string
    Index Индекс колонки, с отсчётом от нуля. Его можно получить с помощью метода GET: /contactGroups/{id}/columns int32

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы контактов
    Index Индекс колонки, с отсчётом от нуля


  40. POST: /contactGroups/{id}/columns/{index}

    Редактировать колонку группы контактов

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string
    Index Индекс колонки, с отсчётом от нуля. Его можно получить с помощью метода GET: /contactGroups/{id}/columns int32

    Сведения о колонке, подлежащие изменению, передаваемые в теле запроса

    Параметр Описание Тип
    Title Название колонки string
    Index Индекс колонки, с отсчётом от нуля int32, может быть null

    Ответ

    Параметр Описание Тип
    Title Название колонки string
    Type Тип колонки enum — String, Number, Bool, Date, Decimal
    State Текущее состояние колонки enum — Hidden, Visible
    Index Индекс колонки, с отсчётом от нуля int32
    Preset True — если колонка является предустановленной и не может быть переименована boolean

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы контактов
    Index Индекс изменяемой колонки, с отсчётом от нуля
    Title Название колонки
    Index Индекс измененной колонки, с отсчётом от нуля


  41. PUT: /contactGroups/{id}/columns/{index}

    Редактировать колонку группы контактов

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string
    Index Индекс колонки, с отсчётом от нуля. Его можно получить с помощью метода GET: /contactGroups/{id}/columns string

    Сведения о колонке, подлежащие изменению, передаваемые в теле запроса

    Параметр Описание Тип
    Title Название колонки string
    Index Индекс колонки, с отсчётом от нуля int32, может быть null

    Ответ

    Параметр Описание Тип
    Title Название колонки string
    Type Тип колонки enum — String, Number, Bool, Date, Decimal
    State Текущее состояние колонки enum — Hidden, Visible
    Index Индекс колонки, с отсчётом от нуля int32
    Preset True — если колонка является предустановленной и не может быть переименована boolean

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы контактов
    Index Индекс изменяемой колонки, с отсчётом от нуля
    Title Название колонки
    Index Индекс измененной колонки, с отсчётом от нуля


  42. GET: /contactGroups/{id}/columns/{index}

    Получить информацию о конкретной колонке группы контактов

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string
    Index Индекс колонки, с отсчётом от нуля. Его можно получить с помощью метода GET: /contactGroups/{id}/columns string

    Ответ

    Параметр Описание Тип
    Title Название колонки string
    Type Тип колонки enum — String, Number, Bool, Date, Decimal
    State Текущее состояние колонки enum — Hidden, Visible
    Index Индекс колонки, с отсчётом от нуля int32
    Preset True — если колонка является предустановленной и не может быть переименована boolean

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы контактов
    Index Индекс колонки, с отсчётом от нуля


  43. POST: /contactGroups/{id}/columns/{index}/delete

    Удалить колонку из группы контактов

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string
    Index Индекс колонки, с отсчётом от нуля. Его можно получить с помощью метода GET: /contactGroups/{id}/columns string

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы контактов
    Index Индекс колонки, с отсчётом от нуля


  44. POST: /contactGroups/{id}/contacts

    Добавить в группу новый контакт

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string

    Сведения о добавляемом контакте, передаваемые в теле запроса

    Параметр Описание Тип
    Data Данные контакта, передаются в виде словаря. Например: {«Номер телефона»: «88005551745», «Название»: «Арамба», «Комментарий»: «Лучший сервис для СМС и email информирования»} string[]

    Ответ

    Параметр Описание Тип
    Data Данные записи о контакте (имя, фамилия, номер телефона и прочее) string[]
    PhoneNumberInBlackList True — если номер телефона занесён в чёрный список boolean
    EmailInBlackList True — если email-адрес занесён в чёрный список boolean
    Id Идентификатор контакта string

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы контактов
    Data Данные контакта, передаются в виде словаря. Например: {«Номер телефона»: «88005551745», «Название»: «Арамба», «Комментарий»: «Лучший сервис для СМС и email информирования»}


  45. GET: /contactGroups/{id}/contacts

    Получить информацию о контактах контактной группы

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор группы контактов. Его можно получить с помощью метода GET: /contactGroups string
    SearchQuery Поисковая фраза string
    OrderBy Порядок сортировки string
    OrderDestination Направление сортировки enum — ASC, DESC, может быть null
    Offset Количество начальных элементов в результате, которые надо пропустить uint32
    Limit Количество элементов, которые необходимо вернуть(максимум — 500, по умолчанию — 50) uint32

    Ответ

    Параметр Описание Тип
    Items Выбранное подмножество элементов
    Data Данные записи о контакте (имя, фамилия, номер телефона и прочее) string[]
    PhoneNumberInBlackList True — если номер телефона занесён в чёрный список boolean
    EmailInBlackList True — если email-адрес занесён в чёрный список boolean
    Id Идентификатор контакта string
    Total Общее количество элементов int32

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы контактов
    SearchQuery Поисковая фраза
    OrderBy Порядок сортировки
    OrderDestination Направление сортировки
    Offset Количество начальных элементов в результате, которые надо пропустить
    Limit Количество элементов, которые необходимо вернуть(максимум — 500, по умолчанию — 50)


  46. DELETE: /contactGroups/{id}/contacts/{contactId}

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

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор группы. Его можно получить с помощью метода GET: /contactGroups string
    ContactId Идентификатор контакта. Его можно получить с помощью метода GET: /contactGroups/{id}/contacts string

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы
    СontactId Идентификатор контакта


  47. POST: /contacts/{id}

    Изменить данные контакта

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор контакта Его можно получить с помощью метода GET: /contactGroups/{id}/contacts string

    Изменённые сведения о контакте, передаваемые в теле запроса

    Параметр Описание Тип
    Data Данные контакта, передаются в виде словаря. Например: {«Номер телефона»: «88005551745», «Название»: «Арамба», «Комментарий»: «Лучший сервис для СМС и email информирования»} string[]

    Ответ

    Параметр Описание Тип
    Data Данные записи о контакте (имя, фамилия, номер телефона и прочее) string[]
    PhoneNumberInBlackList True — если номер телефона занесён в чёрный список boolean
    EmailInBlackList True — если email-адрес занесён в чёрный список boolean
    Id Идентификатор контакта string

    Параметры
    apiKey api-Ключ
    Id Идентификатор контакта
    Data Данные контакта, передаются в виде словаря. Например: {«Номер телефона»: «88005551745″, «Название»: «Арамба», «Комментарий»: «Лучший сервис для СМС и email информирования»}


  48. PUT: /contacts/{id}

    Изменить данные контакта

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор контакта. Его можно получить с помощью метода GET: /contactGroups/{id}/contacts string

    Изменённые сведения о контакте, передаваемые в теле запроса

    Параметр Описание Тип
    Data Данные контакта, передаются в виде словаря. Например: {«Номер телефона»: «88005551745», «Название»: «Арамба», «Комментарий»: «Лучший сервис для СМС и email информирования»} string[]

    Ответ

    Параметр Описание Тип
    Data Данные записи о контакте (имя, фамилия, номер телефона и прочее) string[]
    PhoneNumberInBlackList True — если номер телефона занесён в чёрный список boolean
    EmailInBlackList True — если email-адрес занесён в чёрный список boolean
    Id Идентификатор контакта string

    Параметры
    apiKey api-Ключ
    Id Идентификатор контакта
    Data Данные контакта, передаются в виде словаря. Например: {«Номер телефона»: «88005551745″, «Название»: «Арамба», «Комментарий»: «Лучший сервис для СМС и email информирования»}


  49. POST: /contactGroups/{id}/contacts/{contactIdPhoneOrEmail}

    Изменить данные контакта

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор контактной группы. Его можно получить с помощью метода GET: /contactGroups string
    СontactIdPhoneOrEmail Идентификатор контакта, его номер телефона ил электронная почта. Идентификатор контакта можно получить с помощью метода GET: /contactGroups/{id}/contacts string

    Изменённые сведения о контакте, передаваемые в теле запроса

    Параметр Описание Тип
    Data Данные контакта, передаются в виде словаря.
    Например: {«Номер телефона»: «88005551745», «Название»: «Арамба», «Комментарий»: «Лучший сервис для СМС и email информирования»}    		 string[]

    Ответ

    Параметр Описание Тип
    Data Данные записи о контакте (имя, фамилия, номер телефона и прочее) string[]
    PhoneNumberInBlackList True — если номер телефона занесён в чёрный список boolean
    EmailInBlackList True — если email-адрес занесён в чёрный список boolean
    Id Идентификатор контакта string

    Параметры
    apiKey api-Ключ
    Id Идентификатор контактной группы
    СontactIdPhoneOrEmail Идентификатор контакта, его номер телефона или электронный адрес
    Data Данные контакта, передаются в виде словаря. Например: {«Номер телефона»: «88005551745″, «Название»: «Арамба», «Комментарий»: «Лучший сервис для СМС и email информирования»}


  50. GET: /contacts/{id}

    Получить информацию о конкретном контакте

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор контакта. Его можно получить с помощью метода GET: /contactGroups/{id}/contacts string

    Ответ

    Параметр Описание Тип
    Data Данные записи о контакте (имя, фамилия, номер телефона и прочее) string[]
    PhoneNumberInBlackList True — если номер телефона занесён в чёрный список boolean
    EmailInBlackList True — если email-адрес занесён в чёрный список boolean
    Id Идентификатор контакта string

    Параметры
    apiKey api-Ключ
    Id Идентификатор контакта


  51. POST: /contactGroups/{id}/contacts/{contactId}/delete

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

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор группы. Его можно получить с помощью метода GET: /contactGroups string
    ContactId Идентификатор контакта. Его можно получить с помощью метода GET: /contactGroups/{id}/contacts string

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы
    ContactId Идентификатор контакта


  52. POST: /contactGroups/{id}/contacts/{contactIdPhoneOrEmail}/move/{targetGroupId}

    Перенести контакт

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор группы, из которой будет перемещаться контакт. Его можно получить с помощью метода GET: /contactGroups string
    ContactIdPhoneOrEmail Номер телефона, эл. почта или идентификатор перемещаемого контакта. Идентификатор контакта можно получить с помощью метода GET: /contactGroups/{id}/contacts string
    TargetGroupId Идентификатор группы, в которую будет перемещаться контакт. Его можно получить с помощью метода GET: /contactGroups string

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы, из который будет перемещаться контакт
    ContactIdPhoneOrEmail Номер телефона, эл. почта или идентификатор перемещаемого контакта
    TargetGroupId Идентификатор группы, в которую будет перемещаться контакт


  53. POST: /contactGroups/{id}/contacts/{contactIdPhoneOrEmail}/copy/{targetGroupId}

    Скопировать контакт

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор группы, из которой будет копироваться контакт. Его можно получить с помощью метода GET: /contactGroups string
    ContactIdPhoneOrEmail Номер телефона, эл. почта или идентификатор копируемого контакта. Идентификатор контакта можно получить с помощью метода GET: /contactGroups/{id}/contacts string
    TargetGroupId Идентификатор группы, в которую будет копироваться контакт. Его можно получить с помощью метода GET: /contactGroups string

    Параметры
    apiKey api-Ключ
    Id Идентификатор группы, из которой будет копироваться контакт
    ContactIdPhoneOrEmail Номер телефона, эл. почта или идентификатор копируемого контакта
    TargetGroupId Идентификатор группы, в которую будет копироваться контакт


  54. GET: /emailAddresses

    Получить email-адреса отправителя в алфавитном порядке

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

    Параметры фильтра, передаваемые через строку запроса

    Параметр Описание Тип
    Offset Количество начальных элементов в результате, которые надо пропустить uint32
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50) uint32

    Ответ

    Параметр Описание Тип
    Items Выбранное подмножество элементов
    Email Адрес string
    Name Имя string
    Total Общее количество элементов int32

    Параметры
    apiKey api-Ключ
    Offset Количество начальных элементов в результате, которые надо пропустить
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50)


  55. POST: /emailAddresses

    Добавить email-адрес отправителя

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

    Сведения об email-адресе отправителя, передаваемые в теле запроса

    Параметр Описание Тип
    EmailAddress Email-адрес отправителя string
    EmailSenderName Имя отправителя string

    Ответ

    Параметр Описание Тип
    Добавленный email-адрес отправителя string

    Параметры
    apiKey api-Ключ
    EmailAddress Email-адрес отправителя
    EmailSenderName Имя отправителя


  56. GET: /smsSenderIds

    Получить заверенные имена отправителя SMS (Sender ID) в алфавитном порядке

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

    Параметры фильтра, передаваемые через строку запроса

    Параметр Описание Тип
    Offset Количество начальных элементов в результате, которые надо пропустить uint32
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50) uint32

    Ответ

    Параметр Описание Тип
    Items Выбранное подмножество элементов string[]
    Total Общее количество элементов int32

    Параметры
    apiKey api-Ключ
    Offset Количество начальных элементов в результате, которые надо пропустить
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50)


  57. POST: /emailSendings

    Создать новую email-рассылку

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

    Сведения о email-рассылке, передаваемые в теле запроса

    Параметр Описание Тип
    SenderEmailAddress Адрес email отправителя, который нужно использовать для рассылки. Должен быть в списке заверенных адресов отправителя.
    Доступные адреса отправителя можно узнать с помощью GET: /emailAddresses    		 string
    SubjectTemplate Шаблон темы основного сообщения string
    BodyTemplate Шаблон тела основного сообщения string
    AlternativeSubjectTemplate Шаблон темы сообщения для пользователей с пустыми полями string
    AlternativeBodyTemplate Шаблон тела сообщения для пользователей с пустыми полями string
    ContactGroupId Идентификатор контактной группы, по которой нужно произвести рассылку. Его можно узнать с помощью метода GET: /contactGroups string
    FilterId Идентификатор сохраненного в группе фильтра по контактам. Если не указан, рассылка будет производиться по всем контактам группы.
    Его можно узнать с помощью метода GET: /contactGroups    		 string
    SendDateTime Дата и время запуска рассылки datetime
    UnsubscribeText Текст ссылки для отписки string
    SubscribeReason Текст причины для подписки string
    PostponeScheduling Если true, то рассылка не будет поставлена в очередь сейчас, и для постановки в очередь потребуется отдельный вызов. Если идентификатор контактной группы не указан, то рассылка обязана быть создана как отложенная.
    Ожидается, что перед постановкой в очередь для такой рассылки будут указаны адреса получателей с помощью отдельного вызова или вызовов.    		 boolean
    WebVersionText Текст ссылки для просмотра письма в браузере string

    Ответ

    Параметр Описание Тип
    SendingId Идентификатор string
    SenderAddress Email-адрес отправителя string
    SubjectTemplate ‘Тема’ письма string
    AlternativeSubjectTemplate Альтернативная ‘тема’ письма string
    BodyTemplate ‘Тело’ письма string
    AlternativeBodyTemplate Альтернативное ‘тело’ письма string
    ContactGroupName Название группы контактов для рассылки string
    ContactGroupId Идентификатор группы контактов для рассылки string
    TotalSentCount Количество отправленных писем int32
    TotalDeliveredCount Количество доставленных писем int32
    TotalBouncedCount Количество отклонённых писем int32
    TotalSpamCount Количество писем отмеченных как ‘спам’ int32
    TotalOpenedCount Количество открытых писем int32
    Price Стоимость рассылки, руб. decimal
    DateOfStart Дата запуска рассылки datetime

    Параметры
    apiKey api-Ключ
    SenderEmailAddress Адрес email отправителя, который нужно использовать для рассылки. Должен быть в списке заверенных адресов отправителя
    SubjectTemplate Шаблон темы основного сообщения
    BodyTemplate Шаблон тела основного сообщения
    AlternativeSubjectTemplate Шаблон темы сообщения для пользователей с пустыми полями
    AlternativeBodyTemplate Шаблон тела сообщения для пользователей с пустыми полями
    ContactGroupId Идентификатор контактной группы, по которой нужно произвести рассылку
    FilterId Идентификатор сохраненного в группе фильтра по контактам. Если не указан, рассылка будет производиться по всем контактам группы
    SendDateTime Дата и время запуска рассылки
    UnsubscribeText Текст ссылки для отписки
    SubscribeReason Текст причины для подписки
    PostponeScheduling Если true, то рассылка не будет поставлена в очередь сейчас
    WebVersionText Текст ссылки для просмотра письма в браузере


  58. POST: /emailSendings/{id}/recipients

    Добавить получателей к email-рассылке, ещё не поставленной в очередь. Метод можно вызывать много раз для дополнения списка

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

    Параметры фильтра, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор email-рассылки string

    Параметры фильтра, передаваемые в теле запроса

    Параметр Описание Тип
    Словарь, где каждому ключу (email-адресу получателя) соответствует набор дополнительных переменных в виде вложенного словаря ключ-значение.
    Если дополнительных переменных нет, передайте в качестве значения в пару к email-адресу пустой словарь.
    В шаблоне письма будут заменяться все переменные из вложенного словаря, а также переменная ((Электронная почта)) — на email-адрес получателя.
    Например: {«aokhrimenko@smsdelivery.ru»: {«Имя»: «Антон»}, «mkirillov@smsdelivery.ru»: {«Имя»: «Михаил»}}    		 string

    Параметры
    apiKey api-Ключ
    Id Идентификатор email-рассылки
    Словарь


  59. POST: /emailSendings/{id}/schedule

    Поставить в очередь ранее созданную email-рассылку

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

    Параметры фильтра, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор email-рассылки string

    Параметры
    apiKey api-Ключ
    Id Идентификатор email-рассылки


  60. POST: /emailSendings/templateId/{id}

    Создать новую email-рассылку по заранее подготовленному шаблону. Шаблон выбирается по шифрованному идентификатору.

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

    Параметры фильтра, передаваемые через строку запроса

    Параметр Описание Тип
    Id Шифрованный идентификатор шаблона string

    Параметры фильтра, передаваемые в теле запроса

    Параметр Описание Тип
    SenderEmailAddress Адрес email отправителя, который нужно использовать для рассылки. Должен быть в списке заверенных адресов отправителя.
    Доступные адреса отправителя можно узнать с помощью GET: /emailAddresses    		 string
    ContactGroupId Идентификатор контактной группы, по которой нужно произвести рассылку. Его можно узнать с помощью метода GET: /contactGroups string
    FilterId Идентификатор сохраненного в группе фильтра по контактам. Если не указан, рассылка будет производиться по всем контактам группы.
    Его можно узнать с помощью метода GET: /contactGroups    		 string
    SendDateTime Дата и время запуска рассылки datetime
    UnsubscribeText Текст ссылки для отписки string
    SubscribeReason Текст причины для подписки string
    PostponeScheduling Если true, то рассылка не будет поставлена в очередь сейчас, и для постановки в очередь потребуется отдельный вызов. Если идентификатор контактной группы не указан, то рассылка обязана быть создана как отложенная.
    Ожидается, что перед постановкой в очередь для такой рассылки будут указаны адреса получателей с помощью отдельного вызова или вызовов.    		 boolean
    SubjectTemplate Необязательный параметр. Шаблон темы основного сообщения. Если указан, то поменяет основную тему сообщения, которая сохранена в используемом шаблоне. string
    AlternativeSubjectTemplate Необязательный параметр. Шаблон темы сообщения для пользователей с пустыми полями. Если указан, то поменяет альтернативную тему сообщения, которая сохранена в используемом шаблоне. string
    WebVersionText Текст ссылки для просмотра письма в браузере string

    Параметры
    apiKey api-Ключ
    Id Шифрованный идентификатор шаблона
    SenderEmailAddress Адрес email отправителя
    ContactGroupId Идентификатор контактной группы
    FilterId Идентификатор сохраненного в группе фильтра по контактам
    SendDateTime Дата и время запуска рассылки
    UnsubscribeText Текст ссылки для отписки
    SubscribeReason Текст причины для подписки
    PostponeScheduling Если true, то рассылка не будет поставлена в очередь сейчас
    SubjectTemplate Шаблон темы основного сообщения
    AlternativeSubjectTemplate Шаблон темы сообщения для пользователей с пустыми полями
    WebVersionText Текст ссылки для просмотра письма в браузере


  61. POST: /emailSendings/templateName/{name}

    Создать новую email-рассылку по заранее подготовленному шаблону. Шаблон выбирается по имени.

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

    Параметры фильтра, передаваемые через строку запроса

    Параметр Описание Тип
    Name Имя шаблона string

    Параметры фильтра, передаваемые в теле запроса

    Параметр Описание Тип
    SenderEmailAddress Адрес email отправителя, который нужно использовать для рассылки. Должен быть в списке заверенных адресов отправителя.
    Доступные адреса отправителя можно узнать с помощью GET: /emailAddresses    		 string
    ContactGroupId Идентификатор контактной группы, по которой нужно произвести рассылку. Его можно узнать с помощью метода GET: /contactGroups string
    FilterId Идентификатор сохраненного в группе фильтра по контактам. Если не указан, рассылка будет производиться по всем контактам группы.
    Его можно узнать с помощью метода GET: /contactGroups    		 string
    SendDateTime Дата и время запуска рассылки datetime
    UnsubscribeText Текст ссылки для отписки string
    SubscribeReason Текст причины для подписки string
    PostponeScheduling Если true, то рассылка не будет поставлена в очередь сейчас, и для постановки в очередь потребуется отдельный вызов. Если идентификатор контактной группы не указан, то рассылка обязана быть создана как отложенная.
    Ожидается, что перед постановкой в очередь для такой рассылки будут указаны адреса получателей с помощью отдельного вызова или вызовов.    		 boolean
    SubjectTemplate Необязательный параметр. Шаблон темы основного сообщения. Если указан, то поменяет основную тему сообщения, которая сохранена в используемом шаблоне. string
    AlternativeSubjectTemplate Необязательный параметр. Шаблон темы сообщения для пользователей с пустыми полями. Если указан, то поменяет альтернативную тему сообщения, которая сохранена в используемом шаблоне. string
    WebVersionText Текст ссылки для просмотра письма в браузере string

    Параметры
    apiKey api-Ключ
    Name Имя шаблона
    SenderEmailAddress Адрес email отправителя
    ContactGroupId Идентификатор контактной группы
    FilterId Идентификатор сохраненного в группе фильтра по контактам
    SendDateTime Дата и время запуска рассылки
    UnsubscribeText Текст ссылки для отписки
    SubscribeReason Текст причины для подписки
    PostponeScheduling Если true, то рассылка не будет поставлена в очередь сейчас
    SubjectTemplate Шаблон темы основного сообщения
    AlternativeSubjectTemplate Шаблон темы сообщения для пользователей с пустыми полями
    WebVersionText Текст ссылки для просмотра письма в браузере


  62. GET: /emailSendings

    Получить информацию о созданных email-рассылках в порядке от новых к старым

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

    Параметры фильтра, передаваемые через строку запроса

    Параметр Описание Тип
    Offset Количество начальных элементов в результате, которые надо пропустить uint32
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50) uint32

    Ответ

    Параметр Описание Тип
    Items Выбранное подмножество элементов
    SendingId Идентификатор string
    SenderAddress Email-адрес отправителя string
    SubjectTemplate ‘Тема’ письма string
    AlternativeSubjectTemplate Альтернативная ‘тема’ письма string
    BodyTemplate ‘Тело’ письма string
    AlternativeBodyTemplate Альтернативное ‘тело’ письма string
    ContactGroupName Название группы контактов для рассылки string
    ContactGroupId Идентификатор группы контактов для рассылки string
    TotalSentCount Количество отправленных писем int32
    TotalDeliveredCount Количество доставленных писем int32
    TotalBouncedCount Количество отклонённых писем int32
    TotalSpamCount Количество писем отмеченных как ‘спам’ int32
    TotalOpenedCount Количество открытых писем int32
    Price Стоимость рассылки, руб. decimal
    DateOfStart Дата запуска рассылки datetime
    Total Общее количество элементов int32

    Параметры
    apiKey api-Ключ
    Offset Количество начальных элементов в результате, которые надо пропустить
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50)


  63. POST: /emailSendings/cost

    Получить стоимость email-рассылки

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

    Сведения о email-рассылке, стоимость которой надо получить, передаваемые в теле запроса

    Параметр Описание Тип
    ContactGroupId Идентификатор контактной группы, по которой нужно произвести рассылку. Его можно получить с помощью метода GET: /СontactGroups string
    FilterId Идентификатор сохраненного в группе фильтра по контактам. Если не указан, рассылка будет производиться по всем контактам группы.
    Его можно получить с помощью метода GET: /СontactGroups    		 string

    Ответ

    Параметр Описание Тип
    TotalCost Стоимость рассылки, руб. decimal
    Balance Количество денег на счету, руб. decimal

    Параметры
    apiKey api-Ключ
    ContactGroupId Идентификатор контактной группы, по которой нужно произвести рассылку
    FilterId Идентификатор сохраненного в группе фильтра по контактам. Если не указан, рассылка будет производиться по всем контактам группы


  64. GET: /emailSendings/{id}

    Получить информацию о конкретной email-рассылке

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Id Идентификатор email-рассылки. Его можно получить с помощью метода GET: /emailSendings string

    Ответ

    Параметр Описание Тип
    SendingId Идентификатор string
    SenderAddress Email-адрес отправителя string
    SubjectTemplate ‘Тема’ письма string
    AlternativeSubjectTemplate Альтернативная ‘тема’ письма string
    BodyTemplate ‘Тело’ письма string
    AlternativeBodyTemplate Альтернативное ‘тело’ письма string
    ContactGroupName Название группы контактов для рассылки string
    ContactGroupId Идентификатор группы контактов для рассылки string
    TotalSentCount Количество отправленных писем int32
    TotalDeliveredCount Количество доставленных писем int32
    TotalBouncedCount Количество отклонённых писем int32
    TotalSpamCount Количество писем отмеченных как ‘спам’ int32
    TotalOpenedCount Количество открытых писем int32
    Price Стоимость рассылки, руб. decimal
    DateOfStart Дата запуска рассылки datetime

    Параметры
    apiKey api-Ключ
    Id Идентификатор email-рассылки


  65. GET: /emailSendings/{id}/recipients

    Получить информацию о доставляемости писем

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Id Идентификатор email-рассылки. Его можно получить с помощью метода GET: /emailSendings string

    Ответ

    Параметр Описание Тип
    Items Выбранное подмножество элементов
    Email Электронный адрес получателя string
    IsDelivered Доставлено письмо? True — Да, False — Нет boolean
    IsBounced Отклонено письмо? True — Да, False — Нет boolean
    IsOpened Было ли открыто письмо? True — Да, False — Нет boolean
    IsClicked Был ли клик в письме по ссылкам? True — Да, False — Нет boolean
    DeliveredOrBouncedDate Дата и время доставки/отклонения письма datetime
    OpenedDate Дата и время открытия письма datetime
    СlickedDate Дата и время первого клика в письме datetime
    СlickedUrls Список ссылок, по которым был произведен клик в письме string[]

    Параметры
    apiKey api-Ключ
    Id Идентификатор email-рассылки


  66. GET: /emailSendings/{id}/recipients/{email}

    Получить информацию о доставляемости письма на конкретный электронный адрес

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Id Идентификатор email-рассылки. Его можно получить с помощью метода GET: /emailSendings string
    Email Электронный адрес получателя string

    Ответ

    Параметр Описание Тип
    Email Электронный адрес получателя string
    IsDelivered Доставлено письмо? True — Да, False — Нет boolean
    IsBounced Отклонено письмо? True — Да, False — Нет boolean
    IsOpened Было ли открыто письмо? True — Да, False — Нет boolean
    IsClicked Был ли клик в письме по ссылкам? True — Да, False — Нет boolean
    DeliveredOrBouncedDate Дата и время доставки/отклонения письма datetime
    OpenedDate Дата и время открытия письма datetime
    СlickedDate Дата и время первого клика в письме datetime
    СlickedUrls Список ссылок, по которым был произведен клик в письме string[]

    Параметры
    apiKey api-Ключ
    Id Идентификатор email-рассылки
    Email Электронный адрес получателя


  67. POST: /singleEmail

    Отправить одиночное Email-сообщение

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

    Сведения о Email-сообщении, передаваемые в теле запроса

    Параметр Описание Тип
    Subject Тема Email string
    Body Тело Email string
    FromAddress Email-адрес отправителя (должен быть в перечне разрешенных адресов в профиле). Доступные адреса можно узнать с помощью метода GET: /emailAddresses string
    ToAddress Email-адрес получателя string
    AttachmentSetId Идентификатор набора вложений для прикрепления файла(ов) к письму guid

    Параметры
    apiKey api-Ключ
    Subject Тема Email
    Body Тело Email
    FromAddress Email-адрес отправителя (должен быть в перечне разрешенных адресов в профиле)
    ToAddress Email-адрес получателя


  68. POST: /singleEmail/templateId/{id}

    Отправить одиночное Email-сообщение по идентификатору шаблона

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

    Для отправки письма можно передавать либо словарь со всеми переменными в теле запроса, либо email контакта и шифрованный идентификатор его группы в строке запроса, либо идентификатор контакта в строке запроса

    Сведения о Email-сообщении, передаваемые в строке запроса

    Параметр Описание Тип
    Id Идентификатор шаблона. Доступные шаблоны можно узнать с помощью метода GET: /emailTemplates string
    FromAddress Адрес отправителя. Доступные адреса можно узнать с помощью метода GET: /emailAddresses string
    СontactId Идентификатор контакта. Его можно получить с помощью метода GET: /contactGroups/{id}/contacts string
    ToAddress Email-адрес получателя. Использовать только в связке с параметром ContactGroupId string
    ContactGroupId Идентификатор группы контактов. Использовать только в связке с параметром ToAddress. Его можно получить с помощью метода GET: /СontactGroups string
    Subject Необязательный параметр. Шаблон темы основного сообщения. Если указан, то поменяет основную тему сообщения, которая сохранена в используемом шаблоне. string
    AlternativeSubject Необязательный параметр. Шаблон темы альтернативного сообщения. Если указан, то поменяет альтернативную тему сообщения, которая сохранена в используемом шаблоне. string
    AttachmentSetId Идентификатор набора вложений для прикрепления файла(ов) к письму guid

    Сведения о Email-сообщении, передаваемые в теле запроса

    Параметр Описание Тип
    Словарь. Использовать только, если не указаны параметры ContactId или ToAddress в паре с ContactGroupId. Формат словаря {«Электронная почта»: «mail@aramba.ru», «Имя»: «Антон»} string

    Параметры
    apiKey api-Ключ
    Id Идентификатор шаблона
    FromAddress Адрес отправителя
    СontactId Идентификатор контакта
    ToAddress Email-адрес получателя
    ContactGroupId Идентификатор группы контактов
    Subject Шаблон темы основного сообщения.
    AlternativeSubject Шаблон темы альтернативного сообщения
    Словарь


  69. POST: /singleEmail/templateName/{name}

    Отправить одиночное Email-сообщение по имени шаблона

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

    Для отправки письма можно передавать либо словарь со всеми переменными в теле запроса, либо email контакта и шифрованный идентификатор его группы в строке запроса, либо идентификатор контакта в строке запроса

    Сведения о Email-сообщении, передаваемые в строке запроса

    Параметр Описание Тип
    Name Имя шаблона. Доступные шаблоны можно узнать с помощью метода GET: /emailTemplates string
    FromAddress Адрес отправителя. Доступные адреса можно узнать с помощью метода GET: /emailAddresses string
    СontactId Идентификатор контакта. Его можно получить с помощью метода GET: /contactGroups/{id}/contacts string
    ToAddress Email-адрес получателя. Использовать только в связке с параметром ContactGroupId string
    ContactGroupId Идентификатор группы контактов. Использовать только в связке с параметром ToAddress. Его можно получить с помощью метода GET: /СontactGroups string
    Subject Необязательный параметр. Шаблон темы основного сообщения. Если указан, то поменяет основную тему сообщения, которая сохранена в используемом шаблоне. string
    AlternativeSubject Необязательный параметр. Шаблон темы альтернативного сообщения. Если указан, то поменяет альтернативную тему сообщения, которая сохранена в используемом шаблоне. string
    AttachmentSetId Идентификатор набора вложений для прикрепления файла(ов) к письму guid

    Сведения о Email-сообщении, передаваемые в теле запроса

    Параметр Описание Тип
    Словарь. Использовать только, если не указаны параметры ContactId или ToAddress в паре с ContactGroupId. Формат словаря {«Электронная почта»: «mail@aramba.ru», «Имя»: «Антон»} string

    Параметры
    apiKey api-Ключ
    Name Имя шаблона
    FromAddress Адрес отправителя
    СontactId Идентификатор контакта
    ToAddress Email-адрес получателя
    ContactGroupId Идентификатор группы контактов
    Subject Шаблон темы основного сообщения.
    AlternativeSubject Шаблон темы альтернативного сообщения
    Словарь


  70. GET: /singleEmail/{id}

    Получить информацию по отправленному одиночному email-сообщению

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

    Сведения о Email-сообщении, передаваемые в строке запроса

    Параметр Описание Тип
    Id Индентификатор отправленного email-сообщения guid

    Ответ

    Параметр Описание Тип
    Email Адрес получателя string
    IsDelivered Было ли письмо доставлено boolean
    IsBounced Было ли письмо отклонено boolean
    IsOpened Было ли письмо открыто boolean
    IsClicked Был ли клик по какой-либо ссылке в письме boolean
    DeliveredOrBouncedDate Дата доставки или отклонения письма datetime, может быть null
    OpenedDate Дата открытия письма datetime, может быть null
    ClickedDate Дата первого клика datetime, может быть null
    ClickedUrls Список кликнутых ссылок array, может быть null

    Параметры
    apiKey api-Ключ
    Id Индентификатор отправленного email-сообщения


  71. GET: /singleSms

    Получить информацию об отправленных одиночных СМС-сообщениях в порядке от новых к старым

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

    Параметры фильтра, передаваемые через строку запроса

    Параметр Описание Тип
    StartUtcDateTime Фильтр по дате, нижняя граница (UTC) datetime, может быть null
    EndUtcDateTime Фильтр по дате, верхняя граница (UTC) datetime, может быть null
    SenderId Фильтр по имени отправителя СМС string
    PhoneNumber Фильтр по номеру телефона string
    Offset Количество начальных элементов в результате, которые надо пропустить uint32
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50) uint32

    Ответ

    Параметр Описание Тип
    Items Выбранное подмножество элементов
    Id Идентификатор СМС-сообщения string
    PlannedUtcDateTime Планируемое время отправки (UTC) datetime
    DeliveryUtcDateTime Время доставки (UTC) datetime, может быть null
    Status Статус доставки, принимает значения: Enroute, Delivered, Undeliverable string
    SenderId Имя отправителя (Sender ID) string
    PhoneNumber Номер телефона получателя string
    Cost Стоимость отправки, руб. decimal
    Text Текст СМС string
    Total Общее количество элементов int32

    Параметры
    apiKey api-Ключ
    StartUtcDateTime Фильтр по дате, нижняя граница
    EndUtcDateTime Фильтр по дате, верхняя граница
    SenderId Фильтр по имени отправителя СМС
    PhoneNumber Фильтр по номеру телефона
    Offset Количество начальных элементов в результате, которые надо пропустить
    Limit Количество элементов, которые необходимо вернуть


  72. POST: /singleSms

    Отправить одиночное СМС-сообщение

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

    Сведения об СМС-сообщении, передаваемые в теле запроса

    Параметр Описание Тип
    SenderId Имя отправителя СМС. Доступные имена отправителя можно узнать с помощью метода GET: /smsSenderIds string
    SendDateTime Дата и время, в которое следует отправить СМС. Оставьте пустым для немедленной отправки. При UseRecepientTimeZone = True укажите здесь время в часовой зоне абонента. Иначе укажите здесь время UTC datetime, может быть null
    UseRecepientTimeZone True — если следует отправлять СМС по местному времени абонента boolean
    PhoneNumber Номер телефона, на который нужно отправить сообщение string
    Text Текст СМС string

    Ответ

    Параметр Описание Тип
    Id Идентификатор СМС-сообщения string
    PlannedUtcDateTime Планируемое время отправки (UTC) datetime
    DeliveryUtcDateTime Время доставки (UTC) datetime, может быть null
    Status Статус доставки, принимает значения: Enroute, Delivered, Undeliverable string
    SenderId Имя отправителя (Sender ID) string
    PhoneNumber Номер телефона получателя string
    Cost Стоимость отправки, руб. decimal
    Text Текст СМС string

    Параметры
    apiKey api-Ключ
    SenderId Имя отправителя
    SendDateTime Оставьте пустым для немедленной отправки.
    При UseRecepientTimeZone = True укажите здесь время в часовой зоне абонента.
    Иначе укажите здесь время UTC
    UseRecepientTimeZone True — если следует отправлять СМС по местному времени абонента
    PhoneNumber Номер телефона, на который нужно отправить сообщение
    Text Текст СМС


  73. POST: /singleSms/cost

    Получить стоимость одиночного СМС-сообщения

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

    Сведения об СМС-сообщении, передаваемые в теле запроса

    Параметр Описание Тип
    SenderId Имя отправителя СМС. Доступные имена отправителя можно узнать с помощью метода GET: /smsSenderIds string
    PhoneNumber Номер телефона, на который нужно отправить сообщение string
    Text Текст СМС string

    Ответ

    Параметр Описание Тип
    SegmentsCount Количество сегментов в СМС int32
    TextLength Длина текста СМС int32
    Cost Цена за СМС decimal
    CleanedText Цена за СМС string

    Параметры
    apiKey api-Ключ
    SenderId Имя отправителя СМС
    PhoneNumber Номер телефона, на который нужно отправить сообщение
    Text Текст СМС


  74. POST: /singleSms/multiple

    Отправить одиночные СМС-сообщение (одинаковый текст на несколько номеров)

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

    Сведения об СМС-сообщениях, передаваемые в теле запроса

    Параметр Описание Тип
    PhoneNumbers Номера телефонов, на которые нужно отправить сообщения string[]
    Text Текст СМС string
    SenderId Имя отправителя СМС. Доступные имена отправителя можно узнать с помощью метода GET: /smsSenderIds string
    SendDateTime Дата и время, в которое следует отправить СМС. Оставьте пустым для немедленной отправки. При UseLocalTimeZone = True укажите здесь время в часовой зоне абонента. Иначе укажите здесь время UTC datetime, может быть null
    UseRecepientTimeZone True — если следует отправлять СМС по местному времени абонента boolean

    Параметры
    apiKey api-Ключ
    PhoneNumbers Номера телефонов, на которые нужно отправить сообщения
    Text Текст СМС
    SenderId Имя отправителя СМС
    SendDateTime Оставьте пустым для немедленной отправки. При UseRecepientTimeZone = True укажите здесь время в часовой зоне абонента.
    Иначе укажите здесь время UTC
    UseRecepientTimeZone True — если следует отправлять СМС по местному времени абонента


  75. GET: /singleSms/{id}

    Получить информацию о конкретном одиночном СМС-сообщении

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Id Идентификатор одиночного СМС-сообщения. Его можно получить с помощью метода GET: /singleSms string

    Ответ

    Параметр Описание Тип
    Id Идентификатор СМС-сообщения string
    PlannedUtcDateTime Планируемое время отправки (UTC) datetime
    DeliveryUtcDateTime Время доставки (UTC) datetime, может быть null
    Status Статус доставки, принимает значения: Enroute, Delivered, Undeliverable string
    SenderId Имя отправителя (Sender ID) string
    PhoneNumber Номер телефона получателя string
    Cost Стоимость отправки, руб. decimal
    Text Текст СМС string

    Параметры
    apiKey api-Ключ
    Id Идентификатор одиночного СМС-сообщения


  76. POST: /emailAttachments

    Создать набор файлов-вложений и добавить в него произвольный файл

    При добавлении файла укажите заголовок Сontent-type равным multipart/form-data

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

    Сведения, передаваемые в теле запроса

    Параметр Описание Тип
    Файл, который будет использоваться в качестве вложения в письме

    Ответ

    Параметр Описание Тип
    Идентификатор нового набора файлов-вложений guid

  77. POST: /emailAttachments/{id}

    Добавить файл в уже существующий набор файлов-вложений

    При добавлении файла укажите заголовок Сontent-type равным multipart/form-data

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

    Сведения, передаваемые в строке запроса

    Параметр Описание Тип
    Id Идентификатор существующего набора файлов-вложений guid

    Сведения, передаваемые в теле запроса

    Параметр Описание Тип
    Файл, который будет использоваться в качестве вложения в письме

    Ответ

    Параметр Описание Тип
    Идентификатор набора файлов-вложений, в который добавлен файл guid

  78. POST: /smsSendings

    Создать новую СМС-рассылку

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

    Сведения об смс-рассылке, передаваемые в теле запроса

    Параметр Описание Тип
    SmsSenderId Имя отправителя. Доступные адреса можно получить с помощью метода GET: /smsSenderIds string
    SendDateTime Дата и время, в которое следует выполнить СМС-рассылку. Оставьте пустым для немедленной отправки. При UseRecepientTimeZone = True укажите здесь время в часовой зоне абонента. Иначе укажите здесь время UTC datetime
    UseRecepientTimeZone True — если следует отправлять СМС по местному времени абонента boolean
    ContactGroupId Идентификатор контактной группы, по которой нужно произвести рассылку. Его можно получить с помощью метода GET: /contactGroups string
    FilterId Идентификатор сохраненного в группе фильтра по контактам. Если не указан, рассылка будет производиться по всем контактам группы.
    Его можно получить с помощью метода GET: /contactGroups    		 string
    SmsTemplate Шаблон основного сообщения string
    AlternativeSmsTemplate Шаблон сообщения для пользователей с пустыми полями string
    Transliterate True — если следует предварительно транслитерировать текст сообщения с русского на английский boolean
    PostponeScheduling Если true, то рассылка не будет поставлена в очередь сейчас, и для постановки в очередь потребуется отдельный вызов.
    Если идентификатор контактной группы не указан, то рассылка обязана быть создана как отложенная.
    Ожидается, что перед постановкой в очередь для такой рассылки будут указаны адреса получателей с помощью отдельного вызова или вызовов.    		 boolean

    Ответ

    Параметр Описание Тип
    UseRecepientTimeZone True — если следует отправлять СМС по местному времени абонента boolean
    SmsTemplate Шаблон основного сообщения string
    AlternativeSmsTemplate Шаблон сообщения для пользователей с пустыми полями string
    SmsSenderId Имя отправителя SMS string
    CreatedDate Дата и время создания СМС-рассылки datetime
    ContactGroupId Идентификатор группы контактов для рассылки string
    SendDateTime Дата и время, в которое следует выполнить СМС-рассылку datetime
    Id Идентификатор рассылки string
    ContactGroupName Название группы контактов для рассылки string
    ContactFilters Коллекция фильтров, использованная при СМС-рассылке
    Field Поле для фильтрации string
    Operator Логический оператор enum — Eq, Neq, Contains, Startswith, EndsWith, Gte, Gt, Lte, Lt, ThisDayOfYear, ThisMonth, Between
    Value Значение фильтра string
    Price Стоимость СМС-рассылки, руб. decimal
    MessagesSent Количество отправленных СМС int32
    MessageSegmentsSent Количество отправленных сегментов СМС int32
    MessagesDelivered Количество доставленных СМС int32
    MessageSegmentsDelivered Количество доставленных сегментов СМС int32
    MessagesUnDelivered Количество недоставленных СМС int32
    TotalUnsubscribed Количество отписавшихся от рассылки получателей int32
    Transliterate True — если текст СМС транслитирируется boolean

    Параметры
    apiKey api-Ключ
    SmsSenderId Имя отправителя
    SendDateTime Дата и время, в которое следует выполнить СМС-рассылку. Оставьте пустым для немедленной отправки.
    При UseRecepientTimeZone = True укажите здесь время в часовой зоне абонента. Иначе укажите здесь время UTC
    UseRecepientTimeZone True — если следует отправлять СМС по местному времени абонента
    ContactGroupId Идентификатор контактной группы, по которой нужно произвести рассылку
    FilterId Идентификатор сохраненного в группе фильтра по контактам. Если не указан, рассылка будет производиться по всем контактам группы
    SmsTemplate Шаблон основного сообщения
    AlternativeSmsTemplate Шаблон сообщения для пользователей с пустыми полями
    Transliterate True — если следует предварительно транслитерировать текст сообщения с русского на английский
    PostponeScheduling Если true, то рассылка не будет поставлена в очередь сейчас


  79. POST: /smsSendings/{id}/recipients

    Добавить получателей к смс рассылке, ещё не поставленной в очередь.

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

    Параметры фильтра, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор смс рассылки string

    Параметры фильтра, передаваемые в теле запроса

    Параметр Описание Тип
    Словарь, где каждому ключу (телефонному номеру получателя) соответствует набор дополнительных переменных в виде вложенного словаря ключ-значение.
    Если дополнительных переменных нет, передайте в качестве значения в пару к номеру телефона пустой словарь.
    В шаблоне смс будут заменяться все переменные из вложенного словаря, а также переменная ((Номер телефона)) — на номер телефона получателя.
    Например: {«79210000001»: {«Имя»: «Антон»}, «79535456594»: {}}    		 string

    Параметры
    apiKey api-Ключ
    Id Идентификатор смс рассылки
    Словарь


  80. POST: /smsSendings/{id}/schedule

    Поставить в очередь ранее созданную смс рассылку

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

    Параметры фильтра, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор смс рассылки string

    Параметры
    apiKey api-Ключ
    Id Идентификатор смс рассылки


  81. GET: /smsSendings

    Получить информацию о созданных смс-рассылках в порядке от новых к старым

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

    Параметры фильтра, передаваемые через строку запроса

    Параметр Описание Тип
    Offset Количество начальных элементов в результате, которые надо пропустить uint32
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50) uint32

    Ответ

    Параметр Описание Тип
    Items Выбранное подмножество элементов
    UseRecepientTimeZone True — если следует отправлять СМС по местному времени абонента boolean
    SmsTemplate Шаблон основного сообщения string
    AlternativeSmsTemplate Шаблон сообщения для пользователей с пустыми полями string
    SmsSenderId Имя отправителя SMS string
    CreatedDate Дата и время создания СМС-рассылки datetime
    ContactGroupId Идентификатор группы контактов для рассылки string
    SendDateTime Дата и время, в которое следует выполнить СМС-рассылку datetime
    Id Идентификатор рассылки string
    ContactGroupName Название группы контактов для рассылки string
    ContactFilters Коллекция фильтров, использованная при СМС-рассылке
    Field Поле для фильтрации string
    Operator Логический оператор enum — Eq, Neq, Contains, Startswith, EndsWith, Gte, Gt, Lte, Lt, ThisDayOfYear, ThisMonth, Between
    Value Значение фильтра string
    Price Стоимость СМС-рассылки, руб. decimal
    MessagesSent Количество отправленных СМС int32
    MessageSegmentsSent Количество отправленных сегментов СМС int32
    MessagesDelivered Количество доставленных СМС int32
    MessageSegmentsDelivered Количество доставленных сегментов СМС int32
    MessagesUnDelivered Количество недоставленных СМС int32
    TotalUnsubscribed Количество отписавшихся от рассылки получателей int32
    Transliterate True — если текст СМС транслитирируется boolean
    Total Общее количество элементов int32

    Параметры
    apiKey api-Ключ
    Offset Количество начальных элементов в результате, которые надо пропустить
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50)


  82. POST: /smsSendings/cost

    Рассчитать стоимость смс-рассылки

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

    Сведения об смс-рассылке, передаваемые в теле запроса

    Параметр Описание Тип
    ContactGroupId Идентификатор контактной группы, по которой нужно произвести рассылку. Его можно получить с помощью метода GET: /contactGroups string
    FilterId Идентификатор сохраненного в группе фильтра по контактам. Если не указан, рассылка будет производиться по всем контактам группы.
    Его можно получить с помощью метода GET: /contactGroups    		 string
    SmsTemplate Шаблон основного сообщения string
    AlternativeSmsTemplate Шаблон сообщения для пользователей с пустыми полями string
    Transliterate True — если следует предварительно транслитерировать текст сообщения с русского на английский boolean

    Параметры
    apiKey api-Ключ
    ContactGroupId Идентификатор контактной группы, по которой нужно произвести рассылку
    FilterId Идентификатор сохраненного в группе фильтра по контактам. Если не указан, рассылка будет производиться по всем контактам группы
    SmsTemplate Шаблон основного сообщения
    AlternativeSmsTemplate Шаблон сообщения для пользователей с пустыми полями
    Transliterate True — если следует предварительно транслитерировать текст сообщения с русского на английский


  83. GET: /smsSendings/{id}

    Получить информацию о конкретной смс-рассылке

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Id Идентификатор смс-рассылки. Его можно получить при помощи метода GET: /smsSendings string

    Ответ

    Параметр Описание Тип
    UseRecepientTimeZone True — если следует отправлять СМС по местному времени абонента boolean
    SmsTemplate Шаблон основного сообщения string
    AlternativeSmsTemplate Шаблон сообщения для пользователей с пустыми полями string
    SmsSenderId Имя отправителя SMS string
    CreatedDate Дата и время создания СМС-рассылки datetime
    ContactGroupId Идентификатор группы контактов для рассылки string
    SendDateTime Дата и время, в которое следует выполнить СМС-рассылку datetime
    Id Идентификатор рассылки string
    ContactGroupName Название группы контактов для рассылки string
    ContactFilters Коллекция фильтров, использованная при СМС-рассылке
    Field Поле для фильтрации string
    Operator Логический оператор enum — Eq, Neq, Contains, Startswith, EndsWith, Gte, Gt, Lte, Lt, ThisDayOfYear, ThisMonth, Between
    Value Значение фильтра string
    Price Стоимость СМС-рассылки, руб. decimal
    MessagesSent Количество отправленных СМС int32
    MessageSegmentsSent Количество отправленных сегментов СМС int32
    MessagesDelivered Количество доставленных СМС int32
    MessageSegmentsDelivered Количество доставленных сегментов СМС int32
    MessagesUnDelivered Количество недоставленных СМС int32
    TotalUnsubscribed Количество отписавшихся от рассылки получателей int32
    Transliterate True — если текст СМС транслитирируется boolean

    Параметры
    apiKey api-Ключ
    Id Идентификатор смс-рассылки


  84. GET: /subAccounts

    Получить список субаккаунтов в алфавитном порядке

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

    Параметры фильтра, передаваемые через строку запроса

    Параметр Описание Тип
    Offset Количество начальных элементов в результате, которые надо пропустить uint32
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50) uint32

    Ответ

    Параметр Описание Тип
    Items Выбранное подмножество элементов
    Login Логин string
    FullName Полное имя string
    Email Email-адрес string
    Position Должность string
    AccessRights Права доступа string[] — EditContact, SmsSending, EmailSending, SingleSmsSending, EditContactGroup
    IsBlocked True — если субаккаунт заблокирован boolean
    Total Общее количество элементов int32

    Параметры
    apiKey api-Ключ
    Offset Количество начальных элементов в результате, которые надо пропустить
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50)


  85. POST: /subAccounts

    Создать новый субаккаунт

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

    Сведения о создаваемом субаккаунте, передаваемые в теле запроса

    Параметр Описание Тип
    Login Логин субаккаунта string
    Email Email-адрес субаккаунта string
    Password Пароль субаккаунта string
    ContactGroupAccessType Тип прав на группы контактов enum — All, Include, Exclude
    ContactGroupIdsAccess Идентификаторы контактных групп, к которым устанавливаются права в свойстве ContactGroupAccessType, в случае Include или Exclude string[]
    Emails Разрешённые email-адреса отправителя string[]
    SenderIds Разрешённые имена отправителя СМС (Sender ID) string[]
    FullName Полное имя пользователя субаккаунта string
    AccessRights Права доступа string[] — EditContact, SmsSending, EmailSending, SingleSmsSending, EditContactGroup
    Position Должность string

    Ответ

    Параметр Описание Тип
    Login Логин string
    FullName Полное имя string
    Email Email-адрес string
    Position Должность string
    AccessRights Права доступа string[] — EditContact, SmsSending, EmailSending, SingleSmsSending, EditContactGroup
    IsBlocked True — если субаккаунт заблокирован boolean

    Параметры
    apiKey api-Ключ
    Login Логин субаккаунта
    Email Email-адрес субаккаунта
    Password Пароль субаккаунта
    ContactGroupAccessType Тип прав на группы контактов
    ContactGroupIdsAccess Идентификаторы контактных групп, к которым устанавливаются права в свойстве ContactGroupAccessType, в случае Include или Exclude
    Emails Разрешённые email-адреса отправителя
    SenderIds Разрешённые имена отправителя СМС (Sender ID)
    FullName Полное имя пользователя субаккаунта
    AccessRights Права доступа
    Position Должность


  86. GET: /subAccounts/{login}

    Получить информацию о конкретном субаккунте

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Login Логин субаккаунта string

    Ответ

    Параметр Описание Тип
    Login Логин string
    FullName Полное имя string
    Email Email-адрес string
    Position Должность string
    AccessRights Права доступа string[] — EditContact, SmsSending, EmailSending, SingleSmsSending, EditContactGroup
    IsBlocked True — если субаккаунт заблокирован boolean

    Параметры
    apiKey api-Ключ
    Login Логин субаккаунта


  87. DELETE: /subAccounts/{login}

    Удалить субаккаунт

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Login Логин субаккаунта string

    Параметры
    apiKey api-Ключ
    Login Логин субаккаунта


  88. POST: /subAccounts/{login}

    Обновить сведения о субаккаунте

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

    Сведения о создаваемом субаккаунте, передаваемые в строке запроса

    Параметр Описание Тип
    Login Логин субаккаунта string

    Сведения о субаккаунте, подлежащие изменению, передаваемые в теле запроса

    Параметр Описание Тип
    Email Email-адрес субаккаунта string
    Password Пароль субаккаунта string
    FullName Полное имя пользователя субаккаунта string
    AccessRights Права доступа string[] — EditContact, SmsSending, EmailSending, SingleSmsSending, EditContactGroup
    Position Должность string

    Ответ

    Параметр Описание Тип
    Login Логин string
    FullName Полное имя string
    Email Email-адрес string
    Position Должность string
    AccessRights Права доступа string[] — EditContact, SmsSending, EmailSending, SingleSmsSending, EditContactGroup
    IsBlocked True — если субаккаунт заблокирован boolean

    Параметры
    apiKey api-Ключ
    Login Логин субаккаунта
    Email Email-адрес субаккаунта
    Password Пароль субаккаунта
    FullName Полное имя пользователя субаккаунта
    AccessRights Права доступа
    Position Должность


  89. POST: /subAccounts/{login}/delete

    Удалить субаккаунт

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Login Логин субаккаунта string

    Параметры
    apiKey api-Ключ
    Login Логин субаккаунта


  90. POST: /subAccounts/{login}/lock

    Заблокировать субаккаунт

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Login Логин субаккаунта string

    Параметры
    apiKey api-Ключ
    Login Логин субаккаунта


  91. POST: /subAccounts/{login}/unlock

    Разблокировать субаккаунт

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Login Логин субаккаунта string

    Параметры
    apiKey api-Ключ
    Login Логин субаккаунта


  92. GET: /emailTemplates

    Получить список Email шаблонов

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    SearchQuery Cтрока поиска шаблона по имени string
    Offset Количество начальных элементов в результате, которые надо пропустить (по умолчанию — 0) uint32
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50) uint32

    Ответ

    Параметр Описание Тип
    Items Выбранное подмножество элементов
    Id Идентификатор string
    Name Имя шаблона string
    Description Описание шаблона string
    Total Общее количество элементов int32

    Параметры
    apiKey api-Ключ
    SearchQuery Cтрока поиска шаблона по имени
    Offset Количество начальных элементов в результате, которые надо пропустить
    Limit Количество элементов, которые необходимо вернуть


  93. GET: /emailTemplates/{id}

    Получить Email шаблон по идентификатору

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Id Идентификатор шаблона. Его можно получить при помощи метода GET: /emailTemplates string

    Ответ

    Параметр Описание Тип
    Name Имя шаблона string
    BodyHtml Основной текст string
    AlternativeBodyHtml Альтернативный текст string
    CreatedDate Дата создания datetime
    Subject Основная тема string
    AlternativeSubject Альтернативная тема string

    Параметры
    apiKey api-Ключ
    Id Идентификатор шаблона


  94. GET: /emailTemplates/name/{name}

    Получить Email шаблон по имени

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

    Параметры, передаваемые в строке запроса

    Параметр Описание Тип
    Name Имя шаблона. Его можно получить при помощи метода GET: /emailTemplates string

    Ответ

    Параметр Описание Тип
    Name Имя шаблона string
    BodyHtml Основной текст string
    AlternativeBodyHtml Альтернативный текст string
    CreatedDate Дата создания datetime
    Subject Основная тема string
    AlternativeSubject Альтернативная тема string

    Параметры
    apiKey api-Ключ
    Name Имя шаблона


  95. GET: /automatedEmails

    Получить список цепочек

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Offset Количество начальных элементов в результате, которые надо пропустить uint32
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50) uint32

    Ответ

    Параметр Описание Тип
    Id Идентификатор цепочки string
    Title Название цепочки string
    ContactGroupId Идентификатор контактной группы, по которой запущена цепочка string
    ContactGroupName Название контактной группы, по которой запущена цепочка string
    ContactGroupIsRemoved Удалена ли группа? true — да, false — нет boolean
    FromAddress Электронный адрес, с которого отсылаются письма в цепочке string
    IsActive Активность цепочки. true — цепочка активирована, false — деактивирована boolean
    SubscriptionFormIds Формы подписки, с которых добавляются контакты string[]

    Параметры
    apiKey api-Ключ
    Offset Количество начальных элементов в результате, которые надо пропустить
    Limit Количество элементов, которые необходимо вернуть


  96. POST: /automatedEmails/{id}/launch/{contactIdOrEmail}

    Запустить конкретную цепочку для конкретного контакта

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Id Идентификатор цепочки string
    СontactIdOrEmail Идентификатор контакта или его электронная почта. Идентификатор контакта можно получить с помощью метода GET: /contactGroups/{id}/contacts string
    NotAgain Параметр необходимый для того, чтобы не запускать повторно цепочку для того или иного контакта. True — не запускать повторно, False — запускать повторно boolean

    Параметры
    apiKey api-Ключ
    Id Идентификатор цепочки
    СontactIdOrEmail Идентификатор контакта или его электронная почта
    NotAgain Параметр необходимый для того, чтобы не запускать повторно цепочку для того или иного контакта


  97. GET: /subscriptionForms/integrations

    Получить список зарегистрированных интеграций с внешними формами подписки

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

    Параметры, передаваемые через строку запроса

    Параметр Описание Тип
    Offset Количество начальных элементов в результате, которые надо пропустить uint32
    Limit Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50) uint32

    Ответ

    Параметр Описание Тип
    Id Идентификатор формы (интеграции) string
    Name Название формы (интеграции) string
    Key Уникальный ключ формы (интеграции), используемый для добавления контактов через неё string
    ContactGroupId Идентификатор группы, в которую попадают контакты string
    ContactGroupName Название группы, в которую попадаю контакты string
    ContactGroupDeleted True если группа, в которую попадают контакты, удалена boolean
    SendsConfirmation True если для добавления контакта через эту форму (интеграцию) требуется обязательное подтверждение контактом своего адреса email boolean

    Параметры
    apiKey api-Ключ
    Offset Количество начальных элементов в результате, которые надо пропустить
    Limit Количество элементов, которые необходимо вернуть


Пример

Вот пример PHP-кода для отправки одиночной СМС методом singleSms:


  1. <?  
  2.   
  3. header('Content-Type: text/html; charset=utf-8');  
  4.   
  5.   
  6. $apikey='DZA-Xtosz7HS2TYw';             // ваш API-ключ, регистрируется в личном кабинете  
  7.   
  8. $smstemplate= array(  
  9.       'PhoneNumber' => '79114022068',   // номер получателя  
  10.       'Text' => 'Проверка СМС',  
  11.       'SenderId' => 'TestSMS',          // ваше имя отправителя, должно быть зарегистрировано в личном кабинете  
  12.       'SendDateTime' => '',  
  13.       'UseRecepientTimeZone' => 'false'  
  14. );  
  15.   
  16.   
  17. $ch = curl_init();  
  18.   
  19. curl_setopt($ch, CURLOPT_URL,'https://api.aramba.ru/singleSms');  
  20. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);  
  21. curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);  
  22. curl_setopt($ch, CURLOPT_POST, 1);  
  23.   
  24. curl_setopt($ch, CURLOPT_HTTPHEADER, array(  
  25. 'Accept: application/json',  
  26. 'Content-Type: application/json',  
  27. 'Authorization: ApiKey '.$apikey));  
  28.   
  29. curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($smstemplate));  
  30. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);  
  31.   
  32. $response = curl_exec ($ch);  
  33. curl_close ($ch);  
  34.   
  35.   
  36. print_r($response);  
  37.   
  38. ?>  

Пример отправки одиночной СМС методом singleSms из Oktell
Oktell пример отправки

Oktell пример отправки