-
Notifications
You must be signed in to change notification settings - Fork 5
发送邮件验证码
jiang.tao edited this page May 6, 2023
·
8 revisions
简要描述:
- 邮件验证码发送
请求方式:
- URL:
http://api2.nxcloud.com/api/email/otp - Method:
POST - Content-Type:
application/json
参数:
| 参数名 | 参数值 | 必选 | 类型 | 说明 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| 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 | 否 | 验证码 |
请求示例
curl --location --request POST 'http://api2.nxcloud.com/api/email/otp' \
--header 'Content-Type: application/json' \
--data-raw '{
"appKey": "asdf",
"secretKey": "qwer",
"from": "asdf@qwer.com",
"to": "qwer@asdf.com",
"templateName": "temp1",
"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 | 提交失败 |
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_v1
- 已上传录音文件查询
- 发送语音群呼
- 发送语音通知
- 发送语音验证码
- 发送语音群呼_v1
- 发送语音通知_v1
- 发送语音验证码_v1
- 语音验证码回填上报
- 语音回执回调
- 语音记录查询
- 上传语音录音文件-旧版本已废弃
- 发送语音群呼‐旧版已废弃
- 发送语音通知‐旧版已废弃
- 发送语音验证码‐旧版已废弃
- 语音回执回调‐旧版已废弃
云呼叫中心(NXLink)
- Web SDK
- Iframe集成
- 手动拨号通话记录查询
- 通过orderId查询
- 手动拨号记录回调
- 坐席信息查询
- 坐席状态查询
- 坐席状态信息查询
- 坐席组查询
- 坐席可用主叫查询
- 坐席组成员查询
- 坐席组更新成员
- 坐席效率统计
- 创建AICC外呼任务
- Webhook-手动外呼
云呼叫中心(AI自动外呼)
- Callbot API概述
- Callbot API鉴权
- Callbot 接口探活
- 创建自动拨号任务
- 批量添加拨打名单
- 创建自动拨号任务并添加拨打名单
- 任务控制(启动/暂停)
- 更新任务
- 获取通话列表
- 获取任务列表
- 获取拨打订单列表
- 停止订单拨打
- 查询订单维度拨打详情
- 通话维度回调
- 订单维度拨打回调
- 任务状态回调
- 批次-导出最新批次数据
- 批次-导入最新批次数据
Flash Call
短链
邮件验证码
DID号码
- DID号码进行短信下行V2
- DID短信结果回调(加签)
- DID短信结果回调(无加签)
- DID号码短信记录查询(新接口,未启用)
- DID号码通话记录查询
- DID呼出并转接到Amazon坐席
- DID呼出前与Connect号码绑定
通用
号码检测
- 发送消息
- 发送otp消息
- webhook
- 标记入站消息已读
- 上传媒体文件
- 获取媒体文件
- 删除媒体文件
- 查询号码信息
- 查询消息模板
- 创建消息模板
- 异步创建消息模板
- 编辑消息模板
- 删除消息模板
- 上传模板示例文件
- 嵌入式页面登录
- 创建客户应用
- 客户应用的号码列表
- 获取验证码
- 核验验证码
- flows-创建流
- flows-更新流
- flows-根据流ID查询流信息
- flows-根据whatsapp号码查询流列表
- flows-根据流ID查询流预览地址
- flows-查询流JSON
- flows-发布流
- flows-删除流草稿
- flows-废弃已发布的流
- flows-更新流JSON
- flows-上传业务公钥
- ads-根据公共主页ID查询绑定的数据集列表
- ads-根据数据集ID上报CAPI广告数据
- 封锁用户
- 业务主页
- 查询消息记录
- 查询calling配置
- 查询calling通话记录
- 禁用calling配置
- 启用calling配置
- 二维码管理
Viber
Zalo ZNS
Super Message API
隐私号(旧)
PNS
坐席(旧版)
- NXphone PC 使用说明
- NXphone Android 使用说明
- NXphone Android SDK 接入文档
- 呼叫挂断原因解释
- 话单CDR查询接口
- 话单CDR回调接口说明(V1.0)
- 坐席API调用接口说明(V1.0)
- 根据orderid查询话单CDR接口
- 坐席系统sip链接调用方式(推荐)
- 号码脱敏处理
- 修改话机密码接口
- 查询审批单
- 查询话机
- WebRTC SDK使用说明
NXLINK(HKG)
- 发送WhatsApp消息
- webhook
- 发送Viber消息
- webhook-viber
- 发送Line消息
- webhook-Line
- 批量创建客户
- 批量创建客户sea
- 查询客户字段接口
- 查询、创建模板相关接口
- 查询对话分析相关接口
- 查询通知分析相关接口
- 查询聊天记录接口
- 查询客户列表
NXLINK(IDN)
- 发送WhatsApp消息
- webhook
- 发送Viber消息
- webhook-viber
- 发送Line消息
- webhook-Line
- 批量创建客户
- 批量创建客户sea
- 查询客户字段接口
- 查询、创建模板相关接口
- 查询对话分析相关接口
- 查询通知分析相关接口
- 查询聊天记录接口
- 查询客户列表
NXLINK(CHL)
- 发送WhatsApp消息
- webhook
- 发送Viber消息
- webhook-viber
- 发送Line消息
- webhook-Line
- 批量创建客户
- 批量创建客户sea
- 查询客户字段接口
- 查询、创建模板相关接口
- 查询对话分析相关接口
- 查询通知分析相关接口
- 查询聊天记录接口
- 查询客户列表
AI Agent
RCS