README

A laravel Crisp library for Crisp Chat API.

Support Me

You can use my referral link to sign up for Crisp Chat. I get a small reward if you upgrade to the Essentials or Plus Plan in the future.

I highly recommend Crisp Chat if you are looking for a chat support SaaS for your website. As it charges a flat monthly fee per workspace instead of charging by per seat.

At the Essentials Plan & above, you also get features like: Sites Monitoring, Status Pages, AI Bot Builder, Knowledge Base, WhatsApp Integration & more!

Side Note: Looking to send WhatsApp messages with Crisp Chat? Check out my Laravel Crisp WhatsApp package too!

Installation

You can install the package via composer:

composer require ziming/laravel-crisp

You can publish the config file with:

php artisan vendor:publish --tag="crisp-config"

This is the contents of the published config file:

return [
    'website_id' => env('CRISP_WEBSITE_ID'),
    'tier' => env('CRISP_TIER', 'plugin'),
    'access_key_id' => env('CRISP_ACCESS_KEY_ID'),
    'secret_access_key' => env('CRISP_SECRET_ACCESS_KEY'),
];

Usage

So what are the differences between the Crisp's official PHP SDK and this package?

The 1st main difference is that you don't have to set the tier & api credentials every time after instantiating

You also do not have to pass in the website_id every time.

I hope through the examples below, you can see how much more convenient this brings for those of us who only have a single Crisp workspace.

But 1st you need to create your plugin at the Crisp Marketplace 1st.

With that done, you may continue with the examples below or check out the source code in the src/Resources folder.

// Official PHP Crisp SDK
use Crisp\CrispClient;
$officialCrisp = new CrispClient();
$officialCrisp->setTier('plugin');
$officialCrisp->authenticate(
    config('crisp.access_key_id'), 
    config('crisp.secret_access_key')
);

$officialCrisp->websitePeople->findByEmail(config('crisp.website_id'), 'abc@example.com');

// This Package
$laravelCrisp = new Ziming\LaravelCrisp();
$laravelCrisp->websitePeople->findByEmail('abc@example.com');

// If you prefer the laravel facade approach you can just do this
\Ziming\LaravelCrisp\Facades\LaravelCrisp::websitePeople()
    ->findByEmail('abc@example.com');

// If for some reason you want to use a different website_id,
// the official Crisp client is always available too
$laravelCrisp->officialClient->websitePeople->findByEmail(
    config('crisp.website_id'), 
    'abc@example.com'
);

The 2nd main difference are extra methods that I think are useful but are not in Crisp official SDK when I 1st added them.

// Gives you the Crisp Profile Link in Crisp. You can put it in your laravel admin to easier go to the customer profile in Crisp for example.
\Ziming\LaravelCrisp\Resources\WebsitePeople::getProfileLink('people-id');

// Gives you the conversation link in Crisp. You can put it in your laravel admin to easier go to the customer chat in Crisp for example.
\Ziming\LaravelCrisp\Resources\WebsiteConversations::getConversationLink('session-id');

// Get the first people id that matches the search text if 1 or more results are returned
$laravelCrisp = new Ziming\LaravelCrisp();
$laravelCrisp->websitePeople->getFirstPeopleIdBySearchText('Some Phone Number as Crisp does not have an exact filter by phone feature yet (but coming soon)');

// Get you the last message of a conversation to show in admin for example
$laravelCrisp->websiteConversations->getOneLastMessage('session-id');

// Gives you a nice DTO object for a crisp conversation. Which give really nice hints to your IDEs
$crispConversation = $laravelCrisp->websiteConversations->getOneCrispConversation('session-id');

// Because it is a DTO object, you can access all the various properties
// of the object with IDE hints!
$crispConversation->is_verified;

The 3rd main difference is a few methods' signatures are changed to be more user-friendly compared to

// The official Crisp PHP sdk takes in a params array, mine takes in the 2 required arguments directly
$laravelCrisp->websiteConversations->create('website name', 'website.domain');

// The official Crisp PHP sdk takes in a params array, where the date key need to be in ISO 8601 string format,
// Mine takes in a Carbon instance directly and do the conversion for you. You can also pass in a ISO 8601 string for the $date
// argument if you prefer. You can use this to send a reminder to your customer via Crisp Chat for example
$laravelCrisp->websiteConversations->scheduleReminder($sessionId, now()->addDay(), 'Note');

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

ziming / laravel-crisp

Maintainers

Details