Create and send templates

Viber Business Messages transactional and OTP templates allow you to send pre-approved notifications and verification codes to end users through Viber. Use the Infobip API or the web interface to create templates, check approval status, send template messages, and delete templates that are no longer needed.

Transactional templates are for notifications such as order confirmations, delivery updates, and appointment reminders. OTP templates are for authentication flows, verification codes, and any scenario that requires delivering a single-use PIN to the end user.

Before you begin, verify the following:

• Your account has the viber-bm:manage scope enabled. Contact your Infobip account manager to enable the scope.
• You have an approved Viber sender. To register a sender, see Get started with Viber Business Messages.

For template body constraints, supported languages, and approval statuses, see Viber message templates.

Create a template

To create a transactional or OTP template, send a POST request to the template registration endpoint (opens in a new tab):

POST /viber/1/senders/{sender}/templates

Replace {sender} with your approved Viber sender name.

Rate limit: 25 requests per second.

Create a transactional template

curl -X POST "https://{baseUrl}/viber/1/senders/{sender}/templates" \
  -H "Authorization: App {api-key}" \
  -H "Content-Type: application/json" \
  -d '{
    "category": "TRANSACTIONAL",
    "body": [
      {
        "language": "en",
        "template": "Hello {{1}}, your order {{2}} has been confirmed."
      }
    ],
    "params": [
      { "type": "TEXT", "name": "1", "example": "John" },
      { "type": "TEXT", "name": "2", "example": "ORD-12345" }
    ]
  }'

Create an OTP template

curl -X POST "https://{baseUrl}/viber/1/senders/{sender}/templates" \
  -H "Authorization: App {api-key}" \
  -H "Content-Type: application/json" \
  -d '{
    "category": "OTP",
    "body": [
      {
        "language": "en",
        "template": "Your verification code is {{pin}}. Valid for 5 minutes."
      }
    ],
    "params": [
      { "type": "TEXT", "name": "pin", "example": "123456" }
    ]
  }'

A successful request returns 201 Created with the template details:

{
  "templateId": "a1b2c3d4-0000-0000-0000-000000000000",
  "version": "1",
  "sender": "YourSender",
  "createdAt": 1677628800000,
  "creator": "[email protected]",
  "category": "TRANSACTIONAL",
  "status": "PENDING",
  "params": [
    { "type": "TEXT", "name": "{{1}}", "example": "John" },
    { "type": "TEXT", "name": "{{2}}", "example": "ORD-12345" }
  ],
  "body": [
    { "language": "en", "template": "Hello {{1}}, your order {{2}} has been confirmed." }
  ]
}

Create a template using the web interface

You can also create templates using the Infobip web interface. This method does not support language selection. To specify a language other than the default, use the API.

1. In the web interface, go to Channels and Numbers > Channels > Viber for Business > Senders.

2. Select the sender you want to create a template for, then select Create a Template.

   

3. Select the template type: Transactional template or OTP template.

   

4. In the Design tab, enter the message content (maximum 875 characters).

   

5. In the Parameters tab, create the parameters (maximum 5). Separate consecutive parameters with at least 3 non-whitespace, non-punctuation characters.

   

6. Insert parameters into the message body using the curly brace icon.

   

7. Select the required parameter from the list.

   

8. Select Register Template. The confirmation screen displays the Template ID.

   

Confirm template approval

After you create a template, it enters PENDING status while it is reviewed for compliance. Approval can complete within seconds but can take up to 24 hours. Send the template only after it reaches APPROVED status.

For information about what causes templates to be declined, see Compliance guidelines.

Send a GET request to check the status:

curl -X GET "https://{baseUrl}/viber/1/senders/{sender}/templates/{templateId}" \
  -H "Authorization: App {api-key}"

An approved template returns:

{
  "templateId": "a1b2c3d4-0000-0000-0000-000000000000",
  "category": "TRANSACTIONAL",
  "status": "APPROVED",
  "body": [
    { "language": "en", "template": "Hello {{1}}, your order {{2}} has been confirmed." }
  ],
  "params": [
    { "type": "TEXT", "name": "{{1}}", "example": "John" },
    { "type": "TEXT", "name": "{{2}}", "example": "ORD-12345" }
  ]
}

The following table describes the possible template statuses.

Check approval in the web interface

1. In the web interface, go to Channels and Numbers > Channels > Viber for Business > Senders.

2. Select View Templates for the sender you want to check.

   

3. View the template ID, status, and creation date for each submitted template.

   

4. To view the template text, select the expand icon next to the template.

   

Send a template message

After the template reaches APPROVED status, send a message using the template to one or more recipients. Use the POST /viber/2/messages endpoint and set content.type to "TEMPLATE".

For the full endpoint specification, see the Viber Business Messages API reference (opens in a new tab).

When building the parameters object, strip the double curly braces from the placeholder name to form the key: {{1}} becomes "1", {{orderNum}} becomes "orderNum".

The following table describes the content object fields.

Send a transactional template message

curl -X POST "https://{baseUrl}/viber/2/messages" \
  -H "Authorization: App {api-key}" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "sender": "{sender}",
        "destinations": [ { "to": "385981234568" } ],
        "content": {
          "type": "TEMPLATE",
          "templateId": "a1b2c3d4-0000-0000-0000-000000000000",
          "language": "en",
          "parameters": {
            "1": "John",
            "2": "ORD-12345"
          }
        }
      }
    ]
  }'

Send an OTP template message

For OTP templates, the parameters object must contain the key "pin" (without curly braces) mapped to the actual one-time password value.

curl -X POST "https://{baseUrl}/viber/2/messages" \
  -H "Authorization: App {api-key}" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "sender": "{sender}",
        "destinations": [ { "to": "385981234568" } ],
        "content": {
          "type": "TEMPLATE",
          "templateId": "b2c3d4e5-0000-0000-0000-000000000001",
          "language": "en",
          "parameters": { "pin": "847291" }
        }
      }
    ]
  }'

Send a template message using Broadcast

1. In the web interface, go to Broadcast.

   

2. Select Create Broadcast.

   

3. Select Viber as the channel. To switch channels, select the channel name.

   

4. Add recipients by profile name, phone number, tag, or segment. Select the sender.

   

5. Under Content, select the content area.

   

6. From the Message Content list, select Template.

   

7. Enter the Template ID. The system displays the template content and required parameters.

   

8. Enter a value for each parameter. To insert attributes from an uploaded file or the People module, select the curly brace icon.

   

9. Select Done Designing.

   

10. Select Continue to Preview.

    

11. Review the broadcast setup, then select Launch.

    

Delete a template (API only)

Delete a template when it is no longer needed. Template deletion is available only through the API. The web interface does not support template deletion.

To delete a template, send a DELETE request:

Rate limit: 10 requests per minute.

curl -X DELETE "https://{baseUrl}/viber/1/senders/{sender}/templates/{templateId}" \
  -H "Authorization: App {api-key}"

A successful deletion returns 204 No Content with no response body.

Troubleshooting

The following table describes common errors and how to resolve them. For additional information about Viber message delivery, see Reports and insights.

For API authentication details, see API authentication.