RCS
L'API RCS de seven offre la possibilité d'intégrer les fonctions puissantes de RCS dans votre application et ainsi permettre une communication riche et interactive avec vos utilisateurs. Cette documentation décrit en détail les différents points de terminaison, paramètres et fonctions de l'API RCS. Découvrez les nombreuses possibilités qu'offre RCS pour améliorer la messagerie, le partage de fichiers, le partage de localisation et bien plus encore.
Pour envoyer des messages RCS, il est obligatoire d'enregistrer un agent auprès de chaque opérateur de réseau auquel vous voulez envoyer des messages RCS. L'agent est, pour ainsi dire, l'expéditeur vérifié du RCS et est conçu dans votre CI.
- 1
Enregistrement des agents
Le processus d'enregistrement ne peut actuellement être effectué que manuellement. Soumettez le formulaire sur notre page produit RCS pour commencer avec RCS. Nous vous contacterons ensuite immédiatement pour demander quelques données afin de configurer l'agent.
- 2
Intégrer l'API RCS
Une fois votre agent configuré, vous pouvez commencer à implémenter l'API directement.
- 3
Tester RCS
Mettez votre intégration à l'épreuve. À ce stade, vous ne pouvez utiliser que les numéros de test stockés pour l'agent.
- 4
Demander la mise en production
Dès que vous avez implémenté RCS et l'avez testé suffisamment et avec succès, nous pouvons demander l'approbation de l'agent auprès des opérateurs de réseau souhaités. Ce processus prend généralement quelques jours ouvrables et est souvent associé à des requêtes.
- 5
Envoyer RCS 🚀
Vous êtes prêt et pouvez maintenant envoyer des messages RCS !
Envoyer RCS
Ce point de terminaison vous permet d'envoyer des messages RCS aux utilisateurs. Avant d'envoyer un RCS, vous devriez idéalement interroger les capacités du numéro de téléphone pour assurer la meilleure expérience utilisateur possible.
Paramètres
- Name
to- Type
- string
- Description
Le numéro destinataire de votre message RCS. Cela peut aussi être un nom de contact ou un nom de groupe.
- Name
text- Type
- string
- Description
Texte du message RCS. Pour envoyer un message RCS simple (sans images, réponses suggérées, etc.), entrez seulement le texte brut du message ici. Sinon, utilisez un objet RCS.
- Name
from- Type
- string
- Optional
- Optional
- Description
L'ID unique de votre agent. Vous pouvez le consulter dans les Paramètres de votre compte. Si non spécifié, le premier expéditeur compatible RCS sera utilisé.
- Name
delay- Type
- timestamp
- Optional
- Optional
- Description
Date/heure pour l'envoi différé. En option timestamp Unix ou un timestamp au format yyyy-mm-dd hh:ii.
- Name
ttl- Type
- integer
- Optional
- Optional
- Description
Spécifie la période de validité du RCS en minutes. La valeur par défaut est 2880, soit 48 heures.
- Name
label- Type
- string
- Optional
- Optional
- Description
Définir optionnellement un label séparé pour chaque SMS afin que vous puissiez l'assigner à vos statistiques. Max. 100 caractères, caractères autorisés : a-z, A-Z, 0-9, .-_@.
- Name
performance_tracking- Type
- boolean
- Optional
- Optional
- Description
Activer le suivi des clics et des performances pour les URLs trouvées dans le texte SMS. Cela active également le raccourcisseur d'URL.
- Name
foreign_id- Type
- string
- Optional
- Optional
- Description
Entrez votre propre ID pour ce message. Vous recevrez le foreign_id en retour pour les callbacks pour les rapports de statut etc. Max. 64 caractères, caractères autorisés : a-z, A-Z, 0-9, .-_@.
- Name
fallback- Type
- enum
- Description
S'il n'est pas possible d'envoyer un message RCS parce que, par exemple, l'appareil du destinataire ne supporte pas RCS, le message peut être automatiquement envoyé via un canal alternatif. Si aucun fallback n'est spécifié, il est désactivé.
Envoyez soit une de ces valeurs :
sms - Envoie un SMS avec le texte du message RCS comme contenu webview - Envoie un SMS avec un lien vers une vue web du message RCS
Ou envoyez un objet JSON :
{ "type": "sms", "text": "Voici le texte du SMS", "from": "sender" }
curl -X POST "https://gateway.seven.io/api/rcs/messages" \
-H "X-Api-Key: VOTRE_CLÉ_API" \
-d "text=Bonjour le monde !" \
-d "to=49176123456789"
{
"success": "100",
"total_price": null,
"balance": 3218.988,
"debug": "false",
"sms_type": "direct",
"messages": [
{
"id": "77233319353",
"sender": "myfancyagent",
"recipient": "49176123456789",
"text": "Bonjour le monde !",
"encoding": "gsm",
"label": null,
"parts": 0,
"udh": null,
"is_binary": false,
"price": 0,
"channel": "RCS",
"success": true,
"error": null,
"error_text": null
},
{
"id": "77233319354",
// ...
}
]
}
Supprimer RCS
Vous pouvez révoquer un message RCS qui n'a pas encore été livré. Cette API retourne immédiatement une réponse réussie, peu importe si le message a été supprimé ou non. La révocation n'est possible que si l'appareil final a la capacité REVOCATION.
Paramètres de chemin
- Name
Message ID- Type
- string
- Description
L'ID du message à supprimer.
Requête
curl -X DELETE "https://gateway.seven.io/api/rcs/messages/123456" \
-H "X-Api-Key: VOTRE_CLÉ_API"
Réponse
{
"success": true
}
Événements
Envoyez un événement à un numéro de téléphone pour fournir aux utilisateurs une expérience conversationnelle plus authentique. Après avoir reçu un message, vous devriez envoyer l'événement READ puis IS_TYPING en conséquence dans un délai raisonnable.
Paramètres
- Name
to- Type
- string Union
- Description
Le numéro de téléphone auquel vous voulez envoyer l'événement.
- Name
msg_id- Type
- string Union
- Description
L'ID du RCS reçu auquel vous voulez envoyer l'événement. Si non spécifié, l'événement est automatiquement envoyé au dernier message RCS reçu.
- Name
event- Type
- enum
- Description
L'événement à envoyer. Peut avoir une des valeurs suivantes :
Afficher les événements
IS_TYPING- L'agent est actuellement en train d'écrireREAD- Le message envoyé par l'utilisateur a été lu
Requête
curl -X POST "https://gateway.seven.io/api/rcs/events" \
-H "X-Api-Key: VOTRE_CLÉ_API" \
-d "to=49176123456789" \
-d "event=IS_TYPING" \
-d "from=myfancyagent"
Réponse
{
"success": true
}