sendinblue/api-v3-sdk

此包已被弃用且不再维护。作者建议使用 getbrevo/brevo-php 包。

官方SendinBlue提供的RESTful API V3 PHP库

维护者

详情

github.com/sendinblue/APIv3-php-library

主页

源代码

问题

安装次数: 4,671,257

依赖项: 45

建议者: 6

安全性: 0

星标: 201

关注者: 11

分支: 96

开放问题: 14

v8.4.2 2023-03-10 04:21 UTC

Requires

Requires (Dev)

MIT 5d08398c7247a2f5d80f285d08a6dbe169f18eab

phpapisdkswaggersendinblue

This package is not auto-updated.

Last update: 2023-07-13 08:09:46 UTC

README

SendinBlue的API通过标准化的程序化接口公开了SendinBlue的所有功能。请参阅完整的文档以了解更多信息。

这是API的包装器。它实现了API v3的所有功能。

SendinBlue的API符合OpenAPI v2定义。规范可以在此下载。

此PHP包由Swagger Codegen项目自动生成，并由SendinBlue审查和维护。

要求

PHP 5.6及更高版本

安装与使用

Composer

要通过Composer安装绑定

在任意目录中创建一个composer.json文件，并在composer.json文件中添加以下代码。

{
"require": {
"sendinblue/api-v3-sdk": "8.x.x"
}
}

然后在同一目录中运行以下命令

composer require sendinblue/api-v3-sdk "8.x.x"

进一步执行

  • 运行composer install以将依赖项添加到您的vendor目录
  • 通过此行将自动加载器添加到您的应用程序：require("vendor/autoload.php")

测试

要运行单元测试

composer install
./vendor/bin/phpunit

入门

请按照安装过程进行操作，然后运行以下操作

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new SendinBlue\Client\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getAccount();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getAccount: ', $e->getMessage(), PHP_EOL;
}

?>

API端点文档

所有URI均相对于https://api.sendinblue.com/v3

类 方法 HTTP请求 描述
AccountApi getAccount GET /account 获取您的账户信息、计划和信用详情
CompaniesApi companiesAttributesGet GET /companies/attributes 获取公司属性
CompaniesApi companiesGet GET /companies 获取所有公司
CompaniesApi companiesIdDelete DELETE /companies/{id} 删除公司
CompaniesApi companiesIdGet GET /companies/{id} 获取公司
CompaniesApi companiesIdPatch PATCH /companies/{id} 更新公司
CompaniesApi companiesLinkUnlinkIdPatch PATCH /companies/link-unlink/{id} 将与联系人和交易的链接和解除链接与公司
CompaniesApi companiesPost POST /companies 创建公司
AttributesApi createAttribute POST /contacts/attributes/{attributeCategory}/{attributeName} 创建联系人属性
AttributesApi deleteAttribute 删除 /contacts/attributes/{attributeCategory}/{attributeName} 删除属性
AttributesApi getAttributes 获取 /contacts/attributes 列出所有属性
AttributesApi updateAttribute 更新 /contacts/attributes/{attributeCategory}/{attributeName} 更新联系人属性
CRMApi crmNotesGet 获取 /crm/notes 获取所有笔记
CRMApi crmNotesIdDelete 删除 /crm/notes/{id} 删除笔记
CRMApi crmNotesIdGet 获取 /crm/notes/{id} 获取笔记
CRMApi crmNotesIdPatch 修补 /crm/notes/{id} 更新笔记
CRMApi crmNotesPost 提交 /crm/notes 创建笔记
CRMApi crmTasksGet 获取 /crm/tasks 获取所有任务
CRMApi crmTasksIdDelete 删除 /crm/tasks/{id} 删除任务
CRMApi crmTasksIdGet 获取 /crm/tasks/{id} 获取任务
CRMApi crmTasksIdPatch 修补 /crm/tasks/{id} 更新任务
CRMApi crmTasksPost 提交 /crm/tasks 创建任务
CRMApi crmTasktypesGet 获取 /crm/tasktypes 获取所有任务类型
ContactsApi addContactToList 提交 /contacts/lists/{listId}/contacts/add 将现有联系人添加到列表
ContactsApi createAttribute POST /contacts/attributes/{attributeCategory}/{attributeName} 创建联系人属性
ContactsApi createContact 提交 /contacts 创建联系人
ContactsApi createDoiContact 提交 /contacts/doubleOptinConfirmation 通过DOI（双重确认）流程创建联系人
ContactsApi createFolder 提交 /contacts/folders 创建文件夹
ContactsApi createList 提交 /contacts/lists 创建列表
ContactsApi deleteAttribute 删除 /contacts/attributes/{attributeCategory}/{attributeName} 删除属性
ContactsApi deleteContact 删除 /contacts/{identifier} 删除联系人
ContactsApi deleteFolder 删除 /contacts/folders/{folderId} 删除文件夹（及其所有列表）
ContactsApi deleteList 删除 /contacts/lists/{listId} 删除列表
ContactsApi getAttributes 获取 /contacts/attributes 列出所有属性
ContactsApi getContactInfo 获取 /contacts/{identifier} 获取联系人的详细信息
ContactsApi getContactStats 获取 /contacts/{identifier}/campaignStats 获取联系人的电子邮件活动统计信息
ContactsApi getContacts 获取 /contacts 获取所有联系人
ContactsApi getContactsFromList 获取 /contacts/lists/{listId}/contacts 获取列表中的联系人
ContactsApi getFolder 获取 /contacts/folders/{folderId} 返回文件夹的详细信息
ContactsApi getFolderLists 获取 /contacts/folders/{folderId}/lists 获取文件夹中的列表
ContactsApi getFolders 获取 /contacts/folders 获取所有文件夹
ContactsApi getList 获取 /contacts/lists/{listId} 获取列表的详细信息
ContactsApi getLists 获取 /contacts/lists 获取所有列表
ContactsApi importContacts 提交 /contacts/import 导入联系人
ContactsApi removeContactFromList 提交 /contacts/lists/{listId}/contacts/remove 从列表中删除联系人
ContactsApi requestContactExport 提交 /contacts/export 导出联系人
ContactsApi updateAttribute 更新 /contacts/attributes/{attributeCategory}/{attributeName} 更新联系人属性
ContactsApi updateBatchContacts 提交 /contacts/batch 更新多个联系人
ContactsApi updateContact 更新 /contacts/{identifier} 更新联系人
ContactsApi updateFolder 更新 /contacts/folders/{folderId} 更新文件夹
ContactsApi updateList 更新 /contacts/lists/{listId} 更新列表
ConversationsApi conversationsAgentOnlinePingPost 提交 /conversations/agentOnlinePing 将代理的状态设置为在线2-3分钟
ConversationsApi conversationsMessagesIdDelete 删除 /conversations/messages/{id} 删除代理发送的消息
ConversationsApi conversationsMessagesIdGet 获取 /conversations/messages/{id} 获取消息
ConversationsApi conversationsMessagesIdPut 更新 /conversations/messages/{id} 更新代理发送的消息
ConversationsApi conversationsMessagesPost 提交 /conversations/messages 以代理身份发送消息
ConversationsApi conversationsPushedMessagesIdDelete 删除 /conversations/pushedMessages/{id} 删除自动消息
ConversationsApi conversationsPushedMessagesIdGet 获取 /conversations/pushedMessages/{id} 获取自动消息
ConversationsApi conversationsPushedMessagesIdPut PUT /conversations/pushedMessages/{id} 更新自动化消息
ConversationsApi conversationsPushedMessagesPost POST /conversations/pushedMessages 向访客发送自动化消息
DealsApi crmAttributesDealsGet GET /crm/attributes/deals 获取交易属性
DealsApi crmDealsGet GET /crm/deals 获取所有交易
DealsApi crmDealsIdDelete DELETE /crm/deals/{id} 删除交易
DealsApi crmDealsIdGet GET /crm/deals/{id} 获取交易
DealsApi crmDealsIdPatch PATCH /crm/deals/{id} 更新交易
DealsApi crmDealsLinkUnlinkIdPatch PATCH /crm/deals/link-unlink/{id} 将与联系人和公司相关的交易链接和解除链接
DealsApi crmDealsPost POST /crm/deals 创建交易
DealsApi crmPipelineDetailsGet GET /crm/pipeline/details 获取管道阶段
EcommerceApi createBatchOrder POST /orders/status/batch 批量创建订单
EcommerceApi createOrder POST /orders/status 管理订单状态
EcommerceApi createUpdateBatchCategory POST /categories/batch 批量创建类别
EcommerceApi createUpdateBatchProducts POST /products/batch 批量创建产品
EcommerceApi createUpdateCategory POST /categories 创建/更新类别
EcommerceApi createUpdateProduct POST /products 创建/更新产品
EcommerceApi ecommerceActivatePost POST /ecommerce/activate 激活电子商务应用
EcommerceApi getCategories GET /categories 返回所有您的类别
EcommerceApi getCategoryInfo GET /categories/{id} 获取类别详情
EcommerceApi getProductInfo GET /products/{id} 获取产品详情
EcommerceApi getProducts GET /products 返回所有您的产品
EmailCampaignsApi createEmailCampaign POST /emailCampaigns 创建电子邮件营销活动
EmailCampaignsApi deleteEmailCampaign DELETE /emailCampaigns/{campaignId} 删除电子邮件营销活动
EmailCampaignsApi emailExportRecipients POST /emailCampaigns/{campaignId}/exportRecipients 导出电子邮件营销活动的收件人
EmailCampaignsApi getAbTestCampaignResult GET /emailCampaigns/{campaignId}/abTestCampaignResult 获取A/B测试电子邮件营销活动结果
EmailCampaignsApi getEmailCampaign GET /emailCampaigns/{campaignId} 获取电子邮件营销活动报告
EmailCampaignsApi getEmailCampaigns GET /emailCampaigns 返回您创建的所有电子邮件营销活动
EmailCampaignsApi getSharedTemplateUrl GET /emailCampaigns/{campaignId}/sharedUrl 获取共享模板URL
EmailCampaignsApi sendEmailCampaignNow POST /emailCampaigns/{campaignId}/sendNow 根据营销活动ID立即发送电子邮件营销活动
EmailCampaignsApi sendReport POST /emailCampaigns/{campaignId}/sendReport 发送活动报告
EmailCampaignsApi sendTestEmail POST /emailCampaigns/{campaignId}/sendTest 向您的测试列表发送电子邮件营销活动
EmailCampaignsApi updateCampaignStatus PUT /emailCampaigns/{campaignId}/status 更新电子邮件营销活动状态
EmailCampaignsApi updateEmailCampaign PUT /emailCampaigns/{campaignId} 更新电子邮件营销活动
EmailCampaignsApi uploadImageToGallery POST /emailCampaigns/images 将图片上传到您的账户图片库
FoldersApi createFolder 提交 /contacts/folders 创建文件夹
FoldersApi deleteFolder 删除 /contacts/folders/{folderId} 删除文件夹（及其所有列表）
FoldersApi getFolder 获取 /contacts/folders/{folderId} 返回文件夹的详细信息
FoldersApi getFolderLists 获取 /contacts/folders/{folderId}/lists 获取文件夹中的列表
FoldersApi getFolders 获取 /contacts/folders 获取所有文件夹
FoldersApi updateFolder 更新 /contacts/folders/{folderId} 更新文件夹
FilesApi crmFilesGet GET /crm/files 获取所有文件
FilesApi crmFilesIdDataGet GET /crm/files/{id}/data 获取文件详情
FilesApi crmFilesIdDelete DELETE /crm/files/{id} 删除文件
FilesApi crmFilesIdGet GET /crm/files/{id} 下载文件
FilesApi crmFilesPost POST /crm/files 上传文件
InboundParsingApi getInboundEmailAttachment GET /inbound/attachments/{downloadToken} 通过下载令牌检索传入附件。
InboundParsingApi getInboundEmailEvents GET /inbound/events 获取接收电子邮件的所有事件的列表。
InboundParsingApi getInboundEmailEventsByUuid GET /inbound/events/{uuid} 获取特定收件电子邮件的所有事件历史。
ListsApi addContactToList 提交 /contacts/lists/{listId}/contacts/add 将现有联系人添加到列表
ListsApi createList 提交 /contacts/lists 创建列表
ListsApi deleteList 删除 /contacts/lists/{listId} 删除列表
ListsApi getContactsFromList 获取 /contacts/lists/{listId}/contacts 获取列表中的联系人
ListsApi getFolderLists 获取 /contacts/folders/{folderId}/lists 获取文件夹中的列表
ListsApi getList 获取 /contacts/lists/{listId} 获取列表的详细信息
ListsApi getLists 获取 /contacts/lists 获取所有列表
ListsApi removeContactFromList 提交 /contacts/lists/{listId}/contacts/remove 从列表中删除联系人
ListsApi updateList 更新 /contacts/lists/{listId} 更新列表
MasterAccountApi corporateMasterAccountGet GET /corporate/masterAccount 获取请求的主账户详细信息。
MasterAccountApi corporateSubAccountGet GET /corporate/subAccount 获取主账户下所有子账户的列表。
MasterAccountApi corporateSubAccountIdDelete DELETE /corporate/subAccount/{id} 删除子账户。
MasterAccountApi corporateSubAccountIdGet GET /corporate/subAccount/{id} 获取子账户详细信息。
MasterAccountApi corporateSubAccountIdPlanPut PUT /corporate/subAccount/{id}/plan 更新子账户计划。
MasterAccountApi corporateSubAccountKeyPost POST /corporate/subAccount/key 为子账户创建API密钥。
MasterAccountApi corporateSubAccountPost POST /corporate/subAccount 在主账户下创建新的子账户。
MasterAccountApi corporateSubAccountSsoTokenPost POST /corporate/subAccount/ssoToken 生成SSO令牌以访问Sendinblue。
NotesApi crmNotesGet 获取 /crm/notes 获取所有笔记
NotesApi crmNotesIdDelete 删除 /crm/notes/{id} 删除笔记
NotesApi crmNotesIdGet 获取 /crm/notes/{id} 获取笔记
NotesApi crmNotesIdPatch 修补 /crm/notes/{id} 更新笔记
NotesApi crmNotesPost 提交 /crm/notes 创建笔记
ProcessApi getProcess GET /processes/{processId} 返回进程的信息。
ProcessApi getProcesses GET /processes 返回您账户的所有进程。
ResellerApi addCredits POST /reseller/children/{childIdentifier}/credits/add 向特定子账户添加电子邮件和/或短信积分。
ResellerApi associateIpToChild POST /reseller/children/{childIdentifier}/ips/associate 将专用IP关联到子账户。
ResellerApi createChildDomain POST /reseller/children/{childIdentifier}/domains 为子账户创建域名。
ResellerApi createResellerChild POST /reseller/children 创建经销商子账户。
ResellerApi deleteChildDomain DELETE /reseller/children/{childIdentifier}/domains/{domainName} 基于传递的childIdentifier和domainName删除经销商子账户的发件人域名。
ResellerApi deleteResellerChild DELETE /reseller/children/{childIdentifier} 根据提供的子标识符删除单个经销商子账户。
ResellerApi dissociateIpFromChild POST /reseller/children/{childIdentifier}/ips/dissociate 将专用IP从子账户中解除关联。
ResellerApi getChildAccountCreationStatus GET /reseller/children/{childIdentifier}/accountCreationStatus 根据提供的标识符获取经销商子账户创建状态，是否成功创建（存在）或不存在。
ResellerApi getChildDomains GET /reseller/children/{childIdentifier}/domains 获取特定子账户的所有发件人域名。
ResellerApi getChildInfo GET /reseller/children/{childIdentifier} 获取子账户的详细信息。
ResellerApi getResellerChilds GET /reseller/children 获取所有子账户的列表。
ResellerApi getSsoToken GET /reseller/children/{childIdentifier}/auth 获取会话令牌以访问Sendinblue（SSO）。
ResellerApi removeCredits POST /reseller/children/{childIdentifier}/credits/remove 从特定子账户中移除电子邮件和/或短信积分。
ResellerApi updateChildAccountStatus PUT /reseller/children/{childIdentifier}/accountStatus 根据提供的子标识符更新经销商子账户状态信息。
ResellerApi updateChildDomain PUT /reseller/children/{childIdentifier}/domains/{domainName} 根据传递的childIdentifier和domainName更新经销商子账户的发件人域名。
ResellerApi updateResellerChild PUT /reseller/children/{childIdentifier} 根据提供的子标识符更新经销商子账户信息。
SMSCampaignsApi createSmsCampaign POST /smsCampaigns 创建短信营销活动。
SMSCampaignsApi deleteSmsCampaign DELETE /smsCampaigns/{campaignId} 删除短信营销活动。
SMSCampaignsApi getSmsCampaign GET /smsCampaigns/{campaignId} 获取短信营销活动。
SMSCampaignsApi getSmsCampaigns GET /smsCampaigns 返回您创建的所有短信活动的信息
SMSCampaignsApi requestSmsRecipientExport POST /smsCampaigns/{campaignId}/exportRecipients 导出短信活动的接收者信息
SMSCampaignsApi sendSmsCampaignNow POST /smsCampaigns/{campaignId}/sendNow 立即发送短信活动
SMSCampaignsApi sendSmsReport POST /smsCampaigns/{campaignId}/sendReport 发送短信活动的报告
SMSCampaignsApi sendTestSms POST /smsCampaigns/{campaignId}/sendTest 发送测试短信活动
SMSCampaignsApi updateSmsCampaign PUT /smsCampaigns/{campaignId} 更新短信活动
SMSCampaignsApi updateSmsCampaignStatus PUT /smsCampaigns/{campaignId}/status 更新活动的状态
SendersApi createSender POST /senders 创建新的发送者
SendersApi deleteSender DELETE /senders/{senderId} 删除发送者
SendersApi getIps GET /senders/ips 获取您账户的所有专用IP地址
SendersApi getIpsFromSender GET /senders/{senderId}/ips 获取发送者的所有专用IP地址
SendersApi getSenders GET /senders 获取所有发送者的列表
SendersApi updateSender PUT /senders/{senderId} 更新发送者
TasksApi crmTasksGet 获取 /crm/tasks 获取所有任务
TasksApi crmTasksIdDelete 删除 /crm/tasks/{id} 删除任务
TasksApi crmTasksIdGet 获取 /crm/tasks/{id} 获取任务
TasksApi crmTasksIdPatch 修补 /crm/tasks/{id} 更新任务
TasksApi crmTasksPost 提交 /crm/tasks 创建任务
TasksApi crmTasktypesGet 获取 /crm/tasktypes 获取所有任务类型
TransactionalEmailsApi blockNewDomain POST /smtp/blockedDomains 将新域名添加到阻止域名的列表中
TransactionalEmailsApi createSmtpTemplate POST /smtp/templates 创建电子邮件模板
TransactionalEmailsApi deleteBlockedDomain DELETE /smtp/blockedDomains/{domain} 从阻止域名的列表中解锁现有域名
TransactionalEmailsApi deleteHardbounces POST /smtp/deleteHardbounces 删除硬退信
TransactionalEmailsApi deleteScheduledEmailById DELETE /smtp/email/{identifier} 通过batchId或messageId删除计划中的电子邮件
TransactionalEmailsApi deleteSmtpTemplate DELETE /smtp/templates/{templateId} 删除不活动的电子邮件模板
TransactionalEmailsApi getAggregatedSmtpReport GET /smtp/statistics/aggregatedReport 获取您在一定时间范围内的交易电子邮件活动汇总
TransactionalEmailsApi getBlockedDomains GET /smtp/blockedDomains 获取阻止域名的列表
TransactionalEmailsApi getEmailEventReport GET /smtp/statistics/events 获取所有交易电子邮件活动（非汇总事件）
TransactionalEmailsApi getScheduledEmailByBatchId GET /smtp/emailStatus/{batchId} 通过batchId获取计划中的电子邮件
TransactionalEmailsApi getScheduledEmailById DELETE /smtp/email/{identifier} 通过batchId或messageId删除计划中的电子邮件
TransactionalEmailsApi getScheduledEmailByMessageId GET /smtp/emailStatus/{messageId} 通过messageId获取计划中的电子邮件
TransactionalEmailsApi getSmtpReport GET /smtp/statistics/reports 按天获取您的交易电子邮件活动汇总
TransactionalEmailsApi getSmtpTemplate GET /smtp/templates/{templateId} 返回模板信息
TransactionalEmailsApi getSmtpTemplates GET /smtp/templates 获取电子邮件模板的列表
TransactionalEmailsApi getTransacBlockedContacts GET /smtp/blockedContacts 获取被阻止或取消订阅的交易联系人列表
TransactionalEmailsApi getTransacEmailContent GET /smtp/emails/{uuid} 获取发送的交易电子邮件的个人化内容
TransactionalEmailsApi getTransacEmailsList GET /smtp/emails 基于允许的过滤器获取交易电子邮件列表
TransactionalEmailsApi sendTestTemplate POST /smtp/templates/{templateId}/sendTest 向您的测试列表发送模板
TransactionalEmailsApi sendTransacEmail POST /smtp/email 发送交易电子邮件
TransactionalEmailsApi smtpBlockedContactsEmailDelete DELETE /smtp/blockedContacts/{email} 解锁或重新订阅交易联系人
TransactionalEmailsApi smtpLogMessageIdDelete DELETE /smtp/log/{messageId} 删除SMTP交易日志
TransactionalEmailsApi updateSmtpTemplate PUT /smtp/templates/{templateId} 更新电子邮件模板
TransactionalSMSApi getSmsEvents GET /transactionalSMS/statistics/events 获取所有短信活动（非聚合事件）
TransactionalSMSApi getTransacAggregatedSmsReport GET /transactionalSMS/statistics/aggregatedReport 获取一段时间内短信活动的聚合数据
TransactionalSMSApi getTransacSmsReport GET /transactionalSMS/statistics/reports 按日获取短信活动的聚合数据
TransactionalSMSApi sendTransacSms POST /transactionalSMS/sms 向手机号码发送短信消息
TransactionalWhatsAppApi getWhatsappEventReport GET /whatsapp/statistics/events 获取所有WhatsApp活动（非聚合事件）
TransactionalWhatsAppApi sendWhatsappMessage POST /whatsapp/sendMessage 发送WhatsApp消息
WebhooksApi createWebhook POST /webhooks 创建webhook
WebhooksApi deleteWebhook DELETE /webhooks/{webhookId} 删除webhook
WebhooksApi getWebhook GET /webhooks/{webhookId} 获取webhook详细信息
WebhooksApi getWebhooks GET /webhooks 获取所有webhook
WebhooksApi updateWebhook PUT /webhooks/{webhookId} 更新webhook
WhatsappCampaignsApi deleteWhatsappCampaign DELETE /whatsappCampaigns/{campaignId} 删除whatsapp活动
WhatsappCampaignsApi getWhatsappCampaign GET /whatsappCampaigns/{campaignId} 获取whatsapp活动

模型文档

授权文档

api-密钥

API 密钥应以 api-key 的形式包含在请求头中进行身份验证。

  • 类型: API 密钥
  • API 密钥参数名: api-key
  • 位置: HTTP 头

合作伙伴密钥

合作伙伴密钥应以 partner-key 的形式与 api-key 配对包含在请求头中，以便成功验证合作伙伴（可选）。

  • 类型: API 密钥
  • API 密钥参数名: partner-key
  • 位置: HTTP 头

如果您发现错误，请在 Github 上发布问题。

一如既往，如果您需要额外的帮助，请在此 处 联系我们。