The Get list of canned messages endpoint returns the canned messages you can access.

Requirements: Base URL, Authentication, Error codes

Scope: messaging.canned_messages.read

What this does

When you send a Get list of canned messages request, Voiso returns a paginated list of canned message objects.

Canned messages are pre written replies that agents can use during messaging interactions.

When to use it

Populate a canned message picker in a custom agent workspace
Sync canned messages into an external system
Retrieve canned message IDs for auditing or reporting

Endpoint


GET /api/v4/messaging/canned_messages

Query parameters

All query parameters are optional.

limit
The number of items to return. Default is 100. Maximum is 100.
offset
The number of items to skip before collecting results. Default is 0.

Examples

Minimal request

curl -X GET "https://{cluster_id}.voiso.com/api/v4/messaging/canned_messages" \
  -H "Authorization: Bearer <contact_center_api_key>" \
  -H "Content-Type: application/json"

Request the third page of results (20 per page)

curl -X GET "https://{cluster_id}.voiso.com/api/v4/messaging/canned_messages?limit=20&offset=40" \
  -H "Authorization: Bearer <contact_center_api_key>" \
  -H "Content-Type: application/json"

Response

If successful, the API returns an array of canned message objects and pagination metadata.

{
  "canned_messages": [
    {
      "id": 10,
      "name": "Payment Confirmation",
      "body": "Thank you for your payment of {{amount}}.",
      "channels": [
        "sms",
        "whatsapp",
        "telegram"
      ],
      "teams": [
        {
          "id": 3,
          "name": "Multilingual Support"
        }
      ]
    }
  ],
  "metadata": {
    "total": 100
  }
}

Troubleshooting

401 Unauthorized

What to check:

You are sending Authorization: Bearer <contact_center_api_key>.
Your Base URL includes the correct {cluster_id}.

403 Forbidden

What to check:

The API key is valid, but does not have access to messaging resources in this contact center.

429 Too many requests

What to do:

Reduce request frequency and retry with backoff.

200OK

400Bad Request

401Unauthorized

403Forbidden

429Too many requests