GET
/
api
/
v1
/
custom_messages
import os
import syllable_sdk
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.custom_messages.list(page=0, search_fields=[
        syllable_sdk.CustomMessageProperties.NAME,
    ], search_field_values=[
        "Some Object Name",
    ], start_datetime="2023-01-01T00:00:00Z", end_datetime="2024-01-01T00:00:00Z")

    # Handle response
    print(res)
{
  "items": [
    {
      "name": "Customer service greeting",
      "text": "Hello and thank you for calling customer service. How can I help you today?",
      "label": "Customer service",
      "rules": [
        {
          "date": "2025-01-01",
          "description": "Closed on New Year's Day",
          "invert": false,
          "text": "Hello, thank you for calling. Sorry, we're closed today.",
          "time_range_end": "17:00",
          "time_range_start": "09:00"
        },
        {
          "days_of_week": [
            "sa",
            "su"
          ],
          "description": "Closed on weekends",
          "invert": false,
          "text": "Hello, thank you for calling. Sorry, we're closed on weekends.",
          "time_range_end": "17:00",
          "time_range_start": "09:00"
        }
      ],
      "id": 1,
      "updated_at": "2024-01-01T00:00:00Z",
      "agent_count": 1,
      "last_updated_by": "user@email.com",
      "type": "greeting"
    }
  ],
  "page": 0,
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}

Authorizations

​
Syllable-API-Key
string
header
required

Query Parameters

​
page
integer | null
default:0

The page number from which to start (0-based)

Required range: x >= 0
Example:

0

​
limit
integer
default:25

The maximum number of items to return

Required range: x >= 0
Example:

25

​
search_fields
enum<string>[]

String names of fields to search. Correspond by index to search field values

Available options:
id,
name,
text,
label,
updated_at
Example:

"name"

​
search_field_values
string[]

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Example:

"Some Object Name"

​
order_by
enum<string> | null

The field whose value should be used to order the results

Available options:
id,
name,
text,
label,
updated_at
Example:

"name"

​
order_by_direction
enum<string> | null

The direction in which to order the results

Available options:
asc,
desc
​
fields
enum<string>[] | null

The fields to include in the response

Available options:
id,
name,
text,
label,
updated_at
​
start_datetime
string | null

The start datetime for filtering results

Example:

"2023-01-01T00:00:00Z"

​
end_datetime
string | null

The end datetime for filtering results

Example:

"2024-01-01T00:00:00Z"

Response

200
application/json
Successful Response
​
items
object[]
required

List of items returned from the query

Response model for custom message operations. A custom message is a pre-configured message delivered by an agent as a greeting at the beginning of a conversation. Multiple agents can use the same custom mesasage. A custom message has one or more rules defined, which allow for different messages to be dynamically selected and delivered at runtime based on the current time and either date or day of the week. For more information, see Console docs.

​
page
integer
required

The page number of the results (0-based)

Example:

0

​
page_size
integer
required

The number of items returned per page

Example:

25

​
total_pages
integer | null

The total number of pages of results given the indicated page size

Example:

4

​
total_count
integer | null

The total number of items returned from the query

Example:

100