Envío de mensajes personalizados

Si ha creado contenido de plantilla personalizado en la plataforma OTP, llame a esta interfaz para enviar el contenido del mensaje personalizado.

Dirección de la llamada

POST https://otp.api.engagelab.cc/v1/custom-messages

Autenticación de llamadas

Consulte Autenticación de llamadas para saber cómo autenticar la API.

Formato de la solicitud

Encabezados de la solicitud

              
              POST /v1/custom-messages  HTTP/1.1  
Content-Type: application/json  
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

Cuerpo de la solicitud

              
              {
    "to": "+6591234567", 
    "template":{
      "id":"test-template-1",
      "params": {
        "code": "codevalue",
        "var1":"value1"
        }
    }
}

            

Parámetros de la solicitud

Un objeto de solicitud se expresa en formato JSON, por lo que el encabezado de la solicitud debe incluir Content-Type: application/json.

Acerca de params

1. Para las variables preestablecidas de la plantilla como {{brand_name}}, {{ttl}}, {{pwa_url}}, no es necesario pasarlas; el sistema las sustituirá automáticamente por el contenido especificado al crear la plantilla;
2. Si el tipo de plantilla es código de verificación, es obligatorio pasar la variable {{code}}; de lo contrario, se producirá un error.;
3. Asimismo, para los campos de variables personalizadas del contenido de la plantilla definidos al crearla, también se asignan sus valores mediante params; por ejemplo, si el contenido de la plantilla es Hi {{name}}, your verify code is {{code}}, deberá asignar el parámetro params:{"name":"Bob"}
4. Variables especiales del canal Email: para el canal Email, se admite sobrescribir dinámicamente mediante params el asunto del correo (subject), el nombre del remitente (from_name), el correo del remitente (from_mail), etc. Para el uso avanzado detallado, consulte Crear plantilla - Uso avanzado de las variables de plantilla de Email.

Ejemplos de solicitud

1. Enviar un código de verificación personalizado:

              
              {
    "to": "+6591234567", 
    "template":{
      "id":"code-template",
      "params": {
        "code": "123456"        
        }
    }
}

            

2. Enviar contenido de notificación personalizado:

              
              {
    "to": "+6591234567",
    "template": {
        "id": "notification-template",
        "params": {
            "order": "123456"
        }
    }
}

            

3. Enviar contenido de marketing personalizado:

              
              {
    "to": ["+6591234567"],
    "template": {
        "id": "marketing-template",
        "params": {
            "name": "EngageLab",
            "promotion": "30%"
        }
    }
}

            

Parámetros de la respuesta

Respuesta exitosa

              
              {
    "message_id": "1725407449772531712",
    "send_channel": "sms"
}

            

Tenga en cuenta que el valor de**send_channel**devuelto no representa el canal final por el que se entrega al usuario, sino únicamente el canal usado en la etapa actual; por ejemplo, si en la estrategia configurada en la plantilla se establece que, ante un fallo de entrega por el canal WhatsApp, se reenvíe automáticamente por el canal SMS, la interfaz devolverá el valor whatsapp y, tras detectar el fallo de entrega pasado un tiempo, el sistema enviará por el canal SMS.

Respuesta de error

El código de estado HTTP es 4xx o 5xx, y el cuerpo de la respuesta contiene los siguientes campos:

              
              {
    "code": 5001,
    "message": "sms send fail"
}

            

Códigos de error