Buraya başlayın
Your first request in four steps
Configure a mailbox in the dashboard.
Copy both apikey and the mailbox apikeybox.
Send a simple text email first.
Add attachments or embedded images only after the basic request works.
BU API İÇİN WEBHOOK V2
İş akışınızın ihtiyaç duyduğu mobil olaylara abone olun.
Bir hedef her şeyi alabilir ya da üretim sistemlerini, analizleri ve operasyonel uyarıları ayırabilirsiniz. Her olayın kesin bir adı vardır, böylece uygulamanız onu öngörülebilir şekilde işleyebilir.
email.sentE-posta gönderildi
SMSMobileAPI tarafından bir e-posta gönderme isteği oluşturuldu.
email.receivedE-posta alındı
Bağlı bir posta kutusu bir e-posta aldı.
Authentication
Keep credentials on your server
Email endpoints require the account apikey and the mailbox-specific apikeybox. Store both credentials server-side and mask them in application logs.
Tarih Yönetimi
Clear history güvenle: önizleme, silme, ilerleme
Bu uç noktaları, API anahtarınız için seçilen sunucu tarihini, telefonlarda veya dış hizmetlerde mesaj vermemektedir. Hesap süresi sağlamazlar. Yeni aktivite, yıkımdan sonra görünebilir.
request_id ve yeniden deneme rehberi
Varsayılan olarak, bağlantılı veya işleme kayıtları görünür. Sadece sadece sadece kullanım kullanımı kullanın include_linked=1 Bu entegrasyonları kabul ederseniz veya devam eden işleme çalışmayı durdurabilir.
How request_id works
- action=preview ile olan sayıların bir göstergesi. request_id gerekli değildir ve kayıtları silinmez.
- Genrate a unique request_id Yeni bir deletion için, örneğin bir UUID. Onu göndermeden önce kurtar action=delete.
- Yeniden geziler, zamanlar veya HTTP 202, aynı şeyi tekrarlayın API Anahtar, tarih uç noktası, request_id ve include_linked değer. Bir hatadan sonra otomatik olarak yeni bir kimlik üretmeyin.
- When completed=true, the operation is finished. Reusing its ID returns the same result instead of deleting newly arrived records. Use a new ID only for a deliberately new cleanup.
request_id Deletion işleminizi tanımlayın, bireysel bir birey değil SMSİzinli format: 16-128 ASCII mektuplar, basamaklar, hipnozlar veya alt işaretler. A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A A UUID Kripto.randomUUID() ile üretilen uygun.
Silme işlemi gruplar halinde yürütülür. HTTP 202 ile continue_required=true dönerse 3 saniye sonra action=delete isteğini tekrarlayın. Arka planda cron çalışmaz. action=status yalnızca ilerlemeyi okur ve HTTP 200 dönse bile silmeyi sürdürmez.
Deletion ve durum örnekleri
Başlangıçta kendi eşsiz değerinizle request_id örneklerini değiştirin. Aşağıdaki silekler gerçek hesap tarihini değiştirir; onlar önizleme değildir.
curl -X POST "https://api.smsmobileapi.com/delete-history-email/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=delete" -d "include_linked=0" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"curl -X POST "https://api.smsmobileapi.com/delete-history-email/" \
-H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
-d "action=delete" -d "include_linked=0" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"curl -G "https://api.smsmobileapi.com/delete-history-email/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=status" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"GET Ayrıca kabul de kabul kabul de kabul action=preview veya veya action=delete. POST önerilir: URL parametreleri tarayıcı tarihine ve sunucu loglarına sızdırılabilir. Asla bir halk bağlantı, görüntü veya prefetch'de bir deletion URL'yi yerlemeyin.
For POST, send all parameters in the form body or a JSON object, never in the query string. Unknown parameters are rejected; date or mobile filters are not supported.
Tarih için kimlik doğrulama son noktaları
Use apikey or an Authorization: Bearer access token issued by SMSMobileAPI OAuth2. Do not send a refresh token or an API key as a Bearer token. Expired tokens are refused.
Alanlar ayarlandığında, history:read önizleme /status ve izin verir history:delete Ayrıca deletion izin verir. Hem token hem de tokenler OAuth müşteri uygulanır. kapsamı olmayan Legacy Jetonlar mevcut hesap erişimlerini korur.
OAuth2 Benzersiz birincil birincil seçin API anahtar. Birkaç birincil anahtar var ise, aynı zamanda da sağlar apikey Hesabına ait birini seçmek. Orta anahtarlar asla birincil anahtar tarihine erişmez.
Devam etmeden önce cevabı okuyun
count_delete is the cumulative number removed by this operation. selected_at_start is the initial selection; protected_at_start counts excluded records. Use preview.linked_or_processing to count linked records even when include_linked=1.
{
"result": {
"error": 0,
"history": "email",
"action": "delete",
"request_id": "6d54ac58-41f1-4fbc-9a39-6e6c86089451",
"status": "processing",
"completed": false,
"count_delete": 100,
"total_before": 250,
"selected_at_start": 200,
"protected_at_start": 50,
"include_linked": 0,
"continue_required": true,
"message": "Repeat GET or POST with the same request_id and include_linked to continue. Status requests do not run deletion."
}
}- completed=true ile 200: bit. Sadece 200 önizleme veya durum yanıtı tamamlanmamıştır.
- 400 INVALID_REQUEST_ID: check the format. 404 REQUEST_NOT_FOUND: no operation exists for this ID, API key and history.
- 401: geçersiz veya süresiz kimlikler. 403: yetersiz OAuth kapsamı veya yetkisiz hesabı.
- 409 HISTORY_BUSY: Başka bir temizlik çalışır; orijinal müşteriden devam edin. 409 INCLUDE_LINKED_CONFLICT: Orijinal include_linked değerini geri yükleyin.
- 409 OAUTH_ACCOUNT_AMBIGUOUS: Bir an için API Bu hesaba ait anahtar.
- 503 veya ağ kesintisi: Bazı partiler zaten tamamlanmış olabilir. Kontrol konfigürasyonu, sonra orijinal ile yeniden başa çıkmak request_id. Geçici bir işlem otomatik olarak yaratmaz.
POST
Send an email
https://api.smsmobileapi.com/sendemail/Sends plain-text or HTML email through a configured mailbox.
Use it for transactional or operational email from your application.
Parameters
| Ad | Type | Requirement | Description |
|---|---|---|---|
apikey |
string | Required | Your account API key. |
apikeybox |
string | Required | API key of the configured mailbox. |
sender_name |
string | Required | Display name of the sender. |
sender_email |
Required | Sender email address. | |
recipient_email |
Required | Recipient address. | |
mail_subject |
string | Required | Email subject. |
mail_body |
string | Required | Plain text or HTML body. |
allow_self_signed |
yes | no | Required | Set to yes only when the configured mail server uses a trusted internal self-signed certificate. |
unsubscribe |
1 | Optional | Adds unsubscribe terms and a link. |
email_cc1 |
Optional | First optional CC recipient. | |
email_cc2 |
Optional | Second optional CC recipient. | |
email_cc3 |
Optional | Third optional CC recipient. | |
attachmentBase64 |
base64 | Optional | Base64-encoded attachment content. |
attachmentBase64_name_1 |
filename | Optional | Original attachment file name with extension, for example invoice.pdf. Required when attachmentBase64 has a value. |
charset |
string | Optional | Character set; default UTF-8. |
embeddedImage |
HTTPS URL | Optional | Image to embed in the email. |
embeddedImage_cid |
string | Optional | Content-ID referenced from the HTML body. |
format |
string | Optional | Requested response format. |
reply_name |
string | Optional | Reply-to display name. |
reply_email |
Optional | Reply-to address. |
Request example
curl -X POST "https://api.smsmobileapi.com/sendemail/" \
-d "apikey=YOUR_API_KEY" \
-d "apikeybox=YOUR_MAILBOX_KEY" \
--data-urlencode "sender_name=Example Team" \
-d "sender_email=team@example.com" \
-d "recipient_email=customer@example.net" \
--data-urlencode "mail_subject=Order confirmation" \
--data-urlencode "mail_body=Your order has been confirmed." \
--data-urlencode "attachmentBase64=BASE64_FILE_CONTENT" \
-d "attachmentBase64_name_1=invoice.pdf" \
-d "allow_self_signed=no"
Want to run this request? Connect your API key at the top of the page to unlock the interactive tester.
Connect key ↑- Prefer POST because email bodies can be long.
- If attachmentBase64 is provided, attachmentBase64_name_1 is required and must include the file extension.
- Base64 attachments can make requests large; apply sensible size limits in your application.
GET
Retrieve emails
https://api.smsmobileapi.com/getemail/Retrieves messages from a configured mailbox folder.
Use it to synchronize inbound email into a help desk or application workflow.
Parameters
| Ad | Type | Requirement | Description |
|---|---|---|---|
apikey |
string | Required | Your account API key. |
apikeybox |
string | Required | Mailbox API key. |
mbox |
string | Required | Mailbox folder, for example INBOX. |
start |
integer | Required | Starting index; use 0 for the first page. |
Request example
curl "https://api.smsmobileapi.com/getemail/?apikey=YOUR_API_KEY&apikeybox=YOUR_MAILBOX_KEY&mbox=INBOX&start=0"
Want to run this request? Connect your API key at the top of the page to unlock the interactive tester.
Connect key ↑- Responses include available subject, sender, recipient, body, timestamp and attachment details.
GET
Check unsubscribed contacts
https://api.smsmobileapi.com/email/unsubscribed/Checks unsubscribe records generated by emails sent through the platform.
Use it before sending campaigns and when synchronizing suppression lists.
Parameters
| Ad | Type | Requirement | Description |
|---|---|---|---|
apikey |
string | Required | Your account API key. |
apikeybox |
string | Required | Mailbox API key. |
email |
Optional | Filter one contact. An empty result means no unsubscribe record was found. |
Request example
curl "https://api.smsmobileapi.com/email/unsubscribed/?apikey=YOUR_API_KEY&apikeybox=YOUR_MAILBOX_KEY&email=customer@example.net"
Want to run this request? Connect your API key at the top of the page to unlock the interactive tester.
Connect key ↑- Keep your own recipient database synchronized with unsubscribe results.
- You remain responsible for applicable anti-spam and privacy rules.
POST · GET
Gönderilen e-posta geçmişini temizle
https://api.smsmobileapi.com/delete-history-email/Clears bu e-posta loglarını bu nedenle gönderdi API posta kutularının anahtarı. Bir posta kutusunda mesajları silmiyor. Hayır hayır hayır hayır hayır apikeybox Gereklidir.
İlk önce önizleme kullanın, sayıları kontrol edin, sonra açıkça istek delesyon. Bu, seçilen tüm tarihi açıklar API Anahtar, tarih olmadan, telefon veya mesaj filtreleri.
Parameters
| Ad | Type | Requirement | Description |
|---|---|---|---|
apikey |
string | Optional | Gerekli olmadan Gerekli OAuth2. with . with OAuth2, Seçmeli olarak bir an seçin API Aynı hesaba ait anahtar. |
action |
preview | delete | status | Optional | preview silmeden sayar; delete silmeyi başlatır veya sürdürür; status yalnızca ilerlemeyi gösterir. API varsayılanı delete, bu test aracının varsayılanı preview değeridir. |
include_linked |
0 | 1 | Optional | Varsayılan 0: Bağlantılı veya işleme kayıtlarını tut. Onları içerecek 1 set, kırılma entegrasyonları riski ile. Bu değeri bir delesyon devam ederken değişmeden tutun. |
request_id |
string | Optional | delete ve status için zorunlu, preview için isteğe bağlıdır. 16–128 ASCII harfi, rakam, kısa çizgi (-) veya alt çizgi (_) kullanın. Her yeni silme işlemi için benzersiz bir ID oluşturun ve tüm yeniden denemelerde aynı ID’yi koruyun. Bu bir mesaj ID’si veya API anahtarı değildir. |
Request example
curl -X POST "https://api.smsmobileapi.com/delete-history-email/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=preview" -d "include_linked=0"
Deletion ve durum örnekleri
Başlangıçta kendi eşsiz değerinizle request_id örneklerini değiştirin. Aşağıdaki silekler gerçek hesap tarihini değiştirir; onlar önizleme değildir.
curl -X POST "https://api.smsmobileapi.com/delete-history-email/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=delete" -d "include_linked=0" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"curl -X POST "https://api.smsmobileapi.com/delete-history-email/" \
-H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
-d "action=delete" -d "include_linked=0" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"curl -G "https://api.smsmobileapi.com/delete-history-email/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=status" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"Example response
{
"result": {
"error": 0,
"history": "email",
"action": "preview",
"total": 120,
"simple": 100,
"linked_or_processing": 20,
"selected": 100,
"include_linked": 0,
"operation_in_progress": false,
"active_include_linked": null
}
}
Want to run this request? Connect your API key at the top of the page to unlock the interactive tester.
Connect key ↑- Yukarıdaki örnek bir önbellek değil, bir deletion. Kontlar açıklayıcıdır; kesin seçim, yıkım başladığında sabitlenir.
- include_linked=1 Bu kesintiyi bozabilir GHL, Zapier, otomasyonlar, Ücretli bağlantılar veya teslimat izleme. Asla hesap mülkiyeti veya depolama bütünlüğü kontrollerini atlamıyor.
Troubleshooting
Errors and safe retries
Read the HTTP status and the JSON error field before retrying. Do not retry validation or authentication failures without correcting the request first.
| HTTP | Code | What to do |
|---|---|---|
| 400 | missing_parameter | A required parameter is empty or absent. Check the parameter table for the endpoint. |
| 403 | invalid_apikey | The API key is unknown, expired or not authorized for the requested feature. |
| 429 | too_many_requests | Requests are arriving too quickly. Wait, then retry with exponential backoff. |
| 500 | server_error | The service could not complete the request. Keep the response and contact support if it persists. |
Need help?
Bring the request context—not your secrets.
Share the endpoint, timestamp, HTTP status and sanitized response. Never include API keys, tokens or private message content.
Official mobile application
The secure bridge between your phone, dashboard and API.
SMS and call operations pass through the official SMSMobileAPI app installed on your connected phone. The app securely pairs the device with your account, synchronizes authorized events and links the mobile network to the dashboard and REST API.
- Signed releases distributed through the official Google Play and Apple App Store listings
- Google and Apple platform review, signing and distribution controls
- Secure device pairing, HTTPS transport and authenticated API access
- Only the permissions required for the mobile features you enable


