ChatMeetsのwebAPI解説
web通話アプリ「ChetMeets」にwebAPIを実装したので使い方を解説します。
ChatMeetsとは
まずchatmeetsとは何ぞやということですが、chatmeetsは僕(fumi0916)が個人で開発している完全匿名でブラウザから使用できるweb通話アプリケーションです。
特にX(twitter)やlineオープンチャットなど通話機能のないSNSなどでも部屋のurlを共有するだけで手軽に通話を始めることができるのが強みとなっています。
何のためのAPIなのか
今回実装したapiで使用できる機能はchatmeetsのgui上からでも使うことは可能ですが、apiで操作できるようにすることで、皆さんの自作のwebサイト、アプリなどからchatmeetsを使うことができ、手軽に通話機能を実装することが可能になります。
Tokenの取得
chatmeetsのapiを使用するにはまずtokenを取得する必要があります。
ここにアクセスすると、自分のipとapiの使用に必要なtokenが表示されます。
ここで表示されたtokenはapiを叩く際に必要になるのでメモしておいてください。
APIリスト
現在の段階で使用できるapiは
- 通話（ルームの作成）
- 通話情報の取得
の2種類です....少ない..
通話(ルーム)の作成api
このapiではchatmeetsの通話(ルーム)を作成することが出来ます。
https://fumiapp.com/api/createroom にpostすることで利用することができます。
その際リクエストのbodyには
- token(最初に取得したやつ)
- roomname(通話の名前)
- maxuser(参加できるユーザーの最大値,1~6人までの幅で設定可能)
- ispublick(公開設定,publickとprivateの二種類)
を追加する必要があります。
また
- token,roomnameは文字列(string)
- maxuserは1~6の数字(Int,Number)
- ispublickはtrue or false(trueだとpublick、falseだとprivateになります)
で指定してください。
例(postmanを使用)
このような感じでpostするとこのようなレスポンスが返ってきます。
これは
- roomname(通話の名前)
- roomId(通話のID)
- joinurl（通話に参加するためのurl）
の構成となっています。
これでルームの作成は完了です。。
※通話(ルーム)は一つのtokenにつき7部屋までしか同時に作成できません。
通話の情報取得api
このapiでは現在行われている通話の情報を取得することが出来ます。
https://fumiapp.com/api/getroom にpostすることで利用できます。
その際リクエストのbodyには
- roomId(通話のID)
を追加する必要があります。
例
ポストするとこのようなレスポンスが返ってきます
これには今ルームにいるユーザーのidリスト（userList）やルーム名(roomName)など通話のもろの情報が記載されています。
これで通話情報の取得は完了です。
終わりに
今後もアップデートを続けていく予定なので、何か進展があったらまた記事にしようとおもいます。
Discussion