OTP Delivery

This API generates verification codes through the EngageLab platform and delivers them according to the channel strategy specified in the template.

If you want to generate verification codes yourself instead of using the EngageLab platform, you can call the EngageLab OTP Custom Verification Code Delivery API.

Endpoint

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

Authentication

Use HTTP Basic Authentication and add Authorization to the HTTP header:

              
              Authorization: Basic ${base64_auth_string}

            

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

Request Example

Request Header

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

            

Request Body

              
              {
  "to": "+6591234567",
  "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.

Notes on params

1. For preset fields in the template, such as from_id, if the param_vars field value is not provided, the template's preset from_id will be used when the message is delivered.
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 delivered.
3. At the same time, custom variable fields in the template content created during template creation are also assigned 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"
}

            

Note that the returned send_channel value does not represent the final channel used to deliver the message to the user. It only indicates the channel currently in use. For example, if the template strategy is configured so that delivery through the WhatsApp channel fails and then automatically retries through the SMS channel, the API response will return the value whatsapp. After a certain period of time, once the delivery failure is detected, the system will send the message 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