Geeksend.com API
GEEKSEND API
用户可以通过 Geeksend API 来使用 Geeksend 功能。集成 Geeksend API 可验证邮箱地址、邮件发信以及管理Webhook等。
Geeksend API 的速率限制为每分钟 60 次请求, 验证速率限制为每小时5000个邮箱地址。
如有速率提升需求,可直接通过在线客服或service@geeksend.com联系我们。
认证
您需要生成访问口令来确认之后的请求。发出请求时,请在“Authorization”字段中指定此访问口令
Authorization: Bearer QSlHffXmCAILIOHNGXToq4LsP2yX64VQhEBZ7Ei4
以上即为生成的口令示例。
POST https://open.geeksend.com/oauth/access_token
grant_type | 将始终是client_credentials |
client_id | 您的 ID 在帐户设置中可用 https://app.geeksend.com/account/api |
client_secret | 您的密钥在帐户设置中可用 https://app.geeksend.com/account/api |
def get_access_token():
params = {
'grant_type':'client_credentials',
'client_id':'client_id',#your client_id
'client_secret': 'client_secret' #your client_secret
}
res = requests.post('https://open.geeksend.com/oauth/access_token', data=params)
token = res.json()["data"]["access_token"]
return token
{
"code": 1,
"info": "success",
"data": {
"access_token": "your access token",
"expire_in": 1660
}
}
access_token | 您的新访问口令 |
token_type | 将始终是 Bearer |
expires_in | 口令到期时间(秒) |
电子邮箱验证
POST获取邮箱验证结果
免费该方法可以检查您所提供的邮箱地址是否有效。API 端点会返回邮箱地址的验证结果。若我们之前未曾验证过某个邮箱地址,那么结果将不会反馈给您。在此情况下,API 将返回 “not_verified” 标识符,并且不会向您收取积分。此时,您应使用 “添加邮箱验证任务” 方法推送此邮箱地址进行验证,之后您便能够使用此端点获取邮箱地址的验证结果。
POST https://open.geeksend.com/verify/get_emails_verification_status
request_id | 添加邮箱验证任务后返回的request_id |
def get_email_verifier():
token = get_access_token()
headers = {
"Authorization": f"Bearer {token}",
"Content-Type": "application/json"
}
params = {
'request_id': 'd1c88b51-bf90-7f9e-c64c-d825bc92a4b5',
}
res = requests.post('https://open.geeksend.com/verify/get_emails_verification_status',headers=headers, data=json.dumps(params))
print(res.json())
{
"success": true,
"results": [
{
"status": {
"identifier": "complete",
"description": "Verification completed"
},
"data": {
"email": "info@geeksend.com",
"sendStatus": "invalid",
"smtpStatus": "valid",
"isCatchall": false,
"isGreylist": false,
"isBannedError": true,
"isConnectionError": false,
"isBusinessEmail": false,
"isValidFormat": true,
"isWebmail": false,
"isDisposable": false,
"isCompanyEmail": false,
"isGibberish": false
}
}
]
}
status | 邮箱地址验证状态。包含标识符和描述。 |
identifier | 可以包含以下值:complete ,in_progress , 或 not_verified . 如果标识符为 not_verified ,data 将为空。 |
description | 描述邮箱地址验证状态 |
提交的邮箱地址 | |
sendStatus | 邮箱发送状态 valid 可以检测邮箱可以正常发送 invalid 检测邮箱无法发送 unknow 无法判断邮箱是否可以正常发送 |
smtpStatus | 邮箱的SMTP是否正常 valid 有效 invalid 无效 |
isCatchall | 是否包罗万象 |
isGreylist | 是否被列入灰名单 |
isBannedError | 是否被列入黑名单 |
isConnectionError | 与邮件服务器建立连接时是否发生网络或者配置错误 |
isBusinessEmail | 是否为商业邮箱 |
isValidFormat | 格式是否符合语法规范 |
isWebmail | 是否为公共邮箱 |
isDisposable | 是否为一次性邮箱 |
isGibberish | 是否为乱码地址 |
我们只对验证结果为有效和无效的邮箱地址进行扣费,验证结果为无法验证的则不收取您的费用。
POST添加邮箱验证任务
每验证 1 个邮箱地址消耗 1 个积分如果您以前从未验证过某个邮箱地址,则应使用此 API 方法将其推送以进行验证。执行此操作后,您可以使用“电子邮箱验证器”获得验证结果。
POST https://open.geeksend.com/verify/add_emails_to_verification
emails | 您需要添加到验证队列的邮箱地址列表。每个请求最多可以包含 10 个邮箱地址。 |
def add_emails_for_verification():
token = get_access_token()
headers = {
"Authorization": f"Bearer {token}",
"Content-Type": "application/json"
}
params = {
'emails': ['info@geeksend.com'],
}
res = requests.post('https://open.geeksend.com/verify/add_emails_to_verification',headers=headers, data=json.dumps(params))
print(res.json())
{
"success": true,
"results": [
"info@geeksend.com"
],
"request_id": "d1c88b51-bf90-7f9e-c64c-d825bc92a4b5"
}
如果将邮箱地址成功添加到队列中,则该方法返回 {"success":true}
用户账户
POST查看用户余额
免费用此方法查看您的积分余额。
POST http://open.geeksend.com/account/balance
def get_balance():
token = get_access_token()
headers = {
"Authorization": f"Bearer {token}"
}
res = requests.post('https://open.geeksend.com/account/balance',headers=headers)
print(json.dumps(res.json()
{
"success": true,
"data": {
"balance": 100,
"teamwork": true
}
}
balance | 用户当前的信用点数余额。 |
teamwork | 若您目前是团队成员或领导,则为“true”,若您不属于任何团队,则为“false”。 |
recipients_used | 本月已使用的唯一收件人数量。 |
邮件营销
POST发送邮件
每个邮箱收件人扣除1积分给指定邮箱发送邮件内容
POST https://open.geeksend.com/send/email
emails | 收件人邮箱,可以传递多个,一次最多10个邮箱 |
prospect_id | 潜在客户id,通过系统潜在客户列表获取 |
template_id | 邮件模版id,通过邮件模版接口获取相应的邮件模版id数据,如果模版id提供,subject和content可以不传(template_id和【subject,content】二选一) |
subject | 邮件主题 |
content | 邮件内容 |
sender | 发件人邮箱地址【如果个人邮箱发信需要在电子邮箱账户配置邮箱信息,链接:https://app.geeksend.com/account/email-account】 |
flag | 发信任务标记 可选 |
reply_email | 回复邮件地址 |
is_trace_link | 是否开启链接统计 1表示是 0表示否 |
is_trace_open | 是否开启打开统计 1表示是 0表示否 |
def send_email():
token = get_access_token()
headers = {
"Authorization":f"Bearer {token}"
}
params = {
'emails':['info@geeksend.com'],
'prospect_id': 0,
'template_id': 100010,
'subject': '邮件主题',
'content':'邮件内容',
'sender': "sender@geeksend.com",
'reply_email': "reply_email@geeksend.com"
}
res = requests.post('https://open.geeksend.com/send/email',headers=headers,data=params)
print(json.dumps(res.json()))
{
"success": true,
"results": {
"task_id": 3,
"request_id": "唯一id"
}
}
task_id | 任务id,用来通过【获取邮件发送结果】接口获取邮件发送状态 |
POST获取邮箱发送结果
返回值包含邮箱以及邮箱发送状态
POST https://open.geeksend.com/send/result
task_id | 任务id,通过发送邮箱api接口返回的task_id |
def get_send_results():
token = get_access_token()
headers = {
"Authorization":f"Bearer {token}"
}
params = {
'task_id':1
}
res = requests.post('https://open.geeksend.com/send/result',headers=headers,data=params)
print(json.dumps(res.json()))
{
"success": true,
"results": {
"task_id": 1,
"data": {
"info@geeksend.com": "success"
}
}
}
task_id | 当前接口请求的任务id |
data | 对应的邮箱发送状态【邮箱地址:发送状态】 【发送状态:success 发送成功 unsend 未发送 failed 发送失败 sending 发送中】 |
SMTPSMTP发信
通过SMTP的方式,给指定邮箱发送邮件内容
注意:SMTP暂时不支持附件
SMTP smtp.geeksend.io
端口 | 587 TLS / 465 SSL |
账密 | AppID和AccessKeySecret |
<?php
include "vendor/autoload.php";
use PHPMailer\PHPMailer\PHPMailer;
use \PHPMailer\PHPMailer\SMTP;
$mail = new PHPMailer(true);
try {
//基础设置
$mail->SMTPDebug = SMTP::DEBUG_SERVER; //是否开启调试模式
$mail->isSMTP(); //设置使用SMTP
$mail->Host = 'smtp.geeksend.io'; //设置SMTP主机地址
$mail->SMTPAuth = true; // 必须开启
$mail->Username = 'appId'; //详见: 账户->API->appId
$mail->Password = 'AccessKeySecret'; //详见:账户->API->AccessKeySecret
// 用户跟进情况酌情使用
// 如果使用587端口进行发送邮件,请将SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS 以及端口port=587
// $mail->SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS;
// $mail->Port = 587;
// 如果使用465端口进行发送邮件,请将SMTPSecure = PHPMailer::ENCRYPTION_SMTPS 以及端口port=465
// $mail->SMTPSecure = PHPMailer::ENCRYPTION_SMTPS;
// $mail->Port = 465;
$mail->CharSet = PHPMailer::CHARSET_UTF8;
$mail->Encoding = PHPMailer::ENCODING_BASE64;
$mail->ContentType = PHPMailer::CONTENT_TYPE_MULTIPART_RELATED;
//Recipients
$mail->setFrom('sender@geeksend.com', 'sender'); // 发信邮箱;
$mail->addAddress('to@geeksend.com', 'to'); // 可以添加多个,SMTP服务会分别给用户单独发送邮件 prospect_id 和 to@geeksend.com二选一
$mail->addReplyTo("reply@geeksend.com","reply"); // 回复地址 默认为空,如果需要回复到指定邮箱,必须给此参数
$mail->addCustomHeader("Template-Id",10002);// 模版id详见:营销发信-> 模版管理 template_id与 subject&body 二选一 优先使用subject&body
$mail->addCustomHeader("Flag","**********"); // 用户提交的唯一标识
$mail->addCustomHeader("Prospect-Id",10001); // 潜在客户id 详见: 客户列表-> 潜在客户管理 潜在客户id和to_email 二选一 优先to_email
$mail->addCustomHeader("Is-Trace-Link",1); // 是否开启链接跟踪 1表示开启,0表示关闭 默认是0
$mail->addCustomHeader("Is-Trace-Open",1); // 是否开启邮箱打开跟踪 1表示开启,0表示关闭 默认是0
$mail->addCustomHeader("Variable",'{}'); // 模版id或者body 中的变量替换。Variable 是一个json,json格式为:{"to@geeksen.com":{"code":111}} body中的内容为 “验证码为:{{code}}” 替换后的内容为 “验证码为:111”
//Content
$mail->isHTML(true); //设置为HTML格式
$mail->Subject = '邮件主题';
$mail->Body = '邮件内容';
$mail->send();
echo 'Message has been sent';
} catch (Exception $e) {
echo "Message could not be sent. Mailer Error: {$mail->ErrorInfo}";
}
Golang示例:
import (
"crypto/tls"
"fmt"
"gopkg.in/gomail.v2"
)
func SendMail() {
d := gomail.NewDialer("smtp.geeksend.io", 587, "appId", "AccessKeySecret")
d.TLSConfig = &tls.Config{InsecureSkipVerify: true}
m := gomail.NewMessage()
m.SetHeader("From", "sender@geeksend.com")
m.SetHeader("To", "to@geeksend.com")
m.SetHeader("Subject", "Hello!")
m.SetBody("text/html", "Hello <b>Bob</b> and <i>Cora</i>!")
err := d.DialAndSend(m)
if err != nil {
fmt.Println("错误:", err)
}
}
Python示例
import smtplib
from email.mime.text import MIMEText
from email.header import Header
from email.mime.multipart import MIMEMultipart
sender = 'sender@geeksend.com'
receivers = ['to@geeksend.com'] # 接收邮件,可设置为你的QQ邮箱或者其他邮箱
message = MIMEText('Python 邮件发送测试...', 'plain', 'utf-8')
message['From'] = Header(sender, 'utf-8') # 发送者
message['To'] = Header(",".join(receivers), 'utf-8') # 接收者
subject = 'Python SMTP 邮件测试 587'
message['Subject'] = Header(subject, 'utf-8')
try:
client = smtplib.SMTP('smtp.geeksend.io', 587)
client.set_debuglevel(1)
client.login("appId","AccessKeySecret")
client.sendmail(sender,receivers, message.as_string())
print("邮件发送成功")
except smtplib.SMTPException as e:
print(e)
返回250表示发送成功
550 表示发送失败
Webhook
POST列出所有 webhook
您可以使用这种 API 方法来获取账户的 webhook 列表。POST https://open.geeksend.com/webhooks/list
def list_webhook():
token = get_access_token()
headers = {
"Authorization": f"Bearer {token}"
}
res = requests.post('https://open.geeksend.com/webhooks/list',headers=headers)
print(json.dumps(res.json()
{
"success": true,
"results": {
"list": [
{
"webhook_id": 1,
"end_point": "https://www.baidu.com",
"event_object": "campaign_email",
"event_action": "sent",
"status": "active",
"create_time": 1744620856
}
],
"webhook_count": 1
}
}
参数 | 数据类型 | 描述 |
webhook_id | int | webhook id |
end_point | string | 您在添加webhook时提供的实际URL地址及其发送位置 |
event_object | string | 执行操作对象,详情见添加 |
event_action | sting | 对象的操作, 详情见添加 |
create_time | int | 添加webhook的创建时间。Unix Timestamp格式 |
status | string | webhook状态,启用active,停用 deactivated |
POST添加 webhook
您可以使用这种 API 方法来创建 webhook 订阅并接收取指定端点 URL 的事件通知。目前支持的 webhook 对象和操作如下:
Webhook 对象 | 操作 | 触发后 |
---|---|---|
campaign_email | sent | 在任何自动化营销中向收件人发送任何邮件时 |
opened | 当收件人打开任何自动化营销中的任何邮件时 | |
replied | 当收件人回复邮件时 | |
clicked | 当收件人点击邮件里的链接时 | |
email_verification | verified | 当您请求邮箱验证时。 |
POST https://open.geeksend.com/webhooks/add
event_object | 执行操作的对象 |
event_action | 对象执行的操作 |
endpoint_url | 发送webhook的URL地址 |
def add_webhook():
token = get_access_token()
headers = {
"Authorization": f"Bearer {token}"
}
params = {
'event_object':'campaign_email',
'event_action': 'sent',
'endpoint_url': '回调地址'
}
res = requests.post('https://open.geeksend.com/webhooks/add',headers=headers,data=params)
print(json.dumps(res.json()
{
"success": true,
"results": [],
"msg": "success"
}
POST删除一个 webhook
删除一个选定的 webhook。根据webhook_id删除对应的webhook
POST https://open.geeksend.com/webhooks/delete
参数 | 类型 | 描述 |
webhook_id | int | webhook id 唯一标识 |
def delete_webhook():
token = get_access_token()
headers = {
"Authorization":f"Bearer {token}"
}
params = {
'webhook_id': 1001
}
res = requests.post('https://open.geeksend.com/webhooks/delete', headers=headers, data=params)
print(json.dumps(res.json()))
{
"success":true,
"results":{},
"msg":"success"
}
POST更改 webhook 状态
更改所选 webhook 订阅的状态。在请求 URL 地址的末尾包含所选 webhook 的唯一“id”值。
POST https://open.geeksend.com/webhooks/status
参数 | 类型 | 描述 |
webhook_id | int | webhook id唯一标识 |
def status_webhook():
token = get_access_token()
headers = {
"Authorization":f"Bearer {token}"
}
params = {
'webhook_id':10001
}
res = requests.post('https://open.geeksend.com/webhooks/status', headers=headers, data=params)
print(json.dumps(res.json()))
自有邮箱
POST创建自有邮箱
创建账户自有邮箱,并验证发信和收信状态创建账户自有邮箱,并验证邮箱发信和收信状态是否有效
POST https://open.geeksend.com/mailbox/create
参数 | 类型 | 描述 | 默认值 |
limit | int | 每天的发送限制 | 17280 |
delay_type | string | 发送间隔延迟类型 | fixed/random 默认:fixed |
fixed_delay | int | 如果是fixed模式的间隔时间 单位秒 | 5 |
min_delay | int | 如果是random模式的最小间隔时间 单位秒 | 5 |
max_delay | int | 如果是random模式的最大间隔时间 单位秒 | 30 |
smtp_name | string | SMTP显示的发信人名称 | 可为空 默认:空字符串 |
smtp_email | string | SMTP显示的发信邮件地址 | null |
smtp_username | string | SMTP协议用户名 | 通常和smtp_email一致, 如不提交则使用smtp_email |
smtp_password | string | SMTP协议密码 | null |
smtp_host | string | SMTP协议主机地址 | null |
smtp_port | int | SMTP协议主机端口 | 587 |
smtp_secure | string | SMTP协议安全模式 | ssl/tls/no 默认:ssl |
string | 发信邮箱地址 默认等于smtp_email | null | |
name | string | 发信显示用户名 默认等于smtp_name | null |
imap_username | string | IMAP协议用户名 | 如不提交则使用smtp_username |
imap_password | string | IMAP协议密码 | 如不提交则使用smtp_password |
imap_host | string | IMAP协议主机地址 | 空字符串 |
imap_port | int | IMAP协议主机端口 | 993 |
imap_secure | string | IMAP协议安全模式 | ssl/tls/no 默认:ssl |
reply_email | string | 自定义的回复地址 | null |
bcc_email | string | BCC地址 | null |
custom_trace_domain | string | 跟踪域名 | null |
{
"success": true,
"id": 1***
}
参数 | 数据类型 | 描述 |
success | bool | 接口标识 true:成功 false:失败 |
id | int | 邮箱标识ID |
POST修改自有邮箱
修改账户自有邮箱,并验证发信和收信状态修改账户已创建的自有邮箱,并验证邮箱发信和收信状态是否有效
POST https://open.geeksend.com/mailbox/modify
参数 | 类型 | 描述 | 默认值 |
id | int | 自由邮箱数据ID | 0 |
limit | int | 每天的发送限制 | 17280 |
delay_type | string | 发送间隔延迟类型 | fixed/random 默认:fixed |
fixed_delay | int | 如果是fixed模式的间隔时间 单位秒 | 5 |
min_delay | int | 如果是random模式的最小间隔时间 单位秒 | 5 |
max_delay | int | 如果是random模式的最大间隔时间 单位秒 | 30 |
smtp_name | string | SMTP显示的发信人名称 | 可为空 默认:null |
smtp_email | string | SMTP显示的发信邮件地址 | null |
smtp_username | string | SMTP协议用户名 | 通常和smtp_email一致, 如不提交则使用smtp_email |
smtp_password | string | SMTP协议密码 | null |
smtp_host | string | SMTP协议主机地址 | null |
smtp_port | int | SMTP协议主机端口 | 587 |
smtp_secure | string | SMTP协议安全模式 | ssl/tls/no 默认:ssl |
string | 发信邮箱地址 默认等于smtp_email | null | |
name | string | 发信显示用户名 默认等于smtp_name | null |
imap_username | string | IMAP协议用户名 | 如不提交则使用smtp_username |
imap_password | string | IMAP协议密码 | 如不提交则使用smtp_password |
imap_host | string | IMAP协议主机地址 | null |
imap_port | int | IMAP协议主机端口 | 993 |
imap_secure | string | IMAP协议安全模式 | ssl/tls/no 默认:ssl |
reply_email | string | 自定义的回复地址 | null |
bcc_email | string | BCC地址 | null |
custom_trace_domain | string | 跟踪域名 | null |
custom_trace_domain_id | int | 跟踪域名ID | 0 |
{
"success": true,
"id": 1***,
"change": true
}
参数 | 数据类型 | 描述 |
success | bool | 接口标识 true:成功 false:失败 |
id | int | 修改邮箱数据的标识ID |
change | bool | 修改结果 true:成功 false:失败 |
POST查询自有邮箱
查询自有邮箱查询用户已创建的自有邮箱数据
POST https://open.geeksend.com/mailbox/query
参数 | 数据类型 | 描述 | 默认值 |
page | int | 查询分页当前数 | 1 |
limit | int | 每页显示数 | 50 |
query | string | 查询邮箱 支持模糊搜索 | null |
{
"success": true,
"list": [
{
"id": 1***,
"email": "demo@***.com",
"name": "demo",
"smtp_username": "demo",
"imap_username": "demo",
"smtp_host": "smtp.qq.com",
"imap_host": "imap.qq.com",
"smtp_port": 465,
"imap_port": 993,
"smtp_secure": "ssl",
"imap_secure": "ssl"
},
{
"id": 1***,
"email": "demo*@***.com",
"name": "demo**",
"smtp_username": "demo**",
"imap_username": "demo**",
"smtp_host": "smtp.163.com",
"imap_host": "imap.163.com",
"smtp_port": 465,
"imap_port": 993,
"smtp_secure": "ssl",
"imap_secure": "ssl"
}
],
"total": 2
}
参数 | 数据类型 | 描述 |
success | bool | 接口标识 true:成功 false:失败 |
total | int | 账户邮箱总数 |
list | object | 邮箱数据对象集合 |
→ | 以下是list 单个对象字段 | |
id | int | 邮箱数据标识ID |
string | 邮箱地址 | |
name | string | 邮箱用户名 |
smtp_username | string | SMTP用户名 |
imap_username | string | IMAP用户名 |
smtp_host | string | SMTP 主机名 |
imap_host | string | IMAP 主机名 |
smtp_port | int | SMTP 端口号 |
imap_port | int | IMAP 端口号 |
smtp_secure | string | SMTP 加密协议 如:ssl tls |
imap_secure | string | IMAP 加密协议 如:ssl tls |
POST验证自有邮箱
验证自有邮箱验证用户已创建的自有邮箱数据
POST https://open.geeksend.com/mailbox/check
参数 | 数据类型 | 描述 | 默认值 |
id | int | 自有邮箱数据ID | 1 |
{
"success": true,
"smtp_status": 1,
"imap_status": 1,
"smtp_text": "",
"imap_text": ""
}
参数 | 数据类型 | 描述 |
success | bool | 接口标识 true:成功 false:失败 |
smtp_status | int | SMTP 状态值 1:有效 2:无效 |
imap_status | int | IMAP状态值 1:有效 2:无效 |
smtp_text | string | SMTP 错误信息 |
imap_text | string | IMAP 错误信息 |
POST删除自有邮箱
删除自有邮箱删除用户已创建的自有邮箱数据
POST https://open.geeksend.com/mailbox/delete
参数 | 数据类型 | 描述 | 默认值 |
id | int | 自由邮箱数据ID | 0 |
{
"success": true,
"id": 1***
}
参数 | 数据类型 | 描述 |
success | bool | 接口标识 true:成功 false:失败 |
id | int | 要删除的邮箱数据标识ID |
域名邮箱
POST创建发信域名
创建发信域名,并验证腾讯云和阿里云域名状态创建发信域名,并验证腾讯云和阿里云域名状态
POST https://open.geeksend.com/edm/createDomain
参数 | 类型 | 描述 | 默认值 |
domain | string | 域名地址 | null |
{
"success": true,
"domain_id": 1***
}
参数 | 数据类型 | 描述 |
success | bool | 返回标识 true:成功 false:失败 |
domain_id | int | 返回创建的发信域名id |
POST获取发信域名及配置信息
获取发信域名及配置信息获取发信域名及配置信息
POST https://open.geeksend.com/edm/descDomain
参数 | 类型 | 描述 | 默认值 |
domain_id | int | 自由域名ID (创建返回的domain_id) | 0 |
{
"success": true,
"data": {
"domain_id": 1***,
"dkim_record_type_1": "TXT",
"dkim_record_1": "domainkey.***.com",
"dkim_value_1": "",
"dkim_status_1": 0,
"dkim_record_type_2": "TXT",
"dkim_value_2": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADC***",
"dkim_record_2": "qcloud_***.com",
"dkim_status_2": 0,
"dkim_record_type_3": "CNAME",
"dkim_record_3": "geeksend_***.com",
"dkim_value_3": "dkim.geeksend.io",
"dkim_status_3": 0,
"spf_record_type": "TXT",
"spf_record": "ccc.***.com",
"spf_value": "v=spf1 include:spf.geeksend.io ~all",
"mx_record_type": "MX",
"mx_record": "ccc.***.com",
"mx_value": "edm.***.io",
"mx_pri": 10,
"dmarc_record_type": "TXT",
"dmarc_record": "ccc.***.com",
"dmarc_value": "v=DMARC1; p=none",
"spf_status": 0,
"mx_status": 0,
"dmarc_status": 0,
"status": 0
}
}
参数 | 数据类型 | 描述 |
domain_id | int | 发信域名ID |
dkim_record_type_1 | string | 阿里云DKIM记录类型 |
dkim_record_1 | string | 阿里云DKIM记录值 |
dkim_value_1 | string | 阿里云DKIM值 |
dkim_status_1 | int | 阿里云DKIM状态值 |
dkim_record_type_2 | string | 腾讯云DKIM记录类型 |
dkim_value_2 | string | 腾讯云DKIM记录值 |
dkim_record_2 | string | 腾讯云DKIM值 |
dkim_status_2 | int | 腾讯云DKIM状态值 |
dkim_record_type_3 | string | geeksend DKIM记录类型 |
dkim_record_3 | string | geeksend DKIM记录类型 |
dkim_value_3 | string | geeksend DKIM值 |
dkim_status_3 | int | geeksend DKIM状态值 |
spf_record_type | string | SPF记录类型 |
spf_record | string | SPF记录值 |
spf_value | string | SPF值 |
mx_record_type | string | MX记录类型 |
mx_record | string | MX记录值 |
mx_value | string | MX值 |
mx_pri | int | MX优先级值 固定10 |
dmarc_record_type | string | DMARC记录类型 固定txt |
dmarc_record | string | DMARC记录值 |
dmarc_value | string | DMARC值 |
spf_status | int | SPF状态值 |
mx_status | int | MX状态值 |
dmarc_status | int | DMARC状态值 |
status | int | 状态值 |
POST查询发信域名
查询发信域名查询发信域名
POST https://open.geeksend.com/edm/queryDomain
参数 | 类型 | 描述 | 默认值 |
page | int | 查询当前页 | 1 |
limit | int | 分页每页数 | 50 |
query | string | 查询域名关键词 | null |
{
"success": true,
"list": [
{
"domain_id": 1***,
"domain": "ccc.***.com",
"status": 2
},
{
"domain_id": 1***,
"domain": "***.com",
"status": 0
}
],
"total": 2
}
参数 | 数据类型 | 描述 |
success | bool | 返回标识 true:成功 false:失败 |
total | int | 域名总数 |
list | array | 返回域名列表 |
→ | 下面是list 字段 | |
domain_id | int | 发信域名ID |
domain | string | 发信域名 |
status | int | 发信域名状态 0:未知 1:有效 2:无效 |
POST验证发信域名
验证发信域名验证发信域名
POST https://open.geeksend.com/edm/checkDomain
参数 | 类型 | 描述 | 默认值 |
domain_id | int | 待验证的域名ID | 0 |
"success": true,
"msg": "The domain is verified",
"data": {
"domain_id": 1***,
"domain": "momo.***.email",
"status": 1,
"spf_status": 1,
"mx_status": 1,
"dmarc_status": 1,
"dkim_status": 1,
"dkim_status_1": 1,
"dkim_status_2": 1,
"dkim_status_3": 1
}
}
参数 | 数据类型 | 描述 |
success | bool | 返回标识 true:成功 false:失败 |
msg | string | 提示信息 |
data | object | data对象 |
→ | 以下data对象字段 | |
domain_id | int | 域名ID |
domain | string | 域名 |
status | int | 状态 1:有效 2:无效 0:未验证 (以下状态值均是) |
spf_status | int | SPF状态值 |
mx_status | int | MX状态值 |
dmarc_status | int | DMARC状态值 |
dkim_status | int | DKIM状态值 |
dkim_status_1 | int | 阿里云DKIM状态值 |
dkim_status_2 | int | 腾讯云DKIM状态值 |
dkim_status_3 | int | geeksend DKIM状态值 |
POST删除发信域名
删除发信域名删除发信域名
POST https://open.geeksend.com/edm/deleteDomain
参数 | 类型 | 描述 | 默认值 |
domain_id | int | 要删除的域名ID | 0 |
{
"success": true,
"msg": "The deletion is successful"
}
参数 | 数据类型 | 描述 |
success | bool | 标识 true:成功 false:失败 |
msg | string | 提示信息 |
POST创建邮箱
创建邮箱创建有效域名下的邮箱,并验证邮箱状态
POST https://open.geeksend.com/edm/edm/createEmail
参数 | 类型 | 描述 | 默认值 |
domain_id | int | 有效域名ID | 0 |
string | 邮箱 | null |
{
"success": true,
"email_id": 1***,
"msg": "success"
}
参数 | 数据类型 | 描述 |
success | bool | 标识 true:成功 false:失败 |
email_id | int | 创建邮箱数据ID |
msg | string | 提示信息 |
POST查询邮箱
查询邮箱查询邮箱
POST https://open.geeksend.com/edm/queryEmail
参数 | 类型 | 描述 | 默认值 |
page | int | 查询当前页 | 1 |
limit | int | 分页每页数 | 50 |
query | string | 查询邮箱关键词 | 空字符串 |
"success": true,
"list": [
{
"email_id": 1***,
"email": "service99@***.email",
"name": "service99"
},
{
"email_id": 1***,
"email": "service-1601@***.email",
"name": "service-1601"
}
],
"total": 2
}
参数 | 数据类型 | 描述 |
success | bool | 标识 true:成功 false:失败 |
total | int | 账户邮箱总数 |
list | object | 账户邮箱列表 |
→ | ||
email_id | int | 邮箱ID |
string | 邮箱 | |
name | string | 邮箱用户名 |
POST修改邮箱
修改邮箱修改邮箱
POST https://open.geeksend.com/edm/modifyEmail
参数 | 类型 | 描述 | 默认值 |
email_id | int | 创建邮箱返回标识ID | 0 |
limit | int | 分页每页数 | null |
name | string | 查询域名关键词 | null |
delay_type | string | 延迟类型 fixed|random | null |
fixed_type | int | 固定延迟 单位S | null |
min_delay | int | 最小延迟 | null |
max_delay | int | 最大延迟 | null |
reply_email | string | 回复地址 | null |
bcc_email | string | 抄送地址 | null |
custom_trace_domain | string | 跟踪域名 | null |
custom_trace_domain_id | int | 跟踪域名ID | 0 |
{
"success": true,
"id": 1***,
"change": true
}
参数 | 数据类型 | 描述 |
success | bool | 标识 true:成功 false:失败 |
id | int | 邮箱ID |
change | bool | 更新标识 true:成功 false:失败 |
POST删除邮箱
删除邮箱删除邮箱
POST https://open.geeksend.com/edm/deleteEmail
参数 | 类型 | 描述 | 默认值 |
email_id | int | 待删除的邮箱ID | 0 |
{
"success": true,
"msg": "The deletion is successful"
}
参数 | 数据类型 | 描述 |
success | bool | 接口标识 true:成功 false:失败 |
msg | string | 提示信息 |