Configuración de proveedores de correo electrónico y SMS

Para autenticar tu dominio de correo electrónico, utiliza las Email Domain Authentication API. Para obtener más información sobre las API, consulta «Autenticación de dominios de correo electrónico ».

1. Registra tu dominio de correo electrónico. https://{tenanturl}/config/v1.0/email-domain-auth
   Ejemplo

   curl --request POST \
        --url https://tenant_url/config/v1.0/email-domain-auth \
        --header 'accept: application/json' \
        --header 'content-type: application/json'

2. Consigue los registros DNS de tu dominio de correo electrónico. https://{tenanturl}/config/v1.0/email-domain-auth/{domain}
   Ejemplo

   curl --request GET \
        --url https://tenant_url/config/v1.0/email-domain-auth/domain \
        --header 'accept: application/json'

3. Comprueba el estado de tu dominio de correo electrónico. https://{tenanturl}/config/v1.0/email-domain-auth/{domain}/verify
   Ejemplo

   curl --request POST \
        --url https://tenant_url/config/v1.0/email-domain-auth/domain/verify \
        --header 'accept: application/json'

4. Para cambiar o actualizar tu dominio de correo electrónico personalizado, debes eliminar el dominio existente de la notificación y, a continuación, registrar el nuevo.

   Elimina tu dominio de autenticación de correo electrónico. https://{tenanturl}/config/v1.0/email-domain-auth/{domain}

   Ejemplo

   curl --request DELETE \
        --url https://tenant_url/config/v1.0/email-domain-auth/domain \
        --header 'accept: application/json'

• El proveedor externo de SMS debe poner a disposición un punto final de webhook POST de tipo « HTTP » para recibir solicitudes de notificación de OTP procedentes de IBM Verify.
• El punto final debe poner en cola las solicitudes de inmediato y devolver una respuesta de « HTTP ».

{
  "destinationPhoneNumber": "18005551212",
  "content": "Your passcode is 6439-123456. It expires in 5 minutes.",
  "category": "OTP",
  "language": "en-US",
  "otp": "123456",
  "correlation": "6439",
  "expiry": 5
}

destinationPhoneNumber

El número de teléfono del destinatario en formato « E.164 ».

content

El texto completo del SMS que se muestra al usuario.

category

Contraseña única (OTP)

language

El código de idioma o de configuración regional, por ejemplo, en-US.

otp

El valor del código de acceso de un solo uso.

correlation

El identificador que permite vincular la contraseña de un solo uso (OTP) con un proceso de verificación; suele aparecer en el mensaje.

expiry

La duración de la validez en minutos.

202 Aceptado

La solicitud se ha añadido correctamente a la cola.

400 Solicitud errónea

Formato de la carga útil no válido.

500 Error interno del servidor

El proveedor no puede procesar la solicitud.

{
"status": "accepted",
"statusMessage": "Message accepted by provider"
}

{
"status": "failed",
"statusMessage": "The destination phone number is invalid."
}