ITGroup / Reseller API

Тема

Ответить и при необходимости закрыть тикет ​

POST /tickets/{ticketUuid}/messages

operationId: replyTicket

Только live. Создаётся публичное сообщение от владельца покупателя. close_ticket=true закрывает, false/отсутствие открывает тикет (включая ранее закрытый). Возвращается полная карточка тикета, не только созданное сообщение.

Scopes: tickets.write

Параметры ​

Idempotency-Key ​

Расположение: header. Обязательный. Обязателен для POST/PUT/PATCH/DELETE, включая check, sync, test, rotate-secret. После trim 1..160 символов. Один ключ на логическую операцию и API-ключ. Повторите те же method/path/query и байты JSON. TTL HTTP replay по умолчанию 24 часа от первого резервирования; не продлевается. Не переиспользуйте ключ для новой операции, доменная задача дополнительно сохраняет связь с ним.

ПолеТипОбязательно в родителеОграниченияОписание
$stringДаminLength: 1; maxLength: 160

Пример

json
"webhook-create-20261005-0001"

ticketUuid ​

Расположение: path. Обязательный. UUID ресурса текущего реселлера.

ПолеТипОбязательно в родителеОграниченияОписание
$stringДаformat: "uuid"

Тело запроса ​

Обязательное.

application/json ​

ПолеТипОбязательно в родителеОграниченияОписание
$objectДаrequired: ["message"]Добавляет публичное сообщение. Нет отдельного endpoint изменения приоритета, назначения отдела или закрытия без сообщения. Схема: CoreReplyTicketRequest
$.messagestringДаminLength: 1; maxLength: 5000Сообщение.
$.close_ticketbooleanНетdefault: falsetrue закрывает тикет; false открывает его, в том числе ранее закрытый.

Ответить ​

json
{
  "message": "Прилагаем уточнение: ошибка повторяется."
}
bash
API_BASE_URL='https://api.b.websoft.kz/api/reseller/v1'
: "${RESELLER_API_TOKEN:?Set RESELLER_API_TOKEN in your environment}"
: "${TICKET_UUID:?Set TICKET_UUID}"
: "${IDEMPOTENCY_KEY:?Set one persisted unique key per logical request}"

curl --request POST "$API_BASE_URL/tickets/${TICKET_UUID}/messages" \
  --connect-timeout 5 --max-time 20 --fail-with-body \
  --header "Authorization: Bearer $RESELLER_API_TOKEN" \
  --header 'Accept: application/json' \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "message": "Прилагаем уточнение: ошибка повторяется."
}'
php
<?php
declare(strict_types=1);

// PHP 8.0+; extensions: curl, json. Persist the key/body before any write.
function requiredEnv(string $name): string
{
    $value = getenv($name);
    if ($value === false || $value === '' || str_contains($value, "\r") || str_contains($value, "\n")) {
        throw new RuntimeException('Set a valid environment variable: ' . $name);
    }
    return $value;
}

$baseUrl = rtrim(getenv('API_BASE_URL') ?: 'https://api.b.websoft.kz/api/reseller/v1', '/');
$path = '/tickets/{ticketUuid}/messages';
$path = str_replace('{ticketUuid}', rawurlencode(requiredEnv('TICKET_UUID')), $path);
$url = $baseUrl . $path;
$headers = [
    'Authorization: Bearer ' . requiredEnv('RESELLER_API_TOKEN'),
    'Accept: application/json',
    'Idempotency-Key: ' . requiredEnv('IDEMPOTENCY_KEY'),
    'Content-Type: application/json',
];
$body = '{
  "message": "Прилагаем уточнение: ошибка повторяется."
}';
$responseHeaders = [];
$handle = curl_init($url);
if ($handle === false) {
    throw new RuntimeException('Cannot initialize cURL.');
}
try {
    if (!curl_setopt_array($handle, [
        CURLOPT_CUSTOMREQUEST => 'POST',
        CURLOPT_HTTPHEADER => $headers,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_FOLLOWLOCATION => false,
        CURLOPT_CONNECTTIMEOUT => 5,
        CURLOPT_TIMEOUT => 20,
        CURLOPT_SSL_VERIFYPEER => true,
        CURLOPT_SSL_VERIFYHOST => 2,
        CURLOPT_POSTFIELDS => $body,
        CURLOPT_HEADERFUNCTION => static function (CurlHandle $curl, string $line) use (&$responseHeaders): int {
            if (str_starts_with($line, 'HTTP/')) {
                $responseHeaders = [];
            } elseif (str_contains($line, ':')) {
                [$name, $value] = explode(':', $line, 2);
                $responseHeaders[strtolower(trim($name))] = trim($value);
            }
            return strlen($line);
        },
    ])) {
        throw new RuntimeException('Cannot configure cURL.');
    }
    $raw = curl_exec($handle);
    if ($raw === false) {
        throw new RuntimeException('Transport failure; result may be unknown. cURL code: ' . curl_errno($handle));
    }
    $status = (int) curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
} finally {
    unset($handle);
}
$requestId = $responseHeaders['x-request-id'] ?? null;
$retryAfter = $responseHeaders['retry-after'] ?? null;
$data = null;
if ($raw !== '' && !in_array($status, [204, 205], true)) {
    try {
        $data = json_decode($raw, true, 512, JSON_THROW_ON_ERROR);
    } catch (JsonException $error) {
        if ($status >= 200 && $status < 300) {
            throw new RuntimeException('Unexpected non-JSON success response.', 0, $error);
        }
    }
}
if ($status < 200 || $status >= 300) {
    // Inspect $data['error']; queue 429 using $retryAfter, never create a new write key blindly.
    throw new RuntimeException('HTTP ' . $status . '; request_id=' . ($requestId ?? '-') . '; retry_after=' . ($retryAfter ?? '-'));
}
// $data contains the decoded response; 202 means accepted, not completed.
echo 'HTTP ' . $status . PHP_EOL;
js
// Node.js 22+; save as request.mjs. No third-party dependencies.
function requiredEnv(name) {
  const value = process.env[name];
  if (!value || /[\r\n]/u.test(value)) throw new Error('Set a valid environment variable: ' + name);
  return value;
}
const baseUrl = (process.env.API_BASE_URL || "https://api.b.websoft.kz/api/reseller/v1").replace(/\/$/u, '');
let path = "/tickets/{ticketUuid}/messages";
path = path.replaceAll("{ticketUuid}", encodeURIComponent(requiredEnv("TICKET_UUID")));
const url = baseUrl + path;
const body = `{
  "message": "Прилагаем уточнение: ошибка повторяется."
}`;
const response = await fetch(url, {
  method: "POST",
  redirect: 'manual',
  signal: AbortSignal.timeout(20_000),
  headers: {
    Authorization: 'Bearer ' + requiredEnv('RESELLER_API_TOKEN'),
    Accept: 'application/json',
    'Idempotency-Key': requiredEnv('IDEMPOTENCY_KEY'),
    "Content-Type": "application/json",
  },
  body,
});
const requestId = response.headers.get('x-request-id');
const retryAfter = response.headers.get('retry-after');
const raw = await response.text();
let data = null;
if (raw && ![204, 205].includes(response.status)) {
  try { data = JSON.parse(raw); }
  catch (cause) { if (response.ok) throw new Error('Unexpected non-JSON success response.', { cause }); }
}
if (!response.ok) {
  // Inspect data?.error; schedule 429 using retryAfter. Do not generate another write key.
  throw new Error('HTTP ' + response.status + '; request_id=' + requestId + '; retry_after=' + retryAfter);
}
// A timeout may have an unknown result. No automatic mutation retry in this example.
// data contains the response; 202 means accepted, not completed.
console.log('HTTP', response.status);
python
# Python 3.10+; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import quote
from urllib.request import HTTPRedirectHandler, Request, build_opener

def required_env(name):
    value = os.environ.get(name, "")
    if not value or "\r" in value or "\n" in value:
        raise RuntimeError("Set a valid environment variable: " + name)
    return value

class NoRedirect(HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None

base_url = os.environ.get("API_BASE_URL", "https://api.b.websoft.kz/api/reseller/v1").rstrip("/")
path = "/tickets/{ticketUuid}/messages"
path = path.replace("{ticketUuid}", quote(required_env("TICKET_UUID"), safe=""))
url = base_url + path
headers = {
    "Authorization": "Bearer " + required_env("RESELLER_API_TOKEN"),
    "Accept": "application/json",
    "Idempotency-Key": required_env("IDEMPOTENCY_KEY"),
    "Content-Type": "application/json",
}
body = "{\n  \"message\": \"Прилагаем уточнение: ошибка повторяется.\"\n}".encode("utf-8")
request = Request(url, data=body, headers=headers, method="POST")
opener = build_opener(NoRedirect())
try:
    response = opener.open(request, timeout=20)
except HTTPError as error:
    response = error  # HTTP failure still has a response body and headers.
# Network/timeout exceptions propagate: a write may already have been accepted.
with response:
    status = response.status
    request_id = response.headers.get("X-Request-ID")
    retry_after = response.headers.get("Retry-After")
    raw = response.read()
data = None
if raw and status not in (204, 205):
    try:
        data = json.loads(raw)
    except (ValueError, UnicodeDecodeError):
        if 200 <= status < 300:
            raise RuntimeError("Unexpected non-JSON success response.")
if not 200 <= status < 300:
    # Inspect data['error']; schedule 429 with retry_after, keeping the same persisted key.
    raise RuntimeError(f"HTTP {status}; request_id={request_id}; retry_after={retry_after}")
# data contains the response. Do not log secrets/PII; 202 is not completion.
print("HTTP", status)
go
// Go 1.22+; standard library only. Save as main.go and run: go run main.go
package main

import (
    "encoding/json"
    "fmt"
    "io"
    "net/http"
    "net/url"
    "os"
    "strings"
    "time"
)

func requiredEnv(name string) string {
    value := os.Getenv(name)
    if value == "" || strings.ContainsAny(value, "\r\n") { panic("Set a valid environment variable: " + name) }
    return value
}

func main() {
    baseURL := os.Getenv("API_BASE_URL")
    if baseURL == "" { baseURL = "https://api.b.websoft.kz/api/reseller/v1" }
    path := "/tickets/{ticketUuid}/messages"
    value0 := requiredEnv("TICKET_UUID")
    path = strings.ReplaceAll(path, "{ticketUuid}", url.PathEscape(value0))
    endpoint := strings.TrimRight(baseURL, "/") + path
    request, err := http.NewRequest("POST", endpoint, strings.NewReader("{\n  \"message\": \"Прилагаем уточнение: ошибка повторяется.\"\n}"))
    if err != nil { panic(err) }
    request.Header.Set("Authorization", "Bearer " + requiredEnv("RESELLER_API_TOKEN"))
    request.Header.Set("Accept", "application/json")
    request.Header.Set("Idempotency-Key", requiredEnv("IDEMPOTENCY_KEY"))
    request.Header.Set("Content-Type", "application/json")
    client := &http.Client{
        Timeout: 20 * time.Second,
        CheckRedirect: func(req *http.Request, via []*http.Request) error { return http.ErrUseLastResponse },
    }
    response, err := client.Do(request)
    if err != nil { panic("Transport failure; operation result may be unknown") }
    defer response.Body.Close()
    raw, err := io.ReadAll(response.Body)
    if err != nil { panic("Response read failed; operation result may be unknown") }
    requestID := response.Header.Get("X-Request-ID")
    retryAfter := response.Header.Get("Retry-After")
    var data any
    if len(raw) > 0 && response.StatusCode != 204 && response.StatusCode != 205 {
        decoder := json.NewDecoder(strings.NewReader(string(raw)))
        decoder.UseNumber() // Preserve integer money/identifiers without float rounding.
        if err := decoder.Decode(&data); err != nil && response.StatusCode >= 200 && response.StatusCode < 300 { panic("Unexpected non-JSON success response") }
    }
    if response.StatusCode < 200 || response.StatusCode >= 300 {
        // Inspect data; schedule 429 using retryAfter. Never create a new key blindly.
        panic(fmt.Sprintf("HTTP %d; request_id=%s; retry_after=%s", response.StatusCode, requestID, retryAfter))
    }
    // data holds the JSON value; 202 means accepted, not completed. Do not log secrets.
    fmt.Println("HTTP", response.StatusCode)
}
java
// Java 17+; standard library only. Save as RequestExample.java.
// Run: java RequestExample.java
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.time.Duration;

public class RequestExample {
    private static String requiredEnv(String name) {
        String value = System.getenv(name);
        if (value == null || value.isEmpty() || value.contains("\r") || value.contains("\n")) {
            throw new IllegalStateException("Set a valid environment variable: " + name);
        }
        return value;
    }
    private static String envOr(String name, String fallback) {
        String value = System.getenv(name);
        return value == null || value.isEmpty() ? fallback : value;
    }
    public static void main(String[] args) throws Exception {
        String baseUrl = envOr("API_BASE_URL", "https://api.b.websoft.kz/api/reseller/v1").replaceAll("/+$", "");
        String path = "/tickets/{ticketUuid}/messages";
        path = path.replace("{ticketUuid}", URLEncoder.encode(requiredEnv("TICKET_UUID"), StandardCharsets.UTF_8).replace("+", "%20"));
        URI uri = URI.create(baseUrl + path);
        String body = "{\n  \"message\": \"Прилагаем уточнение: ошибка повторяется.\"\n}";
        HttpRequest request = HttpRequest.newBuilder(uri)
            .timeout(Duration.ofSeconds(20))
            .header("Authorization", "Bearer " + requiredEnv("RESELLER_API_TOKEN"))
            .header("Accept", "application/json")
            .header("Idempotency-Key", requiredEnv("IDEMPOTENCY_KEY"))
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body, StandardCharsets.UTF_8))
            .build();
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(5))
            .followRedirects(HttpClient.Redirect.NEVER)
            .build();
        // Reuse HttpClient in production. A timeout may mean an unknown write result.
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8));
        int status = response.statusCode();
        String requestId = response.headers().firstValue("X-Request-ID").orElse("");
        String retryAfter = response.headers().firstValue("Retry-After").orElse("");
        String responseBody = (status == 204 || status == 205) ? "" : response.body();
        if (status < 200 || status >= 300) {
            // Decode responseBody with your JSON library; schedule 429 using retryAfter.
            throw new IllegalStateException("HTTP " + status + "; request_id=" + requestId + "; retry_after=" + retryAfter);
        }
        // Java SE has no JSON object mapper: pass responseBody to your project's JSON parser.
        // Do not parse an empty 204 body; 202 means accepted, not completed.
        System.out.println("HTTP " + status);
    }
}
csharp
// C# / .NET 8+ console app; standard library only. Save as Program.cs.
using System;
using System.Net.Http;
using System.Text;
using System.Text.Json;

static string RequiredEnv(string name)
{
    string? value = Environment.GetEnvironmentVariable(name);
    if (string.IsNullOrEmpty(value) || value.Contains('\r') || value.Contains('\n'))
        throw new InvalidOperationException("Set a valid environment variable: " + name);
    return value;
}

string baseUrl = (Environment.GetEnvironmentVariable("API_BASE_URL") ?? "https://api.b.websoft.kz/api/reseller/v1").TrimEnd('/');
string path = "/tickets/{ticketUuid}/messages";
path = path.Replace("{ticketUuid}", Uri.EscapeDataString(RequiredEnv("TICKET_UUID")));
using var handler = new HttpClientHandler { AllowAutoRedirect = false };
using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(20) };
// Reuse HttpClient (or IHttpClientFactory) in production, not one client per request.
using var request = new HttpRequestMessage(new HttpMethod("POST"), baseUrl + path);
request.Headers.Add("Authorization", "Bearer " + RequiredEnv("RESELLER_API_TOKEN"));
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Idempotency-Key", RequiredEnv("IDEMPOTENCY_KEY"));
request.Content = new StringContent("{\n  \"message\": \"Прилагаем уточнение: ошибка повторяется.\"\n}", Encoding.UTF8, "application/json");

// Transport exceptions may have an unknown result; do not issue a new mutation automatically.
using var response = await client.SendAsync(request);
int status = (int)response.StatusCode;
string requestId = response.Headers.TryGetValues("X-Request-ID", out var ids) ? string.Join(",", ids) : "";
string retryAfter = response.Headers.TryGetValues("Retry-After", out var delays) ? string.Join(",", delays) : "";
string raw = await response.Content.ReadAsStringAsync();
JsonElement? data = null;
if (raw.Length > 0 && status != 204 && status != 205)
{
    try { using var document = JsonDocument.Parse(raw); data = document.RootElement.Clone(); }
    catch (JsonException) { if (response.IsSuccessStatusCode) throw; }
}
if (!response.IsSuccessStatusCode)
{
    // Inspect data; schedule 429 using retryAfter and preserve the same key/body.
    throw new HttpRequestException($"HTTP {status}; request_id={requestId}; retry_after={retryAfter}");
}
// data contains JSON, or null for 204. HTTP 202 is not completion.
Console.WriteLine($"HTTP {status}");

Ответить и закрыть ​

json
{
  "message": "Вопрос решён, спасибо.",
  "close_ticket": true
}
bash
API_BASE_URL='https://api.b.websoft.kz/api/reseller/v1'
: "${RESELLER_API_TOKEN:?Set RESELLER_API_TOKEN in your environment}"
: "${TICKET_UUID:?Set TICKET_UUID}"
: "${IDEMPOTENCY_KEY:?Set one persisted unique key per logical request}"

curl --request POST "$API_BASE_URL/tickets/${TICKET_UUID}/messages" \
  --connect-timeout 5 --max-time 20 --fail-with-body \
  --header "Authorization: Bearer $RESELLER_API_TOKEN" \
  --header 'Accept: application/json' \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "message": "Вопрос решён, спасибо.",
  "close_ticket": true
}'
php
<?php
declare(strict_types=1);

// PHP 8.0+; extensions: curl, json. Persist the key/body before any write.
function requiredEnv(string $name): string
{
    $value = getenv($name);
    if ($value === false || $value === '' || str_contains($value, "\r") || str_contains($value, "\n")) {
        throw new RuntimeException('Set a valid environment variable: ' . $name);
    }
    return $value;
}

$baseUrl = rtrim(getenv('API_BASE_URL') ?: 'https://api.b.websoft.kz/api/reseller/v1', '/');
$path = '/tickets/{ticketUuid}/messages';
$path = str_replace('{ticketUuid}', rawurlencode(requiredEnv('TICKET_UUID')), $path);
$url = $baseUrl . $path;
$headers = [
    'Authorization: Bearer ' . requiredEnv('RESELLER_API_TOKEN'),
    'Accept: application/json',
    'Idempotency-Key: ' . requiredEnv('IDEMPOTENCY_KEY'),
    'Content-Type: application/json',
];
$body = '{
  "message": "Вопрос решён, спасибо.",
  "close_ticket": true
}';
$responseHeaders = [];
$handle = curl_init($url);
if ($handle === false) {
    throw new RuntimeException('Cannot initialize cURL.');
}
try {
    if (!curl_setopt_array($handle, [
        CURLOPT_CUSTOMREQUEST => 'POST',
        CURLOPT_HTTPHEADER => $headers,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_FOLLOWLOCATION => false,
        CURLOPT_CONNECTTIMEOUT => 5,
        CURLOPT_TIMEOUT => 20,
        CURLOPT_SSL_VERIFYPEER => true,
        CURLOPT_SSL_VERIFYHOST => 2,
        CURLOPT_POSTFIELDS => $body,
        CURLOPT_HEADERFUNCTION => static function (CurlHandle $curl, string $line) use (&$responseHeaders): int {
            if (str_starts_with($line, 'HTTP/')) {
                $responseHeaders = [];
            } elseif (str_contains($line, ':')) {
                [$name, $value] = explode(':', $line, 2);
                $responseHeaders[strtolower(trim($name))] = trim($value);
            }
            return strlen($line);
        },
    ])) {
        throw new RuntimeException('Cannot configure cURL.');
    }
    $raw = curl_exec($handle);
    if ($raw === false) {
        throw new RuntimeException('Transport failure; result may be unknown. cURL code: ' . curl_errno($handle));
    }
    $status = (int) curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
} finally {
    unset($handle);
}
$requestId = $responseHeaders['x-request-id'] ?? null;
$retryAfter = $responseHeaders['retry-after'] ?? null;
$data = null;
if ($raw !== '' && !in_array($status, [204, 205], true)) {
    try {
        $data = json_decode($raw, true, 512, JSON_THROW_ON_ERROR);
    } catch (JsonException $error) {
        if ($status >= 200 && $status < 300) {
            throw new RuntimeException('Unexpected non-JSON success response.', 0, $error);
        }
    }
}
if ($status < 200 || $status >= 300) {
    // Inspect $data['error']; queue 429 using $retryAfter, never create a new write key blindly.
    throw new RuntimeException('HTTP ' . $status . '; request_id=' . ($requestId ?? '-') . '; retry_after=' . ($retryAfter ?? '-'));
}
// $data contains the decoded response; 202 means accepted, not completed.
echo 'HTTP ' . $status . PHP_EOL;
js
// Node.js 22+; save as request.mjs. No third-party dependencies.
function requiredEnv(name) {
  const value = process.env[name];
  if (!value || /[\r\n]/u.test(value)) throw new Error('Set a valid environment variable: ' + name);
  return value;
}
const baseUrl = (process.env.API_BASE_URL || "https://api.b.websoft.kz/api/reseller/v1").replace(/\/$/u, '');
let path = "/tickets/{ticketUuid}/messages";
path = path.replaceAll("{ticketUuid}", encodeURIComponent(requiredEnv("TICKET_UUID")));
const url = baseUrl + path;
const body = `{
  "message": "Вопрос решён, спасибо.",
  "close_ticket": true
}`;
const response = await fetch(url, {
  method: "POST",
  redirect: 'manual',
  signal: AbortSignal.timeout(20_000),
  headers: {
    Authorization: 'Bearer ' + requiredEnv('RESELLER_API_TOKEN'),
    Accept: 'application/json',
    'Idempotency-Key': requiredEnv('IDEMPOTENCY_KEY'),
    "Content-Type": "application/json",
  },
  body,
});
const requestId = response.headers.get('x-request-id');
const retryAfter = response.headers.get('retry-after');
const raw = await response.text();
let data = null;
if (raw && ![204, 205].includes(response.status)) {
  try { data = JSON.parse(raw); }
  catch (cause) { if (response.ok) throw new Error('Unexpected non-JSON success response.', { cause }); }
}
if (!response.ok) {
  // Inspect data?.error; schedule 429 using retryAfter. Do not generate another write key.
  throw new Error('HTTP ' + response.status + '; request_id=' + requestId + '; retry_after=' + retryAfter);
}
// A timeout may have an unknown result. No automatic mutation retry in this example.
// data contains the response; 202 means accepted, not completed.
console.log('HTTP', response.status);
python
# Python 3.10+; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import quote
from urllib.request import HTTPRedirectHandler, Request, build_opener

def required_env(name):
    value = os.environ.get(name, "")
    if not value or "\r" in value or "\n" in value:
        raise RuntimeError("Set a valid environment variable: " + name)
    return value

class NoRedirect(HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None

base_url = os.environ.get("API_BASE_URL", "https://api.b.websoft.kz/api/reseller/v1").rstrip("/")
path = "/tickets/{ticketUuid}/messages"
path = path.replace("{ticketUuid}", quote(required_env("TICKET_UUID"), safe=""))
url = base_url + path
headers = {
    "Authorization": "Bearer " + required_env("RESELLER_API_TOKEN"),
    "Accept": "application/json",
    "Idempotency-Key": required_env("IDEMPOTENCY_KEY"),
    "Content-Type": "application/json",
}
body = "{\n  \"message\": \"Вопрос решён, спасибо.\",\n  \"close_ticket\": true\n}".encode("utf-8")
request = Request(url, data=body, headers=headers, method="POST")
opener = build_opener(NoRedirect())
try:
    response = opener.open(request, timeout=20)
except HTTPError as error:
    response = error  # HTTP failure still has a response body and headers.
# Network/timeout exceptions propagate: a write may already have been accepted.
with response:
    status = response.status
    request_id = response.headers.get("X-Request-ID")
    retry_after = response.headers.get("Retry-After")
    raw = response.read()
data = None
if raw and status not in (204, 205):
    try:
        data = json.loads(raw)
    except (ValueError, UnicodeDecodeError):
        if 200 <= status < 300:
            raise RuntimeError("Unexpected non-JSON success response.")
if not 200 <= status < 300:
    # Inspect data['error']; schedule 429 with retry_after, keeping the same persisted key.
    raise RuntimeError(f"HTTP {status}; request_id={request_id}; retry_after={retry_after}")
# data contains the response. Do not log secrets/PII; 202 is not completion.
print("HTTP", status)
go
// Go 1.22+; standard library only. Save as main.go and run: go run main.go
package main

import (
    "encoding/json"
    "fmt"
    "io"
    "net/http"
    "net/url"
    "os"
    "strings"
    "time"
)

func requiredEnv(name string) string {
    value := os.Getenv(name)
    if value == "" || strings.ContainsAny(value, "\r\n") { panic("Set a valid environment variable: " + name) }
    return value
}

func main() {
    baseURL := os.Getenv("API_BASE_URL")
    if baseURL == "" { baseURL = "https://api.b.websoft.kz/api/reseller/v1" }
    path := "/tickets/{ticketUuid}/messages"
    value0 := requiredEnv("TICKET_UUID")
    path = strings.ReplaceAll(path, "{ticketUuid}", url.PathEscape(value0))
    endpoint := strings.TrimRight(baseURL, "/") + path
    request, err := http.NewRequest("POST", endpoint, strings.NewReader("{\n  \"message\": \"Вопрос решён, спасибо.\",\n  \"close_ticket\": true\n}"))
    if err != nil { panic(err) }
    request.Header.Set("Authorization", "Bearer " + requiredEnv("RESELLER_API_TOKEN"))
    request.Header.Set("Accept", "application/json")
    request.Header.Set("Idempotency-Key", requiredEnv("IDEMPOTENCY_KEY"))
    request.Header.Set("Content-Type", "application/json")
    client := &http.Client{
        Timeout: 20 * time.Second,
        CheckRedirect: func(req *http.Request, via []*http.Request) error { return http.ErrUseLastResponse },
    }
    response, err := client.Do(request)
    if err != nil { panic("Transport failure; operation result may be unknown") }
    defer response.Body.Close()
    raw, err := io.ReadAll(response.Body)
    if err != nil { panic("Response read failed; operation result may be unknown") }
    requestID := response.Header.Get("X-Request-ID")
    retryAfter := response.Header.Get("Retry-After")
    var data any
    if len(raw) > 0 && response.StatusCode != 204 && response.StatusCode != 205 {
        decoder := json.NewDecoder(strings.NewReader(string(raw)))
        decoder.UseNumber() // Preserve integer money/identifiers without float rounding.
        if err := decoder.Decode(&data); err != nil && response.StatusCode >= 200 && response.StatusCode < 300 { panic("Unexpected non-JSON success response") }
    }
    if response.StatusCode < 200 || response.StatusCode >= 300 {
        // Inspect data; schedule 429 using retryAfter. Never create a new key blindly.
        panic(fmt.Sprintf("HTTP %d; request_id=%s; retry_after=%s", response.StatusCode, requestID, retryAfter))
    }
    // data holds the JSON value; 202 means accepted, not completed. Do not log secrets.
    fmt.Println("HTTP", response.StatusCode)
}
java
// Java 17+; standard library only. Save as RequestExample.java.
// Run: java RequestExample.java
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.time.Duration;

public class RequestExample {
    private static String requiredEnv(String name) {
        String value = System.getenv(name);
        if (value == null || value.isEmpty() || value.contains("\r") || value.contains("\n")) {
            throw new IllegalStateException("Set a valid environment variable: " + name);
        }
        return value;
    }
    private static String envOr(String name, String fallback) {
        String value = System.getenv(name);
        return value == null || value.isEmpty() ? fallback : value;
    }
    public static void main(String[] args) throws Exception {
        String baseUrl = envOr("API_BASE_URL", "https://api.b.websoft.kz/api/reseller/v1").replaceAll("/+$", "");
        String path = "/tickets/{ticketUuid}/messages";
        path = path.replace("{ticketUuid}", URLEncoder.encode(requiredEnv("TICKET_UUID"), StandardCharsets.UTF_8).replace("+", "%20"));
        URI uri = URI.create(baseUrl + path);
        String body = "{\n  \"message\": \"Вопрос решён, спасибо.\",\n  \"close_ticket\": true\n}";
        HttpRequest request = HttpRequest.newBuilder(uri)
            .timeout(Duration.ofSeconds(20))
            .header("Authorization", "Bearer " + requiredEnv("RESELLER_API_TOKEN"))
            .header("Accept", "application/json")
            .header("Idempotency-Key", requiredEnv("IDEMPOTENCY_KEY"))
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body, StandardCharsets.UTF_8))
            .build();
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(5))
            .followRedirects(HttpClient.Redirect.NEVER)
            .build();
        // Reuse HttpClient in production. A timeout may mean an unknown write result.
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8));
        int status = response.statusCode();
        String requestId = response.headers().firstValue("X-Request-ID").orElse("");
        String retryAfter = response.headers().firstValue("Retry-After").orElse("");
        String responseBody = (status == 204 || status == 205) ? "" : response.body();
        if (status < 200 || status >= 300) {
            // Decode responseBody with your JSON library; schedule 429 using retryAfter.
            throw new IllegalStateException("HTTP " + status + "; request_id=" + requestId + "; retry_after=" + retryAfter);
        }
        // Java SE has no JSON object mapper: pass responseBody to your project's JSON parser.
        // Do not parse an empty 204 body; 202 means accepted, not completed.
        System.out.println("HTTP " + status);
    }
}
csharp
// C# / .NET 8+ console app; standard library only. Save as Program.cs.
using System;
using System.Net.Http;
using System.Text;
using System.Text.Json;

static string RequiredEnv(string name)
{
    string? value = Environment.GetEnvironmentVariable(name);
    if (string.IsNullOrEmpty(value) || value.Contains('\r') || value.Contains('\n'))
        throw new InvalidOperationException("Set a valid environment variable: " + name);
    return value;
}

string baseUrl = (Environment.GetEnvironmentVariable("API_BASE_URL") ?? "https://api.b.websoft.kz/api/reseller/v1").TrimEnd('/');
string path = "/tickets/{ticketUuid}/messages";
path = path.Replace("{ticketUuid}", Uri.EscapeDataString(RequiredEnv("TICKET_UUID")));
using var handler = new HttpClientHandler { AllowAutoRedirect = false };
using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(20) };
// Reuse HttpClient (or IHttpClientFactory) in production, not one client per request.
using var request = new HttpRequestMessage(new HttpMethod("POST"), baseUrl + path);
request.Headers.Add("Authorization", "Bearer " + RequiredEnv("RESELLER_API_TOKEN"));
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Idempotency-Key", RequiredEnv("IDEMPOTENCY_KEY"));
request.Content = new StringContent("{\n  \"message\": \"Вопрос решён, спасибо.\",\n  \"close_ticket\": true\n}", Encoding.UTF8, "application/json");

// Transport exceptions may have an unknown result; do not issue a new mutation automatically.
using var response = await client.SendAsync(request);
int status = (int)response.StatusCode;
string requestId = response.Headers.TryGetValues("X-Request-ID", out var ids) ? string.Join(",", ids) : "";
string retryAfter = response.Headers.TryGetValues("Retry-After", out var delays) ? string.Join(",", delays) : "";
string raw = await response.Content.ReadAsStringAsync();
JsonElement? data = null;
if (raw.Length > 0 && status != 204 && status != 205)
{
    try { using var document = JsonDocument.Parse(raw); data = document.RootElement.Clone(); }
    catch (JsonException) { if (response.IsSuccessStatusCode) throw; }
}
if (!response.IsSuccessStatusCode)
{
    // Inspect data; schedule 429 using retryAfter and preserve the same key/body.
    throw new HttpRequestException($"HTTP {status}; request_id={requestId}; retry_after={retryAfter}");
}
// data contains JSON, or null for 204. HTTP 202 is not completion.
Console.WriteLine($"HTTP {status}");

Ответы ​

Условия ошибок и восстановление ​

HTTPКодКогда возникаетЧто делать
401unauthenticatedBearer-ключ отсутствует, недействителен, отозван или истёк.Проверьте ключ и его срок, не повторяйте с теми же неверными credentials.
403forbiddenКлюч test либо отсутствует tickets.write.Проверьте scopes, среду, allowlist и настройки реселлера через администратора.
404resource_not_foundТикет не найден у реселлера.Проверьте UUID, среду и принадлежность; при отключённой функции обратитесь к оператору.
409conflictIdempotency-Key уже обрабатывается либо использован для другого метода, URL/query или тела.Для того же запроса дождитесь завершения и повторите неизменённый запрос с тем же ключом; изменённый запрос требует нового ключа после сверки результата.
422validation_failedПустое/слишком длинное сообщение, неверный boolean или у покупателя нет владельца.Исправьте поля из error.details/условия. Не повторяйте неизменённый невалидный запрос.
429rate_limit_exceededЛимит текущего API-ключа исчерпан.Учитывайте Retry-After при наличии, используйте backoff с jitter. Запись повторяйте с прежним Idempotency-Key и неизменённым телом.
500internal_errorНеобработанная ошибка выполнения; это не подтверждение отсутствия побочного эффекта.Сохраните request_id; сначала проверьте состояние объекта, затем повторяйте запись с тем же ключом. Для неоднозначного результата обращайтесь в поддержку.

HTTP 200 ​

Успешный ответ.

Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.

ПолеТипОбязательно в родителеОграниченияОписание
$stringДаformat: "uuid"

Заголовок X-RateLimit-Limit: Лимит API-ключа на 60 секунд. После прохождения ограничителя, включая replay. Отсутствует в собственной ветке 429 и при раннем отказе.

ПолеТипОбязательно в родителеОграниченияОписание
$integerДаminimum: 1
text
X-RateLimit-Limit: 120

Заголовок X-RateLimit-Remaining: Остаток после запроса. Снимок, не гарантия при конкуренции. Отсутствует в собственной ветке 429 и при раннем отказе.

ПолеТипОбязательно в родителеОграниченияОписание
$integerДаminimum: 0
text
X-RateLimit-Remaining: 119

Заголовок Idempotency-Replayed: Только при возврате сохранённого HTTP-ответа: true, не false. Отсутствие не доказывает, что доменная операция ранее не выполнялась.

ПолеТипОбязательно в родителеОграниченияОписание
$stringДаconst: "true"

Content-Type: application/json

ПолеТипОбязательно в родителеОграниченияОписание
$objectДаrequired: ["data"]Успешный ответ. Схема: CoreTicketEnvelope
$.dataobjectДаrequired: ["uuid","external_id","customer_uuid","number","subject","status","priority","department","category","service_uuid","domain_uuid","order_uuid","last_message_at","closed_at","messages_count","created_at","updated_at","messages"]Тикет с полной публичной перепиской в хронологическом порядке. Схема: CoreTicket
$.data.uuidstringДаformat: "uuid"UUID объекта.
$.data.external_idstring / nullДаID тикета внешнего биллинга.
$.data.customer_uuidstring / nullДаformat: "uuid"Покупатель.
$.data.numberstringДаНомер.
$.data.subjectstringДаТема.
$.data.statusstringДаСостояние; ответ клиента открывает тикет, close_ticket=true закрывает.
$.data.prioritystringДаenum: "low", "normal", "high", "urgent"Приоритет.
$.data.departmentstring / nullДаОтдел.
$.data.categorystring / nullДаКатегория.
$.data.service_uuidstring / nullДаformat: "uuid"Связанная услуга.
$.data.domain_uuidstring / nullДаformat: "uuid"Связанный домен.
$.data.order_uuidstring / nullДаformat: "uuid"Связанный заказ.
$.data.last_message_atstring / nullДаformat: "date-time"Последнее сообщение.
$.data.closed_atstring / nullДаformat: "date-time"Закрыт.
$.data.messages_countintegerДаformat: "int64"; minimum: 0Количество публичных сообщений.
$.data.created_atstring / nullДаformat: "date-time"Создан.
$.data.updated_atstring / nullДаformat: "date-time"Изменён.
$.data.messagesarrayДаСообщения от старых к новым, без отдельной пагинации.
$.data.messages[]objectДаrequired: ["uuid","type","body","sender_type","created_at","attachments"]Только публичное сообщение; внутренние заметки не возвращаются. Схема: CoreTicketMessage
$.data.messages[].uuidstringДаformat: "uuid"UUID объекта.
$.data.messages[].typestringДаТип сообщения.
$.data.messages[].bodystringДаТекст.
$.data.messages[].sender_typestringДаenum: "customer", "support"Сторона.
$.data.messages[].created_atstring / nullДаformat: "date-time"Создано.
$.data.messages[].attachmentsarrayДаМетаданные вложений.
$.data.messages[].attachments[]objectДаrequired: ["uuid","name","mime_type","size_bytes"]Метаданные вложения. Этот API не предоставляет upload/download endpoint или URL содержимого. Схема: CoreTicketAttachment
$.data.messages[].attachments[].uuidstringДаformat: "uuid"UUID объекта.
$.data.messages[].attachments[].namestringДаИсходное имя.
$.data.messages[].attachments[].mime_typestringДаMIME.
$.data.messages[].attachments[].size_bytesintegerДаformat: "int64"; minimum: 0Байты.

Ответ закрыл обращение (200) ​

json
{
  "data": {
    "uuid": "019a0000-0000-7000-8000-000000000060",
    "external_id": "support-4042",
    "customer_uuid": "019a0000-0000-7000-8000-000000000010",
    "number": "TCK-20261005090000-DEMO42",
    "subject": "Проверка регистрации домена",
    "status": "closed",
    "priority": "normal",
    "department": null,
    "category": null,
    "service_uuid": "019a0000-0000-7000-8000-000000000040",
    "domain_uuid": "019a0000-0000-7000-8000-000000000041",
    "order_uuid": "019a0000-0000-7000-8000-000000000030",
    "last_message_at": "2026-10-05T10:00:00+00:00",
    "closed_at": "2026-10-05T10:00:00+00:00",
    "messages_count": 2,
    "created_at": "2026-10-05T09:00:00+00:00",
    "updated_at": "2026-10-05T10:00:00+00:00",
    "messages": [
      {
        "uuid": "019a0000-0000-7000-8000-000000000061",
        "type": "message",
        "body": "Просим проверить состояние регистрации домена reseller-example.kz.",
        "sender_type": "customer",
        "created_at": "2026-10-05T09:00:00+00:00",
        "attachments": []
      },
      {
        "uuid": "019a0000-0000-7000-8000-000000000062",
        "type": "message",
        "body": "Вопрос решён, спасибо.",
        "sender_type": "customer",
        "created_at": "2026-10-05T10:00:00+00:00",
        "attachments": []
      }
    ]
  }
}

Ответ без close_ticket открывает тикет (200) ​

json
{
  "data": {
    "uuid": "019a0000-0000-7000-8000-000000000060",
    "external_id": "support-4042",
    "customer_uuid": "019a0000-0000-7000-8000-000000000010",
    "number": "TCK-20261005090000-DEMO42",
    "subject": "Проверка регистрации домена",
    "status": "open",
    "priority": "normal",
    "department": null,
    "category": null,
    "service_uuid": "019a0000-0000-7000-8000-000000000040",
    "domain_uuid": "019a0000-0000-7000-8000-000000000041",
    "order_uuid": "019a0000-0000-7000-8000-000000000030",
    "last_message_at": "2026-10-05T10:00:00+00:00",
    "closed_at": null,
    "messages_count": 2,
    "created_at": "2026-10-05T09:00:00+00:00",
    "updated_at": "2026-10-05T10:00:00+00:00",
    "messages": [
      {
        "uuid": "019a0000-0000-7000-8000-000000000061",
        "type": "message",
        "body": "Просим проверить состояние регистрации домена reseller-example.kz.",
        "sender_type": "customer",
        "created_at": "2026-10-05T09:00:00+00:00",
        "attachments": []
      },
      {
        "uuid": "019a0000-0000-7000-8000-000000000062",
        "type": "message",
        "body": "Вопрос решён, спасибо.",
        "sender_type": "customer",
        "created_at": "2026-10-05T10:00:00+00:00",
        "attachments": []
      }
    ]
  }
}

HTTP 401 ​

Bearer-ключ отсутствует, недействителен, отозван или истёк.

Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.

ПолеТипОбязательно в родителеОграниченияОписание
$stringДаformat: "uuid"

Content-Type: application/json

ПолеТипОбязательно в родителеОграниченияОписание
$objectДаrequired: ["error"]Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope
$.errorobjectДаrequired: ["code","message","details","request_id"]
$.error.codestringДаМашинный код; не извлекайте причину из message.
$.error.messagestringДаЧеловекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки.
$.error.detailsoneOfДаБез подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}.
$.error.details (oneOf 1)arrayДаmaxItems: 0
$.error.details (oneOf 2)objectДа
$.error.details (oneOf 2).*arrayНет
$.error.details (oneOf 2).*[]stringДа
$.error.details (oneOf 3)objectДаrequired: ["retry_after"]; Дополнительные поля запрещены
$.error.details (oneOf 3).retry_afterintegerДаminimum: 0
$.error.request_idstring / nullДаformat: "uuid"UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке.

default (401) ​

json
{
  "error": {
    "code": "unauthenticated",
    "message": "API credential is missing or invalid.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

HTTP 403 ​

Ключ test либо отсутствует tickets.write.

Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.

ПолеТипОбязательно в родителеОграниченияОписание
$stringДаformat: "uuid"

Content-Type: application/json

ПолеТипОбязательно в родителеОграниченияОписание
$objectДаrequired: ["error"]Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope
$.errorobjectДаrequired: ["code","message","details","request_id"]
$.error.codestringДаМашинный код; не извлекайте причину из message.
$.error.messagestringДаЧеловекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки.
$.error.detailsoneOfДаБез подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}.
$.error.details (oneOf 1)arrayДаmaxItems: 0
$.error.details (oneOf 2)objectДа
$.error.details (oneOf 2).*arrayНет
$.error.details (oneOf 2).*[]stringДа
$.error.details (oneOf 3)objectДаrequired: ["retry_after"]; Дополнительные поля запрещены
$.error.details (oneOf 3).retry_afterintegerДаminimum: 0
$.error.request_idstring / nullДаformat: "uuid"UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке.

default (403) ​

json
{
  "error": {
    "code": "forbidden",
    "message": "Source IP address is not allowed.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

supportTest (403) ​

json
{
  "error": {
    "code": "forbidden",
    "message": "Support is available only to live credentials.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

HTTP 404 ​

Тикет не найден у реселлера.

Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.

ПолеТипОбязательно в родителеОграниченияОписание
$stringДаformat: "uuid"

Content-Type: application/json

ПолеТипОбязательно в родителеОграниченияОписание
$objectДаrequired: ["error"]Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope
$.errorobjectДаrequired: ["code","message","details","request_id"]
$.error.codestringДаМашинный код; не извлекайте причину из message.
$.error.messagestringДаЧеловекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки.
$.error.detailsoneOfДаБез подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}.
$.error.details (oneOf 1)arrayДаmaxItems: 0
$.error.details (oneOf 2)objectДа
$.error.details (oneOf 2).*arrayНет
$.error.details (oneOf 2).*[]stringДа
$.error.details (oneOf 3)objectДаrequired: ["retry_after"]; Дополнительные поля запрещены
$.error.details (oneOf 3).retry_afterintegerДаminimum: 0
$.error.request_idstring / nullДаformat: "uuid"UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке.

default (404) ​

json
{
  "error": {
    "code": "resource_not_found",
    "message": "Not Found",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

HTTP 409 ​

Idempotency-Key уже обрабатывается либо использован для другого метода, URL/query или тела.

Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.

ПолеТипОбязательно в родителеОграниченияОписание
$stringДаformat: "uuid"

Content-Type: application/json

ПолеТипОбязательно в родителеОграниченияОписание
$objectДаrequired: ["error"]Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope
$.errorobjectДаrequired: ["code","message","details","request_id"]
$.error.codestringДаМашинный код; не извлекайте причину из message.
$.error.messagestringДаЧеловекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки.
$.error.detailsoneOfДаБез подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}.
$.error.details (oneOf 1)arrayДаmaxItems: 0
$.error.details (oneOf 2)objectДа
$.error.details (oneOf 2).*arrayНет
$.error.details (oneOf 2).*[]stringДа
$.error.details (oneOf 3)objectДаrequired: ["retry_after"]; Дополнительные поля запрещены
$.error.details (oneOf 3).retry_afterintegerДаminimum: 0
$.error.request_idstring / nullДаformat: "uuid"UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке.

default (409) ​

json
{
  "error": {
    "code": "conflict",
    "message": "A request with this Idempotency-Key is already processing.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

changedRequest (409) ​

json
{
  "error": {
    "code": "conflict",
    "message": "Idempotency-Key was already used with a different request.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

HTTP 422 ​

Пустое/слишком длинное сообщение, неверный boolean или у покупателя нет владельца.

Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.

ПолеТипОбязательно в родителеОграниченияОписание
$stringДаformat: "uuid"

Content-Type: application/json

ПолеТипОбязательно в родителеОграниченияОписание
$objectДаrequired: ["error"]Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope
$.errorobjectДаrequired: ["code","message","details","request_id"]
$.error.codestringДаМашинный код; не извлекайте причину из message.
$.error.messagestringДаЧеловекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки.
$.error.detailsoneOfДаБез подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}.
$.error.details (oneOf 1)arrayДаmaxItems: 0
$.error.details (oneOf 2)objectДа
$.error.details (oneOf 2).*arrayНет
$.error.details (oneOf 2).*[]stringДа
$.error.details (oneOf 3)objectДаrequired: ["retry_after"]; Дополнительные поля запрещены
$.error.details (oneOf 3).retry_afterintegerДаminimum: 0
$.error.request_idstring / nullДаformat: "uuid"UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке.

default (422) ​

json
{
  "error": {
    "code": "validation_failed",
    "message": "A valid Idempotency-Key header is required.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

fields (422) ​

json
{
  "error": {
    "code": "validation_failed",
    "message": "The name field is required.",
    "details": {
      "name": [
        "The name field is required."
      ]
    },
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

HTTP 429 ​

Превышен общий лимит текущего API-ключа по всем методам (в том числе replay). Квота отдельных EPP-команд и фоновых задач не равна этому HTTP-лимиту.

Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.

ПолеТипОбязательно в родителеОграниченияОписание
$stringДаformat: "uuid"

Заголовок Retry-After: На 429 API: целые секунды до сброса окна, не дата/Unix timestamp. При 0 добавьте jitter. Proxy может вернуть HTTP-date.

ПолеТипОбязательно в родителеОграниченияОписание
$stringДаpattern: "^[0-9]+$"
text
Retry-After: 42

Content-Type: application/json

ПолеТипОбязательно в родителеОграниченияОписание
$objectДаrequired: ["error"]Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope
$.errorobjectДаrequired: ["code","message","details","request_id"]
$.error.codestringДаМашинный код; не извлекайте причину из message.
$.error.messagestringДаЧеловекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки.
$.error.detailsoneOfДаБез подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}.
$.error.details (oneOf 1)arrayДаmaxItems: 0
$.error.details (oneOf 2)objectДа
$.error.details (oneOf 2).*arrayНет
$.error.details (oneOf 2).*[]stringДа
$.error.details (oneOf 3)objectДаrequired: ["retry_after"]; Дополнительные поля запрещены
$.error.details (oneOf 3).retry_afterintegerДаminimum: 0
$.error.request_idstring / nullДаformat: "uuid"UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке.

default (429) ​

json
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "API rate limit exceeded.",
    "details": {
      "retry_after": 42
    },
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

HTTP 500 ​

Необработанная ошибка выполнения; это не подтверждение отсутствия побочного эффекта.

Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.

ПолеТипОбязательно в родителеОграниченияОписание
$stringДаformat: "uuid"

Content-Type: application/json

ПолеТипОбязательно в родителеОграниченияОписание
$objectДаrequired: ["error"]Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope
$.errorobjectДаrequired: ["code","message","details","request_id"]
$.error.codestringДаМашинный код; не извлекайте причину из message.
$.error.messagestringДаЧеловекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки.
$.error.detailsoneOfДаБез подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}.
$.error.details (oneOf 1)arrayДаmaxItems: 0
$.error.details (oneOf 2)objectДа
$.error.details (oneOf 2).*arrayНет
$.error.details (oneOf 2).*[]stringДа
$.error.details (oneOf 3)objectДаrequired: ["retry_after"]; Дополнительные поля запрещены
$.error.details (oneOf 3).retry_afterintegerДаminimum: 0
$.error.request_idstring / nullДаformat: "uuid"UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке.

default (500) ​

json
{
  "error": {
    "code": "internal_error",
    "message": "The request could not be completed.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

Машиночитаемый контракт ​

OpenAPI JSON · OpenAPI YAML · Markdown этой операции