1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Chat Authentications

Create a chat authentication

post

/crmRestApi/resources/11.13.18.05/chatAuthenticate

Request

Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • This attribute indicates if the agent should be allowed to send attachments. This attribute is optional.
  • The application classification for the interaction such as Sales or Service. This attribute is optional.
  • The unique identifier of the resource being proposed to be assigned to this interaction. This attribute is optional.
  • The unique identifier of the logged in user. This attribute is mandatory.
  • The unique identifier of the business unit that the interaction request is associated with. This attribute is optional.
  • The unique identifier of the category of the interaction request. This attribute is optional.
  • The priority of a particular chat interaction compared to other chat interactions. This attribute is optional. Higher chatPriority value indicates higher chat interaction priority to be used for chat routing.
  • The name of the site of the Channel Server returned by the authenticate call. This is a response attribute, and should not be filled in by the client.
  • The type of the user who authenticates for the interaction. The possible value currently is CONSUMER. This attribute is mandatory.
  • The unique identifier of the party associated with the user who authenticates for the interaction. This attribute is optional.
  • A JSON string that contains Custom Fields key value pairs to be used to assign this interaction. This attribute is optional.
  • The domain address of the Channel Server returned by the authenticate call. This is a response attribute, and should not be filled in by the client.
  • The email address of the user who authenticates for the interaction. This attribute is optional.
  • The level to which the chat interaction has been escalated. The default value is 0 which means no escalation. This attribute is not supported.
  • The first name of the user who authenticates for the interaction. This attribute is optional.
  • The unique identifier of the resource that is assigned to the entity related to the interaction, such as service request, sales opportunity, etc. This attribute is not supported.
  • The unique identifier of an entity related to the interaction, such as product, service request, sales opportunity, etc. This attribute is optional.
  • The name of an entity related to the interaction, such as product, service request, sales opportunity, etc. This attribute is optional.
  • The lookup code for the severity of the entity related to the interaction, such as service request, sales opportunity, and so on. This attribute is optional.
  • The type of the entity related to the interaction, such as product, service request, sales opportunity, etc. This attribute is optional.
  • The unique identifier of the interface to be used in the interaction with the Channel Server. The interface identifier defines the language for system generated messages. This attribute is optional.
  • The unique identifier of the inventory item. It is used along with inventoryOrgId and prodGroupId to identify the product. This attribute is optional.
  • The unique identifier of the inventory organization. It is used along with inventoryItemId and prodGroupId to identify the product. This attribute is optional.
  • The JSON Web Token returned by the authenticate call. This is a response attribute, and should not be filled in by the client.
  • The last name of the user who authenticates for the interaction. This attribute is optional.
  • An optional attribute that encodes a complex array that is a combination of a channel type name and an optional list of errors of the end-user???s machine capabilities for that channel. The valid values for channel type name are CHAT, VIDEO, and COBROWSE. The valid values for Video channel errors are NO_CAMERA, NO_MICROPHONE, and NO_SPEAKERS. The valid values for other channels errors are BROWSER_NOT_SUPPORTED and INSECURE_ORIGIN. The complex elements in the array are separated by a semicolon, the errors are separated by a comma, and the channel type and its corresponding errors are separated by a colon. For example, ???mediaList???: ???CHAT:NO_KEYBOARD;VIDEO:NO_CAMERA,NO_MICROPHONE???.
  • The unique identifier of the account associated with the user who authenticates for the interaction. This attribute is optional.
  • The unique identifier of the Channel Server's pool returned by the authenticate call. This is a response attribute, and should not be filled in by the client.
  • The comma-delimited list of unique identifiers of the resources that should be given preference when determining the assignee for the interaction. This attribute is not supported.
  • The unique identifier of the product group. It is used along with inventoryOrgId and inventoryItemId to identify the product. This attribute is optional.
  • The unique identifier of the product. This attribute is unutilized.
  • The subject of the interaction request.
  • The unique identifier of the internal queue to be used with this interaction. This attribute is optional.
  • Indicates whether to resume the session. The accepted values are RESUME and DO_NOT_RESUME. This attribute is optional.
  • The comma-delimited list of unique identifiers of the resources that should be excluded when determining the assignee for the interaction. This attribute is not supported.
  • The application to which the interaction belongs to, such as CRM, HRHD, ISR. This attribute is optional.
  • The unique identifier of the end-user's browser history provides insight into the end-users page visits to the agent handling this interaction. This attribute is not supported.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : chatAuthenticate-item-response
Type: object
Show Source
  • This attribute indicates if the agent should be allowed to send attachments. This attribute is optional.
  • The application classification for the interaction such as Sales or Service. This attribute is optional.
  • The unique identifier of the resource being proposed to be assigned to this interaction. This attribute is optional.
  • The unique identifier of the logged in user. This attribute is mandatory.
  • The unique identifier of the business unit that the interaction request is associated with. This attribute is optional.
  • The unique identifier of the category of the interaction request. This attribute is optional.
  • The priority of a particular chat interaction compared to other chat interactions. This attribute is optional. Higher chatPriority value indicates higher chat interaction priority to be used for chat routing.
  • The name of the site of the Channel Server returned by the authenticate call. This is a response attribute, and should not be filled in by the client.
  • The type of the user who authenticates for the interaction. The possible value currently is CONSUMER. This attribute is mandatory.
  • The unique identifier of the party associated with the user who authenticates for the interaction. This attribute is optional.
  • A JSON string that contains Custom Fields key value pairs to be used to assign this interaction. This attribute is optional.
  • The domain address of the Channel Server returned by the authenticate call. This is a response attribute, and should not be filled in by the client.
  • The email address of the user who authenticates for the interaction. This attribute is optional.
  • The level to which the chat interaction has been escalated. The default value is 0 which means no escalation. This attribute is not supported.
  • The first name of the user who authenticates for the interaction. This attribute is optional.
  • The unique identifier of the resource that is assigned to the entity related to the interaction, such as service request, sales opportunity, etc. This attribute is not supported.
  • The unique identifier of an entity related to the interaction, such as product, service request, sales opportunity, etc. This attribute is optional.
  • The name of an entity related to the interaction, such as product, service request, sales opportunity, etc. This attribute is optional.
  • The lookup code for the severity of the entity related to the interaction, such as service request, sales opportunity, and so on. This attribute is optional.
  • The type of the entity related to the interaction, such as product, service request, sales opportunity, etc. This attribute is optional.
  • The unique identifier of the interface to be used in the interaction with the Channel Server. The interface identifier defines the language for system generated messages. This attribute is optional.
  • The unique identifier of the inventory item. It is used along with inventoryOrgId and prodGroupId to identify the product. This attribute is optional.
  • The unique identifier of the inventory organization. It is used along with inventoryItemId and prodGroupId to identify the product. This attribute is optional.
  • The JSON Web Token returned by the authenticate call. This is a response attribute, and should not be filled in by the client.
  • The last name of the user who authenticates for the interaction. This attribute is optional.
  • Links
  • An optional attribute that encodes a complex array that is a combination of a channel type name and an optional list of errors of the end-user???s machine capabilities for that channel. The valid values for channel type name are CHAT, VIDEO, and COBROWSE. The valid values for Video channel errors are NO_CAMERA, NO_MICROPHONE, and NO_SPEAKERS. The valid values for other channels errors are BROWSER_NOT_SUPPORTED and INSECURE_ORIGIN. The complex elements in the array are separated by a semicolon, the errors are separated by a comma, and the channel type and its corresponding errors are separated by a colon. For example, ???mediaList???: ???CHAT:NO_KEYBOARD;VIDEO:NO_CAMERA,NO_MICROPHONE???.
  • The unique identifier of the account associated with the user who authenticates for the interaction. This attribute is optional.
  • The unique identifier of the Channel Server's pool returned by the authenticate call. This is a response attribute, and should not be filled in by the client.
  • The comma-delimited list of unique identifiers of the resources that should be given preference when determining the assignee for the interaction. This attribute is not supported.
  • The unique identifier of the product group. It is used along with inventoryOrgId and inventoryItemId to identify the product. This attribute is optional.
  • The unique identifier of the product. This attribute is unutilized.
  • The subject of the interaction request.
  • The unique identifier of the internal queue to be used with this interaction. This attribute is optional.
  • Indicates whether to resume the session. The accepted values are RESUME and DO_NOT_RESUME. This attribute is optional.
  • The comma-delimited list of unique identifiers of the resources that should be excluded when determining the assignee for the interaction. This attribute is not supported.
  • The application to which the interaction belongs to, such as CRM, HRHD, ISR. This attribute is optional.
  • The unique identifier of the end-user's browser history provides insight into the end-users page visits to the agent handling this interaction. This attribute is not supported.
Back to Top

Examples

The following example shows how to create a chat authentication by submitting a POST request on the REST resource using cURL.

cURL Command

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

Example of Request Body

The following example shows the contents of the request body in JSON format.

{

    "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"
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"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": [
...
]
}
Back to Top