CustomOTP Send

If you prefer to generate the verification code yourself instead of using the EngageLab platform, you can call this API.

This API is specifically for sending pre-generated verification codes and will not generate the codes itself. After sending the verification code, there is no need to call the verification API for validation.

If you prefer the EngageLab platform to generate the verification code, you can call the EngageLab OTP Send API.

Endpoint

POST https://otp.api.engagelab.cc/v1/codes

Authentication

Uses HTTP Basic Authentication for verification. Add an Authorization in the HTTP Header:

          Authorization: Basic ${base64_auth_string}

        

The generation algorithm for the above base64_auth_string is: base64(dev_key:dev_secret)

Request Example

Request Header

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

        

Request Body

          {
    "to": "+8618701235678",
    "code": "398210", 
    "template":{
      "id":"test-template-1",
      "language": "default",
        "params": {
        "key1": "value1",
        "key2": "value2"
        }
    }
}

        

Request Parameters

A request object is expressed in JSON format, so the request header needs to include Content-Type: application/json.

Notes on params

1. For templates with pre-set fields like from_id, if the param_vars field value is not passed, the message will use the template's pre-set from_id during dispatch;
2. If param_vars field values are passed, such as param_vars:{"from_id":"12345"}, then during dispatch, the template's from_id will be replaced with 12345;
3. Similarly, for custom variable fields in the template content created, assign values through param_vars, e.g., for template content Hi {{name}}, your verify code is {{code}}, assign parameters with param_vars:{"name":"Bob"}

Response Parameters

Success Response

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

        

Note, the returned send_channel value does not represent the final delivery channel to the user, but only the current phase's channel. For example, if the template's strategy is configured to fallback from WhatsApp to SMS upon delivery failure, the API return will initially show whatsapp, and later, if delivery failure is detected, the system will use the SMS channel for sending.

Failure Response

HTTP status code of 4xx or 5xx, response body includes the following fields:

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

        

Error Codes