GetCannedMessageById

POST

https://api.cbf.tcn.com/api/v0alpha/omniapi/getcannedmessagebyid

Get canned message details for the canned_message_id
The method will return an canned message/entity
Required permissions:
OMNI_BOSS

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "canned_message_id": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/omniapi/getcannedmessagebyid' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "canned_message_id": "string"
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "canned_message_id": "string",
    "name": "string",
    "description": "string",
    "message_body": "string",
    "date_created": "1s",
    "last_updated": "1s",
    "canned_message_group_id": "string",
    "group_name": "string",
    "group_description": "string",
    "group_date_created": "1s",
    "group_last_updated": "1s",
    "allows_html": true,
    "attachments": [
        {
            "omni_attachment_sid": 0,
            "name": "string",
            "file_type": "string",
            "file_size": 0,
            "path": "string",
            "temp_id": "string",
            "download_url": "string",
            "date_created": "1s",
            "date_modified": "1s",
            "content_id": "string",
            "width": "string",
            "height": "string"
        }
    ]
}

🟢200Success

Modified at 2025-09-26 15:44:58

UpdateCannedMessage

DeleteCannedMessageById