Maxime Pauvert
MeProjects

//php-crisp-apibymaximepvrt

php-crisp-api

:elephant: Crisp API PHP Wrapper

0
0
0
PHP
View on GitHubWebsite

Crisp API PHP

Installation with composer

composer require crispchat/php-crisp-api

Authentication

To authenticate against the API, generate your session identifier and session key once using the Crisp token generation utility. You’ll get a token keypair made of 2 values.

undefinedKeep your token keypair values private, and store them safely for long-term use.undefined

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.

undefined🔴 Important: Make sure to generate your token once, and use the same token keys in all your subsequent requests to the API. Do not generate too many tokens, as we may invalidate your older tokens to make room for newer tokens.undefined

API Overview

require __DIR__ . '/vendor/autoload.php';
$CrispClient = new Crisp();

$CrispClient->authenticate(identifier, key);

$profile = $CrispClient->userProfile->get();
$firstName = $profile["first_name"];
echo "Hello $firstName";

Available resources & methods

Where you see params it is a plain Array object, e.g. [email => 'foo@example.com' ]

Website

  • undefinedWebsite Conversationsundefined

    • undefinedGet Conversation List: CrispClient->websiteConversations->getList(websiteId, page)
    • undefinedGet A Conversation: CrispClient->websiteConversations->getOne(websiteId, sessionId)
    • undefinedGet Conversation Metadata: CrispClient->websiteConversations->getMeta(websiteId, sessionId)
    • undefinedUpdate Conversation Metadata:CrispClient->websiteConversations->updateMeta(websiteId, sessionId, params)
    • undefinedGet a Messages in a Conversation: CrispClient->websiteConversations->getMessages(websiteId, sessionId, query)
    • undefinedCreate a Conversation: CrispClient->websiteConversations->create(websiteId)
    • undefinedInitiate a Conversation: CrispClient->websiteConversations->initiateOne(websiteId, sessionId)
    • undefinedSend a Conversation: CrispClient->websiteConversations->sendMessage(websiteId, sessionId, message)
    • undefinedSet Conversation State:: CrispClient->websiteConversations->setState(websiteId, sessionId, state)
    • undefinedGet Conversation Routing: CrispClient->websiteConversations->getRouting(websiteId, sessionId)
    • undefinedAssign Conversation Routing:CrispClient->websiteConversations->assignRouting(websiteId, sessionId, params)
    • undefinedBlock Conversation:: CrispClient->websiteConversations->setBlock(websiteId, sessionId, blocked)
    • undefinedDelete Conversation::CrispClient->websiteConversations->deleteOne(websiteId, sessionId)
    • undefinedAcknowledge Messages:: CrispClient->acknowledgeMessages(websiteId, sessionId, fingerprints)
    • undefinedSchedule a Reminder in a Conversation:: CrispClient->scheduleReminder(websiteId, sessionId, params)

  • undefinedWebsite People (These are your End Users)

The PeopleID argument can be an email or the PeopleID.

  • undefinedFind By Email: CrispClient->websitePeople->findByEmail(websiteId, email)

  • undefinedFind With Search Text (Name, Email, Segments): CrispClient->websitePeople->findWithSearchText(websiteId, searchText)

  • undefinedCreate A New Profile: CrispClient->websitePeople->createNewPeopleProfile(websiteId, params)

  • undefinedCheck If Exists: CrispClient->websitePeople->checkPeopleProfileExists(websiteId, peopleId)

  • undefinedGet People Profile: CrispClient->websitePeople->getPeopleProfile(websiteId, peopleId)

  • undefinedList People Profiles: CrispClient->websitePeople->listPeopleProfiles(websiteId, peopleId, page)

  • undefinedRemove A Profile: CrispClient->websitePeople->removePeopleProfile(websiteId, peopleId)

  • undefinedSave A Profile: CrispClient->websitePeople->savePeopleProfile(websiteId, peopleId, params)

  • undefinedUpdate A Profile: CrispClient->websitePeople->updatePeopleProfile(websiteId, peopleId, params)

  • undefinedList Conversations CrispClient->websitePeople->listPeopleConversations(websiteId, peopleId, page)

  • undefinedList Segments: CrispClient->websitePeople->listPeopleSegments(websiteId, peopleId, page)

  • undefinedList Events: CrispClient->websitePeople->listPeopleEvent(websiteId, peopleId, page)

  • undefinedAdd Event: CrispClient->websitePeople->addPeopleEvent(websiteId, peopleId, event)

  • undefinedGet Data: CrispClient->websitePeople->getPeopleData(websiteId, peopleId)

  • undefinedUpdate Data: CrispClient->websitePeople->updatePeopleData(websiteId, peopleId, params)

  • undefinedWebsite Baseundefined

    • undefinedCreate A Website: CrispClient->website->create(params)
    • undefinedCreate User Account: CrispClient->website->delete(websiteId)

  • undefinedWebsite Settingsundefined

    • undefinedGet Website Settings: CrispClient->websiteSettings->get(websiteId)
    • undefinedUpdate Website Settings: CrispClient->websiteSettings->get(params)

  • undefinedWebsite Verifyundefined

    • undefinedGet Verify Settings: CrispClient->websiteVerify->getSettings(websiteId)
    • undefinedUpdate Verify Settings: CrispClient->websiteVerify->updateSettings(websiteId, params)
    • undefinedGet Verify Key: CrispClient->websiteVerify->getKey(websiteId)
    • undefinedRoll Key: CrispClient->websiteVerify->rollKey(websiteId)

  • undefinedWebsite Operatorsundefined

    • undefinedGet All Operators: CrispClient->websiteOperators->getList(websiteId)
    • undefinedGet One Operators: CrispClient->websiteOperators->getOne(websiteId, operatorId)
    • undefinedDelete One Operators: CrispClient->websiteOperators->deleteOne(websiteId, operatorId)
    • undefinedUpdate An Operator: CrispClient->websiteOperators->updateOne(websiteId, operatorId, parameters)

  • undefinedWebsite Visitorsundefined

    • undefinedList Visitors: CrispClient->websiteVisitors->listVisitors(websiteId, page)

Plugins

  • undefinedPlugin Subscriptionsundefined
    • undefinedList All Active Subsciptions: CrispClient->pluginSubscriptions->listAllActiveSubscriptions()
    • undefinedGet All Subscriptions For Website: CrispClient->pluginSubscriptions->listSubscriptionsForWebsite(websiteId)
    • undefinedGet Subscription Details: CrispClient->pluginSubscriptions->getSubscriptionDetails(websiteId)
    • undefinedSubscribe Website To Plugin: CrispClient->pluginSubscriptions->subscribeWebsiteToPlugin(websiteId, pluginId)
    • undefinedUnsubscribe Plguin From Website: CrispClient->pluginSubscriptions->unsubscribePluginFromWebsite(websiteId, pluginId)
    • undefinedGet Subscription Settings: CrispClient->pluginSubscriptions->getSubscriptionSettings(websiteId, pluginId)
    • undefinedSave Subscription Settings: CrispClient->pluginSubscriptions->saveSubscriptionSettings(websiteId, pluginId, settings)
[beta]v0.14.0