Resources Overview

Available Resources

Viber Transactional Template Resources

From July 1, 2026, every transactional Viber Business Message must be sent using a pre-approved template.

The transactional template API allows you to:

• Create templates for Viber moderation
• List templates and their moderation status
• Update lifecycle callback URLs
• Delete templates
• Send approved transactional and OTP-category templates

📘

Important

OTP-category templates are sent through:

HTTP

POST /viber/transactional/messages

There is no greenfield:

HTTP

POST /viber/transactional/otp

Legacy:

HTTP

POST /viber/otp

remains available for older integrations only.

Template Management Endpoints

List Viber Transactional Templates

GET /viber/transactional/templates

Retrieves Viber transactional templates available for the account.

You can optionally filter the response by sender.

Optional Query Parameter

Create Viber Transactional Template

POST /viber/transactional/templates

Creates a new Viber transactional or OTP-category template and submits it for moderation.

Required Query Parameter

Notes

• One template belongs to one Viber sender.
• One template has one locale.
• Templates cannot be edited after submission.
• If wording or variables must change, delete the existing template and create a new one.
• Routee supports up to 2,000 transactional templates per Viber sender.

Update Viber Transactional Template Callback

PATCH /viber/transactional/templates/{templateId}

Updates Routee’s stored lifecycle callback URL for template moderation status events.

This endpoint is used only for the template lifecycle webhook URL.

It does not update the template text, language, category, or variables.

Path Parameter

Request Body

Use callbackUrl:

{
  "callbackUrl": "https://example.com/viber-template-status"
}

Or use the alternate field name lifecycleCallbackUrl:

{
  "lifecycleCallbackUrl": "https://example.com/viber-template-status"
}

To clear the callback URL:

{
  "callbackUrl": null
}

❗

Strict request body

An empty request body is rejected on the greenfield endpoint:

JSON

{}

The callback update must be explicit.

Delete Viber Transactional Template

DELETE /viber/transactional/templates/{templateId}

Deletes a Viber transactional template.

Path Parameter

❗

Important

Once deleted, the template ID can no longer be used for sending.

Send Endpoint

Send Viber Transactional Template Message

POST /viber/transactional/messages

Sends an approved Viber transactional template message.

This endpoint is used for both:

• Transactional templates
• OTP-category templates

Request Body Highlights

Example — Transactional Template Message

{
  "senderInfoTrackingId": "your-viber-sender-tracking-id",
  "to": "+972500000000",
  "ttl": 86400,
  "templateId": "2c017482-2f44-41d6-adad-2d6af725fdbe",
  "templateLang": "en",
  "templateParams": {
    "name": "John",
    "time_start": "10:00",
    "time_end": "14:00"
  },
  "deliveryScope": "PRIMARY_DEVICE",
  "sessionMessage": false
}

Example — OTP-Category Template Message

{
  "senderInfoTrackingId": "your-viber-sender-tracking-id",
  "to": "+972500000000",
  "templateId": "APPROVED_OTP_TEMPLATE_UUID",
  "templateLang": "en",
  "templateParams": {
    "pin": "482910",
    "minutes": "5"
  },
  "deliveryScope": "PRIMARY_DEVICE",
  "ttl": 86400
}

📘

OTP templates

OTP-category templates must include a non-empty pin value in templateParams.

Send-Time Validation

Before a transactional template message is queued, Routee validates the request against the approved template.

Routee checks:

• Template ID
• Template language
• Required parameters
• OTP pin, where applicable
• Parameter length
• Invalid URLs in parameter values
• File-extension-like parameter values, for example test.pdf

If validation fails, Routee returns:

HTTP 400

With error code:

400019029

And a validationIssues array.

Example Error Response

{
  "code": "400019029",
  "validationIssues": [
    {
      "code": "OTP_PIN_REQUIRED",
      "message": "OTP template messages must include a non-empty pin parameter."
    }
  ]
}

Typical validation issue codes include:

Tracking and Callbacks

Transactional template sends use the standard Viber tracking and callback concepts.

Polling

Use the existing Viber tracking endpoint:

GET /viber/tracking/{trackingId}

Delivery Callback

Set callbackUrl on the send request to receive per-message delivery status updates.

Delivery callbacks may include transactional template information such as:

• messageKind
• transactionalTemplate
• transactionalTemplate.seq

Lifecycle Callback

Set or update the template lifecycle callback URL using:

PATCH /viber/transactional/templates/{templateId}

Lifecycle callbacks are for moderation events such as:

• Pending moderation
• Approved
• Rejected

❗

Do not confuse callback types

The template lifecycle callback is not the same as the per-message delivery callback.

Use separate URLs unless you intentionally merge them behind your own gateway.

What’s Next

After reviewing the Viber Messaging resources, continue with:

• Viber transactional templates
• Viber Messaging Statuses
• Callback (Webhook)
• Send Viber Transactional Template Message
• Tracking and Delivery Callbacks