Buraya başlayın
İlk isteğiniz dört adımda
Panoda bir posta kutusu yapılandırın.
Hem apikey hem de posta kutusu apikeybox'ı kopyalayın.
İlk önce basit bir metin e-posta gönderin.
Temel istek işlerinden sonra eks veya gömülü görüntüler ekleyin.
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ı.
Kimlik doğrulama
Kimlik bilgilerini sunucunuzda tutun
E-posta uç noktaları hesabı apikey ve posta kutusu-spinanbox gerektirir. Hem kimlik bilgilerini sunucuya hem de onları uygulama loglarında maskeleyin.
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.
Nasıl istek id çalışır
- 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.
- Tamamlandığında, operasyon sona erer. ID'sini yeniden kullanmak yeni gelen kayıtları silmenin yerine aynı sonucu döndürür. Sadece kasıtlı olarak yeni bir temizlik için yeni bir kimlik kullanın.
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.
POST için, form gövdesinde veya JSON nesnesinde tüm parametreleri gönderin, asla sorgu dizesinde. Bilinmeyen parametreler reddedilir; tarih veya mobil filtreler desteklenmez.
Tarih için kimlik doğrulama son noktaları
Birpikey veya bir Yazarlaşma kullanın: SMSMobileAPI OAuth2 tarafından yayınlanan Ayırma erişim. Bir yenileme token veya bir API anahtarını bir Ayıer token olarak göndermeyin. Açıklamalanmış jetonlar reddedilir.
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 bu operasyon tarafından kaldırıldı. Seçilen at start ilk seçimdir; protected at start dışlanmış kayıtlardır. Bağlantılı kayıtları saymak için önbellek kullanma işlemini, linked=1 dahil olduğunda bile.
{
"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: formatı kontrol edin. 404 REQUEST NOT FOUND: Bu ID için hiçbir operasyon mevcut değildir, API anahtar ve tarih.
- 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.
POSTALAMAK
Bir e-posta gönder
https://api.smsmobileapi.com/sendemail/yapılandırılmış bir posta kutusu aracılığıyla düz metin veya HTML e-posta gönderin.
Uygulamanızdan işlem veya operasyonel e-posta için kullanın.
Parametreler
| Ad | Tür | Gereklilik | Tanım |
|---|---|---|---|
apikey |
dize | Gerekli | Hesabınız API anahtarı. |
apikeybox |
dize | Gerekli | API, yapılandırılmış posta kutusunun anahtarı. |
sender_name |
dize | Gerekli | Göndererin ekran adı. |
sender_email |
e-posta | Gerekli | Sender email adresi. |
recipient_email |
e-posta | Gerekli | Recipient adresi. |
mail_subject |
dize | Gerekli | E-posta konusu. |
mail_body |
dize | Gerekli | Plain text veya HTML vücudu. |
allow_self_signed |
Evet | hayır | Gerekli | Sadece yapılandırılmış posta sunucusu güvenilir bir içsel kendi imzalı sertifika kullandığında evet'ye ayarlayın. |
unsubscribe |
1 | Seçmeli | Kayıtsız şartlar ve bir bağlantı ekleyin. |
email_cc1 |
e-posta | Seçmeli | İlk Seçmeli CC alıcısı. |
email_cc2 |
e-posta | Seçmeli | İkinci Seçmeli CC alıcısı. |
email_cc3 |
e-posta | Seçmeli | Üçüncü Seçmeli CC alıcısı. |
attachmentBase64 |
baz64 | Seçmeli | Base64 kodlu ek içeriği. |
attachmentBase64_name_1 |
Dosya adı | Seçmeli | Örneğin, kayıt için eklenti dosyasını adı.pdf. EkBase64'ün bir değeri olduğunda gerekli. |
charset |
dize | Seçmeli | Karakter seti; varsayılan UTF-8. |
embeddedImage |
HTTPS URL URL URL | Seçmeli | E-postaya gömülmek için resim. |
embeddedImage_cid |
dize | Seçmeli | HTML vücuttan gelen içerik-ID referans. |
format |
dize | Seçmeli | İstekli yanıt formatı. |
reply_name |
dize | Seçmeli | Reply-to display name. |
reply_email |
e-posta | Seçmeli | Cevap: "You" (İngilizce). |
Örneğin
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"
Bu isteği çalıştırmak ister misiniz?API anahtarını interaktif testleyiciyi kilidini açmak için sayfanın başında bağlayın.
Anahtarı bağlayın ↑- POST'yi tercih edin çünkü e-posta organları uzun olabilir.
- Eğer ekBase64 sağlanırsa, ekBase64 name 1 gereklidir ve dosya uzatmasını içermelidir.
- Base64 ekleri büyük talep edebilir; uygulamanızda mantıklı boyut sınırları uygulayın.
ELDE ETMEK
Erişim e-postaları
https://api.smsmobileapi.com/getemail/yapılandırılmış bir posta kutusu klasöründen gelen mesajlar.
Bir yardım masası veya uygulama akışına bağlı e-postayı senkronize etmek için kullanın.
Parametreler
| Ad | Tür | Gereklilik | Tanım |
|---|---|---|---|
apikey |
dize | Gerekli | Hesabınız API anahtarı. |
apikeybox |
dize | Gerekli | Mailbox API anahtarı. |
mbox |
dize | Gerekli | Mailbox klasörü, örneğin INBOX. |
start |
Tamsa | Gerekli | indekse başlayın; ilk sayfa için 0 kullanın. |
Örneğin
curl "https://api.smsmobileapi.com/getemail/?apikey=YOUR_API_KEY&apikeybox=YOUR_MAILBOX_KEY&mbox=INBOX&start=0"
Bu isteği çalıştırmak ister misiniz?API anahtarını interaktif testleyiciyi kilidini açmak için sayfanın başında bağlayın.
Anahtarı bağlayın ↑- Yanıtlar mevcut konu, gönderici, alıcı, vücut, zamantamp ve ek ayrıntılar içerir.
ELDE ETMEK
Check unsubscribed contact
https://api.smsmobileapi.com/email/unsubscribed/Platform aracılığıyla gönderilen e-postalarla oluşturulan abonelik kayıtları kontrol eder.
Kampanya göndermeden önce kullanın ve baskı listeleri senkronize ederken.
Parametreler
| Ad | Tür | Gereklilik | Tanım |
|---|---|---|---|
apikey |
dize | Gerekli | Hesabınız API anahtarı. |
apikeybox |
dize | Gerekli | Mailbox API anahtarı. |
email |
e-posta | Seçmeli | Filtre bir iletişim. Boş bir sonuç, hiç bir giriş kaydının bulunulmadığını anlamına gelir. |
Örneğin
curl "https://api.smsmobileapi.com/email/unsubscribed/?apikey=YOUR_API_KEY&apikeybox=YOUR_MAILBOX_KEY&email=customer@example.net"
Bu isteği çalıştırmak ister misiniz?API anahtarını interaktif testleyiciyi kilidini açmak için sayfanın başında bağlayın.
Anahtarı bağlayın ↑- Kendi alıcı veritabanınızı iptal sonuçları ile senkronize edin.
- Geçerli anti-spam ve gizlilik kurallarından sorumlu kalırsınız.
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.
Parametreler
| Ad | Tür | Gereklilik | Tanım |
|---|---|---|---|
apikey |
dize | Seçmeli | Gerekli olmadan Gerekli OAuth2. with . with OAuth2, Seçmeli olarak bir an seçin API Aynı hesaba ait anahtar. |
action |
Tanıtım | silin | durum | Seçmeli | 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 | Seçmeli | 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 |
dize | Seçmeli | 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. |
Örneğin
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"Örnek yanıt
{
"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
}
}
Bu isteği çalıştırmak ister misiniz?API anahtarını interaktif testleyiciyi kilidini açmak için sayfanın başında bağlayın.
Anahtarı bağlayın ↑- 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.
Sorun giderme
Hatalar ve güvenli yenidenrries
HTTP statüsünü ve JSON hata alanını yeniden denemeden önce okuyun. İstekyi ilk önce düzeltmeden doğrulama veya doğrulama başarısızlıklarını yeniden denemeyin.
| HTTP | Kod Kodu Kodu | Ne yapmalı |
|---|---|---|
| 400 | missing_parameter | Gerekli bir parametre boş veya yok. Son nokta için parametre masasına göz atın. |
| 403 | invalid_apikey | API anahtarı bilinmemektedir, süresiz veya talep edilen özellik için yetkili değildir. |
| 429 | too_many_requests | İstekler çok hızlı geliyor. Bekle, sonra üst üste tekrar tekrarla. |
| 500 | server_error | Hizmet isteği tamamlayamadı. Devam ederse yanıt ve iletişim desteği tutun. |
Yardıma mı ihtiyacınız var?
İstek bağlamını getir - sırlarınız değil.
Son noktayı paylaşın, zamantamp, HTTP durumu ve sanitized yanıt. API anahtarlarını, jetonları veya özel mesaj içeriğini asla dahil etmeyin.
