PHPackages                             emailplatform/api\_parser - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. emailplatform/api\_parser

ActiveLibrary[API Development](/categories/api)

emailplatform/api\_parser
=========================

PHP class for using our company's API as part of the subscription

1.2.22(2y ago)379.8k↓40.7%3MITPHPPHP >=5.6.0

Since Dec 22Pushed 2y ago1 watchersCompare

[ Source](https://github.com/emailplatform/ApiParser)[ Packagist](https://packagist.org/packages/emailplatform/api_parser)[ Docs](https://github.com/emailplatform/ApiParser/tree/version1.2.1)[ RSS](/packages/emailplatform-api-parser/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)DependenciesVersions (49)Used By (0)

ApiParser
=========

[](#apiparser)

PHP class for using our company's API as part of the subscription.

---

Installation
------------

[](#installation)

Run following command in terminal from the root of your project:

```
composer require emailplatform/api_parser
```

You can load dependencies by adding these lines to your code:

```
require_once 'vendor/emailplatform/api_parser/src/settings.php';
require_once 'vendor/emailplatform/api_parser/src/ApiParser.class.php';
```

---

How to use
----------

[](#how-to-use)

1. Set up your API credentials (apiusername & apitoken) into **settings.php**
2. Create instance from **ApiParser.class.php**

```
$parser = new ApiParser($settings);
```

3. Call method from ApiParser

```
$subscriberid = 68317547;
$listid = 0;
$emailaddress = "";
$mobileNumenr = "";
$mobilePrefix = "";
$fieldid = 14;
$fieldValue = array(
   'Lastname' => "Tom",
   'Firstname' => 'Jones',
   'Date' => '31-12-2020 T00:00',
   'Active' => 0
);
$path = 'Users[Lastname=SimpleChange4]';

$result = $parser->UpdateOTMDocument($subscriberid, $listid, $emailaddress, $mobileNumber, $mobilePrefix, $fieldid, $fieldValue, $path);

print_r($result);
```

---

Changelog:
----------

[](#changelog)

### *Differences between **v1.2.21** and **v1.2.22***

[](#differences-between-v1221-and-v1222)

#### Method definition changed:

[](#method-definition-changed)

- **ChangeMobile**

> *Now:*
>
> ```
> $Mobile no longer require parameters
> ```

### *Differences between **v1.2.19** and **v1.2.21***

[](#differences-between-v1219-and-v1221)

#### Method definition changed:

[](#method-definition-changed-1)

- **ScheduleSendSMS**

> \*Previous:

> ```
> public function ScheduleSendSMS($campaignid = false, $lists = false, $hours = false)
> ```

> *Now:*
>
> ```
> public function ScheduleSendSMS($campaignid = false, $hours = false)
> ```

### *Differences between **v1.2.16** and **v1.2.17***

[](#differences-between-v1216-and-v1217)

#### Method definition changed:

[](#method-definition-changed-2)

- **UpdateOTMDocument**

> *Previous:*

> ```
> public function UpdateOTMDocument ($subscriberid = 0, $fieldid = 0, $fieldValueOTM = array(), $path = "")
> ```

> *Now:*
>
> ```
> public function UpdateOTMDocument ($subscriberid = 0, $listid = 0, $emailaddress = "", $mobileNumber = "", $mobilePrefix = "", $fieldid = 0, $fieldValueOTM = array(), $path = "")
> ```

> - **Added:** listid, emailaddress, mobileNumber and mobilePrefix.

### *Differences between **v1.2.15** and **v1.2.16***

[](#differences-between-v1215-and-v1216)

#### Method definition changed:

[](#method-definition-changed-3)

- **GetSubscriberDetails**

> *Previous:*`listid was required.`

> *Now:*`listid is not required if subscriberid is specified.`

### *Differences between **v1.2.14** and **v1.2.15***

[](#differences-between-v1214-and-v1215)

#### Method definition changed:

[](#method-definition-changed-4)

- **ScheduleSendNewsletter**

> *Previous:*

> ```
> public function ScheduleSendNewsletter($campaignid = false, $hours = false, $saveSnapshots = true, $reloadFeed = true)
> ```

> *Now:*
>
> ```
> public function ScheduleSendNewsletter($campaignid = false, $hours = false, $saveSnapshots = true, $reloadFeed = true, $notifyOwner = false)
> ```

> - **Added:** notifyOwner

- **ScheduleSendNewsletterToLists**

> *Previous:*
>
> ```
> public function ScheduleSendNewsletterToLists($newsletterid = false, $timeToSend = false, $listids = array(), $saveSnapshots = true, $reloadFeed = true)
> ```
>
>
>
> *Now:*
>
> ```
> public function ScheduleSendNewsletterToLists($newsletterid = false, $timeToSend = false, $listids = array(), $saveSnapshots = true, $reloadFeed = true, $notifyOwner = false)
> ```
>
>
>
> - **Added:** notifyOwner

- **ScheduleSendNewsletterToSegments**

> *Previous:*
>
> ```
> public function ScheduleSendNewsletterToSegments($newsletterid = false, $timeToSend = false, $segmentids = array(), $saveSnapshots = true, $reloadFeed = true)
> ```
>
>
>
> *Now:*
>
> ```
> public function ScheduleSendNewsletterToSegments($newsletterid = false, $timeToSend = false, $segmentids = array(), $saveSnapshots = true, $reloadFeed = true, $notifyOwner = false)
> ```
>
>
>
> - **Added:** notifyOwner

- **SendNewsletter**

> *Previous:*
>
> ```
> public function SendNewsletter($newsletterid = 0, $subscriberid = 0, $email = '', $senderEmail = '', $senderName = '', $replyEmail = '', $callbackUrl = false, $reloadFeed = false)
> ```
>
>
>
> *Now:*
>
> ```
> public function SendNewsletter($newsletterid = 0, $subscriberid = 0, $email = '', $senderEmail = '', $senderName = '', $replyEmail = '', $callbackUrl = false, $reloadFeed = false, $notifyOwner = false)
> ```
>
>
>
> - **Added:** notifyOwner

#### New method:

[](#new-method)

- **UpdateOTMDocument**

> ```
> public function UpdateOTMDocument ($subscriberid = 0, $fieldid = 0, $fieldValueOTM = array(), $path = "")
> ```

- **RemoveOTMDocument**

> ```
> public function RemoveOTMDocument ($subscriberid = 0, $fieldid = 0, $path = "", $index = 0)
> ```

### *Differences between **v1.2.13** and **v1.2.14***

[](#differences-between-v1213-and-v1214)

#### Method definition changed:

[](#method-definition-changed-5)

- **ScheduleSendNewsletter**

> *Previous:*
>
> ```
> public function ScheduleSendNewsletter($campaignid = false, $hours = false, $saveSnapshots = true)
> ```
>
>
>
> *Now:*
>
> ```
> public function ScheduleSendNewsletter($campaignid = false, $hours = false, $saveSnapshots = true, $reloadFeed = true)
> ```
>
>
>
> - **Added:** reloadFeed

- **ScheduleSendNewsletterToLists**

> *Previous:*
>
> ```
> public function ScheduleSendNewsletterToLists($newsletterid = false, $timeToSend = false, $listids = array())
> ```
>
>
>
> *Now:*
>
> ```
> public function ScheduleSendNewsletterToLists($newsletterid = false, $timeToSend = false, $listids = array(), $saveSnapshots = true, $reloadFeed = true)
> ```
>
>
>
> - **Added:** saveSnapshots and reloadFeed

- **ScheduleSendNewsletterToSegments**

> *Previous:*
>
> ```
> public function ScheduleSendNewsletterToSegments($newsletterid = false, $timeToSend = false, $segmentids = array())
> ```
>
>
>
> *Now:*
>
> ```
> public function ScheduleSendNewsletterToSegments($newsletterid = false, $timeToSend = false, $segmentids = array(), $saveSnapshots = true, $reloadFeed = true)
> ```
>
>
>
> - **Added:** saveSnapshots and reloadFeed

### *Differences between **v1.2.12** and **v1.2.13***

[](#differences-between-v1212-and-v1213)

#### New method:

[](#new-method-1)

- **CreateSegment**

> ```
> public function CreateSegment($name = "", $rules = array(), $connector = 'and')
> ```

### *Differences between **v1.2.11** and **v1.2.12***

[](#differences-between-v1211-and-v1212)

#### New method:

[](#new-method-2)

- **AddCustomFieldsToList**

> ```
> public function AddCustomFieldsToList($listid = false, $customFields = array())
> ```

### *Differences between **v1.2.10** and **v1.2.11***

[](#differences-between-v1210-and-v1211)

#### Method definition changed:

[](#method-definition-changed-6)

- **SendNewsletter**

> *Previous:*
>
> ```
> public function SendNewsletter($newsletterid = 0, $subscriberid = 0, $email = '', $senderEmail = '', $senderName = '', $replyEmail = '')
> ```
>
>
>
> *Now:*
>
> ```
> public function SendNewsletter($newsletterid = 0, $subscriberid = 0, $email = '', $senderEmail = '', $senderName = '', $replyEmail = '', $callbackUrl = false, $reloadFeed = false)
> ```
>
>
>
> - **Added:** callbackUrl and reloadFeed

### *Differences between **v1.2.9** and **v1.2.10***

[](#differences-between-v129-and-v1210)

#### New methods:

[](#new-methods)

- **ScheduleSendNewsletterToLists**

> *Definition:*
>
> ```
> public function ScheduleSendNewsletterToLists($newsletterid = false, $timeToSend = false, $listids = array())
> ```

- **ScheduleSendNewsletterToSegments**

> *Definition:*
>
> ```
> public function ScheduleSendNewsletterToSegments($newsletterid = false, $timeToSend = false, $segmentids = array()))
> ```

### *Differences between **v1.2.7** and **v1.2.9***

[](#differences-between-v127-and-v129)

#### Method definition changed:

[](#method-definition-changed-7)

- **ScheduleSendNewsletter**

> *Previous:*
>
> ```
> public function ScheduleSendNewsletter($campaignid = false, $hours = false)
> ```
>
>
>
> *Now:*
>
> ```
> public function ScheduleSendNewsletter($campaignid = false, $hours = false, $saveSnapshots = true)
> ```
>
>
>
> - **Added:** $saveSnapshots

#### New methods:

[](#new-methods-1)

- **GetSentEmailCampaignEvents**

> *Definition:*
>
> ```
> public function GetSentEmailCampaignEvents($from = false, $to = false $limit = 10, $offset = 0)
> ```

- **GetSentEmailCampaignWithTriggerEvents**

> *Definition:*
>
> ```
> public function GetSentEmailCampaignWithTriggerEvents($from = false, $to = false $limit = 10, $offset = 0)
> ```

- **GetOpenCampaignEvents**

> *Definition:*
>
> ```
> public function GetOpenCampaignEvents($from = false, $to = false $limit = 10, $offset = 0)
> ```

- **GetOpenTriggersEvents**

> *Definition:*
>
> ```
> public function GetOpenTriggersEvents($from = false, $to = false $limit = 10, $offset = 0)
> ```

- **GetLinkClickCampaignEvents**

> *Definition:*
>
> ```
> public function GetLinkClickCampaignEvents($from = false, $to = false $limit = 10, $offset = 0)
> ```

- **GetLinkClickTriggerEvents**

> *Definition:*
>
> ```
> public function GetLinkClickTriggerEvents($from = false, $to = false $limit = 10, $offset = 0)
> ```

- **GetSentAutoresponderEvents**

> *Definition:*
>
> ```
> public function GetSentAutoresponderEvents($from = false, $to = false $limit = 10, $offset = 0)
> ```

- **GetOpenAutoresponderEvents**

> *Definition:*
>
> ```
> public function GetOpenAutoresponderEvents($from = false, $to = false $limit = 10, $offset = 0)
> ```

- **GetLinkClickAutoresponderEvents**

> *Definition:*
>
> ```
> public function GetLinkClickAutoresponderEvents($from = false, $to = false $limit = 10, $offset = 0)
> ```

- **GetSentSMSCampaignEvents**

> *Definition:*
>
> ```
> public function GetSentSMSCampaignEvents($from = false, $to = false $limit = 10, $offset = 0)
> ```

---

### *Differences between **v1.2.6** and **v1.2.7***

[](#differences-between-v126-and-v127)

#### New method:

[](#new-method-3)

- **GetTrackingEvents**

> *Definition:*
>
> ```
> public function GetTrackingEvents($listid = false, $subscriberid = false, $limit = 100, $offset = 0)
> ```

---

### *Differences between **v1.2.5** and **v1.2.6***

[](#differences-between-v125-and-v126)

#### New methods:

[](#new-methods-2)

- **GetLeadScore**

> *Definition:*
>
> ```
> public function GetLeadScore($subscriberid = false)
> ```

- **SetLeadScore**

> *Definition:*
>
> ```
> public function SetLeadScore($subscriberid = false, $leadScore = false, $type = "add")
> ```

---

### *Differences between **v1.2.4** and **v1.2.5***

[](#differences-between-v124-and-v125)

#### Method condition changed:

[](#method-condition-changed)

- **GetCustomFields**

> *Previous:*
>
> ```
> public function GetCustomFields($listids = false)
> ```
>
>
>
> *Now:*
>
> ```
> public function GetCustomFields($listids = false)
> ```
>
>
>
> - **listids:** is not required.

---

### *Differences between **v1.2.3** and **v1.2.4***

[](#differences-between-v123-and-v124)

#### New methods:

[](#new-methods-3)

- **GetSnapshots**

> *Definition:*
>
> ```
> public function GetSnapshots($subscriberid = false, $triggerid = false, $autoresponderid = false, $campaignid = false, $groupby = "date")
> ```

- **GetNewsletterSummary**

> *Definition:*
>
> ```
> public function GetNewsletterSummary($newsletterid = false, $statid = false, $from = false, $to = false)
> ```

- **GetStatids**

> *Definition:*
>
> ```
> public function GetStatids($listid = false, $segmentid = false, $newsletterid = false, $from = false, $to = false, $limit = 100, $offset = 0)
> ```

---

### *Differences between **v1.2.2** and **v1.2.3***

[](#differences-between-v122-and-v123)

#### Method definition changed:

[](#method-definition-changed-8)

- **ResubscribeContact**

> *Previous:*
>
> ```
> public function ResubscribeContact($listid = false, $emailaddress = false, $mobileNumber = false, $mobilePrefix = false, $add_to_autoresponders = false)
> ```
>
>
>
> *Now:*
>
> ```
> public function ResubscribeContact($listid = false, $emailaddress = false, $mobileNumber = false, $mobilePrefix = false, $add_to_autoresponders = false, $contactFields = array())
> ```
>
>
>
> - **Added:** $contactFields.

---

### *Differences between **v1.2.1** and **v1.2.2***

[](#differences-between-v121-and-v122)

#### New methods:

[](#new-methods-4)

- **GetTriggers**

> *Definition:*
>
> ```
> public function GetTriggers($listid = false, $limit = 1000, $offset = 0)
> ```

- **GetSegments**

> *Definition:*
>
> ```
> public function GetSegments($listid = false, $count_subscribers = false, $limit = 100, $offset = 0)
> ```

---

### *Differences between **v1.1.11** and **v1.2.1***

[](#differences-between-v1111-and-v121)

#### New methods:

[](#new-methods-5)

- **AddToOTMDocument**

> *Definition:*
>
> ```
> public function AddToOTMDocument ($listid = false, $subscriberid = false, $emailaddress = false, $mobile = false, $mobilePrefix = false, $fieldid = false, $values = array(), $path = false)
> ```

- **GetSubscribersByCustomField**

> *Definition:*
>
> ```
> public function GetSubscribersByCustomField ($listid = false, $data = array(), $activeonly = true, $countonly = false, $limit = 1000, $offset = 0)
> ```

---

### *Differences between **v1.1.10** and **v1.1.11***

[](#differences-between-v1110-and-v1111)

#### New methods:

[](#new-methods-6)

- **GetTriggerSummary**

> *Definition:*
>
> ```
> public function GetTriggerSummary($triggerid = false, $from = false, $to = false)
> ```

- **GetAutoresponderSummary**

> *Definition:*
>
> ```
> public function GetAutoresponderSummary($autoresponderid = false, $from = false, $to = false)
> ```

### *Differences between **v1.1.9** and **v1.1.10***

[](#differences-between-v119-and-v1110)

#### New methods:

[](#new-methods-7)

- **GetSegmentSummary**

> *Definition:*
>
> ```
> public function GetSegmentSummary($segmentid = false, $from = false, $to = false)
> ```

- **GetRulesForSegment**

> *Definition:*
>
> ```
> public function GetRulesForSegment($segmentid = false)
> ```

- **EditNewsletter**

> *Definition:*
>
> ```
> public function EditNewsletter($newsletterid = false, $name = false, $subject = false)
> ```

- **SetTriggerStatus**

> *Definition:*
>
> ```
> public function SetTriggerStatus($triggerid = false, $status = false)
> ```

- **SetAutoresponderStatus**

> *Definition:*
>
> ```
> public function SetAutoresponderStatus($autoresponderid = false, $status = false)
> ```

---

### *Differences between **v1.1** and **v1.1.9***

[](#differences-between-v11-and-v119)

#### New methods:

[](#new-methods-8)

- **SendSMS**

> *Definition:*
>
> ```
> public function SendSMS($campaignid = 0, $subject = '', $text = '', $subscriberid = 0, $listid = 0, $mobile = '', $mobilePrefix = '')
> ```

- **GetSubscribersFromSegment**

> *Definition:*
>
> ```
> public function GetSubscribersFromSegment($segmentid = false, $countonly = false, $activeonly = true, $limit = 100, $offset = 0)
> ```

- **GetTriggersForSegment**

> *Definition:*
>
> ```
> public function GetTriggersForSegment($segmentid)
> ```

- **ViewNewsletter**

> *Definition:*
>
> ```
> public function ViewNewsletter($newsletterid)
> ```

#### Method definition changed:

[](#method-definition-changed-9)

- **GetNewsletters**

> *Previous:*
>
> ```
> public function GetNewsletters($countOnly= false, $getLastSentDetails = false, $content = true, $aftercreatedate = false, $newsletterNameLike = false)
> ```
>
>
>
> *Now:*
>
> ```
> public function GetNewsletters($countOnly= false, $getLastSentDetails = false, $content = true, $aftercreatedate = false, $newsletterNameLike = false, $limit = false, $offset = false)
> ```
>
>
>
> - **Added:** $limit & $offset.

---

### *Differences between **v1.0** and **v1.1***

[](#differences-between-v10-and-v11)

#### Renamed methods:

[](#renamed-methods)

Old name \[v1.0\]New name \[v1.1\]Create\_ListCreateListUpdate\_ListUpdateListDelete\_ListDeleteListUpdate\_SubscriberUpdateSubscriberCopy\_NewsletterCopyNewsletter
#### Method definition changed:

[](#method-definition-changed-10)

- **UnsubscribeSubscriberEmail**

> *Previous:*
>
> ```
> public function UnsubscribeSubscriberEmail ($emailaddress = false, $listid = false, $subscriberid = false, $skipcheck = false, $statid = false)
> ```
>
>
>
> *Now:*
>
> ```
> public function UnsubscribeSubscriberEmail ($listid = false, $emailaddress = false, $subscriberid = false, $skipcheck = false, $statid = false)
> ```

- **UnsubscribeSubscriberMobile**

> *Previous:*
>
> ```
> public function UnsubscribeSubscriberMobile ($mobile = false, $mobilePrefix = false, $listid = false, $subscriberid = false, $skipcheck = false, $statid = false)
> ```
>
>
>
> *Now:*
>
> ```
> public function UnsubscribeSubscriberMobile ($listid = false, $mobile = false, $mobilePrefix = false, $subscriberid = false, $skipcheck = false, $statid = false)
> ```

- **GetSubscriberDetails**

> *Previous:*
>
> ```
> public function GetSubscriberDetails($emailaddress = false, $listid = false)
> ```
>
>
>
> *Now:*
>
> ```
> public function GetSubscriberDetails($listid = false, $subscriberid = false, $emailaddress = false, $mobile = false, $mobile_prefix = false)
> ```
>
>
>
> - **Added:** subscriberid, mobile and mobile\_prefix.

- **GetRecipients**

> *Previous:*
>
> ```
> public function GetRecipients($statid = false, $stats_type = false, $count_only = false)
> ```
>
>
>
> *Now:*
>
> ```
> public function GetRecipients($statid = false, $count_only = false)
> ```
>
>
>
> - **Removed:** stats\_type.

- **ActivateSubscriber**

> *Previous:*
>
> ```
> public function ActivateSubscriber ($service = false, $lists = false, $emailaddress = false, $mobile = false, $mobile_prefix = false)
> ```
>
>
>
> *Now:*
>
> ```
> public function ActivateSubscriber ($service = false, $listid = false, $emailaddress = false, $mobile = false, $mobile_prefix = false, $subscriberid = false)
> ```
>
>
>
> - **Added:** subscriberid.

- **UpdateSubscriber**

> *Previous:*
>
> ```
> public function UpdateSubscriber($subscriberid = false, $emailaddress = false, $mobile = false, $listid = false, $customfields = array())
> ```
>
>
>
> *Now:*
>
> ```
> public function UpdateSubscriber($listid = false, $subscriberid = false, $emailaddress = false, $mobile = false, $mobilePrefix = false, $customfields = array())
> ```
>
>
>
> - **Added:** mobile, mobilePrefix.

- **ScheduleSendSMS**

> *Previous:*
>
> ```
> public function ScheduleSendSMS($campaignid = false, $hours = false, $lists = false)
> ```
>
>
>
> *Now:*
>
> ```
> public function ScheduleSendSMS($campaignid = false, $lists = false, $hours = false)
> ```

---

###  Health Score

38

—

LowBetter than 85% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity35

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity71

Established project with proven stability

 Bus Factor1

Top contributor holds 99.4% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~88 days

Recently: every ~296 days

Total

25

Last Release

945d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/4cfae98a15de28c2990796a0fdc1a88380d19ca80c17a5c1879cd0bd8b148b81?d=identicon)[emailplatform](/maintainers/emailplatform)

---

Top Contributors

[![emailplatform](https://avatars.githubusercontent.com/u/34769697?v=4)](https://github.com/emailplatform "emailplatform (179 commits)")[![maarcz](https://avatars.githubusercontent.com/u/7533848?v=4)](https://github.com/maarcz "maarcz (1 commits)")

---

Tags

apilibrary

### Embed Badge

![Health badge](/badges/emailplatform-api-parser/health.svg)

```
[![Health](https://phpackages.com/badges/emailplatform-api-parser/health.svg)](https://phpackages.com/packages/emailplatform-api-parser)
```

###  Alternatives

[gorkalaucirica/hipchat-v2-api-client

Hipchat v2 API client

80223.4k6](/packages/gorkalaucirica-hipchat-v2-api-client)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)