Skip to content

发送邮件验证码

ben.zhuang edited this page Oct 14, 2022 · 1 revision

简要描述:

  • 邮件验证码发送

请求URL:

  • http://api2.nxcloud.com/api/email/otp

请求方式:

  • POST

参数:

Headers:
参数名 参数值 必选 类型 说明
Content-Type application/json
Body:
参数名 类型 必选 说明
appKey string 邮件应用appKey
secretKey string 邮件应用sercretKey
from string 发件人email,必须要邮箱地址格式
to string 收件人email,必须要邮箱地址格式
templateName string 模板名称
templateData object 模板中自定义替换数据,请确认在模板中插入了替换参数
-- eAddr string 地址
-- userName string 客户姓名
-- nickName string 客户昵称
-- gender string 尊称,如先生、女士
-- date string 日期、时间
-- mobile string 手机号
-- vCode string 验证码

请求示例

{
    "appKey": "",
    "secretKey": "",
    "from": "",
    "to": "",
    "templateName": "",
    "templateData": {
        "eAddr": "",
        "userName": "",
        "nickName": "",
        "gender": "",
        "date": "",
        "mobile": "",
        "vCode": "123456"
    }
}

返回示例

{
    "msg": "请求成功",
    "result": "e7b3082a46cf4959a3bc10f5d101d1cc",
    "code": 0
}

返回参数说明

参数名 类型 说明
msg string 返回信息
result string 邮件id
code string 返回码

错误码

Code 说明
0 请求成功
601001 账号状态异常
601002 账号余额不足
601101 应用状态异常,appKey/SecretKey不匹配
601102 应用无报价
601103 应用下无该域名配置
601104 域名未校验通过
601105 发件邮箱地址不存在
601106 邮件模板不存在
601107 邮件模板审核未通过
601201 提交失败

Introduction

WhatsApp

Short message

Voice

Call Center(NXLink)

AI Agent(NXLink)

Call Center(Callbot)

Flash Call

Short links

邮件验证码

DID号码

通用

号码检测

Clone this wiki locally