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

انواع پیام

هر الگو دارای یک نوع پیام است (فیلد messageType). این endpointها فهرست انواع را برمی‌گردانند.

هر الگو و هر خط یک نوع دارد و این دو باید یکی باشند: الگو با messageType برابر 0 فقط از خطی با lineType برابر 0 ارسال می‌شود. جزئیات در خطوط ارسال.

ساختار (SmsDefinitionDto)​

فیلدنوعتوضیح
codeعدد صحیحکد نوع
nameرشتهنام نوع
descriptionرشتهتوضیح

فهرست انواع​

GET /sms/api/SmsDefinition/Types

curl -X GET "https://api.payavasms.com/sms/api/SmsDefinition/Types" \
-H "X-Api-Key: YOUR_API_KEY"
[
{
"code": 0,
"name": "اطلاع‌رسانی",
"description": null
}
]

نوع با کد​

GET /sms/api/SmsDefinition/Types/{code}

curl -X GET "https://api.payavasms.com/sms/api/SmsDefinition/Types/0" \
-H "X-Api-Key: YOUR_API_KEY"
{
"code": 0,
"name": "اطلاع‌رسانی",
"description": null
}