機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 電子メールの確認

すべてのEメール検証の取得

get

/crmRestApi/resources/11.13.18.05/emailVerification

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey : 指定された主キーの検証済データを検索します。
      ファインダ変数:
      • Id; integer;検証済データの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • Domain; string;指定された電子メール・アドレスのドメイン部分。
    • Duration; string;電子メールの検証にかかる時間(秒単位)。 最大タイムアウトは15秒で強制されます。 返されるタイムアウト・レスポンスの数を最小限に抑えるため、タイムアウト値を15秒以上に高めることをお薦めします。
    • EmailAddress; string; 検証された電子メール・アドレス。
    • EmailVerificationEnabled; string; 検証サービスが有効かどうかを示します。
    • Id; integer;検証済データの一意の識別子。
    • IsComplainerOrFraudRisk; string; Eメール・アドレスが既知の苦情者リストに対して認識されるか、不正行為に使用されたかを示します。
    • IsDisposableOrTemporary; string; 指定された電子メール・アドレスが一時メールボックスかどうかを示します。 組織によっては、マーケティング・コミュニケーションに使用しない一時的なメールボックスを作成する場合があります。
    • ResponseCode; string; 有効な、Valid_CatchAll、無効、タイムアウトなどのレスポンス・コード。
    • ResponseMessage; string;返されるレスポンス・コードのテキストによる説明。 たとえば、有効は、アカウント部分を含むEメール・アドレスが完全に検証されたことを意味します。Valid_CatchAllは、ドメインが検証されたが、アカウントを検証できなかったことを意味します。無効は、Eメール・アドレスが無効であり、受け入れられないことを意味し、タイムアウトは、指定したタイムアウト内に検証を完了できなかったことを意味します。 タイムアウトをレスポンス・コードとして受信した場合は、タイムアウト値を増やします。
    • UserAccount; string; 指定された電子メール・アドレスのアカウント部分。
    • VerificationCode; string; 指定された電子メール・アドレスの検証コード。
    • VerificationHelpText; string;返される検証ステータスのテキスト・ヘルプの説明。
    • VerificationStatus; string; 指定された電子メール・アドレスの検証ステータス。
    • VerificationText; string;返される検証コードのテキストによる説明。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : emailVerification
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : emailVerification-item-response
タイプ: object
ソースを表示
  • 指定された電子メール・アドレスのドメイン部分。
  • 電子メールの検証に要した時間(秒単位)。 最大タイムアウトは15秒で強制されます。 返されるタイムアウト・レスポンスの数を最小限に抑えるため、タイムアウト値を15秒以上に高めることをお薦めします。
  • 検証された電子メール・アドレス。
  • 検証サービスが有効かどうかを示します。
  • 検証済データの一意の識別子。
  • Eメール・アドレスが、苦情の既知のリストに対して認識されるか、不正行為に使用されたかを示します。
  • 指定されたEメール・アドレスが一時メールボックスかどうかを示します。 組織によっては、マーケティング・コミュニケーションに使用しない一時的なメールボックスを作成する場合があります。
  • Links
  • 有効、Valid_CatchAll、無効、タイムアウトなどのレスポンス・コード。
  • 返されたレスポンス・コードのテキストによる説明。 たとえば、有効は、アカウント部分を含むEメール・アドレスが完全に検証されたことを意味します。Valid_CatchAllは、ドメインが検証されたが、アカウントを検証できなかったことを意味します。無効は、Eメール・アドレスが無効であり、受け入れられないことを意味し、タイムアウトは、指定したタイムアウト内に検証を完了できなかったことを意味します。 タイムアウトをレスポンス・コードとして受信した場合は、タイムアウト値を増やします。
  • 指定されたEメール・アドレスのアカウント部分。
  • 提供された電子メール・アドレスの確認コード。
  • 返される検証ステータスのテキスト形式のヘルプの説明。
  • 指定された電子メール・アドレスの検証ステータス。
  • 返される検証コードのテキスト形式の説明。
「トップに戻る」