شروع کار

مستندات API پیام‌رس

وب‌سرویس پیام‌رس یک API ساده HTTP است: یک درخواست با کلید API خودتان می‌فرستید و پاسخ JSON می‌گیرید. کتابخانه اجباری، توکن موقت یا مرحله احراز هویت جداگانه ندارد. ۳۲ متد برای ارسال پیامک، کد تایید، تماس صوتی، گزارش‌گیری و مدیریت حساب در اختیار شماست.

پیش از شروع

  1. حساب پیام‌رس. اگر هنوز حساب ندارید، از فرم تماس درخواست راه‌اندازی بدهید.
  2. کلید API. پس از ورود به پنل مشتریان، بخش کلید API، کلید اختصاصی حسابتان را کپی کنید.
  3. اعتبار و خط ارسال. هر پیام از اعتبار حساب کم می‌شود. اعتبار و خطوط فعال حساب در داشبورد پنل مشتریان دیده می‌شود.

آدرس پایه

همه درخواست‌ها به این آدرس فرستاده می‌شوند و کلید API بخشی از خود آدرس است:

https://api.payamras.ir/v1/YOUR_API_KEY/{scope}/{method}.json

scope دسته متد است (مثلا sms، verify یا account) و method نام خود متد. مثلا ارسال پیامک می‌شود sms/send.json.

ارسال اولین پیامک

کلید خود را جای YOUR_API_KEY بگذارید و شماره خودتان را به‌عنوان گیرنده بنویسید. اگر return.status در پاسخ ۲۰۰ بود، پیام در صف ارسال است.

curl -X POST "https://api.payamras.ir/v1/YOUR_API_KEY/sms/send.json" \
  --data-urlencode "receptor=09121234567,09351234567" \
  --data-urlencode "message=سفارش شما ثبت شد. کد پیگیری: 48213" \
  --data-urlencode "sender=10004346"

پاسخ موفق برای هر گیرنده یک messageid دارد. آن را ذخیره کنید تا بعدا با sms/status بفهمید پیام رسیده است یا نه. جزئیات همه پارامترها در صفحه ارسال پیامک است.

همه متدها

ارسال پیامک

پیامک تایید (OTP)

تماس صوتی

وضعیت و گزارش ارسال

صندوق دریافت

لیست سیاه خط

قالب‌های تایید

فایل‌های چندرسانه‌ای

حساب کاربری