新規問い合わせ作成

[mapps-tsutsum]

新規問い合わせ作成

sequenceDiagram
    Otonari Mobile ->> Otonari API: 問い合わせ送信
    Otonari API ->> freshdesk: チケット作成 API 呼び出し[*1]
    freshdesk -->> Otonari API: 作成されたチケットの情報
    Otonari API ->> freshdesk: ユーザー情報更新 API 呼び出し[*2]
    freshdesk -->> Otonari API: 更新されたユーザーの情報
    Otonari API ->> Otonari Mobile: 問い合わせ受付メッセージ送信

サポートスタッフが問い合わせに返答

sequenceDiagram
    Support Staff ->> freshdesk: チケットに公開メモを追加
    freshdesk ->> Otonari API: Webhook でサポートスタッフ返答 API 呼び出し[*3]
    Otonari API ->> Otonari Mobile: 問い合わせ返答メッセージ送信

ユーザーが問い合わせに返答

sequenceDiagram
    Otonari Mobile ->> Otonari API: 返答メッセージ送信
    Otonari API ->> freshdesk: inquiries.id を条件にチケット検索 API 呼び出し[*4]
    freshdesk -->> Otonari API: 検索結果のチケットの情報
    Otonari API ->> freshdesk: users.open_id を条件にユーザー検索 API 呼び出し[*5]
    freshdesk -->> Otonari API: 検索結果のユーザーの情報
    Otonari API ->> freshdesk: チケット メモ追加 API 呼び出し[*6]

API / Webhook

freshdesk ドキュメント

API: https://developers.freshdesk.com/api/

Webhook: https://support.freshdesk.com/support/solutions/45927

チケット作成 API [*1]

• POST /api/v2/tickets
  • name : ユーザー名
  • unique_external_id : ユーザーID（OPEN ID）
  • subject : [issue:{inquiries.id}] {本文の先頭から10文字}
  • status : 2 (Open)
  • priority : 1（Low） ※要検討
  • description : メッセージ本文（HTML形式）
  • ユーザーの user-agent を末尾に付加する
  • otonari の inquiry の URL を末尾に付加しても良いかもしれない
  • custom_fields : {"cf_otonari_inquiry_id": [otonari inquiries.id]}
  • source : 100（追加した Otonari App）
• unique_external_id が同一のユーザーが freshdesk 上に存在しない場合は自動でユーザーが追加される
  • ユーザーが存在していたとしても、ユーザー名はリクエストパラメータで上書き更新されないため、ユーザー名を同期させるためユーザー情報更新 API を呼び出す必要がある

ユーザー情報更新 API [*2]

• PUT /api/v2/contacts/{id=ticket作成時のレスポンスに含まれる requester_id}
  • name : ユーザ名
  • description : otonari のユーザー情報ページの URL を入れておく
• ユーザー情報は変更されている可能性があるため、常に更新をかける

サポートスタッフ返答 API 呼び出し Webhook[*3]

• freshdesk 管理 [ワークフロー] -> [自動化] -> [チケットの更新] に新規作成
• 条件
  • When an action performed by Agent
  • When public Note is Added
  • If Source is Otonari App
• アクション
  • Webhook
  • URL: otonari-api に用意する API
  • リクエストタイプ: POST
  • エンコーディング: JSON
  • コンテンツ: 複雑
  • "freshdesk_ticket_id": "{{ticket.id}}",
  • "otonari_inquiry_id": "{{ticket.cf_otonari_inquiry_id}}",
  • "reply_message": "{{ticket.latest_public_comment}}"
    • 注意：メッセージ本文の先頭に投稿者の名前が入ってしまうので、API 側で除去する必要がある

チケット検索 API [*4]

• GET '/api/v2/search/tickets?query="cf_otonari_inquiry_id:{inquiries.id}"'
• inquiries.id は返答メッセージの channel_id で inquiries.channel_id を検索すれば取得できる（レコードがあればそれは問い合わせへの返答、と判断できる）

ユーザー検索 API [*5]

• GET '/api/v2/search/contacts?query="unique_external_id:{users.open_id}"'