List templates

curl --request GET \
  --url https://api.onexaura.com/v1/templates \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.onexaura.com/v1/templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onexaura.com/v1/templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onexaura.com/v1/templates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.onexaura.com/v1/templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "page": 1,
  "pageSize": 25,
  "total": 137,
  "totalPages": 6,
  "data": [
    {
      "id": "tpl_abc123",
      "name": "<string>",
      "status": "enabled",
      "archivedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "updatedBy": "<string>",
      "pinLength": 6,
      "pinType": "numeric",
      "pinAttempts": 123,
      "pinTimeToLive": "<string>",
      "verifyPinLimit": "<string>",
      "sendPinPerTemplateLimit": "<string>",
      "sendPinPerPhoneNumberLimit": "<string>",
      "resendCooldown": "<string>",
      "channels": [
        {
          "id": "<string>",
          "channelType": "sms",
          "channelAccountId": "<string>",
          "providerTemplateRef": "<string>",
          "contentText": "<string>",
          "subjectText": "<string>",
          "isDefault": true,
          "languageCode": "<string>",
          "copyCodeButtonIndex": 123,
          "pinPlaceholder": "<string>",
          "paramDefaults": {},
          "entityId": "<string>",
          "unicode": true
        }
      ]
    }
  ]
}

{
  "error": {
    "code": "pin_expired",
    "message": "<string>",
    "requestId": "req_9f3a2c",
    "details": {}
  }
}

{
  "error": {
    "code": "pin_expired",
    "message": "<string>",
    "requestId": "req_9f3a2c",
    "details": {}
  }
}

{
  "error": {
    "code": "pin_expired",
    "message": "<string>",
    "requestId": "req_9f3a2c",
    "details": {}
  }
}

GET

templates

List templates

curl --request GET \
  --url https://api.onexaura.com/v1/templates \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.onexaura.com/v1/templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onexaura.com/v1/templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onexaura.com/v1/templates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.onexaura.com/v1/templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "page": 1,
  "pageSize": 25,
  "total": 137,
  "totalPages": 6,
  "data": [
    {
      "id": "tpl_abc123",
      "name": "<string>",
      "status": "enabled",
      "archivedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "updatedBy": "<string>",
      "pinLength": 6,
      "pinType": "numeric",
      "pinAttempts": 123,
      "pinTimeToLive": "<string>",
      "verifyPinLimit": "<string>",
      "sendPinPerTemplateLimit": "<string>",
      "sendPinPerPhoneNumberLimit": "<string>",
      "resendCooldown": "<string>",
      "channels": [
        {
          "id": "<string>",
          "channelType": "sms",
          "channelAccountId": "<string>",
          "providerTemplateRef": "<string>",
          "contentText": "<string>",
          "subjectText": "<string>",
          "isDefault": true,
          "languageCode": "<string>",
          "copyCodeButtonIndex": 123,
          "pinPlaceholder": "<string>",
          "paramDefaults": {},
          "entityId": "<string>",
          "unicode": true
        }
      ]
    }
  ]
}

{
  "error": {
    "code": "pin_expired",
    "message": "<string>",
    "requestId": "req_9f3a2c",
    "details": {}
  }
}

{
  "error": {
    "code": "pin_expired",
    "message": "<string>",
    "requestId": "req_9f3a2c",
    "details": {}
  }
}

{
  "error": {
    "code": "pin_expired",
    "message": "<string>",
    "requestId": "req_9f3a2c",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

An API key from the OneXtel portal, Developers → API Keys, sent as Authorization: Bearer <key>.

Query Parameters

string

Free-text search over the template name.

status

enum<string>

Available options:

enabled,

disabled

archived

boolean

Include archived templates.

page

integer

default:1

1-based page number. Out-of-range or unparseable values read as page 1.

pageSize

integer

default:25

Rows per page. Defaults to 25; larger values clamp to 100.

Required range: x <= 100

sortBy

string

default:createdAt

Column to sort by. Defaults to createdAt. Enum-typed columns sort by declaration order, not alphabetically.

sortOrder

enum<string>

default:desc

Sort direction. Defaults to desc.

Available options:

asc,

desc

Response

page

integer

Example:

1

pageSize

integer

Example:

25

total

integer

Example:

137

totalPages

integer

Example:

6

data

object[]

Show child attributes

WhatsApp

RCS

SMS (India)

SMS (International)

OmniChannel

Verify

List templates

Authorizations

Query Parameters

Response