[Twilio+Zendesk] Twilio に SIP 接続して Zendesk のチケットを作成する

対象読者

• LINE コール Plus などの SIP 接続で Zendesk API にアクセスしたい人
• Twilio + Zendesk 連携の実装例に興味がある人
• Twilio の音声認識機能の応用例に興味がある人

概要

この記事では、 Twilio が SIP 接続で受け取った音声の内容を認識し、 Zendesk チケット化する方法について解説します。

全体としては次のような流れになります。

• Twilio コンソールの Functions で Zendesk API をコールする実装を作成する
• Twilio コンソールの Studio で SIP 音声を文字起こしする Flow を実装する
• Twilio コンソールの Voice SIP Domains で Domain を作成する

SIP 接続とは

SIP（Session Initiation Protocol）は、インターネット上で音声通話を行うための通信プロトコルです。LINE コール Plus などの VoIP サービスは、SIP を使って通話を制御します。

Twilio とは

Twilio は、音声通話・SMS・チャットなどの通信機能を API 経由で提供するクラウドサービスです。GUI で通話フローを構築できる Studio や、サーバーレス実行環境の Functions などが利用できます。

Zendesk とは

Zendesk は、カスタマーサポート向けのクラウド型 CRM プラットフォームです。API を通じてチケットの作成や更新が可能で、Twilio との連携により通話内容をサポートチケットとして記録できます。

Function の作成

Twilio コンソール の Functions にアクセスします。 Service を任意の名前で作成し、エディタの画面に遷移したら Create your function をクリックします。

Function 名は任意のもので構いません。 function を作成したら、次の内容を入力し、 Save をクリックして保存します。

const axios = require('axios');

exports.handler = async function(context, event, callback) {
  const transcript = event.SpeechResult || "(音声認識結果なし)";
  const from = event.From;
  const to = event.To;

  const zendeskDomain = context.ZENDESK_DOMAIN;
  const zendeskEmail = context.ZENDESK_EMAIL;
  const zendeskToken = context.ZENDESK_API_TOKEN;

  const auth = Buffer.from(`${zendeskEmail}/token:${zendeskToken}`).toString('base64');

  try {
    await axios.post(
      `https://${zendeskDomain}/api/v2/tickets.json`,
      {
        ticket: {
          subject: "音声入力による問い合わせ",
          comment: {
            body: `発信者: ${from}\n着信先: ${to}\n\n--- 音声認識結果 ---\n${transcript}`
          }
        }
      },
      {
        headers: {
          Authorization: `Basic ${auth}`,
          'Content-Type': 'application/json'
        }
      }
    );

    return callback(null, { status: 'success' });
  } catch (err) {
    console.error(err);
    return callback(null, { status: 'error', message: err.message });
  }
};

Settings & More > Environment Variables` をクリックし、 Key と Value に次の内容を登録します。

Key と Value の入力が完了したら Deploy All をクリックし変更を反映します。

Flow の作成

Twilio Studio にアクセスし、新しい Flow を作成します。名前は任意のもので構いません。 Start from scratch を選択し、空の Flow を作成します。

右のオプションから Gather Input on Call をドラッグアンドドロップして配置します。プロパティを次のように設定します。

他はデフォルトのままで構いません。プロパティの設定が完了したら、 Save をクリックして保存し、 Trigger の Incoming Call から gather に接続します。

次に、 Run Function をドラッグアンドドロップで配置します。プロパティを次のように設定します。

Function Parameters に次の Key と Value を登録します。

プロパティの設定が完了したら、 Save をクリックして保存し、 gather の User Said Something から function に接続します。

最終的に Flow が上のようになっていれば問題ありません。 Publish を押して変更を反映します。

SIP Domain の作成

Voice SIP Domains にアクセスします。新しい SIP Domain を作成し、次のように設定します。

他はデフォルトのままで構いません。入力が完了したら Save をクリックし SIP Domain を作成します。

これで手順はすべて完了です。

動作確認

検証用 SIP クライアントから sip:アカウント名@SIP Domain の URI に発信し、 Zendesk にチケットが作成されることを確認します。

sip:your-username@your-sip-domain.sip.twilio.com

まとめ

Twilio を用いることで、SIP 接続を受け取るアプリケーションが GUI 上の操作でローコードで実現できることが分かりました。今回は Zendesk との連携を紹介しましたが、Twilio Functions を用いることでさまざまな API と組み合わせることが可能です。今後も Twilio Functions を利用したアプリケーションについて執筆予定ですので、お楽しみに！