Custom Messages Delivery

Si se ha creado contenido de plantilla personalizado en la plataforma de OTP, se debe utilizar esta API para enviar contenido de mensajes personalizado.

Endpoint de la API

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

Autenticación

Se utiliza HTTP Basic Authentication para la verificación. Añadir el encabezado Authorization en la solicitud HTTP:

              
              Authorization: Basic ${base64_auth_string}

            

El valor base64_auth_string se genera mediante el siguiente algoritmo: base64(dev_key:dev_secret)

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": "+8618701235678", 
    "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.

Notas sobre params:

Para variables predefinidas de la plantilla, como {{brand_name}}, {{ttl}} y {{pwa_url}}, no es necesario pasar valores; el sistema las reemplazará automáticamente por el contenido especificado durante la creación de la plantilla.

Si el tipo de plantilla es un código de verificación, se debe pasar la variable {{code}}; de lo contrario, se producirá un error.

Para variables personalizadas definidas en el contenido de la plantilla, se deben asignar valores mediante params. Por ejemplo, si el contenido de la plantilla es Hi {{name}}, your verify code is {{code}}, se debe pasar el parámetro params:{"name":"Bob"}.

Ejemplos de solicitud

1. Envío de un código de verificación personalizado:

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

            

2. Envío de una notificación personalizada:

              
              {
    "to": ["+8618701235678"],
    "template": {
        "id": "notification-template",
        "params": {
            "order": "123456"
        }
    }
}

            

3. Envío de contenido de marketing personalizado:

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

            

Parámetros de la respuesta

Respuesta correcta

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

            

Nota: El valor send_channel devuelto no representa el canal de entrega final al usuario, sino únicamente el canal utilizado en la etapa actual. Por ejemplo, si la estrategia de la plantilla está configurada para cambiar a SMS cuando la entrega por WhatsApp falla, la API devolverá inicialmente whatsapp. Si la entrega falla, el sistema cambiará automáticamente a SMS.

Respuesta de error

Los códigos de estado HTTP son 4xx o 5xx, y el cuerpo de la respuesta incluye los siguientes campos:

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

            

Códigos de error