Search Chat Entry Points

Overview

Use this API to retrieve all chat entry points in a department.

Permissions

Actor Permission
User All of the following are required:
  • If logged in user is a department user:
    • The user must have "View" action on the "Chat Entry Point" resource.
    • The department must be the home department of the user, or a department in which the user is a foreign user.
  • If the logged in user is a partition user, one of the following is required:
    • User must have 'Administer' permission on the provided department provided in the request.
    • User must have one of following privileges: 'View partition resources', 'Manage partition resources'
Client Application No additional permission is required.
SecurityoAuthUser or oAuthClient
Request
path Parameters
id
required
string

Department ID

Examples:
999
query Parameters
$attribute
string

Available values: all, description, secure, allowMidChatAuthentication, queue, agentAvailabilityRequired, subActivity, routingType
Note: 'subActivity' and 'routingType' are applicable for Integrated Entry points (ECE/SPlus).

Examples:
$attribute=
Attributes 'description' and 'queue' are returned in server response.
$attribute=description,queue
All the attributes are returned in server response.
$attribute=all
$sort
string

Objects returned in server response are sorted based on the attribute supplied under $sort.

Enum: "id" "name"
$order
string

Common query parameter $order.

Enum: "asc" "desc"
header Parameters
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Responses
200

OK

204

No content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal server error

get/department/{id}/chat/entrypoint
Request samples
Response samples
application/json
    

  • GET /core/workassignmentmgr/v3/department/999/chat/entrypoint?$sort=id&$order=desc
    • 

  • This example demonstrates the following:
      

    • Search chat entry points in a department.
      • 

    • Representation of the summary attributes.
      • 

    • Sorting on ID in descending order.
      • 

    

    • 



{
  • "entryPoint": [
    ]
}