curl --request GET \
--url https://api.ya.onl/v1/template-messages/{event_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.ya.onl/v1/template-messages/{event_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.ya.onl/v1/template-messages/{event_id}', 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.ya.onl/v1/template-messages/{event_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.ya.onl/v1/template-messages/{event_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ya.onl/v1/template-messages/{event_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ya.onl/v1/template-messages/{event_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"event_id": "<string>",
"status": "accepted",
"updated_at": "2023-11-07T05:31:56Z",
"status_detail": "stale"
}{
"type": "<string>",
"detail": "<string>"
}{
"type": "<string>",
"detail": "<string>"
}{
"type": "<string>",
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"type": "<string>",
"detail": "<string>"
}Get template message status
Check where a template message got to, by your own event_id.
curl --request GET \
--url https://api.ya.onl/v1/template-messages/{event_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.ya.onl/v1/template-messages/{event_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.ya.onl/v1/template-messages/{event_id}', 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.ya.onl/v1/template-messages/{event_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.ya.onl/v1/template-messages/{event_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ya.onl/v1/template-messages/{event_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ya.onl/v1/template-messages/{event_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"event_id": "<string>",
"status": "accepted",
"updated_at": "2023-11-07T05:31:56Z",
"status_detail": "stale"
}{
"type": "<string>",
"detail": "<string>"
}{
"type": "<string>",
"detail": "<string>"
}{
"type": "<string>",
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"type": "<string>",
"detail": "<string>"
}Autorizaciones
Merchant API key for authentication
Parámetros de ruta
The event_id sent when the message was requested
^[A-Za-z0-9._-]{8,128}$Respuesta
Successful Response
The event_id sent in the request
Current status of the send. A send that was taken answers accepted; poll the status endpoint for what became of it. sent, delivered, read and failed come from delivery receipts, and discarded means it was never sent
accepted, in_progress, sent, delivered, read, failed, discarded When this send's record last changed (UTC) — not when you asked. Polling never moves it, but a delivery write that leaves status unchanged does, so it is not a watermark: reconcile on event_id
Reason behind a failed or discarded status, or the delivery_not_observable note on an accepted one. Not a closed set, and may be absent. stale, paused, account_not_eligible, no_sender_number, send_failed, send_cancelled and delivery_not_observable are ours and stable — the last one means the send went to a store this deployment cannot read, so the status will not settle here; when the provider refused the delivery it carries provider_error_<code> with the provider's own numeric code (for example provider_error_131049), and that catalogue changes without notice. Branch on status, log this, and treat an unrecognised or missing value as a generic failure
"stale"

