مقدمه و احراز هویت (Authentication)

وب‌سرویس تکست‌آن بر پایه معماری RESTful بنا شده است. تمامی درخواست‌ها و پاسخ‌ها با فرمت JSON ارسال و دریافت می‌شوند.


برای احراز هویت، شما به یک API Key نیاز دارید. این کلید را از داشبورد کاربری خود (بخش تنظیمات > وب‌سرویس) دریافت کرده و در هدر تمامی درخواست‌ها با فرمت Authorization: Bearer YOUR_API_KEY ارسال کنید.

ارسال پیامک ساده

از این متد برای ارسال پیامک‌های متنی دلخواه به یک یا چند شماره استفاده کنید.

POST https://api.texton.ir/v1/sms/send
پارامترنوعتوضیحات
sender * String شماره خط اختصاصی شما (مثال: 30002040)
receptor * Array آرایه‌ای از شماره‌های گیرندگان (مثال: ["09121111111"])
message * String متن پیامک شما 
curl -X POST "https://api.texton.ir/v1/sms/send" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "sender": "30002040",
  "receptor": ["09121111111"],
  "message": "وضعیت کسب‌وکارت: روشن"
}'
<?php
$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.texton.ir/v1/sms/send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    "sender" => "30002040",
    "receptor" => ["09121111111"],
    "message" => "وضعیت کسب‌وکارت: روشن"
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer YOUR_API_KEY",
    "Content-Type: application/json"
  ],
]);
$response = curl_exec($curl);
echo $response;
import requests
import json

url = "https://api.texton.ir/v1/sms/send"
payload = json.dumps({
  "sender": "30002040",
  "receptor": ["09121111111"],
  "message": "وضعیت کسب‌وکارت: روشن"
})
headers = {
  'Authorization': 'Bearer YOUR_API_KEY',
  'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)

ارسال سریع با پترن (OTP)

این متد برای ارسال کدهای اعتبارسنجی ورود (OTP) با سرعت زیر ۳ ثانیه و عبور قطعی از بلک‌لیست مخابراتی استفاده می‌شود. (نیازمند ثبت الگو در پنل)

POST https://api.texton.ir/v1/sms/otp
پارامترنوعتوضیحات
receptor * String شماره گیرنده (فقط یک شماره مجاز است)
pattern_code * String کد الگوی تایید شده در داشبورد شما
variables * Object متغیرهای داخل الگو (Key-Value) 
<?php
// Example: Hello %name%, your code is %code%
$payload = [
    "receptor" => "09121111111",
    "pattern_code" => "otp-1234",
    "variables" => [
        "name" => "علی",
        "code" => "5896"
    ]
];
// Execute cURL POST to /sms/otp ...

استعلام وضعیت تحویل (Delivery)

با استفاده از Message ID دریافت شده در زمان ارسال، وضعیت رسیدن پیامک به گوشی مخاطب را بررسی کنید.

GET https://api.texton.ir/v1/sms/status/{message_id} 
{
  "success": true,
  "data": {
    "message_id": 100548962,
    "status": "Delivered",
    "cost": 65
  }
}