livechat/api-client-php

Enables PHP applications to communicate with the LiveChat API.

Maintainers

Details

github.com/livechat/api-client-php

Homepage

Source

Issues

Installs: 278 312

Dependents: 0

Suggesters: 0

Security: 0

Stars: 37

Watchers: 24

Forks: 27

Open Issues: 5

v1.1.1 2016-01-15 09:01 UTC

Requires

  • php: >=5.3.0

MIT 755cda267e1c54e593eab28c5c7ae31735533425

restapi

This package is not auto-updated.

Last update: 2024-12-19 14:32:40 UTC

README

PHP client for connecting to the LiveChat REST API.

Documentation

To find out more, visit the official LiveChat REST API documentation.

Previous version of LiveChat API Client.

Requirements

  • PHP 5.3 or greater
  • cUrl extension enabled

Authentication to the API occurs via HTTP Basic Auth. Provide your:

  • login
  • API key

More information: https://developers.livechatinc.com/rest-api/#authentication

Installation

Composer

$ composer require livechat/api-client-php "@dev"

Or, set up dev as minimum-stability in your composer.json:

    "minimum-stability": "dev"

Then:

 $ composer require livechat/api-client-php
 $ composer update

Execute tests

This operation requires PHPUnit installed.

 $ phpunit

Basic usage

<?php

require_once __DIR__ . '/vendor/autoload.php';

use LiveChat\Api\Client as LiveChat;

$LiveChatAPI = new LiveChat('%login%', '%apiKey%');
$agents = $LiveChatAPI->agents->get();

Available methods

Methods returns stdClass (parsed JSON response).

Agents

Agents REST API documentation.

  • $LiveChatAPI->agents->get($login = null)
  • $LiveChatAPI->agents->add(array $vars)
  • $LiveChatAPI->agents->update($login, array $vars)
  • $LiveChatAPI->agents->delete($login)

Canned responses

Canned responses REST API documentation.

  • $LiveChatAPI->cannedResponses->get($group = 0)
  • $LiveChatAPI->cannedResponses->getSingleResponse($id)
  • $LiveChatAPI->cannedResponses->addNewResponse($text, $tags)
  • $LiveChatAPI->cannedResponses->updateResponse($id, $text, $tags)
  • $LiveChatAPI->cannedResponses->deleteResponse($id)

Chat archives

Archives REST API documentation.

  • $LiveChatAPI->chats->get($params = array())
  • $LiveChatAPI->chats->getSingleChat($chatId)
  • $LiveChatAPI->chats->updateTags($id, array $vars)

Goals

Goals REST API documentation.

  • $LiveChatAPI->goals->markAsSuccessful($goalId)

Groups

Groups REST API documentation.

  • $LiveChatAPI->groups->get($group = 0)
  • $LiveChatAPI->groups->update($id, array $vars)
  • $LiveChatAPI->groups->add(array $vars)
  • $LiveChatAPI->groups->delete($id)

Reports

Reports REST API documentation.

  • $LiveChatAPI->reports->get($type, array $params = array())

Status

Status REST API documentation.

  • $LiveChatAPI->status->get($group = 0)

Tickets

Tickets REST API documentation.

  • $LiveChatAPI->tickets->get(array $params = array())
  • $LiveChatAPI->tickets->getSingleTicket($ticketId)
  • $LiveChatAPI->tickets->add(array $vars)
  • $LiveChatAPI->tickets->updateTags($id, array $vars)

Visitors

Visitors REST API documentation.

  • $LiveChatAPI->visitors->get(array $params = array())

Tags

Tags REST API documentation.

  • $LiveChatAPI->tags->get($group=0)

  • $LiveChatAPI->tags->add(array( "author" => 'test@email.com', "tag" => 'Test Tag', "group" => 1 ))

  • $LiveChatAPI->tags->delete('Tag Name')

Webhooks

Webhooks REST API documentation.

  • $LiveChatAPI->webhooks->get()

  • $LiveChatAPI->webhooks->add(array( "event_type" => "chat_started", "data_types" => array( "chat", "visitor" ), "url" => "http://www.shoeshop.com/webhook", ))

  • $LiveChatAPI->webhooks->delete('622d3950eecea8bb5f8c26f20c76ee2e')

To do

  • Tests for models
  • Add all supported API methods