Custom Send Message

If you have created custom template content on the OTP platform, you can call this interface to send custom message content.

Request URL

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

Authentication

Please refer to Authentication to learn how to perform API authentication.

Request Format

Request Header

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

            

Request Body

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

            

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 template preset variables such as {{brand_name}}, {{ttl}}, {{pwa_url}}, etc., there is no need to pass them; the system will automatically replace them with the content specified when the template was created;
2. If the template type is a verification code, the {{code}} variable must be passed, otherwise an error will be reported;
3. At the same time, for custom variable fields in the template content when creating the template, they are also assigned values through params. For example, if the template content is Hi {{name}}, your verify code is {{code}}, you need to assign the parameter params:{"name":"Bob"}.
4. Email Channel Special Variables: For the Email channel, you can dynamically override the email subject (subject), sender name (from_name), sender email (from_mail), etc., through params. For detailed advanced usage, please refer to Create Template - Email Template Variables Advanced Usage.

Request Example

1. Send Custom Verification Code:

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

            

2. Send Custom Notification Content:

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

            

3. Send Custom Marketing Content:

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

            

Response Parameters

Success Response

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

            

Note that the returned send_channel value does not represent the final channel delivered to the user, but only represents the channel used at this stage; for example, if the strategy configured in the template specifies that the WhatsApp channel fails to deliver and then automatically falls back to the SMS channel, the interface will return the whatsapp value. After sensing the delivery failure after a certain period of time, the system will use the SMS channel to send.

Failure 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