README

Sendbird PHP Platform SDK

This is a SDK written for PHP that makes talking to the Sendbird Platform API easier. With this library you can extend your Sendbird integration to include advanced features like message-, and channel automation, user management, create user authentication tokens, and create bots.

🔥 Quick start

<?php
require_once('/PATH_TO/sendbird-platform-sdk-php/vendor/autoload.php');
$config = \Sendbird\Configuration::getDefaultConfiguration();

$api_token = 'MASTER_API_TOKEN_FROM_DASHBOARD';
$config->setHost("API_REQUEST_URL_FROM_DASHBOARD");

$apiInstance = new Sendbird\Api\UserApi(
    new GuzzleHttp\Client(),
    $config
);

$list_users_params['api_token'] = $api_token;

try {
    $result = $apiInstance->listUsers($list_users_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling listUsers: ', $e->getMessage(), PHP_EOL;
}

⚠️ Warnings

This package is not currently published. Please see the Local development section for installation instructions.

⚒️ Prerequisite

In order to make requests with this SDK you will need you master API token. This can be found through the Sendbird dashboard. Each app you create in Sendbird has its own master api token. These tokens can be found in Settings > Application > General.

💻 Requirements

You will need PHP installed. This has been developed and tested with PHP 7.3 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/sendbird/sendbird-platform-sdk-php.git"
    }
  ],
  "require": {
    "sendbird/sendbird-platform-sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Clone this repository, run composer install in the sendbird-platform-sdk directory
Include autoload.php in your project

<?php
require_once('/path/to/sendbird-platform-sdk/vendor/autoload.php');

Helpful links

	Documentation
Announcement	docs/Api/AnnouncementApi.md
Application	docs/Api/ApplicationApi.md
Bot	docs/Api/BotApi.md
GroupChannel	docs/Api/GroupChannelApi.md
OpenChannel	docs/Api/OpenChannelApi.md
Message	docs/Api/MessageApi.md
User	docs/Api/UserApi.md
Webhooks	docs/Api/WebhooksApi.md

sendbird / sendbird-platform-sdk-php

Maintainers

Details