پرش به مطلب اصلی

گروه‌های الگو

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

ساختار گروه (MsgFormatGroupDto)​

فیلدنوعتوضیح
idعدد صحیحشناسه‌ی گروه
nameرشتهنام گروه
descriptionرشتهتوضیح گروه
modifiedAtتاریخزمان آخرین ویرایش

فهرست گروه‌ها​

GET /sms/api/FormatGroup

curl -X GET "https://api.payavasms.com/sms/api/FormatGroup" \
-H "X-Api-Key: YOUR_API_KEY"
[
{
"id": "665f0c2e9b1d4a0012ab34cf",
"name": "احراز هویت",
"description": "الگوهای کد تأیید",
"modifiedAt": "2026-10-01T08:30:00Z"
}
]

فهرست صفحه‌بندی‌شده​

GET /sms/api/FormatGroup/Page?skip={skip}&limit={limit}

پارامترنوعتوضیح
skipعدد صحیحتعداد ردیف‌های ردشده
limitعدد صحیحتعداد ردیف‌های برگشتی
curl -X GET "https://api.payavasms.com/sms/api/FormatGroup/Page?skip=0&limit=20" \
-H "X-Api-Key: YOUR_API_KEY"
[
{
"id": "665f0c2e9b1d4a0012ab34cf",
"name": "احراز هویت",
"description": "الگوهای کد تأیید",
"modifiedAt": "2026-10-01T08:30:00Z"
}
]

تعداد گروه‌ها​

GET /sms/api/FormatGroup/Count

curl -X GET "https://api.payavasms.com/sms/api/FormatGroup/Count" \
-H "X-Api-Key: YOUR_API_KEY"
12

گروه با شناسه​

GET /sms/api/FormatGroup/{id}

curl -X GET "https://api.payavasms.com/sms/api/FormatGroup/GROUP_ID" \
-H "X-Api-Key: YOUR_API_KEY"
{
"id": "665f0c2e9b1d4a0012ab34cf",
"name": "احراز هویت",
"description": "الگوهای کد تأیید",
"modifiedAt": "2026-10-01T08:30:00Z"
}