راهنمای استفاده از وبسرویس MihanSMSCenter
| متد send : برای ارسال تکی SMS از این متد استفاده می شود. در صورتی که ارسال بدون خطا انجام شود status (کد خطا) دارای مقدار صفر خواهد بود و identifier شامل کد شناسه پیام خواهد بود که با استفاده از آن میتوان وضعیت پیام را بررسی کرد. پارامتر send_time اختیاری می باشد که برای تعیین زمان ارسال استفاده میشود. |
|
| پارامتر های ورودی (مواردی که با * مشخص شده اند اختیاری می باشند) | |
| username | نام کاربری Mihan SMS Center |
| password | رمز عبور Mihan SMS Center |
| to | شماره گیرنده پیام |
| from | شماره فرستنده پیام |
| message | متن پیام (هزینه پیام با توجه به طول پیام متفاوت خواهد بود.) |
| send_time* | زمان ارسال پیام بر حسب UNIX Timestamp |
| check_duplicate* | در صورتی که بعد از ارسال پیام به دلیل تایم اوت در شبکه و یا هر مشکل دیگری پاسخی از سرور دریافت نکردید با فراخوانی مجدد این متد و قرار دادن این پارامتر برابر true میتوانید از ارسال پیام تکراری جلوگیری نمایید. با این کار چنانچه این پیام قبلا ارسال شده باشد شناسه پیام برگردانده میشود و در غیر اینصورت مجددا ارسال انجام خواهد شد. |
| udh* | در این پارامتر مقدار UDH به صورت HEX قرار می‌گیرد. برای ارسال پیامک با کاربردهای خاص از UDH استفاده میشود (برای مثال ارسال روی پورت خاص). |
| پارامتر های خروجی | |
| status | کد خطا (راهنما) |
| identifier | کد شناسه پیام جهت بررسی وضعیت پیام |
| status_message | متن پیام خطا |
| متد multiSend : از این متد برای ارسال یک SMS به چند نفر استفاده می شود. در صورت بروز خطای کلی status شامل کد خطا خواهد بود در غیر اینصورت صفر خواهد بود. در صورت بروز خطا برای هر یک از ارسال ها کد خطای متناظر با هر کدام در آرایه send_results قابل بررسی می باشد. کد های شناسه پیام های ارسالی در آرایه identifiers برگردانده خواهد شد که آرایه ایست متناظر با آرایه to. پارامتر send_time اختیاری می باشد که برای تعیین زمان ارسال استفاده میشود. |
|
| پارامتر های ورودی (مواردی که با * مشخص شده اند اختیاری می باشند) | |
| username | نام کاربری Mihan SMS Center |
| password | رمز عبور Mihan SMS Center |
| to | آرایه ای از شماره های گیرندگان |
| from | شماره فرستنده پیام |
| message | متن پیام (هزینه پیام با توجه به طول پیام متفاوت خواهد بود.) |
| send_time* | زمان ارسال پیام بر حسب UNIX Timestamp |
| check_duplicate* | در صورتی که بعد از ارسال پیامها به دلیل تایم اوت در شبکه و یا هر مشکل دیگری پاسخی از سرور دریافت نکردید با فراخوانی مجدد این متد و قرار دادن این پارامتر برابر true میتوانید از ارسال پیام تکراری جلوگیری نمایید. با این کار چنانچه پیامها قبلا ارسال شده باشند شناسه پیامها برگردانده میشود و در غیر اینصورت مجددا ارسال انجام خواهد شد. |
| udh* | در این پارامتر مقدار UDH به صورت HEX قرار می‌گیرد. برای ارسال پیامک با کاربردهای خاص از UDH استفاده میشود (برای مثال ارسال روی پورت خاص). |
| پارامتر های خروجی | |
| status | کد خطا (در صورت بروز خطای کلی) (راهنما) |
| send_results | آرایه ای از کد های خطا برای هر یک از پیام های ارسالی که با آرایه ورودی to متناظر است. (راهنما) |
| identifiers | کدهای شناسه پیام های ارسالی که با آرایه ورودی to متناظر است. |
| status_message | متن پیام خطا |
| متد bulkSend : از این متد برای ارسال نظیر به نظیر SMS استفاده می شود. در صورت بروز خطای کلی status شامل کد خطا خواهد بود در غیر اینصورت صفر خواهد بود. در صورت بروز خطا برای هر یک از ارسال ها کد خطای متناظر با هر کدام در آرایه send_results قابل بررسی می باشد. کد های شناسه پیام های ارسالی در آرایه identifiers برگردانده خواهد شد که آرایه ایست متناظر با آرایه to. پارامتر send_time اختیاری می باشد که برای تعیین زمان ارسال استفاده میشود. |
|
| پارامتر های ورودی (مواردی که با * مشخص شده اند اختیاری می باشند) | |
| username | نام کاربری Mihan SMS Center |
| password | رمز عبور Mihan SMS Center |
| to | آرایه ای از شماره های گیرندگان |
| from | آرایه ای از شماره فرستنده پیام |
| message | آرایه ای از متن پیامها (هزینه پیام با توجه به طول پیام متفاوت خواهد بود.) |
| send_time* | آرایه ای از زمان ارسال پیام بر حسب UNIX Timestamp |
| check_duplicate* | در صورتی که بعد از ارسال پیامها به دلیل تایم اوت در شبکه و یا هر مشکل دیگری پاسخی از سرور دریافت نکردید با فراخوانی مجدد این متد و قرار دادن این پارامتر برابر true میتوانید از ارسال پیام تکراری جلوگیری نمایید. با این کار چنانچه پیامها قبلا ارسال شده باشند شناسه پیامها برگردانده میشود و در غیر اینصورت مجددا ارسال انجام خواهد شد. |
| udh* | آرایه ای از مقادیر UDH به صورت HEX. برای ارسال پیامک با کاربردهای خاص از UDH استفاده میشود (برای مثال ارسال روی پورت خاص). |
| پارامتر های خروجی | |
| status | کد خطا (در صورت بروز خطای کلی) (راهنما) |
| send_results | آرایه ای از کد های خطا برای هر یک از پیام های ارسالی که با آرایه ورودی to متناظر است. (راهنما) |
| identifiers | کدهای شناسه پیام های ارسالی که با آرایه ورودی to متناظر است. |
| status_message | متن پیام خطا |
| متد checkSendStatus : از این متد برای بررسی وضعیت SMS ی که قبلا ارسال شده است استفاده می شود. | |
| پارامتر های ورودی | |
| username | نام کاربری Mihan SMS Center |
| password | رمز عبور Mihan SMS Center |
| identifier | کد شناسه پیام |
| پارامتر های خروجی | |
| status | کد خطا (راهنما) |
| sendStatus | کد وضعیت SMS ارسالی (راهنما) |
| status_message | متن پیام خطا |
متد multiCheckSendStatus : این متد برای بررسی وضعیت SMS هایی که قبلا ارسال شده اند استفاده می شود. کد شناسه پیام هایی که می خواهید از وضعیت آنها مطلع شوید را به صورت آرایه در پارامتر identifiers قرار دهید. |
|
| پارامتر های ورودی | |
| username | نام کاربری Mihan SMS Center |
| password | رمز عبور Mihan SMS Center |
| identifiers | آرایه ای از کدهای شناسه پیام |
| پارامتر های خروجی | |
| status | کد خطا (راهنما) |
| sendStatuses | آرایه ای از کدهای وضعیت SMS های ارسالی (راهنما) |
| status_message | متن پیام خطا |
متد cancelSend : از این متد برای لغو ارسال پیام های زمانبندی شده ای که
هنوز ارسال نشده اند استفاده می شود. کد شناسه پیام هایی که می خواهید لغو شوند را به صورت آرایه در پارامتر identifiers قرار دهید. |
|
| پارامتر های ورودی | |
| username | نام کاربری Mihan SMS Center |
| password | رمز عبور Mihan SMS Center |
| identifiers | آرایه ای از کدهای شناسه پیام |
| پارامتر های خروجی | |
| status | کد خطا (راهنما) |
| sendStatuses | آرایه ای از کدهای وضعیت SMS های ارسالی (راهنما) |
| status_message | متن پیام خطا |
| متد verifyReceive : با توجه به اینکه SMS ها ار از طریق متد POST دریافت میکنید جهت جلوگیری از شبیه سازی دریافت توسط اشخاص دیگر از این متد برای بررسی صحت SMS دریافتی استفاده می شود. قابل ذکر است که پس از استفاده از این متد وضعیت پیام به حالت خوانده شده تغییر پیدا میکند. در صورت صحت دریافت، پارامتر status (کد خطا) شامل مقدار صفر خواهد بود. |
|
| پارامتر های ورودی | |
| username | نام کاربری Mihan SMS Center |
| password | رمز عبور Mihan SMS Center |
| to | این 4 پارامتر باید عینا حاوی پارامترهای دریافتی از متد POST باشند. |
| from | |
| message | |
| timestamp | |
| پارامتر های خروجی | |
| status | کد خطا (راهنما) |
| status_message | متن پیام خطا |
| متد getNewMessages : از این متد برای گرفتن پیام های دریافتی های جدید استفاده میشود (پیام هایی که وضعیتشان «خوانده نشده» می باشد). این متد برای حالتی که امکان دریافت آنلاین از طریق URL وجود ندارد قابل استفاده است. برای مثال برای نرم افزار هایی که با delphi و vb یا c نوشته می شوند و امکان دریافت پیام از طریق URL وجود ندارد، از این متد میتوان استفاده نمود. پیام هایی که توسط این متد برگردانده میشوند، وضعیتشان از «خوانده نشده» به «خوانده شده» تغییر می یابد. قابل ذکر است که این متد حداکثر 100 پیام را برمیگرداند و برای دریافت بیش از صد پیام باید به صورت متوالی این متد صدا زده شود. |
|
| پارامتر های ورودی | |
| username | نام کاربری Mihan SMS Center |
| password | رمز عبور Mihan SMS Center |
| پارامتر های خروجی | |
| status | کد خطا (راهنما) |
| status_message | متن پیام خطا |
| count | تعداد پیام ها |
| messages | جزئیات پیام ها در قالب یک آرایه از پیام ها، که هر پیام خود آرایه ای شامل messageId، to، from، message، timestamp می باشد. |
| متد getMessages : از این متد برای گرفتن پیام های دریافتی استفاده میشود. پارامتر اختیاری fromId در صورتی که حاوی شناسه یک پیام دریافتی باشد، پیام های برگردانده شده پیام هایی خواهند بود که بعد از این پیام دریافت شده اند. پیام هایی که توسط این متد برگردانده میشوند، وضعیتشان از «خوانده نشده» به «خوانده شده» تغییر می یابد. قابل ذکر است که این متد حداکثر 100 پیام را برمیگرداند و برای دریافت بیش از صد پیام باید به صورت متوالی این متد صدا زده شود و هر با fromId برابر با شناسه آخرین پیام دریافتی باشد. |
|
| پارامتر های ورودی (مواردی که با * مشخص شده اند اختیاری می باشند) | |
| username | نام کاربری Mihan SMS Center |
| password | رمز عبور Mihan SMS Center |
| fromId* | پیام هایی که بعد از این پیام دریافت شده باشند برگردانده میشوند. |
| پارامتر های خروجی | |
| status | کد خطا (راهنما) |
| status_message | متن پیام خطا |
| count | تعداد پیام ها |
| messages | جزئیات پیام ها در قالب یک آرایه از پیام ها، که هر پیام خود آرایه ای شامل messageId، to، from، message و timestamp می باشد. |
| متد getSentMessages : از این متد برای گرفتن پیام های ارسالی استفاده میشود. پارامتر اختیاری fromId در صورتی که حاوی شناسه یک پیام ارسالی باشد، پیام های برگردانده شده پیام هایی خواهند بود که بعد از این پیام ارسال شده اند. قابل ذکر است که این متد حداکثر 100 پیام را برمیگرداند و برای دریافت بیش از صد پیام باید به صورت متوالی این متد صدا زده شود و هر با fromId برابر با شناسه آخرین پیام ارسالی باشد. |
|
| پارامتر های ورودی (مواردی که با * مشخص شده اند اختیاری می باشند) | |
| username | نام کاربری Mihan SMS Center |
| password | رمز عبور Mihan SMS Center |
| fromId* | پیام هایی که بعد از این پیام ارسال شده باشند برگردانده میشوند. |
| پارامتر های خروجی | |
| status | کد خطا (راهنما) |
| status_message | متن پیام خطا |
| count | تعداد پیام ها |
| messages | جزئیات پیام ها در قالب یک آرایه از پیام ها، که هر پیام خود آرایه ای شامل messageId، to، from، message و timestamp می باشد. |
| متد accountInfo : از این متد برای بررسی اطلاعات حساب خود می توانید استفاده نمایید. پارامترهای بازگشتی شامل تعداد کل sms های ارسالی و دریافتی و تعداد باقیمانده موجودی sms شما و تعداد کل موجودی sms شما از ابتدا و url ی که جهت دریافت استفاده می کنید و شماره SMS های مجاز شما خواهد بود. |
|
| پارامتر های ورودی | |
| username | نام کاربری Mihan SMS Center |
| password | رمز عبور Mihan SMS Center |
| پارامتر های خروجی | |
| status | کد خطا (راهنما) |
| status_message | متن پیام خطا |
| balance | موجودی حساب SMS بر حسب ریال |
| level | درجه حساب که بر اساس آن قیمت پیامک ها محاسبه می شود. |
| sms_price_fa | هزینه هر پیامک فارسی بر حسب ریال |
| sms_price_en | هزینه هر پیامک انگلیسی بر حسب ریال |
| received_sms | تعداد کل SMS های دریافتی تاکنون |
| sent_sms | تعداد کل SMS های ارسالی تاکنون |
| recieve_url | URL ی که SMS های دریافتی به آن POST میشود |
| sms_numbers | آرایه ای شامل شماره SMS هایی که به این حساب اختصاص یافته است |
| متد changeReceiveURL : از این متد برای تغییر URL دریافت استفاده میشود. | |
| پارامتر های ورودی | |
| username | نام کاربری Mihan SMS Center |
| password | رمز عبور Mihan SMS Center |
| receive_url | URL جدید که SMS های دریافتی باید به آن POST شوند |
| پارامتر های خروجی | |
| status | کد خطا (راهنما) |
| status_message | متن پیام خطا |
| متد changePassword : از این متد برای تغییر رمز حساب دریافت استفاده میشود. | |
| پارامتر های ورودی | |
| username | نام کاربری Mihan SMS Center |
| password | رمز عبور Mihan SMS Center |
| new_password | رمز عبور جدید |
| پارامتر های خروجی | |
| status | کد خطا (راهنما) |
| status_message | متن پیام خطا |
| جدول راهنمای کد های خطا | |
| کد خطا | توضیحات |
| 0 | بدون خطا |
| 1 | نام کاربری و رمز عبور نامعتبر است |
| 2 | شماره فرستنده نا معتبر است |
| 3 | شماره گیرنده نامعتبر است |
| 4 | اعتبار حساب کافی نمی باشد |
| 5 | خطا در ارتباط با سرور |
| 6 | پیام نامعتبر است |
| 7 | متن پیام بیش از حد طولانی است |
| 8 | خطا در برقراری ارتباط با سوئیچ مخابرات |
| 9 | پیام دریافتی معتبر نمی باشد |
| 10 | شناسه پیام نامعتبر است. |
| 11 | تعداد پارامترها صحیح نمی باشد. |
| 12 | مقدار UDH نامعتبر است. |
| 13 | شماره گیرنده امکان دریافت پیامک تبلیغاتی ندارد. |
| جدول راهنمای کد وضعیت SMS های ارسالی | |
| کد وضعیت | توضیحات |
| 0 | نا مشخص |
| 1 | در صف ارسال |
| 2 | ارسال شده به مخابرات |
| 3 | رسيده به مخابرات |
| 4 | در صف مخابرات |
| 5 | پیام چند قسمتی بوده و یک یا چند قسمت آن هنوز ارسال نشده است. |
| 100 | ارسال با خطا |
| 101 | نرسيده به مخابرات |
| 102 | نرسيده به گوشي |
| 103 | پیام چند قسمتی بوده و بخشهایی از آن با خطا ارسال شده است. |
| 104 | قبل از ارسال لغو شده است. |
| 105 | شناسه نامعتبر است. |
| 1000 | رسيده به گوشي |