FAQ 【2024年4月】Re:lation APIの拡張について

（2024年4月1日 作成）
この度Re:lation APIにおいて、新たなエンドポイント、リクエストパラメータ、レスポンスの追加を行いました。
これによりAPIを使用し、できることが増えています。
※新しいAPIとレスポンスの追加のみとなり、アドレス帳登録や更新APIには影響はありません。

Re:lation API 仕様書：https://developer.ingage.jp/

以下のAPIを新たに追加しました。
　・テンプレート検索
　・ラベルの登録・更新
　・チケット分類登録・更新
　・コメント作成
　・アドレス帳一覧取得

また、以下については既存のAPIにレスポンスを追加しました。
　・ユーザー一覧取得
　・チケット分類一覧取得
　・受信箱一覧取得
　・チケット更新

■テンプレート検索
新規エンドポイント
POST https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/templates/search

　テンプレートを検索することができます。

■ラベル登録
新規エンドポイント
POST https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/labels

指定した受信箱に新規ラベルを作成できます。

■ラベル更新
新規エンドポイント
PUT https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/labels/<label_id>

　指定したラベルの名前や色を更新できます。

■チケット分類登録
新規エンドポイント
POST https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/case_categories

　指定した受信箱に新規チケット分類を作成できます。

■チケット分類更新
新規エンドポイント
PUT https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/case_categories/<case_category_id>

　指定したチケット分類の名前の変更やアーカイブにできます。

■コメント作成
新規エンドポイント
POST https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/comments

　指定したメッセージに対してコメントの作成ができます。
　※添付ファイルには対応していません
　※Re:lationユーザをコメントの投稿者として指定することはできません

■アドレス帳一覧取得
新規エンドポイント
GET https://<subdomain>.relationapp.jp/api/v2/customer_groups

　登録や更新時に必要なアドレス帳IDが取得できます。

■ユーザー一覧取得
既存のエンドポイント
GET https://<subdomain>.relationapp.jp/api/v2/users

レスポンスに下記を追加しました。
　・email
　・is_tenant_admin
　・is_otp_required

　アカウントオーナーかどうか、多要素認証が有効かどうかが分かるようになりました。

■チケット分類一覧取得
既存のエンドポイント
GET https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/case_categories

レスポンスに下記を追加しました。
　・archived

　アーカイブ済みのチケット分類かどうかが分かるようになりました。

■受信箱一覧取得
既存のエンドポイント
GET https://<subdomain>.relationapp.jp/api/v2/message_boxes

レスポンスに下記を追加しました。
　・customer_group_id

　受信箱に紐づいているアドレス帳IDが分かるようになりました。

■チケット更新
既存のエンドポイント
PUT https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/tickets/<ticket_id>

リクエストに下記を追加しました。
　・notification_mention_name

　スヌーズ復帰時に通知するユーザを指定できるようになりました。

本件に関してのご不明点は株式会社インゲージ サポート担当までお問い合わせください。
お問い合わせは、Re:lation画面左下の[？]アイコンよりサポートチャットまたは「support@ingage.jp」までメールにてご連絡ください。