ارسال پیام برای تعداد زیادی کاربر به صورت پارامتریک (Dynamic Parameters).
حداکثر تعداد کاربران برای هر بار ارسال: ۵۰۰ نفر
Endpoint
POST
/api/message/batch/parametric
Request Body
| فیلد | نوع | اجباری | توضیح |
|---|---|---|---|
title |
string |
بله | عنوان پیام |
groupId |
string |
بله | شناسه گروه |
sendBy |
'phone' | 'nationalCode' |
بله | ارسال با شماره تلفن یا کد ملی |
content |
string |
بله | محتوا که میتواند شامل پارامتر باشد، مثلاً: مبلغ قبض گاز شما [p1] میباشد. این پارامترها در آرایه users مقداردهی میشوند. |
media |
string[] |
خیر | آدرس عکس و فایلهای آپلود شده |
users |
Array |
بله | آرایهای از { phone | nationalCode, params: { [key]: string } } |
مثال Request
{
"title": "قبض گاز دوره",
"groupId": "01KFNWPJ3QR4QF5SXJCTEJ85CF",
"sendBy": "phone",
"content": "مبلغ گاز شما [p1]",
"users": [
{
"phone": "09362532122",
"params": {
"p1": "دویست هزار تومان"
}
}
]
}
پاسخ
{
"data": {
"results": [
{
"value": "09922908783",
"status": true
}
]
},
"success": true
}
محدودیتها و نکات مهم
- حداکثر کاربران در هر درخواست: ۵۰۰ نفر
- حداکثر مدیا در هر پیام: ۱۰ فایل
- محتوای پیام باید Markdown باشد (HTML مجاز نیست)
- ایجاد Post Group الزامی قبل از هر ارسال پیام
- پارامترها باید به صورت string ارسال شوند
- Keyهای پارامترها دلخواه است و دقیقاً همان Keyها باید در
usersاستفاده شود