PHP download

PHP code example of crispchat / php-crisp-api

1. Go to this page and download the library: Download crispchat/php-crisp-api library. Choose the download type require.

2. Extract the ZIP file and open the index.php.

3. Add this code to the index.php.

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

crispchat / php-crisp-api example snippets



$CrispClient = new \Crisp\CrispClient;

// Authenticate to API with your plugin token (identifier, key)
// eg. $CrispClient->authenticate("7c3ef21c-1e04-41ce-8c06-5605c346f73e", "cc29e1a5086e428fcc6a697d5837a66d82808e65c5cce006fbf2191ceea80a0a");
$CrispClient->setTier("plugin");
$CrispClient->authenticate(identifier, key);

// Now, you can use authenticated API sections.



$CrispClient = new \Crisp\CrispClient;

$CrispClient->setTier("plugin");
$CrispClient->authenticate(identifier, key);

$conversations = $CrispClient->websiteConversations->getList(websiteId, 1);
echo $conversations;


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $pageNumber = 1;

      CrispClient->websiteConversations->getList(websiteId, pageNumber);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

      CrispClient->websiteConversations->create(websiteId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";

      CrispClient->websiteConversations->initiateOne(websiteId, sessionId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $pageNumber = 1;

      CrispClient->websiteConversations->getList(websiteId, pageNumber);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";

      CrispClient->websiteConversations->getOne(websiteId, sessionId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";

      $message = [
        "type" => "text",
        "from" => "operator",
        "origin" => "chat",
        "content" => "Hey there! Need help?"
      ];

      CrispClient->websiteConversations->sendMessage(websiteId, sessionId, message);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";

      CrispClient->websiteConversations->getMeta(websiteId, sessionId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";

      $params = [
        "nickname" => "John Doe",
        "email" => "[email protected]",
        "segments" => [
          "happy",
          "customer",
          "love"
        ],
        "data" => [
          "type" => "customer",
          "signup" => "finished"
        ]
      ];

      CrispClient->websiteConversations->updateMeta(websiteId, sessionId, params);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      $timestampBefore = 1641206011000;

      CrispClient->websiteConversations->getMessages(websiteId, sessionId, timestampBefore);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      $originalId = "2325a3c0-9b47-4fc6-b00e-111b752e44cd";

      CrispClient->websiteConversations->getOriginalMessage(websiteId, sessionId, originalId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";

      $state = true;

      CrispClient->websiteConversations->setState(websiteId, sessionId, state);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";

      CrispClient->websiteConversations->getRouting(websiteId, sessionId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";

      $params = [
        "assigned" => [
          "user_id" => "a4c32c68-be91-4e29-8a05-976e93abbe3f"
        ]
      ];

      CrispClient->websiteConversations->assignRouting(websiteId, sessionId, params);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";

      $blocked = true;

      CrispClient->websiteConversations->setBlock(websiteId, sessionId, blocked);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";

      CrispClient->websiteConversations->deleteOne(websiteId, sessionId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      $fingerprint = 524653764345;

      $fingerprints = [
        "from" => "operator",
        "origin" => "urn:crisp.im:slack:0",
        "fingerprints" => [
          "5719231201"
        ]
      ];

      CrispClient->websiteConversations->acknowledgeMessages(websiteId, sessionId, fingerprints);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";

      $params = [
        "date" => "2018-05-29T09:00:00Z",
        "note" => "Call this customer."
      ];

      CrispClient->websiteConversations->scheduleReminder(websiteId, sessionId, params);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

      CrispClient->websitePeople->findByEmail(websiteId, email);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

      CrispClient->websitePeople->findWithSearchText(websiteId, searchText);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

      $params = [
        "email" => "[email protected]",
        "person" => [
          "nickname" => "Valerian Saliou"
        ]
      ];

      CrispClient->websitePeople->createNewPeopleProfile(websiteId, params);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";

      CrispClient->websitePeople->checkPeopleProfileExists(websiteId, peopleId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

      CrispClient->websitePeople->findByEmail(websiteId, email);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

      CrispClient->websitePeople->findWithSearchText(websiteId, searchText);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";

      CrispClient->websitePeople->removePeopleProfile(websiteId, peopleId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";

      $params = [
        "email" => "[email protected]",
        "person" => [
          "nickname" => "Valerian Saliou"
        ]
      ];

      CrispClient->websitePeople->savePeopleProfile(websiteId, peopleId, params);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";

      $params = [
        "email" => "[email protected]",
        "person" => [
          "nickname" => "Valerian Saliou"
        ]
      ];

      CrispClient->websitePeople->updatePeopleProfile(websiteId, peopleId, params);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
      $pageNumber = 1;

      CrispClient->websitePeople->listPeopleConversations(websiteId, peopleId, pageNumber);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
      $pageNumber = 1;

      CrispClient->websitePeople->listPeopleSegments(websiteId, peopleId, pageNumber);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
      $pageNumber = 1;

      CrispClient->websitePeople->listPeopleEvent(websiteId, peopleId, pageNumber);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";

      $event = [
        "text" => "Added item to basket",
        "data" => [
          "price" => 10.99,
          "currency" => "USD"
        ],
        "color" => "red"
      ];

      CrispClient->websitePeople->addPeopleEvent(websiteId, peopleId, event);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";

      CrispClient->websitePeople->getPeopleData(websiteId, peopleId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";

      $params = [
        "data" => [
          "type" => "customer",
          "signup" => "finished"
        ]
      ];

      CrispClient->websitePeople->savePeopleData(websiteId, peopleId, params);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";

      $params = [
        "data" => [
          "signup" => "finished"
        ]
      ];

      CrispClient->websitePeople->updatePeopleData(websiteId, peopleId, params);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";

      CrispClient->websitePeople->getPeopleSubscriptionStatus(websiteId, peopleId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";

      $params = [
        "email" => true
      ];

      CrispClient->websitePeople->updatePeopleSubscriptionStatus(websiteId, peopleId, params);


      CrispClient->website->create(params);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

      CrispClient->website->delete(websiteId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

      CrispClient->websiteSettings->get(websiteId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

      CrispClient->websiteVerify->getSettings(websiteId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

      $params = [
        "enabled" => true
      ];

      CrispClient->websiteVerify->updateSettings(websiteId, params);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

      CrispClient->websiteVerify->getKey(websiteId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

      CrispClient->websiteVerify->rollKey(websiteId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

      CrispClient->websiteOperators->getList(websiteId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $operatorId = "d14ce289-f759-43c8-8854-00c57fb7e5d5";

      CrispClient->websiteOperators->getOne(websiteId, operatorId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $operatorId = "d14ce289-f759-43c8-8854-00c57fb7e5d5";

      CrispClient->websiteOperators->deleteOne(websiteId, operatorId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $operatorId = "d14ce289-f759-43c8-8854-00c57fb7e5d5";

      $parameters = [
        "role" => "owner",
        "title" => "CTO"
      ];

      CrispClient->websiteOperators->updateOne(websiteId, operatorId, parameters);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $pageNumber = 1;

      CrispClient->websiteVisitors->listVisitors(websiteId, pageNumber);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

      CrispClient->websiteAvailability->getAvailabilityStatus(websiteId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

      CrispClient->websiteAvailability->listOperatorAvailabilities(websiteId);


      CrispClient->pluginSubscriptions->listAllActiveSubscriptions();


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

      CrispClient->pluginSubscriptions->listSubscriptionsForWebsite(websiteId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $pluginId = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";

      CrispClient->pluginSubscriptions->getSubscriptionDetails(websiteId, pluginId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $pluginId = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";

      $pluginId = "98454664-9f7d-4d95-a9ce-f37356f5e65a";

      CrispClient->pluginSubscriptions->subscribeWebsiteToPlugin(websiteId, pluginId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $pluginId = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";

      CrispClient->pluginSubscriptions->unsubscribePluginFromWebsite(websiteId, pluginId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $pluginId = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";

      CrispClient->pluginSubscriptions->getSubscriptionSettings(websiteId, pluginId);


      $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      $pluginId = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";

      $settings = [
        "chatbox" => [
          "25" => "#bbbbbb"
        ]
      ];

      CrispClient->pluginSubscriptions->saveSubscriptionSettings(websiteId, pluginId, settings);