HOOK文档

本页汇总智简魔方财务系统中“HOOK 文档”相关文档，便于读者按现有分类快速查找具体说明。

本文档包含以下内容：

一、交易流水

二、模块命令

三、定时任务

四、产品服务

五、账单

六、购物车

七、客户

八、管理员

九、工单

十、其他

一、交易流水

后台手动添加交易流水后执行

after_admin_add_account

后台手动添加交易流水之后执行

请求参数:

参数名称	类型	说明
account_id	整型	交易流水 ID
amount_in	浮点型	收入
amount_out	浮点型	支出
currency	字符串	货币代码
description	字符串	描述
trans_id	字符串	付款流水号
invoice_id	整型	账单 ID
gateway	字符串	付款方式
refund	整型	是否退款到余额
uid	整型	用户ID

响应:

无

示范代码:

<?php
add_hook('after_admin_add_account', 1, function($vars) {
    // Perform hook code here...
});

后台手动编辑交易流水后执行

after_admin_edit_account

后台手动编辑交易流水之后执行

请求参数:

参数名称	类型	说明
account_id	整型	交易流水 ID
amount_in	浮点型	收入
amount_out	浮点型	支出
invoice_id	整型	账单 ID
gateway	字符串	付款方式

响应:

无

示范代码:

<?php
add_hook('after_admin_edit_account', 1, function($vars) {
    // Perform hook code here...
});

后台手动删除交易流水后执行

after_admin_delete_account

后台手动删除交易流水之后执行

请求参数:

参数名称	类型	说明
account_id	整型	交易流水 ID

响应:

无

示范代码:

<?php
add_hook('after_admin_delete_account', 1, function($vars) {
    // Perform hook code here...
});

二、模块命令

模块升降级成功之后执行

after_module_change_package

模块升降级成功之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

无

示范代码:

<?php
add_hook('after_module_change_package', 1, function($vars) {
    // Perform hook code here...
});

模块升降级失败之后执行

after_module_change_package_failed

模块升降级失败之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params
msg	字符串	失败原因

响应:

无

示范代码:

<?php
add_hook('after_module_change_package_failed', 1, function($vars) {
    // Perform hook code here...
});

模块重置密码成功之后执行

after_module_crack_password

模块重置密码成功之后执行

请求参数:

参数名称	类型	说明
hostid	整型	产品 ID
oldpassword	字符串	原密码
newspassword	字符串	新密码

响应:

无

示范代码:

<?php
add_hook('after_module_crack_password', 1, function($vars) {
    // Perform hook code here...
});

模块重置密码失败之后执行

after_module_crack_password_failed

模块重置密码失败之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params
msg	字符串	失败原因

响应:

无

示范代码:

<?php
add_hook('after_module_crack_password_failed', 1, function($vars) {
    // Perform hook code here...
});

模块开通成功之后执行

after_module_create

模块开通成功之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

无

示范代码:

<?php
add_hook('after_module_create', 1, function($vars) {
    // Perform hook code here...
});

模块开通失败之后执行

after_module_create_failed

模块开通失败之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params
msg	字符串	失败原因

响应:

无

示范代码:

<?php
add_hook('after_module_crack_failed', 1, function($vars) {
    // Perform hook code here...
});

模块暂停成功之后执行

after_module_suspend

模块暂停成功之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

无

示范代码:

<?php
add_hook('after_module_suspend', 1, function($vars) {
    // Perform hook code here...
});

模块暂停失败之后执行

after_module_suspend_failed

模块暂停失败之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params
msg	字符串	失败原因

响应:

无

示范代码:

<?php
add_hook('after_module_suspend_failed', 1, function($vars) {
    // Perform hook code here...
});

模块删除成功之后执行

after_module_terminate

模块删除成功之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

无

示范代码:

<?php
add_hook('after_module_terminate', 1, function($vars) {
    // Perform hook code here...
});

模块删除失败之后执行

after_module_terminate_failed

模块删除失败之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params
msg	字符串	失败原因

响应:

无

示范代码:

<?php
add_hook('after_module_terminate_failed', 1, function($vars) {
    // Perform hook code here...
});

模块解除暂停成功之后执行

after_module_unsuspend

模块解除暂停成功之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

无

示范代码:

<?php
add_hook('after_module_unsuspend', 1, function($vars) {
    // Perform hook code here...
});

模块解除暂停之后执行

after_module_unsuspend_failed

模块解除暂停之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params
msg	字符串	失败原因

响应:

无

示范代码:

<?php
add_hook('after_module_unsuspend_failed', 1, function($vars) {
    // Perform hook code here...
});

模块开机成功之后执行

after_module_on

模块开机成功之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

无

示范代码:

<?php
add_hook('after_module_on', 1, function($vars) {
    // Perform hook code here...
});

模块开机失败之后执行

after_module_on_failed

模块开机失败之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params
msg	字符串	失败原因

响应:

无

示范代码:

<?php
add_hook('after_module_on_failed', 1, function($vars) {
    // Perform hook code here...
});

模块关机成功之后执行

after_module_off

模块关机成功之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

无

示范代码:

<?php
add_hook('after_module_off', 1, function($vars) {
    // Perform hook code here...
});

模块关机失败之后执行

after_module_off_failed

模块关机失败之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params
msg	字符串	失败原因

响应:

无

示范代码:

<?php
add_hook('after_module_off_failed', 1, function($vars) {
    // Perform hook code here...
});

模块重启成功之后执行

after_module_reboot

模块重启成功之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

无

示范代码:

<?php
add_hook('after_module_reboot', 1, function($vars) {
    // Perform hook code here...
});

模块重启失败之后执行

after_module_reboot_failed

模块重启失败之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params
msg	字符串	失败原因

响应:

无

示范代码:

<?php
add_hook('after_module_reboot_failed', 1, function($vars) {
    // Perform hook code here...
});

模块硬关机成功之后执行

after_module_hard_off

模块硬关机成功之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

无

示范代码:

<?php
add_hook('after_module_hard_off', 1, function($vars) {
    // Perform hook code here...
});

模块硬关机失败之后执行

after_module_hard_off_failed

模块硬关机失败之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params
msg	字符串	失败原因

响应:

无

示范代码:

<?php
add_hook('after_module_hard_off_failed', 1, function($vars) {
    // Perform hook code here...
});

模块硬重启成功之后执行

after_module_hard_reboot

模块硬重启成功之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

无

示范代码:

<?php
add_hook('after_module_hard_reboot', 1, function($vars) {
    // Perform hook code here...
});

模块硬重启失败之后执行

after_module_hard_reboot_failed

模块硬重启失败之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params
msg	字符串	失败原因

响应:

无

示范代码:

<?php
add_hook('after_module_hard_reboot_failed', 1, function($vars) {
    // Perform hook code here...
});

模块重装系统成功之后执行

after_module_reinstall

模块重装系统成功之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

无

示范代码:

<?php
add_hook('after_module_reinstall', 1, function($vars) {
    // Perform hook code here...
});

模块重装系统失败之后执行

after_module_reinstall_failed

模块重装系统失败之后执行

请求参数:

参数名称	类型	说明
param s	数组	参考模块开发的params
msg	字符串	失败原因

响应:

无

示范代码:

<?php
add_hook('after_module_reinstall_failed', 1, function($vars) {
    // Perform hook code here...
});

模块救援系统成功之后执行

after_module_rescue_system

模块救援系统成功之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

无

示范代码:

<?php
add_hook('after_module_rescue_system', 1, function($vars) {
    // Perform hook code here...
});

模块救援系统失败之后执行

after_module_rescue_system_failed

模块救援系统失败之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params
msg	字符串	失败原因

响应:

无

示范代码:

<?php
add_hook('after_module_rescue_system_failed', 1, function($vars) {
    // Perform hook code here...
});

模块拉取信息成功之后执行

after_module_sync

模块拉取信息成功之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

无

示范代码:

<?php
add_hook('after_module_sync', 1, function($vars) {
    // Perform hook code here...
});

模块拉取信息失败之后执行

after_module_sync_failed

模块拉取信息失败之后执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params
msg	字符串	失败原因

响应:

无

示范代码:

<?php
add_hook('after_module_sync_failed', 1, function($vars) {
    // Perform hook code here...
});

模块升降级之前执行

before_module_change_package

模块升降级之前执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

返回键值对,键值对将会覆盖原来相同键的 params,返回 exit_module=true 将会中断模块方法

示范代码:

<?php
add_hook('before_module_change_package', 1, function($vars) {
    // Perform hook code here...
});

模块重置密码之前执行

before_module_crack_password

模块重置密码之前执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

返回键值对,键值对将会覆盖原来相同键的 params,返回 exit_module=true 将会中断模块方法

示范代码:

<?php
add_hook('before_module_crack_password', 1, function($vars) {
    // Perform hook code here...
});

模块开通之前执行

before_module_create

模块开通之前执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

返回键值对,键值对将会覆盖原来相同键的 params,返回 exit_module=true 将会中断模块方法

示范代码:

<?php
add_hook('before_module_create', 1, function($vars) {
    // Perform hook code here...
});

模块续费之前执行

before_module_renew

模块续费之前执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

返回键值对,键值对将会覆盖原来相同键的 params,返回 exit_module=true 将会中断模块方法

示范代码:

<?php
add_hook('before_module_renew', 1, function($vars) {
    // Perform hook code here...
});

模块暂停之前执行

before_module_suspend

模块续费之前执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

返回键值对,键值对将会覆盖原来相同键的 params,返回 exit_module=true 将会中断模块方法

示范代码:

<?php
add_hook('before_module_suspend', 1, function($vars) {
    // Perform hook code here...
});

模块删除之前执行

before_module_terminate

模块删除之前执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

返回键值对,键值对将会覆盖原来相同键的 params,返回 exit_module=true 将会中断模块方法

示范代码:

<?php
add_hook('before_module_terminate', 1, function($vars) {
    // Perform hook code here...
});

模块解除暂停之前执行

before_module_unsuspend

模块解除暂停之前执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

返回键值对,键值对将会覆盖原来相同键的 params,返回 exit_module=true 将会中断模块方法

示范代码:

<?php
add_hook('before_module_unsuspend', 1, function($vars) {
    // Perform hook code here...
});

模块开机之前执行

before_module_on

模块开机之前执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

返回键值对,键值对将会覆盖原来相同键的 params,返回 exit_module=true 将会中断模块方法

示范代码:

<?php
add_hook('before_module_on', 1, function($vars) {
    // Perform hook code here...
});

模块关机之前执行

before_module_off

模块关机之前执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

返回键值对,键值对将会覆盖原来相同键的 params,返回 exit_module=true 将会中断模块方法

示范代码:

<?php
add_hook('before_module_off', 1, function($vars) {
    // Perform hook code here...
});

模块重启之前执行

before_module_reboot

模块重启之前执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

返回键值对,键值对将会覆盖原来相同键的 params,返回 exit_module=true 将会中断模块方法

示范代码:

<?php
add_hook('before_module_reboot', 1, function($vars) {
    // Perform hook code here...
});

模块硬关机之前执行

before_module_hard_off

模块硬关机之前执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

返回键值对,键值对将会覆盖原来相同键的 params,返回 exit_module=true 将会中断模块方法

示范代码:

<?php
add_hook('before_module_hard_off', 1, function($vars) {
    // Perform hook code here...
});

模块硬重启之前执行

before_module_hard_reboot

模块硬重启之前执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

返回键值对,键值对将会覆盖原来相同键的 params,返回 exit_module=true 将会中断模块方法

示范代码:

<?php
add_hook('before_module_hard_reboot', 1, function($vars) {
    // Perform hook code here...
});

模块重装系统之前执行

before_module_reinstall

模块重装系统之前执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

返回键值对,键值对将会覆盖原来相同键的 params,返回 exit_module=true 将会中断模块方法

示范代码:

<?php
add_hook('before_module_reinstall', 1, function($vars) {
    // Perform hook code here...
});

模块救援系统之前执行

before_module_rescue_system

模块救援系统之前执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

返回键值对,键值对将会覆盖原来相同键的 params,返回 exit_module=true 将会中断模块方法

示范代码:

<?php
add_hook('before_module_rescue_system', 1, function($vars) {
    // Perform hook code here...
});

模块拉取信息之前执行

before_module_sync

模块拉取信息之前执行

请求参数:

参数名称	类型	说明
params	数组	参考模块开发的 params

响应:

返回键值对,键值对将会覆盖原来相同键的 params,返回 exit_module=true 将会中断模块方法

示范代码:

<?php
add_hook('before_module_sync', 1, function($vars) {
    // Perform hook code here...
});

三、定时任务

每次定时任务之后执行

after_cron

每次定时任务之后执行

请求参数：

参数名称	类型	说明

响应:

无

示范代码:

<?php
add_hook('after_cron', 1, function($vars) {
    // Perform hook code here...
});

每次定时任务之前执行

before_cron

每次定时任务之前执行

请求参数：

参数名称	类型	说明

响应:

无

示范代码:

<?php
add_hook('before_cron', 1, function($vars) {
    // Perform hook code here...
});

每天定时任务之后执行

after_daily_cron

每天定时任务之后执行

请求参数：

参数名称	类型	说明

响应:

无

示范代码:

<?php
add_hook('after_daily_cron', 1, function($vars) {
    // Perform hook code here...
});

每天定时任务之前执行

before_daily_cron

每天定时任务之前执行

请求参数：

参数名称	类型	说明

响应:

无

示范代码:

<?php
add_hook('before_daily_cron', 1, function($vars) {
    // Perform hook code here...
});

定时任务保存后执行

cron_config_save

定时任务保存后执行

请求参数：

参数名称	类型	说明

响应:

无

示范代码:

<?php
add_hook('cron_config_save', 1, function($vars) {
    // Perform hook code here...
});

四、产品服务

管理员手动保存产品后执行

after_admin_edit_service

管理员手动保存产品后执行

请求参数:

参数名称	类型	说明
adminid	整型	管理员 ID
hostid	整型	服务 ID

响应:

无

示范代码:

<?php
add_hook('after_admin_edit_service', 1, function($vars) {
    // Perform hook code here...
});

产品转移后执行

transfer_service

产品转移后执行

请求参数:

参数名称	类型	说明
adminid	整型	管理员 ID
hostid	整型	服务 ID
transfer_uid	整型	接收用户 id

响应:

无

示范代码:

<?php
add_hook('transfer_service', 1, function($vars) {
    // Perform hook code here...
});

删除服务后执行

service_delete

删除服务后执行

请求参数:

参数名称	类型	说明
Uid	整型	用户 id
hostid	整型	服务 id

响应:

无

示范代码:

<?php
add_hook('service_delete', 1, function($vars) {
    // Perform hook code here...
});

删除商品后执行

product_delete

删除商品后执行

请求参数:

参数名称	类型	说明
pid	整型	商品id

响应:

无

示范代码:

<?php
add_hook('product_delete', 1, function($vars) {
    // Perform hook code here...
});

商品创建后执行

product_create

商品创建后执行

请求参数:

参数名称	类型	说明
pid	整型	商品id

响应:

无

示范代码:

<?php
add_hook('product_create', 1, function($vars) {
    // Perform hook code here...
});

商品编辑后执行

product_edit

商品编辑后执行

请求参数:

参数名称	类型	说明
pid	整型	商品id

响应:

无

示范代码:

<?php
add_hook('product_edit', 1, function($vars) {
    // Perform hook code here...
});

在创建取消请求时执行

cancellation_request

在创建取消请求时执行

请求参数:

参数名称	类型	说明
uid	整型	用户 id
relid	整型	服务被取消的 id
reason	整型	取消原因
type	字符串	取消类型

响应:

无

示范代码:

<?php
add_hook('cancellation_request', 1, function($vars) {
    // Perform hook code here...
});

产品升级后执行

after_product_upgrade

产品升级后执行

请求参数:

参数名称	类型	说明
upgradeid	整型	升级 ID

响应:

无

示范代码:

<?php
add_hook('after_product_upgrade', 1, function($vars) {
    // Perform hook code here...
});

五、账单

账单支付后邮件发送前执行

invoice_paid_before_email

账单支付后邮件发送前执行

请求参数:

参数名称	类型	说明
invoiceid	整型	账单 ID

响应:

无

示范代码:

<?php
add_hook('invoice_paid_before_email', 1, function($vars) {
    // Perform hook code here...
});

账单支付后邮件发送后执行

invoice_paid

账单支付后邮件发送后执行

请求参数:

参数名称	类型	说明
invoiceid	整型	账单 ID

响应:

无

示范代码:

<?php
add_hook('invoice_paid', 1, function($vars) {
    // Perform hook code here...
});

当账单标记为未支付后执行

invoice_mark_unpaid

当账单标记为未支付后执行

请求参数:

参数名称	类型	说明
invoiceid	整型	账单 ID

响应:

无

示范代码:

<?php
add_hook('invoice_mark_unpaid', 1, function($vars) {
    // Perform hook code here...
});

当账单标记为已取消后执行

invoice_mark_cancelled

当账单标记为已取消后执行

请求参数:

参数名称	类型	说明
invoiceid	整型	账单 ID

响应:

无

示范代码:

<?php
add_hook('invoice_mark_cancelled', 1, function($vars) {
    // Perform hook code here...
});

当账单删除后执行

invoice_delete

当账单删除后执行

请求参数:

参数名称	类型	说明
invoiceid	整型	账单 ID

响应:

无

示范代码:

<?php
add_hook('invoice_delete', 1, function($vars) {
    // Perform hook code here...
});

账单退款后执行

invoice_refunded

当账单退款后执行

请求参数:

参数名称	类型	说明
invoiceid	整型	账单 ID
amount	浮点型	退款金额

响应:

无

示范代码:

<?php
add_hook('invoice_refunded', 1, function($vars) {
    // Perform hook code here...
});

账单备注后执行

invoice_notes

账单备注后执行

请求参数:

参数名称	类型	说明
invoiceid	整型	账单 ID
content	字符串	备注内容

响应:

无

示范代码:

<?php
add_hook('invoice_notes', 1, function($vars) {
    // Perform hook code here...
});

创建续费账单后

renew_invoice_create

创建续费账单后

请求参数:

参数名称	类型	说明
invoiceid	整型	生成账单 ID
hostid	整型	产品 id

响应:

无

示范代码:

<?php
add_hook('renew_invoice_create', 1, function($vars) {
    // Perform hook code here...
});

创建流量包账单后

flow_packet_invoice_create

创建流量包账单后

请求参数:

参数名称	类型	说明
invoiceid	整型	生成的账单 ID
hostid	整型	产品 id
price	浮点型	流量包价格
name	字符串	流量包名称
capacity	字符串	流量包大小
flowpacketid	字符串	流量包 ID

响应:

无

示范代码:

<?php
add_hook('flow_packet_invoice_create', 1, function($vars) {
    // Perform hook code here...
});

合并账单后执行

invoice_combine

合并账单后执行

请求参数:

参数名称	类型	说明
invoiceid	整型	生成的账单 ID
combined_invoice	数组	合并的账单 ID

响应:

无

示范代码:

<?php
add_hook('invoice_combine', 1, function($vars) {
    // Perform hook code here...
});

订单审核通过后执行

order_pass_check

订单审核通过后执行

请求参数:

参数名称	类型	说明
orderid	整型	订单 id

响应:

无

示范代码:

<?php
add_hook('order_pass_check', 1, function($vars) {
    // Perform hook code here...
});

订单取消后执行

order_cancel

订单取消后执行

请求参数:

参数名称	类型	说明
orderid	整型	订单 id

响应:

无

示范代码:

<?php
add_hook('order_cancel', 1, function($vars) {
    // Perform hook code here...
});

订单删除后执行

order_delete

订单删除后执行

请求参数:

参数名称	类型	说明
orderid	整型	订单 id

响应:

无

示范代码:

<?php
add_hook('order_delete', 1, function($vars) {
    // Perform hook code here...
});

六、购物车

前台购物车修改购买产品数量后执行

shopping_cart_modify_num

前台购物车修改购买产品数量后执行

请求参数:

参数名称	类型	说明
pid	整型	产品 ID
num	整型	修改后的数量

响应:

无

示范代码:

<?php
add_hook('shopping_cart_modify_num', 1, function($vars) {
    // Perform hook code here...
});

前台购物车结算后执行

shopping_cart_settle

前台购物车结算后执行

请求参数:

参数名称	类型	说明
total	整型	结算金额( 可能是免费 )
invoiceid	整型	生成的账单 ID
hostid	数组	生成的产品 ID

响应:

无

示范代码:

<?php
add_hook('shopping_cart_settle', 1, function($vars) {
    // Perform hook code here...
});

前台购物车添加商品后执行

shopping_cart_add_product

前台购物车添加商品后执行

请求参数:

参数名称	类型	说明
pid	number	产品 ID
qty	字符串	产品数量
serverid	number	服务器可用区 ID
configoption	数组	产品配置数组
customfield	数组	产品自定义字段数组
currencyid	数组	货币 ID
host	字符串	主机名
password	字符串	密码

响应:

无

示范代码:

<?php
add_hook('shopping_cart_add_product ', 1, function($vars) {
    // Perform hook code here...
});

前台购物车移除商品后执行

shopping_cart_remove_product

前台购物车移除商品后执行

请求参数:

参数名称	类型	说明
pid	number	产品 ID
qty	字符串	产品数量
serverid	number	服务器可用区 ID
configoption	数组	产品配置数组
customfield	数组	产品自定义字段数组
currencyid	数组	货币 ID
host	字符串	主机名
password	字符串	密码

响应:

无

示范代码:

<?php
add_hook('shopping_cart_remove_product', 1, function($vars) {
    // Perform hook code here...
});

前台购物车清空后执行

shopping_cart_clear

前台购物车清空后执行

请求参数:

参数名称	类型	说明
data	数组	二维数组(pid= 产品 ID,billingcycle= 购买周期 ,num= 购买数量 )

响应:

无

示范代码:

<?php
add_hook('shopping_cart_clear', 1, function($vars) {
    // Perform hook code here...
});

七、客户

客户添加后

client_add

客户添加后

请求参数:

参数名称	类型	说明
userid	整型	用户名 ID
username	整型	用户名
sex	整型	性别
avatar	整型	头像
profession	整型	职业
signature	整型	个性签名
companyname	整型	所在公司
email	整型	邮件
country	整型	国家
province	整型	省份
city	整型	城市
region	整型	区
address1	整型	具体地址 1
address2	整型	具体地址 2
postcode	整型	邮编
phone_code	整型	电话区号
phonenumber	整型	电话
notes	整型	管理员备注
groupid	整型	用户组 ID

响应:

无

示范代码:

<?php
add_hook('client_add', 1, function($vars) {
    // Perform hook code here...
});

客户编辑

client_edit

客户编辑

请求参数:

参数名称	类型	说明
userid	整型	用户名 ID
username	整型	用户名
sex	整型	性别
avatar	整型	头像
profession	整型	职业
signature	整型	个性签名
companyname	整型	所在公司
email	整型	邮件
country	整型	国家
province	整型	省份
city	整型	城市
region	整型	区
address1	整型	具体地址 1
address2	整型	具体地址 2
postcode	整型	邮编
phone_code	整型	电话区号
phonenumber	整型	电话
notes	整型	管理员备注
groupid	整型	用户组 ID

响应:

无

示范代码:

<?php
add_hook('client_edit', 1, function($vars) {
    // Perform hook code here...
});

关闭客户后

client_close

关闭客户后

请求参数:

参数名称	类型	说明
userid	整型	客户 ID

响应:

无

示范代码:

<?php
add_hook('client_close', 1, function($vars) {
    // Perform hook code here...
});

删除客户前

pre_client_delete

删除客户前

请求参数:

参数名称	类型	说明
userid	整型	客户 ID

响应:

无

示范代码:

<?php
add_hook('pre_client_delete', 1, function($vars) {
    // Perform hook code here...
});

删除客户后

client_delete

删除客户后

请求参数:

参数名称	类型	说明
userid	整型	客户 ID

响应:

无

示范代码:

<?php
add_hook('client_delete', 1, function($vars) {
    // Perform hook code here...
});

添加客户前验证(客户端添加或者管理端添加)

client_details_validate

添加客户前验证(客户端添加或者管理端添加)

请求参数:

参数名称	类型	说明
userid	整型	用户名 ID
username	整型	用户名
sex	整型	性别
avatar	整型	头像
profession	整型	职业
signature	整型	个性签名
companyname	整型	所在公司
email	整型	邮件
country	整型	国家
province	整型	省份
city	整型	城市
region	整型	区
address1	整型	具体地址 1
address2	整型	具体地址 2
postcode	整型	邮编
phone_code	整型	电话区号
phonenumber	整型	电话
notes	整型	管理员备注
groupid	整型	用户组 ID

响应:

array.错误信息

示范代码:

<?php
add_hook('client_details_validate', 1, function($vars) {
    // Perform hook code here...
});

用户登录后执行

client_login

用户登录后执行

请求参数:

参数名称	类型	说明
uid	整型	用户 ID
name	字符串	用户名称
IP	字符串	登录 IP

响应:

无

示范代码:

<?php
add_hook('client_login', 1, function($vars) {
    // Perform hook code here...
});

用户 API 登录后执行

client_api_login

用户 API 登录后执行

请求参数:

参数名称	类型	说明
uid	整型	用户 ID
name	字符串	用户名称
IP	字符串	登录 IP

响应:

无

示范代码:

<?php
add_hook('client_api_login', 1, function($vars) {
    // Perform hook code here...
});

用户重置密码后执行

client_reset_password

用户重置密码后执行

请求参数:

参数名称	类型	说明
uid	整型	用户 ID
password	字符串	新密码

响应:

无

示范代码:

<?php
add_hook('client_reset_password', 1, function($vars) {
    // Perform hook code here...
});

用户退出登录后执行

client_logout

用户退出登录后执行

请求参数:

参数名称	类型	说明
uid	整型	用户 ID

响应:

无

示范代码:

<?php
add_hook('client_logout', 1, function($vars) {
    // Perform hook code here...
});

八、管理员

管理员退出登录执行

admin_logout

管理员退出登录执行

请求参数:

参数名称	类型	说明
adminid	整型	管理员ID

响应:

无

示范代码:

<?php
add_hook('admin_logout', 1, function($vars) {
    // Perform hook code here...
});

管理员登录执行

admin_login

管理员登录执行

请求参数:

参数名称	类型	说明
adminid	整型	管理员 ID
admin	字符串	管理员账号
nickname	字符串	管理员昵称

响应:

无

示范代码:

<?php
add_hook('admin_login', 1, function($vars) {
    // Perform hook code here...
});

管理员登录系统验证全通过后执行

auth_admin_login

管理员登录系统验证全通过后执行

请求参数:

参数名称	类型	说明

响应:

"status":"true通过验证/false验证失败",
"msg":"失败信息"

示范代码:

<?php
add_hook('auth_admin_login', 1, function($vars) {
    // Perform hook code here...
});

添加管理员后执行

add_admin

添加管理员后执行

请求参数:

参数名称	类型	说明
adminid	整型	管理员 ID

响应:

无

示范代码:

<?php
add_hook('add_admin', 1, function($vars) {
    // Perform hook code here...
});

编辑管理员后执行

edit_admin

编辑管理员后执行

请求参数:

参数名称	类型	说明
adminid	整型	管理员 ID

响应:

无

示范代码:

<?php
add_hook('edit_admin', 1, function($vars) {
    // Perform hook code here...
});

删除管理员后执行

delete_admin

删除管理员后执行

请求参数:

参数名称	类型	说明
adminid	整型	管理员 ID

响应:

无

示范代码:

<?php
add_hook('delete_admin', 1, function($vars) {
    // Perform hook code here...
});

九、工单

添加工单备注

ticket_add_note

管理员在后台添加工单备注。

请求参数：

参数名称	类型	说明
ticketid	整型	工单 ID
content	字符串	备注内容
attachment	数组	工单附件储存路径
adminid	整型	管理员 ID

响应：

无

示范代码：

<?php
add_hook('ticket_add_note', 1, function($vars){
    // Perform hook code here...
})

管理员回复工单

ticket_admin_reply

管理员在后台回复工单

请求参数：

参数名称	类型	说明
ticketid	整形	工单 ID
replyid	整型	工单回复 ID
dptid	整型	工单部门 ID
dptname	字符串	工单部门名称
title	字符串	工单标题
content	字符串	回复内容
priority	字符串	工单优先级
admin	字符串	管理员名称
status	整型	工单状态 ID
status_title	字符串	工单状态名称

响应：

无

示范代码：

<?php
add_hook('ticket_admin_reply', 1, function($vars){
    // Perform hook code here...
})

关闭工单

ticket_close

客户或管理员关闭工单时执行

请求参数：

参数名称	类型	说明
ticketid	整型	工单 ID

响应：

无

示范代码：

<?php
add_hook('ticket_close', 1, function($vars){
    // Perform hook code here...
})

删除工单

ticket_delete

管理员在后台删除工单

请求参数：

参数名称	类型	说明
ticketid	整型	工单 ID
adminid	整型	操作的管理员 ID

响应：

无

示范代码：

<?php
add_hook('ticket_delete', 1, function($vars){
    // Perform hook code here...
})

删除工单回复

ticket_delete_reply

删除工单回复后执行

请求参数：

参数名称	类型	说明
ticketid	整型	工单 ID
replyid	整型	工单回复 ID
adminid	整型	操作的管理员 ID

响应：

无

示范代码：

<?php
add_hook('ticket_delete_reply', 1, function($vars){
    // Perform hook code here...
})

工单部门变更

ticket_department_change

工单部门变更后执行

请求参数：

参数名称	类型	说明
ticketid	整型	工单 ID
dptid	整型	新部门 ID
dptname	字符串	新部门名称

响应：

无

示范代码：

<?php
add_hook('ticket_department_change', 1, function($vars){
    // Perform hook code here...
})

用户创建工单

ticket_open

用户创建工单后执行

请求参数：

参数名称	类型	说明
ticketid	整型	工单 ID
tid	字符串	工单号
uid	整型	用户 ID
dptid	整型	部门 ID
dptname	字符串	部门名称
title	字符串	工单标题
content	字符串	工单内容
priority	字符串	优先级
hostid	整型	产品 ID
attachment	数组	附件

响应：

无

示范代码：

<?php
add_hook('ticket_open', 1, function($vars){
    // Perform hook code here...
})

管理员创建工单

ticket_open_admin

管理员在后台创建工单

请求参数：

参数名称	类型	说明
ticketid	整型	工单 ID
tid	字符串	工单号
uid	整型	用户 ID
dptid	整型	部门 ID
dptname	字符串	部门名称
title	字符串	工单标题
content	字符串	工单内容
priority	字符串	优先级 high 高，medium 中，low 低
attachment	数组	附件

响应：

无

示范代码：

<?php
add_hook('ticket_open_admin', 1, function($vars){
    // Perform hook code here...
})

管理员修改工单状态

ticket_status_change

工单状态被管理员手动变更时执行

请求参数：

参数名称	类型	说明
ticketid	数组	工单 ID
status	整型	新状态 ID
status_title	字符串	新状态名称
adminid	整型	管理员 ID

响应：

无

示范代码：

<?php
add_hook('ticket_status_change', 1, function($vars){
    // Perform hook code here...
})

修改工单标题

ticket_title_change

工单标题变更后执行

请求参数：

参数名称	类型	说明
ticketid	整型	工单 ID
title	字符串	新标题

响应：

无

示范代码：

<?php
add_hook('ticket_title_change', 1, function($vars){
    // Perform hook code here...
})

用户回复工单

ticket_user_reply

用户回复工单后执行

请求参数：

参数名称	类型	说明
ticketid	整型	工单 ID
replyid	整型	工单回复 ID
uid	整型	用户 ID
dptid	整型	工单部门 ID
dptname	字符串	工单部门名称
title	字符串	工单标题
content	字符串	回复内容
priority	字符串	工单优先级
status	整型	工单状态 ID
status_title	字符串	工单状态名称

响应：

无

示范代码：

<?php
add_hook('ticket_user_reply', 1, function($vars){
    // Perform hook code here...
})

十、其他

添加服务器后

server_add

添加服务器后

请求参数:

参数名称	类型	说明
serverid	整型	服务器 ID

响应:

无

示范代码:

<?php
add_hook('server_add', 1, function($vars) {
    // Perform hook code here...
});

删除服务器前

server_delete

删除服务器前

请求参数:

参数名称	类型	说明
serverid	整型	服务器 ID

响应:

无

示范代码:

<?php
add_hook('server_delete', 1, function($vars) {
    // Perform hook code here...
});

编辑服务器前

server_edit

编辑服务器前

请求参数:

服务器 ID	类型	说明
serverid	整型	服务器 ID

响应:

无

示范代码:

<?php
add_hook('server_edit', 1, function($vars) {
    // Perform hook code here...
});

在删除日志前执行

before_delete_log

在删除日志前执行

请求参数:

参数名称	类型	说明
adminid	整型	管理员 ID
type	字符串	日志类型

响应:

无

示范代码:

<?php
add_hook('before_delete_log', 1, function($vars) {
    // Perform hook code here...
});

添加系统活动日志

log_activity

添加系统活动日志

请求参数:

参数名称	类型	说明
description	整型	描述
user	整型	操作名(Sub-Account,Client,System)
uid	整型	用户 id
ipaddress	字符串	ip 地址

响应:

无

示范代码:

<?php
add_hook('log_activity', 1, function($vars) {
    // Perform hook code here...
});

用户推介计划激活后执行

affiliate_activation

用户推介计划激活后执行

请求参数:

参数名称	类型	说明
Uid	整型	用户 ID
affid	整型	推介 ID

响应:

无

示范代码:

<?php
add_hook('affiliate_activation', 1, function($vars) {
    // Perform hook code here...
});

自定义字段值更新时执行

custom_field_save

自定义字段值更新时执行

请求参数:

参数名称	类型	说明
fieldid	整型	自定义字段 ID
relid	整型	关联 ID
value	字符串	自定义字段值

响应:

返回以下内容可覆盖自定义字段值：

['value' => '新 value']

示范代码:

<?php
add_hook('custom_field_save', 1, function($vars) {
    // Perform hook code here...
});

邮件发送前执行

before_email_send

自定义字段值更新时执行

请求参数:

参数名称	类型	说明
email	字符串	邮箱
subject	字符串	主题
content	字符串	邮件正文

响应:

返回以下内容可覆盖自定义字段值：

['value' => '新 value']

示范代码:

<?php
add_hook('before_email_send', 1, function($vars) {
    // Perform hook code here...
});

交易流水

模块命令

定时任务

产品服务

账单

购物车

客户

管理员

工单

其他

本页目录