機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. チャット認証

すべてのチャット認証の取得 - サポートなし

get

/crmRestApi/resources/11.13.18.05/chatAuthenticate

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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 : サポートされていません。
      ファインダ変数:
      • authUserName; string; サポートされていません。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : chatAuthenticate
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : chatAuthenticate-item-response
タイプ: object
ソースを表示
  • 販売またはサービスなどの顧客対応のアプリケーション分類です。 この属性はオプションです。
  • この顧客対応に割り当てる提案されたリソースの一意の識別子。 この属性はオプションです。
  • ログイン・ユーザーの一意の識別子。 この属性は必須です。
  • 顧客対応リクエストが関連付けられているビジネス・ユニットの一意の識別子。 この属性はオプションです。
  • 顧客対応リクエストのカテゴリの一意の識別子。 この属性はオプションです。
  • 他のチャット・インタラクションと比較した特定のチャット・インタラクションの優先度。 この属性はオプションです。 chatPriority値が大きいほど、チャット・ルーティングに使用されるチャットの対話優先度が高くなります。
  • 認証コールによって返されたチャネル・サーバーのサイトの名前。 これはレスポンス属性であり、クライアントで入力しないでください。
  • 顧客対応を認証するユーザーのタイプ。 現在使用可能な値はCONSUMERです。 この属性は必須です。
  • 顧客対応の認証を行うユーザーに関連付けられたパーティの一意の識別子。 この属性はオプションです。
  • この顧客対応の割当に使用されるカスタム・フィールドのキー値ペアを含むJSON文字列。 この属性はオプションです。
  • 認証コールによって返されたチャネル・サーバーのドメイン・アドレス。 これはレスポンス属性であり、クライアントで入力しないでください。
  • 顧客対応の認証を行うユーザーのEメール・アドレス。 この属性はオプションです。
  • チャット・インタラクションがエスカレーションされたレベル。 デフォルト値は0で、これはエスカレーションがないことを意味します。 この属性はサポートされていません。
  • インタラクションの認証を行うユーザーの名。 この属性はオプションです。
  • サービス・リクエスト、販売商談など、顧客対応に関連するエンティティに割り当てられるリソースの一意の識別子。この属性はサポートされていません。
  • 製品、サービス・リクエスト、販売機会など、顧客対応に関連するエンティティの一意の識別子。この属性はオプションです。
  • 製品、サービス・リクエスト、販売機会など、顧客対応に関連するエンティティの名前。この属性はオプションです。
  • サービス・リクエスト、販売商談など、顧客対応に関連するエンティティの重大度の参照コード。 この属性はオプションです。
  • 製品、サービス・リクエスト、販売機会など、顧客対応に関連するエンティティのタイプ。この属性はオプションです。
  • チャネル・サーバーとの相互作用で使用されるインタフェースの一意の識別子。 インタフェース識別子は、システム生成メッセージの言語を定義します。 この属性はオプションです。
  • 在庫品目の一意の識別子。 製品を識別するために、inventoryOrgIdおよびprodGroupIdとともに使用されます。 この属性はオプションです。
  • 在庫組織の一意の識別子。 製品を識別するために、inventoryItemIdおよびprodGroupIdとともに使用されます。 この属性はオプションです。
  • 認証コールによって返されたJSON Webトークン。 これはレスポンス属性であり、クライアントで入力しないでください。
  • 顧客対応の認証を行うユーザーの姓。 この属性はオプションです。
  • Links
  • チャネル・タイプ名と、そのチャネルに対するエンド・ユーザーのマシン機能のエラー・リスト(オプション)の組合せである複合配列をエンコードするオプション属性。 チャネル・タイプ名の有効な値は、CHAT、VIDEOおよびCOBROWSEです。 ビデオ・チャネル・エラーの有効な値は、NO_CAMERA、NO_MICROPHONEおよびNO_SPEAKERSです。 他のチャネル・エラーの有効な値は、BROWSER_NOT_SUPPORTEDおよびINSECURE_ORIGINです。 配列内の複合要素はセミコロンで区切られ、エラーはカンマで区切られ、チャネル・タイプとその対応するエラーはコロンで区切られます。 例: ???mediaList??? : ???CHAT:NO_KEYBOARD;VIDEO:NO_CAMERA,NO_MICROPHONE???.
  • 顧客対応の認証を行うユーザーに関連付けられたアカウントの一意の識別子。 この属性はオプションです。
  • 認証コールによって返されるチャネル・サーバーのプールの一意の識別子。 これはレスポンス属性であり、クライアントで入力しないでください。
  • 顧客対応の割当先を決定する際にプリファレンスを与える必要があるリソースの一意の識別子のカンマ区切りリスト。 この属性はサポートされていません。
  • 製品グループの一意の識別子。 製品を識別するために、inventoryOrgIdおよびinventoryItemIdとともに使用されます。 この属性はオプションです。
  • 製品の一意の識別子。 この属性は使用されていません。
  • 顧客対応リクエストの件名。
  • この顧客対応で使用される内部キューの一意の識別子。 この属性はオプションです。
  • セッションを再開するかどうかを示します。 使用可能な値は、RESUMEおよびDO_NOT_RESUMEです。 この属性はオプションです。
  • 顧客対応の割当先を決定するときに除外する必要があるリソースの一意の識別子のカンマ区切りリスト。 この属性はサポートされていません。
  • CRM、HRHD、ISRなど、顧客対応が属するアプリケーション。 この属性はオプションです。
  • エンドユーザーのブラウザ履歴の一意の識別子は、この対話を処理しているエージェントへのエンドユーザーのページ訪問に関するインサイトを提供します。 この属性はサポートされていません。
「トップに戻る」