API SMS Phone Confirmation — Envoyer un code OTP

Support DQE
Support DQE
  • Mise à jour

L'endpoint GDPR_MSG envoie un SMS contenant un code de vérification à un numéro de téléphone, ainsi que les canaux de consentement de communication RGPD sélectionnés.

Documentation SMS Phone Confirmation associée :

Requête GET

Endpoint

https://{SERVER_ADDRESS}/GDPR_MSG/?Phone={PHONE}&Duration={DURATION}&Custom_sms={CUSTOM_SMS_CONTENT}&Phonecom={VALUE_PHONECOM}&Email={VALUE_EMAIL}&Post={VALUE_POST}&Sms={VALUE_SMS}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Company={COMPANY_NAME}

Remplacez les valeurs entre accolades par vos propres informations :

Paramètre Valeur Description Obligatoire/Optionnel
SERVER_ADDRESS {SERVER_ADDRESS} Adresse du serveur DQE qui traitera les données. Obligatoire
Licence {LICENCE_CODE} Code de licence attribué à votre compte. Obligatoire
Phone {PHONE} Numéro de téléphone au format international. Obligatoire
Country {COUNTRY_CODE} Code pays ISO à 3 lettres. Obligatoire
Company {COMPANY_NAME} Nom de l'entreprise utilisé comme expéditeur du SMS. Minimum 3 caractères et maximum 11 caractères. Obligatoire
Custom_sms {CUSTOM_SMS_CONTENT} Contenu personnalisé du SMS. Limité à 125 caractères. Le code de vérification est automatiquement ajouté. Obligatoire
Duration {DURATION} Durée de validité du code SMS en minutes. Optionnel
Phonecom {VALUE_PHONECOM} 1 ou 0. Indique si le consentement de communication par téléphone a été sélectionné. Optionnel
Email {VALUE_EMAIL} 1 ou 0. Indique si le consentement de communication par e-mail a été sélectionné. Optionnel
Post {VALUE_POST} 1 ou 0. Indique si le consentement de communication postale a été sélectionné. Optionnel
Sms {VALUE_SMS} 1 ou 0. Indique si le consentement de communication par SMS a été sélectionné. Optionnel

Paramètres de consentement multi-contacts optionnels : SMS2–SMS5, PHONE2–PHONE5, EMAIL2–EMAIL5, POST2–POST5 (consentement pour les contacts secondaires).

Requête POST

Endpoint

https://{SERVER_ADDRESS}/GDPR_MSG/

Ajoutez les paramètres suivants dans le corps de la requête en utilisant x-www-form-urlencoded.

Paramètre Valeur Description Obligatoire/Optionnel
Licence {LICENCE_CODE} Code de licence attribué à votre compte. Obligatoire
Phone {PHONE} Numéro de téléphone au format international. Obligatoire
Country {COUNTRY_CODE} Code pays ISO à 3 lettres. Obligatoire
Company {COMPANY_NAME} Nom de l'entreprise utilisé comme expéditeur du SMS. Minimum 3 caractères et maximum 11 caractères. Obligatoire
Custom_sms {CUSTOM_SMS_CONTENT} Contenu personnalisé du SMS. Limité à 125 caractères. Le code de vérification est automatiquement ajouté. Obligatoire
Duration {DURATION} Durée de validité du code SMS en minutes. Optionnel
Phonecom {VALUE_PHONECOM} 1 ou 0. Indique si le consentement de communication par téléphone a été sélectionné. Optionnel
Email {VALUE_EMAIL} 1 ou 0. Indique si le consentement de communication par e-mail a été sélectionné. Optionnel
Post {VALUE_POST} 1 ou 0. Indique si le consentement de communication postale a été sélectionné. Optionnel
Sms {VALUE_SMS} 1 ou 0. Indique si le consentement de communication par SMS a été sélectionné. Optionnel

Paramètres de consentement multi-contacts optionnels : SMS2–SMS5, PHONE2–PHONE5, EMAIL2–EMAIL5, POST2–POST5 (consentement pour les contacts secondaires).

Réponse

Réponse de succès

La réponse JSON contient le statut de livraison du SMS et les métadonnées de vérification.

Clé Description Format
status Statut de livraison du SMS. STRING
timeout Durée de validité du code en minutes. STRING
companyName Nom de l'entreprise utilisé comme expéditeur. STRING
country Code pays ISO à 3 lettres. STRING
to Numéro de téléphone du destinataire au format international. STRING
channels Canaux de communication sélectionnés. JSON OBJECT
errors Détails de l'erreur. JSON OBJECT
smsToken Identifiant unique du SMS. Transmettez cette valeur à GDPR_VERIF en tant que paramètre Token. STRING
dateTime Date et heure d'envoi du SMS. STRING

Valeurs de statut :

Statut Description
PENDING Le SMS a été envoyé à l'opérateur.
DELIVERED Le SMS a été livré avec succès.
UNDELIVERABLE Le SMS n'a pas pu être livré.
EXPIRED Le SMS a expiré avant la confirmation de livraison.
REJECTED Le SMS a été rejeté par l'opérateur.

Codes d'erreur :

Code Description
00 Aucune erreur.
01 Paramètres manquants.
02 Service non autorisé pour cette licence.
03 Numéro de téléphone invalide.
04 Code pays invalide.
05 Durée invalide.
06 Pays introuvable.
07 Nom d'entreprise invalide.
08 Erreur interne de l'API.
09 Aucun statut de livraison reçu.
10 Valeurs de consentement invalides.
11 Au moins un canal de communication doit être activé.

Exemple :

{
  "channels": {
    "phone": 0,
    "post": 0,
    "sms": 1,
    "email": 1
  },
  "to": "33612345678",
  "errors": {
    "00": "00 - No errors"
  },
  "status": "DELIVERED",
  "smsToken": "C6hfYZIER3CVoGVYwTiZLg",
  "timeout": "3",
  "companyName": "MYCOMPANY",
  "country": "FRA",
  "dateTime": "2019-07-29 11:32:32.876709"
}

Voir aussi

Associé à

Cet article vous a-t-il été utile ?

Utilisateurs qui ont trouvé cela utile : 0 sur 0