آدرسِ سرویس: https://sms-node.homacrm.com/Services/SMS/index.asmx · WSDL · health
این سرویس جایگزینِ یکبهیکِ سرویسِ قدیمیِ soap.negins.com/Services/SMS/index.asmx است؛ همان دو عملیات، همان پارامترها، همان کدهای برگشتی. کلاینت فقط آدرس را عوض میکند.
| پارامتر | نوع | الزامی | توضیح |
|---|---|---|---|
| PortalCode | int | بله | کدِ پرتال |
| Token | string | بله | توکنِ API پرتال |
| Mobile | string | بله | موبایلِ ۱۱ رقمی (۰۹…) |
| Message | string | بله | متنِ پیام |
| SenderNumber | string | بله | شمارهٔ خطِ فرستنده (خالی ⇒ کدِ −۲۱) |
| UseSharedBlacklist | bool | خیر | ارسال از مرجعِ اشتراکیِ BL (بدونِ جستوجوی خطوطِ پرتال) |
| ServerType, ReferenceID, NoDelivery, Flash | — | خیر | منسوخ — نادیده گرفته میشوند؛ اپراتور از روی SenderNumber تشخیص داده میشود |
خروجی (JSON داخلِ singleSMS_FULLResult): success, code (شناسهٔ پیام اگر > 10000، وگرنه کدِ خطا), message, recordID, senderNumber, referenceID, referenceType.
| پارامتر | نوع | الزامی | توضیح |
|---|---|---|---|
| PortalCode, Token | int, string | بله | مثلِ بالا |
| Mobiles | string[] | بله | گیرندهها |
| Messages | string[] | بله | یک متن برای همه، یا همطولِ Mobiles |
| SenderNumber | string | بله | خطِ فرستنده؛ نوعِ اپراتور از همین تشخیص داده میشود (۱ مگفا · ۴ آسانک/۰۲۱ · ۶ ارمغان/۵۰۰۰۴؛ مراجعِ BL به ۶ میروند) |
| UseSharedBlacklist | bool | خیر | مرجعِ اشتراکیِ BL |
| MagfaUserName/Password/ServiceURL/DelaySeconds · User021/Password021/ServiceURL021/Delay021Seconds · User50004/Password50004/ServiceURL50004/Delay50004Seconds | — | خیر | اعتبارِ اپراتور؛ اگر خالی باشد از تنظیماتِ سیستم پر میشود |
خروجی: success, code, message, recordIDs[] (بهازای هر گیرنده: شناسهٔ پیام اگر > 10000، وگرنه کدِ اپراتور).
| کد | معنی |
|---|---|
| > 10000 | موفق — شناسهٔ پیام |
| −1 / −9 / −10 | درخواستِ خالی / بدونِ گیرنده / بدونِ متن |
| −2 / −15 | توکن نامعتبر / خطای سرویسِ احراز |
| −4 | موبایل نامعتبر |
| −13 | نوعِ اپراتور یا اعتبارِ آن ناقص |
| −20 / −21 / −22 | شمارهٔ فرستنده نامعتبر یا WhoIs تأییدنشده / خالی / مرجعِ اشتراکی پیدا نشد |
| −6, −7, −3, −32…−35, −50…−70 | کدهای اعتبارسنجیِ ارسال (شارژ، بودجه، WhoIs، اپراتورِ غیرفعال…) |
| −4101 … −4113 | لایهٔ آسانک: خطای اپراتور / شبکه / آدرسِ نامعتبر / تایماوت / ردِ کلِ دسته / پاسخِ ناخوانا — از این نسخه، پیامِ −۴۱۱۲ status و errorMsg خودِ آسانک را هم دارد |
| −3101 / −3102 | مگفا: پاسخِ خالی / کدِ خطا |
| −99 / −9001 | استثنای موتور / خطای درگاه |
POST https://sms-node.homacrm.com/Services/SMS/index.asmx
Content-Type: text/xml; charset=utf-8
SOAPAction: "Http://soap.negins.com/singleSMS_FULL"
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<singleSMS_FULL xmlns="Http://soap.negins.com">
<req>
<PortalCode>10003385</PortalCode><Token>…</Token>
<Mobile>09121234567</Mobile><Message>سلام</Message>
<SenderNumber>3000854085</SenderNumber><UseSharedBlacklist>false</UseSharedBlacklist>
</req>
</singleSMS_FULL>
</soap:Body>
</soap:Envelope>
مستندِ استقرار و نگهداری: docs/DEPLOY.md در ریپوی Homa-OS/Nodes_smsAPI.