ユーザ登録について

回答済み

コメント

11件のコメント

  • Kompiraサポートチーム

    ①現在の権限による差異としては、特権ユーザーのみが API トークンを発行できる、という点になります
    ②再登録についての注意事項は特にございません
    ③初期登録されたユーザーは必ず特権を持ち、招待されたユーザーは登録直後は一般ユーザーとなります
    ④ご認識の通りです
     多要素認証の利用有無はプロフィールでの ON/OFF で、どの番号へショートメッセージを送るかは認証時に問われます
    ⑤トライアルと本利用での差異はございません
    ⑥共通部分のマニュアルとして以下がございます
     https://kompira.zendesk.com/hc/ja/articles/4404190405785
     権限については追って更新予定となります

    0
    コメントアクション Permalink
  • 原井麻有

    ご回答ありがとうございました。
    また、共通部分マニュアルの url をご教示いただきありがとうございました。
    存在を知らなかったマニュアルが幾つかございまして、中身を拝見しております。

    その中の一つに「kompira pigeon 基本マニュアル」
    Kompira Pigeon 基本マニュアル (windows.net)
    がございました。
    p33 に
    また、Pigeon では、以下のような操作は API からでのみ実施可能となります。
    ・ 電話連絡の際、一時的な連絡先やコールフロー、ガイダンスを作成して電話連絡を行う
    ・ 電話連絡が終了した際、終了時のステータス(成功/失敗)等を含めた通知を行う
    との記載がございました。

    質問【20210806_2】
    ・ 電話連絡が終了した際、終了時のステータス(成功/失敗)等を含めた通知を行う

    につきまして、今までは架電ステータスについては、Enterprise から API /api/apps/pigeon/results/{resultId} などを定期的に発行して、結果が失敗のものだけを確認する、といった方法があると認識しておりました。
    Pigeon 側から電話連絡が終了した際に、(成功/失敗)の通知を行うことが可能ですか?
    もし可能なら、やり方をご教示ください。

    宜しくお願い致します。

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

    Pigeon 側から電話連絡が終了した際に、(成功/失敗)の通知を行うことが可能ですか?

    APIからの設定となりますが、Pigeonでは連絡の「開始」「成功」「失敗」「中止」の4つに対して、WebhookもしくはEメールによる通知を行う機能がございます。
    この設定方法についてはAPIドキュメント内のPigeonカテゴリ「通知設定の作成」APIの仕様をご覧ください。

    メール通知の場合

    単に人向けに通知を行うのであればメール通知を用いるのが簡単で、その場合例えば下記の文面がメールにて送信されます。

    以下の連絡に失敗しました。

    https://xxx.cloud.kompira.jp/apps/pigeon/results/ad3ee585-6313-4411-b3d4-9ed8cc6f695a
    失敗理由: loop limit exceeded

    ※このメールは自動で送信されています。返信はできませんのでご注意ください。
    ※このメールにお心当たりのない方は、恐れ入りますが破棄して頂けますようお願いいたします。

    ------------------------------------------------------
    Kompira cloudサポート
    お問い合わせ  https://www.fixpoint.co.jp/cloudcontact/
    ------------------------------------------------------

    メール本文中に連絡結果のURLが記載されておりますので、ここからさらに詳細を見ることが可能です。

    Webhook通知の場合

    Webhook通知を用いる場合ですと、例えば下記のようなリクエストボディにて通知が行われます。

    {"resultId":"ad3ee585-6313-4411-b3d4-9ed8cc6f695a","reason":"loop limit exceeded"}

    このとき「resultId」はPigeonの連絡結果IDを、「reason」は連絡失敗の場合に失敗事由を示します。

    0
    コメントアクション Permalink
  • 原井麻有

    お世話になっております。
    ご回答ありがとうございました。

    質問【20210806_2】につきまして、もう少し質問をさせてください。


    >>連絡の「開始」「成功」「失敗」「中止」の4つに対して、WebhookもしくはEメールによる通知を行う機能
    についてですが、Pigeonの機能としてならば、上記のステータスを判別させてアクションでのメールかwebhook発動の仕様ではないかと想像しております。


    ①上記のステータスをAPIから設定するということは、どこからPOSTコマンドを発行するのでしょうか?
    ルールやトリガーのイベントにはそういった機能は見当たらないようですが、Enterprise からPigeon に「通知設定の作成」API を発行して、必要な event のステータス chain:failed を作成しておき、それを深刻度名にしておいてトリガーの実行条件で chain:failed と等しかったらアクションを実行し、メールを送信する、といった仕様でしょうか?間違っていたらご指摘ください。

    ②またcurl コマンドで「通知設定の作成」API を試そうと思っていますが(Enterprise → pigeon)、以下のような形態でよろしいでしょうか?「どの架電に対して」という指定も必要かと思いますので、間違い等々ご指摘ください。
    curl  -x プロキシサーバ:ポート番号  http://kompira cloud url  -X POST -H "Content-Type:application/json"  d='{"event"}:{"chain:failed"}' 

    以上、よろしくお願いいたします。

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

    ①上記のステータスをAPIから設定するということは、どこからPOSTコマンドを発行するのでしょうか?

    Pigeonの通知機能はAlertHubとは全く関係しないPigeonの単体機能となっており、外からイベント指示を行うのではなく、Pigeonの連絡の進捗に合わせて自動的に通知が発生します。

    発生の契機としてはそれぞれ下記の通りとなります。

    • 開始(chain:started): 連絡のステータスが「架電中」に変わったとき
    • 成功(chain:succeeded): 連絡のステータスが「成功」に変わったとき
    • 成功(chain:aborted): 連絡中止APIが呼ばれたとき(もしくは、連絡中止ボタンが押されたとき)
    • 成功(chain:failed): 連絡のステータスが「失敗」に変わったとき

    ②またcurl コマンドで「通知設定の作成」API を試そうと思っていますが(Enterprise → pigeon)、以下のような形態でよろしいでしょうか?「どの架電に対して」という指定も必要かと思いますので、間違い等々ご指摘ください。

    残念ながら、Pigeonの通知機能は特定の連絡や特定のコールフロー・ガイダンスを指定して行うものではなく、そのスペースから行われたすべての連絡実行が対象となります。そのため「どの架電に対して」という指定はございません。

    通知設定の作成について、いただいた例をもとに正しいと思われるcurlコマンド実行例を示しますと、下記のようになります。(「<>」にて囲われている箇所は「<>」ごと具体的な値に置き換えください)

    curl -x <プロキシサーバ>:<ポート番号> https://<スペースURL>/api/apps/pigeon/notification-settings -X POST -H "Content-Type: application/json" -H "X-Authorization: Token <使用するAPIトークンの値>" -d '{"disabled":false,"displayName":"連絡失敗通知","emails":["<送信先のメールアドレス>"],"events":["chain:failed"],"kind":"email"}'

    (コマンド例は長く、横にスクロールしますのでご注意ください)

    上記のコマンドにより、連絡失敗時に「<送信先のメールアドレス>」に指定されたメールアドレスに対してメール通知が行われるように設定が作成されます。

    0
    コメントアクション Permalink
  • 原井麻有

    速やかなご回答ありがとうございます。

    ③では、上記 curl コマンドによって、Pigeon に「通知設定の作成」を行うことで、作成したステータス"failed" については、自動的に指定したメールアドレスに通知が届くように、全ての架電において半永久的に出来るという認識で良いでしょうか?

    ②上記url で指定しているAPIトークンは、Enterprise からのcurl コマンド発行なので、Enterprise REST API でしょうか?もしそうなら、REST API のトークン有効期限は指定(管理)できましたでしょうか?

    ③今まで、架電失敗についてはずっと何等かの気づきができるようにしたいと調査してきたつもりなのですが、今回の「通知設定を作成」して自動でメール通知する方法は存じ上げませんでした。私が今回指摘したマニュアルの記載(「kompira pigeon 基本マニュアル」p33)以外に、どこに情報が載っているのでしょうか?

     

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

    上記 curl コマンドによって、Pigeon に「通知設定の作成」を行うことで、作成したステータス"failed" については、自動的に指定したメールアドレスに通知が届くように、全ての架電において半永久的に出来るという認識で良いでしょうか?

    そのご認識で相違ございません。

    上記url で指定しているAPIトークンは、Enterprise からのcurl コマンド発行なので、Enterprise REST API でしょうか?もしそうなら、REST API のトークン有効期限は指定(管理)できましたでしょうか?

    APIトークンは「APIリクエスト先」のシステムに対して認証を行うための情報となります。
    今回のケースであれば「リクエスト元」であるEnterpriseではなく、「リクエスト先」であるクラウド側のAPIトークンを指定する必要がございます。(APIトークンはWeb画面の「設定」→「API token」より発行可能です)

    今まで、架電失敗についてはずっと何等かの気づきができるようにしたいと調査してきたつもりなのですが、今回の「通知設定を作成」して自動でメール通知する方法は存じ上げませんでした。私が今回指摘したマニュアルの記載(「kompira pigeon 基本マニュアル」p33)以外に、どこに情報が載っているのでしょうか?

    Pigeonの通知設定に関しては画面機能がないことから情報公開が不十分な機能となっており、指摘いただいたマニュアル以外には情報が乗っていない可能性が高いと思われます。

    こちらでのやりとりまで含めますと、以前いただいたご質問「 複数のコールフローで、引継ぎ利用ができますか? 」にて一度話題には挙げられている様子です。

    0
    コメントアクション Permalink
  • 原井麻有

    ご回答ありがとうございました。

    curl コマンドで通知設定の作成をする運用を一考したいと思います。
    それで恐縮ですが、また追加で質問をお願いいたします。

    質問【20210811_1】

    通知設定一覧の取得方法について教えてください。

    curl -X GET "https://xxx-xxxxxxx.cloud.kompira.jp/api/apps/pigeon/notification-settings" -H "Content-Type: application/json"

     

    のように最低限のGETコマンドを投入したところ、以下のエラーが出ました。
    error: title":"Authorization error","detail":"Access denied","instance":"/api/apps/pigeon/notification-settings"}

    ①curl コマンドを入れる際は、必ず

    -H "X-Authorization: Token <使用するAPIトークンの値>" がいるのでしょうか?

    ② "disabled": true, "disabled": false, の使い分けはどのようにすれば良いでしょうか?

    ③例えば以下の例のように、必要な指定一覧のわかるもの、その意味などわかるものはないでしょうか?

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

    ①curl コマンドを入れる際は、必ず

    -H "X-Authorization: Token <使用するAPIトークンの値>" がいるのでしょうか?

    APIを使用する場合、X-AuthorizationヘッダによるAPIトークンの指定は必ず行う必要がございます。

    ② "disabled": true, "disabled": false, の使い分けはどのようにすれば良いでしょうか?

    作成する設定をそのまますぐに適用する場合は常に false を指定していただいて構いません。

    このフィールドの利用例として、通知設定は設定だけあらかじめ作っておいて、実際に通知を発生させるのはメール連絡先やWebhook連携先との調整が済むまで待ちたい、というケースがございます。そういったシーンでは「"disabled": true」で無効化した状態で設定を作成し、後から有効化する、といったことができるようになっております。

    ③例えば以下の例のように、必要な指定一覧のわかるもの、その意味などわかるものはないでしょうか?

    APIドキュメントの「Request body」の項にはAPIに対しての指定例が表示されておりますが、この表示丈夫の「Schema」をクリックすることで指定可能なフィールド一覧が確認可能です。

    APIの取り扱いは不慣れな方にとっては難しく、この情報が十分にお役に立つかはわかりませんが、参考になれば幸いです。

    0
    コメントアクション Permalink
  • 原井麻有

    お世話になっております。
    上記 GET コマンドにて、同じエラーが出てしまいます。
    申し訳ありませんが、ご教示願えますでしょうか?

    質問【20210824_3】

    入力:

    [infraope@TRHEL7305 ~]$ curl -X GET "https://ajs-kompira.cloud.kompira.jp/api/apps/pigeon/notification-setting/{notificationSettingId}" -H "Content-Type:application/json" -H"X-Authorization:Tokun XXXXXXXXXXXXXXXXXXX" -d'{"disabled":false,"displayName":"通知設定取得","events":["chain:failed"]}ed"]}'

     

    エラー:
    {"type":"https://fixpoint.co.jp/probs/authorization","title":"Authorization error","detail":"Access denied","instance":"/api/apps/pigeon/notification-setting/notificationSettingId"}
    宜しくお願い致します。

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

    まず、記載いただいたご質問の中に API トークンが記載されていましたので、こちらはマスクさせていただきました。
    API トークンとスペースのアドレスが外部に知られると御社が利用しているスペースに対して、
    意図しない操作が行われる可能性もありますのでお気をつけください。
    ---

    お送りいただいた入力内容とエラー内容ですが、
    認証できなかったことでのエラーが返却されています。

    この原因ですが、ヘッダでの API トークンの指定に問題があると思われます。
    `-H` オプションの後に空白が無いことや、`Token` が `Tokun` となっていることなどです。

    また、今回はエラーには直接関係していませんが、API の URL が異なっていることと、
    GET の API に `-d` オプションで POST 用の不要な情報が付加されています。

    確認を行っていただくために以下に実行内容を記載しましたので、
    トークンの文字列を置き換えた上で実行確認していただいてもよろしいでしょうか。

    成功しますと、Pigeon の通知設定情報が一覧取得されるものとなります。

    curl -X GET "https://ajs-kompira.cloud.kompira.jp/api/apps/pigeon/notification-settings" -H "Content-Type:application/json" -H "X-Authorization:Token XXXXXXXXXXX"
    0
    コメントアクション Permalink

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