insidieux/slack-api

Simple Slack API client wih predefined methods

SlackApi

, _(*1)

A simple PHP package for making request to Slack API, focused on ease-of-use and elegant syntax., _(*2)

Requirements

• PHP 5.5 or greater
• CURL extension for PHP

Installation

You can install the package using the Composer package manager. You can install it by running this command in your project root:, _(*3)

composer require insidieux/slack-api

Usage

Create API client, _(*4)

$client = new \SlackApi\Client('your-token-here');

Make request, _(*5)

$client = new \SlackApi\Client('your-token-here');
$response = $client->request('module.method', ['argument' => 'value']);
$response->toArray();

Or you can use predefined modules and methods, _(*6)

$client = new \SlackApi\Client('your-token-here');
$response = $client->users()->getList();
$response->toArray()

Predefined modules: * [channels] (https://api.slack.com/methods#channels) * [chat] (https://api.slack.com/methods#chat) * [dnd] (https://api.slack.com/methods#dnd) * [emoji] (https://api.slack.com/methods#emoji) * [files] (https://api.slack.com/methods#files) * [groups] (https://api.slack.com/methods#groups) * [im] (https://api.slack.com/methods#im) * [oauth] (https://api.slack.com/methods#oauth) * [pins] (https://api.slack.com/methods#pins) * [search] (https://api.slack.com/methods#search) * [team] (https://api.slack.com/methods#team) * [usergroups] (https://api.slack.com/methods#usergroups) * [users] (https://api.slack.com/methods#users), _(*7)

Message and attachment objects

Create message object, _(*8)

$client = new \SlackApi\Client('your-token-here');
$message = new \SlackApi\Models\Message($client);

or, _(*9)

$client = new \SlackApi\Client('your-token-here');
$message = $client->makeMessage();

Create new attachment from array, _(*10)

$data = [
    'fallback' => 'Some fallback'
    'pretext'  => 'Some pretext',
    'text'     => 'good',
    'text'     => 'Some text'
]; 
$attachment1 = new \SlackApi\Models\Attachment($data);

Or use set methods, _(*11)

$attachment2 = new \SlackApi\Models\Attachment;
$attachment2->setText('Some text')
    ->setColor(\SlackApi\Models\Attachment::COLOR_GOOD)
    ->setFallback('Some fallback');

Add field to attachment, _(*12)

$field = new \SlackApi\Models\AttachmentField;
$field->setShort(false)
    ->setTitle('Field title')
    ->setValue('Field value');
$attachment->addField($field);

Attach object to message, _(*13)

$message->attach($attachment);

Send message, _(*14)

$response = $message->send();
$response->toArray()

Author

• Ageev Pavel