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

خطوط ارسال

شماره‌ی خط را می‌توان در ارسال پیامک با lineNumber تعیین کرد. اگر ذکر نشود، سامانه خط مناسب را انتخاب می‌کند.

تطابق نوع خط و الگو

هر الگو فقط از خطی ارسال می‌شود که نوع آن با نوع پیام الگو یکی باشد. مثلاً الگویی با messageType برابر 0 فقط از خط با lineType برابر 0 ارسال می‌شود. نوع خط و نوع پیام هر دو از فهرست انواع پیام هستند. اگر lineNumber را بفرستید و نوع آن با الگو نخواند، خطای 3002 برمی‌گردد. اگر lineNumber را خالی بگذارید، سامانه فقط از میان خطوط هم‌نوع الگو انتخاب می‌کند.

ساختار خط (LineNumberDto)​

فیلدنوعتوضیح
idرشتهشناسه‌ی خط
providerNameرشتهنام ارائه‌دهنده
lineTypeعددنوع خط؛ همان code در انواع پیام. فقط الگوهایی با messageType برابر همین مقدار از این خط ارسال می‌شوند
numberرشتهشماره‌ی خط؛ مقداری که در lineNumber ارسال می‌شود
basePriceعددقیمت پایه
isActiveبولیفعال بودن خط

فهرست خطوط​

GET /sms/api/LineNumber

curl -X GET "https://api.payavasms.com/sms/api/LineNumber" \
-H "X-Api-Key: YOUR_API_KEY"
[
{
"id": "665f0c2e9b1d4a0012ab34d1",
"providerName": "PROVIDER_NAME",
"lineType": 1,
"number": "YOUR_LINE_NUMBER",
"basePrice": 1000,
"isActive": true
}
]

خط با شناسه​

GET /sms/api/LineNumber/getById/{id}

curl -X GET "https://api.payavasms.com/sms/api/LineNumber/getById/LINE_ID" \
-H "X-Api-Key: YOUR_API_KEY"
{
"id": "665f0c2e9b1d4a0012ab34d1",
"providerName": "PROVIDER_NAME",
"lineType": 1,
"number": "YOUR_LINE_NUMBER",
"basePrice": 1000,
"isActive": true
}