ارسال گیفت به یوزرنیم
POST
/api/v1/gifts/sendscope: orders:writeاحراز هویت: Bearerlive و test
یک گیفت استارزی را مستقیم به یوزرنیم تلگرام بفرست، با پیام اختیاری روی گیفت. تفاوتش با POST /orders: فقط گیفت میپذیرد، گیرنده اجباری است و پیام گیفت فیلد مستقیم دارد. سفارش ساختهشده همان سفارش استاندارد است.
درخواست
| نام | محل | نوع | توضیح | |
|---|---|---|---|---|
Authorization | header | string | الزامی | Bearer sk_live_… یا Bearer sk_test_… |
Idempotency-Key | header | string | اختیاری | کلید یکتا |
بدنه (JSON)
| فیلد | نوع | توضیح | |
|---|---|---|---|
product_id | integer | الزامی | از GET /gifts |
recipient | string | الزامی | @username گیرنده |
message | string | اختیاری | پیام روی گیفت، حداکثر ۲۰۰ کاراکتر |
message_entities | array | اختیاری | entities تلگرام برای پیام (bold، custom_emoji و…) |
hide_sender | boolean | اختیاری | فرستندهی مخفی (+۲٬۰۰۰ تومان) |
scheduled_at | string | اختیاری | زمان ارسال برنامهریزیشده (ISO 8601) |
pay_currency | string | اختیاری | TON یا IRT |
quote_id | string | اختیاری | از POST /orders/quote با type=product |
metadata | object | اختیاری | دادهی دلخواه |
نمونه
curl -X POST "https://stard-market.ir/api/v1/gifts/send" \
-H "Authorization: Bearer $STARD_API_KEY" \
-H "Content-Type: application/json" \
-d '{"product_id": 12, "recipient": "@username", "message": "تولدت مبارک 🎉"}'const res = await fetch("https://stard-market.ir/api/v1/gifts/send", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.STARD_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"product_id": 12,
"recipient": "@username",
"message": "تولدت مبارک 🎉"
}),
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
console.log(data);type StardError = { error: { type: string; code: string; message: string; param: string | null; request_id: string } };
const res = await fetch("https://stard-market.ir/api/v1/gifts/send", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.STARD_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"product_id": 12,
"recipient": "@username",
"message": "تولدت مبارک 🎉"
}),
});
if (!res.ok) {
const { error } = (await res.json()) as StardError;
throw new Error(`${error.code}: ${error.message} (${error.request_id})`);
}
const data: Record<string, unknown> = await res.json();import os
import requests
r = requests.post(
"https://stard-market.ir/api/v1/gifts/send",
headers={
"Authorization": f"Bearer {os.environ['STARD_API_KEY']}",
},
json={
"product_id": 12,
"recipient": "@username",
"message": "تولدت مبارک 🎉"
},
timeout=20,
)
data = r.json()
if r.status_code >= 400:
raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
print(data)<?php
$ch = curl_init("https://stard-market.ir/api/v1/gifts/send");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("STARD_API_KEY"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"product_id" => 12,
"recipient" => "@username",
"message" => "تولدت مبارک 🎉"
]),
CURLOPT_TIMEOUT => 20,
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($status >= 400) {
throw new RuntimeException($data["error"]["code"] . ": " . $data["error"]["message"]);
}
print_r($data);package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{"product_id": 12, "recipient": "@username", "message": "تولدت مبارک 🎉"}`)
req, _ := http.NewRequest("POST", "https://stard-market.ir/api/v1/gifts/send", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("STARD_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
b, _ := io.ReadAll(res.Body)
fmt.Println(res.StatusCode, string(b))
}پاسخ — 201
{
"object": "order",
"id": "ord_test_znAt8QplAwwQImWM",
"order_id": null,
"environment": "test",
"status": "pending",
"raw_status": "pending",
"title": "کادو (test)",
"product_id": 12577,
"product_tag": null,
"type": "gift",
"quantity": 1,
"recipient": "@username",
"amount": {
"amount": 112275,
"currency": "IRT"
},
"paid": {
"amount": 112275,
"currency": "IRT"
},
"failure_reason": null,
"metadata": {},
"created_at": "2026-10-02T17:43:23Z",
"updated_at": "2026-10-02T17:43:23Z"
}هدرهای پاسخ
content-type: application/json
x-request-id: req_XhAAu3bzRaDHeDIToYdd
x-ratelimit-limit: 1000
x-ratelimit-remaining: 989خطاها
| HTTP | code | کی |
|---|---|---|
400 | not_a_gift | این product_id گیفت استارزی نیست |
400 | recipient_invalid | یوزرنیم گیرنده نامعتبر |
402 | insufficient_funds | موجودی کیف پول API (یا موجودی آزمایشی) کافی نیست |
400 | quote_invalid / quote_mismatch | quote_id نامعتبر یا مال سفارش دیگری است |
409 | quote_expired | مهلت پیشقیمت (۲ دقیقه) تمام شده |
409 | price_changed | قیمت از مبلغ پیشقیمت بالاتر رفته؛ پولی کسر نشده |
403 | insufficient_scope | کلید scope orders:write را ندارد |
401 | invalid_api_key / missing_api_key / api_key_revoked / api_key_expired | کلید نیامده، نامعتبر، باطل یا منقضی است |
429 | rate_limit_exceeded | سقف درخواست در دقیقه پر شده؛ بعد از Retry-After ثانیه دوباره بفرست |
محدودیت نرخ
پیشفرض ۶۰ درخواست در دقیقه برای هر کلید (قابل تنظیم در داشبورد). وضعیت در هدرهای X-RateLimit-* برمیگردد — جزئیات.
