مقدمه

این پروژه مرجع نسخه فعلی وب‌سرویس REST سامانه پیامک است. آدرس پایه درخواست‌ها:

https://rest.payamak-panel.com

احراز هویت

در بیشتر متدها username و password داخل بدنه JSON ارسال می‌شوند. مقدار password همان کلید API تنظیم‌شده برای وب‌سرویس است و نباید در کد عمومی، لاگ یا مخزن کد قرار بگیرد. متدهایی که فقط recID دریافت می‌کنند استثنا هستند.

ساخت درخواست

• درخواست را با HTTPS، متد POST و هدر Content-Type: application/json; charset=utf-8 ارسال کنید.
• نام پارامترها به حروف کوچک و بزرگ حساس است؛ همان نام درج‌شده در جدول هر متد را استفاده کنید.
• برای آرایه‌های متن و گیرنده، تعداد آیتم‌ها و ترتیب آن‌ها باید یکسان باشد.
• در متدهای گروهی، حداکثر تعداد مجاز هر درخواست را رعایت کنید.

پردازش پاسخ

بیشتر متدها سه فیلد Value، و برمی‌گردانند. موفقیت معمولاً با مشخص می‌شود، اما برای تصمیم نهایی باید مقدار و کدهای کاربردی همان متد نیز بررسی شوند. برخی خطاهای کاربردی ممکن است همراه پاسخ HTTP موفق دریافت شوند.