مستندات API تبدیل متن به گفتار

این مستندات نحوه استفاده از API تبدیل متن به گفتار را توضیح می‌دهد.

نحوه ارسال درخواست

برای ارسال یک درخواست به API، باید یک درخواست HTTP POST به URL مورد نظر ارسال کنید:

$url = 'https://api.talkbot.ir/v1/media/text-to-speech/REQ';

سربرگ‌ها

شما باید سربرگ Authorization را با توکن Bearer خود تنظیم کنید:

$headers = [
    'Authorization: Bearer YOUR_ACCESS_TOKEN'
];

داده‌های POST

داده‌های زیر را باید به عنوان بخشی از بدنه درخواست POST ارسال کنید:

// Data For Azure TTS (با امکان انتخاب نام صدا)
$data = [
    'text' => 'متن شما اینجا قرار میگیرد.',
    'server' => 'azure',
    'voice' => 'fa-IR-FaridNeural'  // نام صدای مورد نظر (مثال: صدای مرد فارسی)
];

// Data For Farsi TTS (صدای طبیعی تاک بات)
$data = [
    'text' => 'Your Persian Text',
    'server' => 'farsi',
    'sound' => '3' // شماره صدا (مثال: 3)
];

ارسال درخواست

برای ارسال درخواست، می‌توانید از cURL در PHP استفاده کنید:

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
if(curl_errno($ch)){
    echo 'error CURL: ' . curl_error($ch);
}
curl_close($ch);

مثال درخواست برای سرور Azure با PHP:

اینجا یک مثال برای درخواست PHP با انتخاب صدای خاص از سرور Azure وجود دارد. کافیست کلید API خود را جایگزین کنید.

$headers = [
    'Authorization: Bearer YOUR_API_KEY' // کلید API خود را جایگزین کنید
];
$data = [
    'text' => 'سلام ، این یک متن فارسی است که توسط تاک بات به صدا تبدیل شده است.',
    'server' => 'azure',
    'voice' => 'fa-IR-FaridNeural - fa-IR (Male)' // مثال: صدای زن انگلیسی از آمریکا
];
$url = 'https://api.talkbot.ir/v1/media/text-to-speech/REQ';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
if(curl_errno($ch)){
    echo 'error CURL: ' . curl_error($ch);
} else {
    echo $response;
}
curl_close($ch);
    

مثال درخواست برای سرور Azure با Python:

اینجا یک مثال برای درخواست پایتون با انتخاب صدای خاص از سرور Azure وجود دارد. کافیست کلید API خود را جایگزین کنید.

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY' # کلید API خود را جایگزین کنید
}

data = {
    'text': 'سلام! این یک تست از API تبدیل متن به گفتار آژور با صدای خاص است.',
    'server': 'azure',
    'voice': 'fa-IR-FaridNeural - fa-IR (Male)' # مثال: صدای مرد فارسی از ایران
}

url = 'https://api.talkbot.ir/v1/media/text-to-speech/REQ'

response = requests.post(url, headers=headers, data=data)

if response.status_code == 200:
    print(response.text)
else:
    print(f'Error: {response.status_code} - {response.text}')
    

مثال درخواست برای سرور صدای طبیعی تاک بات: پی اچ پی

اینجا یک مثال برای درخواست PHP برای سرور صدای طبیعی تاک بات وجود دارد. کافیست کلید API خود را جایگزین کنید.

$headers = [
    'Authorization: Bearer YOUR_API_KEY' // کلید API خود را جایگزین کنید
];
$data = [
    'text' => 'سلام امیدوارم حالت خوب باشه.',
    'server' => 'farsi',
    'sound' => '3' // شماره صدا را برای صداهای طبیعی تاک بات مشخص کنید
];
$url = 'https://api.talkbot.ir/v1/media/text-to-speech/REQ';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
if(curl_errno($ch)){
    echo 'error CURL: ' . curl_error($ch);
} else {
    echo $response;
}
curl_close($ch);
    

مثال درخواست برای سرور صدای طبیعی تاک بات: پایتون

اینجا یک مثال برای درخواست پایتون برای سرور صدای طبیعی تاک بات وجود دارد. کافیست کلید API خود را جایگزین کنید.

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY' # کلید API خود را جایگزین کنید
}

data = {
    'text': 'سلام امیدوارم حالت خوب باشه.',
    'server': 'farsi',
    'sound' => '3' # شماره صدا را برای صداهای طبیعی تاک بات مشخص کنید
}

url = 'https://api.talkbot.ir/v1/media/text-to-speech/REQ'

response = requests.post(url, headers=headers, data=data)

if response.status_code == 200:
    print(response.text)
else:
    print(f'Error: {response.status_code} - {response.text}')
    

لیست صداهای موجود در سرور Azure

برای انتخاب صدای دلخواه خود در سرور Azure، می‌توانید از نام کامل صدا (که شامل کد زبان و منطقه نیز می‌شود) به همراه جنسیت آن استفاده کنید. در جدول زیر لیستی از صداهای موجود به همراه زبان و جنسیت آن‌ها آورده شده است:

پاسخ API

پاسخ API به صورت یک رشته JSON خواهد بود که شامل اطلاعاتی درباره فایل صوتی تولید شده و وضعیت درخواست است.

نمونه خروجی:

 {"response":{"code":200,"message":"Success","id":"TTSTALKBOT_51580953352.mp3","download":"https:\/\/talkbot.ir\/tts_temp\/51580953352.mp3"}}

آزمایش رایگان:

برای آزمایش و تست رایگان این وب سرویس (API) ابتدا در سایت ثبتنام کنید، و سپس از طریق کنترل پنل کاربری، کلید اختصاصی خود را ایجاد کنید. پس از ایجاد کلید، آن را در نمونه کدهای بالا جایگزاری کرده و خروجی را مشاهده کنید. امکان استفاده از کلید آزمایشی فقط تا 15000 توکن میسر است.

سایر وب سرویس ها:

با خرید بسته یاقوتی و یا یکی از بسته های فرایاقوتی، شما علاوه بر وب سرویس یا API پیش رو، از وب سرویس های زیر نیز میتوانید استفاده کنید.