SMS Phone Confirmation API — Enviar OTP

Support DQE
Support DQE
  • Actualización

El endpoint GDPR_MSG envía un SMS que contiene un código de verificación a un número de teléfono, junto con los canales de consentimiento de comunicación GDPR seleccionados.

Documentación relacionada de SMS Phone Confirmation:

Solicitud 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}

Sustituya los valores entre llaves por su propia información:

Parámetro Valor Descripción Obligatorio/Opcional
SERVER_ADDRESS {SERVER_ADDRESS} Dirección del servidor DQE que procesará los datos. Obligatorio
Licence {LICENCE_CODE} Código de licencia asignado a su cuenta. Obligatorio
Phone {PHONE} Número de teléfono en formato internacional. Obligatorio
Country {COUNTRY_CODE} Código de país ISO de 3 letras. Obligatorio
Company {COMPANY_NAME} Nombre de la empresa utilizado como remitente del SMS. Mínimo 3 caracteres y máximo 11 caracteres. Obligatorio
Custom_sms {CUSTOM_SMS_CONTENT} Contenido personalizado del SMS. Limitado a 125 caracteres. El código de verificación se añade automáticamente. Obligatorio
Duration {DURATION} Duración de validez del código SMS en minutos. Opcional
Phonecom {VALUE_PHONECOM} 1 o 0. Indica si se seleccionó el consentimiento de comunicación telefónica. Opcional
Email {VALUE_EMAIL} 1 o 0. Indica si se seleccionó el consentimiento de comunicación por correo electrónico. Opcional
Post {VALUE_POST} 1 o 0. Indica si se seleccionó el consentimiento de comunicación postal. Opcional
Sms {VALUE_SMS} 1 o 0. Indica si se seleccionó el consentimiento de comunicación por SMS. Opcional

Parámetros opcionales de consentimiento multicontacto: SMS2–SMS5, PHONE2–PHONE5, EMAIL2–EMAIL5, POST2–POST5 (consentimiento para contactos secundarios).

Solicitud POST

Endpoint

https://{SERVER_ADDRESS}/GDPR_MSG/

Añada los siguientes parámetros en el cuerpo de la solicitud utilizando x-www-form-urlencoded.

Parámetro Valor Descripción Obligatorio/Opcional
Licence {LICENCE_CODE} Código de licencia asignado a su cuenta. Obligatorio
Phone {PHONE} Número de teléfono en formato internacional. Obligatorio
Country {COUNTRY_CODE} Código de país ISO de 3 letras. Obligatorio
Company {COMPANY_NAME} Nombre de la empresa utilizado como remitente del SMS. Mínimo 3 caracteres y máximo 11 caracteres. Obligatorio
Custom_sms {CUSTOM_SMS_CONTENT} Contenido personalizado del SMS. Limitado a 125 caracteres. El código de verificación se añade automáticamente. Obligatorio
Duration {DURATION} Duración de validez del código SMS en minutos. Opcional
Phonecom {VALUE_PHONECOM} 1 o 0. Indica si se seleccionó el consentimiento de comunicación telefónica. Opcional
Email {VALUE_EMAIL} 1 o 0. Indica si se seleccionó el consentimiento de comunicación por correo electrónico. Opcional
Post {VALUE_POST} 1 o 0. Indica si se seleccionó el consentimiento de comunicación postal. Opcional
Sms {VALUE_SMS} 1 o 0. Indica si se seleccionó el consentimiento de comunicación por SMS. Opcional

Parámetros opcionales de consentimiento multicontacto: SMS2–SMS5, PHONE2–PHONE5, EMAIL2–EMAIL5, POST2–POST5 (consentimiento para contactos secundarios).

Respuesta

Respuesta correcta

La respuesta JSON contiene el estado de entrega del SMS y los metadatos de verificación.

Clave Descripción Formato
status Estado de entrega del SMS. STRING
timeout Duración de validez del código en minutos. STRING
companyName Nombre de la empresa utilizado como remitente. STRING
country Código de país ISO de 3 letras. STRING
to Número de teléfono del destinatario en formato internacional. STRING
channels Canales de comunicación seleccionados. JSON OBJECT
errors Detalles del error. JSON OBJECT
smsToken Identificador único del SMS. Pase este valor a GDPR_VERIF como parámetro Token. STRING
dateTime Fecha y hora de envío del SMS. STRING

Valores de estado:

Estado Descripción
PENDING El SMS fue enviado al operador.
DELIVERED El SMS se entregó correctamente.
UNDELIVERABLE El SMS no pudo ser entregado.
EXPIRED El SMS caducó antes de la confirmación de entrega.
REJECTED El SMS fue rechazado por el operador.

Códigos de error:

Código Descripción
00 Sin errores.
01 Faltan parámetros.
02 Servicio no autorizado para esta licencia.
03 Número de teléfono no válido.
04 Código de país no válido.
05 Duración no válida.
06 País no encontrado.
07 Nombre de empresa no válido.
08 Error interno de la API.
09 No se recibió el estado de entrega.
10 Valores de consentimiento no válidos.
11 Debe habilitarse al menos un canal de comunicación.

Ejemplo:

{
  "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"
}

Véase también

Relacionada con

¿Fue útil este artículo?

Usuarios a los que les pareció útil: 0 de 0