فهرست Endpointهای عمومی
این صفحه نمای سریع قرارداد عمومی v1 است. همه مسیرهای زیر متعلق به https://service.smsdaily.ir هستند و با X-API-Key مشتری فراخوانی می‌شوند. جزئیات Provider، شناسه‌های داخلی و API مدیریتی در قرارداد عمومی نمایش داده نمی‌شوند.
ارسال و مدیریت پیام
| متد | مسیر | کاربرد |
|---|---|---|
POST |
/v1/messages |
ارسال یک پیامک |
GET |
/v1/messages |
فهرست صفحه‌بندی‌شده پیام‌های حساب |
GET |
/v1/messages/{trackingCode} |
جزئیات و تاریخچه وضعیت یک پیام |
POST |
/v1/messages/batch |
ارسال همزمان چند پیام متفاوت |
POST |
/v1/messages/scheduled |
ثبت پیام برای ارسال در آینده |
POST |
/v1/messages/status |
دریافت وضعیت چند کد پیگیری در یک درخواست |
POST |
/v1/messages/{trackingCode}/cancel |
لغو پیام صف‌شده پیش از ارسال |
در تمام Endpointهای ایجاد پیام، Idempotency-Key را برای همان عملیات ثابت نگه دارید تا Retry شبکه باعث ارسال تکراری نشود.
الگو و OTP
| متد | مسیر | کاربرد |
|---|---|---|
GET |
/v1/patterns |
فهرست الگوهای فعال حساب |
POST |
/v1/messages/pattern |
ارسال با الگوی تاییدشده |
POST |
/v1/otp/challenges |
ایجاد OTP با اعتبارسنجی سمت SMSDaily |
POST |
/v1/otp/challenges/{trackingCode}/verify |
بررسی کد واردشده توسط مخاطب |
POST |
/v1/otp/codes |
ایجاد OTP با اعتبارسنجی در Backend مشتری |
در مدل Server-Verified، کد OTP در پاسخ ایجاد Challenge برگردانده نمی‌شود. در مدل Client-Managed، کد تولیدشده به Backend مشتری برگردانده می‌شود و مسئولیت نگهداری و اعتبارسنجی آن با مشتری است.
گروه‌های خدماتی تاییدشده
| متد | مسیر | کاربرد |
|---|---|---|
GET |
/v1/approved-groups |
مشاهده گروه‌های تاییدشده حساب |
POST |
/v1/approved-groups/{groupCode}/messages |
ارسال متن آزاد خدماتی به اعضای گروه تاییدشده |
عضویت مخاطبان در این گروه‌ها از طریق API عمومی قابل تغییر نیست. ثبت و تایید اعضا پس از فرآیند اداری، نامه و تعهدنامه انجام می‌شود.
حساب و پیام‌های ورودی
| متد | مسیر | کاربرد |
|---|---|---|
GET |
/v1/senders |
فرستنده‌های فعال و مجاز حساب |
GET |
/v1/inbound-messages |
فهرست صفحه‌بندی‌شده پیامک‌های ورودی |
Webhook و Callback
| متد | مسیر | کاربرد |
|---|---|---|
GET |
/v1/webhooks/ |
فهرست Webhookهای حساب |
POST |
/v1/webhooks/ |
ایجاد Subscription و دریافت Signing Secret |
PATCH |
/v1/webhooks/{id} |
ویرایش URL، رویدادها یا وضعیت فعال بودن |
DELETE |
/v1/webhooks/{id} |
حذف Webhook |
POST |
/v1/webhooks/{id}/test |
ارسال رویداد آزمایشی در صف Callback |
رویدادهای قابل عضویت در نسخه فعلی message.status و inbound.received هستند. جزئیات امضای HMAC، Retry و Idempotency را در Webhook و Callback ببینید.
پارامترهای مشترک
X-API-Key: کلید دسترسی حساب؛ در Backend یا Secret Store نگهداری شود.Idempotency-Key: برای عملیات ایجاد/ارسال پیام الزامی است و حداکثر ۱۰۰ نویسه دارد.X-Correlation-Id: اختیاری در درخواست؛ اگر ارسال نشود سرویس مقدار مناسب تولید می‌کند و در پاسخ بازمی‌گرداند.page: شماره صفحه؛ مقدار پیش‌فرض1.pageSize: تعداد رکورد هر صفحه؛ مقدار پیش‌فرض25و حداکثر100.
برای Schema دقیق درخواست و پاسخ هر Endpoint از مرجع API استفاده کنید. برای شروع عملی نیز نمونه کد چندزبانه یا SDK رسمی .NET را ببینید.