وب سرویس ارسال پیامک هیرو – راهنمای جامع API پیامک

مقدمه ای بر وب سرویس پیامک هیرو

وب سرویس ارسال پیامک هیرو یک راهکار قدرتمند برای ارسال و دریافت پیامک از طریق API است که به توسعه دهندگان و کسب و کارها امکان یکپارچه سازی سرویس پیامک را با سیستم های نرم افزاری می دهد. این سرویس با ارائه API RESTful انعطاف پذیر، امکان ارسال انبوه پیامک، بررسی وضعیت ارسال و مدیریت اعتبار حساب را فراهم می کند.

ویژگی های کلیدی وب سرویس پیامک هیرو

• پشتیبانی از متدهای GET و POST

• خروجی در سه فرمت JSON، XML و HTML

• امنیت بالا با استفاده از رمزنگاری MD5 برای رمز عبور

• پشتیبانی از ارسال پیامک معمولی و فلش

• امکان ارسال گروهی تا ۱۵۰ شماره در هر درخواست

• بررسی وضعیت تحویل پیامک (Delivery Report)

• مدیریت اعتبار حساب به صورت برنامه نویسی

آدرس وب سرویس

آدرس پایه وب سرویس هیرو:

https://my.hiro-sms.com/webservice/url/send.php

توابع اصلی API پیامک هیرو

۱. ارسال پیامک (SendSMS)

کاربرد: ارسال پیامک به یک یا چند شماره موبایل

مثال درخواست (JSON):

https://my.hiro-sms.com/webservice/url/send.php?method=sendsms&format=json&from=10001234&to=9121234567,9127654321&text=سلام%۲۰به%۲۰سرویس%۲۰پیامک%۲۰هیرو%۲۰خوش%۲۰آمدید&type=0&username=test&password=e10adc3949ba59abbe56e057f20f883e

پارامترهای ورودی:

کدهای وضعیت بازگشتی:

• ۰: نام کاربری یا رمز عبور نادرست

• ۱: اعتبار برای ارسال کافی است

• ۲: شماره فرستنده معتبر نیست

• ۴: سامانه ارسال غیرفعال است

• ۵: پنل کاربری غیرفعال است

• ۶: پنل کاربری منقضی شده

• ۷: متن پیام خالی است

• ۹: هیچ گیرنده ای وارد نشده

• ۱۰: محدودیت زمانی ارسال از خطوط عادی

• ۱۱: خطای نامشخص

• ۱۶: تعداد آرایه های ورودی بیش از ۱۵۰ عدد است

• ۲۲: تمامی ورودی ها به درستی وارد نشده

• ۳۳: نوع متغیر method به درستی وارد نشده

۲. بررسی اعتبار حساب (GetCredit)

کاربرد: دریافت میزان اعتبار باقیمانده حساب

مثال درخواست (XML):

https://my.hiro-sms.com/webservice/url/send.php?method=getcredit&format=xml&username=test&password=e10adc3949ba59abbe56e057f20f883e

پارامترهای ورودی:

۳. دریافت وضعیت ارسال (GetStatus)

کاربرد: بررسی وضعیت تحویل پیامک های ارسال شده

مثال درخواست (HTML):

https://my.hiro-sms.com/webservice/url/send.php?method=getstatus&format=html&id=161424362086102656,361424362086102666&username=test&password=e10adc3949ba59abbe56e057f20f883e

پارامترهای ورودی:

کدهای وضعیت بازگشتی:

• ۰: ارسال شده به مخابرات

• ۱: رسیده به گوشی

• ۲: نرسیده به گوشی

• ۳: رسیده به مخابرات

• ۴: نرسیده به مخابرات

• ۵: آهنگ ارسال

• ۶: ترگشته

• ۱۴: کد وضعیت نامعتبر است

• ۱۵: نام کاربری یا رمز عبور نادرست

• ۱۶: تعداد آرایه های ورودی بیش از ۵۰ عدد است

• ۱۷: پنل کاربری غیرفعال است

• ۱۸: پنل کاربری منقضی شده

• ۲۲: تمامی ورودی ها به درستی وارد نشده

• ۳۳: نوع متغیر method به درستی وارد نشده

۴. ارسال چندگانه پیامک (SendMultiSMS)

کاربرد: ارسال پیامک های مختلف به گیرندگان مختلف در یک درخواست

مثال درخواست (JSON):

https://my.hiro-sms.com/webservice/url/send.php?method=sendmultisms&format=json&from=10001234,30001234&to=9121234567,9127654321&text=پیام%۲۰اول,پیام%۲۰دوم&type=0,1&username=test&password=e10adc3949ba59abbe56e057f20f883e

پارامترهای ورودی:

توجه: تعداد آرایه های ورودی برای پارامترهای from، to، text و type باید برابر باشند.

بهترین روش های استفاده از API پیامک هیرو

1. استفاده از رمز عبور MD5: برای امنیت بیشتر، همیشه رمز عبور را به صورت MD5 ارسال کنید.

2. مدیریت خطاها: همیشه کدهای وضعیت بازگشتی را بررسی و برای هر کد رفتار مناسب را پیاده سازی کنید.

3. محدودیت های سامانه: به محدودیت های سامانه مانند حداکثر ۱۵۰ گیرنده در هر درخواست توجه کنید.

4. استفاده از HTTPS: برای امنیت ارتباط، همیشه از آدرس HTTPS استفاده نمایید.

5. لاگ گیری: تمامی درخواست ها و پاسخ های API را در سیستم خود ذخیره کنید.

نمونه کدهای پیاده سازی

نمونه کد PHP برای ارسال پیامک:

<?php
$username = "test";
$password = md5("۱۲۳۴۵۶");
$from = "۱۰۰۰۱۲۳۴";
$to = "۹۱۲۱۲۳۴۵۶۷,۹۱۲۷۶۵۴۳۲۱";
$text = urlencode("سلام به سرویس پیامک هیرو خوش آمدید");
$type = "۰";

$url = "https://my.hiro-sms.com/webservice/url/send.php?method=sendsms&format=json&from=$from&to=$to&text=$text&type=$type&username=$username&password=$password";

$response = file_get_contents($url);
$result = json_decode($response, true);

if($result[۰] == ۱) {
    echo "پیامک با موفقیت ارسال شد. کد پیگیری: ".$result[۱];
} else {
    echo "خطا در ارسال پیامک. کد خطا: ".$result[۰];
}
?>

نمونه کد Python برای بررسی اعتبار حساب:

import requests
import hashlib

username = "test"
password = hashlib.md5("۱۲۳۴۵۶".encode()).hexdigest()

url = f"https://my.hiro-sms.com/webservice/url/send.php?method=getcredit&format=json&username={username}&password={password}"

response = requests.get(url)
result = response.json()

if isinstance(result, list) and result[۰] == "۰":
    print(f"اعتبار باقیمانده: {result[۱]} واحد")
else:
    print("خطا در دریافت اعتبار حساب")

نتیجه گیری

وب سرویس ارسال پیامک هیرو با ارائه API قدرتمند و انعطاف پذیر، امکان یکپارچه سازی سرویس پیامک را با انواع سیستم های نرم افزاری فراهم می کند. با استفاده از این سرویس، می توانید به راحتی پیامک های انبوه ارسال کنید، وضعیت تحویل پیامک ها را بررسی نمایید و اعتبار حساب خود را مدیریت کنید.

برای اطلاعات بیشتر و مستندات کامل، به وبسایت رسمی هیرو مراجعه کنید

admin

See Full Bio