Contents x
      Public Canned Message
      • 04 Jul 2022
      • 4 Minutes to read
      • Print
      • Dark
        Light
      Contents

      Public Canned Message

      • Updated on 04 Jul 2022
      • 4 Minutes to read
      • Print
      • Dark
        Light
      Article summary

      Public Canned Message

      You need Manage Public Canned Messages permission to manage the public canned message.

      Public Canned Message JSON Format

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

      NameTypeDescription
      idguidId of the public canned message.
      categoryIdguidId of the category.
      namestringName of the canned message.
      messagestringDefault 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.
      htmlMessagestringMessage 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.
      textMessagestringMessage 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.
      shortcutsstringShortcut using which agents can quickly locate the canned message while chatting with a visitor.
      similarQuestionsstring []Available when Agent Assist is enabled.
      categoryPublicCannedMessageCategory[]Reference to PublicCannedMessageCategory.

      Get the list of Public Canned Messages

      GET global/publicCannedMessages

      • Parameters:

      NameTypeinRequiredDescription
      categoryguidquerynoId of the public canned message category.
      keywordsstringquerynoFilter by keywords in name and message of the public canned message.
      includestringquerynoAllowed value is "publicCannedMessageCategory".

      • Response:

      An array of Public Canned Message

      • Example

      Sample Request:

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

      Response:

      HTTP/1.1 200 OK

      [
  {
      "id": "7ea02303-959b-eb11-8103-00155d081d0b",
      "categoryId": "79a02303-959b-eb11-8103-00155d081d0b",
      "name": "thanks",
      "message": "thanks",
      "htmlMessage": "<p>thanks</p>",
      "textMessage": "thanks",
      "shortcuts": "thx",
      "similarQuestions": [
          "are you ok?"
      ]
  }
]

      Get a single Public Canned Message

      GET global/publicCannedMessages/{id}

      • Parameters:

      NameTypeinRequiredDescription
      includestringquerynoAllowed value is "publicCannedMessageCategory".

      • Response:

      Public Canned Message

      • Example

      Sample Request:

      curl https://api11.comm100.io/v4/global/publicCannedMessages/7ea02303-959b-eb11-8103-00155d081d0b \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \

      Response:

      HTTP/1.1 200 OK

      {
  "id": "7ea02303-959b-eb11-8103-00155d081d0b",
  "categoryId": "79a02303-959b-eb11-8103-00155d081d0b",
  "name": "thanks",
  "message": "thanks",
  "htmlMessage": "<p>thanks</p>",
  "textMessage": "thanks",
  "shortcuts": "thx",
  "similarQuestions": [
      "are you ok?"
  ]
}

      Create a new Public Canned Message

      POST global/publicCannedMessages

      • Parameters:

      NameTypeinRequiredDescription
      categoryIdguidbodyyesId of the category.
      namestringbodyyesName of the canned message.
      messagestringbodyyesDefault 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.
      htmlMessagestringbodynoMessage 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.
      textMessagestringbodynoMessage 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.
      shortcutsstringbodynoShortcut using which agents can quickly locate the canned message while chatting with a visitor.
      similarQuestionsstring []bodynoAvailable when Agent Assist is enabled.

      • Response:

      Public Canned Message

      • Example

      Sample Request:

      curl https://api11.comm100.io/v4/global/publicCannedMessages \ 
    -X 'POST' \ 
    -H 'Authorization: Bearer {access_token}' \ 
    -H 'Content-Type: application/json' \ 
    -D '{"categoryId":"79a02303-959b-eb11-8103-00155d081d0b","name":"thanks","message":"thanks","htmlMessage":"<p>thanks</p>","textMessage":"thanks","shortcuts":"thx","similarQuestions":["are you ok?"]}'

      Response:

      HTTP/1.1 201 Created

      {
  "id": "7ea02303-959b-eb11-8103-00155d081d0b",
  "categoryId": "79a02303-959b-eb11-8103-00155d081d0b",
  "name": "thanks",
  "message": "thanks",
  "htmlMessage": "<p>thanks</p>",
  "textMessage": "thanks",
  "shortcuts": "thx",
  "similarQuestions": [
      "are you ok?"
  ]
}

      Update the Public Canned Message

      PUT global/publicCannedMessages/{id}

      • Parameters:

      NameTypeinRequiredDescription
      categoryIdguidbodyyesId of the category.
      namestringbodyyesName of the canned message.
      messagestringbodyyesDefault 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.
      htmlMessagestringbodynoMessage 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.
      textMessagestringbodynoMessage 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.
      shortcutsstringbodynoShortcut using which agents can quickly locate the canned message while chatting with a visitor.
      similarQuestionsstring []bodynoAvailable when Agent Assist is enabled.

      • Response:

      Public Canned Message

      • Example

      Sample Request:

      curl https://api11.comm100.io/v4/global/publicCannedMessages/7ea02303-959b-eb11-8103-00155d081d0b \ 
    -X 'PUT' \ 
    -H 'Authorization: Bearer {access_token}' \ 
    -H 'Content-Type: application/json' \ 
    -D '{"categoryId":"79a02303-959b-eb11-8103-00155d081d0b","name":"thanks","message":"thanks","htmlMessage":"<p>thanks</p>","textMessage":"thanks","shortcuts":"thx","similarQuestions":["are you ok?"]}'

      Response:

      HTTP/1.1 200 OK

      {
  "id": "7ea02303-959b-eb11-8103-00155d081d0b",
  "categoryId": "79a02303-959b-eb11-8103-00155d081d0b",
  "name": "thanks",
  "message": "thanks",
  "htmlMessage": "<p>thanks</p>",
  "textMessage": "thanks",
  "shortcuts": "thx",
  "similarQuestions": [
      "are you ok?"
  ]
}

      Remove the Public Canned Message

      DELETE global/publicCannedMessages/{id}

      • Parameters:

      No Parameters

      • Response:

      No Content

      • Example

      Sample Request:

      curl https://api11.comm100.io/v4/global/publicCannedMessages/7ea02303-959b-eb11-8103-00155d081d0b \ 
    -X 'DELETE' \ 
    -H 'Authorization: Bearer {access_token}' \

      Response:

      HTTP/1.1 204 No Content

      Was this article helpful?
      What's Next
      Copyright © 2022 Comm100 Network Corporation. All Rights Reserved.