当前位置: 首页>>代码示例 >>用法及示例精选 >>正文


PHP WHMCS AddClientNote用法及代码示例


添加客户备注

请求参数

参数 类型 说明 必需的
action string “AddClientNote” Required
userid int 应用注释的客户 ID Required
notes string 要添加的注释 Required
sticky bool 是否应将便条设为粘性。制作注释 ‘sticky’ 并在整个客户的帐户以及他们在管理区域提交的任何票证上显示注释 Optional

响应参数

参数 类型 说明
result string 操作结果:成功或错误
noteid int 新建笔记的id

示例请求 (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'AddClientNote',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'userid' => '1',
            'notes' => 'Note to add',
            'sticky' => true,
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例请求(本地 API)

$command = 'AddClientNote';
$postData = array(
    'userid' => '1',
    'notes' => 'Note to add',
    'sticky' => true,
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);

示例响应 JSON

{
    "result": "success",
    "noteid": "1"
}

错误响应

可能的错误条件响应包括:

  • 未找到客户 ID
  • 备注不能为空

相关用法


注:本文由纯净天空筛选整理自whmcs.com大神的英文原创作品 AddClientNote。非经特殊声明,原始代码版权归原作者所有,本译文未经允许或授权,请勿转载或复制。