Skip to content
AelystAelyst API

List message templates

GET
/space/channel/{id}/template
curl --request GET \
  --url 'https://api.aelyst.ai/v1/space/channel/example/template?limit=10' \
  --header 'Authorization: Bearer <token>'

Get all the message template of a connected channels in the workspace.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

ID of the channel to list template

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 10 >= 1 < 100 >= 1 characters <= 100 characters

Number of items to return i.e. page size.

cursorId
integer

Pointer to the template id from where the next batch of records should start from.

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
items
Array<object>
MessageTemplate
object
id
integer
name
required
string
components
required
Array
Any of:
Any of:
object
type
required
string
Allowed values: header
format
string
Allowed values: text
text
required
string
parameters
required
Array<object>
object
type
required
string
text
required
string
bundle
object
channelId
required
integer
botId
required
integer
languageCode
required

Follows ISO 639-1 standard

string
namespace
string
category
required
string
status
string
statusDetail
string
templateId
string
pagination
object
next
required
string
previous
required
string
Example
{
  "items": [
    {
      "id": 12345,
      "name": "conversation_follow_up",
      "components": [
        {
          "type": "header",
          "format": "text",
          "text": "Header text",
          "parameters": [
            {
              "type": "text",
              "text": "aelyst.ai"
            }
          ]
        }
      ],
      "channelId": 1234,
      "botId": 123,
      "languageCode": "en",
      "namespace": null,
      "category": "MARKETING",
      "status": "approved",
      "templateId": "1234"
    }
  ],
  "pagination": {
    "next": "https://api.aelyst.ai/space/channel/{id}/template?limit=10&cursorId=10",
    "previous": "https://api.aelyst.ai/space/channel/{id}/template?limit=10&cursorId=-10"
  }
}

400

Section titled “400”
Media typeapplication/json
object
code
integer
message
string
Example
{
  "code": 400,
  "message": "Validation error."
}

401

Section titled “401”
Media typeapplication/json
object
code
integer
message
string
Example
{
  "code": 401,
  "message": "UN_AUTHORIZED"
}

429

Section titled “429”
Media typeapplication/json
object
code
integer
message
string
Example
{
  "code": 429,
  "message": "Too Many Requests"
}

Headers

Section titled “Headers”
Retry-After
number
Example
1

Number of seconds until you can retry the request

X-RateLimit-Limit
number
Example
10

Number of request allowed for this end point

X-RateLimit-Remaining
number
Example
5

Number of request remaining for this end point

500

Section titled “500”
Media typeapplication/json
object
code
integer
message
string
Example
{
  "code": 500,
  "message": "Unexpected error occurred"
}