shapin / talkjs
PHP client for talk.js API
Installs: 182 878
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 2
Forks: 4
Open Issues: 3
Requires
- php: ^7.3
- symfony/config: ^4.3|^5.0
- symfony/http-client: ^4.3|^5.0
Requires (Dev)
- phpunit/phpunit: ^8.5
- symfony/phpunit-bridge: ^4.4|^5.0
- symfony/var-dumper: ^4.3|^5.0
README
Note: This package is unmaintained. For further updates please see carandclassic/talkjs
Install
Via Composer
$ composer require shapin/talkjs
Usage
Create a TalkJSClient
use Shapin\TalkJS\TalkJSClient; use Symfony\Component\HttpClient\HttpClient; $httpClient = HttpClient::create([ 'base_uri' => 'https://api.talkjs.com/v1/'.self::APP_ID.'/', 'auth_bearer' => self::SECRET_KEY, 'headers' => [ 'Content-Type' => 'application/json', ], ]); $talkJSClient = new TalkJSClient($httpClient);
IDs
TalkJS IDs for users and conversations are custom and managed by your application.
Filtering
All endpoints that fetch multiple records (users, conversations, messages) have limit & pagination options. API usage below will use a $filters variable where possible for demonstration, and it will look like this:
$filters = [ 'limit' => 50, 'startingAfter' => 'latestMessageId' ];
Users
Please note TalkJS currently does not offer a user deletion API, and instead recommend you use the update/edit endpoints to anonymise personally identifiable information.
// Create or update a user $client->users()->createOrUpdate('my_custom_id', [ 'email' => 'georges@abitbol.com', ]); // Retrieve a user $user = $client->users()->get('my_custom_id');
Conversations
// Create or update a conversation $client->conversations()->createOrUpdate('my_custom_id', [ 'subject' => 'My new conversation', 'participants' => ['my_user_id_1', 'my_user_id_2'], 'welcomeMessages' => ['Welcome!'], 'custom' => ['test' => 'test'], 'photoUrl' => null ]); // Retrieve a conversation $conversation = $client->conversations()->get('my_custom_id'); // Find conversations $conversations = $client->conversations()->find($filters); // Join a conversation $client->conversation()->join('my_conversation_id', 'my_user_id'); // Leave a conversation $client->conversation()->leave('my_conversation_id', 'my_user_id'); // Update participation settings $params = [ 'notify' => true, // Boolean, default true 'access' => 'ReadWrite' // ReadWrite or Read, default ReadWrite ]; $client->conversations()->updateParticipation('my_conversation_id', 'my_user_id', $params);
Messages
For more information on custom data and filters, please refer to the TalkJS documentation linked above.
Please note:
- Sending file attachment is not implemented.
- Endpoints that return multiple messages will return them in descending order, i.e. latest first.
$custom = [ 'foo' => 'bar' ]; // Find Messages $client->conversations()->findMessages('my_conversation_id', $filters); // Post a system message $client->conversations()->postSystemMessage('my_conversation_id', 'message_text', $custom); // Post a user message $client->conversations()->postUserMessage('my_conversation_id', 'my_user_id', 'message_text', $custom);
Integration with Symfony
Create a new HttpClient:
framework: http_client: scoped_clients: talkjs.client: auth_bearer: '%env(TALKJS_SECRET_KEY)%' base_uri: 'https://api.talkjs.com/v1/%env(TALKJS_APP_ID)%/' headers: 'Content-Type': 'application/json'
Then create your service:
services: Shapin\TalkJS\TalkJSClient: ~
You're done!
One day, I may consider creating a bundle in order to bootstrap this SDK...
License
The MIT License (MIT). Please see License File for more information.