مستندات پیامک ایران

ارسال پیامک/OTP با Providerهای Kavenegar، ملی‌پیامک یا Generic HTTP.

معرفی

ارسال پیامک/OTP با Providerهای Kavenegar، ملی‌پیامک یا Generic HTTP.

احراز هویت

صدور API Key از پنل کاربری در نسخه‌های بعدی فعال می‌شود. تست عمومی از صفحه جزئیات بدون کلید و با محدودیت نرخ انجام می‌شود.

Endpoint تست

POST /Mcp/ExecuteTool
Content-Type: application/json

{ "slug": "sms-iran", "tool": "TOOL_NAME", "arguments": { } }

Tools

normalize_mobile

09xxxxxxxxx

Parameters (Input Schema)

{"type":"object","properties":{"mobile":{"type":"string","description":"شماره"}},"required":["mobile"]}

Response (Output Schema)

{"type":"object"}

send_sms

mobile+message+apiKey/provider

Parameters (Input Schema)

{"type":"object","properties":{"mobile":{"type":"string","description":"09"},"message":{"type":"string","description":"متن"},"provider":{"type":"string","description":"Kavenegar|Melipayamak|Generic"},"apiKey":{"type":"string","description":"کلید"},"sender":{"type":"string","description":"خط"},"providerUrl":{"type":"string","description":"URL جنریک"}},"required":["mobile","message"]}

Response (Output Schema)

{"type":"object"}

send_otp

تولید/ارسال کد

Parameters (Input Schema)

{"type":"object","properties":{"mobile":{"type":"string","description":"09"},"code":{"type":"string","description":"اختیاری"},"message":{"type":"string","description":"قالب با {code}"},"returnCode":{"type":"string","description":"true فقط تست"}},"required":["mobile"]}

Response (Output Schema)

{"type":"object"}

get_balance

Kavenegar account/info

Parameters (Input Schema)

{"type":"object","properties":{"apiKey":{"type":"string","description":"کلید"},"provider":{"type":"string","description":"Kavenegar"}},"required":[]}

Response (Output Schema)

{"type":"object"}

Error Codes

INVALID_ARGUMENT
NOT_FOUND
FORBIDDEN
SERVICE_UNAVAILABLE
TIMEOUT
INTERNAL_ERROR

Pricing / Rate Limits

نیاز به Credential — محدودیت دقیق از تنظیمات پلتفرم اعمال می‌شود.