自定義驗證碼下發

如果您希望自行生成驗證碼而不通過 EngageLab 平台生成，可以調用本接口。

本接口專用於發送預生成的驗證碼，不會自行生成驗證碼。發送驗證碼後，無需調用驗證接口進行校驗。

如果您希望 EngageLab 平台生成驗證碼，可以調用 EngageLab OTP 驗證碼下發 。

调用地址

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

调用验证

采用 HTTP 基本认证 的验证方式，在 HTTP Header（头）里加 Authorization：

          Authorization: Basic ${base64_auth_string}

        

上述 base64_auth_string 的生成算法为：base64(dev_key:dev_secret)

请求示例

请求头

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

        

请求体

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

        

请求参数

一个请求对象以 JSON 格式表达，因此请求头需要带 Content-Type: application/json 。

对于params的说明

1. 对于模版有预设的字段如from_id，若不传param_vars字段值，则消息下发时使用模版预设的from_id；
2. 若传递了param_vars字段值，如param_vars:{"from_id":"12345"}，则消息下发时，模版的from_id将会替换成12345；
3. 同时对于创建模版时模版内容有自定义的变量字段，也都通过param_vars进行赋值，如模版内容Hi {{name}}, your verify code is {{code}}，此时需要赋值参数param_vars:{"name":"Bob"}

返回参数

成功返回

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

        

注意，返回的**send_channel**值不代表最终下发到用户的通道，仅代表现阶段使用的通道；如模版配置的策略中配置了WhatsApp通道送达失败然后自动补发SMS通道，则接口返回将返回whatsapp值，一定时间后感知到送达失败，系统将采用SMS通道发送

失败返回

http 状态码为 4xx 或者 5xx，响应体包含字段如下：

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

        

错误码