راهنمای استفاده از API ارسال SMS خدماتی

برای ارسال پیامک خدماتی ابتدا به حساب کاربری خود در Developer Center وارد شوید و کد hash خود را دریافت کنید. این کد یکتا بوده و در درخواست هایی که توسط API ارسال می کنید به عنوان نام کاربری و رمز عبور شما مورد استفاده قرار میگیرد. توجه داشته باشید که نگه داری از این hash بسیار مهم بوده و هرکسی در صورت دسترسی به hash string شما می تواند با اعتبار حساب کاربری شما اقدام به ارسال SMS کند.

 

انواع ارسال SMS خدماتی در DC میهن سرویس :

در میهن سرویس به صورت کلی ۲ نوع ارسال پیامک خدماتی می توان ارسال نمود :

verification : متن این نوع پیامک ها قبلا باید توسط شما در حساب DC شما ثبت شده و به تایید میهن سرویس برسد. این نوع پیام ها صرفا برای تولید یکبار رمز استفاده می شود و در مراحل verify نرم افزار شما قابل استفاده هستند.

notification : متن این نوع پیام ها توسط API به صورت مستقیم تعیین می شوند. این نوع پیامک ها برای اطلاع رسانی استفاده می شوند. مثلا در صورت ثبت سفارش در فروشگاه شما اطلاع رسانی به مشتری را باید با این روش انجام دهید. (این روش فعلا در میهن سرویس فعال نشده است.)

 

ارسال sms از نوع verification یا notification :

برای امکان ارسال پیامک مراحل زیر را انجام دهید :

۱- در صورتی که قبلا در میهن سرویس عضو نشده اید ، از این قسمت عضو میهن سرویس شود.

۲- سپس به حساب کاربری خود وارد شوید.

۲- در قسمت داشبورد حساب کاربری DC خود ،‌ کد hash خود را مشاهده می کنید. این کد را در محلی نگه دارید تا در مراحل بعدی از آن استفاده کنیم.

۳- از قسمت اپلیکیشن فرم ها ، ابتدا یک اپلیکیشن فرم ایجاد کنید. این فرم ها صرفا محلی برای ثبت متن پیامک شما هستند تا به تایید مدیر برسد. برای هر اپلیکیشن فرمی که ایجاد کنید یک ID تولید می شود که از این ID بعدا در API استفاده می کنید.

۴- منتظر تایید اپلیکیشن فرم خود توسط مدیر DC بمانید.

 

حالا همه چیزهای لازم برای ارسال پیامک توسط  API در اختیار شما قرار گرفته است. آدرس API میهن سرویس :

https://mihanservice.com/developers/api_sms

 

توضیحات استفاده از API :

۱- همه پارامتر های ارسالی به سمت API باید با متد POST ارسال شوند.

۲- خروجی API همیشه از نوع JSON میباشد.

۳- API به صورت Restful طراحی شده است.

۴- پارامتر های لازم برای ارسال SMS به صورت زیر است :

نام پارامتر مقدار
hash کد hash دریافتی از قسمت داشبورد حساب کاربری Developer Center میهن سرویس
appform_id کد ID اپلیکیشن فرم ساخته شده
to شماره موبایل دریافت کننده SMS

۵- در صورتی که نوع اپلیکیشن فرم شما notification باشد ، باید همزمان با POST مقادیر فوق ، سایر متغیرهایی که در متن SMS استفاده کردید را به صورت POST ارسال کنید.

 

۶- در صورت ارسال صحیح/خطا SMS خروجی به صورت زیر دریافت می کنید :

نام پارامتر مقدار
return در صورتی که success باشد به معنای ارسال صحیح و در صورت error بود به معنای برخوردن به خطاست
code کد وضعیت - اگر کمتر از 0 باشد به معنای کد خطا و در غیر اینصورت شناسه SMS ارسالی
text در صورت خطا دادن API شامل توضیح خطا - در حالت verification : در صورت موفق بود API شامل کد رندوم ارسال شده به کاربر - در حالت notification : متن ارسالی به کاربر

 

موفق باشید