README

摘要

此包提供对Maropost多个服务的编程访问。它包含在Maropost.Api命名空间内的八个服务。每个服务都包含一个或多个执行针对您的Maropost账户的操作的函数。这些函数返回一个结果对象，指示成功/失败、抛出的任何异常以及结果数据。

安装

Composer

Composer 是 PEAR 的现代替代品，易于使用。由于此包符合 PSR-4 标准，您可以使用 Composer 安装它。要这样做，只需将 maropost/api 添加到您自己的项目 composer.json 文件中的 "require" 对象。

{
    "require": {
        "maropost/api": "*"
    }
}

从源代码安装

您还可以克隆 API 仓库并使用符合 PSR-4 标准的自动加载器来加载库。我们位于 ~/tests/index.php 的测试文件提供了一个如何这样做的示例。您需要查看我们的 composer.json 文件以获取依赖项（列在 "requires" 下），并确保已安装它们。

使用方法

要使用一个服务，首先实例化它，提供您的 Maropost 账户 ID 和身份验证令牌。例如，要使用 Reports 服务获取您的报告列表，请执行以下操作：

$reports = new Maropost.Api.Reports($myAccountId, $myAuthToken);
$result = $reports.get();
if ($result.isSuccess) {
    $myReports = $result.getData();
}

结果对象包含三个字段

• isSuccess（布尔值）
• errorMessage（字符串）
• exception（异常）

如果 isSuccess 是 false，则 errorMessage 将包含信息，而 exception 可能 包含异常，具体取决于失败的原因。如果 exception 不是 null，则 isSuccess 将始终为 false。

该对象还包含一个函数 getData()，其中包含操作本身提供的任何数据。某些操作，例如 delete() 操作，可能不会提供任何数据。

特定API

包含的特定API有

• 活动
• A/B 测试活动
• 事务性活动
• 联系人
• 旅程
• 产品和收入
• 关系表
• 报告

活动

实例化

new Maropost.Api.Campaigns($myAccountId, $myAuthToken)

可用方法

• get(int $page)
  • 返回账户的活动列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。
• getCampaign(int $campaignId)
  • 返回指定的活动
  • $campaignId
• getBounceReports(int $id, int $page)
  • 返回给定活动 ID 的弹跳报告列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。
• getClickReports(int $id, int $page, bool unique = null)
  • 返回给定活动 ID 的点击报告列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。
  • $unique：true = 获取唯一联系人。否则，false。
• getComplaintReports(int $id, int $page)
  • 返回给定活动 ID 的投诉报告列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。
• getDeliveredReports(int $id, int $page)
  • 返回给定活动 ID 的投递报告列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。
• getHardBounceReports(int $id, int $page)
  • 返回给定活动 ID 的硬弹跳列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。
• getLinkReports(int $id, int $page, bool unique = null)
  • 返回给定活动 ID 的链接报告列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。
  • $unique：true = 获取唯一联系人。否则，false。
• getOpenReports(int $id, int $page, bool unique = null)
  • 返回给定活动 ID 的打开报告列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。
  • $unique：true = 获取唯一联系人。否则，false。
• getSoftBounceReports(int $id, int $page)
  • 返回给定活动 ID 的软弹跳报告列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。
• getUnsubscribeReports(int $id, int $page)
  • 返回给定活动 ID 的退订报告列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。

A/B 测试活动

实例化

new Maropost.Api.AbTestCampaigns($myAccountId, $myAuthToken)

可用方法

• createAbTest(string $name, string $fromEmail, string $replyTo, string $address, string $language, array $campaignGroupsAttributes, string commit, \DateTime $sendAt, int $brandId = null, array $suppressedListIds = [], array $suppressedSegmentIds = [], array $suppressedJourneyIds = [], int $emailPreviewLink = null, string $decidedBy = null, array $lists = [], array $cTags = [], array $segments = [])
  • $name: 新活动的名称
  • $fromEmail: 活动邮件的默认发送者电子邮件地址
  • $replyTo: 活动邮件的默认回复电子邮件地址
  • $address: 活动邮件中包含的默认物理地址
  • $language: ISO 639-1语言代码（例如，"en"）。2个字符。
  • $campaignGroupsAttributes: 属性数组。每个属性本身是一个对象，具有以下属性（全部为字符串）
    • name: 组名称
    • content_id: 内容ID
    • subject: 邮件的主题行
    • from_name: 邮件中的"发件人名称"
    • percentage: 应发送具有这些设置的电子邮件的百分比。
    • 预览头:
    • send_at: 表示DateTime的字符串，格式为YYYY-MM-DD HH:mm:ss
  • $commit: 允许的值：'保存为草稿'或'发送测试'或'安排'
  • $sendAt: 表示AB活动的开始时间的DateTime对象
  • $brandId: 作为字符串的品牌ID
  • $suppressedListIds: 列表ID数组（字符串格式）
  • $suppressedSegmentIds: 段落ID数组（字符串格式）
  • $suppressedJourneyIds: 旅程ID数组（字符串格式）
  • $emailPreviewLink: 1（true）发送预览链接。否则0（false）。
  • $decidedBy: 允许的值：('TopChoice'用于最高选择)或('Opens'用于最高打开率)或('Clicks'用于最高点击率)或('Manual'用于手动选择)或('click_to_open'用于最高点击到打开率)或('conversions'用于最高转化率)
  • $lists: 目标列表ID数组（字符串格式）
  • $cTags: 字符串格式的标签数组
  • $segments: 目标段落ID数组（字符串格式）

事务性活动

实例化

new Maropost.Api.TransactionalCampaigns($myAccountId, $myAuthToken)

可用方法

• get(int $page)

  • 返回事务活动的列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。

• create(string $name, string $subject, string $preheader, string $fromName, string $fromEmail, string $replyTo, int $contentId, bool $emailPreviewLink, string $address, string $language, string... $ctags)

  • 创建事务活动
  • $name 活动名称
  • $subject 活动主题
  • $preheader 活动预览头
  • $fromName 邮件中的发件人名称
  • $fromEmail 发件人电子邮件地址
  • $replyTo 回复电子邮件地址
  • $contentId
  • $emailPreviewLink
  • $address 物理地址
  • $language ISO 639-1语言代码
  • ...$ctags 活动标签数组

• sendEmail(int $campaignId, int $contentId = null, string $contentName = null, string $contentHtmlPart = null, string $contentTextPart = null, int $sendAtHour = null, int $sendAtMinute = null, bool $ignoreDnm = null, int $contactId = null, string $recipientEmail = null, string $recipientFirstName = null, string $recipientLastName = null, array $recipientCustomFields = null, string $bccEmail = null, string $fromName = null, string $fromEmail = null, string $subject = null, string $replyTo = null, string $senderAddress = null, array $tags = null, array $ctags = null )

  • 向收件人发送事务活动邮件。除非在函数参数中提供，否则将自动从事务活动获取发件人信息。
  • $campaignId: 必须是在调用 $svc->get() 时已存在的活动。如果您没有，首先调用 $svc->create()。
  • $contentId: 如果提供，将用此内容替换事务活动的內容。
  • $contentName: 如果 $contentId 为 null，将用此名称替换事务活动的內容名称。
  • $contentHtmlPart: 如果 $contentId 为 null，将用此HTML部分替换事务活动的內容HTML部分。
  • $contentTextPart：如果 $contentId 为空，则交易型活动的文本部分将被此文本部分替换。
  • $sendAtHour：必须是 1-12。否则电子邮件将立即发送。如果小时数小于当前小时，则电子邮件将在第二天发送。
  • $sendAtMinute：必须是 0-60。否则将视为 0。如果小时和分钟组合小于当前时间，则电子邮件将在第二天发送。
  • $ignoreDnm：如果为 true，则忽略收件人联系人的“不邮寄”列表。
  • $contactId：收件人的联系 ID。
  • $recipientEmail：电子邮件地址。除非 $contactId 为空，否则将被忽略。否则，它必须是一个符合 FILTER_VALIDATE_EMAIL 的有效电子邮件地址。
  • $recipientFirstName：收件人的名字。除非 $contactId 为空，否则将被忽略。
  • $recipientLastName：收件人的姓氏。除非 $contactId 为空，否则将被忽略。
  • $recipientCustomFields：收件人的自定义字段。除非 $contactId 为空，否则将被忽略。它是一个关联数组，其中项键是自定义字段的名称，项值是字段值。所有键必须是字符串。所有值必须是非空标量。
  • $bccEmail：BCC 收件人。只能传递单个电子邮件地址、空字符串或 null。如果提供，则必须是一个符合 FILTER_VALIDATE_EMAIL 的有效电子邮件地址。
  • $fromName：发件人姓名。如果设置了 $fromEmail，则覆盖交易型活动的默认发件人姓名。否则将被忽略。
  • $fromEmail：发件人电子邮件地址。覆盖交易型活动的默认发件人电子邮件。
  • $subject：电子邮件的主题行。覆盖交易型活动的默认主题。
  • $replyTo：回复地址。覆盖交易型活动的默认回复地址。
  • $senderAddress：发件人的物理地址。覆盖交易型活动的默认发件人地址。
  • $tags：关联数组，其中项键是内容中的标签名称，项值是在发送时替换标签的值。所有键必须是字符串。所有值必须是非空标量。
  • $ctags：活动标签。必须是一个标量值的简单数组。

联系人

实例化

new Maropost.Api.Contacts($myAccountId, $myAuthToken)

可用方法

• getForEmail(string $email)

  • 根据电子邮件地址获取联系人
  • $email：联系人的电子邮件地址

• getOpens(int $contactId, int $page)

  • 获取指定联系人的打开列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。

• getClicks(int $contactId, int $page)

  • 获取指定联系人的点击列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。

• getForList(int $listId, int $page)

  • 获取指定列表的联系人类别
  • $page：页面号（>= 1）。每页最多返回 200 条记录。

• getContactForList(int $listId, int $contactId)

  • 从指定列表中获取指定联系人
  • $listId
  • $contactId

• public function updateForListAndContact( int $listId, int $contactId, string $email, string $firstName = null, string $lastName = null, string $phone = null, string $fax = null, string $uid = null, array $customField = [], array $addTags = [], array $removeTags = [], bool $removeFromDNM = true, bool $subscribe = true )

  • 在列表中创建联系人。如果以前通过电子邮件匹配到联系人则更新
  • $listId：要更新的联系人所属列表的 ID
  • $contactId：要更新的联系人的 ID
  • $email：要更新的联系人的电子邮件地址
  • $firstName：联系人的名字
  • $lastName：联系人的姓氏
  • $phone：联系人的电话号码
  • $fax：联系人的传真号码
  • $uid：联系人的 UID
  • $customField：作为关联数组传递的自定义字段。键表示字段名称，值表示值
  • $addTags：要添加到联系人的标签。标签名称的简单数组
  • $removeTags: 从联系人中删除的标签。简单的标签名称数组
  • $removeFromDNM: 设置为true以订阅联系人到列表，并从DNM中删除
  • $subscribe: 设置为true以订阅联系人到列表；否则为false

• createOrUpdateForList( int $listId, string $email, string $firstName = null, string $lastName = null, string $phone = null, string $fax = null, string $uid = null, array $customField = [], array $addTags = [], array $removeTags = [], bool $removeFromDNM = true, bool $subscribe = true )

  • 在列表中创建联系人。如果通过电子邮件匹配到以前的联系人则更新
  • $listId: 创建联系人的列表ID
  • $email: 要创建或更新的联系人的电子邮件地址
  • $firstName：联系人的名字
  • $lastName: 联系人的姓氏
  • $phone：联系人的电话号码
  • $fax：联系人的传真号码
  • $uid: 联系人的UID
  • $customField: 以关联数组形式传递的自定义字段。键表示字段名称，值表示值。
  • $addTags: 要添加到联系人的标签。简单的标签名称字符串数组
  • $removeTags: 要从联系人中删除的标签。简单的标签名称字符串数组
  • $removeFromDNM: 设置为true以订阅联系人到列表，并从DNM中删除
  • $subscribe: 订阅联系人到列表为true；否则为false

• createOrUpdateContact( int $contactId, string $email, string $firstName = null, string $lastName = null, string $phone = null, string $fax = null, string $uid = null, array $customField = [], array $addTags = [], array $removeTags = [], bool $removeFromDNM = true, bool $subscribe = true )

  • 创建不带列表的联系人。如果已传递现有的电子邮件则更新
  • $contactId: 联系人的ID
  • $email: 要创建或更新的联系人的电子邮件地址
  • $firstName：联系人的名字
  • $lastName: 联系人的姓氏
  • $phone：联系人的电话号码
  • $fax：联系人的传真号码
  • $uid: 联系人的UID
  • $customField：作为关联数组传递的自定义字段。键表示字段名称，值表示值
  • $addTags: 要添加到联系人的标签。简单的标签名称字符串数组
  • $removeTags: 要从联系人中删除的标签。简单的标签名称字符串数组
  • $removeFromDNM: 设置为true以订阅联系人到列表，并从DNM中删除

• createOrUpdateForListsAndWorkflows( string $email, string $firstName = null, string $lastName = null, string $phone = null, string $fax = null, string $uid = null, array $customField = [], array $addTags = [], array $removeTags = [], bool $removeFromDNM = false, array $subscribeListIds = [], array $unsubscribeListIds = [], array $unsubscribeWorkflowIds = [], string $unsubscribeCampaign = null )

  • 创建或更新联系人
    • 可以订阅或取消订阅多个列表。
    • 可以取消订阅多个工作流。
  • $email: 要创建或更新的联系人的电子邮件地址
  • $firstName：联系人的名字
  • $lastName：联系人的姓氏
  • $phone：联系人的电话号码
  • $fax：联系人的传真号码
  • $uid：联系人的 UID
  • $customField：作为关联数组传递的自定义字段。键表示字段名称，值表示值
  • $addTags: 要添加到联系人的标签。简单的标签名称字符串数组
  • $removeTags: 要从联系人中删除的标签。简单的标签名称字符串数组
  • $removeFromDNM: 设置为true以订阅联系人到列表，并从DNM中删除
  • $subscribeListIds: 订阅联系人到的列表ID的简单数组
  • $unsubscribeListIds: 从联系人取消订阅的列表ID的简单数组
  • $unsubscribeWorkflowIds: 从联系人取消订阅的工作流ID的简单数组
  • $unsubscribeCampaign: 要取消订阅的联系人的活动ID

• deleteFromAllLists(string $email)

  • 从所有列表中删除指定的联系人
  • $email：联系人的电子邮件地址

• deleteFromLists(int $contactId, array $listIds = [])

  • 从指定的列表中删除指定的联系人
  • $contactId: 联系人的id
  • $listIds: 列表id的简单数组

• deleteContactForUid(string $uid)

  • 删除具有指定UID的联系人

• deleteListContact(int $listId, int $contactId)

  • 从指定的列表中删除指定的联系人

• unsubscribeAll(string $contactFieldValue, string $contactFieldName = 'email')

  • 取消具有指定字段名/值的联系人的订阅。
  • $contactFieldValue: 要取消订阅的联系人的字段值
  • $contactFieldName: 检查值的字段名称。目前，接受的字段名称是：'email' 或 'uid'

旅程

实例化

new Maropost.Api.Journeys($myAccountId, $myAuthToken)

可用方法

• get(int $page)

  • 获取旅程列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。

• getCampaigns(int $journeyId, int $page)

  • 获取指定旅程的所有活动的列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。

• getContacts(int $journeyId, int $page)

  • 获取指定旅程的所有联系人列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。

• stopAll(int $contactId, string $recipientEmail, string $uid)

  • 停止所有旅程，根据匹配的参数进行过滤
  • $contactId：除非大于0，否则此过滤器将被忽略
  • $recipientEmail：如果为null，则此过滤器将被忽略
  • $uid：如果为null，则此过滤器将被忽略

• pauseJourneyForContact(int $journeyId, int $contactId)

  • 暂停指定旅程的指定联系人

• pauseJourneyForUid(int $journeyId, string $uid)

  • 暂停具有指定UID的联系人指定的旅程

• resetJourneyForContact(int $journeyId, int $contactId)

  • 重置指定旅程的指定活动/暂停联系人。将联系人重置为旅程的开始将导致发送与最初发送相同的旅程活动。

• public function resetJourneyForUid(int $journeyId, string $uid)

  • 重置具有指定UID的活动/暂停联系人指定的旅程。将联系人重置为旅程的开始将导致发送与最初发送相同的旅程活动。

• public function startJourneyForContact(int $journeyId, int $contactId)

  • 重新启动已暂停的联系人旅程。在旅程中添加新的联系人。重新触发已完成其旅程一次的联系人。要重新触发，请确保“重新触发旅程”选项已启用。

• startJourneyForUid(int $journeyId, string $uid)

  • 重新启动具有指定UID的已暂停联系人旅程。在旅程中添加新的联系人。重新触发已完成其旅程一次的联系人。要重新触发，请确保“重新触发旅程”选项已启用。

产品和收入

实例化

new Maropost.Api.ProductAndRevenue($myAccountId, $myAuthToken)

可用方法

• getOrder(int $id)

  • 获取指定的订单

• getOrderForOriginalOrderId(string $originalOrderId)

  • 获取指定的订单

• createOrder(bool $requireUnique, string $contactEmail, string $contactFirstName, string $contactLastName, string $orderDateTime, string $orderStatus, string $originalOrderId, array $orderItems, array $customFields = null, array $addTags = null, array $removeTags = null, string $uid = null, string $listIds = null, string $grandTotal = null, int $campaignId = null, string $couponCode = null)

  • 创建订单
  • $requireUnique：如果为true，则验证订单对于给定联系人具有唯一的original_order_id。
  • $contactEmail
  • $contactFirstName
  • $contactLastName
  • $orderDateTime：使用格式：“YYYY-MM-DDTHH:MM:SS-05:00”
  • $orderStatus
  • $originalOrderId：设置original_order_id字段
  • $orderItems：数组，包含\Maropost\Api\InputTypes\OrderItemInput对象。
  • $customFields：关联数组，键（字符串）表示字段名称，值是字段值
  • $addTags：要添加的标签的简单数组（标量值）
  • $removeTags：要删除的标签的简单数组（标量值）
  • $uid
  • $listIds：ID的CSV列表（例如，“12,13”）
  • $grandTotal
  • $campaignId
  • $couponCode

• updateOrderForOriginalOrderId(string $originalOrderId, string $orderDateTime, string $orderStatus, array $orderItems, int $campaignId = null, string $couponCode = null)

  • 使用唯一的original_order_id更新现有电子商务订单，如果由于部分退货或其他更新而更改了详细信息。
  • $originalOrderId：与订单的original_order_id字段匹配
  • $orderDateTime：使用格式：YYYY-MM-DDTHH:MM:SS-05:00
  • $orderStatus
  • $orderItems：重新陈述orderItems，作为OrderItemInput对象的数组。
  • $campaignId
  • $couponCode

• updateOrderForOrderId(int $orderId, string $orderDateTime, string $orderStatus, array $orderItems, int $campaignId = null, string $couponCode = null)

  • 使用唯一的order_id更新现有电子商务订单，如果由于部分退货或其他更新而更改了详细信息。
  • 例如：
  • $orderId：与订单的Maropost order_id字段匹配
  • $orderDateTime：使用格式：YYYY-MM-DDTHH:MM:SS-05:00
  • $orderStatus
  • $orderItems：重新陈述orderItems，作为OrderItemInput对象的数组。
  • $campaignId
  • $couponCode

• deleteForOriginalOrderId(string $originalOrderId)

  • 如果订单被取消或退货，则删除完整的电子商务订单
  • $originalOrderId 与订单的 original_order_id 字段匹配

• deleteForOrderId(int $id)

  • 如果订单取消或退货，使用 Maropost 订单 id 删除完整电子商务订单
  • $id: Maropost 订单 id

• deleteProductsForOriginalOrderId(string $originalOrderId, array $productIds)

  • 如果产品取消或退货，则从完整电子商务订单中删除指定的产品
  • $originalOrderId：与订单的original_order_id字段匹配
  • $productIds: 从订单中删除的产品

• deleteProductsForOrderId(int $id, array $productIds)

  • 如果产品取消或退货，则从完整电子商务订单中删除指定的产品
  • $id: Maropost 订单 id
  • $productIds: 从订单中删除的产品

关系表

实例化

与其他服务不同，此构造函数需要一个第三个参数：$tableName。例如

$svc = new Maropost.Api.RelationalTables($myAccountId, $myAuthToken, $tableName);

$tableName 设置服务操作应针对哪个关系表。要切换表，您不需要重新实例化服务。相反，您可以调用

$svc->_setTableName($newTableName);

您还可以调用 _getTableName() 来确定当前设置的是哪个表。

可用函数

• get()

  • 获取关系表的记录

• show(int $id)

  • 从关系表获取指定的记录
  • $id: 要读取的现有记录的 ID

• create(KeyValue... $keyValues)

  • 向关系表添加记录
  • ...$keyValues: 要创建的记录的多个 Maropost.Api.InputTypes.KeyValue 对象，每个对象由两个字段组成
    • $key: 表示字段名称的字符串
    • $value: 表示字段新值的标量值。
      • 任何 DateTime 字符串必须采用以下三种格式之一："MM/DD/YYYY"、"YYYY-MM-DD" 或 "YYYY-MM-DDThh:mm:ssTZD"。
    • 注意：其中之一必须表示唯一标识符。

• update(KeyValue... $keyValues)

  • 更新关系表中的记录。
  • ...$keyValues: 要更新的记录的多个 Maropost.Api.InputTypes.KeyValue 对象，每个对象由两个字段组成
    • $key: 表示字段名称的字符串
    • $value: 表示字段新值的标量值。
      • 任何 DateTime 字符串必须采用以下三种格式之一："MM/DD/YYYY"、"YYYY-MM-DD" 或 "YYYY-MM-DDThh:mm:ssTZD"。
    • 注意：其中之一必须表示唯一标识符。

• upsert(KeyValue... $keyValues)

  • 在关系表中创建或更新记录。
  • ...$keyValues: 要创建或更新的记录的多个 Maropost.Api.InputTypes.KeyValue 对象，每个对象由两个字段组成
    • $key: 表示字段名称的字符串
    • $value: 表示字段新值的标量值。
      • 任何 DateTime 字符串必须采用以下三种格式之一："MM/DD/YYYY"、"YYYY-MM-DD" 或 "YYYY-MM-DDThh:mm:ssTZD"。
    • 注意：其中之一必须表示唯一标识符。

• delete(int $idFieldName, $idFieldValue)

  • 删除关系表的给定记录
  • $idFieldName 代表唯一标识符的字段名称（例如，“id”，“email”）
  • $idFieldValue 标识符字段的值，用于删除记录。

报告

实例化

new Maropost.Api.Reports($myAccountId, $myAuthToken)

可用方法

• get(int $page)

  • 返回报告列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。

• getReport(int $id)

  • 获取报告列表
  • $id: 报告 ID

• getOpens( int $page, array $fields = [], string $from = null, string $to = null, bool $unique = null, string $email = null, string $uid = null, int $per = null )

  • 根据提供的筛选器和字段返回打开报告的列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。
  • $fields: 要检索的联系人字段名称
  • $from: 日期范围筛选的开始
  • $to: 日期范围筛选的结束
  • $unique: 当为 true 时，仅获取唯一打开
  • $email: 根据提供的联系人中的电子邮件进行筛选
  • $uid: 根据提供的 uid 进行筛选
  • $per: 确定每次请求接收的记录数

• getClicks( int $page, array $fields = [], string $from = null, string $to = null, bool $unique = null, string $email = null, string $uid = null, int $per = null )

  • 返回点击报告的列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。
  • $fields: 如果存在，则检索这些联系人字段
  • $from: 日期范围筛选的开始
  • $to: 日期范围筛选的结束
  • $unique: 如果为 true，则获取唯一记录
  • $email: 获取特定电子邮件的点击
  • $uid: 获取提供的 uid 的点击
  • $per: 获取指定的记录数

• getBounces( int $page, array $fields = [], string $from = null, string $to = null, bool $unique = null, string $email = null, string $uid = null, string $type = null, int $per = null )

  • 返回弹跳报告的列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。
  • $fields: 如果存在，则检索这些联系人字段
  • $from: 日期范围筛选的开始
  • $to: 日期范围筛选的结束
  • $unique: 如果为 true，则获取唯一记录
  • $email: 获取特定电子邮件的弹跳
  • $uid: 获取提供的 uid 的弹跳
  • $per: 获取指定的记录数

• getUnsubscribes(int $page, array $fields = [], string $from = null, string $to = null, bool $unique = null, string $email = null, string $uid = null, int $per = null)

  • 根据提供的筛选约束返回取消订阅列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。
  • $fields: 如果存在，则检索这些联系人字段
  • $from: 日期范围筛选的开始
  • $to: 日期范围筛选的结束
  • $unique如果为true，则获取唯一记录
  • $email获取特定电子邮件的取消订阅
  • $uid获取提供的uid的取消订阅
  • $per获取指定数量的记录

• getComplaints(array $fields = [], string $from = null, string $to = null, bool $unique = null, string $email = null, string $uid = null, int $per = null)

  • 返回根据提供的参数筛选的投诉列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。
  • $fields: 如果存在，则检索这些联系人字段
  • $from: 日期范围筛选的开始
  • $to: 日期范围筛选的结束
  • $unique: 如果为 true，则获取唯一记录
  • $email：获取特定电子邮件的投诉
  • $uid：获取提供的uid的投诉
  • $per: 获取指定的记录数

• getAbReports(string $name, int $page, string $from = null, string $to = null, int $per = null)

  • 返回Ab报告列表
  • $name：获取提及名称的ab_reports
  • $page：页面号（>= 1）。每页最多返回 200 条记录。
  • $from：日期范围筛选的开始
  • $to: 日期范围筛选的结束
  • $per：获取指定数量的报告

• getJourneys(int $page)

  • 返回所有旅程列表
  • $page：页面号（>= 1）。每页最多返回 200 条记录。