composer require crispchat/php-crisp-api
To authenticate against the API, generate your session identifier and session key once using the following cURL request in your terminal (replace YOUR_ACCOUNT_EMAIL
and YOUR_ACCOUNT_PASSWORD
):
curl -H "Content-Type: application/json" -X POST -d '{"email":"YOUR_ACCOUNT_EMAIL","password":"YOUR_ACCOUNT_PASSWORD"}' https://api.crisp.chat/v1/user/session/login
If authentication succeeds, you will get a JSON response containing your authentication keys: identifier
and key
. Keep those 2 values private, and store them safely for long-term use.
Then, add authentication parameters to your client
instance right after you create it:
require __DIR__ . '/vendor/autoload.php';
$CrispClient = new Crisp();
// Authenticate to API (identifier, key)
// eg. $CrispClient->authenticate("7c3ef21c-1e04-41ce-8c06-5605c346f73e", "cc29e1a5086e428fcc6a697d5837a66d82808e65c5cce006fbf2191ceea80a0a");
$CrispClient->authenticate(identifier, key);
// Now, you can use authenticated API sections.
🔴 Important: Be sure to login once, and re-use the same authentication keys (same identifier
+ key
) in all your subsequent requests to the API. Do not generate new tokens from your code for every new request to the API (you will be heavily rate-limited; that will induce HTTP failures for some of your API calls).
require __DIR__ . '/vendor/autoload.php';
$CrispClient = new Crisp();
$CrispClient->authenticate(identifier, key);
$profile = $CrispClient->userProfile->get();
$firstName = $profile["first_name"];
echo "Hello $firstName";
Where you see params
it is a plain Array object, e.g. [email => '[email protected]' ]
-
Website Conversations
- Get Conversation List:
CrispClient->websiteConversations->getList(websiteId, page)
- Get A Conversation:
CrispClient->websiteConversations->getOne(websiteId, sessionId)
- Get Conversation Metadata:
CrispClient->websiteConversations->getMeta(websiteId, sessionId)
- Update Conversation Metadata:
CrispClient->websiteConversations->updateMeta(websiteId, sessionId, params)
- Get Conversation Messages:
CrispClient->websiteConversations->getMessages(websiteId, sessionId, query)
- Create a Conversation:
CrispClient->websiteConversations->create(websiteId)
- Initiate a Conversation:
CrispClient->websiteConversations->initiateOne(websiteId, sessionId)
- Send a Conversation:
CrispClient->websiteConversations->sendMessage(websiteId, sessionId, message)
- Set Conversation State::
CrispClient->websiteConversations->setState(websiteId, sessionId, state)
- Block Conversation::
CrispClient->websiteConversations->setBlock(websiteId, sessionId, blocked)
- Delete Conversation::
CrispClient->deleteOne(websiteId, sessionId)
- Acknowledge Messages::
CrispClient->acknowledgeMessages(websiteId, sessionId, fingerprints)
- Get Conversation List:
-
Website People (These are your End Users)
- Find By Email:
CrispClient->websitePeople->findByEmail(websiteId, email)
- Check By Segments:
CrispClient->websitePeople->findBySegments(websiteId, segments)
- Create A New Profile:
CrispClient->websitePeople->createNewPeopleProfile(websiteId, params)
- Check If Exists:
CrispClient->websitePeople->checkPeopleProfileExists(websiteId, peopleId)
- Get People Profile:
CrispClient->websitePeople->getPeopleProfile(websiteId, peopleId)
- List People Profiles:
CrispClient->websitePeople->listPeopleProfiles(websiteId, peopleId, page)
- Remove A Profile:
CrispClient->websitePeople->removePeopleProfile(websiteId, peopleId)
- Save A Profile:
CrispClient->websitePeople->savePeopleProfile(websiteId, peopleId, params)
- Update A Profile:
CrispClient->websitePeople->updatePeopleProfile(websiteId, peopleId, params)
- List Conversations
CrispClient->websitePeople->listPeopleConversations(websiteId, peopleId, page)
- List Segments:
CrispClient->websitePeople->listPeopleSegments(websiteId, peopleId, page)
- List Events:
CrispClient->websitePeople->listPeopleEvent(websiteId, peopleId, page)
- Get Data:
CrispClient->websitePeople->getPeopleData(websiteId, peopleId)
- Update Data:
CrispClient->websitePeople->updatePeopleData(websiteId, peopleId, params)
- Find By Email:
-
Website Base
- Create A Website:
CrispClient->website->create(params)
- Create User Account:
CrispClient->website->delete(websiteId)
- Create A Website:
-
Website Settings
- Get Website Settings:
CrispClient->websiteSettings->get(websiteId)
- Update Website Settings:
CrispClient->websiteSettings->get(params)
- Get Website Settings:
-
Website Operators
- Get All Operators:
CrispClient->websiteOperators->getList(websiteId)
- Get One Operators:
CrispClient->websiteOperators->getOne(websiteId, operatorId)
- Delete One Operators:
CrispClient->websiteOperators->deleteOne(websiteId, operatorId)
- Create An Operator:
CrispClient->websiteOperators->createOne(websiteId, parameters)
- Update An Operator:
CrispClient->websiteOperators->updateOne(websiteId, operatorId, parameters)
- Get All Operators:
- Plugin Subscriptions
- List All Active Subsciptions:
CrispClient->pluginSubscriptions->listAllActiveSubscriptions()
- Get All Subscriptions For Website:
CrispClient->pluginSubscriptions->listSubscriptionsForWebsite(websiteId)
- Get Subscription Details:
CrispClient->pluginSubscriptions->getSubscriptionDetails(websiteId)
- Subscribe Website To Plugin:
CrispClient->pluginSubscriptions->subscribeWebsiteToPlugin(websiteId, pluginId)
- Unsubscribe Plguin From Website:
CrispClient->pluginSubscriptions->unsubscribePluginFromWebsite(websiteId, pluginId)
- Get Subscription Settings:
CrispClient->pluginSubscriptions->getSubscriptionSettings(websiteId, pluginId)
- Save Subscription Settings:
CrispClient->pluginSubscriptions->saveSubscriptionSettings(websiteId, pluginId, settings)
- List All Active Subsciptions:
From the API side, Users are Crisp Users, not your end users
- User Account
- Get User Account:
CrispClient->userAccount->get()
- Create User Account:
CrispClient->userAccount->create(params)
- Get User Account:
- User Session
- Create A New Sessiont:
CrispClient->userSession->loginWithEmail(email, password)
- Recover the Password:
CrispClient->userSession->recoverPassword(email)
- Logout:
CrispClient->userSession->logout()
- Create A New Sessiont:
- User Notifications
- Get User Notifications:
CrispClient->userNotification->get()
- Update User Notifications:
CrispClient->userNotification->update(params)
- Get User Notifications:
- User Profile
- Get User Profile:
CrispClient->userProfile->get()
- Update User Profile:
CrispClient->userProfile->update(params)
- Get User Profile:
- User Websites
- Get:
CrispClient->userWebsites->get()
- Get: