README

mainframe-bot-api

一个易于使用主框架机器人API的包

您可以在此处找到主框架API的文档。

如果您发现任何错误或问题，请随意分支该项目并提交一个PR。或者您可以通过dev@jaquier.co给我发邮件。

如何安装它

使用composer: composer require aubruz/mainframe-bot-api 在您的项目中添加 use Aubruz\Mainframe\MainframeClient;。

如何使用它

创建客户端

$mainframeClient = new MainframeClient($botSecret);

如果您想使用其他API URL，可以指定。默认URL为 "https://api.mainframe.com/bots/v1/"。

$mainframeClient = new MainframeClient($botSecret, 'https://api-staging.mainframe.com/bots/v1/');

发送消息

$mainframeClient->sendMessage($conversationID, 'Hello World!!');

设置订阅

$mainframeClient->setupSubscription($subscriptionToken, $label);

编辑订阅

$mainframeClient->editSubscription($subscriptionToken, $label);

删除订阅

$mainframeClient->deleteSubscription($conversationID, $subscriptionID);

您可以为要发布到对话的消息添加一个可选的消息（以解释删除的原因）

$mainframeClient->deleteSubscription($conversationID, $subscriptionID, $message);

响应

mainframe-bot-api包使用guzzlehttp/guzzle来执行请求。每个调用都返回该库中的响应对象。您可以在此找到文档这里。

$response = mainframeClient->setupSubscription($subscriptionToken, $label);
$response = json_decode($response->getBody());
if($response->getStatusCode() === 200 && $response->success){
    // Do something
}

aubruz / mainframe-bot-api

维护者

详细信息