مقدمه

این مستندات راهنمای کامل متدهای GET وب‌سرویس پیامک سامانه پیامک (نسخه ۴) است. تمام درخواست‌ها از طریق GET انجام می‌شوند و پاسخ‌ها به صورت JSON بازگردانده می‌شوند.

آدرس پایه
https://api-payamak.com/api/v4/{API-KEY}/

برای راحتی کار، تمام نمونه‌ها از پارامترهای کوئری استفاده می‌کنند. حتماً {API-KEY} را با کلید خود جایگزین کنید.

احراز هویت

برای احراز هویت، API-KEY خود را به یکی از روش‌های زیر ارسال کنید:

پارامتر کوئری:
?apikey=YOUR_API_KEY
?api_key=YOUR_API_KEY
یا
در مسیر: https://api-payamak.com/api/v4/{API-KEY}/...
در این مستندات از روش پارامتر کوئری (?api_key=...) یا (?apikey=...) استفاده شده است.

سرویس پیامک

ارسال پیامک GET

GET https://api-payamak.com/api/v4/{API-KEY}/sms/send.json?from=21xxxxxxxx&recipients=09123456789&message=سلام&type=0

ارسال پیامک به یک یا چند گیرنده (حداکثر ۲۰۰ گیرنده در هر فراخوانی).

پارامترنوعاجباریتوضیح
fromStringاجباریشماره فرستنده
recipientsStringاجباریشماره گیرنده (چندتا با کاما جدا کنید)
messageStringاجباریمتن پیام (حداکثر ۹۰۰ کاراکتر)
typeIntegerاختیارینوع پیام (۰=معمولی، ۱=فلش) – پیش‌فرض ۰
📤 مثال پاسخ
{
    "return": { 
        "status": 200,
        "message": "پیام با موفقیت در صف ارسال قرار گرفت"
    },
    "data": {
        "messageid": 8792343,
        "message": "سلام",
        "state": 1,
        "from": "+9821xxxxxxxx",
        "to": "+989123456789",
        "date": 1786619709
    }
}
در صورت ارسال پیام به بیش از ۲۰۰ گیرنده، خطای 414 بازگردانده می‌شود.

ارسال گروهی (چند پیام) GET

GET https://api-payamak.com/api/v4/{API-KEY}/sms/multi.json?fromArray=21xxxx,21xxxx&recipients=09123456789,09123456789&messageArray=پیام,پیام&typeArray=0,0

ارسال چندین پیام متفاوت به گیرنده‌های مختلف با شماره‌های فرستنده متفاوت. تعداد آرایه‌ها باید برابر باشد.

پارامترنوعاجباریتوضیح
fromArrayStringاجباریشماره‌های فرستنده (با کاما جدا کنید)
recipientsStringاجباریشماره‌های گیرنده (با کاما جدا کنید)
messageArrayStringاجباریمتن پیام‌ها (با کاما جدا کنید، تعداد برابر با گیرنده‌ها)
typeArrayStringاجبارینوع هر پیام (۰ یا ۱، با کاما جدا کنید، تعداد برابر با گیرنده‌ها)
تعداد آرایه‌ها باید برابر باشد. در صورت عدم برابری، خطای 419 بازگردانده می‌شود.
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "پیام‌های گروهی با موفقیت در صف ارسال قرار گرفتند"
    },
    "entries": [
        {
            "index": 0,
            "messageid": 8792343,
            "message": "پیام",
            "state": 1,
            "from": "+9821xxxx",
            "to": "+989123456789",
            "date": 1786619709
        },
        {
            "index": 1,
            "messageid": 8792344,
            "message": "پیام",
            "state": 1,
            "from": "+9821xxxx",
            "to": "+989123456789",
            "date": 1786619709
        }
    ]
}

ارسال پیامک با الگو (Pattern) GET

GET https://api-payamak.com/api/v4/{API-KEY}/sms/pattern?from=1000xxxx&recipients=09123456789&message={"name":"محمدرضا"}&pattern_id=100&type=0

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

پارامتر نوع اجباری توضیح
from String اجباری شماره فرستنده (خط اختصاصی)
recipients String اجباری شماره گیرنده (با کاما جدا کنید)
message JSON String اجباری پارامترهای الگو به‌صورت JSON (انکد شده)
pattern_id Integer اجباری شناسه الگو در پنل کاربری
type Integer اختیاری ۰=معمولی، ۱=فلش (پیش‌فرض: ۰)
پارامتر message باید به‌صورت JSON string و URL-encoded ارسال شود. کلیدهای موجود در آن باید با پارامترهای تعریف‌شده در الگو (پنل) مطابقت داشته باشند.
📤 مثال درخواست (GET)
GET https://api-payamak.com/api/v4/{API-KEY}/sms/pattern?from=1000xxxx&recipients=09123456789&message={"name":"محمدرضا"}&pattern_id=1224&type=0
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "پیام با موفقیت در صف ارسال قرار گرفت"
    },
    "data": {
        "messageid": 222910475,
        "message": "مشترک گرامی، محمدرضا عزیز خوش آمدید.",
        "state": "فعال",
        "from": "+981000xxxx",
        "date": "1787466576"
    }
}
❌ مثال پاسخ خطا
{
    "return": {
        "status": 404,
        "message": "الگوی مورد نظر یافت نشد"
    }
}

کنترل وضعیت پیامک GET

GET https://api-payamak.com/api/v4/{API-KEY}/sms/status.json?messageid=8792343,8792344

دریافت وضعیت پیام‌های ارسال شده (حداکثر ۵۰ شناسه در هر فراخوانی).

پارامترنوعاجباریتوضیح
messageidStringاجباریشناسه‌های پیام (با کاما جدا کنید)
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "وضعیت پیام‌ها"
    },
    "entries": [
        {
            "messageid": 8792343,
            "from": "+9821000xxx",
            "number": "09123456789",
            "state": 10,
            "status": "رسیده به گیرنده"
        },
        {
            "messageid": 8792344,
            "from": "+9821000xxx",
            "number": "09123456789",
            "state": 4,
            "status": "ارسال به مخابرات"
        }
    ]
}

جزئیات پیامک GET

GET https://api-payamak.com/api/v4/{API-KEY}/sms/select.json?messageid=8792343

مشابه Status اما با اطلاعات کامل‌تر (متن پیام، شماره فرستنده، تاریخ).

پارامترنوعاجباریتوضیح
messageidStringاجباریشناسه پیام (چندتا با کاما)
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "جزئیات پیام"
    },
    "entries": [
        {
            "messageid": 8792343,
            "message": "خدمات پیام کوتاه",
            "number": "09123456789",
            "state": 10,
            "status": "رسیده به گیرنده",
            "from": "1000xxxx",
            "date": 1786619709
        }
    ]
}

لیست ارسال‌ها GET

GET https://api-payamak.com/api/v4/{API-KEY}/sms/selectoutbox.json?startdate=1759533200&enddate=1809619600

دریافت لیست پیام‌های ارسال شده در بازه زمانی (حداکثر ۱ روز).

پارامترنوعاجباریتوضیح
startdateUnixTimeاجباریتاریخ شروع
enddateUnixTimeاجباریتاریخ پایان
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "لیست ارسال‌ها"
    },
    "entries": [
        {
            "messageid": 8792343,
            "message": "test",
            "number": "09123456789",
            "from": "1000xxxx",
            "state": 10,
            "status": "رسیده به گیرنده",
            "date": 1409533200
        },
        {
            "messageid": 8792344,
            "message": "test",
            "number": "09121234568",
            "from": "1000xxxx",
            "state": 10,
            "status": "رسیده به گیرنده",
            "date": 1409533200
        }
    ]
}

آخرین وضعیت پیام GET

GET https://api-payamak.com/api/v4/{API-KEY}/sms/latest.json

دریافت آخرین پیام ارسال‌شده (آخرین رکورد بر اساس شناسه) همراه با جزئیات کامل.

این متد نیازی به پارامتر ورودی ندارد و آخرین پیام ارسالی کاربر را برمی‌گرداند.

📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "آخرین وضعیت پیام"
    },
    "data": {
        "messageid": 8792340,
        "message": "خدمات پیام کوتاه",
        "recipients_count": 2,
        "recipients": [
            "+989123456789",
            "+989123456789"
        ],
        "from": "21xxxxxxxx",
        "state": 10,
        "date": 1786619709
    }
}
در صورت عدم وجود پیام، خطای 400 با پیام "هیچ پیامکی یافت نشد" بازگردانده می‌شود.

آخرین ارسال‌ها GET

GET https://api-payamak.com/api/v4/{API-KEY}/sms/latestoutbox.json?pagesize=50

دریافت آخرین پیام‌های ارسال شده (حداکثر ۲۰۰ مورد).

پارامترنوعاجباریتوضیح
pagesizeIntegerاختیاریتعداد نتایج (پیش‌فرض ۲۰۰)
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "messageid": 8792343,
            "from": "1000xxxx",
            "to": "09123456789",
            "message": "test",
            "state": 10,
            "status": "رسیده به گیرنده",
            "date": 1409533200
        },
        {
            "messageid": 8792344,
            "from": "1000xxxx",
            "to": "09123456789",
            "message": "test",
            "state": 10,
            "status": "رسیده به گیرنده",
            "date": 1409533200
        }
    ]
}

تعداد ارسال‌ها GET

GET https://api-payamak.com/api/v4/{API-KEY}/sms/countoutbox.json?startdate=1409533200&enddate=1409619600

تعداد، پارتیشن‌ها و هزینه کل ارسال‌ها در بازه زمانی.

پارامترنوعاجباریتوضیح
startdateUnixTimeاجباریتاریخ شروع
enddateUnixTimeاجباریتاریخ پایان
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "data": {
        "startdate": 1759533200,
        "enddate": 1789619600,
        "sumpart": 10,
        "sumcount": 10,
        "cost": 50
    }
}

تعداد دریافت‌ها GET

GET https://api-payamak.com/api/v4/{API-KEY}/sms/countinbox.json?startdate=1409533200&enddate=1409619600&number=1000xxxx&isread=0

تعداد پیام‌های دریافت شده با فیلتر شماره و وضعیت خوانده‌شدن.

پارامترنوعاجباریتوضیح
startdateUnixTimeاجباریتاریخ شروع
enddateUnixTimeاجباریتاریخ پایان
numberStringاختیاریشماره خط گیرنده
isreadIntegerاختیاری۰=نخوانده، ۱=خوانده
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "data": {
        "startdate": 1759533200,
        "enddate": 1789619600,
        "isread": 0,
        "count": 5
    }
}

دریافت پیام‌های دریافتی GET

GET https://api-payamak.com/api/v4/{API-KEY}/sms/inbox.json?count=50&offset=0

دریافت لیست پیام‌های دریافتی کاربر با قابلیت تعیین تعداد و offset (صفحه‌بندی ساده).

پارامترنوعاجباریتوضیح
countIntegerاختیاریتعداد پیام‌های مورد نظر (پیش‌فرض ۵۰)
offsetIntegerاختیاریمیزان offset (پیش‌فرض ۰)
این متد فقط سه فیلد message (متن)، to (گیرنده) و from (فرستنده) را بازمی‌گرداند و زمان دریافت date (زمان) را برمیگرداند.
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "لیست پیام‌های دریافتی"
    },
    "entries": [
        {
            "message": "خدمات پیام کوتاه",
            "to": "1000xxxx",
            "from": "09123456789",
            "date": 1789619600
        },
        {
            "message": "تست",
            "to": "1000xxxx",
            "from": "09123456789",
            "date": 1789619600
        }
    ]
}

دریافت پیامک (صفحه‌بندی) GET

GET https://api-payamak.com/api/v4/{API-KEY}/sms/inboxpaged.json?number=1000xxxx&isread=0&page=1&pagesize=200

دریافت پیام‌های دریافتی با صفحه‌بندی (تا ۵۰۰ مورد در هر صفحه).

پارامترنوعاجباریتوضیح
numberStringاختیاریشماره خط
isreadIntegerاختیاری۰=نخوانده، ۱=خوانده
pageIntegerاختیاریشماره صفحه (پیش‌فرض ۱)
pagesizeIntegerاختیاریتعداد در هر صفحه (پیش‌فرض ۲۰۰، حداکثر ۵۰۰)
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "messageid": 35850015,
            "message": "خدمات پیام کوتاه",
            "from": "09123456789",
            "to": "1000xxxx",
            "date": 1357206241
        }
    ],
    "current": {
        "totalcount": "1",
        "currentpage": "1",
        "totalpages": "1",
        "pagesize": "200"
    }
}

دریافت پیامک GET

GET https://api-payamak.com/api/v4/{API-KEY}/sms/receive.json?number=1000xxxx&isread=0

دریافت حداکثر ۵۰ پیام خوانده‌نشده و بروزرسانی خودکار وضعیت به خوانده‌شده.

پارامترنوعاجباریتوضیح
numberStringاختیاریشماره خط
isreadIntegerاختیاری۰=نخوانده (پیش‌فرض)، ۱=خوانده
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "messageid": 35850015,
            "message": "خدمات پیام کوتاه",
            "from": "09123456789",
            "to": "1000xxxx",
            "date": 1757206241
        },
        {
            "messageid": 35850016,
            "message": "خدمات پیام کوتاه",
            "from": "09123456789",
            "to": "1000xxxx",
            "date": 1787206242
        }
    ]
}

کنترل وضعیت با شماره GET

GET https://api-payamak.com/api/v4/{API-KEY}/sms/statusbynumber.json?number=09123456789&startdate=1785677000&pagesize=50

دریافت وضعیت پیام‌های ارسال شده به یک شماره خاص از تاریخ شروع تا حال.

پارامترنوعاجباریتوضیح
numberStringاجباریشماره موبایل گیرنده
startdateUnixTimeاجباریتاریخ شروع
pagesizeIntegerاختیاریتعداد نتایج (پیش‌فرض 50، حداکثر 50)
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "messageid": 8792343,
            "message": "خدمات پیام کوتاه",
            "to": "09123456789",
            "status": 10,
            "statustext": "رسیده به گیرنده",
            "date": 1785677000
        }
    ]
}

سرویس کاربر

اعتبار کاربر GET

GET https://api-payamak.com/api/v4/{API-KEY}/user/credit.json

دریافت اعتبار باقی‌مانده حساب کاربری (ریال).

📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "اعتبار کاربر"
    },
    "data": {
        "credit": 1500000
    }
}

اطلاعات کاربر GET

GET https://api-payamak.com/api/v4/{API-KEY}/user/details.json

دریافت مشخصات کامل کاربر شامل نام، شرکت، اعتبار، تعرفه و ...

📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "اطلاعات کاربر"
    },
    "data": {
        "fullname": "محمدرضا راه‌پیما",
        "mellicode": "001xxxxxxx",
        "shenasname": "001xxxxxxx",
        "date": "1375/11/22",
        "postcode": "1234567890",
        "addr": "تهران _ تهران _ پايتخت",
        "expire_time": "1900000000",
        "credit": "10000000.000",
        "tarrif": "2400",
        "type": "نماینده"
    }
}

ثبت‌نام کاربر GET

GET https://api-payamak.com/api/v4/{API-KEY}/user/register.json?uname=amirreza&passwd=123456&passwd_repeat=123456&parent=admin&mobile=09121234567&melli_code=1234567890&package=1&reseller=1

ایجاد حساب کاربری جدید در سامانه. (هر مدیر در روز حداکثر ۲ کاربر ثبت‌نام می‌کند.)

پارامترهای ورودی
پارامترنوعاجباریتوضیح
unameStringاجبارینام کاربری (فقط حروف و اعداد انگلیسی، بدون فاصله و کاراکتر خاص)
passwdStringاجباریرمز عبور
passwd_repeatStringاجباریتکرار رمز عبور (باید با passwd یکسان باشد)
parentStringاجبارینام کاربری مدیر (کسی که کاربر جدید زیرمجموعه او ثبت می‌شود)
mobileStringاجباریشماره موبایل (با فرمت 0912... یا 98912+...)
melli_codeStringاجباریکد ملی 10 رقمی، یکتا در سامانه
packageIntegerاجباریشناسه پکیج (بسته تعرفه‌ای که کاربر انتخاب می‌کند)
resellerIntegerاجباریوضعیت نمایندگی (0 = نیست یا 1 = هست)
در صورت ارسال نام کاربری تکراری یا شماره موبایل نامعتبر، خطای مناسب بازگردانده می‌شود.
📤 مثال پاسخ موفق
{
    "return": {
        "status": 200,
        "message": "ثبت نام با موفقیت انجام شد"
    }
}
📤 مثال پاسخ خطا (محدودیت روزانه)
{
    "return": {
        "status": 429,
        "message": "امکان ثبت‌نام بیش از ۲ کاربر در یک روز برای این مدیر وجود ندارد"
    }
}

دفترچه تلفن

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

GET https://api-payamak.com/api/v4/{API-KEY}/phonebook/list.json

دریافت لیست تمام دفترچه‌های تلفن کاربر.

پارامترنوعاجباریتوضیح
nameStringاختیاریفیلتر بر اساس نام دفترچه
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "لیست دفترچه‌ها"
    },
    "entries": [
        {
            "book_id": 1,
            "uname": "user",
            "title": "مشتریان",
            "count": 45
        },
        {
            "book_id": 2,
            "uname": "user",
            "title": "مشتریان 2",
            "count": 700
        }
    ]
}

شماره‌های دفترچه GET

GET https://api-payamak.com/api/v4/{API-KEY}/phonebook/numbers.json?bookId=123

دریافت لیست شماره‌های یک دفترچه تلفن.

پارامترنوعاجباریتوضیح
bookIdIntegerاجباریشناسه دفترچه
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "شماره‌های دفترچه"
    },
    "entries": [
        {
            "number_id": 1,
            "number": "09123456789"
        },
        {
            "number_id": 2,
            "number": "09123456789"
        }
    ]
}

لیست سیاه

لیست سیاه GET

GET https://api-payamak.com/api/v4/{API-KEY}/line/blocked/list.json?number=1000xxxx&page=1&pagesize=200

دریافت لیست شماره‌های مسدود شده برای یک خط.

پارامترنوعاجباریتوضیح
numberStringاجباریشماره خط
startdateUnixTimeاختیاریتاریخ شروع
pageIntegerاختیاریشماره صفحه
pagesizeIntegerاختیاریتعداد در هر صفحه
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "number": "1000xxxx",
            "to": "09123456789",
            "user": "username",
            "setter": "system"
        }
    ],
    "current": {
        "totalcount": "1",
        "currentpage": "1",
        "totalpages": "1",
        "pagesize": "200"
    }
}

افزودن شماره به لیست سیاه GET

GET https://api-payamak.com/api/v4/{API-KEY}/line/blocked/add.json?number=21xxxxxxxx&to=09123456789,09123456789

افزودن یک یا چند شماره موبایل به لیست سیاه یک خط مشخص. (فقط شماره‌هایی که کاربر به آن‌ها دسترسی دارد قابل افزودن هستند.)

پارامترنوعاجباریتوضیح
numberStringاجباریشماره خط (خطی که می‌خواهید شماره را برای آن مسدود کنید)
toStringاجباریشماره موبایل(های) مورد نظر برای مسدودسازی (چندتا با کاما جدا کنید)
شماره‌های تکراری و شماره‌هایی که قبلاً در لیست سیاه موجود هستند، با وضعیت تکراری برگردانده می‌شوند. حداکثر ۲۰۰ شماره در هر فراخوانی.
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "number": "21xxxxxxxx",
            "to": "+989123456789",
            "status": "افزوده شد"
        },
        {
            "number": "21xxxxxxxx",
            "to": "+989123456789",
            "status": "تکراری"
        }
    ]
}
کدهای خطا
  • 400 – پارامترهای number یا to ارسال نشده‌اند.
  • 400 – حداقل یک شماره موبایل برای افزودن وجود ندارد.
  • 400 – خطا در افزودن شماره به لیست سیاه (مشکل در دیتابیس یا سطح دسترسی).
  • 401 – حساب کاربری غیرفعال یا توکن نامعتبر.

حذف شماره از لیست سیاه GET

GET https://api-payamak.com/api/v4/{API-KEY}/line/blocked/remove.json?number=21xxxxxxxx&to=09123456789

حذف یک شماره موبایل از لیست سیاه یک خط مشخص. (فقط شماره‌هایی که متعلق به کاربر هستند قابل حذف می‌باشند.)

پارامترنوعاجباریتوضیح
numberStringاجباریشماره خط (خطی که می‌خواهید شماره را از لیست سیاه آن حذف کنید)
toStringاجباریشماره موبایلی که می‌خواهید از لیست سیاه حذف شود (فقط یک شماره)
در صورت عدم وجود شماره در لیست سیاه، خطای 400 با پیام "شماره مورد نظر در لیست سیاه یافت نشد" بازگردانده می‌شود.
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "شماره با موفقیت از لیست سیاه حذف شد"
    }
}
کدهای خطا
  • 400 – پارامترهای number یا to ارسال نشده‌اند.
  • 400 – شماره مورد نظر در لیست سیاه یافت نشد.
  • 400 – خطا در حذف شماره از لیست سیاه (مشکل در دیتابیس یا سطح دسترسی).
  • 401 – حساب کاربری غیرفعال یا توکن نامعتبر.

بررسی وجود در لیست سیاه GET

GET https://api-payamak.com/api/v4/{API-KEY}/line/blocked/exists.json?number=1000xxxx&to=09123456789

بررسی اینکه آیا یک شماره در لیست سیاه خط مورد نظر وجود دارد یا خیر.

پارامترنوعاجباریتوضیح
numberStringاجباریشماره خط
toStringاجباریشماره موبایل (چندتا با کاما)
📤 مثال پاسخ
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "number": "1000xxxx",
            "to": "09123456789",
            "status": "فعال"
        }
    ]
}

کدهای برگشتی

وضعیت‌های کاربر

این کدها در پاسخ وب‌سرویس‌هایی که جزئیات حساب کاربری را برمی‌گردانند (مانند گزارش مقدار اعتبار) برگشت داده می‌شوند.

کدتوضیح
0کاربر در وضعیت فعال قرار دارد. پاسخ ارائه‌شده معتبر است.
1کاربر مورد بررسی یافت نشد.
2کاربر آزمایشی (جهت تست وب‌سرویس).
3کاربر قفل شده است و امکان اجرای عملیات وجود ندارد.
4عضویت کاربر منقضی شده است.
5کاربر هنوز تأیید نشده است.
6دسترسی به وب‌سرویس برای کاربر تعریف نشده است.
وضعیت‌های ثبت کاربر جدید

کدهای بازگشتی متد RegisterUser.

کدتوضیح
0ثبت‌نام با موفقیت انجام شد.
10نام کاربری نامعتبر است.
11شماره موبایل نامعتبر است.
12کد ملی نامعتبر است.
13ایمیل نامعتبر است.
14مدیر کاربر دسترسی کافی ندارد.
15نام کاربری قبلاً ثبت شده است.
16پکیج درخواستی اشتباه است.
17رمز عبور و تکرار آن هماهنگ نیست.
18محدودیت ثبت‌نام (بیش از ۲ کاربر در روز برای این مدیر).
19کد ملی نامعتبر است.
وضعیت‌های ارسال پیامک

کدهای بازگشتی متدهای ارسال پیامک.

کدتوضیح
0ارسال با موفقیت انجام شد.
21تعداد گیرنده‌ها از حد مجاز بیشتر است.
22اعتبار کاربر کافی نیست.
23شماره فرستنده نامعتبر است.
24متن پیام خالی است.
25هیچ گیرنده‌ای انتخاب نشده است.
26زمان ارسال اشتباه تنظیم شده است.
27خطای نامشخص در ارسال (اپراتور).
28داده‌های ارسالی مغایرت دارد.
29الگوی انتخاب‌شده فعال نیست.
وضعیت گزارش‌های پیامکی

کدهای بازگشتی متدهای گزارش‌گیری (وضعیت، لیست ارسال‌ها، ...).

کدتوضیح
0گزارش با موفقیت ایجاد شد.
30هیچ پیامکی انتخاب نشده است.
31هیچ گزارشی موجود نیست.
32تعداد شناسه‌ها از حد مجاز فراتر رفته است.
وضعیت دلیوری (رسید) پیامک

کدهای بازگشتی متد sms/status و sms/select.

کدتوضیح
1ارسال شده به مخابرات
2نرسیده به مخابرات
3رسیده به مخابرات
4رسیده به گوشی
5نرسیده به گوشی
6برگشتی
7خطای مخابراتی
8خطای نامشخص
9نامشخص
10لیست سیاه
11ارسال شد به مخابرات
12در صف ارسال
13لغو شده
14REJECTED
15REJECTD
16FAILED
17UNDELIV
18EXPIRED
19خطا در پردازش متن پیام
20شماره مقصد در لیست سیاه
21شماره فرستنده نامعتبر
22نقض قوانین و مقررات
23فرمت پیام نامعتبر
24سایر خطاهای غیرمنتظره
وضعیت دفترچه تلفن

کدهای بازگشتی متدهای مدیریت دفترچه تلفن.

کدتوضیح
0عملیات با موفقیت انجام شد.
40رکوردی با این اطلاعات وجود ندارد.
41دفترچه تلفن با این اطلاعات قبلاً وجود دارد.
42شماره‌ای ارسال نشده است.
43عملیات شکست خورد.
44فیلد flag خالی ارسال شده است.
45flag تکراری است.
سایر کدهای وضعیت
کدتوضیح
1000اشکال در پایگاه داده.
2000اشکال در سرور.