slackのAPIを通してユーザーグループを作るために

開発

広告

はじめに

slackでよく使われているものの一つでチャンネルと呼ばれるものがあります。チャンネル内で特定の人に通知を限定して送ることができます。それがメンションと呼ばれるものになります。@channelでチャンネル内の人すべて、@hereでチャンネル内で現在アクティブの人等があります。それとは別に、グループを作り、該当する人のみで作成するものもあります。それがユーザーグループと呼ばれるものになります。今回はユーザーグループというものをAPIを通して作る上で重要なことをまとめてみることにします。 slackのAPIに関してはこちら

slackのAPIを使うために(API Methods)

  • tokenが必要
API Methodsを使うためにtokenが必要となりますので、事前に取得しておきます。https://api.slack.com/custom-integrations/legacy-tokens

ユーザーグループの作成

usergroups.create メソッド

必要なパラーメータ

  • token(必須)
  • URLの指定(必須)
  • name(必須)
  • channels(任意)
  • description(任意)
  • handle(任意)
usergroups.createを使うためのURLは、https://slack.com/api/usergroups.create
となっています。nameに関しては、ユーザーグループの名前に該当します。こちらに関しては、他のユーザーグループ名と重複しては作ることができません。channelsに関しては、カンマ区切りで複数指定することができます。デフォルトのチャンネルを設定することができます。
descriptionに関しては、説明となります。こちらは任意ですので必要であれば記述するようにします。
handleについてですが、実際にメンションの記述をする際に、handleを指定することでメンションを指定することができます。handleの指定は任意ですが、handleを指定しないとメンションをつける際に@だけになってしまいますので、設定しておくのがおすすめです。また、こちらに関しては、チャンネル名とユーザーグループのhandleで重複して作ることができず、ユニークで指定しなければなりません。

実行方法

  • slackのAPIのtesterからパラメータを指定して、実行する
  • curlを実行
  • プログラムから、curlを実行する

広告