Maskyoo SMS Gateway API
Maskyoo SMS gateway provides several APIs to allow developers to integrate functionality of send and receive SMS messages into their systems.
Overview
The SMS Gateway supports multiple integration methods:
| Method | Description |
|---|---|
| REST Web Service API | Simple query parameters via URLs |
| Bulk SMS API | Send multiple SMS in one batch |
| SOAP Web Service API | XML based messages over HTTP(S) |
| Mail to SMS | Send SMS via email |
| Receive SMS API | Receive inbound SMS messages |
| Contacts API | Add and modify contacts |
| Senders API | Manage sender IDs |
| Credit API | Check account balance |
Prerequisites
Before using the API, ensure the following requirements are met:
| Requirement | Description |
|---|---|
| Active Account | You have an active Maskyoo service account |
| Internet Connection | Your server has connection to the internet |
| HTTP Protocol | Connection via TCP/IP port 80 or HTTP protocol (check firewall rules) |
| XML Parse Support | Your programming language supports XML parsing in UTF-8 Unicode format |
| ASCII Encoding | Special characters encoded according to URL encode standard (UTF-8) |
| Max SMS Length | Maximum incoming message length is 600 characters |
Authentication
Important
This service requires registration of requesting server IP on the account settings page. For enhanced security, we recommend using the Bearer token whenever possible.
Using Bearer Token
Add the token to the Authorization header:
Authorization: Bearer YOUR_TOKEN_HERE
Using Query Parameter
Alternatively, pass the token as a query parameter:
?token=YOUR_TOKEN_HERE
For information on obtaining your API token, see API Token Guide.
השפעות על המערכת
ה‑SMS Gateway מקשר בין שליחה חיצונית לבין התשתיות הפנימיות של מסקיו:
- קרדיט — כל הודעה שנשלחת מורידה נקודה מחשבון ה‑SMS; חשבון ללא קרדיט לא ישלח הודעות
- דו״ח התראות — כל הודעה נשלחת נרשמת ב‑_notifications ונראית בדוח ההתראות, כולל ב‑widget של הלוח בקרה
- sender IDs — שליחה חייבת להשתמש בשם שולח מאושר (מתבצע ב‑
/senders); שימוש בשם לא מאושר יידחה - שיטות אינטגרציה — REST (ערוץ ראשי), SOAP (legacy), Bulk, Mail‑to‑SMS, Webhooks לקבלת הודעות
- אוטומציה — הודעה נכנסת יכולה להפעיל אירוע
sms_receiveולהעביר את הנתונים לרולאוטומציה