KcPieonとenterpriseの連携について

回答済み

コメント

6件のコメント

  • 正式なコメント
    Kompiraサポートチーム

    ご質問ありがとうございます。
    Kompira cloud開発チームの本田と申します。
    回答させていただきます。

    ・電話連絡時に回線の空きがない場合の挙動について

    回線に空きがない場合連絡は「開始待ち」ステータスとなり、回線が空き次第自動的に連絡を開始します。

    ・Kompira enterpriseからの架電情報の取得について

    Pigeonの架電実行時には一意な結果IDが発行され、これを用いてWeb APIより架電情報の取得が可能です。
    Kompira enterpriseとの連携を行う場合、例えば下記のようなフローで実現可能です。

    1. PigeonのWeb APIリクエストを行い、架電実行を行う
    2. レスポンスから結果IDを取得する
    3. 一定時間ごとに架電情報APIから情報を取得(ポーリング)する
    4. 架電情報内のステータスを確認する
    5. 架電終了を示すステータスを確認したら、次の処理(メール連絡やインシデント登録)を実行する

    またこちらはベータ機能となりますが、Pigeonでの連絡終了時に架電結果をメール通知するようAPIから設定が可能です。
    この通知メールをKompira enterpriseで取得し、これを契機にメール内容から架電情報を取得しつつ、次の処理に繋げる形でも実現可能となります。

    コメントアクション Permalink
  • auto_ope

    暫く期間が開きまして申し訳ございません。

    もう少しご教示ください。

    上記の2~4について具体的なコマンド等をご教示頂けますでしょうか。

    2.レスポンスIDとは「resultId」の事でしょうか

    3.情報取得する具体的なコマンドをご教示頂けますでしょうか。

    4.ステータスにはどのようなステータスがあるのでしょうか

      一覧みたいなものはございますでしょうか。

    0
    コメントアクション Permalink
  • Kompiraサポートチーム

    ご回答いたします。

    > 2. レスポンスIDとは「resultId」の事でしょうか

    「resultId」で問題ございません。
    回答中では「結果ID」と日本語で記載したため紛らわしかったかと思います。申し訳ありません。

    > 3. 情報取得する具体的なコマンドをご教示頂けますでしょうか。

    curlコマンドでの例を挙げますと、下記の様になります。
    (URLのドメイン部はお使いのスペースのものに、{apiKey}はお使いのスペースにて発行したAPIキーに、末尾の{resultId}は具体的なresultIdに置き換えて発行してください)

    curl -H "X-Authorization: Token {apiKey}" https://xxxx.cloud.kompira.jp/api/apps/pigeon/results/{resultId}

    上記コマンドを実行するとJSON形式にて連絡に関する情報が取得できます。
    APIキーの発行については Pigeonチュートリアル に記載されておりますので、合わせてご参照ください。

    なお、Kompira EnterpriseにはHTTPリクエストを送信するための組み込み関数 urlopen() が用意されており、上記のcurlコマンドと同じ処理を実行することが可能です。
    ジョブフロー中で使用するにはこちらの方が便利なケースもございますので、Kompira Enterpriseのマニュアルを参考にこちらも利用をご検討ください。

    > 4. ステータスにはどのようなステータスがあるのでしょうか

    連絡のステータスには下記のものがございます。
    (カッコ内はWeb画面上で確認した際のステータス表示です)

    - preparing (準備中)
     → 連絡のリクエスト直後にごく一瞬のみ滞在するステータスです
    - waiting (待機中)
     → 他の連絡により回線が埋まっており、空き待ちをしている間のステータスです
    - processing (架電中)
     → コールフローの設定に従い、連絡を行っている間のステータスです
    - aborting (中止待ち)
     → 連絡のキャンセルをリクエストしてから、実行中の架電の終了が確認されるまで滞在するステータスです
    - succeeded (成功)
     → 電話が取られ、「終了」に設定されたキー入力により通話が完了した場合のステータスです
    - aborted (中止)
     → 連絡のキャンセルがリクエストされ、全ての架電の終了が確認された後のステータスです
    - failed (失敗)
     → 誰も「終了」に設定されたキー入力を行わず、コールフローのループ上限を超過した時のステータスです

    なお、ステータスは先のAPIより取得したJSONデータの「status」フィールドより取得可能です。

    0
    コメントアクション Permalink
  • auto_ope

    ご教示有難うございます。

    3.についてurlopen関数を使用してリクエストを送信したいと考えておりますが、apiKeyをどのようにしてパラーメータとして渡せば良いかわからず、サンプルなどございませんでしょうか

    0
    コメントアクション Permalink
  • Kompiraサポートチーム

    Kompira EnterpriseからPigeonを呼び出すジョブフローの実現例はコラム記事として公開済みでございました。
    下記の記事に実現の流れが一通り解説されており、またその中でurlopen関数の具体的な使用法について触れられておりますので、ご参照ください。

    Enterprise技術情報 - Kompira cloud Pigeonを利用した通知電話の利用

    0
    コメントアクション Permalink
  • auto_ope

    ご教示有難うございます。

    当方でも確認することが出来ました。

    もう少し確認ですが、「aborted」というステータスは具体的にどのような場合にこのステータスとなるのかわからず、ご教示頂けませんでしょうか。

    0
    コメントアクション Permalink

サインインしてコメントを残してください。