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

（2023年9月14日 作成）

この度Re:lation APIにおいて、新たなエンドポイント、リクエストパラメータ、レスポンスの追加を行いました。
これによりAPIを使用し、できることが増えています。
※新しいAPIの追加もしくは既存APIへの機能追加（互換性は維持）となります。
　なお、既存のアドレス帳登録や更新のAPIには影響はありません。

以下のAPIを新たに追加しました。
Re:lation API 仕様書：https://developer.ingage.jp/

　・新規メール送信
　・メール返信
　・チケット更新
　・テンプレート一覧取得
　・チケット検索の機能拡張
　・チケット1件取得の機能拡張
　・メッセージ添付ファイル取得

■新規メール送信
新規エンドポイント
POST https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/mails

　メールを新規作成し、送信ができます。
　宛先・件名・本文・送信後のチケットステータスを指定します。
　添付ファイルをつけることはできません
　ラベルなどを付与したい場合は後述のチケット更新APIをご利用ください

■メール返信
新規エンドポイント
POST https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/mails/reply

　指定したチケットに対してメール返信します
　宛先・件名・本文・送信後のチケットステータスを指定します
　添付ファイルをつけることはできません
　ラベルなどを付与したい場合は後述のチケット更新APIをご利用ください

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

指定したチケットに対して、下記情報を更新できます
　・ステータス（保留の場合は保留理由とスヌーズ復帰日時・コメントも指定可）
　・担当者（要承認・コメントも）
　・フラグ
　・ラベル
　・チケット分類

■テンプレート一覧取得
新規エンドポイント
GET https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/templates

　テンプレート設定を一覧で取得します
　インライン画像・添付ファイルには対応していません

■チケット検索の機能拡張
既存のエンドポイント
POST https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/tickets/search

　ラベルを指定してチケットを検索できるようになります
　ラベルID を複数指定したときは AND 検索になります

リクエストパラメータに下記を追加
（必須項目ではないため、ラベルで検索しない場合は既存の API 呼び出しプログラムを修正する必要はありません）
label_ids、array[integer]

■チケット1件取得の機能拡張
既存のエンドポイント

GET https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/tickets/<ticket_id>

　レスポンスにコメント一覧を追加します
　レスポンスに添付ファイル一覧を追加します
　（項目追加のため、コメントおよび添付ファイル情報を見ないのであれば既存の API 呼び出しプログラムを修正する必要はありません）

{
  "ticket_id": 12,
  "assignee": "admin",
  "status_cd": "closed",
    :
    :
  "messages": [
    {
      "message_id": 31,
      "from": null,
      "to": null,
        :
        :
      "last_updated_at": "2020-11-13T01:39:38Z",
      "comments": [ // ← ※※※ この項目が追加されます ※※※
        {
         "commenter": "y.suzuki",
         "comment_type": "request",
         "comment": "承認よろしくお願いします。",
         "commented_at": "2020-11-13T00:30:12Z"
        }, ...
      ],
      "attachments": [ // ← ※※※ この項目が追加されます ※※※
        { attachment_id: 765, file_name: "abc123.jpg" },
        { attachment_id: 766, file_name: "def456.pdf" }, ...
      ]
    }, ...
  ]
}

■メッセージ添付ファイル取得
新しいエンドポイント

GET https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/messages/attachments/<attachment_id>

　添付ファイルIDを指定して、メールの添付ファイルをダウンロードできます
　添付ファイルID はチケット1件取得APIのレスポンスから取得してください

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