hnhdigital-os/php-slack-api

通过 PHP 对象访问 Slack 团队的 API

v0.24.0 2021-02-07 12:39 UTC

README

   _____ _            _
  / ____| |          | |
 | (___ | | __ _  ___| | __
  \___ \| |/ _` |/ __| |/ /
  ____) | | (_| | (__|   <
 |_____/|_|\__,_|\___|_|\_\

通过 PHP 对象访问 Slack 团队的 API。

Latest Version Total Downloads Software License

此包由澳大利亚精品开发公司 H&H|Digital 从 cleentfaar/slack 调整。访问我们 hnh.digital

1.0.0 版本发布

请注意,从 1.0.0 版本开始,此包的命名空间(以及文件夹结构)将从 CL\Slack 更改为 HnhDigital\SlackApi。

从 v1.0.0 版本开始,所有有效载荷和响应都将与 Slack API 匹配,并补充以下列出的缺失 api 方法。

文档

  • 入门指南 - 在使用此库之前,您需要生成一个令牌或设置 OAuth。
  • 安装 - 如何通过 composer 或作为 git 子模块安装此库的信息。
  • 用法 - 使用此库访问 Slack API 的几个简单示例
  • API 方法 - Slack 的每个 API 方法以及如何使用此库的 Payload 类访问它们的详细信息。
  • 事件 - 监听由 ApiClient 触发的事件的示例

特性

  • 使用专用的有效载荷类访问 Slack 的所有 API 方法(请参阅 用法文档
  • 有效载荷和响应遵循 官方文档 中描述的相同定义(有些例外,我认为这将使区分更好)。
  • 使用 JMS Serializer 包序列化您和 Slack 之间的数据,允许使用完全规范的 PHP 对象与 API 一起工作。
  • 代码经过高度抽象,以支持在更具体的实现中重用(请参阅 SlackBundle

单元测试

目前单元测试已损坏(如从导入的存储库 cleentfaar/slack)。这将在不久的将来更新到最新版本。

请随意使用 PR 修复。

最新方法

以下方法已审查并更新

  • chat.postMessage(最后审查:2017 年 6 月 23 日)
  • chat.update(最后审查:2017 年 6 月 23 日)
  • oauth.access(最后审查:2017 年 6 月 21 日)
  • users.identity(添加:2017 年 6 月 25 日)

请随意审查一个方法,并通过 PR 更新 README。

缺失的 API 方法

以下方法尚未实现。

请随意添加 PR。

  • auth.revoke
  • channels.replies
  • chat.meMessage
  • chat.unfurl
  • dnd.endDnd
  • dnd.endSnooze
  • dnd.setSnooze
  • dnd.teamInfo
  • files.comments.add
  • 文件.评论.删除
  • 文件.评论.编辑
  • 文件.删除
  • 文件.撤销公开URL
  • 文件.共享公开URL
  • 即时消息.回复
  • 多人对话.关闭
  • 多人对话.历史记录
  • 多人对话.列表
  • 多人对话.标记
  • 多人对话.打开
  • 多人对话.回复
  • 图钉.添加
  • 图钉.列表
  • 图钉.移除
  • 反应.添加
  • 反应.列表
  • 反应.移除
  • 提醒.添加
  • 提醒.完成
  • 提醒.删除
  • 提醒.信息
  • 提醒.列表
  • 实时消息传输.连接
  • 收藏.添加
  • 收藏.移除
  • 团队.访问日志
  • 团队.可计费信息
  • 团队.集成日志
  • 团队.配置文件获取
  • 用户组.创建
  • 用户组.禁用
  • 用户组.启用
  • 用户组.列表
  • 用户组.更新
  • 用户组.用户列表
  • 用户组.用户更新
  • 用户.删除照片
  • 用户.设置照片
  • 用户.配置文件获取
  • 用户.配置文件设置

需要删除的方法

以下方法在API中不再存在

  • 用户.管理员邀请

相关包

常见问题解答

为什么在尝试连接到Slack API时我会收到cURL 60错误?

底层这个库使用Guzzle来连接到Slack API,Guzzle发送HTTP请求的默认方法是cURL。

完整的错误代码是CURLE_SSL_CACERT: Peer certificate cannot be authenticated with known CA certificates,尤其是在Windows或OS X上,可能是因为Guzzle在操作系统上找不到最新的CA证书包

要修复此问题,您首先需要手动创建Guzzle客户端,使用替代CA证书包,或者禁用对等验证(出于安全原因不推荐),并将其传递给API客户端。

$client = new \GuzzleHttp\Client();
$client->setDefaultOption('verify', 'C:\Program Files (x86)\Git\bin\curl-ca-bundle.crt');

// continue as normal, using the client above

$apiClient =  new ApiClient('api-token-here', $client);

如果您收到不同的错误代码,您可以查看cURL错误代码列表,或直接咨询Guzzle文档

贡献

有关详细信息,请参阅贡献指南

鸣谢

许可证

MIT许可证(MIT)。有关更多信息,请参阅许可证文件