README

Crisp API PHP 封装器。从您的 PHP 代码中进行身份验证、发送消息、获取对话、访问您的代理账户。

版权所有 2023 Crisp IM SAS。有关复制信息，请参阅 LICENSE。

• 📝 实现: REST API 参考（V1），修订日期：2017年12月31日
• 😘 维护者: @baptistejamin

使用 composer 安装

composer require crispchat/php-crisp-api

身份验证

要验证 API，请按照 REST API 身份验证 指南操作。您将获得一个由 2 个值组成的令牌密钥对。

请保留您的令牌密钥对值，并安全存储以供长期使用。

然后，在创建实例后立即向您的 client 实例添加身份验证参数

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 概述

您可以按照 REST API 快速入门 指南操作，这将在几分钟内使您运行 REST API。

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

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

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

可用资源和方法

所有可用的 Crisp API 资源都已完全实现。程序性方法名称与 REST API 参考 中的标签名称相同。

在构建 Crisp 集成时，您最可能需要的方法都以前置星号符号（⭐）为前缀。

在您看到 params 时，它是一个普通的数组对象，例如 [email => 'foo@example.com' ]

⚠️ 注意，根据您的身份验证令牌级别，是 user 还是 plugin，您可能无法使用库中的所有方法。如有疑问，请参阅下面的库方法描述。您很可能正在使用 plugin 令牌。

网站

• 网站对话

  • ⭐ 列出对话 [user, plugin]: 参考

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

    • 查看示例

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

  • ⭐ 创建对话 [user, plugin]: 参考

    • CrispClient->websiteConversations->create(websiteId)

    • 查看示例

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

  • 启动对话 [user, plugin]: 参考

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

    • 查看示例

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

  • 通过搜索查找对话 [user, plugin]: 参考

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

    • 查看示例

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

  • ⭐ 获取对话 [user, plugin]: 参考

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

    • 查看示例

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

  • ⭐ 在会话中发送消息 [用户, 插件]: 参考

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

    • 查看示例

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

  • ⭐ 获取会话元数据 [用户, 插件]: 参考

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

    • 查看示例

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

  • ⭐ 更新会话元数据 [用户, 插件]: 参考

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

    • 查看示例

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

  • ⭐ 获取会话中的消息 [用户, 插件]: 参考

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

    • 查看示例

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

  • 获取会话原始消息 [用户, 插件]: 参考

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

    • 查看示例

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

  • ⭐ 更改会话状态 [用户, 插件]: 参考

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

    • 查看示例

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

  • 获取会话路由 [用户, 插件]: 参考

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

    • 查看示例

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

  • 分配会话路由 [用户, 插件]: 参考

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

    • 查看示例

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

  • 阻止会话： [用户, 插件]: 参考

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

    • 查看示例

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

  • 删除会话： [用户, 插件]: 参考

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

    • 查看示例

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

  • 确认消息为已读： [用户, 插件]: 参考

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

    • 查看示例

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

  • 在会话中安排提醒： [用户, 插件]: 参考

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

    • 查看示例

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

• 网站人员 （这些是您的最终用户）

  • 按电子邮件查找 [用户, 插件]: 参考

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

    • 查看示例

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

  • 通过搜索文本（姓名，电子邮件，分段）查找 [用户, 插件]: 参考

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

    • 查看示例

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

  • 创建新配置文件 [用户, 插件]: 参考

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

    • 查看示例

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

  • ⭐ 检查是否存在 [用户, 插件]: 参考

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

    • 查看示例

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

  • ⭐ 获取人员配置文件 [用户, 插件]: 参考

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

    • 查看示例

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

  • ⭐ 列出人员配置文件 [用户, 插件]: 参考

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

    • 查看示例

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

  • ⭐ 删除个人资料 [user, plugin]: 参考

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

    • 查看示例

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

  • ⭐ 保存个人资料 [user, plugin]: 参考

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

    • 查看示例

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

  • ⭐ 更新个人资料 [user, plugin]: 参考

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

    • 查看示例

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

  • 列出对话 [user, plugin]: 参考

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

    • 查看示例

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

  • 列出人群细分 [user, plugin]: 参考

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

    • 查看示例

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

  • 列出事件 [user, plugin]: 参考

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

    • 查看示例

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

  • 添加事件 [user, plugin]: 参考

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

    • 查看示例

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

  • 获取数据 [user, plugin]: 参考

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

    • 查看示例

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

  • 保存数据 [user, plugin]: 参考

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

    • 查看示例

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

  • 更新数据 [user, plugin]: 参考

    • CrispClient->websitePeople->updatePeopleData(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);

  • 获取订阅状态 [user, plugin]: 参考

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

    • 查看示例

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

  • 更新订阅状态 [user, plugin]: 参考

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

    • 查看示例

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

👉 注意：参数 peopleID 可以是一个电子邮件地址或者 peopleID。

• 网站基础

  • 创建网站 [user, plugin]: 参考

    • CrispClient->website->create(params)

    • 查看示例

      CrispClient->website->create(params);

  • 删除网站 [user]: 参考

    • CrispClient->website->delete(websiteId)

    • 查看示例

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

• 网站设置

  • 获取网站设置 [user, plugin]: 参考

    • CrispClient->websiteSettings->get(websiteId)

    • 查看示例

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

  • 更新网站设置 [user, plugin]: 参考

    • CrispClient->websiteSettings->get(params)

• 网站验证

  • 获取验证设置 [user, plugin]: 参考

    • CrispClient->websiteVerify->getSettings(websiteId)

    • 查看示例

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

  • 更新验证设置 [user, plugin]: 参考

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

    • 查看示例

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

  • 获取验证密钥 [user, plugin]: 参考

    • ClientCrisp->websiteVerify->getKey(websiteId)

    • 查看示例

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

  • 滚动密钥 [用户, 插件]: 参考

    • ClientCrisp->websiteVerify->rollKey(websiteId)

    • 查看示例

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

• 网站运营商

  • 获取所有运营商 [用户, 插件]: 参考

    • ClientCrisp->websiteOperators->getList(websiteId)

    • 查看示例

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

  • 获取单个运营商 [用户, 插件]: 参考

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

    • 查看示例

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

  • 删除单个运营商 [用户, 插件]: 参考

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

    • 查看示例

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

  • 更新运营商 [用户, 插件]: 参考

    • ClientCrisp->websiteOperators->updateOne(websiteId, operatorId, parameters)

    • 查看示例

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

• 网站访客

  • 列出访客 [用户, 插件]: 参考

    • ClientCrisp->websiteVisitors->listVisitors(websiteId, pageNumber)

    • 查看示例

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

• 网站可用性

  • 获取可用性状态 [用户, 插件]: 参考

    • ClientCrisp->websiteAvailability->getAvailabilityStatus(websiteId)

    • 查看示例

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

  • 列出运营商可用性 [用户, 插件]: 参考

    • ClientCrisp->websiteAvailability->listOperatorAvailabilities(websiteId)

    • 查看示例

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

插件

• 插件订阅

  • 列出所有活动订阅 [用户]: 参考

    • ClientCrisp->pluginSubscriptions->listAllActiveSubscriptions()

    • 查看示例

      CrispClient->pluginSubscriptions->listAllActiveSubscriptions();

  • 获取网站所有订阅 [用户]: 参考

    • ClientCrisp->pluginSubscriptions->listSubscriptionsForWebsite(websiteId)

    • 查看示例

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

  • 获取订阅详情 [用户, 插件]: 参考

    • ClientCrisp->pluginSubscriptions->getSubscriptionDetails(websiteId)

    • 查看示例

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

  • 订阅网站插件 [用户]: 参考

    • ClientCrisp->pluginSubscriptions->subscribeWebsiteToPlugin(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);

  • 从网站取消插件订阅 [用户]: 参考

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

    • 查看示例

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

  • 获取订阅设置 [用户, 插件]: 参考

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

    • 查看示例

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

  • 保存订阅设置 [用户, 插件]: 参考

    • ClientCrisp->pluginSubscriptions->saveSubscriptionSettings(websiteId, pluginId, settings)

    • 查看示例

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