Private Canned Message

You need Manage Private Canned Messages permission to manage the private canned message.

Private Canned Messages
- Private Canned Messages Manage
GET global/privateCannedMessages
GET global/privateCannedMessages/{id}
POST global/privateCannedMessages
PUT global/privateCannedMessages/{id}
DELETE global/privateCannedMessages/{id}
Model
Private Canned Message JSON Format

Private Canned Message is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the private canned message.
categoryId guid Id of the category.
name string Name of the canned message.
message string Default message content in all channels. 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.
htmlMessage string Message content for html email in Ticketing & Messaging. 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.
textMessage string Message content for plaintext email in Ticketing & Messaging. 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.
shortcuts string Shortcut using which agents can quickly locate the canned message while chatting with a visitor.
createdById guid Id of the agent who create the canned message.
Endpoint
Get the list of Private Canned Messages

GET global/privateCannedMessages

Parameters:
Name Type In Required Description
category guid query no Id of the private canned message category.
keywords string query no Filter by keywords in name and message of the private canned message.
include string query no Allowed value is "privateCannedMessageCategory".
Response:

An array of   Private Canned Message

Example

Sample Request:

curl https://api15.comm100.io/v4/global/privateCannedMessages \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"id":"3d6962cd-3420-4cb9-a9bf-eef0654ae980","categoryId":"79a02303-959b-eb11-8103-00155d081d0b","name":"Goodbye","message":"Goodbye","htmlMessage":"<p>Goodbye</p>","textMessage":"Goodbye","shortcuts":"bye","createdById":"9a413cfe-792e-4abe-bc5e-8595640ddb3d"}]
Get a single Private Canned Message

GET global/privateCannedMessages/{id}

Parameters:
Name Type In Required Description
include string query no Allowed value is "privateCannedMessageCategory".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/global/privateCannedMessages/3d6962cd-3420-4cb9-a9bf-eef0654ae980 \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"3d6962cd-3420-4cb9-a9bf-eef0654ae980","categoryId":"79a02303-959b-eb11-8103-00155d081d0b","name":"Goodbye","message":"Goodbye","htmlMessage":"<p>Goodbye</p>","textMessage":"Goodbye","shortcuts":"bye","createdById":"9a413cfe-792e-4abe-bc5e-8595640ddb3d"}
Create a new Private Canned Message

POST global/privateCannedMessages

Parameters:
Name Type In Required Description
categoryId guid body yes Id of the category.
name string body yes Name of the canned message.
message string body yes Default message content in all channels. 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.
htmlMessage string body no Message content for html email in Ticketing & Messaging. 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.
textMessage string body no Message content for plaintext email in Ticketing & Messaging. 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.
shortcuts string body no Shortcut using which agents can quickly locate the canned message while chatting with a visitor.
createdById guid body no Id of the agent who create the canned message.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/global/privateCannedMessages \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"categoryId":"79a02303-959b-eb11-8103-00155d081d0b","name":"Goodbye","message":"Goodbye","htmlMessage":"<p>Goodbye</p>","textMessage":"Goodbye","shortcuts":"bye","createdById":"9a413cfe-792e-4abe-bc5e-8595640ddb3d"}'

Response:

 HTTP/1.1 201 Created

{"id":"3d6962cd-3420-4cb9-a9bf-eef0654ae980","categoryId":"79a02303-959b-eb11-8103-00155d081d0b","name":"Goodbye","message":"Goodbye","htmlMessage":"<p>Goodbye</p>","textMessage":"Goodbye","shortcuts":"bye","createdById":"9a413cfe-792e-4abe-bc5e-8595640ddb3d"}
Update the Private Canned Message

PUT global/privateCannedMessages/{id}

Parameters:
Name Type In Required Description
categoryId guid body yes Id of the category.
name string body yes Name of the canned message.
message string body yes Default message content in all channels. 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.
htmlMessage string body no Message content for html email in Ticketing & Messaging. 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.
textMessage string body no Message content for plaintext email in Ticketing & Messaging. 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.
shortcuts string body no Shortcut using which agents can quickly locate the canned message while chatting with a visitor.
createdById guid body no Id of the agent who create the canned message.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/global/privateCannedMessages/3d6962cd-3420-4cb9-a9bf-eef0654ae980 \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"categoryId":"79a02303-959b-eb11-8103-00155d081d0b","name":"Goodbye","message":"Goodbye","htmlMessage":"<p>Goodbye</p>","textMessage":"Goodbye","shortcuts":"bye","createdById":"9a413cfe-792e-4abe-bc5e-8595640ddb3d"}'

Response:

 HTTP/1.1 200 OK

{"id":"3d6962cd-3420-4cb9-a9bf-eef0654ae980","categoryId":"79a02303-959b-eb11-8103-00155d081d0b","name":"Goodbye","message":"Goodbye","htmlMessage":"<p>Goodbye</p>","textMessage":"Goodbye","shortcuts":"bye","createdById":"9a413cfe-792e-4abe-bc5e-8595640ddb3d"}
Remove the Private Canned Message

DELETE global/privateCannedMessages/{id}

Parameters:
No Parameters
Response:

No Content

Example

Sample Request:

curl https://api15.comm100.io/v4/global/privateCannedMessages/3d6962cd-3420-4cb9-a9bf-eef0654ae980 \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 204 No Content