3 个稳定版本
| 3.3.0 | 2024 年 5 月 27 日 |
|---|---|
| 3.1.0 | 2022 年 12 月 11 日 |
| 3.0.0 | 2022 年 11 月 27 日 |
#25 in 电子邮件
158 个月下载量
1MB
11K SLoC
Rust API 客户端用于 sendinblue v3
使用： https://github.com/OpenAPITools/openapi-generator 生成
SendinBlue 提供一个 RESTFul API，可用于任何语言。使用此 API，您将能够
- 管理您的活动并获取统计数据
- 管理您的联系人
- 发送事务性电子邮件和短信
- 以及更多...
您可以在 https://github.com/orgs/sendinblue 下载我们的包装器
可能的响应
| 代码 | 消息 |
|---|---|
| 200 | OK. 成功请求 |
| 201 | OK. 成功创建 |
| 202 | OK. 请求已接受 |
| 204 | OK. 成功更新/删除 |
| 400 | 错误。无效请求 |
| 401 | 错误。需要身份验证 |
| 402 | 错误。信用不足，需要计划升级 |
| 403 | 错误。权限被拒绝 |
| 404 | 错误。对象不存在 |
| 405 | 错误。不允许的方法 |
| 406 | 错误。不可接受 |
有关更多信息，请访问 https://account.sendinblue.com/support
概述
此 API 客户端由 OpenAPI Generator 项目生成。通过使用远程服务器上的 openapi-spec，您可以轻松生成 API 客户端。
- API 版本：3.0.0
- 包版本：3.0.0
- 构建包：
org.openapitools.codegen.languages.RustClientCodegen
安装
将包放入您的项目文件夹中名为 sendinblue-v3 的目录下，并在 Cargo.toml 中添加以下内容，位于 [dependencies]
sendinblue-v3 = 3.0.0
API端点文档
所有URI均相对于 https://api.sendinblue.com/v3
| 类 | 方法 | HTTP请求 | 描述 |
|---|---|---|---|
| AccountApi | get_account | GET /account | 获取您的账户信息、计划及信用详情 |
| AttributesApi | create_attribute | POST /contacts/attributes/{attributeCategory}/{attributeName} | 创建联系属性 |
| AttributesApi | delete_attribute | DELETE /contacts/attributes/{attributeCategory}/{attributeName} | 删除属性 |
| AttributesApi | get_attributes | GET /contacts/attributes | 列出所有属性 |
| AttributesApi | update_attribute | PUT /contacts/attributes/{attributeCategory}/{attributeName} | 更新联系属性 |
| ContactsApi | add_contact_to_list | POST /contacts/lists/{listId}/contacts/add | 将现有联系人添加到列表中 |
| ContactsApi | create_attribute | POST /contacts/attributes/{attributeCategory}/{attributeName} | 创建联系属性 |
| ContactsApi | create_contact | POST /contacts | 创建联系人 |
| ContactsApi | create_doi_contact | POST /contacts/doubleOptinConfirmation | 通过DOI（双重确认）流程创建联系人 |
| ContactsApi | create_folder | POST /contacts/folders | 创建文件夹 |
| ContactsApi | create_list | POST /contacts/lists | 创建列表 |
| ContactsApi | delete_attribute | DELETE /contacts/attributes/{attributeCategory}/{attributeName} | 删除属性 |
| ContactsApi | delete_contact | DELETE /contacts/{email} | 删除联系人 |
| ContactsApi | delete_folder | DELETE /contacts/folders/{folderId} | 删除文件夹（及其所有列表） |
| ContactsApi | delete_list | DELETE /contacts/lists/{listId} | 删除列表 |
| ContactsApi | get_attributes | GET /contacts/attributes | 列出所有属性 |
| ContactsApi | get_contact_info | GET /contacts/{email} | 获取联系人的详细信息 |
| ContactsApi | get_contact_stats | GET /contacts/{email}/campaignStats | 获取联系人的电子邮件活动统计信息 |
| ContactsApi | get_contacts | GET /contacts | 获取所有联系人 |
| ContactsApi | get_contacts_from_list | GET /contacts/lists/{listId}/contacts | 获取列表中的联系人 |
| ContactsApi | get_folder | GET /contacts/folders/{folderId} | 返回文件夹的详细信息 |
| ContactsApi | get_folder_lists | GET /contacts/folders/{folderId}/lists | 获取文件夹中的列表 |
| ContactsApi | get_folders | GET /contacts/folders | 获取所有文件夹 |
| ContactsApi | get_list | GET /contacts/lists/{listId} | 获取列表的详细信息 |
| ContactsApi | get_lists | GET /contacts/lists | 获取所有列表 |
| ContactsApi | import_contacts | POST /contacts/import | 导入联系人 |
| ContactsApi | remove_contact_from_list | POST /contacts/lists/{listId}/contacts/remove | 从列表中删除联系人 |
| ContactsApi | request_contact_export | POST /contacts/export | 导出联系人 |
| ContactsApi | update_attribute | PUT /contacts/attributes/{attributeCategory}/{attributeName} | 更新联系属性 |
| ContactsApi | update_contact | PUT /contacts/{email} | 更新联系人 |
| ContactsApi | update_folder | PUT /contacts/folders/{folderId} | 更新文件夹 |
| ContactsApi | update_list | PUT /contacts/lists/{listId} | 更新列表 |
| EmailCampaignsApi | create_email_campaign | POST /emailCampaigns | 创建电子邮件活动 |
| EmailCampaignsApi | delete_email_campaign | DELETE /emailCampaigns/{campaignId} | 删除电子邮件活动 |
| EmailCampaignsApi | email_export_recipients | POST /emailCampaigns/{campaignId}/exportRecipients | 导出电子邮件活动的收件人 |
| EmailCampaignsApi | get_ab_test_campaign_result | GET /emailCampaigns/{campaignId}/abTestCampaignResult | 获取A/B测试电子邮件活动的结果 |
| EmailCampaignsApi | get_email_campaign | GET /emailCampaigns/{campaignId} | 获取电子邮件活动的报告 |
| EmailCampaignsApi | get_email_campaigns | GET /emailCampaigns | 返回所有创建的电子邮件活动 |
| EmailCampaignsApi | get_shared_template_url | GET /emailCampaigns/{campaignId}/sharedUrl | 获取共享模板的URL |
| EmailCampaignsApi | send_email_campaign_now | POST /emailCampaigns/{campaignId}/sendNow | 立即发送电子邮件活动，基于campaignId |
| EmailCampaignsApi | send_report | POST /emailCampaigns/{campaignId}/sendReport | 发送活动的报告 |
| EmailCampaignsApi | send_test_email | POST /emailCampaigns/{campaignId}/sendTest | 向您的测试列表发送电子邮件活动 |
| EmailCampaignsApi | update_campaign_status | PUT /emailCampaigns/{campaignId}/status | 更新电子邮件活动状态 |
| EmailCampaignsApi | update_email_campaign | PUT /emailCampaigns/{campaignId} | 更新电子邮件活动 |
| EmailCampaignsApi | upload_image_to_gallery | POST /emailCampaigns/images | 将图片上传到您的账户图片库 |
| FoldersApi | create_folder | POST /contacts/folders | 创建文件夹 |
| FoldersApi | delete_folder | DELETE /contacts/folders/{folderId} | 删除文件夹（及其所有列表） |
| FoldersApi | get_folder | GET /contacts/folders/{folderId} | 返回文件夹的详细信息 |
| FoldersApi | get_folder_lists | GET /contacts/folders/{folderId}/lists | 获取文件夹中的列表 |
| FoldersApi | get_folders | GET /contacts/folders | 获取所有文件夹 |
| FoldersApi | update_folder | PUT /contacts/folders/{folderId} | 更新文件夹 |
| ListsApi | add_contact_to_list | POST /contacts/lists/{listId}/contacts/add | 将现有联系人添加到列表中 |
| ListsApi | create_list | POST /contacts/lists | 创建列表 |
| ListsApi | delete_list | DELETE /contacts/lists/{listId} | 删除列表 |
| ListsApi | get_contacts_from_list | GET /contacts/lists/{listId}/contacts | 获取列表中的联系人 |
| ListsApi | get_folder_lists | GET /contacts/folders/{folderId}/lists | 获取文件夹中的列表 |
| ListsApi | get_list | GET /contacts/lists/{listId} | 获取列表的详细信息 |
| ListsApi | get_lists | GET /contacts/lists | 获取所有列表 |
| ListsApi | remove_contact_from_list | POST /contacts/lists/{listId}/contacts/remove | 从列表中删除联系人 |
| ListsApi | update_list | PUT /contacts/lists/{listId} | 更新列表 |
| ProcessApi | get_process | GET /processes/{processId} | 返回一个流程的信息 |
| ProcessApi | get_processes | GET /processes | 返回您账户的所有流程 |
| ResellerApi | add_credits | POST /reseller/children/{childIdentifier}/credits/add | 向特定子账户添加电子邮件和/或短信积分 |
| ResellerApi | associate_ip_to_child | POST /reseller/children/{childIdentifier}/ips/associate | 将专用IP关联到子账户 |
| ResellerApi | create_child_domain | POST /reseller/children/{childIdentifier}/domains | 为子账户创建一个域名 |
| ResellerApi | create_reseller_child | POST /reseller/children | 创建一个经销商子账户 |
| ResellerApi | delete_child_domain | DELETE /reseller/children/{childIdentifier}/domains/{domainName} | 根据传递的childIdentifier和domainName删除经销商子账户的发送者域名 |
| ResellerApi | delete_reseller_child | DELETE /reseller/children/{childIdentifier} | 根据提供的子标识符删除单个经销商子账户 |
| ResellerApi | dissociate_ip_from_child | POST /reseller/children/{childIdentifier}/ips/dissociate | 将专用IP从子账户中取消关联 |
| ResellerApi | get_child_account_creation_status | GET /reseller/children/{childIdentifier}/accountCreationStatus | 获取经销商子账户创建状态，根据提供的childIdentifier判断是否成功创建（存在）或不存在 |
| ResellerApi | get_child_domains | GET /reseller/children/{childIdentifier}/domains | 获取特定子账户的所有发送者域名 |
| ResellerApi | get_child_info | GET /reseller/children/{childIdentifier} | 获取子账户的详细信息 |
| ResellerApi | get_reseller_childs | GET /reseller/children | 获取所有子账户的列表 |
| ResellerApi | get_sso_token | GET /reseller/children/{childIdentifier}/auth | 获取会话令牌以访问Sendinblue（SSO） |
| ResellerApi | remove_credits | POST /reseller/children/{childIdentifier}/credits/remove | 从特定子账户中删除电子邮件和/或短信积分 |
| ResellerApi | update_child_account_status | PUT /reseller/children/{childIdentifier}/accountStatus | 根据提供的标识符更新经销商子账户状态的信息 |
| ResellerApi | update_child_domain | PUT /reseller/children/{childIdentifier}/domains/{domainName} | 根据传递的childIdentifier和domainName更新经销商子账户的发送者域名 |
| ResellerApi | update_reseller_child | PUT /reseller/children/{childIdentifier} | 根据提供的子标识符更新经销商子账户的信息 |
| SmsCampaignsApi | create_sms_campaign | POST /smsCampaigns | 创建一个短信活动 |
| SmsCampaignsApi | delete_sms_campaign | DELETE /smsCampaigns/{campaignId} | 删除一个短信活动 |
| SmsCampaignsApi | get_sms_campaign | GET /smsCampaigns/{campaignId} | 获取一个短信活动 |
| SmsCampaignsApi | get_sms_campaigns | GET /smsCampaigns | 返回您创建的所有短信活动的信息 |
| SmsCampaignsApi | request_sms_recipient_export | POST /smsCampaigns/{campaignId}/exportRecipients | 导出一个短信活动的接收者 |
| SmsCampaignsApi | send_sms_campaign_now | POST /smsCampaigns/{campaignId}/sendNow | 立即发送您的短信活动 |
| SmsCampaignsApi | send_sms_report | POST /smsCampaigns/{campaignId}/sendReport | 发送一个短信活动的报告 |
| SmsCampaignsApi | send_test_sms | POST /smsCampaigns/{campaignId}/sendTest | 发送一个测试短信活动 |
| SmsCampaignsApi | update_sms_campaign | PUT /smsCampaigns/{campaignId} | 更新短信活动 |
| SmsCampaignsApi | update_sms_campaign_status | PUT /smsCampaigns/{campaignId}/status | 更新活动的状态 |
| SmtpApi | block_new_domain | POST /smtp/blockedDomains | 将新域名添加到阻止域名的列表中 |
| SmtpApi | create_smtp_template | POST /smtp/templates | 创建电子邮件模板 |
| SmtpApi | delete_blocked_domain | DELETE /smtp/blockedDomains/{domain} | 从被阻止域名列表中解除现有域 |
| SmtpApi | delete_hardbounces | POST /smtp/deleteHardbounces | 删除硬退信 |
| SmtpApi | delete_smtp_template | DELETE /smtp/templates/{templateId} | 删除一个非活动的电子邮件模板 |
| SmtpApi | get_aggregated_smtp_report | GET /smtp/statistics/aggregatedReport | 获取一段时间内事务性电子邮件活动的汇总 |
| SmtpApi | get_blocked_domains | GET /smtp/blockedDomains | 获取被阻止域名列表 |
| SmtpApi | get_email_event_report | GET /smtp/statistics/events | 获取所有事务性电子邮件活动（非汇总事件） |
| SmtpApi | get_smtp_report | GET /smtp/statistics/reports | 按日获取事务性电子邮件活动的汇总 |
| SmtpApi | get_smtp_template | GET /smtp/templates/{templateId} | 返回模板信息 |
| SmtpApi | get_smtp_templates | GET /smtp/templates | 获取电子邮件模板列表 |
| SmtpApi | get_transac_blocked_contacts | GET /smtp/blockedContacts | 获取被阻止或取消订阅的事务性联系人列表 |
| SmtpApi | get_transac_email_content | GET /smtp/emails/{uuid} | 获取已发送事务性电子邮件的个性化内容 |
| SmtpApi | get_transac_emails_list | GET /smtp/emails | 基于允许的过滤器获取事务性电子邮件列表 |
| SmtpApi | send_template | POST /smtp/templates/{templateId}/send | 发送模板 |
| SmtpApi | send_test_template | POST /smtp/templates/{templateId}/sendTest | 向您的测试列表发送模板 |
| SmtpApi | send_transac_email | POST /smtp/email | 发送事务性电子邮件 |
| SmtpApi | smtp_blocked_contacts_email_delete | DELETE /smtp/blockedContacts/{email} | 解除或重新订阅事务性联系人 |
| SmtpApi | smtp_log_message_id_delete | DELETE /smtp/log/{messageId} | 删除SMTP事务性日志 |
| SmtpApi | update_smtp_template | PUT /smtp/templates/{templateId} | 更新电子邮件模板 |
| SendersApi | create_sender | POST /senders | 创建新的发件人 |
| SendersApi | delete_sender | DELETE /senders/{senderId} | 删除发件人 |
| SendersApi | get_ips | GET /senders/ips | 获取您账户的所有专用IP地址 |
| SendersApi | get_ips_from_sender | GET /senders/{senderId}/ips | 获取发件人的所有专用IP地址 |
| SendersApi | get_senders | GET /senders | 获取所有发件人列表 |
| SendersApi | update_sender | PUT /senders/{senderId} | 更新发件人 |
| TransactionalSmsApi | get_sms_events | GET /transactionalSMS/statistics/events | 获取所有短信活动（非汇总事件） |
| TransactionalSmsApi | get_transac_aggregated_sms_report | GET /transactionalSMS/statistics/aggregatedReport | 获取一段时间内短信活动的汇总 |
| TransactionalSmsApi | get_transac_sms_report | GET /transactionalSMS/statistics/reports | 按日获取短信活动的汇总 |
| TransactionalSmsApi | send_transac_sms | POST /transactionalSMS/sms | 向手机号码发送短信消息 |
| WebhooksApi | create_webhook | POST /webhooks | 创建webhook |
| WebhooksApi | delete_webhook | DELETE /webhooks/{webhookId} | 删除webhook |
| WebhooksApi | get_webhook | GET /webhooks/{webhookId} | 获取webhook详情 |
| WebhooksApi | get_webhooks | GET /webhooks | 获取所有webhooks |
| WebhooksApi | update_webhook | PUT /webhooks/{webhookId} | 更新webhook |
模型文档
- AbTestCampaignResult
- AbTestCampaignResultClickedLinks
- AbTestCampaignResultStatistics
- AbTestVersionClicksInner
- AbTestVersionStats
- AddChildDomain
- AddContactToList
- AddCredits
- BlockDomain
- CreateAttribute
- CreateAttributeEnumerationInner
- CreateChild
- CreateContact
- CreateDoiContact
- CreateEmailCampaign
- CreateEmailCampaignRecipients
- CreateEmailCampaignSender
- CreateList
- CreateModel
- CreateReseller
- 创建发送者
- 创建发送者IP内联
- 创建发送者模型
- 创建短信活动
- 创建短信活动收件人
- 创建SMTP电子邮件
- 创建SMTP模板
- 创建SMTP模板发送者
- 创建更新联系人模型
- 创建更新文件夹
- 创建Webhook
- 创建进程ID
- 删除硬退信
- 电子邮件导出收件人
- 错误模型
- 获取账户
- 获取账户全部
- 获取账户全部营销自动化
- 获取账户全部计划
- 获取账户全部中继
- 获取账户全部中继数据
- 获取聚合报告
- 获取属性
- 获取属性属性内联
- 获取属性属性内联枚举内联
- 获取被阻止的域
- 获取活动概述
- 获取活动收件人
- 获取活动统计
- 获取子账户创建状态
- 获取子域
- 获取子域内联
- 获取子信息
- 获取子信息全部
- 获取子信息全部API密钥
- 获取子信息全部API密钥V2
- 获取子信息全部API密钥V3
- 获取子信息全部信用
- 获取子信息全部统计
- 获取子账户列表
- 获取子账户列表子内联
- 获取子账户列表子内联全部
- 获取客户端
- 获取联系人活动统计
- 获取联系人活动统计点击内联
- 获取联系人活动统计点击内联链接内联
- 获取联系人活动统计消息已发送内联
- 获取联系人活动统计已打开内联
- 获取联系人活动统计交易属性内联
- 获取联系人活动统计退订
- 获取联系人活动统计退订管理员退订内联
- 获取联系人活动统计退订用户退订内联
- 获取联系人详细信息
- 获取联系人
- 获取联系人联系人内联
- 获取设备浏览器统计
- 获取电子邮件活动
- 获取电子邮件活动全部
- 获取电子邮件活动列表
- 获取电子邮件活动列表活动内联
- 获取电子邮件活动列表活动内联全部
- 获取电子邮件活动列表活动内联全部收件人
- 获取电子邮件活动列表活动内联全部统计
- 获取电子邮件事件报告
- 获取电子邮件事件报告事件内联
- 获取扩展活动概述
- 获取扩展活动概述全部
- 获取扩展活动概述全部发送者
- 获取扩展活动统计
- 获取扩展活动统计活动统计内联
- 获取扩展活动统计全局统计
- 获取扩展客户端
- 获取扩展客户端全部
- 获取扩展客户端全部地址
- 获取扩展联系人详细信息
- 获取扩展联系人详细信息全部
- 获取扩展联系人详细信息全部统计
- 获取扩展联系人详细信息全部统计点击
- 获取扩展联系人详细信息全部统计链接
- 获取扩展联系人详细信息全部统计消息已发送
- 获取扩展联系人详细信息全部统计已打开
- 获取扩展联系人详细信息全部统计退订
- 获取扩展联系人详细信息全部统计退订管理员退订
- 获取扩展联系人详细信息全部统计退订用户退订
- 获取扩展列表
- 获取扩展列表全部
- 获取扩展列表全部活动统计
- 获取文件夹
- 获取文件夹列表
- 获取文件夹列表列表内联
- 获取文件夹
- 获取文件夹文件夹内联
- 获取IP
- 从发送者获取IP
- 获取IP列表
- 从发送者获取IP列表
- 获取列表
- 获取列表列表
- 获取列表列表内联
- 获取列表列表内联全部
- 获取进程
- 获取进程列表
- 获取报告
- 获取报告报告内联
- 获取发送者列表
- 获取发送者列表发送者内联
- 获取发送者列表发送者内联IP内联
- 获取共享模板URL
- 获取短信活动
- 获取短信活动全部
- 获取短信活动概述
- 获取短信活动统计
- 获取短信活动列表
- 获取短信活动列表活动内联
- 获取短信活动列表活动内联全部
- 获取短信活动列表活动内联全部统计
- 获取短信事件报告
- 获取短信事件报告事件内联
- 获取SMTP模板概述
- 获取SMTP模板概述发送者
- 获取SMTP模板列表
- 获取SSO令牌
- 按设备获取统计
- 获取交易聚合短信报告
- 获取交易被阻止的联系人
- 获取交易被阻止的联系人联系人内联
- 获取交易被阻止的联系人联系人内联原因
- 获取交易电子邮件内容
- 获取交易电子邮件内容事件内联
- 获取交易电子邮件列表
- 获取交易电子邮件列表交易电子邮件内联
- 获取交易短信报告
- 获取交易短信报告报告内联
- 获取Webhook
- 获取Webhooks
- 获取WebhooksWebhooks内联
- 管理IP
- 发布联系人信息
- 发布联系人信息联系人
- 发布发送失败
- 发布发送短信测试失败
- 剩余信用模型
- 剩余信用模型子
- 剩余信用模型经销商
- 从列表中删除联系人
- 删除信用
- 请求联系人导出
- 请求联系人导出自定义联系人筛选器
- 请求联系人导入
- 请求联系人导入新列表
- 请求短信收件人导出
- 发送电子邮件
- 发送电子邮件附件内联
- 发送报告
- 发送报告电子邮件
- 发送短信
- 发送SMTP电子邮件
- 发送SMTP电子邮件附件内联
- 发送SMTP电子邮件Bcc内联
- 发送SMTP电子邮件Cc内联
- 发送SMTP电子邮件回复到
- 发送SMTP电子邮件发送者
- 发送SMTP电子邮件到内部
- 发送模板电子邮件
- 发送测试电子邮件
- 发送测试短信
- 发送交易短信
- 更新属性
- 更新属性枚举内部
- 更新活动状态
- 更新子项
- 更新子账户状态
- 更新子域名
- 更新联系人
- 更新电子邮件活动
- 更新电子邮件活动接收者
- 更新电子邮件活动发送者
- 更新列表
- 更新发送者
- 更新短信活动
- 更新SMTP模板
- 更新SMTP模板发送者
- 更新Webhook
- 上传图片到图库
要获取crate生成的文档访问权限，请使用
cargo doc --open
作者
依赖项
~4–15MB
~221K SLoC