Jump to

• Request
• Response

Get a chat authentication - Not Supported

get

/crmRestApi/resources/11.13.18.05/chatAuthenticate/{authUserName}

Request

Path Parameters

• authUserName(required): string
  The unique identifier of the logged in user. This attribute is mandatory.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  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".
• REST-Framework-Version:
  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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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

• allowAgentAttachments: string
  This attribute indicates if the agent should be allowed to send attachments. This attribute is optional.
• applicationClassification: string
  The application classification for the interaction such as Sales or Service. This attribute is optional.
• assigneeId: string
  The unique identifier of the resource being proposed to be assigned to this interaction. This attribute is optional.
• authUserName: string
  The unique identifier of the logged in user. This attribute is mandatory.
• businessUnitOrgId: string
  The unique identifier of the business unit that the interaction request is associated with. This attribute is optional.
• categoryId: string
  The unique identifier of the category of the interaction request. This attribute is optional.
• chatPriority: string
  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.
• chatSiteName: string
  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.
• clientType: string
  The type of the user who authenticates for the interaction. The possible value currently is CONSUMER. This attribute is mandatory.
• contactId: string
  The unique identifier of the party associated with the user who authenticates for the interaction. This attribute is optional.
• customFields: string
  A JSON string that contains Custom Fields key value pairs to be used to assign this interaction. This attribute is optional.
• domain: string
  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.
• emailAddress: string
  The email address of the user who authenticates for the interaction. This attribute is optional.
• escalationLevel: string
  The level to which the chat interaction has been escalated. The default value is 0 which means no escalation. This attribute is not supported.
• firstName: string
  The first name of the user who authenticates for the interaction. This attribute is optional.
• incidentAssigneeId: string
  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.
• incidentId: string
  The unique identifier of an entity related to the interaction, such as product, service request, sales opportunity, etc. This attribute is optional.
• incidentName: string
  The name of an entity related to the interaction, such as product, service request, sales opportunity, etc. This attribute is optional.
• incidentSeverityCode: string
  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.
• incidentType: string
  The type of the entity related to the interaction, such as product, service request, sales opportunity, etc. This attribute is optional.
• interfaceId: string
  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.
• inventoryItemId: string
  The unique identifier of the inventory item. It is used along with inventoryOrgId and prodGroupId to identify the product. This attribute is optional.
• inventoryOrgId: string
  The unique identifier of the inventory organization. It is used along with inventoryItemId and prodGroupId to identify the product. This attribute is optional.
• jwt: string
  The JSON Web Token returned by the authenticate call. This is a response attribute, and should not be filled in by the client.
• lastName: string
  The last name of the user who authenticates for the interaction. This attribute is optional.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• mediaList: string
  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???.
• organizationId: string
  The unique identifier of the account associated with the user who authenticates for the interaction. This attribute is optional.
• poolId: string
  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.
• preferredResources: string
  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.
• prodGroupId: string
  The unique identifier of the product group. It is used along with inventoryOrgId and inventoryItemId to identify the product. This attribute is optional.
• productId: string
  The unique identifier of the product. This attribute is unutilized.
• question: string
  The subject of the interaction request.
• queueId: string
  The unique identifier of the internal queue to be used with this interaction. This attribute is optional.
• resumeType: string
  Indicates whether to resume the session. The accepted values are RESUME and DO_NOT_RESUME. This attribute is optional.
• skipAgentIds: string
  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.
• stripeCode: string
  The application to which the interaction belongs to, such as CRM, HRHD, ISR. This attribute is optional.
• visitorBrowserHistorySessionId: string
  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.

{
    "type":"object",
    "properties":{
        "inventoryOrgId":{
            "type":"string",
            "description":"The unique identifier of the inventory organization. It is used along with inventoryItemId and prodGroupId to identify the product. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "lastName":{
            "type":"string",
            "description":"The last name of the user who authenticates for the interaction. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "queueId":{
            "type":"string",
            "description":"The unique identifier of the internal queue to be used with this interaction. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "incidentAssigneeId":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "jwt":{
            "type":"string",
            "description":"The JSON Web Token returned by the authenticate call.  This is a response attribute, and should not be filled in by the client.",
            "nullable":true,
            "x-queryable":false
        },
        "customFields":{
            "type":"string",
            "description":"A JSON string that contains Custom Fields key value pairs to be used to assign this interaction. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "incidentType":{
            "type":"string",
            "description":"The type of the entity related to the interaction, such as product, service request, sales opportunity, etc. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "chatPriority":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "resumeType":{
            "type":"string",
            "description":"Indicates whether to resume the session. The accepted values are RESUME and DO_NOT_RESUME. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "skipAgentIds":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "applicationClassification":{
            "type":"string",
            "description":"The application classification for the interaction such as Sales or Service. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "organizationId":{
            "type":"string",
            "description":"The unique identifier of the account associated with the user who authenticates for the interaction. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "visitorBrowserHistorySessionId":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "emailAddress":{
            "type":"string",
            "description":"The email address of the user who authenticates for the interaction. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "clientType":{
            "type":"string",
            "description":"The type of the user who authenticates for the interaction. The possible value currently is CONSUMER. This attribute is mandatory.",
            "nullable":true,
            "x-queryable":false
        },
        "stripeCode":{
            "type":"string",
            "description":"The application to which the interaction belongs to, such as CRM, HRHD, ISR. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "allowAgentAttachments":{
            "type":"string",
            "description":"This attribute indicates if the agent should be allowed to send attachments. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "businessUnitOrgId":{
            "type":"string",
            "description":"The unique identifier of the business unit that the interaction request is associated with. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "incidentName":{
            "type":"string",
            "description":"The name of an entity related to the interaction, such as product, service request, sales opportunity, etc. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "authUserName":{
            "type":"string",
            "description":"The unique identifier of the logged in user. This attribute is mandatory.",
            "nullable":false,
            "x-queryable":false
        },
        "productId":{
            "type":"string",
            "description":"The unique identifier of the product. This attribute is unutilized.",
            "nullable":true,
            "x-queryable":false
        },
        "question":{
            "type":"string",
            "description":"The subject of the interaction request.",
            "nullable":true,
            "x-queryable":false
        },
        "contactId":{
            "type":"string",
            "description":"The unique identifier of the party associated with the user who authenticates for the interaction. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "preferredResources":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "chatSiteName":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "escalationLevel":{
            "type":"string",
            "description":"The level to which the chat interaction has been escalated. The default value is 0 which means no escalation. This attribute is not supported.",
            "nullable":true,
            "x-queryable":false
        },
        "assigneeId":{
            "type":"string",
            "description":"The unique identifier of the resource being proposed to be assigned to this interaction. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "inventoryItemId":{
            "type":"string",
            "description":"The unique identifier of the inventory item. It is used along with inventoryOrgId and prodGroupId to identify the product. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "firstName":{
            "type":"string",
            "description":"The first name of the user who authenticates for the interaction. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "mediaList":{
            "type":"string",
            "description":"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???.",
            "nullable":true,
            "x-queryable":false
        },
        "domain":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "poolId":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "prodGroupId":{
            "type":"string",
            "description":"The unique identifier of the product group. It is used along with inventoryOrgId and inventoryItemId to identify the product. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "interfaceId":{
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":false
        },
        "incidentId":{
            "type":"string",
            "description":"The unique identifier of an entity related to the interaction, such as product, service request, sales opportunity, etc. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        },
        "incidentSeverityCode":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "categoryId":{
            "type":"string",
            "description":"The unique identifier of the category of the interaction request. This attribute is optional.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top