ارسال پیامک
ارسال گروهی متفاوت
در یک درخواست، به هر گیرنده متن و خط فرستنده مخصوص خودش را میفرستد. سه آرایه receptor، sender و message همطول هستند و عضو nام هر کدام یک پیام را میسازد.
POST
https://api.payamras.ir/v1/YOUR_API_KEY/sms/sendarray.json
- فقط با متد POST کار میکند؛ درخواست GET خطای 405 میگیرد.
- آرایهها را بهصورت رشته JSON بفرستید، مثلا ["09121234567","09351234567"].
- حداکثر ۲۰۰ پیام در هر درخواست.
پارامترها
| نام | نوع | توضیح |
|---|---|---|
receptor
الزامی
|
Array<String> | آرایه شماره گیرندهها. |
sender
الزامی
|
Array<String> | آرایه خط فرستنده هر پیام. |
message
الزامی
|
Array<String> | آرایه متن هر پیام. |
date
اختیاری
|
UnixTime | زمان ارسال زمانبندیشده برای همه پیامها. |
type
اختیاری
|
Array<Integer> | نوع نمایش هر پیام. فقط برای خطوط ۳۰۰۰. |
localmessageids
اختیاری
|
Array<Long> | شناسه محلی هر پیام برای جلوگیری از ارسال تکراری. |
hide
اختیاری
|
Byte | مقدار 1 شماره گیرندهها را در گزارشها پنهان میکند. |
tag
اختیاری
|
String | برچسب دستهبندی گزارش. |
policy
اختیاری
|
String | نام سیاست ارسال. |
mediaid
اختیاری
|
Guid | شناسه فایل چندرسانهای. فقط برای خطوط پیامرسان داخلی. |
نمونه درخواست
curl -X POST "https://api.payamras.ir/v1/YOUR_API_KEY/sms/sendarray.json" \
--data-urlencode "receptor=[\"09121234567\",\"09351234567\"]" \
--data-urlencode "sender=[\"10004346\",\"10004346\"]" \
--data-urlencode "message=[\"سلام علی، سفارش شما ارسال شد\",\"سلام مریم، سفارش شما ارسال شد\"]"
<?php
$apiKey = 'YOUR_API_KEY';
$params = [
'receptor' => '["09121234567","09351234567"]',
'sender' => '["10004346","10004346"]',
'message' => '["سلام علی، سفارش شما ارسال شد","سلام مریم، سفارش شما ارسال شد"]',
];
$ch = curl_init("https://api.payamras.ir/v1/{$apiKey}/sms/sendarray.json");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, 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: "[\"09121234567\",\"09351234567\"]",
sender: "[\"10004346\",\"10004346\"]",
message: "[\"سلام علی، سفارش شما ارسال شد\",\"سلام مریم، سفارش شما ارسال شد\"]",
});
const response = await fetch(`https://api.payamras.ir/v1/${apiKey}/sms/sendarray.json`, {
method: "POST",
body: 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": "[\"09121234567\",\"09351234567\"]",
"sender": "[\"10004346\",\"10004346\"]",
"message": "[\"سلام علی، سفارش شما ارسال شد\",\"سلام مریم، سفارش شما ارسال شد\"]",
}
response = requests.post(f"https://api.payamras.ir/v1/{api_key}/sms/sendarray.json", data=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": 8792350,
"message": "سلام علی، سفارش شما ارسال شد",
"status": 1,
"statustext": "در صف ارسال",
"sender": "10004346",
"receptor": "09121234567",
"date": 1760337000,
"cost": 1200
},
{
"messageid": 8792351,
"message": "سلام مریم، سفارش شما ارسال شد",
"status": 1,
"statustext": "در صف ارسال",
"sender": "10004346",
"receptor": "09351234567",
"date": 1760337000,
"cost": 1200
}
]
}
خطاهای رایج
علاوه بر خطاهای عمومی مثل 403 و
418، این متد ممکن است این کدها را در
return.status برگرداند: