​

Règles d’opt-out et d’opt-in SMS

Original anglais : Règles d’opt-out et d’opt-in SMS.

​

Qui peut ouvrir la page

​

Ce que chaque règle configure

• Mots-clés d’opt-out — désabonnent le contact (STOP, CANCEL, etc.).
• Mots-clés d’opt-in — réabonnent le contact (START, YES, etc.).

​

Les libellés de langue sont informatifs

​

Une route dédiée, pas une superposition

​

Où les règles s’appliquent

• À l’échelle du compte. Les règles s’appliquent aux réponses entrantes sur chaque numéro capable de recevoir des réponses (un long code ou short code qui accepte les SMS entrants) de votre compte. Elles ne sont pas liées à un messaging service, vous n’avez donc pas besoin d’en attacher un pour qu’elles s’exécutent.
• Par messaging service. Chaque service tient sa propre liste de suppression d’opt-out, gérée sur le service — voir Custom Opt-Out Keyword Lists.
• Par numéro. Une réponse par mot-clé n’est reconnue que sur un numéro capable de recevoir des réponses. Un sender ID alphanumérique ne peut pas recevoir de réponses, donc le traitement des mots-clés ne se déclenche jamais pour ces expéditeurs. La page montre lesquels de vos numéros sont éligibles et avertit quand aucun ne l’est.

​

Fusion avec le jeu STOP/START de la plateforme

​

Défauts amorcés

​

Attacher et tester

1. Envoyez le mot-clé par texto à l’un de vos numéros capables de recevoir des réponses depuis un mobile.
2. La boîte de réception montre le tour entrant et la réponse automatique dans la même conversation.
3. Le profil du contact montre l’état de consentement basculé, avec le mot-clé consigné dans l’historique de consentement ; la vue Opt-Outs liste l’enregistrement.
4. Le journal de distribution suit votre réponse automatique à travers queued → sent → delivered.

​

Aller-retour : supprimer → tenter l’envoi → réinscrire

​

1. Supprimer le contact

curl -X POST "https://api.orbit.devotel.io/api/v1/contacts/optouts" \
  -H "X-API-Key: dv_test_sk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contact": "+14155552671",
    "channel": "sms",
    "reason": "Customer reply STOP"
  }'

{
  "data": {
    "id": "con_abc",
    "phone": "+14155552671",
    "channel_preferences": {
      "sms": { "opted_out": true }
    },
    "already_opted_out": false,
    "updated_at": "2026-09-12T12:00:00Z"
  },
  "meta": { "request_id": "req_abc123" }
}

import { Orbit } from "@devotel-orbit/node";

const orbit = new Orbit({ apiKey: process.env.ORBIT_API_KEY! });

const { data } = await orbit.request<unknown>("POST", "/contacts/optouts", {
  body: {
    contact: "+14155552671",
    channel: "sms",
    reason: "Customer reply STOP",
  },
});

from orbit_sdk import OrbitClient

client = OrbitClient.from_env()  # reads ORBIT_API_KEY

res = client.request(
    "POST",
    "/contacts/optouts",
    json={
        "contact": "+14155552671",
        "channel": "sms",
        "reason": "Customer reply STOP",
    },
)

​

2. Tenter un envoi — le gate le rejette

curl -X POST "https://api.orbit.devotel.io/api/v1/messages/sms" \
  -H "X-API-Key: dv_test_sk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+14155552671",
    "body": "Hello from the suppression round trip"
  }'

{
  "error": {
    "code": "RECIPIENT_OPTED_OUT",
    "message": "Recipient has opted out of this channel",
    "status": 422,
    "details": { "to": "+14155552671", "channel": "sms" }
  },
  "meta": {
    "request_id": "req_def456",
    "docs_url": "https://docs.orbit.devotel.io/errors/RECIPIENT_OPTED_OUT"
  }
}

​

3. Retirer la suppression et renvoyer

curl -X DELETE "https://api.orbit.devotel.io/api/v1/contacts/optouts/con_abc/sms" \
  -H "X-API-Key: dv_test_sk_YOUR_KEY"

{
  "data": {
    "id": "msg_xyz",
    "status": "queued",
    "channel": "sms",
    "to": "+14155552671"
  },
  "meta": { "request_id": "req_ghi789" }
}

​

Opt-outs propres à une marque