The Get canned message endpoint returns a single canned message.

Requirements: Base URL, Authentication, Error codes

Scope: messaging.canned_messages.read

What this does

When you send a Get canned message request with a canned message ID,

When to use it

• Retrieve a canned message after you have its ID from Get list of canned messages
• Display canned message content and scope in an admin tool
• Validate that a canned message exists and is accessible to your API key

Prerequisites

• The canned message must exist in the contact center.
• You must have access to the canned message.

Endpoint

GET /api/v4/messaging/canned_messages/{canned_message_id}

Path parameters

• canned_message_id
  The unique identifier of the canned message.

Examples

Minimal request

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

Response

If successful, the API returns a canned message object.

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

Notes

• body can include variables such as {{amount}}. Your application is responsible for substituting values before sending a message.

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 this canned message.

404 Not found

This usually means the canned message ID does not exist, or you do not have access to it.

What to check:

• Confirm the ID using Get list of canned messages.

Example response:

{ "error": "Not found" }

429 Too many requests

What to do:

• Reduce request frequency and retry with backoff.