You need the Manage Agent & Agent Roles permission to manage agents.
Agent is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id |
guid | Id of the agent. |
email |
string | Agent login email. |
displayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
firstName |
string | First name of the agent. |
lastName |
string | Last name of the agent. |
isAdmin |
bool | Whether the agent is an administrator or not. |
isActive |
bool | Whether the agent is active or not. |
phone |
string | Phone number of the agent. |
title |
string | Title of the agent. |
bio |
string | Bio info of the agent. You can pass both plaintext and base64 encoded text. If the request containing plaintext is blocked by comm100 WAF, use base64 format. When using base64, add "data:text/plain;base64," before the content. |
timeZone |
string | Time zone of the agent. Value includes all Time Zone Option identifiers, if not selected, will use the time zone selected in site profile. |
datetimeFormat |
string | Date & Time format selected by agents to display on the site. Allowed values are "YYYY/MM/DD HH:mm:ss", "YYYY-MM-DD HH:mm:ss", "MM/DD/YYYY HH:mm:ss", "MM-DD-YYYY HH:mm:ss", "DD/MM/YYYY HH:mm:ss", "DD-MM-YYYY HH:mm:ss". |
ifCustomizeAvatar |
bool | Whether the agent avatar is customized or not. |
customizeAvatar |
image | Customized avatar of agent. |
systemAvatarId |
guid | Id of system avatar. |
avatar |
string | Avatar of the agent. |
permissionIds |
array | The list of permission identifiers. |
departmentIds |
array | Id of the selected agents for this department. |
roleIds |
array | The selected agents for this role.If not offered, will use role identifier of "AllAgents" as default. |
skillIds |
array | Id of the agents master this skill. |
GET global/agents
Name | Type | In | Required | Description |
---|---|---|---|---|
keywords |
string | query | no | Filter by keywords in agent display name and email. |
roleId |
string | query | no | Id of the role. |
departmentId |
string | query | no | Id of the department. |
include |
string | query | no | Allowed values are "department", "role", "systemAvatar", "shift", "permission". |
An array of Agent
Sample Request:
Response:
HTTP/1.1 200 OK
GET global/agents/{id}
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed values are "department", "role", "systemAvatar", "shift", "permission". |
Sample Request:
Response:
HTTP/1.1 200 OK
POST global/agents
Name | Type | In | Required | Description |
---|---|---|---|---|
email |
string | body | yes | Agent login email. |
displayName |
string | body | yes | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
firstName |
string | body | yes | First name of the agent. |
lastName |
string | body | yes | Last name of the agent. |
isAdmin |
bool | body | no | Whether the agent is an administrator or not. |
isActive |
bool | body | no | Whether the agent is active or not. |
phone |
string | body | no | Phone number of the agent. |
title |
string | body | no | Title of the agent. |
bio |
string | body | no | Bio info of the agent. You can pass both plaintext and base64 encoded text. If the request containing plaintext is blocked by comm100 WAF, use base64 format. When using base64, add "data:text/plain;base64," before the content. |
timeZone |
string | body | yes | Time zone of the agent. Value includes all Time Zone Option identifiers, if not selected, will use the time zone selected in site profile. |
datetimeFormat |
string | body | yes | Date & Time format selected by agents to display on the site. Allowed values are "YYYY/MM/DD HH:mm:ss", "YYYY-MM-DD HH:mm:ss", "MM/DD/YYYY HH:mm:ss", "MM-DD-YYYY HH:mm:ss", "DD/MM/YYYY HH:mm:ss", "DD-MM-YYYY HH:mm:ss". |
ifCustomizeAvatar |
bool | body | no | Whether the agent avatar is customized or not. |
customizeAvatar |
image | body | no | Customized avatar of agent. |
systemAvatarId |
guid | body | no | Id of system avatar. |
avatar |
string | body | no | Avatar of the agent. |
permissionIds |
array | body | no | The list of permission identifiers. |
departmentIds |
array | body | no | Id of the selected agents for this department. |
roleIds |
array | body | no | The selected agents for this role.If not offered, will use role identifier of "AllAgents" as default. |
skillIds |
array | body | no | Id of the agents master this skill. |
Sample Request:
Response:
HTTP/1.1 201 Created
POST Global/agents/{id}:changePassword
Name | Type | In | Required | Description |
---|---|---|---|---|
password |
string | body | yes | New password of the agent. |
No Content
Sample Request:
Response:
HTTP/1.1 200 OK
POST Global/agents/{id}:unlock
No Content
Sample Request:
Response:
HTTP/1.1 200 OK
PUT global/agents/{id}
Name | Type | In | Required | Description |
---|---|---|---|---|
email |
string | body | yes | Agent login email. |
displayName |
string | body | yes | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
firstName |
string | body | yes | First name of the agent. |
lastName |
string | body | yes | Last name of the agent. |
isAdmin |
bool | body | no | Whether the agent is an administrator or not. |
isActive |
bool | body | no | Whether the agent is active or not. |
phone |
string | body | no | Phone number of the agent. |
title |
string | body | no | Title of the agent. |
bio |
string | body | no | Bio info of the agent. You can pass both plaintext and base64 encoded text. If the request containing plaintext is blocked by comm100 WAF, use base64 format. When using base64, add "data:text/plain;base64," before the content. |
timeZone |
string | body | yes | Time zone of the agent. Value includes all Time Zone Option identifiers, if not selected, will use the time zone selected in site profile. |
datetimeFormat |
string | body | yes | Date & Time format selected by agents to display on the site. Allowed values are "YYYY/MM/DD HH:mm:ss", "YYYY-MM-DD HH:mm:ss", "MM/DD/YYYY HH:mm:ss", "MM-DD-YYYY HH:mm:ss", "DD/MM/YYYY HH:mm:ss", "DD-MM-YYYY HH:mm:ss". |
ifCustomizeAvatar |
bool | body | no | Whether the agent avatar is customized or not. |
customizeAvatar |
image | body | no | Customized avatar of agent. |
systemAvatarId |
guid | body | no | Id of system avatar. |
avatar |
string | body | no | Avatar of the agent. |
permissionIds |
array | body | no | The list of permission identifiers. |
departmentIds |
array | body | no | Id of the selected agents for this department. |
roleIds |
array | body | no | The selected agents for this role.If not offered, will use role identifier of "AllAgents" as default. |
skillIds |
array | body | no | Id of the agents master this skill. |
Sample Request:
Response:
HTTP/1.1 200 OK
DELETE global/agents/{id}
No Content
Sample Request:
Response:
HTTP/1.1 204 No Content