CreateCannedMessage

Create/Record canned message defined by CreateCannedMessageReq message for a specified
name, description and message_body.
The method will return a CannedMessage message/entity that will
contain the newly created canned message details for this client
Required permissions:
OMNI_BOSS

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

request to create canned message

name

string

name

optional

canned message name

description

string

description

optional

description

message_body

string

message_body

optional

message details

canned_message_group_id

string

canned_message_group_id

optional

canned message group id

allows_html

boolean

allows_html

optional

allows html

attachments

array[object (OmniAttachment) {12}]

attachments

optional

attachments

temp_id

string

temp_id

optional

temp id

date_created

string <date-time>

date_created

optional

time when the attachment was created

Examples:

1s1.000340012s

date_modified

string <date-time>

date_modified

optional

time when the attachment was last modified

Examples:

1s1.000340012s

content_id

string

content_id

optional

Optional. the id of the attachment in text if inline

width

string

width

optional

Optional. the width of the inline attachment

height

string

height

optional

Optional. the height of the inline attachment

name

string

name

optional

attachment file name

file_type

string

file_type

optional

attachment file type

path

string

path

optional

attachment file path

download_url

string

download_url

optional

download attachment file url

omni_attachment_sid

integer <int64> | string

omni_attachment_sid

optional

primary key or internal identifier for attachment

file_size

integer <int64> | string

file_size

optional

attachment file size

Example

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

canned message creation details

date_created

string <date-time>

date_created

optional

creation date

Examples:

1s1.000340012s

last_updated

string <date-time>

last_updated

optional

last updated date

Examples:

1s1.000340012s

canned_message_id

string

canned_message_id

optional

result of generated canned_message_id

name

string

name

optional

/ canned message name

description

string

description

optional

description

message_body

string

message_body

optional

message details

canned_message_group_id

string

canned_message_group_id

optional

canned message group id

allows_html

boolean

allows_html

optional

allows html

attachments

array[object (OmniAttachment) {12}]

attachments

optional

attachments

temp_id

string

temp_id

optional

temp id

date_created

string <date-time>

date_created

optional

time when the attachment was created

Examples:

1s1.000340012s

date_modified

string <date-time>

date_modified

optional

time when the attachment was last modified

Examples:

1s1.000340012s

content_id

string

content_id

optional

Optional. the id of the attachment in text if inline

width

string

width

optional

Optional. the width of the inline attachment

height

string

height

optional

Optional. the height of the inline attachment

name

string

name

optional

attachment file name

file_type

string

file_type

optional

attachment file type

path

string

path

optional

attachment file path

download_url

string

download_url

optional

download attachment file url

omni_attachment_sid

integer <int64> | string

omni_attachment_sid

optional

primary key or internal identifier for attachment

file_size

integer <int64> | string

file_size

optional

attachment file size

Example

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

🔴500Server Error