احراز هویت: این سرویس کلید API را از مسیر URL میخواند (
/v1/{apiKey}/...) و هدر احراز هویتی ندارد. درخواست فقط از آیپیهای وایتلیستشده پذیرفته میشود. به احراز هویت و وایتلیست IP نگاه کنید.
این مسیر در سرویس فعلی پیادهسازی نشده است. هندلر آن (Controller.SendArrayMessage در api/controller/sms.go:16) هیچ پارامتری را نمیخواند، هیچ اعتبارسنجیای انجام نمیدهد و هیچ پیامکی ارسال نمیکند؛ صرفاً HTTP 200 با بدنهٔ null برمیگرداند.
میانافزارهای گروه /v1/ (احراز هویت با کلید API در مسیر و بررسی IP مجاز) پیش از هندلر اجرا میشوند، بنابراین خطاهای احراز هویت و IP همچنان میتوانند رخ دهند و در این حالت پاسخ، پوشش استاندارد خطا است. برای ارسال پیامک از /v1/{apiKey}/sms/send.json استفاده کنید.
این مسیر با متد
GETهم ثبت شده و رفتار یکسانی دارد؛ در مستندات فقط شکلPOSTنشان داده شده است.
پارامترهای مسیر
۱| نام | نوع | الزامی | توضیح |
|---|---|---|---|
apiKey* | string | الزامی | کلید API حساب کاربری که بهصورت بخشی از مسیر ارسال میشود (نه هدر). نمونه a1b2c3d4e5f60718293a4b5c6d7e8f90 |
پاسخها
ساختار پاسخ
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
return | ApiStatus | اختیاری | وضعیت پاسخ. مقدار |
status* | integer | الزامی | کد وضعیت — همان کد وضعیت HTTP پاسخ. نمونه 200 |
message* | string | الزامی | پیام فارسی قابل نمایش به کاربر. نمونه درخواست تایید شد. |
entries | object | اختیاری | ساختار پاسخ در کد سرویس تعریف نشده است. |
نمونهٔ پاسخ
{ "return": { "status": 200, "message": "درخواست تایید شد." }, "entries": {}}