مستندات API

از این API می‌توانید در پروژه‌های خود برای برقراری تماس‌های خودکار و تولید صدا از متن استفاده نمایید.

برای استفاده از API نیاز به یک کلید API دارید. این کلید را می‌توانید از طریق پنل کاربری دریافت نمایید.

کلید API باید در تمام درخواست‌ها به صورت پارامتر api_key ارسال شود.

برای جلوگیری از بار اضافی روی سرور، هر کلید API مجاز به ارسال حداکثر 60 درخواست در دقیقه است. در صورت عبور از این حد، درخواست‌ها با خطای 429 Too Many Requests پاسخ داده خواهند شد.

1. تماس صوتی

این سرویس برای تبدیل متن به صدا استفاده می‌شود. کافیست متن و کلید API معتبر ارسال کنید تا فایل صوتی تولید شود.

🔗 آدرس درخواست

📤 نمونه درخواست

curl -X POST https://khodgoo.com/api/tts \
  -d "apikey=YOUR_API_KEY" \
  -d "text=سلام دنیا"

📥 پاسخ موفق

{
  "success": true,
  "url": "https://khodgoo.com/tts/1234567890.wav",
  "track_id": 1234567890
}

در پاسخ به درخواست‌های ناموفق، سرور کد وضعیت مناسب همراه با پیام خطا در قالب JSON برمی‌گرداند:

{
  "success": true,
  "message": "تماس با موفقیت انجام شد",
  "call_id": "12345"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "کلید API نامعتبر است"
}

{
  "success": false,
  "error": "Too many requests",
  "message": "حد مجاز درخواست تجاوز شده",
  "retry_after": 60
}

{
  "success": false,
  "error": "Bad request",
  "message": "پارامتر message الزامی است",
  "missing_fields": ["message"]
}

{
  "success": false,
  "error": "Internal server error",
  "message": "خطای داخلی سرور رخ داده است"
}