Download the PHP package arquivei/intercom-php without Composer
On this page you can find all versions of the php package arquivei/intercom-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package intercom-php
intercom-php
Official PHP bindings to the Intercom API
Installation
Requires PHP 5.6.
The recommended way to install intercom-php is through Composer:
First, install Composer:
Next, install the latest intercom-php:
Finally, you need to require the library in your PHP application:
Clients
For OAuth or Access Tokens use:
If you already have an access token you can find it here. If you want to create or learn more about access tokens then you can find more info here.
If you are building a third party application you can get your OAuth token by setting-up-oauth for Intercom.
Users
See here for more info on using the scroll parameter
Leads
See here for more info on using the scroll parameter
Visitors
Retrieve user_id
of a visitor via the JavaScript API
Tags
Segments
Events
Companies
Admins
Messages
Conversations
Counts
Notes
Rate Limits
Rate limit info is passed via the rate limit headers. You can access this information as follows:
For more info on rate limits and these headers please see the API reference docs
Pagination
When listing, the Intercom API may return a pagination object:
You can grab the next page of results using the client:
Scroll
The first time you use the scroll API you can just send a simple GET request. This will return up to 100 records. If you have more than 100 you will need to make another call. To do this you need to use to scroll_parameter returned in the original response. Use this for subsequent responses until you get an empty array of records. This means there are no records and the scroll timer will be reset. For more information on scroll please see the API reference Here is an example of a simple way to use the scroll for multiple calls:
Exceptions
Exceptions are handled by Guzzle. The Intercom API may return an unsuccessful HTTP response, for example when a resource is not found (404). If you want to catch errors you can wrap your API call into a try/catch:
Pull Requests
-
Add tests! Your patch won't be accepted if it doesn't have tests.
-
Document any change in behaviour. Make sure the README and any other relevant documentation are kept up-to-date.
-
Create topic branches. Don't ask us to pull from your master branch.
-
One pull request per feature. If you want to do more than one thing, send multiple pull requests.
- Send coherent history. Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before sending them to us.