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

チャット認証の作成

post

/crmRestApi/resources/11.13.18.05/chatAuthenticate

リクエスト

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

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : 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など、顧客対応が属するアプリケーション。 この属性はオプションです。
  • エンドユーザーのブラウザ履歴の一意の識別子は、この対話を処理しているエージェントへのエンドユーザーのページ訪問に関するインサイトを提供します。 この属性はサポートされていません。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPOSTリクエストを発行することによって、チャット認証を作成する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/chatAuthenticate

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{

    "clientType" : "CONSUMER",
    "authUserName" : "john.doe.4@us2.oraclecloud.com",
    "categoryId" : 456000,
    "contactId" : 123000,
    "emailAddress" : "john.doe.4@us2.oraclecloud.com",
    "firstName" : "John",
    "lastName" : "Doe",
    "incidentId" : null,
    "organizationId" : 112233,
    "productId" : null,
    "question" : "This is a question",
    "queueId" : "2",
    "interfaceId": "1",
    "resumeType": "RESUME",
    "incidentName": "Incident 200000",
    "incidentType": "SVC_SERVICE_REQUESTS",
    "inventoryItemId": "200000",
    "inventoryOrgId": "300000",
    "prodGroupId": "400000"
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
"authUserName": "john.doe.4@us2.oraclecloud.com",
"categoryId": "456000",
"chatSiteName": "sdi_07_13_17_1643_46-Svcdit-Fusion",
"clientType": "CONSUMER",
"contactId": "123000",
"domain": "bzndv-chatinteg-vip.dv.lan",
"emailAddress": "john.doe.4@us2.oraclecloud.com",
"firstName": "John",
"incidentId": null,
"interfaceId": "1",
"jwt": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1dCI6Ik84Y2xkdXhBbDZnQzgxQ3MxTEFZaVdlaVVyVSIsImtpZCI6InRydXN0c2VydmljZSJ9.eyJleHAiOjE1MDY1MDkyODcsInN1YiI6ImpvaG4uZG9lLjRAYWNtZS5jb20iLCJhdWQiOiJodHRwczovL2J6bmR2LWNoYXRpbnRlZy12aXAuZHYubGFuL2VuZ2FnZW1lbnQvYXBpL2NvbnN1bWVyL3NkaV8wN18xM18xN18xNjQzXzQ2LVN2Y2RpdC1GdXNpb24iLCJpc3MiOiJGdXNpb24gQXBwcyIsInBybiI6ImpvaG4uZG9lLjRAYWNtZS5jb20iLCJpYXQiOjE1MDY1MDkxNjd9.HBedbCQP1RWEn5rDuU3IdgY_KZ8BDrVSHmOt8tPxYu6hNHVNSIP2IhJ-ueGfO8J94MxDPxktwnsW1WUetA5iBvOE9sBF4Zss8ou9TO2t4wOT8MTGxaioR6eZxbUJVSZt-F06atlnLdflvFx5EdhpSmeBTV1BH5ef-hKTxKneagboDKnB3fMZxqYwXbtjgN-Lb3u1ySVucAL2SJZTMAu2BwV9upYhJ_rXY1YpR8vMCeVB4iMAG2TCT7GJRjT9PZvLVaNuJGzv-xHmaUuXwHYsoyfW6mhxjxx7R6mj58c8B5ClS3nDyIGERSh1sXNgS6XHVMnkhymfH1egfXShIZeS7Q",
"lastName": "Doe",
"organizationId": "112233",
"poolId": "452:2",
"productId": null,
"question": "This is a question",
"queueId": "2",
"resumeType": "RESUME",
"incidentName": "Incident 200000",
"incidentType": "SVC_SERVICE_REQUESTS",
"inventoryItemId": "200000",
"inventoryOrgId": "300000",
"prodGroupId": "400000",
"links": [
...
]
}
「トップに戻る」