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. |
emailSignatureMapping |
string | |
tagSettings |
string |
Endpoint
Get a single Agent Preference
GET ticketing/agentPreferences/{id}
Example
Sample Request:
curl https://api11.comm100.io/v4/ticketing/agentPreferences/b13e222d-4832-4198-9f17-83e5612fa9da \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
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. |
emailSignatureMapping |
string | body | no | |
tagSettings |
string | body | no |
Response:
Example
Sample Request:
curl https://api11.comm100.io/v4/ticketing/agentPreferences/b13e222d-4832-4198-9f17-83e5612fa9da \
-X
'PUT'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"ticketSettings":"[\n {\n \"id\": \"email-response\",\n \"name\": \"email-response\",\n \"soundId\": 9,\n \"ifMute\": false,\n \"volume\": 50,\n \"ifPop\": true\n },\n {\n \"id\": \"public-response\",\n \"name\": \"public-response\",\n \"soundId\": 9,\n \"ifMute\": false,\n \"volume\": 50,\n \"ifPop\": true\n },\n {\n \"id\": \"private-response\",\n \"name\": \"private-response\",\n \"soundId\": 9,\n \"ifMute\": false,\n \"volume\": 50,\n \"ifPop\": true\n }\n ]","ifAutoConvertVisitorToContact":true,"htmlSignature":"data:text/plain;base64,PHA+MTExPC9wPg==","textSignature":"data:text/plain;base64,MTEx","emailSignatureMapping":"","tagSettings":""}'
Response:
HTTP/1.1 200 OK