RCS

Pour activer cette fonctionnalité merci de contacter l'équipe technique

URL

POST https://api.smspartner.fr/v1/rcs/send

La plateforme n’envoie pas de SMS commerciaux entre 20h et 8h en semaine et les dimanches et jours fériés (restriction légale). Si un message SMS est envoyé, le message est en pause jusqu’au prochain jour ouvrable à 8h. Vous n’envoyez pas de SMS commerciaux ? Contactez nous pour désactiver cette restriction : help@smspartner.fr

Rate limit : 30 requêtes / 60 secondes

Paramètres obligatoires

Nom

Valeur

apiKey

Votre clé API.

phoneNumbers

Numéros de téléphone des destinataires. Pour l'envoi de plusieurs SMS les numéros doivent être séparés par des virgules. La limite d'envoi sur une seule requête est de 500 numéros. Ils peuvent être : au format national (06xxxxxxxx) ou international (+336xxxxxxxx), pour des numéros français ; au format international (+496xxxxxxxx), pour des numéros hors France.

isUnicode

1

richContent

Le contenu enrichi du message RCS. Voir la section Contenu enrichi. Obligatoire, sauf si modelToken est fourni (voir Envoyer à partir d'un modèle).

Paramètres optionnels

Nom

Valeur

modelToken

Identifiant (32 caractères) d'un modèle RCS enregistré sur la plateforme. À utiliser à la place de richContent : le contenu du message provient alors du modèle. Voir la section Envoyer à partir d'un modèle. Récupérable dans Modèles de message (colonne « Identifiant ») ou dans la fiche du modèle (panneau « Identifiant API »). Seuls les modèles de type RCS (texte, carte enrichie, carrousel, fichier) possèdent un identifiant ; les modèles SMS ne sont pas utilisables ici. modelToken et richContent sont mutuellement exclusifs.

scheduledDeliveryDate

(Déprécié) Date d'envoi du SMS, au format dd/mm/YYYY. À définir uniquement si vous souhaitez que les SMS soient envoyés en différé.

time

(Déprécié) Heure d'envoi du SMS (format 0-24), obligatoire si scheduledDeliveryDate est défini.

minute

(Déprécié) Minute d'envoi du SMS (format 0-55, par intervalle de cinq minutes), obligatoire si scheduledDeliveryDate est défini.

urlResponse

Url de retour des évènements RCS (ex : http://www.monurldereponse) — Les clics — Les lectures — Les demandes de désinscription (STOP) — Les réponses des destinataires.

urlDlr

Url de retour des accusés de réception (ex : http://www.monurldedlr).

scheduledAt

Permet de différer l'envoi du SMS, en une seule valeur, sous deux formes possibles : 1. Date absolue — formats acceptés : – 2026-05-20 10:15 ou 2026-05-20 10:15:00 – 2026-05-20T10:15:00 (ISO 8601) – 20/05/2026 10:15 – 2026-05-20 ou 20/05/2026 (envoi à minuit ce jour-là) 2. Délai relatif — envoi dans X unités de temps à partir de maintenant : – +10 minutes, +2 hours, +3 days, +1 week, +1 month (anglais) – +10 minutes, +2 heures, +3 jours, +1 semaine, +1 mois, +1 an (français, avec abréviations tolérées : min, mn, h, j, hrs) – Le + est optionnel (10 minutes équivaut à +10 minutes) Comportement : – Si scheduledAt est renseigné, il remplace les anciens paramètres scheduledDeliveryDate / time / minute (conservés pour rétrocompatibilité, mais scheduledAt est désormais recommandé). – L'horaire calculé est arrondi au créneau de 5 minutes supérieur (un envoi n'est programmable que toutes les 5 minutes : 10h15, 10h20, 10h25...). – La date obtenue doit être dans le futur, et au maximum 3 mois à l'avance. Exemple : { "apiKey": "xxxxx", "phoneNumbers": "+33600000000", "message": "Votre rendez-vous approche", "scheduledAt": "+2 hours" } Erreurs : si le format n'est reconnu ni comme date absolue ni comme délai relatif, ou si la date résolue est dans le passé / au-delà de 3 mois, l'API renvoie le code d'erreur 49 avec un message explicite.

Contenu enrichi

{
    "apiKey": "",
    "isUnicode": 1,
    "phoneNumbers": [
        "+33....."
    ],
    "richContent": {
        "conversation": {
            "text": "",
            "suggestions": [
                //Voir la section suggestions (4 maximum)
            ]
        }
    },

    //optionnel : Permet d'envoyer un SMS si le RCS n'est pas accepté sur l'appareil du destinataire
    "failover": {
        "sender": "...",
        "message": "ceci est un sms de basculement"
    }
}

{
    "apiKey": "",
    "phoneNumbers": [
        ""
    ],
    "isUnicode": 1,
    "richContent": {
        "conversation": {
            "file": {
                "media": {
                    "fileUrl": ""
                }
            },
            "suggestions": [
                //Voir la section suggestions (4 maximum)
            ]
        }
    },
    //optionnel : Permet d'envoyer un SMS si le RCS n'est pas accepté sur l'appareil du destinataire
    "failover": {
        "sender": "...",
        "message": "ceci est un sms de basculement"
    }
}

{
    "apiKey": "",
    "phoneNumbers": [
        ""
    ],
    "isUnicode": 1,
    "richContent": {
        "conversation": {
            "richCard": {
                "orientation": "VERTICAL", //VERTICAL ou HORIZONTAL
                "thumbnailImageAlignment": "LEFT", //Seulement si orientation == HORIZONTAL, LEFT ou RIGHT
                "title": "", //200 caractères maximum
                "description": "", //500 caractères maximum
                "media": {
                    "height": "MEDIUM", //uniquement si orientation == VERTICAL
                    "mediaUrl": ""
                },
                "suggestions": [
                    //Voir la section suggestions (4 maximum)
                ]
            },

            //suggestions globales (8 maximum)
            "suggestions": [
                //Voir la section suggestions (8 maximum)
            ]
        }
    },

    //optionnel : Permet d'envoyer un SMS si le RCS n'est pas accepté sur l'appareil du destinataire
    "failover": {
        "sender": "...",
        "message": "ceci est un sms de basculement"
    }
}

{
    "apiKey": "",
    "phoneNumbers": [
        ""
    ],
    "isUnicode": 1,
    "richContent": {
        "conversation": {
            "carousel": {
                "cardWidth": "MEDIUM", //MEDIUM ou SMALL

                // 8 cartes maximum
                "cards": [
                    {
                        "title": "", //200 caractères maximum
                        "description": "", //500 caractères maximum
                        "media": {
                            "height": "MEDIUM",
                            "mediaUrl": ""
                        },
                        "suggestions": [
                            //Voir la section suggestions (4 maximum)
                        ]
                    },
                    {
                        "title": "", //200 caractères maximum
                        "description": "", //500 caractères maximum
                        "media": {
                            "height": "MEDIUM",
                            "mediaUrl": ""
                        },
                        "suggestions": [
                            //Voir la section suggestions (4 maximum)
                        ]
                    }
                ]
            },

            //suggestions globales (8 maximum)
            "suggestions": [
                //Voir la section suggestions (8 maximum)
            ]
        }
    },

    //optionnel : Permet d'envoyer un SMS si le RCS n'est pas accepté sur l'appareil du destinataire
    "failover": {
        "sender": "...",
        "message": "ceci est un sms de basculement"
    }
}

Suggestions

{
    "reply": {
        "text": "Réponse 2",
        "postbackData": "postback_..." //Valeur unique qui sera envoyée en réponse à une suggestion.
    }
}

{
    "action": {
        "text": "Open SMSPartner",
        "postbackData": "postback_...", //Valeur unique qui sera envoyée en réponse à une suggestion.
        "openUrlAction": {
            "url": "https://www.smspartner.fr", //URL qui s'ouvrira sur le téléphone lorsque la suggestion est sélectionnée. URI valide au sens de la RFC 3986. Tous les formats d'URI ne sont pas pris en charge par tous les réseaux.
            "application": "WEBVIEW", //optionnel : BROWSER (défaut, navigateur externe) ou WEBVIEW (fenêtre intégrée à la conversation)
            "webviewViewMode": "FULL", //requis si WEBVIEW : FULL (plein écran), HALF (moitié) ou TALL (3/4)
            "description": "Site SMSPartner" //optionnel : texte d'accessibilité, 100 caractères maximum, recommandé en WEBVIEW
        }
    }
}

Voir la section Ouverture d'une URL en WebView pour le détail des paramètres.

{
    "action": {
        "text": "Appeler SMSPartner",
        "postbackData": "postback_...", //Valeur unique qui sera envoyée en réponse à une suggestion.
        "dialAction": {
            "phoneNumber": "+33......." //Numéro de téléphone valide
        }
    }
}

{
    "action": {
        "text": "Emplacement",
        "postbackData": "postback_...", //Valeur unique qui sera envoyée en réponse à une suggestion.
        "viewLocationAction": {
            "label": "Ici !!!", //Label de l'emplacement.
            "latLong": {
                "latitude": 2.4220188, //Latitude du lieu
                "longitude": -122.0844786 //Longitude du lieu
            }
        }
    }
}

Ouverture d'une URL en WebView

L'action « Ouvrir une URL » (openUrlAction) peut ouvrir le lien dans une WebView intégrée à la conversation au lieu du navigateur externe, grâce à des paramètres optionnels.

Ces paramètres sont facultatifs et rétrocompatibles : sans eux, le lien s'ouvre dans le navigateur (application = BROWSER).

Nom

Valeur

url

Obligatoire. URL à ouvrir. Doit être une URL valide (http/https).

application

Optionnel. Mode d'ouverture du lien : BROWSER (défaut, navigateur externe) ou WEBVIEW (fenêtre intégrée à la conversation).

webviewViewMode

Taille de la WebView : FULL (plein écran), TALL (3/4) ou HALF (moitié). Requis lorsque application = WEBVIEW, et à ne pas fournir sinon.

description

Optionnel. Texte d'accessibilité décrivant la WebView (recommandé en mode WEBVIEW). 100 caractères maximum.

Ces paramètres sont valables partout où une suggestion openUrlAction est acceptée : suggestions de message texte, boutons de rich-card et boutons de chaque carte d'un carrousel.

En cas de valeur invalide, l'API retourne une erreur avec l'un des codes suivants : 24 (application invalide), 25 (webviewViewMode invalide), 26 (webviewViewMode fourni sans application = WEBVIEW), 27 (webviewViewMode manquant alors que application = WEBVIEW), 28 (description de plus de 100 caractères).

Envoyer à partir d'un modèle (modelToken)

Plutôt que de fournir tout le contenu dans richContent à chaque appel, vous pouvez enregistrer ce contenu une seule fois sous forme de modèle RCS sur la plateforme, puis l'envoyer via l'API en indiquant simplement son identifiant (modelToken). À chaque envoi, c'est la version actuelle du modèle qui est utilisée.

L'identifiant peut aussi être collé dans nos modules et connecteurs (PrestaShop, WooCommerce, Zapier, Make…) partout où un « identifiant de modèle RCS » est demandé.

L'identifiant désigne uniquement le modèle à utiliser. Il n'expire pas, n'est pas un secret d'authentification et n'est reconnu que pour le compte propriétaire du modèle (résolution basée sur la apiKey). La apiKey reste obligatoire.

modelToken et richContent sont mutuellement exclusifs. Si les deux sont présents dans la même requête, l'API renvoie une erreur HTTP 400 (code 62) et le message n'est pas envoyé. Un richContent vide ({} ou null) est considéré comme non fourni.

{
    "apiKey": "",
    "phoneNumbers": [
        "+33....."
    ],
    "modelToken": "9f8c2b1a7d4e6f30a1b2c3d4e5f60718"
}

{
    "apiKey": "",
    "phoneNumbers": [
        "+33....."
    ],
    "modelToken": "9f8c2b1a7d4e6f30a1b2c3d4e5f60718",
    "tag": "campagne-ete",
    "scheduledAt": "+2 hours",
    "sandbox": false,
    "urlDlr": "https://exemple.com/callback/dlr",
    "urlResponse": "https://exemple.com/callback/response",

    //optionnel : Permet d'envoyer un SMS si le RCS n'est pas accepté sur l'appareil du destinataire
    "failover": {
        "sender": "MaMarque",
        "message": "Votre RCS n'a pas pu être remis. Retrouvez notre offre sur https://exemple.com"
    }
}

Le modelToken fournit le contenu, l'appel API continue de piloter le reste (destinataires, émetteur de repli, programmation, tag, sandbox, callbacks…). Les autres validations (numéros, programmation, tailles de champs, suggestions…) restent identiques à un envoi RCS classique et s'appliquent après l'injection du contenu du modèle.

Code de réponse

Réponse

60

Modèle RCS introuvable : l'identifiant ne correspond à aucun modèle RCS de votre compte, ou il pointe vers un modèle SMS.

61

Le modèle RCS est vide : le modèle existe mais son contenu est vide ou invalide (à ré-enregistrer sur la plateforme).

62

modelToken et richContent ont été envoyés dans la même requête (mutuellement exclusifs).

Scénario RCS

Un scénario RCS est un dialogue automatisé configuré sur la plateforme : un message d'entrée, des suggestions cliquables et des réponses du bot selon les choix du destinataire. Pour démarrer un scénario par son identifiant (scenarioToken), utilisez la route dédiée :

Scénario RCS

Réponse

{
    "success": true,
    "code": 200,
    "message_id": 1,
    "nb_rcs": 1,
    "cost": 0.12,
    "currency": "EUR"
}

Types de fichiers multimédias acceptés

RBM est compatible avec les types de médias suivants :

Type de contenu

Type de document

Extension

Compatible avec les cartes enrichies

application/ogg

Audio OGG

.ogx

Non

application/pdf

PDF

.pdf

Non

audio/aac

Audio AAC

.aac

Non

audio/mp3

Format audio MP3

.mp3

Non

audio/mpeg

Audio MPEG

.mpeg

Non

audio/mpg

Audio MPG

.mp3

Non

audio/mp4

Audio MP4

.mp4

Non

audio/mp4-latm

Audio MP4-latm

.mp4

Non

audio/3gpp

Audio 3GPP

.3gp

Non

image/jpeg

JPEG

.jpeg, .jpg

Oui

image/gif

GIF

.gif

Oui

image/png

PNG

.png

Oui

video/h263

Vidéo H263

.h263

Oui

video/m4v

Vidéo M4V

.m4v

Oui

video/mp4

Vidéo MP4

.mp4

Oui

video/mpeg4

Vidéo MPEG-4

.mp4, .m4p

Oui

video/mpeg

Vidéo MPEG

.mpeg

Oui

video/webm

Vidéo au format WebM

.webm

Oui

PrécédentSupprimer un numéro du STOP SMS

SuivantScénario RCS

Mis à jour il y a 3 jours