Custom OTP Code Delivery

If you want to generate verification codes yourself instead of having them generated by the EngageLab platform, you can call this API.

This API is specifically used to send pre-generated verification codes and does not generate verification codes on its own. After sending a verification code, there is no need to call a verification API to validate it.

If you want the EngageLab platform to generate verification codes, you can call the EngageLab OTP Verification Code Delivery API.

Endpoint

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

Authentication

Use HTTP Basic Authentication by adding Authorization to the HTTP header:

              
              Authorization: Basic ${base64_auth_string}

            

The generation algorithm for base64_auth_string above 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 must include Content-Type: application/json.

Description of params

1. For preset template fields such as from_id, if the param_vars field value is not provided, the preset from_id in the template will be used when the message is sent.
2. If the param_vars field value is provided, such as param_vars:{"from_id":"12345"}, then the template's from_id will be replaced with 12345 when the message is sent.
3. Custom variable fields in the template content that were created during template creation are also assigned values through param_vars. For example, if the template content is Hi {{name}}, your verify code is {{code}}, then the assignment parameter param_vars:{"name":"Bob"} is required.

Response Parameters

Successful Response

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

            

Please note that the returned send_channel value does not represent the final channel used to deliver the message to the user; it only represents the channel currently in use. For example, if the template strategy is configured so that delivery through the WhatsApp channel will automatically retry through the SMS channel if it fails, then the API response will return the value whatsapp. After a certain period of time, if a delivery failure is detected, the system will send through the SMS channel.

Failed Response

The HTTP status code is 4xx or 5xx, and the response body contains the following fields:

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

            

Error Codes