立即注册

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域名搜索

每10个邮箱地址 1个积分；1个潜在客户 1个积分

输入域名：geeksend.com， 将返回该域名上的所有邮箱地址。
如果数据库中存有关于邮箱所有者的任何其他信息，我们也会将其添加进来。
每次响应最多返回 100 个邮箱地址或100个潜在客户。
每10个邮箱地址，扣除1个积分（不满10按照10计算）；每1个潜在客户，扣除1个积分。
如果没有返回邮箱地址或潜在客户，则不会向您收取该请求的费用。
 

请求
POST https://open.geeksend.com/search/domain_emails_with_info
输入参数
domain是您要从中查询电子邮箱地址的域名名称。例如：geeksend.com
type它包含不同的值 - all 、personal 或 generic。通用的电子邮箱地址是基于职务的电子邮箱地址，例如 - contact@geeksend.com.
个人的电子邮箱地址是在公司工作的实际人员的电子邮箱地址。
limit设置返回的电子邮箱地址的数量限制。每次响应最多返回100个电子邮箱地址。
lastId若要收集的邮箱地址数量超过您在“limit”输入参数中设置的数量，请您在下一个请求中输入上一个请求中最后收集的邮箱地址 ID。这样，系统将跳过之前收集过的邮箱。
请注意，lastId 是必填参数。
默认值为 0。
positions使用此参数过滤潜在客户的职位，例如：“Software Developer”。如需过滤多个职务，请输入一些必要的职位名称
 
代码示例
def get_domain_search():
    token = get_access_token()
    headers = {
        "Authorization":f"Bearer {token}"
    }
    params = {
      'domain': 'geeksend.com',
      'type': 'all',
      'limit': 100,
      'lastId': 0,
    }
    res = requests.post('https://open.geeksend.com/search/domain_emails_with_info',headers=headers,data=params)
    print(res.json())
回执示例
{
    "success": true,
    "domain": "huawei.com",
    "result": 100,
    "lastId": 17268170,
    "limit": 100,
    "companyName": "geeksend",
    "emails": [
        {
            "email": "info@geeksend.com",
            "type": "personal",
            "status": "valid"
        }
    ]
}
输出参数
domainAPI 已为其提供电子邮箱地址的域名。
limit指定要返回的电子邮箱地址的最大数量。
companyName用于查找电子邮箱地址的公司名称。
emails在搜索中检索到的域名电子邮箱的数组。
email在搜索中检索到的特定电子邮箱地址。
type包含prospect 或 email值。如果返回类型为 prospect，则Geeksend.com已找到有关邮箱地址所有者的其他信息。
status电子邮箱的验证状态。电子邮箱的状态可以是verified 或 notVerified.
firstName邮箱地址所有者的名字。
lastName邮箱地址所有者的姓氏。
position邮箱地址所有者的当前职位。
sourcePage检索到的个人数据的源页面。
lastId上一个回执中最后收集到的邮箱地址ID。

POST邮箱地址数量

免费

通过API的方式，您可以在我们的数据库中查询到某个域名下的邮箱地址数量，此功能完全免费，无需支付积分。

请求
POST https://open.geeksend.com/search/get_domain_emails_count
输入参数
domain您想知道我们数据库中邮箱地址数量的域名名称。
代码示例
def get_email_count():
    token = get_access_token()
    headers = {
        "Authorization":f"Bearer {token}"
    }
    params = {
        'domain':'geeksend.com'
    }
    res = requests.post('https://open.geeksend.com/search/get_domain_emails_count',headers=headers, data=params)
    print(json.dumps(res.json()))
回执示例
{"success": true, "domain": "geeksend.com", "result": 417}
输出参数
domain您想知道我们数据库中邮箱地址数量的域名的名称。
result我们已找到该域名下的电子邮箱地址的数量。如果我们无法提供该域名的结果，则该域的结果始终是0 .

POST电子邮箱查找器

每个请求 1个积分

通过API可按照名字和姓氏以及域名来查找邮箱地址。如果我们的数据库中不存在此电子邮箱地址，我们将无法立即为您提供结果。

请求
POST https://open.geeksend.com/search/get_emails_from_names
输入参数
firstName邮箱地址所有者的名字。
lastName邮箱地址所有者的姓氏。
domain邮箱地址中使用的公司的域名。
代码示例
def get_email_finder():
    token = get_access_token()
    headers = {
        "Authorization":f"Bearer {token}"
    }
    params = {
        'domain':'geeksend.com',
        'firstName': 'Junn',
        'lastName':'Dai'
    }
    res = requests.post('https://open.geeksend.com/search/get_emails_from_names',headers=headers,data=params)
    print(json.dumps(res.json()))
回执示例
{
    "success": true,
    "params": {
        "firstName": "Junn",
        "lastName": "Dai",
        "domain": "geeksend.com"
    },
    "data": {
        "firstName": "Junn",
        "lastName": "Dai",
        "emails": [

        ]
    },
    "status": {
        "identifier": "not_found",
        "description": "Emails search is completed"
    }
}
 
输出参数
status使用此对象中的值来检测流程的状态。
identifier可能包含以下值：complete ,in_progress , 或 not_found 。如果标识符为 not_found ，回执将包含一个没有邮箱地址的数组。
description在这里，您将看到有关邮箱地址查找状态的文字说明。
data包含搜索结果。
firstName邮箱地址所有者的名字。
lastName邮箱地址所有者的姓氏。
emails邮箱地址及其状态的数组。值emailStatus可能包含：valid 或unknown .

POST通过网址获取潜在客户

每个请求 1个积分

通过您输入的潜在客户的社交网址，Geeksend会返回潜在客户的完整信息以及找到的邮箱地址。该方法的前提是您需要拥有潜在客户的社交网址，否则将不会显示结果。

 

请求
POST https://open.geeksend.com/search/get_emails_from_url
输入参数
url潜在客户社交媒体资料的链接。在(括号)中指定社交网络的名称(领英或X) 。
代码示例
def get_emails_from_url():
    token = get_access_token()
    headers = {
        "Authorization":f"Bearer {token}"
    }
    params = {
        'url':'https://www.linkedin.com/in/geeksend'
    }
    res = requests.post('https://open.geeksend.com/search/get_emails_from_url', headers=headers, data=params)
    print(json.dumps(res.json()))
回执示例
{
    "success": true,
    "data": [
        {
            "id": "DLAr4OjP",
            "name": "geeksend",
            "firstName": "geeksend",
            "lastName": "geeksend",
            "sourcePage": "https://linkedin.com/in/geeksend",
            "source": "linkedin",
            "industry": "research",
            "country": "china",
            "locality": "shenzhen, china,",
            "lastUpdateDate": {
                "date": "1970-01-01 08:00:00",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "currentJob": [
                {
                    "companyName": "geeksend",
                    "position": "",
                    "socialLink": "https://linkedin.com/company/geeksend",
                    "site": "https://geeksend.com",
                    "locality": "shenzhen, china",
                    "state": "",
                    "city": "shenzhen",
                    "street": "",
                    "street2": "",
                    "postal": "",
                    "founded": "1856",
                    "startDate": "",
                    "endDate": null,
                    "size": "10001+",
                    "industry": "web",
                    "companyType": "",
                    "country": "china"
                }
            ],
            "previousJob": [],
            "social": [
                {
                    "type": "linkedin",
                    "link": "https://linkedin.com/in/geeksend"
                }
            ],
            "emails": [
                {
                    "email": "info@geeksend.com",
                    "emailStatus": "valid"
                }
            ]
        }
    ]
}
输出参数
success是 true如果已经找到潜在客户
id唯一的配置文件标识符
name潜在客户全名
firstName潜在客户名字
lastName潜在客户姓氏
industry潜在客户资料中显示的行业
country潜在客户所在国家
locality潜在客户所在地点
skills潜在客户技能
social潜在客户的社交资料链接
currentJobs数组包含有关潜在客户当前职务的信息
previousJobs数组包含有关潜在客户以前职务的信息
lastUpdateDate上次资料更新日期
emails潜在客户的邮箱地址（包含实际状态）

POST获取含有邮箱地址的社交账户资料

每个请求 1个积分

当您提供一个邮箱地址时，Geeksend 会从数据库中返回与该邮箱地址所有者相关的所有配置文件信息。若我们在数据库中未能找到有关该邮箱地址所有者的信息，那么此次请求将不会向您收取费用。

请求
POST https://open.geeksend.com/search/get_profile_by_email
输入参数
email您想要查找其他信息的人的邮箱地址。
代码示例
def get_profile_by_email():
    token = get_access_token()
    headers = {
        "Authorization": f"Bearer {token}"
    }
    params = {
        'email':'info@geeksend.com'
    }

    res = requests.post('https://open.geeksend.com/search/get_profile_by_email', headers=headers, data=params)
    print(json.dumps(res.json()))
回执示例
{
    "success": true,
    "id": "DyExGRgL",
    "source": "linkedin",
    "name": "geeksend",
    "firstName": "geeksend",
    "lastName": "geeksend",
    "industry": null,
    "country": "China",
    "locality": "China, shenzhen",
    "social": [
        {
            "type": "linkedin",
            "link": "https://linkedin.com/in/geeksend"
        }
    ],
    "currentJobs": {
        "companyName": "geeksend",
        "position": "",
        "socialLink": "https://linkedin.com/company/geeksend",
        "site": "http://www.geeksend.com",
        "locality": "China",
        "state": "shenzhen",
        "city": "shenzhen",
        "street": "",
        "street2": "",
        "postal": "",
        "founded": "1921",
        "startDate": "",
        "endDate": null,
        "size": "10,001+",
        "industry": "geeksend",
        "companyType": "",
        "country": "China"
    },
    "previousJobs": [],
    "lastUpdateDate": "2024-09-25 14:56:25"
}
输出参数
id唯一的配置文件标识符。
source检索到的个人数据的来源。
name邮箱地址所有者的全名。
firstName此人的名字。
lastName此人的姓氏。
logo此人的资料照片。
industry来源中显示的此人所在行业。
country来源中显示的此人所在国家/地区。
locality来源中显示的此人所在地点。
social到此人社交资料链接。
currentJobs包含有关此人当前工作职位信息的数组。
previousJobs一个包含有关此人以前工作职位信息的数组。
lastUpdateDate数据库中最后一份资料的更新日期。

电子邮箱验证器

POST电子邮箱验证器

免费

该方法可以检查您所提供的邮箱地址是否有效。API 端点会返回邮箱地址的验证结果。若我们之前未曾验证过某个邮箱地址，那么结果将不会反馈给您。在此情况下，API 将返回 “not_verified” 标识符，并且不会向您收取积分。此时，您应使用 “添加邮箱地址用于验证” 方法推送此邮箱地址进行验证，之后您便能够使用此端点获取邮箱地址的验证结果。

请求
POST https://open.geeksend.com/verify/get_emails_verification_status
输入参数
emails您需要验证的邮箱地址。
代码示例
def get_email_verifier():
    token = get_access_token()
    headers = {
        "Authorization": f"Bearer {token}",
        "Content-Type": "application/json"
    }
    params = {
        'emails': ['info@geeksend.com','help@geeksend.com'],
    }
    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描述邮箱地址验证状态
email提交的邮箱地址
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"
    ]
}

如果将邮箱地址成功添加到队列中，则该方法返回 {"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 发送中】

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_idintwebhook id
end_pointstring您在添加webhook时提供的实际URL地址及其发送位置
event_objectstring执行操作对象，详情见添加
event_actionsting对象的操作,  详情见添加
create_timeint添加webhook的创建时间。Unix Timestamp格式
statusstringwebhook状态，启用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_idintwebhook 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_idintwebhook 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
输入参数
参数类型描述默认值
limitint每天的发送限制17280
delay_typestring发送间隔延迟类型fixed/random  默认:fixed
fixed_delayint如果是fixed模式的间隔时间 单位秒5
min_delayint如果是random模式的最小间隔时间 单位秒5
max_delayint如果是random模式的最大间隔时间 单位秒30
smtp_namestringSMTP显示的发信人名称 *可为空 默认:空字符串
smtp_emailstringSMTP显示的发信邮件地址 *null
smtp_usernamestringSMTP协议用户名 通常和smtp_email一致, 如不提交则使用smtp_email
smtp_passwordstringSMTP协议密码 *null
smtp_hoststringSMTP协议主机地址 *null
smtp_portintSMTP协议主机端口 *587
smtp_securestringSMTP协议安全模式 *ssl/tls/no 默认:ssl
emailstring发信邮箱地址 默认等于smtp_emailnull
namestring发信显示用户名  默认等于smtp_namenull
imap_usernamestringIMAP协议用户名如不提交则使用smtp_username
imap_passwordstringIMAP协议密码如不提交则使用smtp_password
imap_hoststringIMAP协议主机地址空字符串
imap_portintIMAP协议主机端口993
imap_securestringIMAP协议安全模式ssl/tls/no 默认:ssl
reply_emailstring自定义的回复地址null
bcc_emailstringBCC地址null
custom_trace_domainstring跟踪域名null

 

回执示例
{
    "success": true,
    "id": 1***
}
 
输出参数
参数数据类型描述
successstring接口标识 true:成功  false:失败
idint创建邮箱标识ID

 

 

POST修改自有邮箱

修改账户自有邮箱,并验证发信和收信状态

修改账户已创建的自有邮箱，并验证邮箱发信和收信状态是否有效

请求
POST https://open.geeksend.com/mailbox/modify
输入参数
参数类型描述默认值
idint自由邮箱数据ID0
limitint每天的发送限制17280
delay_typestring发送间隔延迟类型fixed/random  默认:fixed
fixed_delayint如果是fixed模式的间隔时间 单位秒5
min_delayint如果是random模式的最小间隔时间 单位秒5
max_delayint如果是random模式的最大间隔时间 单位秒30
smtp_namestringSMTP显示的发信人名称 *可为空 默认:null
smtp_emailstringSMTP显示的发信邮件地址 *null
smtp_usernamestringSMTP协议用户名 通常和smtp_email一致, 如不提交则使用smtp_email
smtp_passwordstringSMTP协议密码 *null
smtp_hoststringSMTP协议主机地址 *null
smtp_portintSMTP协议主机端口 *587
smtp_securestringSMTP协议安全模式 *ssl/tls/no 默认:ssl
emailstring发信邮箱地址 默认等于smtp_emailnull
namestring发信显示用户名 默认等于smtp_namenull
imap_usernamestringIMAP协议用户名如不提交则使用smtp_username
imap_passwordstringIMAP协议密码如不提交则使用smtp_password
imap_hoststringIMAP协议主机地址null
imap_portintIMAP协议主机端口993
imap_securestringIMAP协议安全模式ssl/tls/no 默认:ssl
reply_emailstring自定义的回复地址null
bcc_emailstringBCC地址null
custom_trace_domainstring跟踪域名null
custom_trace_domain_idint跟踪域名ID0

 

回执示例
{
    "success": true,
    "id": 1***,
    "change": true
}
输出参数
参数数据类型描述
successstring接口标识 true:成功  false:失败
idstring修改邮箱数据的标识ID
changestring修改结果 true:成功  false:失败

 

 

POST查询自有邮箱

查询自有邮箱

查询用户已创建的自有邮箱数据

请求
POST https://open.geeksend.com/mailbox/query
输入参数
参数数据类型描述默认值
pageint查询分页当前数1
limitint每页显示数50
querystring查询邮箱 支持模糊搜索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
}
输出参数
参数数据类型描述
successstring接口标识 true:成功  false:失败
totalint账户邮箱总数
listobject邮箱数据对象集合
→ 以下是list 单个对象字段
idint邮箱数据标识ID
emailstring邮箱地址
namestring邮箱用户名
smtp_usernamestringSMTP用户名
imap_usernamestringIMAP用户名
smtp_hoststringSMTP 主机名
imap_hoststringIMAP 主机名
smtp_portintSMTP 端口号
imap_portintIMAP 端口号
smtp_securestringSMTP 加密协议 如:ssl tls
imap_securestringIMAP 加密协议 如:ssl tls

SMTP（简单邮件传输协议） SMTP 是用于发送电子邮件的标准协议

IMAP（互联网邮件访问协议）IMAP 是用于接收和管理电子邮件的协议

POST验证自有邮箱

验证自有邮箱

验证用户已创建的自有邮箱数据

请求
POST https://open.geeksend.com/mailbox/check
输入参数
参数数据类型描述默认值
idint自有邮箱数据ID1
回执示例
{
    "success": true,
    "smtp_status": 1,
    "imap_status": 1,
    "smtp_text": "",
    "imap_text": ""
}
输出参数
参数数据类型描述
successstring接口标识 true:成功  false:失败
smtp_statusstringSMTP 状态值 1:有效 2:无效
imap_statusstringIMAP状态值   1:有效 2:无效
smtp_textstringSMTP 错误信息
imap_textstringIMAP 错误信息

 

 

POST删除自有邮箱

删除自有邮箱

删除用户已创建的自有邮箱数据

请求
POST https://open.geeksend.com/mailbox/delete
输入参数
参数数据类型描述默认值
idint自由邮箱数据ID0
回执示例
{
    "success": true,
    "id": 1***
}
输出参数
参数数据类型描述
successstring接口标识 true:成功  false:失败
idint要删除的邮箱数据标识ID