polidog / php-chatwork-api
Chatwork api library for php
Installs: 6 458
Dependents: 1
Suggesters: 0
Security: 0
Stars: 27
Watchers: 2
Forks: 8
Open Issues: 0
Requires
- php: >=7.4
- ext-json: *
- cakephp/utility: ^4.3
- friendsofphp/php-cs-fixer: ^3.23
- guzzlehttp/guzzle: ^7.0
Requires (Dev)
- phpspec/prophecy: ^1.17
- phpspec/prophecy-phpunit: ^2.0
- phpunit/phpunit: ^9.6
README
Chatwork APIをPHPから利用するためのライブラリです。
Install
$ composer require polidog/php-chatwork-api
Quick Example
利用する前に必ずChatWorkのAPIキーを用意しておいてください。
APIキーの確認方法を確認してください。
オブジェクトを取得する
// ChatWork API Clientオブジェクトの初期化
$chatwork = \Polidog\Chatwork\Chatwork::create("chatwork api token");
自分自身の情報(APIキーの所有者)
$user = $chatwork->me()->show();
// APIのレスポンスはすべてオブジェクトの形で取得できます
var_dump($user);
チャットルーム一覧を取得する
$rooms = $chatwork->rooms()->show();
var_dump($rooms);
チャットルームを作成する
// まずはRoomクラスを用意する
$room = new \Polidog\Chatwork\Entity\Room();
$room->name = 'test chat';
// 次にメンバー一覧を用意する
$members = new \Polidog\Chatwork\Entity\Collection\MembersCollection();
$member = new \Polidog\Chatwork\Entity\Member();
$member->role = 'admin';
$member->account = $user;
$members->add($member);
$chatwork->rooms()->create($room, $members)
チャットルームのメンバー一覧を取得する
$members = $client->rooms()->members(123456/* roomidを指定します。*/);
var_dump($members);
チャットルームのメッセージ一覧を取得する
// $force(0: 新しいメッセージのみ, 1: ラスト100メッセージ)
$messages = $client->rooms()->messages($room_id)->show($force);
メッセージ送信
$message = new \Polidog\Chatwork\Entity\Message();
$message->body = 'メッセージ内容';
$client->rooms()->messages($room_id)->create($message);
メッセージ更新
$message = new \Polidog\Chatwork\Entity\Message();
$message->body = 'メッセージ内容';
// $message_id(メッセージのID)
$client->rooms()->messages($room_id)->update($message, $message_id);
メッセージ削除
// $message_id(メッセージのID)
$client->rooms()->messages($room_id)->delete($message_id);
チャットルームのファイル一覧を取得する
$files = $client->rooms()->files($room_id)->show();
ファイル情報を取得する
$files = $client->rooms()->files($room_id)->detail($file_id);