Agent Preference

Ticket agent preference.

Agent Preference
- Agent Preference Manage
GET ticketing/agentPreferences/{id}
PUT ticketing/agentPreferences/{id}
Model
Agent Preference JSON Format

Agent Preference is represented as simple flat JSON objects with the following keys:

Name Type Description
agentId guid Id of the agent.
ticketSettings string JSON data for configuring sounds and pop-ups for Ticketing&Messaging.
ifAutoConvertVisitorToContact bool Whether convert a visitor to contact automatically when agent replies ticket or not.
htmlSignature string HTML signature. 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.
textSignature string Plain text signature. 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.
Endpoint
Get a single Agent Preference

GET ticketing/agentPreferences/{id}

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/ticketing/agentPreferences/b13e222d-4832-4198-9f17-83e5612fa9da \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"agentId":"b13e222d-4832-4198-9f17-83e5612fa9da","ticketSettings":"[\r\n {\r\n \"id\": \"email-response\",\r\n \"name\": \"email-response\",\r\n \"soundId\": 9,\r\n \"ifMute\": false,\r\n \"volume\": 50,\r\n \"ifPop\": true\r\n },\r\n {\r\n \"id\": \"public-response\",\r\n \"name\": \"public-response\",\r\n \"soundId\": 9,\r\n \"ifMute\": false,\r\n \"volume\": 50,\r\n \"ifPop\": true\r\n },\r\n {\r\n \"id\": \"private-response\",\r\n \"name\": \"private-response\",\r\n \"soundId\": 9,\r\n \"ifMute\": false,\r\n \"volume\": 50,\r\n \"ifPop\": true\r\n }\r\n ]","ifAutoConvertVisitorToContact":true,"htmlSignature":"data:text/plain;base64,PHA+MTExPC9wPg==","textSignature":"data:text/plain;base64,MTEx"}
Update the Agent Preference

PUT ticketing/agentPreferences/{id}

Parameters:
Name Type In Required Description
ticketSettings string body no JSON data for configuring sounds and pop-ups for Ticketing&Messaging.
ifAutoConvertVisitorToContact bool body no Whether convert a visitor to contact automatically when agent replies ticket or not.
htmlSignature string body no HTML signature. 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.
textSignature string body no Plain text signature. 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.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/ticketing/agentPreferences/b13e222d-4832-4198-9f17-83e5612fa9da \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"ticketSettings":"[\r\n {\r\n \"id\": \"email-response\",\r\n \"name\": \"email-response\",\r\n \"soundId\": 9,\r\n \"ifMute\": false,\r\n \"volume\": 50,\r\n \"ifPop\": true\r\n },\r\n {\r\n \"id\": \"public-response\",\r\n \"name\": \"public-response\",\r\n \"soundId\": 9,\r\n \"ifMute\": false,\r\n \"volume\": 50,\r\n \"ifPop\": true\r\n },\r\n {\r\n \"id\": \"private-response\",\r\n \"name\": \"private-response\",\r\n \"soundId\": 9,\r\n \"ifMute\": false,\r\n \"volume\": 50,\r\n \"ifPop\": true\r\n }\r\n ]","ifAutoConvertVisitorToContact":true,"htmlSignature":"data:text/plain;base64,PHA+MTExPC9wPg==","textSignature":"data:text/plain;base64,MTEx"}'

Response:

 HTTP/1.1 200 OK

{"agentId":"b13e222d-4832-4198-9f17-83e5612fa9da","ticketSettings":"[\r\n {\r\n \"id\": \"email-response\",\r\n \"name\": \"email-response\",\r\n \"soundId\": 9,\r\n \"ifMute\": false,\r\n \"volume\": 50,\r\n \"ifPop\": true\r\n },\r\n {\r\n \"id\": \"public-response\",\r\n \"name\": \"public-response\",\r\n \"soundId\": 9,\r\n \"ifMute\": false,\r\n \"volume\": 50,\r\n \"ifPop\": true\r\n },\r\n {\r\n \"id\": \"private-response\",\r\n \"name\": \"private-response\",\r\n \"soundId\": 9,\r\n \"ifMute\": false,\r\n \"volume\": 50,\r\n \"ifPop\": true\r\n }\r\n ]","ifAutoConvertVisitorToContact":true,"htmlSignature":"data:text/plain;base64,PHA+MTExPC9wPg==","textSignature":"data:text/plain;base64,MTEx"}