README

这个 PHP 库使您能够有效地使用 API。

安装

要使用此库，您可以使用 composer 安装。

打开终端，导航到您想要的文件夹。然后输入：

composer require button-request/api-v1

如何使用？

要使用该功能，您必须首先声明以下内容：

use ButtonRequest\ApiV1\Client;
$apiClient=new Client("{API Token}");

消息

抓取

$response=$apiClient->message->fetch();

您还可以添加过滤条件：

$response=$apiClient->message->fetch(
    "msg_id"=>"{Msg ID}",
    "device_id"=>"{Device ID}",
    "pin"=>"{Pin Status}",
    "shared_to_me"=>"{Shared To Me}"
);

有效过滤参数：msg_id、device_id、pin、shared_to_me

PIN 状态

$response=$apiClient->message->pinStatus("{Message ID}", "{Pin or Unpin}");

删除

$response=$apiClient->message->delete("{Message ID}");

设备列表

抓取

$response=$apiClient->deviceList->fetch();

您还可以添加过滤条件：

$response=$apiClient->deviceList->fetch("{Device ID}", 
    [
        "status"=>"{Status}",
        "repeated_message"=>"{Repeated Message}",
    ]
);

有效过滤参数：status、repeated_message

重复消息

$response=$apiClient->deviceList->repeatedMessage("{Device Id}", "{Action}");

按钮消息更新

$response=$apiClient->deviceList->buttonMessageUpdate("{Device Id}", 
    [
        ["buttonNo"=>"1", "message"=>"This is 1"],
        ["buttonNo"=>"2", "message"=>"This is 2"]
    ]
);

按钮消息删除

$response=$apiClient->deviceList->buttonMessageDelete("{Device Id}", 
    [
        "{Button No 1}", "{Button No 2}"
    ]
);

新设备

$response=$apiClient->deviceList->newDevice("{Nickname}");

设备共享

抓取共享给我的

$response=$apiClient->deviceShare->toMeFetch();

您还可以传递过滤数组：

$response=$apiClient->deviceShare->toMeFetch([
    "case_id"=>"{Case ID}",
    "device_id"=>"{Device ID}",
    "owner_email"=>"{Email}",
    "right"=>"{Right}"
]);

有效参数：case_id、device_id、owner_email、right

放弃共享者权利

$response=$apiClient->deviceShare->giveUpShareeRight("{Case ID}");

共享给

$response=$apiClient->deviceShare->shareTo("{Device ID}", "{Email}");

更改共享者权利

$response=$apiClient->deviceShare->changeShareeRight("{Case ID}", "{Right}");

移动访问

抓取

$response=$apiClient->mobileAccess->fetch();

您还可以传递过滤数组。

$response=$apiClient->mobileAccess->fetch(
    [
        "case_id"=>"{Case ID}",
        "deleted_from_phone"=>"{Deleted or Not}"
    ]
);

有效参数：case_id、deleted_from_phone

新建

$response=$apiClient->mobileAccess->new("{Nickname}");

修改昵称

$response=$apiClient->mobileAccess->amendNickname("{Case ID}", "{New Nickname}");

撤销

$response=$apiClient->mobileAccess->revoke("{CASE ID}");

响应

请参阅 API 文档