README

hipchat-api 是一个 PHP 库，它提供了 HipChat v2 REST API 的实现。

安装

hipchat-api 需要 PHP 5.4 或更高版本

hipchat-api 符合 PSR-4 规范，可以使用 composer 简单安装。

只需将 vanilla/hipchat-api 添加到您的 composer.json 文件中。

"require": {
    "vanilla/hipchat-api": "~2.0"
}

用法

HipChat 使用 OAuth2 令牌和特定作用域来控制 API 访问。您可以通过访问 HipChat 账户/API 页面 来为自己请求一个令牌。

<?php

// The library lives in the HipChat namespace.
use HipChat\v2\HipChatClient;

// Require composer's autoloader.
require_once 'vendor/autoload.php';

// Define the cli options.
$client = new HipChatClient();
$client->setAuth('<OAUTH BEARER TOKEN>');

// Start making calls!
$users = $client->usersAPI()->getAll();

以下示例调用 Users API 来 获取所有用户。

• 您可以通过在 $client 上调用 setThrowExceptions(true) 来让客户端在错误时抛出异常而不是返回 false。

自定义 API 端点

如果您正在使用 HipChat 的私有实例，您可以在创建客户端时更改 API 基础 URL。

<?php

use HipChat\v2\HipChatClient;

$client = new HipChatClient('https://my.hipchatdomain.com');

• 您也可以通过在现有 $client 上调用 setBaseUrl() 在任何时间更改基础 URL。

当前状态

以下列表显示了可用的方法和缺失的方法

###附加组件

• 获取附加组件可安装的数据
• 创建附加组件链接
• 调用附加组件链接
• 删除附加组件链接

###功能

• 获取功能

###表情符号

• 获取表情符号
• 获取所有表情符号

###OAuth 会话

• 生成令牌
• 获取会话
• 删除会话

###房间

• 获取所有房间
• 创建房间
• 获取房间
• 更新房间
• 删除房间
• 获取头像
• 更新头像
• 删除头像
• 获取房间消息
• 查看房间历史
• 查看最近房间历史
• 获取预览
• 创建预览
• 删除预览
• 邀请用户
• 添加成员
• 移除成员
• 获取所有成员
• 获取所有参与者
• 发送消息
• 发送房间通知
• 回复消息
• 与房间共享文件
• 与房间共享链接
• 获取房间统计信息
• 设置主题
• 获取钩子
• 删除钩子
• 获取所有钩子
• 创建钩子

###用户

• 获取所有用户
• 创建用户
• 查看用户
• 更新用户
• 删除用户
• 查看私有聊天历史
• 查看最近私有聊天历史
• 获取私有聊天消息
• 向用户发送消息
• 获取照片
• 上传照片
• 删除照片
• 获取偏好设置（自动加入）
• 与用户共享文件
• 与用户共享链接