crispchat/php-crisp-api

Crisp API PHP Wrapper

Crisp API PHP

, _(*1)

The Crisp API PHP wrapper. Authenticate, send messages, fetch conversations, access your agent accounts from your PHP code., _(*2)

Copyright 2023 Crisp IM SAS. See LICENSE for copying information., _(*3)

• 📝 Implements: REST API Reference (V1) at revision: 12/31/2017
• 😘 Maintainer: @baptistejamin

Installation with composer

composer require crispchat/php-crisp-api, _(*4)

Authentication

To authenticate against the API, obtain your authentication token keypair by following the REST API Authentication guide. You'll get a token keypair made of 2 values., _(*5)

Keep your token keypair values private, and store them safely for long-term use., _(*6)

Then, add authentication parameters to your client instance right after you create it:, _(*7)

require __DIR__ . '/vendor/autoload.php';
$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.

API Overview

You may follow the REST API Quickstart guide, which will get you running with the REST API in minutes., _(*8)

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

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

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

Available resources & methods

All the available Crisp API resources are fully implemented. Programmatic methods names are named after their label name in the REST API Reference., _(*9)

All methods that you will most likely need when building a Crisp integration are prefixed with a star symbol (⭐)., _(*10)

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

⚠️ Note that, depending on your authentication token tier, which is either user or plugin, you may not be allowed to use all methods from the library. When in doubt, refer to the library method descriptions below. Most likely, you are using a plugin token., _(*12)

Website

• Website Conversations, _(*13)

  • ⭐ List Conversations [user, plugin]: Reference
  • CrispClient->websiteConversations->getList(websiteId, pageNumber)

  • See Example
    , _(*14)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $pageNumber = 1;
    
    CrispClient->websiteConversations->getList(websiteId, pageNumber);
    

    , _(*15)

  • ⭐ Create a Conversation [user, plugin]: Reference, _(*16)

  • CrispClient->websiteConversations->create(websiteId)

  • See Example
    , _(*17)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    
    CrispClient->websiteConversations->create(websiteId);
    

    , _(*18)

  • Initiate a Conversation [user, plugin]: Reference, _(*19)

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

  • See Example
    , _(*20)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
    
    CrispClient->websiteConversations->initiateOne(websiteId, sessionId);
    

    , _(*21)

  • Find Conversations With Search [user, plugin]: Reference, _(*22)

  • CrispClient->websiteConversations->findWithSearch(websiteId, pageNumber, searchQuery, searchType, searchOperator, includeEmpty, filterUnread, filterResolved, filterNotResolved, filterMention, filterAssigned, filterUnassigned, filterDateStart, filterDateEnd, orderDateCreated, orderDateUpdated)

  • See Example
    , _(*23)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $pageNumber = 1;
    
    CrispClient->websiteConversations->getList(websiteId, pageNumber);
    

    , _(*24)

  • ⭐ Get A Conversation [user, plugin]: Reference, _(*25)
  • CrispClient->websiteConversations->getOne(websiteId, sessionId)

  • See Example
    , _(*26)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
    
    CrispClient->websiteConversations->getOne(websiteId, sessionId);
    

    , _(*27)

  • ⭐ Send a Message in Conversation [user, plugin]: Reference, _(*28)

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

  • See Example
    , _(*29)

    $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);
    

    , _(*30)

  • ⭐ Get Conversation Metas [user, plugin]: Reference, _(*31)

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

  • See Example
    , _(*32)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
    
    CrispClient->websiteConversations->getMeta(websiteId, sessionId);
    

    , _(*33)

  • ⭐ Update Conversation Metas [user, plugin]: Reference, _(*34)

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

  • See Example
    , _(*35)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
    
    $params = [
    "nickname" => "John Doe",
    "email" => "john.doe@acme-inc.com",
    "segments" => [
      "happy",
      "customer",
      "love"
    ],
    "data" => [
      "type" => "customer",
      "signup" => "finished"
    ]
    ];
    
    CrispClient->websiteConversations->updateMeta(websiteId, sessionId, params);
    

    , _(*36)

  • ⭐ Get Messages in Conversation [user, plugin]: Reference, _(*37)

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

  • See Example
    , _(*38)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
    $timestampBefore = 1641206011000;
    
    CrispClient->websiteConversations->getMessages(websiteId, sessionId, timestampBefore);
    

    , _(*39)

  • Get Conversation Original Message [user, plugin]: Reference, _(*40)
  • CrispClient->websiteConversations->getOriginalMessage(websiteId, sessionId, originalId)

  • See Example
    , _(*41)

    $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);
    

    , _(*42)

  • ⭐ Change Conversation State [user, plugin]: Reference, _(*43)

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

  • See Example
    , _(*44)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
    
    $state = true;
    
    CrispClient->websiteConversations->setState(websiteId, sessionId, state);
    

    , _(*45)

  • Get Conversation Routing [user, plugin]: Reference, _(*46)

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

  • See Example
    , _(*47)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
    
    CrispClient->websiteConversations->getRouting(websiteId, sessionId);
    

    , _(*48)

  • Assign Conversation Routing [user, plugin]: Reference, _(*49)

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

  • See Example
    , _(*50)

    $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);
    

    , _(*51)

  • Block Conversation: [user, plugin]: Reference, _(*52)

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

  • See Example
    , _(*53)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
    
    $blocked = true;
    
    CrispClient->websiteConversations->setBlock(websiteId, sessionId, blocked);
    

    , _(*54)

  • Delete Conversation: [user, plugin]: Reference, _(*55)
  • CrispClient->websiteConversations->deleteOne(websiteId, sessionId)

  • See Example
    , _(*56)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $sessionId = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
    
    CrispClient->websiteConversations->deleteOne(websiteId, sessionId);
    

    , _(*57)

  • Acknowledge Messages as Read: [user, plugin]: Reference, _(*58)

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

  • See Example
    , _(*59)

    $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);
    

    , _(*60)

  • Schedule a Reminder in a Conversation: [user, plugin]: Reference, _(*61)

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

  • See Example
    , _(*62)

    $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);
    

    , _(*63)

• Website People (these are your end-users), _(*64)

  • Find By Email [user, plugin]: Reference
  • CrispClient->websitePeople->findByEmail(websiteId, email)

  • See Example
    , _(*65)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    
    CrispClient->websitePeople->findByEmail(websiteId, email);
    

    , _(*66)

  • Find With Search Text (Name, Email, Segments) [user, plugin]: Reference, _(*67)

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

  • See Example
    , _(*68)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    
    CrispClient->websitePeople->findWithSearchText(websiteId, searchText);
    

    , _(*69)

  • Create A New Profile [user, plugin]: Reference, _(*70)
  • CrispClient->websitePeople->createNewPeopleProfile(websiteId, params)

  • See Example
    , _(*71)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    
    $params = [
    "email" => "valerian@crisp.chat",
    "person" => [
      "nickname" => "Valerian Saliou"
    ]
    ];
    
    CrispClient->websitePeople->createNewPeopleProfile(websiteId, params);
    

    , _(*72)

  • ⭐ Check If Exists [user, plugin]: Reference, _(*73)

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

  • See Example
    , _(*74)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
    
    CrispClient->websitePeople->checkPeopleProfileExists(websiteId, peopleId);
    

    , _(*75)

  • ⭐ Get People Profile [user, plugin]: Reference, _(*76)

  • CrispClient->websitePeople->getPeopleProfile(websiteId, peopleId)

  • See Example
    , _(*77)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    
    CrispClient->websitePeople->findByEmail(websiteId, email);
    

    , _(*78)

  • ⭐ List People Profiles [user, plugin]: Reference, _(*79)

  • CrispClient->websitePeople->listPeopleProfiles(websiteId, pageNumber)

  • See Example
    , _(*80)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    
    CrispClient->websitePeople->findWithSearchText(websiteId, searchText);
    

    , _(*81)

  • ⭐ Remove A Profile [user, plugin]: Reference, _(*82)

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

  • See Example
    , _(*83)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
    
    CrispClient->websitePeople->removePeopleProfile(websiteId, peopleId);
    

    , _(*84)

  • ⭐ Save A Profile [user, plugin]: Reference, _(*85)
  • CrispClient->websitePeople->savePeopleProfile(websiteId, peopleId, params)

  • See Example
    , _(*86)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
    
    $params = [
    "email" => "valerian@crisp.chat",
    "person" => [
      "nickname" => "Valerian Saliou"
    ]
    ];
    
    CrispClient->websitePeople->savePeopleProfile(websiteId, peopleId, params);
    

    , _(*87)

  • ⭐ Update A Profile [user, plugin]: Reference, _(*88)

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

  • See Example
    , _(*89)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
    
    $params = [
    "email" => "valerian@crisp.chat",
    "person" => [
      "nickname" => "Valerian Saliou"
    ]
    ];
    
    CrispClient->websitePeople->updatePeopleProfile(websiteId, peopleId, params);
    

    , _(*90)

  • List Conversations [user, plugin] Reference, _(*91)

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

  • See Example
    , _(*92)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
    $pageNumber = 1;
    
    CrispClient->websitePeople->listPeopleConversations(websiteId, peopleId, pageNumber);
    

    , _(*93)

  • List Segments [user, plugin]: Reference, _(*94)

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

  • See Example
    , _(*95)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
    $pageNumber = 1;
    
    CrispClient->websitePeople->listPeopleSegments(websiteId, peopleId, pageNumber);
    

    , _(*96)

  • List Events [user, plugin]: Reference, _(*97)

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

  • See Example
    , _(*98)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
    $pageNumber = 1;
    
    CrispClient->websitePeople->listPeopleEvent(websiteId, peopleId, pageNumber);
    

    , _(*99)

  • Add Event [user, plugin]: Reference, _(*100)
  • CrispClient->websitePeople->addPeopleEvent(websiteId, peopleId, event)

  • See Example
    , _(*101)

    $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);
    

    , _(*102)

  • Get Data [user, plugin]: Reference, _(*103)

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

  • See Example
    , _(*104)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
    
    CrispClient->websitePeople->getPeopleData(websiteId, peopleId);
    

    , _(*105)

  • Save Data [user, plugin]: Reference, _(*106)

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

  • See Example
    , _(*107)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
    
    $params = [
    "data" => [
      "type" => "customer",
      "signup" => "finished"
    ]
    ];
    
    CrispClient->websitePeople->savePeopleData(websiteId, peopleId, params);
    

    , _(*108)

  • Update Data [user, plugin]: Reference, _(*109)

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

  • See Example
    , _(*110)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
    
    $params = [
    "data" => [
      "signup" => "finished"
    ]
    ];
    
    CrispClient->websitePeople->updatePeopleData(websiteId, peopleId, params);
    

    , _(*111)

  • Get Subscription Status [user, plugin]: Reference, _(*112)

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

  • See Example
    , _(*113)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
    
    CrispClient->websitePeople->getPeopleSubscriptionStatus(websiteId, peopleId);
    

    , _(*114)

  • Update Subscription Status [user, plugin]: Reference, _(*115)
  • CrispClient->websitePeople->updatePeopleSubscriptionStatus(websiteId, peopleId, params)

  • See Example
    , _(*116)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
    
    $params = [
    "email" => true
    ];
    
    CrispClient->websitePeople->updatePeopleSubscriptionStatus(websiteId, peopleId, params);
    

    , _(*117)

👉 Notice: The peopleID argument can be an email or the peopleID., _(*118)

• Website Base, _(*119)

  • Create A Website [user, plugin]: Reference
  • CrispClient->website->create(params)

  • See Example
    , _(*120)

    CrispClient->website->create(params);
    

    , _(*121)

  • Delete A Website [user]: Reference, _(*122)

  • CrispClient->website->delete(websiteId)

  • See Example
    , _(*123)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    
    CrispClient->website->delete(websiteId);
    

    , _(*124)

• Website Settings, _(*125)

  • Get Website Settings [user, plugin]: Reference
  • CrispClient->websiteSettings->get(websiteId)

  • See Example
    , _(*126)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    
    CrispClient->websiteSettings->get(websiteId);
    

    , _(*127)

  • Update Website Settings [user, plugin]Reference:, _(*128)

  • CrispClient->websiteSettings->get(params)

• Website Verify, _(*129)

  • Get Verify Settings [user, plugin]: Reference
  • CrispClient->websiteVerify->getSettings(websiteId)

  • See Example
    , _(*130)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    
    CrispClient->websiteVerify->getSettings(websiteId);
    

    , _(*131)

  • Update Verify Settings [user, plugin]: Reference, _(*132)

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

  • See Example
    , _(*133)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    
    $params = [
    "enabled" => true
    ];
    
    CrispClient->websiteVerify->updateSettings(websiteId, params);
    

    , _(*134)

  • Get Verify Key [user, plugin]: Reference, _(*135)
  • CrispClient->websiteVerify->getKey(websiteId)

  • See Example
    , _(*136)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    
    CrispClient->websiteVerify->getKey(websiteId);
    

    , _(*137)

  • Roll Key [user, plugin]: Reference, _(*138)

  • CrispClient->websiteVerify->rollKey(websiteId)

  • See Example
    , _(*139)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    
    CrispClient->websiteVerify->rollKey(websiteId);
    

    , _(*140)

• Website Operators, _(*141)

  • Get All Operators [user, plugin]: Reference
  • CrispClient->websiteOperators->getList(websiteId)

  • See Example
    , _(*142)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    
    CrispClient->websiteOperators->getList(websiteId);
    

    , _(*143)

  • Get One Operators [user, plugin]: Reference, _(*144)

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

  • See Example
    , _(*145)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $operatorId = "d14ce289-f759-43c8-8854-00c57fb7e5d5";
    
    CrispClient->websiteOperators->getOne(websiteId, operatorId);
    

    , _(*146)

  • Delete One Operators [user, plugin]: Reference, _(*147)

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

  • See Example
    , _(*148)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $operatorId = "d14ce289-f759-43c8-8854-00c57fb7e5d5";
    
    CrispClient->websiteOperators->deleteOne(websiteId, operatorId);
    

    , _(*149)

  • Update An Operator [user, plugin]: Reference, _(*150)
  • CrispClient->websiteOperators->updateOne(websiteId, operatorId, parameters)

  • See Example
    , _(*151)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $operatorId = "d14ce289-f759-43c8-8854-00c57fb7e5d5";
    
    $parameters = [
    "role" => "owner",
    "title" => "CTO"
    ];
    
    CrispClient->websiteOperators->updateOne(websiteId, operatorId, parameters);
    

    , _(*152)

• Website Visitors, _(*153)

  • List Visitors [user, plugin]: Reference
  • CrispClient->websiteVisitors->listVisitors(websiteId, pageNumber)

  • See Example
    , _(*154)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $pageNumber = 1;
    
    CrispClient->websiteVisitors->listVisitors(websiteId, pageNumber);
    

    , _(*155)

• Website Availability, _(*156)

  • Get Availability Status [user, plugin]: Reference
  • CrispClient->websiteAvailability->getAvailabilityStatus(websiteId)

  • See Example
    , _(*157)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    
    CrispClient->websiteAvailability->getAvailabilityStatus(websiteId);
    

    , _(*158)

  • List Operator Availabilities [user, plugin]: Reference, _(*159)

  • CrispClient->websiteAvailability->listOperatorAvailabilities(websiteId)

  • See Example
    , _(*160)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    
    CrispClient->websiteAvailability->listOperatorAvailabilities(websiteId);
    

    , _(*161)

Plugins

• Plugin Subscriptions, _(*162)

  • List All Active Subsciptions [user]: Reference
  • CrispClient->pluginSubscriptions->listAllActiveSubscriptions()

  • See Example
    , _(*163)

    CrispClient->pluginSubscriptions->listAllActiveSubscriptions();
    

    , _(*164)

  • Get All Subscriptions For Website [user]: Reference, _(*165)
  • CrispClient->pluginSubscriptions->listSubscriptionsForWebsite(websiteId)

  • See Example
    , _(*166)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    
    CrispClient->pluginSubscriptions->listSubscriptionsForWebsite(websiteId);
    

    , _(*167)

  • Get Subscription Details [user, plugin]: Reference, _(*168)

  • CrispClient->pluginSubscriptions->getSubscriptionDetails(websiteId)

  • See Example
    , _(*169)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $pluginId = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
    
    CrispClient->pluginSubscriptions->getSubscriptionDetails(websiteId, pluginId);
    

    , _(*170)

  • Subscribe Website To Plugin [user]: Reference, _(*171)

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

  • See Example
    , _(*172)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $pluginId = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
    
    $pluginId = "98454664-9f7d-4d95-a9ce-f37356f5e65a";
    
    CrispClient->pluginSubscriptions->subscribeWebsiteToPlugin(websiteId, pluginId);
    

    , _(*173)

  • Unsubscribe Plugin From Website [user]: Reference, _(*174)

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

  • See Example
    , _(*175)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $pluginId = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
    
    CrispClient->pluginSubscriptions->unsubscribePluginFromWebsite(websiteId, pluginId);
    

    , _(*176)

  • Get Subscription Settings [user, plugin]: Reference, _(*177)

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

  • See Example
    , _(*178)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $pluginId = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
    
    CrispClient->pluginSubscriptions->getSubscriptionSettings(websiteId, pluginId);
    

    , _(*179)

  • Save Subscription Settings [user, plugin]: Reference, _(*180)
  • CrispClient->pluginSubscriptions->saveSubscriptionSettings(websiteId, pluginId, settings)

  • See Example
    , _(*181)

    $websiteId = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
    $pluginId = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
    
    $settings = [
    "chatbox" => [
      "25" => "#bbbbbb"
    ]
    ];
    
    CrispClient->pluginSubscriptions->saveSubscriptionSettings(websiteId, pluginId, settings);
    

    , _(*182)