アクションのトリガー:custom-phone-providerのイベントオブジェクト

custom-phone-providerアクショントリガーのeventオブジェクトは、カスタム電話メッセージの送信と受信の要求に関するコンテキスト情報を提供します。

プロパティ 説明

event.client

このログイントランザクションが開始されたクライアントに関する情報です。

以下のプロパティを含みます。

  • client_id :文字列ユーザーがログインしているアプリケーションのクライアントIDです。
  • metadata :辞書他のアプリケーションプロパティを含むオブジェクトです。
  • name :文字列アプリケーションの名前(Dashboardで定義)です。

event.connection

(任意)

ユーザーの認証に使用された接続についての詳細です。

以下のプロパティを含みます。

  • id :任意の文字列接続の一意の識別子です。
  • metadata :任意の辞書接続に関連付けられているメタデータです。
  • name :任意の文字列ユーザーの認証に使用される接続名(twittersome-g-suite-domainなど)です。
  • strategy :任意の文字列接続の種類です。ソーシャル接続の場合はevent.connection.strategy === event.connection.nameです。エンタープライズ接続の場合、ストラテジーはwaad(Windows Azure AD)、ad(Active Directory/LDAP)、auth0(データベース接続)などになります。

event.notification

以下のプロパティを含みます。

  • from :文字列‌‌E.164に準拠した送信者の電話番号です。
  • locale :文字列メッセージをレンダリングしたロケール(en_USなど)で、BCP-47の仕様に従います。
  • message_type :文字列です。

    送信されるメッセージの種類(otp_verifyblocked_accountなど)です。

    以下の値を使用できます。

    • otp_verify
    • otp_enroll
    • blocked_account
    • change_password
    • password_breach
  • recipient :文字列E.164に準拠した受信者の電話番号です。
  • delivery_method :列挙型メッセージの送信方法です。textまたはvoiceになります。
  • code :文字列一部の message_typesotp_verifyotp_enrollなど)で使用するワンタイムパスワードです。
  • as_text :文字列テキストメッセージとして送信可能なレンダリング済みのテキストです。
  • as_voice :文字列音声テキストメッセージとして送信可能なレンダリング済みのテキストです。

event.organization

(任意)

現在のトランザクションに関連付けられている組織の詳細です。

以下のプロパティを含みます。

  • display_name :文字列組織のフレンドリー名です。
  • id :文字列組織の識別子です。
  • metadata :辞書組織に関連付けられているメタデータです。
  • name :文字列組織の名前です。

event.request

(任意)

トランザクションを開始した要求についての詳細です。

以下のプロパティを含みます。

  • geoip :任意のオブジェクトです。

    以下のプロパティを含みます。

    • countryCode :任意の文字列
    • countryCode3 :任意の文字列
    • cityName :任意の文字列
    • latitude :任意の文字列
    • longitude :任意の文字列
    • timeZone :任意の文字列
    • subdivisionCode :任意の文字列
    • subdivisionName :任意の文字列
    • continentCode :任意の文字列
    • continentCode :任意の文字列
  • ip :任意の文字列要求の送信元のIPアドレスです。
  • hostname :任意の文字列認証フローに使用されているホスト名です。
  • method :任意の文字列要求に使用されたHTTPメソッドです。
  • language :任意の文字列ブラウザーから要求された言語です。
  • user_agent :任意の文字列トランザクションの開始で受信したUser-Agentヘッダーの値です。

event.tenant

以下のプロパティを含みます。

  • friendly_name :任意の文字列テナントのフレンドリー名です。通常は人間に読めるバージョンのIDです。
  • home_url :任意の文字列定義されている場合、設定にあるテナントのホームURLです
  • id :文字列テナントの名前です。
  • logo_url :任意の文字列定義されている場合、設定にあるテナントのロゴURLです。
  • support_email :任意の文字列定義されている場合、設定にあるテナントのサポートサービスのメールアドレスです。
  • support_url :任意の文字列定義されている場合、設定にあるテナントのサポートサービスのURLです。

event.user

代理で現在のトランザクションが開始されたユーザーを記述するオブジェクトです。

以下のプロパティを含みます。

  • app_metadata :辞書サポートプラン、セキュリティロール、アクセス制御グループなどのユーザーアクセスに影響するユーザー情報を保管するカスタムフィールドです。
  • email :任意の文字列(一意)ユーザーのメールアドレスです。
  • email_verified :ブール値ユーザーのメールアドレスが検証済みかを示します。
  • family_name :任意の文字列ユーザーの姓です。
  • given_name :任意の文字列ユーザーの名です。
  • name :任意の文字列ユーザーのフルネームです。
  • nickname :任意の文字列ユーザーのニックネームです。
  • picture :任意の文字列 ユーザーのプロフィール画像をポイントするURLです。
  • user_id :文字列(一意)ユーザーの一意の識別子です。
  • user_metadata :辞書勤務先の住所、自宅の住所、ユーザーの設定など、ユーザーのアクセスに影響を与えないユーザー情報を保管するカスタムフィールドです。
  • username :任意の文字列(一意)ユーザーのユーザー名です。