Списки подписчиков

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

GET https://api.chatgun.io/method/dispatch-list/get?api-key=KEY

Этот метод возвращает все списки подписчиков, которые есть в приложении вашего сообщества

Query Parameters

Name	Type	Description
api-key	string

200 Возможные варианты ответа.

{
    "result": "success",
    "data": {
        "lists": [
            {
                "subscribers_count": 155,
                "id": 79,
                "type": 1,
                "name": "Все, кто писал сообществу"
            },
            {
                "subscribers_count": 0,
                "id": 86,
                "type": 2,
                "name": "Первый список"
            },
            {
                "subscribers_count": 0,
                "id": 87,
                "type": 2,
                "name": "Второй список"
            }
        ]
    }
}

Добавить подписчика в список

POST https://api.chatgun.io/method/dispatch-list/insert-user/:list_id/:user_id?api-key=KEY

Добавление пользователя в список подписчиков, если этот пользователь уже есть в выбранном списке - вернется ошибка.

Path Parameters

Name	Type	Description
:user_id	integer	ID пользователя из vk.com, которого нужно добавить в список.
:list_id	integer	ID списка подписчиков, список доступных списков можно получить из get метода.

Query Parameters

Name	Type	Description
api-key	string

200 Возможные варианта ответа.

{
    "result": "success",
    "data": {}
}

{
    "result": "error",
    "error": "Undefined dispatch list id",
    "code": 4
}

{
    "result": "error",
    "error": "User already exist in dispatch list",
    "code": 5
}

Удалить подписчика из списка

POST https://api.chatgun.io/method/dispatch-list/remove-user/:list_id/:user_id?api-key=KEY

Удаление пользователя из списка подписчиков, если пользователь не находится в нем или уже был удален - вернется ошибка.

Path Parameters

Name	Type	Description
:user_id	integer	ID пользователя из vk.com, которого нужно добавить в список.
:list_id	integer	ID списка подписчиков, список доступных списков можно получить из get метода.

Query Parameters

Name	Type	Description
api-key	string

200 Возможные варианта ответа.

{
    "result": "success",
    "data": {}
}

{
    "result": "error",
    "error": "Undefined dispatch list id",
    "code": 4
}

{
    "result": "error",
    "error": "User not exist in dispatch list",
    "code": 6
}