SendMessage
از این متد برای ارسال یک پیام به چندین گیرنده استفاده می‌شود.
پارامترهای ورودی متد
در زیر هر یک از پارامترهاي ورودي و خروجی تشریح شده است.
| نام پارامتر ورودی | نوع پارامتر | توضیح |
|---|---|---|
| username | string | نام کاربری |
| password | string | کلمه عبور وب سرویس |
| senderNumber | string | شماره پیامکی |
| recipientNumbers | string[] | شماره موبایل گیرنده ها. حداکثر 100 شماره |
| message | string | متن پیام |
| saveType | integer | نوع ذخیره پیامک در گوشی. برخی از اپراتورها این مقدار را نادیده میگیرند. 0: در گوشی ذخیره نشود (فلش) 1: در گوشی ذخیره شود (نرمال) |
خروجی متد
خروجی متد آرایه‌ای از رشته‌ها است. تعداد عناصر این آرایه برابر با تعداد عناصر آرایه شماره‌های گیرندگان (پارامتر ورودی) است.
هر عنصر آرایه از دو بخش تشکیل شده است که با کاما از هم جدا شده‌اند:
- وضعیت ارسال
- شناسه پیام
مثلا در یک ارسال موفق به دو گیرنده، خروجی متد مانند زیر است:
["0,654321" , "0,123456"]
اگر خطایی رخ دهد (مانند اینکه کاربر اعتبار کافی ندارد)، کد خطا در قالب یک آرایه تک‌عنصری برگردانده می‌شود (به جدول کدهای خطا مراجعه کنید).
["ERROR_11"]
کد وضعیت های ارسال
وضعیت ارسال شامل مقادیر زیر می باشد:
| وضعیت | توضیح |
|---|---|
| 0 | با موفقیت ارسال شد |
| 1 | گیرنده در لیست سیاه مخابرات است |
| 2 | شماره موبایل معتبر نمی باشد |
| 3 | در صف ارسال قرار گرفت |
| 4 | ارسال نشود |
| 5 | منتظر تایید |