Сценарии

Список сценариев

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

Возвращает список сценариев в приложении, не более 20 штук.

Query Parameters

Name	Type	Description
api-key	string	Ключ доступа к API
offset	integer	Смещение списка сценариев

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

{
    "result": "success",
    "data": {
        "scenarios": [
            {
                "id": 1,
                "keys": [
                    "inline"
                ],
                "name": "",
                "created_at": 1582464167
            },
            {
                "id": 2,
                "keys": [
                    ""
                ],
                "name": "Ничего не подходит",
                "created_at": 1586250546
            },
            {
                "id": 3,
                "keys": [
                    "первый"
                ],
                "name": "",
                "created_at": 1586940709
            },
            {
                "id": 4,
                "keys": [
                    "второй2"
                ],
                "name": "",
                "created_at": 1586940724
            },
            {
                "id": 5,
                "keys": [
                    "test"
                ],
                "name": "",
                "created_at": 1588499151
            }
        ]
    }
}

Запуск сценария

POST https://api.chatgun.io/method/scenario/run/:scenarioId/:user_id?api-key=KEY

Запускает сценарий от имени пользователя.

Path Parameters

Name	Type	Description
:scenario_id	integer	ID сценария, который нужно запустить
:user_id	integer	ID пользователя на сайте vk.com, для которого нужно вызвать сценарий

Query Parameters

Name	Type	Description
api-key	string	Ключ доступа к API

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

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

{
    "result": "error",
    "error": "Undefined scenario",
    "code": 7
}

{
    "result": "error",
    "statusCode": 400,
    "error": {
        "title": "Bad Request",
        "message": "Missing required parameters: scenarioId, userId"
    }
}