活动通知

检索所有

GET https://notifyc.com/api/notifications/
curl --request GET \
--url 'https://notifyc.com/api/notifications/' \
--header 'Authorization: Bearer {api_key}' \
参数 细节 描述
search 可选的 字符串 搜索字符串。
search_by 可选的 字符串 您正在按哪个字段搜索。允许的值为：name。
is_enabled 可选的 布尔值
type 可选的 字符串 允许的值：informational, coupon, live_counter, email_collector, conversions, conversions_counter, video, audio, social_share, reviews, emoji_feedback, cookie_notification, score_feedback, request_collector, countdown_collector, custom_html, informational_bar, image, collector_bar, coupon_bar, button_bar, collector_modal, collector_two_modal, button_modal, text_feedback, engagement_links, whatsapp_chat, contact_us, informational_mini, informational_bar_mini, badge
datetime_field 可选的 字符串 允许的值：datetime, last_datetime
datetime_start 可选的 字符串 Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end 可选的 字符串 Filter results up to this datetime. Y-m-d H:i:s format.
order_by 可选的 字符串 按哪个字段排序结果。允许的值有：notification_id, datetime, last_datetime, name, impressions, hovers, clicks, form_submissions。
order_type 可选的 字符串 结果的排序。允许的值为：ASC 表示升序排序，DESC 表示降序排序。
page 可选的 整数 您想要结果的页码。默认为 1。
results_per_page 可选的 整数 每页您想要多少个结果。允许的值是：10, 25, 50, 100, 250, 500, 1000。默认为25。 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "campaign_id": 1,
            "notification_key": "Example",
            "name": "Example",
            "type": "Example",
            "settings": [],
            "impressions": 1,
            "hovers": 1,
            "clicks": 1,
            "form_submissions": 1,
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-10-21 00:33:25"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://notifyc.com/api/notifications?page=1",
        "last": "https://notifyc.com/api/notifications?page=1",
        "next": null,
        "prev": null,
        "self": "https://notifyc.com/api/notifications?page=1"
    }
}

检索一个

GET https://notifyc.com/api/notifications/{notification_id}
curl --request GET \
--url 'https://notifyc.com/api/notifications/{notification_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "campaign_id": 1,
        "notification_key": "Example",
        "name": "Example",
        "type": "Example",
        "settings": [],
        "impressions": 1,
        "hovers": 1,
        "clicks": 1,
        "form_submissions": 1,
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-21 00:33:25"
    }
}

创建

POST https://notifyc.com/api/notifications
参数 细节 描述
campaign_id 必需 整数 -
type 必需 字符串 允许的值：informational, coupon, live_counter, email_collector, conversions, conversions_counter, video, audio, social_share, reviews, emoji_feedback, cookie_notification, score_feedback, request_collector, countdown_collector, custom_html, informational_bar, image, collector_bar, coupon_bar, button_bar, collector_modal, collector_two_modal, button_modal, text_feedback, engagement_links, whatsapp_chat, contact_us, informational_mini, informational_bar_mini, badge
name 可选的 字符串 -
is_enabled 可选的 布尔值 -
curl --request POST \
--url 'https://notifyc.com/api/notifications' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'type=informational' \
--form 'is_enabled=1' 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "campaign_id": 1,
        "notification_key": "Example",
        "name": "Example",
        "type": "Example",
        "settings": {},
        "impressions": "Example",
        "hovers": "Example",
        "clicks": 1,
        "form_submissions": "Example",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-21 00:33:25"
    }
}

更新

POST https://notifyc.com/api/notifications/{notification_id}
参数 细节 描述
name 可选的 字符串 -
is_enabled 可选的 布尔值 -
trigger_all_pages 可选的 布尔值 -
display_trigger 可选的 字符串 允许的值：delay, time_on_site, pageviews, inactivity, exit_intent, scroll, target_visible, click, hover
display_trigger_value 可选的 字符串 -
display_trigger_selector 可选的 字符串 可用时间：display_trigger = target_visible
display_delay_type_after_close 可选的 字符串 允许的值：time_on_site, pageviews
display_delay_value_after_close 可选的 整数 -
display_focus 可选的 布尔值 -
display_focus_behavior 可选的 字符串 允许的值：visual_only, outside_click_unfocus, lock_until_interaction
display_frequency 可选的 字符串 允许的值：all_time, once_per_session, once_per_browser
direction 可选的 字符串 允许的值：rtl, ltr
display_continents 可选的 数组 字符串 -
display_countries 可选的 数组 字符串 -
display_languages 可选的 数组 字符串 -
display_operating_systems 可选的 数组 字符串 -
display_browsers 可选的 数组 字符串 -
display_cities 可选的 数组 字符串 -
display_mobile 可选的 布尔值 -
display_desktop 可选的 布尔值 -
schedule 可选的 布尔值 -
start_date 可选的 字符串 -
end_date 可选的 字符串 -
display_duration 可选的 整数 -
display_position 可选的 字符串 允许的值：top_left, top_center, top_right, middle_left, middle_center, middle_right, bottom_left, bottom_center, bottom_right, top, bottom, top_floating, bottom_floating
display_close_button 可选的 布尔值 -
close_button_color 可选的 字符串 -
dark_mode_close_button_color 可选的 字符串 -
display_branding 可选的 布尔值 -
shadow 可选的 字符串 允许的值：, subtle, feather, 3d, layered
border_width 可选的 整数 允许的值：0, 1, 2, 3, 4, 5
internal_padding 可选的 整数 允许的值：5-25
background_blur 可选的 整数 允许的值：0-30
custom_css 可选的 字符串 -
hover_animation 可选的 字符串 允许的值：, fast_scale_up, slow_scale_up, fast_scale_down, slow_scale_down
on_animation 可选的 字符串 允许的值：fadeIn, slideInUp, slideInDown, zoomIn, bounceIn
off_animation 可选的 字符串 允许的值：fadeOut, slideOutUp, slideOutDown, zoomOut, bounceOut
animation 可选的 字符串 允许的值：, heartbeat, bounce, flash, pulse
animation_interval 可选的 整数 -
font 可选的 字符串 允许的值：inherit, Arial, Verdana, Helvetica, Tahoma, Trebuchet MS, Times New Roman, Georgia, Courier New, Monaco, Comic Sans MS, Courier, Impact, Futura, Luminari, Baskerville, Papyrus
border_radius 可选的 字符串 允许的值：straight, rounded, highly_rounded, round
dark_mode_is_enabled 可选的 布尔值
notifications 可选的 数组 可用时间：type = email_collector, collector_bar, collector_modal, collector_two_modal, conversions, inline_conversions, conversions_counter, inline_conversions_counter, countdown_collector, request_collector, text_feedback 通知处理程序 ID
translations[input_key][index]['key'] 可选的 字符串 Available for all the marked for translation fields.
translations[input_key][index]['value'] 可选的 字符串 Available for all the marked for translation fields.
conversions / inline_conversions
title 可选的 字符串 可用时间：type = conversions, inline_conversions
description 可选的 字符串 可用时间：type = conversions, inline_conversions
image 可选的 文件 可用时间：type = conversions, inline_conversions
image_alt 可选的 字符串 可用时间：type = conversions, inline_conversions
url 可选的 字符串 可用时间：type = conversions, inline_conversions
display_time 可选的 布尔值 可用时间：type = conversions, inline_conversions
url_new_tab 可选的 布尔值 可用时间：type = conversions, inline_conversions
conversions_count 可选的 整数 可用时间：type = conversions, inline_conversions
in_between_delay 可选的 整数 可用时间：type = conversions, inline_conversions
order 可选的 字符串 可用时间：type = conversions, inline_conversions
允许的值：random, descending
data_trigger_auto 可选的 布尔值 可用时间：type = conversions, inline_conversions
data_trigger_auto_type[index] 可选的 数组 字符串 可用时间：type = conversions, inline_conversions
允许的值：exact, contains, starts_with, ends_with
data_trigger_auto_value[index] 可选的 数组 字符串 可用时间：type = conversions, inline_conversions
title_color 可选的 字符串 可用时间：type = conversions, inline_conversions
description_color 可选的 字符串 可用时间：type = conversions, inline_conversions
date_color 可选的 字符串 可用时间：type = conversions, inline_conversions
background_color 可选的 字符串 可用时间：type = conversions, inline_conversions
border_color 可选的 字符串 可用时间：type = conversions, inline_conversions
shadow_color 可选的 字符串 可用时间：type = conversions, inline_conversions
dark_mode_title_color 可选的 字符串 可用时间：type = conversions, inline_conversions
dark_mode_description_color 可选的 字符串 可用时间：type = conversions, inline_conversions
dark_mode_date_color 可选的 字符串 可用时间：type = conversions, inline_conversions
dark_mode_background_color 可选的 字符串 可用时间：type = conversions, inline_conversions
dark_mode_border_color 可选的 字符串 可用时间：type = conversions, inline_conversions
dark_mode_shadow_color 可选的 字符串 可用时间：type = conversions, inline_conversions
data_trigger_auto 可选的 布尔值 可用时间：type = conversions counter
data_trigger_auto_type[index] 可选的 数组 字符串 可用时间：type = conversions, inline_conversions
允许的值：exact, contains, starts_with, ends_with
data_trigger_auto_value[index] 可选的 数组 字符串 可用时间：type = conversions, inline_conversions
rating_summary / inline_rating_summary
description 可选的 字符串 可用时间：type = rating_summary, inline_rating_summary Translatable
average_rating 可选的 浮动 可用时间：type = rating_summary, inline_rating_summary
reviews_count 可选的 api_documentation.integer 可用时间：type = rating_summary, inline_rating_summary
display_minimum_reviews 可选的 api_documentation.integer 可用时间：type = rating_summary, inline_rating_summary
url 可选的 字符串 可用时间：type = rating_summary, inline_rating_summary
url_new_tab 可选的 布尔值 可用时间：type = rating_summary, inline_rating_summary
selector 可选的 字符串 可用时间：type = inline_rating_summary
inline_placement 可选的 字符串 可用时间：type = inline_rating_summary
rating_color 可选的 字符串 可用时间：type = rating_summary, inline_rating_summary
rating_background_color 可选的 字符串 可用时间：type = rating_summary, inline_rating_summary
stars_color 可选的 字符串 可用时间：type = rating_summary, inline_rating_summary
description_color 可选的 字符串 可用时间：type = rating_summary, inline_rating_summary
background_color 可选的 字符串 可用时间：type = rating_summary, inline_rating_summary
border_color 可选的 字符串 可用时间：type = rating_summary, inline_rating_summary
shadow_color 可选的 字符串 可用时间：type = rating_summary, inline_rating_summary
dark_mode_rating_color 可选的 字符串 可用时间：type = rating_summary, inline_rating_summary
dark_mode_rating_background_color 可选的 字符串 可用时间：type = rating_summary, inline_rating_summary
dark_mode_stars_color 可选的 字符串 可用时间：type = rating_summary, inline_rating_summary
dark_mode_description_color 可选的 字符串 可用时间：type = rating_summary, inline_rating_summary
dark_mode_background_color 可选的 字符串 可用时间：type = rating_summary, inline_rating_summary
dark_mode_border_color 可选的 字符串 可用时间：type = rating_summary, inline_rating_summary
dark_mode_shadow_color 可选的 字符串 可用时间：type = rating_summary, inline_rating_summary
telegram_chat
title 可选的 字符串 可用时间：type = telegram_chat
agent_image 可选的 文件 可用时间：type = telegram_chat
agent_image_alt 可选的 字符串 可用时间：type = telegram_chat
agent_name 可选的 字符串 可用时间：type = telegram_chat Translatable
agent_description 可选的 字符串 可用时间：type = telegram_chat Translatable
agent_message 可选的 字符串 可用时间：type = telegram_chat Translatable
agent_telegram 可选的 字符串 可用时间：type = telegram_chat Translatable
button_text 可选的 字符串 可用时间：type = telegram_chat Translatable
header_agent_name_color 可选的 字符串 可用时间：type = telegram_chat
header_agent_description_color 可选的 字符串 可用时间：type = telegram_chat
header_background_color 可选的 字符串 可用时间：type = telegram_chat
content_background_color 可选的 字符串 可用时间：type = telegram_chat
content_agent_name_color 可选的 字符串 可用时间：type = telegram_chat
content_agent_message_color 可选的 字符串 可用时间：type = telegram_chat
content_agent_message_background_color 可选的 字符串 可用时间：type = telegram_chat
footer_background_color 可选的 字符串 可用时间：type = telegram_chat
footer_button_background_color 可选的 字符串 可用时间：type = telegram_chat
footer_button_color 可选的 字符串 可用时间：type = telegram_chat
title_color 可选的 字符串 可用时间：type = telegram_chat
background_color 可选的 字符串 可用时间：type = telegram_chat
border_color 可选的 字符串 可用时间：type = telegram_chat
shadow_color 可选的 字符串 可用时间：type = telegram_chat
dark_mode_header_agent_name_color 可选的 字符串 可用时间：type = telegram_chat
dark_mode_header_agent_description_color 可选的 字符串 可用时间：type = telegram_chat
dark_mode_header_background_color 可选的 字符串 可用时间：type = telegram_chat
dark_mode_content_background_color 可选的 字符串 可用时间：type = telegram_chat
dark_mode_content_agent_name_color 可选的 字符串 可用时间：type = telegram_chat
dark_mode_content_agent_message_color 可选的 字符串 可用时间：type = telegram_chat
dark_mode_content_agent_message_background_color 可选的 字符串 可用时间：type = telegram_chat
dark_mode_footer_background_color 可选的 字符串 可用时间：type = telegram_chat
dark_mode_footer_button_background_color 可选的 字符串 可用时间：type = telegram_chat
dark_mode_footer_button_color 可选的 字符串 可用时间：type = telegram_chat
dark_mode_title_color 可选的 字符串 可用时间：type = telegram_chat
dark_mode_background_color 可选的 字符串 可用时间：type = telegram_chat
dark_mode_border_color 可选的 字符串 可用时间：type = telegram_chat
dark_mode_shadow_color 可选的 字符串 可用时间：type = telegram_chat
facebook_messenger_chat
display_continents 可选的 字符串 -
display_countries 可选的 字符串 -
display_languages 可选的 字符串 -
display_operating_systems 可选的 字符串 -
display_browsers 可选的 字符串 -
display_cities 可选的 字符串 -
infinite_rotation 可选的 字符串 -
video_is_vimeo 可选的 字符串 -
vimeo_video_id 可选的 整数 -
badge_text 可选的 字符串 -
hint_text 可选的 字符串 -
items 可选的 数组 -
trigger_type 可选的 字符串 -
trigger_value 可选的 整数 -
border_color 可选的 字符串 -
dark_mode_border_color 可选的 字符串 -
shadow_color 可选的 字符串 -
dark_mode_shadow_color 可选的 字符串 -
title_color 可选的 字符串 -
description_color 可选的 字符串 -
background_color 可选的 字符串 -
dark_mode_title_color 可选的 字符串 -
dark_mode_description_color 可选的 字符串 -
dark_mode_background_color 可选的 字符串 -
margin_top 可选的 字符串 -
margin_right 可选的 字符串 -
margin_bottom 可选的 字符串 -
margin_left 可选的 字符串 -
button_background_color 可选的 字符串 -
button_color 可选的 字符串 -
dark_mode_button_background_color 可选的 字符串 -
dark_mode_button_color 可选的 字符串 -
number_background_color 可选的 字符串 -
number_color 可选的 字符串 -
pulse_background_color 可选的 字符串 -
dark_mode_number_background_color 可选的 字符串 -
dark_mode_number_color 可选的 字符串 -
dark_mode_pulse_background_color 可选的 字符串 -
date_color 可选的 字符串 -
dark_mode_date_color 可选的 字符串 -
rating_color 可选的 字符串 -
rating_background_color 可选的 字符串 -
stars_color 可选的 字符串 -
dark_mode_rating_color 可选的 字符串 -
dark_mode_rating_background_color 可选的 字符串 -
dark_mode_stars_color 可选的 字符串 -
content_title_color 可选的 字符串 -
content_description_color 可选的 字符串 -
dark_mode_content_title_color 可选的 字符串 -
dark_mode_content_description_color 可选的 字符串 -
time_color 可选的 字符串 -
time_background_color 可选的 字符串 -
dark_mode_time_color 可选的 字符串 -
dark_mode_time_background_color 可选的 字符串 -
coupon_code_color 可选的 字符串 -
coupon_code_background_color 可选的 字符串 -
coupon_code_border_color 可选的 字符串 -
dark_mode_coupon_code_color 可选的 字符串 -
dark_mode_coupon_code_background_color 可选的 字符串 -
dark_mode_coupon_code_border_color 可选的 字符串 -
categories_title_color 可选的 字符串 -
categories_description_color 可选的 字符串 -
categories_links_title_color 可选的 字符串 -
categories_links_description_color 可选的 字符串 -
categories_links_background_color 可选的 字符串 -
categories_links_border_color 可选的 字符串 -
dark_mode_categories_title_color 可选的 字符串 -
dark_mode_categories_description_color 可选的 字符串 -
dark_mode_categories_links_title_color 可选的 字符串 -
dark_mode_categories_links_description_color 可选的 字符串 -
dark_mode_categories_links_background_color 可选的 字符串 -
dark_mode_categories_links_border_color 可选的 字符串 -
badge_background_color 可选的 字符串 -
badge_color 可选的 字符串 -
hint_background_color 可选的 字符串 -
hint_color 可选的 字符串 -
item_question_color 可选的 字符串 -
item_answer_color 可选的 字符串 -
item_background_color 可选的 字符串 -
item_border_color 可选的 字符串 -
dark_mode_badge_background_color 可选的 字符串 -
dark_mode_badge_color 可选的 字符串 -
dark_mode_hint_background_color 可选的 字符串 -
dark_mode_hint_color 可选的 字符串 -
dark_mode_item_question_color 可选的 字符串 -
dark_mode_item_answer_color 可选的 字符串 -
dark_mode_item_background_color 可选的 字符串 -
dark_mode_item_border_color 可选的 字符串 -
header_agent_name_color 可选的 字符串 -
header_agent_description_color 可选的 字符串 -
header_background_color 可选的 字符串 -
content_background_color 可选的 字符串 -
content_agent_name_color 可选的 字符串 -
content_agent_message_color 可选的 字符串 -
content_agent_message_background_color 可选的 字符串 -
footer_background_color 可选的 字符串 -
footer_button_background_color 可选的 字符串 -
footer_button_color 可选的 字符串 -
dark_mode_header_agent_name_color 可选的 字符串 -
dark_mode_header_agent_description_color 可选的 字符串 -
dark_mode_header_background_color 可选的 字符串 -
dark_mode_content_background_color 可选的 字符串 -
dark_mode_content_agent_name_color 可选的 字符串 -
dark_mode_content_agent_message_color 可选的 字符串 -
dark_mode_content_agent_message_background_color 可选的 字符串 -
dark_mode_footer_background_color 可选的 字符串 -
dark_mode_footer_button_background_color 可选的 字符串 -
dark_mode_footer_button_color 可选的 字符串 -
curl --request POST \
--url 'https://notifyc.com/api/notifications/{notification_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=example' \
--form 'is_enabled=1' 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "campaign_id": 1,
        "notification_key": "Example",
        "name": "Example",
        "type": "Example",
        "settings": {},
        "impressions": 1,
        "hovers": 1,
        "clicks": 1,
        "form_submissions": 1,
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-21 00:33:25"
    }
}

删除

DELETE https://notifyc.com/api/notifications/{notification_id}
curl --request DELETE \
--url 'https://notifyc.com/api/notifications/{notification_id}' \
--header 'Authorization: Bearer {api_key}' \