تماس صوتی
تماس صوتی متنی
متن فارسی را به گفتار تبدیل میکند و برای گیرنده پخش میکند. برای اطلاعرسانی به تلفن ثابت یا گیرندههایی که پیامک را نمیخوانند مناسب است.
GET
POST
https://api.payamras.ir/v1/YOUR_API_KEY/call/maketts.json
- پارامتر repeat فعلا غیرفعال است و مقدار آن نادیده گرفته میشود.
پارامترها
| نام | نوع | توضیح |
|---|---|---|
receptor
الزامی
|
String | شماره گیرنده. چند شماره را با ویرگول جدا کنید. |
message
الزامی
|
String | متنی که خوانده میشود. باید URL-encode شود. |
date
اختیاری
|
UnixTime | زمان تماس زمانبندیشده. |
localid
اختیاری
|
String | شناسه محلی برای جلوگیری از تماس تکراری. |
repeat
اختیاری
|
Integer | تعداد تکرار تماس در صورت پاسخ ندادن (۰ تا ۵، با فاصله ۳ دقیقه). فعلا غیرفعال. |
tag
اختیاری
|
String | برچسب دستهبندی گزارش. |
نمونه درخواست
curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/call/maketts.json" \
--data-urlencode "receptor=02188001234" \
--data-urlencode "message=سفارش شماره ۴۸۲۱۳ آماده تحویل است"
<?php
$apiKey = 'YOUR_API_KEY';
$params = [
'receptor' => '02188001234',
'message' => 'سفارش شماره ۴۸۲۱۳ آماده تحویل است',
];
$ch = curl_init("https://api.payamras.ir/v1/{$apiKey}/call/maketts.json?" . http_build_query($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode(curl_exec($ch), true);
if ($result['return']['status'] !== 200) {
throw new RuntimeException($result['return']['message']);
}
const apiKey = "YOUR_API_KEY";
const params = new URLSearchParams({
receptor: "02188001234",
message: "سفارش شماره ۴۸۲۱۳ آماده تحویل است",
});
const response = await fetch(`https://api.payamras.ir/v1/${apiKey}/call/maketts.json?${params}`);
const result = await response.json();
if (result.return.status !== 200) {
throw new Error(result.return.message);
}
import requests
api_key = "YOUR_API_KEY"
params = {
"receptor": "02188001234",
"message": "سفارش شماره ۴۸۲۱۳ آماده تحویل است",
}
response = requests.get(f"https://api.payamras.ir/v1/{api_key}/call/maketts.json", params=params)
result = response.json()
if result["return"]["status"] != 200:
raise RuntimeError(result["return"]["message"])
پاسخ
فیلدهای هر ردیف entries:
| فیلد | نوع | توضیح |
|---|---|---|
messageid |
Long | شناسه یکتای پیام؛ برای پیگیری وضعیت ذخیره کنید. |
message |
String | متن پیام. |
status |
Integer | وضعیت پیام (صفحه وضعیت پیامها). |
statustext |
String | شرح وضعیت. |
sender |
String | خط فرستنده. |
receptor |
String | شماره گیرنده. |
date |
UnixTime | زمان ثبت یا زمانبندی ارسال. |
cost |
Integer | هزینه پیام به ریال. |
{
"return": {
"status": 200,
"message": "تایید شد"
},
"entries": [
{
"messageid": 8792370,
"message": "سفارش شماره ۴۸۲۱۳ آماده تحویل است",
"status": 5,
"statustext": "ارسال به مخابرات",
"sender": "",
"receptor": "02188001234",
"date": 1760337000,
"cost": 2400
}
]
}
خطاهای رایج
علاوه بر خطاهای عمومی مثل 403 و
418، این متد ممکن است این کدها را در
return.status برگرداند: