README

使用 composer 安装

composer require crispchat/php-crisp-api

认证

为了对 API 进行认证，使用 Crisp token 生成工具 生成一次性的会话标识符和会话密钥。您将获得一个包含两个值的令牌密钥对。

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

然后，在创建客户端实例后立即添加认证参数

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.

🔴 重要：请确保一次性生成令牌，并在所有后续 API 请求中使用相同的令牌密钥。不要生成过多令牌，因为为了为新令牌腾出空间，我们可能会使旧令牌失效。

API 概述

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

$CrispClient->authenticate(identifier, key);

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

可用资源和方法

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

网站

• 网站对话

  • 获取对话列表: CrispClient->websiteConversations->getList(websiteId, page)
  • 获取一个对话: CrispClient->websiteConversations->getOne(websiteId, sessionId)
  • 获取对话元数据: CrispClient->websiteConversations->getMeta(websiteId, sessionId)
  • 更新对话元数据:CrispClient->websiteConversations->updateMeta(websiteId, sessionId, params)
  • 获取对话中的消息: CrispClient->websiteConversations->getMessages(websiteId, sessionId, query)
  • 创建对话: CrispClient->websiteConversations->create(websiteId)
  • 发起对话: CrispClient->websiteConversations->initiateOne(websiteId, sessionId)
  • 发送消息: CrispClient->websiteConversations->sendMessage(websiteId, sessionId, message)
  • 设置对话状态：CrispClient->websiteConversations->setState(websiteId, sessionId, state)
  • 阻止对话：CrispClient->websiteConversations->setBlock(websiteId, sessionId, blocked)
  • 删除对话：CrispClient->websiteConversations->deleteOne(websiteId, sessionId)
  • 确认消息：CrispClient->acknowledgeMessages(websiteId, sessionId, fingerprints)

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

PeopleID 参数可以是 电子邮件 或 PeopleID。

• 按电子邮件查找: CrispClient->websitePeople->findByEmail(websiteId, email)

• 按段查找: CrispClient->websitePeople->findBySegments(websiteId, segments)

• 创建新个人资料: CrispClient->websitePeople->createNewPeopleProfile(websiteId, params)

• 检查是否存在: CrispClient->websitePeople->checkPeopleProfileExists(websiteId, peopleId)

• 获取个人资料: CrispClient->websitePeople->getPeopleProfile(websiteId, peopleId)

• 列出个人资料: CrispClient->websitePeople->listPeopleProfiles(websiteId, peopleId, page)

• 删除个人资料: CrispClient->websitePeople->removePeopleProfile(websiteId, peopleId)

• 保存个人资料: CrispClient->websitePeople->savePeopleProfile(websiteId, peopleId, params)

• 更新个人资料: CrispClient->websitePeople->updatePeopleProfile(websiteId, peopleId, params)

• 列出对话 CrispClient->websitePeople->listPeopleConversations(websiteId, peopleId, page)

• 列出段: CrispClient->websitePeople->listPeopleSegments(websiteId, peopleId, page)

• 列出事件: CrispClient->websitePeople->listPeopleEvent(websiteId, peopleId, page)

• 添加事件: CrispClient->websitePeople->addPeopleEvent(websiteId, peopleId, event)

• 获取数据: CrispClient->websitePeople->getPeopleData(websiteId, peopleId)

• 更新数据: CrispClient->websitePeople->updatePeopleData(websiteId, peopleId, params)

• 网站基础

  • 创建网站: CrispClient->website->create(params)
  • 创建用户账户: CrispClient->website->delete(websiteId)

• 网站设置

  • 获取网站设置: CrispClient->websiteSettings->get(websiteId)
  • 更新网站设置: CrispClient->websiteSettings->get(params)

• 网站验证

  • 获取验证设置: CrispClient->websiteVerify->getSettings(websiteId)
  • 更新验证设置: CrispClient->websiteVerify->updateSettings(websiteId, params)
  • 获取验证密钥: CrispClient->websiteVerify->getKey(websiteId)
  • 滚动密钥: CrispClient->websiteVerify->rollKey(websiteId)

• 网站操作员

  • 获取所有操作员: CrispClient->websiteOperators->getList(websiteId)
  • 获取单个操作员: CrispClient->websiteOperators->getOne(websiteId, operatorId)
  • 删除单个操作员: CrispClient->websiteOperators->deleteOne(websiteId, operatorId)
  • 创建操作员: CrispClient->websiteOperators->createOne(websiteId, parameters)
  • 更新操作员: CrispClient->websiteOperators->updateOne(websiteId, operatorId, parameters)

• 网站访客

  • 列出访客: CrispClient->websiteVisitors->listVisitors(websiteId, page)

插件

• 插件订阅
  • 列出所有活跃订阅: CrispClient->pluginSubscriptions->listAllActiveSubscriptions()
  • 获取网站的全部订阅: CrispClient->pluginSubscriptions->listSubscriptionsForWebsite(websiteId)
  • 获取订阅详情: CrispClient->pluginSubscriptions->getSubscriptionDetails(websiteId)
  • 将网站订阅到插件: CrispClient->pluginSubscriptions->subscribeWebsiteToPlugin(websiteId, pluginId)
  • 从网站取消插件订阅: CrispClient->pluginSubscriptions->unsubscribePluginFromWebsite(websiteId, pluginId)
  • 获取订阅设置: CrispClient->pluginSubscriptions->getSubscriptionSettings(websiteId, pluginId)
  • 保存订阅设置: CrispClient->pluginSubscriptions->saveSubscriptionSettings(websiteId, pluginId, settings)