短信/邮件发送

POST

/notification/send

接口变更记录

变更版本	变更时间	变更人	变更内容	备注
V1.0.0	2023-08-22	Antony Zhou	新增

错误码

code	msg	msg_cn

请求结构

通信协议：Http、Https

字符编码：UTF-8

公共参数

https://app.apifox.com/link/project/3192700/apis/doc-2903487

签名方法

暂无

公共返回结果

https://app.apifox.com/link/project/3192700/apis/doc-2903489

接口描述

接口压测

（参考测试提供的压测结果）

实际并发数	实际RT	实际TPS	频率限制次数（次/秒）
			无

请求参数

Header 参数

x-notify-api-key

string

请求头校验值

必需

示例值:

L7V/RS/7Yvo6XtvugQK7zyzeTiY4FU3gzt+RxXPMaqU=

Body 参数application/json

emailPublicReq

object

邮件发送入参

可选

emails

string

收件人邮箱地址

必需

title

string

邮件标题

必需

content

string

邮件正文

必需

alias

string

邮件发送抬头

可选

smsPublicReq

object

短信发送入参

可选

phone

string

手机号

必需

verifyCode

string

验证码

必需

content

string

短信模板内容中文

必需

areaCode

string

区号

必需

country

string

默认传 all

必需

voicePublicReq

object

语音发送入参

可选

params

string

可选

邮件内容变量根据模板内容替换例：'{'code': 'aaa', 'company_name': 'bbb', 'names': 'cccc'}

phone

string

接收手机号

必需

fromPhone

string

发送手机号

必需

verifyCode

string

验证码

必需

language

string

语言

必需

areaCode

string

区号

可选

content

string

短信模板内容中文

必需

sendType

string | null

必需

发送类型sms,email,web,app notice

url

string

调用结果回调接口

可选

sendSync

integer

可选

0 异步 1 同步默认异步

示例

{
    "emailPublicReq": {
        "emails": "p.rhubiv@qq.com",
        "title": "点大之立些千",
        "content": "minim",
        "alias": "velit laborum anim"
    },
    "smsPublicReq": {
        "phone": "18182128329",
        "verifyCode": "94",
        "content": "qui do enim incididunt dolore",
        "areaCode": "53"
    },
    "voicePublicReq": {
        "params": "occaecat sint",
        "phone": "18170426541",
        "fromPhone": "18666652182",
        "verifyCode": "44",
        "language": "quis sunt",
        "areaCode": "50",
        "content": "est amet ex ullamco dolore"
    },
    "sendType": null,
    "url": "http://sosejisp.gu/holm",
    "sendSync": 53
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/notification/send' \
--header 'x-notify-api-key: L7V/RS/7Yvo6XtvugQK7zyzeTiY4FU3gzt+RxXPMaqU=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "emailPublicReq": {
        "emails": "p.rhubiv@qq.com",
        "title": "点大之立些千",
        "content": "minim",
        "alias": "velit laborum anim"
    },
    "smsPublicReq": {
        "phone": "18182128329",
        "verifyCode": "94",
        "content": "qui do enim incididunt dolore",
        "areaCode": "53"
    },
    "voicePublicReq": {
        "params": "occaecat sint",
        "phone": "18170426541",
        "fromPhone": "18666652182",
        "verifyCode": "44",
        "language": "quis sunt",
        "areaCode": "50",
        "content": "est amet ex ullamco dolore"
    },
    "sendType": null,
    "url": "http://sosejisp.gu/holm",
    "sendSync": 53
}'

返回响应

🟢200OK

application/json

Body

code

integer

code

必需

success

boolean

请求状态

必需

data

object

必需

status

string

发送

必需

sendType

string

发送类型

必需

示例

{
    "code": 0,
    "success": true,
    "data": {
        "status": "string",
        "sendType": "string"
    }
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

修改于 2024-08-01 02:33:09

获取全部资金操作方式

查询设置

短信/邮件发送

接口变更记录#

错误码#

请求结构#

公共参数#

签名方法#

公共返回结果#

接口描述#

接口压测#

请求参数

示例代码

返回响应

接口变更记录

错误码

请求结构

公共参数

签名方法

公共返回结果

接口描述

接口压测