機械翻訳について
  1. Engagement Cloud Oracle FusionサービスでのチャットのチャットREST APIREST API
  2. リファレンス
  3. チャット認証について

チャット認証について

chatAuthenticateエンドポイントは、ログインしているDCSユーザーがFusionエージェントとの新しい会話を開始すると、Digital Customer Service (DCS)によって起動されます。 DCSはChat for B2B Service内のサービスで、顧客がデジタル・チャネルを通じて顧客サービスを提供できるようにします - webサイト、電子メール・メッセージ、オンライン・チャット。

chatAuthenticateエンドポイントは、Oracle Service Cloud (OSvC)チャット・サーバー上のエージェントを認証し、JSON Webトークン(JWT)を含むJSONレスポンスを返します。 このJWTは、OSvCチャット・サーバーへのrequestEngagementコールでDCSによって使用されます。 chatAuthenticateエンドポイントは、POST HTTPリクエストを使用してコールされます。

chatAuthenticateエンドポイントのURIは次のとおりです: 

/serviceApi/resources/11.13.0.0/chatAuthenticate

chatAuthenticateエンドポイントは、資格SVC_REQUEST_FOR_CHAT_PRIVによって保護され、ORA_SVC_CUSTOMER_SELF_SERVICE_USER_ABSTRACTロールに割り当てられたDCS認証済ユーザーのみがコールできます。

サポートされている属性

次の表では、chatAuthenticateリクエスト本文に指定できる属性について説明します。

リクエスト属性 データ型 説明 Required/Optional
clientType 文字列 チャット・サービスによって提供されるREST APIのタイプ。 nullの場合、デフォルトは'CONSUMER'です。 オプション
authUserName 文字列 ログインしているDCSユーザーの一意の識別子。 このフィールドは、JWTペイロードのチャット・サービスに渡され、チャット・サービスによってキーとして使用されます。 必須
contactId Long FUSION.HZ _PARTIES表のログイン済DCSユーザーのPARTY_ID。PARTY_TYPE = 'PERSON'。 オプション
emailAddress 文字列 ログインしているDCSユーザーの電子メール・アドレス。 オプション
firstName 文字列 ログインしているDCSユーザーの名。 オプション
lastName 文字列 ログインしているDCSユーザーの姓。 オプション
organizationId Long FUSION.HZ _PARTIES表のログイン済DCSユーザーのPARTY_ID。PARTY_TYPE = 'ORGANIZATION'。 オプション
question 文字列 ログインしているDCSユーザーに尋ねられた最初の質問。 オプション
queueId Long キューの一意の識別子。 バージョンR 13.17.11以下の場合、値は常に'1'に設定されます。 R 13.17.11より大きいバージョンの場合、値はFusionコードによって設定されます。 この値がFusionコードによって設定される場合、SVC_CHAT_WAIT_TIME_ENABLEDプロファイル・オプションによって決まります。 このプロファイル・オプションの値がNoの場合は、'chatAuthenticate'コール時に設定されます。 このプロファイル・オプションの値がYesの場合は、'requestEngagement'コール時に設定されます。 オプション
interfaceId Long チャット・サービス・インタフェースの一意の識別子。 R 13.18.05より前のバージョンでは、常に'1'です。 R 13.18.05以降では、値はFusionコードによって上書きされます。 必須
resumeType 文字列 チャット・セッションを再開する必要があるかどうかを示します。 受け入れられる値は'RESUME'のみです。 オプション
categoryId Long ログインしているDCSユーザーが投稿した質問に関連するFUSION.SVC _CATEGORIES表のCATEGORY_ID。 オプション
incidentId Long 製品、サービス・リクエスト、販売商談など、顧客対応に関連するエンティティの一意の識別子。 この属性は使用されません。 オプション
productId Long 製品の一意の識別子。 この属性は使用されません。 オプション
incidentName 文字列 FUSION.SVC _SERVICE_REQUESTS表のSR_ID。 オプション
incidentType 文字列 インシデント・タイプのコード。 値は'SVC_SERVICE_REQUESTS'です。 オプション
inventoryItemId 文字列 在庫品目の一意の識別子。 製品を識別するために、inventoryOrgIdおよびprodGroupIdとともに使用されます。 これは、EGP_ITEM_ORG_ASSOCIATIONS表内の製品のINVENTORY_ITEM_IDです。 オプション
inventoryOrgId 文字列 在庫組織の一意の識別子。 製品を識別するために、inventoryItemIdおよびprodGroupIdとともに使用されます。 これは、EGP_ITEM_ORG_ASSOCIATIONS表内の製品のINVENTORY_ORG_IDです。 オプション
prodGroupId 文字列 製品グループの一意の識別子。 製品を識別するために、inventoryOrgIdおよびinventoryItemIdとともに使用されます。 これは、FUSION.QSC _PROD_GROUPS表のPROD_GROUP_IDです。 オプション
businessUnitOrgId 文字列 エンゲージメントに関連付けられたビジネス・ユニットの組織ID。 この属性は、11.13.19.01.0から使用できます。 オプション
chatPriority 文字列 ルーティング・メカニズムがエンゲージメントをエージェントに割り当てる順序を決定するために使用するエンゲージメントの優先度。 この属性は、11.13.19.07.0から使用できます。 オプション
stripeCode 文字列 CRM、HRHD、ISRなど、顧客対応が属するアプリケーション。 オプション
incidentSeverityCode 文字列 サービス・リクエスト、販売商談など、顧客対応に関連するエンティティの重大度の参照コード。 オプション
customFields 文字列 この顧客対応の割当に使用されるカスタム・フィールドのキーと値のペアを含むJSON文字列。 オプション
assigneeID 文字列 提案されているリソースの一意の識別子がこの顧客対応に割り当てられています。 オプション

サポートされているリクエスト・ヘッダー

chatAuthenticateコールに必要なリクエスト・ヘッダーを次に示します:

  • Authorization - このHTTPヘッダーは、リクエストのBasic認証資格証明を指定するために使用されます。 たとえば、Basic ZGNzYWRtaW4xOldlbGNvbWUxです。
  • Content-Type - このHTTPヘッダーは、リソースのメディア・タイプを示すために使用されます。 このコールの値はapplication/vnd.oracle.adf.resourceitem+jsonです。
  • Accept-Language - このHTTPヘッダーは、クライアントが理解できる言語を通知します。 たとえば、en-USです。
  • Accept - このHTTPヘッダーは、クライアントが理解できるMultipurpose Internet Mail Extensions (MIME)タイプとして表されるコンテンツ・タイプを通知します。 このコールの値はapplication/jsonです。

サンプル・ペイロード

chatAuthenticateコールのRESTリクエスト本文の例を次に示します: 

{
	\"clientType\" : \"CONSUMER\",
	\"authUserName\" : \"John Smith\",
	\"categoryId\" : null,
	\"contactId\" : null,
	\"emailAddress\" : \"john.smith@vision.com\",
	\"firstName\" : \"John\",
	\"lastName\" : \"Smith\",
	\"incidentId\" : null,
	\"organizationId\" : null,
	\"productId\" : null,
	\"question\" : \"Question\",
	\"queueId\" : \"2\",
	\"interfaceId\": \"1\",
	\"resumeType\": \"RESUME\",
	\"incidentName\": \"TestIncident\",
	\"incidentType\": \"SVC_SERVICE_REQUESTS\",
	\"inventoryItemId\": null,
	\"inventoryOrgId\": null,
	\"prodGroupId\": null,
	\"businessUnitOrgId\" : null
}

chatAuthenticateコールのRESTレスポンス本文の例を次に示します: 

{
    "authUserName": "John Smith",
    "categoryId": null,
    "chatSiteName": "sdi_11_20_18_2022_21-3586727808788512-Fusion",
    "clientType": "CONSUMER",
    "contactId": null,
    "domain": "chat_rest_server_domain.com",
    "emailAddress": "john.smith@vision.com",
    "firstName": "John",
    "incidentId": null,
    "interfaceId": "1",
    "jwt": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1dCI6Ik9aOVBxbnotd0xraERLclQwSEhBVDFVWE1GQSIsImtpZCI6InRydXN0c2VydmljZSJ9.eyJleHAiOjE1NDc0NzY2MTgsInN1YiI6IkhhcmkgTSIsImF1ZCI6Imh0dHBzOi8vZGVuZHEtZnVzaW9uY2hhdC12aXAudXMub3JhY2xlLmNvbS9lbmdhZ2VtZW50L2FwaS9jb25zdW1lci9zZGlfMTFfMjBfMThfMjAyMl8yMS0zNTg2NzI3ODA4Nzg4NTEyLUZ1c2lvbiIsImlzcyI6IkZ1c2lvbiBBcHBzIiwicHJuIjoiSGFyaSBNIiwiaWF0IjoxNTQ3NDc2NDk4fQ.Qm2PTNP1ji0ay6MGLUTN-8_BCYH0bQ8MmxCOXSmQp8Hf6ljDJm0v5nNTr1ilk4geqe_kC8AmvQzVVXbQUE5dUgPYsiefs67XjDCdzTEfYIO3Wa7OQ0WHui-v7Mfa3xyIbkM9KsGhwVxyxDK-sPRRQLiXVpX_1L0yHn5ZfnioN_ISx_4xycusxHrftNSnzHBju4O09w72j0sP6M7IiwE-zEbKTPPDK-nS0RNSRuLD2Wo3n1KOifQpbB3YfE1i1bPMvsTkSHxkt5Je8Nmr1ReeH1wffuKAzNJJZku90rqe55GItwjWXDUpk96fVSQWEEXRk8DEtr0Cw5qyvZMd64fyCA",
    "lastName": "Smith",
    "organizationId": null,
    "poolId": "353:2",
    "productId": null,
    "question": "Question",
    "queueId": "2",
    "resumeType": "RESUME",
    "incidentName": "TestIncident",
    "incidentType": "SVC_SERVICE_REQUESTS",
    "inventoryItemId": null,
    "inventoryOrgId": null,
    "prodGroupId": null,
    "mediaList": null,
    "businessUnitOrgId": null
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.0.0/chatAuthenticate/John%20Smith",
            "name": "chatAuthenticate",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.0.0/chatAuthenticate/John%20Smith",
            "name": "chatAuthenticate",
            "kind": "item"
        }
    ]
}