مقدمه

POST https://api-payamak.com/api/v3/rest/sms/send
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "from": "21xxxxxxxx",
    "recipients": ["09123456789", "09123456789"],
    "message": "خدمات پیام کوتاه",
    "type": 0
}

{
    "return": {
        "status": 200,
        "message": "پیام با موفقیت در صف ارسال قرار گرفت"
    },
    "data": {
        "messageid": 8792343,
        "message": "خدمات پیام کوتاه",
        "state": "فعال",
        "from": "21xxxxxxxx",
        "date": 1786619709
    }
}

POST https://api-payamak.com/api/v3/rest/sms/multiple-send
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "fromArray": ["21xxxx", "21xxxx"],
    "recipients": ["09123456789", "09123456789"],
    "messageArray": ["پیام", "پیام"],
    "typeArray": [0, 0]
}

{
    "return": {
        "status": 200,
        "message": "پیام‌های گروهی با موفقیت در صف ارسال قرار گرفتند"
    },
    "entries": [
        {
            "index": 0,
            "messageid": 8792343,
            "message": "پیام",
            "state": "فعال",
            "from": "21xxxx",
            "to": "09123456789",
            "date": 1786619709
        },
        {
            "index": 1,
            "messageid": 8792344,
            "message": "پیام",
            "state": "فعال",
            "from": "21xxxx",
            "to": "09123456789",
            "date": 1786619709
        }
    ]
}

POST https://api-payamak.com/api/v3/rest/sms/pattern-send
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "from": "1000xxxx",
    "recipients": ["09123456789"],
    "message": {"name":"محمدرضا"},
    "pattern_id": 100,
    "type": 0
}

{
    "return": {
        "status": 200,
        "message": "پیام با موفقیت در صف ارسال قرار گرفت"
    },
    "data": {
        "messageid": 222910475,
        "message": "مشترک گرامی، محمدرضا عزیز خوش آمدید.",
        "state": "فعال",
        "from": "+981000xxxx",
        "date": "1787466576"
    }
}

POST https://api-payamak.com/api/v3/rest/sms/status
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "messageid": [8792343, 8792344]
}

{
    "return": {
        "status": 200,
        "message": "وضعیت پیام‌ها"
    },
    "entries": [
        {
            "messageid": 8792343,
            "from": "21xxxx",
            "number": "09123456789",
            "state": 10,
            "status": "رسیده به گیرنده"
        },
        {
            "messageid": 8792344,
            "from": "21xxxx",
            "number": "09123456789",
            "state": 4,
            "status": "ارسال به مخابرات"
        }
    ]
}

POST https://api-payamak.com/api/v3/rest/sms/select
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "messageid": [8792343]
}

{
    "return": {
        "status": 200,
        "message": "جزئیات پیام"
    },
    "entries": [
        {
            "messageid": 8792343,
            "message": "خدمات پیام کوتاه",
            "number": "09123456789",
            "state": 10,
            "status": "رسیده به گیرنده",
            "from": "21xxxx",
            "date": 1786619709
        }
    ]
}

POST https://api-payamak.com/api/v3/rest/sms/selectoutbox
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "startdate": 1759533200,
    "enddate": 1809619600
}

{
    "return": {
        "status": 200,
        "message": "لیست ارسال‌ها"
    },
    "entries": [
        {
            "messageid": 8792343,
            "message": "test",
            "number": "09123456789",
            "from": "21xxxx",
            "state": 10,
            "status": "رسیده به گیرنده",
            "date": 1786619709
        }
    ]
}

POST https://api-payamak.com/api/v3/rest/sms/latest
Headers: Authorization: YOUR_API_KEY

{
    "return": {
        "status": 200,
        "message": "آخرین وضعیت پیام"
    },
    "data": {
        "messageid": 8792340,
        "message": "خدمات پیام کوتاه",
        "recipients_count": 2,
        "recipients": ["09123456789", "09123456789"],
        "from": "21xxxxxxxx",
        "state": 10,
        "date": 1786619709
    }
}

POST https://api-payamak.com/api/v3/rest/sms/latestoutbox
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "pagesize": 50
}

{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "messageid": 8792343,
            "from": "21xxxx",
            "to": "09123456789",
            "message": "test",
            "state": 10,
            "status": "رسیده به گیرنده",
            "date": 1786619709
        }
    ]
}

POST https://api-payamak.com/api/v3/rest/sms/countoutbox
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "startdate": 1759533200,
    "enddate": 1789619600
}

{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "data": {
        "startdate": 1759533200,
        "enddate": 1789619600,
        "sumpart": 10,
        "sumcount": 10,
        "cost": 50
    }
}

POST https://api-payamak.com/api/v3/rest/sms/countinbox
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "startdate": 1759533200,
    "enddate": 1789619600,
    "number": "1000xxxx",
    "isread": 0
}

{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "data": {
        "startdate": 1759533200,
        "enddate": 1789619600,
        "isread": 0,
        "count": 5
    }
}

POST https://api-payamak.com/api/v3/rest/sms/inbox
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "count": 50,
    "offset": 0
}

{
    "return": {
        "status": 200,
        "message": "لیست پیام‌های دریافتی"
    },
    "entries": [
        {
            "messageid": 35850015,
            "message": "خدمات پیام کوتاه",
            "to": "1000xxxx",
            "from": "09123456789",
            "date": 1789619600
        }
    ]
}

POST https://api-payamak.com/api/v3/rest/sms/inboxpaged
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "number": "1000xxxx",
    "isread": 0,
    "page": 1,
    "pagesize": 200
}

{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "messageid": 35850015,
            "message": "خدمات پیام کوتاه",
            "from": "09123456789",
            "to": "1000xxxx",
            "date": 1357206241
        }
    ],
    "current": {
        "totalcount": "1",
        "currentpage": "1",
        "totalpages": "1",
        "pagesize": "200"
    }
}

POST https://api-payamak.com/api/v3/rest/sms/receive
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "number": "1000xxxx",
    "isread": 0
}

{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "messageid": 35850015,
            "message": "خدمات پیام کوتاه",
            "from": "09123456789",
            "to": "1000xxxx",
            "date": 1787206241
        }
    ]
}

POST https://api-payamak.com/api/v3/rest/sms/statusbynumber
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "number": "09123456789",
    "startdate": 1785677000,
    "pagesize": 50
}

{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "messageid": 8792343,
            "message": "خدمات پیام کوتاه",
            "to": "09123456789",
            "status": 10,
            "statustext": "رسیده به گیرنده",
            "date": 1785677000
        }
    ]
}

POST https://api-payamak.com/api/v3/rest/my/credit
Headers: Authorization: YOUR_API_KEY

{
    "return": {
        "status": 200,
        "message": "اعتبار کاربر"
    },
    "data": {
        "credit": 1500000
    }
}

POST https://api-payamak.com/api/v3/rest/my
Headers: Authorization: YOUR_API_KEY

{
    "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": "نماینده"
    }
}

POST https://api-payamak.com/api/v3/rest/user/register
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "uname": "amirreza",
    "passwd": "123456",
    "passwd_repeat": "123456",
    "parent": "admin",
    "mobile": "09121234567",
    "melli_code": "1234567890",
    "package": 1,
    "reseller": 1
}

{
    "return": {
        "status": 200,
        "message": "ثبت نام با موفقیت انجام شد"
    }
}

{
    "return": {
        "status": 429,
        "message": "امکان ثبت‌نام بیش از ۲ کاربر در یک روز برای این مدیر وجود ندارد"
    }
}

POST https://api-payamak.com/api/v3/rest/my/phonebook
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "name": "مشتریان"
}

{
    "return": {
        "status": 200,
        "message": "لیست دفترچه‌ها"
    },
    "entries": [
        {
            "book_id": 123,
            "uname": "user",
            "title": "مشتریان",
            "count": 45
        }
    ]
}

POST https://api-payamak.com/api/v3/rest/phonebook/number
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "book_id": 123
}

{
    "return": {
        "status": 200,
        "message": "شماره‌های دفترچه"
    },
    "entries": [
        {
            "number_id": 1,
            "number": "09123456789"
        }
    ]
}

POST https://api-payamak.com/api/v3/rest/phonebook/new
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "name": "مشتریان ویژه",
    "numbers": ["09123456789", "09123456788"],
    "flag": "vip_customers"
}

{
    "return": {
        "status": 200,
        "message": "دفترچه تلفن با موفقیت ایجاد شد"
    },
    "data": {
        "id": 123
    }
}

DELETE https://api-payamak.com/api/v3/rest/phonebook/delete
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "book_id": 123
}

{
    "return": {
        "status": 200,
        "message": "دفترچه تلفن با موفقیت حذف شد"
    }
}

POST https://api-payamak.com/api/v3/rest/phonebook/number/add
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "book_id": 123,
    "numbers": ["09123456789", "09123456788"]
}

{
    "return": {
        "status": 200,
        "message": "شماره‌ها با موفقیت به دفترچه تلفن اضافه شدند"
    }
}

DELETE https://api-payamak.com/api/v3/rest/phonebook/number/delete
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "book_id": 123,
    "numbers": ["09123456789", "09123456788"]
}

{
    "return": {
        "status": 200,
        "message": "شماره‌ها با موفقیت از دفترچه تلفن حذف شدند"
    }
}

POST https://api-payamak.com/api/v3/rest/line/blocked/list
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "number": "1000xxxx",
    "page": 1,
    "pagesize": 200
}

{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "number": "1000xxxx",
            "to": "09123456789",
            "user": "username",
            "setter": "system"
        }
    ],
    "current": {
        "totalcount": "1",
        "currentpage": "1",
        "totalpages": "1",
        "pagesize": "200"
    }
}

POST https://api-payamak.com/api/v3/rest/line/blocked/add
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "number": "21xxxxxxxx",
    "to": ["09123456789", "09123456789"]
}

{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "number": "21xxxxxxxx",
            "to": "+989123456789",
            "status": "افزوده شد"
        },
        {
            "number": "21xxxxxxxx",
            "to": "+989123456789",
            "status": "تکراری"
        }
    ]
}

POST https://api-payamak.com/api/v3/rest/line/blocked/remove
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "number": "21xxxxxxxx",
    "to": "09123456789"
}

{
    "return": {
        "status": 200,
        "message": "شماره با موفقیت از لیست سیاه حذف شد"
    }
}

POST https://api-payamak.com/api/v3/rest/line/blocked/exists
Headers: Authorization: YOUR_API_KEY
Content-Type: application/json

{
    "number": "1000xxxx",
    "to": ["09123456789"]
}

{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "number": "1000xxxx",
            "to": "09123456789",
            "status": "فعال"
        }
    ]
}