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

الگوها

الگو قالب آماده‌ی پیامک است. برای ارسال، کد الگو (code) و مقدار پارامترهای آن لازم است. مفهوم الگو و انواع پارامتر در الگوها و پارامترها توضیح داده شده است.

ساختار الگو (MsgFormatDto)​

فیلدنوعتوضیح
idعدد صحیحشناسه‌ی داخلی الگو
codeعدد صحیحکد الگو؛ همان مقداری که در ارسال استفاده می‌شود
messageTypeعدد صحیحنوع پیام؛ ببینید انواع پیام. الگو فقط از خطی با همین نوع ارسال می‌شود
titleرشتهعنوان الگو
defaultTextرشتهمتن الگو؛ جای پارامترها با @ مشخص شده است
groupIdرشتهشناسه‌ی گروه الگو
hasDynamicParametersبولیاگر false باشد، متن یک‌بار با پارامترهای گیرنده‌ی اول ساخته و برای همه استفاده می‌شود
isActiveبولیفقط الگوی فعال قابل ارسال است
parametersآرایهفهرست پارامترها

ساختار پارامتر​

فیلدنوعتوضیح
keyرشتهکلید پارامتر؛ در ارسال با همین کلید مقدار می‌دهید. کلیدهای با پیشوند Dy_ داینامیک‌اند و خودکار پر می‌شوند
nameرشتهنام نمایشی
optionalبولیاختیاری بودن پارامتر
optionTextرشتهمتنی که فقط در صورت وجود مقدار، به آن افزوده می‌شود
optionPlacementعدد0 پیش از مقدار، 1 پس از مقدار
maxLengthعددحداکثر طول مقدار (پیش‌فرض ۵۰)
regexPatternرشتهمجموعه‌ی نویسه‌های مجاز؛ نویسه‌های غیرمجاز حذف می‌شوند و خطا نمی‌دهند
valueرشتهمقدار ثابت (در پارامترهای ثابت مانند برند)

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

GET /sms/api/MsgFormat

curl -X GET "https://api.payavasms.com/sms/api/MsgFormat" \
-H "X-Api-Key: YOUR_API_KEY"
[
{
"id": "665f0c2e9b1d4a0012ab34d0",
"code": 123456789012,
"messageType": 0,
"title": "خوش‌آمدگویی",
"defaultText": "@ عزیز، @ برای شما فعال شد.",
"groupId": "665f0c2e9b1d4a0012ab34cf",
"hasDynamicParameters": false,
"isActive": true,
"parameters": [
{
"key": "name",
"name": "نام",
"optional": false,
"optionText": null,
"optionPlacement": 0,
"maxLength": 50,
"regexPattern": null,
"value": null
},
{
"key": "discount",
"name": "درصد تخفیف",
"optional": true,
"optionText": "تخفیف ",
"optionPlacement": 0,
"maxLength": 3,
"regexPattern": "0-9",
"value": null
}
]
}
]

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

GET /sms/api/MsgFormat/{id}

curl -X GET "https://api.payavasms.com/sms/api/MsgFormat/FORMAT_ID" \
-H "X-Api-Key: YOUR_API_KEY"
{
"id": "665f0c2e9b1d4a0012ab34d0",
"code": 123456789012,
"messageType": 0,
"title": "خوش‌آمدگویی",
"defaultText": "@ عزیز، @ برای شما فعال شد.",
"groupId": "665f0c2e9b1d4a0012ab34cf",
"hasDynamicParameters": false,
"isActive": true,
"parameters": [
{
"key": "name",
"name": "نام",
"optional": false,
"optionText": null,
"optionPlacement": 0,
"maxLength": 50,
"regexPattern": null,
"value": null
},
{
"key": "discount",
"name": "درصد تخفیف",
"optional": true,
"optionText": "تخفیف ",
"optionPlacement": 0,
"maxLength": 3,
"regexPattern": "0-9",
"value": null
}
]
}

الگو با کد​

GET /sms/api/MsgFormat/Code/{code}

curl -X GET "https://api.payavasms.com/sms/api/MsgFormat/Code/123456789012" \
-H "X-Api-Key: YOUR_API_KEY"
{
"id": "665f0c2e9b1d4a0012ab34d0",
"code": 123456789012,
"messageType": 0,
"title": "خوش‌آمدگویی",
"defaultText": "@ عزیز، @ برای شما فعال شد.",
"groupId": "665f0c2e9b1d4a0012ab34cf",
"hasDynamicParameters": false,
"isActive": true,
"parameters": [
{
"key": "name",
"name": "نام",
"optional": false,
"optionText": null,
"optionPlacement": 0,
"maxLength": 50,
"regexPattern": null,
"value": null
},
{
"key": "discount",
"name": "درصد تخفیف",
"optional": true,
"optionText": "تخفیف ",
"optionPlacement": 0,
"maxLength": 3,
"regexPattern": "0-9",
"value": null
}
]
}

الگوهای یک گروه​

GET /sms/api/MsgFormat/Group/{GroupId}

curl -X GET "https://api.payavasms.com/sms/api/MsgFormat/Group/GROUP_ID" \
-H "X-Api-Key: YOUR_API_KEY"
[
{
"id": "665f0c2e9b1d4a0012ab34d0",
"code": 123456789012,
"messageType": 0,
"title": "خوش‌آمدگویی",
"defaultText": "@ عزیز، @ برای شما فعال شد.",
"groupId": "665f0c2e9b1d4a0012ab34cf",
"hasDynamicParameters": false,
"isActive": true,
"parameters": [
{
"key": "name",
"name": "نام",
"optional": false,
"optionText": null,
"optionPlacement": 0,
"maxLength": 50,
"regexPattern": null,
"value": null
},
{
"key": "discount",
"name": "درصد تخفیف",
"optional": true,
"optionText": "تخفیف ",
"optionPlacement": 0,
"maxLength": 3,
"regexPattern": "0-9",
"value": null
}
]
}
]

پارامترهای یک الگو​

GET /sms/api/MsgFormat/Parameters?code={code}

curl -X GET "https://api.payavasms.com/sms/api/MsgFormat/Parameters?code=123456789012" \
-H "X-Api-Key: YOUR_API_KEY"
[
{
"key": "name",
"name": "نام",
"optional": false,
"optionText": null,
"optionPlacement": 0,
"maxLength": 50,
"regexPattern": null,
"value": null
},
{
"key": "discount",
"name": "درصد تخفیف",
"optional": true,
"optionText": "تخفیف ",
"optionPlacement": 0,
"maxLength": 3,
"regexPattern": "0-9",
"value": null
}
]

الگوهای کاربر​

GET /sms/api/MsgFormat/User/{skip}/{limit} الگوهای اختصاصی حساب شما را صفحه‌بندی‌شده برمی‌گرداند. skip تعداد ردیف‌های ردشده و limit تعداد ردیف‌های برگشتی است.

curl -X GET "https://api.payavasms.com/sms/api/MsgFormat/User/0/20" \
-H "X-Api-Key: YOUR_API_KEY"
[
{
"id": "665f0c2e9b1d4a0012ab34d0",
"code": 123456789012,
"messageType": 0,
"title": "خوش‌آمدگویی",
"defaultText": "@ عزیز، @ برای شما فعال شد.",
"groupId": "665f0c2e9b1d4a0012ab34cf",
"hasDynamicParameters": false,
"isActive": true,
"parameters": [
{
"key": "name",
"name": "نام",
"optional": false,
"optionText": null,
"optionPlacement": 0,
"maxLength": 50,
"regexPattern": null,
"value": null
},
{
"key": "discount",
"name": "درصد تخفیف",
"optional": true,
"optionText": "تخفیف ",
"optionPlacement": 0,
"maxLength": 3,
"regexPattern": "0-9",
"value": null
}
]
}
]

تعداد الگوهای کاربر​

GET /sms/api/MsgFormat/Count/User

curl -X GET "https://api.payavasms.com/sms/api/MsgFormat/Count/User" \
-H "X-Api-Key: YOUR_API_KEY"
5

خطاها​

مسیرهایی که الگو را با شناسه یا کد می‌گیرند، اگر الگو پیدا نشود، پاسخ «یافت نشد» برمی‌گردانند. جزئیات در کدهای وضعیت آمده است.