Documentation de l'API de messagerie

Commencez ici

Votre première demande en quatre étapes

Configurer une boîte aux lettres dans le tableau de bord.

Copiez à la fois apikey et la boîte aux lettres apikeybox.

Envoyez un simple e-mail texte d'abord.

Ajoutez des pièces jointes ou des images intégrées uniquement après que la requête de base ait fonctionné.

Authentification

Conservez les informations d'identification sur votre serveur

Les points de terminaison de messagerie nécessitent l'apikey du compte et l'apikeybox spécifique à la boîte aux lettres. Stockez les deux informations d'identification côté serveur et masquez-les dans les journaux d'application.

POSTE

Envoyer un e-mail

ENDPOINThttps://api.smsmobileapi.com/sendemail/

Envoie un e-mail en texte brut ou HTML via une boîte aux lettres configurée.

Quand l'utiliser

Utilisez-le pour les e-mails transactionnels ou opérationnels à partir de votre application.

Paramètres

Nom	Taper	Exigence	Description
`apikey`	chaîne	Requis	Clé API de votre compte.
`apikeybox`	chaîne	Requis	Clé API de l'application configurée. boîte aux lettres.
`sender_name`	chaîne	Requis	Nom d'affichage de l'expéditeur.
`sender_email`	e-mail	Requis	Adresse e-mail de l'expéditeur.
`recipient_email`	e-mail	Requis	Adresse du destinataire.
`mail_subject`	chaîne	Requis	Objet de l'e-mail.
`mail_body`	chaîne	Requis	Texte brut ou corps HTML.
`allow_self_signed`	oui \| non	Requis	Défini sur oui uniquement lorsque le serveur de messagerie configuré utilise un certificat auto-signé interne de confiance.
`unsubscribe`	1	Facultatif	Ajoute des conditions de désabonnement et un lien.
`email_cc1`	e-mail	Facultatif	Premier destinataire CC facultatif.
`email_cc2`	e-mail	Facultatif	Deuxième destinataire CC facultatif.
`email_cc3`	e-mail	Facultatif	Troisième destinataire CC facultatif.
`attachmentBase64`	base64	Facultatif	Contenu de pièce jointe codé en Base64.
`charset`	chaîne	Facultatif	Jeu de caractères ; UTF-8 par défaut.
`embeddedImage`	URL HTTPS	Facultatif	Image à intégrer dans l'e-mail.
`embeddedImage_cid`	chaîne	Facultatif	Content-ID référencé à partir du corps HTML.
`format`	chaîne	Facultatif	Format de réponse demandé.
`reply_name`	chaîne	Facultatif	Nom d'affichage de la réponse.
`reply_email`	e-mail	Facultatif	Adresse de réponse.

Exemple de demande

boucle

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." \
  -d "allow_self_signed=no"

Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.

Clé de connexion ↑

Bien pour savoir

Préférez le POST car le corps des e-mails peut être long.
Les pièces jointes Base64 peuvent rendre les requêtes volumineuses ; appliquez des limites de taille raisonnables dans votre application.

OBTENIR

Récupérer des e-mails

ENDPOINThttps://api.smsmobileapi.com/getemail/

Récupère les messages d'un dossier de boîte aux lettres configuré.

Quand l'utiliser

Utilisez-le pour synchroniser les e-mails entrants dans un service d'assistance ou un flux de travail d'application.

Paramètres

Nom	Taper	Exigence	Description
`apikey`	chaîne	Requis	Clé API de votre compte.
`apikeybox`	chaîne	Requis	Clé API de boîte aux lettres.
`mbox`	chaîne	Requis	Dossier de boîte aux lettres, par exemple BOÎTE DE RÉCEPTION.
`start`	entier	Requis	Index de départ ; utilisez 0 pour la première page.

Exemple de demande

boucle

curl "https://api.smsmobileapi.com/getemail/?apikey=YOUR_API_KEY&apikeybox=YOUR_MAILBOX_KEY&mbox=INBOX&start=0"

Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.

Clé de connexion ↑

Bien pour savoir

Les réponses incluent le sujet, l'expéditeur, le destinataire, le corps, l'horodatage et les détails des pièces jointes.

OBTENIR

Vérifier les contacts non abonnés

ENDPOINThttps://api.smsmobileapi.com/email/unsubscribed/

Vérifie les enregistrements de désabonnement générés par les e-mails envoyés via la plateforme.

Quand l'utiliser

Utilisez-le avant d'envoyer des campagnes et lors de la synchronisation des listes de suppression.

Paramètres

Nom	Taper	Exigence	Description
`apikey`	chaîne	Requis	Clé API de votre compte.
`apikeybox`	chaîne	Requis	Clé API de boîte aux lettres.
`email`	e-mail	Facultatif	Filtrer un contact. Un résultat vide signifie qu'aucun enregistrement de désabonnement n'a été trouvé.

Exemple de demande

boucle

curl "https://api.smsmobileapi.com/email/unsubscribed/?apikey=YOUR_API_KEY&apikeybox=YOUR_MAILBOX_KEY&email=customer@example.net"

Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.

Clé de connexion ↑

Bien pour savoir

Gardez votre propre base de données de destinataires synchronisée avec les résultats de désabonnement.
Vous restez responsable des règles anti-spam et de confidentialité applicables.

Dépannage

Erreurs et tentatives sécurisées

Lisez l'état HTTP et le champ d'erreur JSON avant de réessayer. Ne réessayez pas les échecs de validation ou d'authentification sans d'abord corriger la demande.

HTTP	Code	Que faire
400	`missing_parameter`	Un paramètre obligatoire est vide ou absent. Vérifiez la table des paramètres du point de terminaison.
403	`invalid_apikey`	La clé API est inconnue, expirée ou non autorisée pour la fonctionnalité demandée.
429	`too_many_requests`	Les demandes arrivent trop rapidement. Attendez, puis réessayez avec un intervalle exponentiel.
500	`server_error`	Le service n'a pas pu terminer la demande. Conservez la réponse et contactez l'assistance si elle persiste.

Règle de nouvelle tentativeRéessayez uniquement les réponses 429 et 5xx transitoires. Commencez après 1 seconde, puis revenez à 2, 4 et 8 secondes.

Besoin d'aide ?

Apportez le contexte de la requête, pas vos secrets.

Partagez le point de terminaison, l'horodatage, l'état HTTP et la réponse nettoyée. N'incluez jamais de clés API, de jetons ou de contenu de message privé.

Contactez l'assistance API →