Get the Agent ID Using the Custom ID

Back to API List

Use this API to get the agent ID associated with a Custom ID (extension number).

An Agent ID will be returned if it is mapped one-to-one with the custom ID. In scenarios where the organization has multiple agent IDs for the same custom ID, it will return an array of agent IDs.

Method	GET
Endpoint	https://{{host}}/agentassist/api/v1/public/{{streamId}}/agents/customId/{{customId}}
Content-Type	application/json
Authorization	auth: {{JWT}} See How to generate the JWT Token.
API Scope	Configuration

Path Parameters

Parameter	Description	Type
host	Environment URL, for example, https://platform.kore.ai	string, required
streamId	botId or streamId. You can get it from the App Settings page.	string, required
customId	The Agent’s ID from the customer’s system.	string, required

Sample Request

curl --location 'https://{{host}}/agentassist/api/v1/public/{{streamId}}/agents/customId/{{customId}}' \
--header 'auth: {{jwt}}' \
--header 'Content-Type: application/json' \
--header 'accountId: {{accountId}}'

Headers

Header	Description	Required/Optional
accountId	The account ID associated with the API request.	required
auth	JWT token for authentication.	required

Sample Response

[
    {
        "firstName": "fdsa",
        "lastName": "Geller",
        "fullName": "fdsa Geller",
        "lFullName": "fdsa geller",
        "emailId": "[e-mail]",
        "nickName": "",
        "profImage": "no-avatar",
        "phoneNumber": "",
        "userId": "u-fa49c902-2c47-58d7-b61b-d00777dcxxxx",
        "accountId": "671103693114e02715cexxxx",
        "isAccountOwner": true,
        "orgId": "o-c8b351ff-6b3c-5769-afea-1a0adaf4xxxx",
        "agentGroups": [
            {
                "groupId": "ag-836c397-9ba0-4cac-9930-e29819c3xxxx",
                "accessLevel": "full",
                "role": "manager",
                "name": "Default Group"
            }
        ],
        "canSupportChat": true,
        "canSupportCase": false,
        "canSupportVoice": true,
        "customId": "1111",
        "id": "a-8b67d6c-db44-4806-ba3a-96605aeaxxxx",
        "status": "ACTIVE",
        "onlineStatus": "Offline",
        "onlineStatusType": "OFFLINE"
    }
]

Response Body Parameters

Parameter	Description	Type
accountId	Account identifier.	string
addresses	List of WSS addresses for voice communication.	array
agentGroups	List of agent groups containing groupId, accessLevel, role, and name.	array
attachmentsEnabled	Whether file attachments are enabled.	boolean
callRegion	The call region, for example, USA.	string
canSupportCase	Whether the agent can handle cases.	boolean
canSupportChat	Whether the agent can provide chat support.	boolean
canSupportVoice	Whether the agent can provide voice support.	boolean
caseLanguageSupport	List of supported case languages with proficiency levels.	array
chatLanguageSupport	List of supported chat languages with proficiency levels.	array
createdAt	Account creation timestamp.	string
createdBy	User ID of the creator.	string
createdByAId	Agent ID of the creator.	string
customId	The custom identifier for the user.	string
desktopLayouts	List of desktop layout configurations.	array
domain	Voice communication domain.	string
emailId	The user’s email address.	string
emojisEnabled	Whether emoji usage is enabled.	boolean
firstName	The user’s first name.	string
fullName	Complete name of the user.	string
hoursOfOperationId	ID reference for operation hours.	string
iceServers	List of ICE server configurations for voice communication.	array
id	Agent identifier.	string
iId	Internal identifier.	string
internalChatPermission	Whether internal chat is permitted.	boolean
isAccountOwner	Indicates if the user is the account owner.	boolean
lastName	The user’s last name.	string
lastOnlineAt	Timestamp of last online presence.	string
lFullName	Lowercase version of the full name.	string
markedAutoAway	Whether the user is marked as automatically away.	boolean
maxDigitalChatSupport	Maximum concurrent digital chats allowed.	number
maxEmailChatSupport	Maximum concurrent email chats allowed.	number
maxMessagingChatSupport	Maximum concurrent messaging chats allowed.	number
name	The display name.	string
nickName	The user’s nickname (optional).	string
onlineStatus	Current online status text.	string
onlineStatusType	Current online status type.	string
orgId	Organization identifier.	string
phoneNumber	The user’s phone number.	string
preferences	User preferences (includes theme).	object
prevStatus	Previous online status text.	string
prevStatusType	Previous online status type.	string
profImage	Profile image identifier.	string
queues	List of queue assignments with ID, name, and preferences.	array
role	The user’s role (for example, Bot Owner).	string
roleId	The role identifier.	string
sipURI	The SIP URI for voice communications.	string
skills	List of user skills with proficiency levels.	array
status	The user’s account status (for example, ACTIVE).	string
updatedAt	Last update timestamp.	string
userId	Unique user identifier (UUID format).	string
voiceLanguageSupport	List of supported voice languages with proficiency levels.	array
voiceSupport	Voice support configuration details.	array