流程

检索全部

GET https://push.btools.online/api/flows/
curl --request GET \
--url 'https://push.btools.online/api/flows/' \
--header 'Authorization: Bearer {api_key}' \
参数 详情 描述
page 可选 整数 您想要获取结果的页码。默认为 1。
results_per_page 可选 整数 每页您想要多少结果。允许的值为：10 , 25 , 50 , 100 , 250 , 500 , 1000。默认值为 25。 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "website_id": 1,
            "name": "Example",
            "title": "Sample message",
            "description": "This is coming from the API.",
            "url": "https://example.com",
            "image_url": null,
            "settings": {
                "ttl": 2419200,
                "urgency": "normal",
                "is_silent": 0,
                "is_auto_hide": 0,
                "button_title_1": "",
                "button_url_1": "",
                "button_title_2": "",
                "button_url_2": ""
            },
            "wait_time": 3,
            "wait_time_type": "days",
            "is_enabled": true,
            "total_sent_push_notifications": 0,
            "total_displayed_push_notifications": 0,
            "total_clicked_push_notifications": 0,
            "total_closed_push_notifications": 0,
            "last_sent_datetime": null,
            "last_datetime": null,
            "datetime": "2025-12-21 12:15:30",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://push.btools.online/api/flows?page=1",
        "last": "https://push.btools.online/api/flows?page=1",
        "next": null,
        "prev": null,
        "self": "https://push.btools.online/api/flows?page=1"
    }
}

检索一个

GET https://push.btools.online/api/flows/{flow_id}
curl --request GET \
--url 'https://push.btools.online/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "website_id": 1,
        "name": "Example",
        "title": "Sample message",
        "description": "This is coming from the API.",
        "url": "https://example.com",
        "image_url": null,
        "settings": {
            "ttl": 2419200,
            "urgency": "normal",
            "is_silent": 0,
            "is_auto_hide": 0,
            "button_title_1": "",
            "button_url_1": "",
            "button_title_2": "",
            "button_url_2": ""
        },
        "wait_time": 3,
        "wait_time_type": "days",
        "is_enabled": true,
        "total_sent_push_notifications": 0,
        "total_displayed_push_notifications": 0,
        "total_clicked_push_notifications": 0,
        "total_closed_push_notifications": 0,
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2025-12-21 12:15:30",
    }
}

创建

POST https://push.btools.online/api/flows
参数 详情 描述
website_id 必填 整数 -
name 必填 字符串 -
title 必填 字符串 -
description 必填 字符串 -
url 可选 字符串 -
image 可选 文件 -
wait_time 必填 整数 -
wait_time_type 必填 字符串 允许的值：minutes , hours , days
button_title_1 可选 字符串 -
button_url_1 可选 字符串 -
button_title_2 可选 字符串 -
button_url_2 可选 字符串 -
is_silent 可选 布尔值 -
is_auto_hide 可选 布尔值 -
ttl 可选 字符串 允许的值：0 , 900 , 1800 , 3600 , 10800 , 21600 , 43200 , 86400 , 259200 , 432000 , 604800 , 1209600 , 2419200
utm_source 可选 字符串 -
utm_medium 可选 字符串 -
utm_campaign 可选 字符串 -
segment 可选 字符串 允许的值：all , INT segment_id
is_enabled 可选 布尔值 -
curl --request POST \
--url 'https://push.btools.online/api/flows' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
--form 'segment=all' \
{
    "data": {
        "id": 1
    }
}

更新

POST https://push.btools.online/api/flows/{flow_id}
参数 详情 描述
website_id 可选 整数 -
name 可选 字符串 -
title 可选 字符串 -
description 可选 字符串 -
url 可选 字符串 -
image 可选 文件 -
wait_time 可选 整数 -
wait_time_type 可选 字符串 允许的值：minutes , hours , days
button_title_1 可选 字符串 -
button_url_1 可选 字符串 -
button_title_2 可选 字符串 -
button_url_2 可选 字符串 -
is_silent 可选 布尔值 -
is_auto_hide 可选 布尔值 -
ttl 可选 字符串 允许的值：0 , 900 , 1800 , 3600 , 10800 , 21600 , 43200 , 86400 , 259200 , 432000 , 604800 , 1209600 , 2419200
utm_source 可选 字符串 -
utm_medium 可选 字符串 -
utm_campaign 可选 字符串 -
segment 可选 字符串 允许的值：all , INT segment_id
is_enabled 可选 布尔值 -
curl --request POST \
--url 'https://push.btools.online/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
--form 'segment=all' \
{
    "data": {
        "id": 1
    }
}

删除

DELETE https://push.btools.online/api/flows/{flow_id}
curl --request DELETE \
--url 'https://push.btools.online/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \