Skip to main content
GET
/
api
/
v2
/
Template
{
  "ErrorCode": 123,
  "ErrorDescription": "<string>",
  "Data": [
    {}
  ],
  "Data[].TemplateId": 123,
  "Data[].CompanyId": 123,
  "Data[].TemplateName": "<string>",
  "Data[].MessageTemplate": "<string>",
  "Data[].IsApproved": true,
  "Data[].IsActive": true,
  "Data[].CreatededDate": "<string>",
  "Data[].ApprovedDate": "<string>"
}

​
Get Templates

Retrieve a list of all message templates in your account. 
curl -X GET "https://accounts.netvox.ng/api/v2/Template?ApiKey=YOUR_API_KEY&ClientId=YOUR_CLIENT_ID" \
  -H "Content-Type: application/json"

​
Parameters

​
ApiKey
string
required
Your API key for authentication
​
ClientId
string
required
Your client identifier for authentication

​
Response

​
ErrorCode
number
Error code (0 for success)
​
ErrorDescription
string
Description of the result
​
Data
array
Array of template objects
​
Data[].TemplateId
number
Unique identifier for the template
​
Data[].CompanyId
number
Company identifier
​
Data[].TemplateName
string
Name of the template
​
Data[].MessageTemplate
string
Template content with placeholders
​
Data[].IsApproved
boolean
Whether the template is approved
​
Data[].IsActive
boolean
Whether the template is currently active
​
Data[].CreatededDate
string
Date when the template was created
​
Data[].ApprovedDate
string
Date when the template was approved

​
Success Response

{
  "ErrorCode": 0,
  "ErrorDescription": "Success",
  "Data": [
    {
      "TemplateId": 138,
      "CompanyId": 121,
      "TemplateName": "test",
      "MessageTemplate": "test ##Field##",
      "IsApproved": false,
      "IsActive": true,
      "CreatededDate": "Mar 19, 2018",
      "ApprovedDate": "Mar 19, 2018"
    }
  ]
}

​
Template Features

  • Placeholders: Use ##Field## for dynamic content
  • Approval: Templates may require approval before use
  • Reusability: Create templates for common message types
  • Consistency: Ensure consistent messaging across campaigns

​
Template Examples

​
OTP Template

Your OTP is ##OTP##. Valid for 5 minutes. Do not share with anyone.

​
Welcome Template

Welcome to ##CompanyName##! Your account has been created successfully. Account ID: ##AccountId##

​
Reminder Template

Reminder: Your appointment with ##DoctorName## is scheduled for ##Date## at ##Time##.

​
Use Cases

  • Consistency: Maintain consistent messaging across all communications
  • Efficiency: Save time by reusing approved templates
  • Compliance: Use pre-approved templates for regulated content
  • Personalization: Combine templates with dynamic data for personalized messages