В SailPlay реализован механизм для типизации коммуникаций с клиентами (т.е. разделение по разным настраиваемым признакам всех сообщений, которые отправляются конечным пользователям). Типы коммуникаций привязываются к цепочкам, рассылкам и конкретным сообщениям.

Существуют несколько системных типов коммуникаций: корневой тип "Канал коммуникации", в который вложены "email", "sms", "viber" и другие.

Методы

  • /api/v2/sender/subscribes/subscribe/ - подписка клиента на типы коммуникаций
  • /api/v2/sender/subscribes/unsubscribe/ - отписка клиента от типов коммуникаций

В SailPlay реализован механизм подписок и отписок клиентов от типов коммуникаций. Клиент не получает рассылки по типам коммуникаций, от которых он отписан.

/api/v2/sender/subscribes/subscribe/ - подписка клиента на типы коммуникаций

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

Параметр обязательный? Имя параметра Описание параметра
да user_phone, email или origin_user_id  Идентификатор клиента. Более подробно см. здесь.
да token  см. здесь
да store_department_id  см. здесь
да communication_types  Массив типов коммуникаций на которые будет подписан клиент

Ответ сервера

Название параметра Описание параметра
status  "ok" или "error"
processed_count  Количество типов коммуникаций, на которые был успешно подписан клиент

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

http://sailplay.ru/api/v2/sender/subscribes/subscribe?token=XXX&store_department_id=YYY&email=ZZZ&communication_types=["a1","a2","a3"]

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

В случае успеха:

{
    "status": "ok",
"processed_count": 3
}

В случае, если клиент не найден:

{
    "status": "error",
    "status_code": -4000,
    "message": "User not found"
}

В случае, если тип коммуникации не существует, он будет пропущен и в "processed_count" учитываться не будет.

 

/api/v2/sender/subscribes/unsubscribe/ - отписка клиента от типов коммуникаций

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

Параметр обязательный? Имя параметра Описание параметра
да user_phone, email или origin_user_id  Идентификатор клиента. Более подробно см. здесь.
да token  см. здесь
да store_department_id  см. здесь
да communication_types  Массив типов коммуникаций от которых будет отписан клиент

Ответ сервера

Название параметра Описание параметра
status  "ok" или "error"
processed_count  Количество типов коммуникаций, от которых был успешно отписан клиент

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

http://sailplay.ru/api/v2/sender/subscribes/unsubscribe?token=XXX&store_department_id=YYY&email=ZZZ&communication_types=["a1","a2","a3"]

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

В случае успеха:

{
    "status": "ok",
"processed_count": 3
}

В случае, если клиент не найден:

{
    "status": "error",
    "status_code": -4000,
    "message": "User not found"
}

В случае, если тип коммуникации не существует, он будет пропущен и в "processed_count" учитываться не будет.