README

Carrot Quest API 的扩展原生 PHP 封装，无需任何要求。支持所有方法和响应类型。

## 安装

首选安装方式是通过 Composer。

php composer.phar require  veksa/carrot-api "~1.0"

运行以下命令：

"veksa/carrot-api": "~1.0"

或者将以下内容添加到你的 composer.json 文件中的 require 部分：

使用方法

API 封装

$carrot = new \Veksa\Carrot\Api('YOUR_APP_ID', 'YOUR_CARROT_API_TOKEN');

方法

getActiveUsers

获取当前在线且状态为 "在线" 的用户。

getCountLeads

获取用户（线索）的数量。如果已知关于线索的联系方式：姓名、电子邮件、电话、用户 ID，或者至少有一个对话。

getLeads

获取所有用户（线索）。如果已知关于线索的联系方式：姓名、电子邮件、电话、用户 ID，或者至少有一个对话。

filters array：过滤器数组，例如：https://carrotquest.io/developers/filters/。

prop string：排序属性。默认：$last_seen

order string：排序顺序。默认：desc

limit int：显示用户数限制。默认：20

offset int：起始位置。默认：0

getConversations

获取应用的所有对话。

id int：用户 ID。

limit int：显示对话数限制。默认：20

offset int：起始位置。默认：0

closed bool|null：true - 开放对话，false - 关闭对话，null - 所有对话

assigned int|null：分配给管理员对话的 ID，或 null

tags array：标签数组

getConversation

获取特定对话的信息。

id int：对话 ID。 必选项

getMessages

获取特定对话中的消息。

id int：对话 ID。 必选项

limit int：显示用户数限制。默认：20

offset int：起始位置。默认：0

sendConversationMessage

向特定对话发送消息。

id int：对话 ID。 必选项

message string：消息文本。 必选项

type string：消息类型。默认：note

botName string：机器人名称。默认：Bot

fromUser bool：true - 来自用户的消息

fromAdmin int：发送消息的管理员 ID 或默认_admin

randomId int：消息的随机 ID，用于控制投递。默认：0

autoAssign int：自动分配给管理员的 ID

autoAssignRandomId int：消息的随机 ID，用于控制分配投递。默认：0

readMessages

在对话中标记所有消息为已读（网站上的用户）。

id int：对话 ID。 必选项

setTyping

在对话中设置正在输入的消息。

id int：对话 ID。 必选项

message string：消息。

botName string：设置正在输入的机器人名称

fromUser bool：设置正在输入的用户

fromAdmin int：设置正在输入的管理员

assignConversation

分配由管理员定义的特定对话（或取消分配）。

id int：对话 ID。 必选项

adminId int|null：管理员 ID 或 null 以取消分配

fromAdminId int|null：分配的管理员 ID

botName string：分配的机器人名称。默认：Bot

randomId int：控制分配的数字。

addTag

向对话添加标签。

id int：对话 ID。 必选项

tag string：标签。

fromAdminId int|null：分配的管理员 ID

botName string：分配的机器人名称。默认：Bot

randomId int：控制分配的数字。

deleteTag

从对话中删除标签。

id int：对话 ID。 必选项

tag string：标签。

fromAdminId int|null：分配的管理员 ID

botName string：分配的机器人名称。默认：Bot

randomId int：控制分配的数字。

closeConversation

关闭对话。

id int：对话 ID。 必选项

fromAdminId int|null：分配的管理员 ID

botName string：分配的机器人名称。默认：Bot

randomId int：控制分配的数字。

getUser

通过ID获取用户。

id int：用户ID。 必选选项

isSystem bool：系统或本地ID。默认为系统

setProps

添加或更新用户属性。

id int：用户ID。 必选选项

props array：属性数组。 必选选项

isSystem bool：是否为系统ID？

deleteProps

删除用户属性。

id int：用户ID。 必选选项

props array：属性数组。 必选选项

isSystem bool：是否为系统ID？

setPresence

设置用户状态。

id int：用户ID。 必选选项

presence string：用户状态。 必选选项

sessionId string：会话ID 必选选项

sendUserMessage

向特定用户发送消息。

id int：用户ID。 必选选项

message string：消息文本。 必选项

type string：是便签还是消息。默认：popup_chat

startConversation

与用户开始对话。

id int：用户ID。 必选选项

message string：消息文本。 必选项

trackEvent

跟踪用户执行的事件。

id int：用户ID。 必选选项

eventName string：事件名称。 必选选项

additionalParams array：附加参数

getEvents

接收用户按时间顺序做出的事件。

id int：用户ID。 必选选项

eventName string：要筛选的事件名称。

limit int：显示用户数限制。默认：20

offset int：起始位置。默认：0

变更日志

请参阅变更日志以获取最近更改的更多信息。

测试

$ composer test

贡献

请参阅贡献指南以获取详细信息。

安全性

如果您发现任何安全相关的问题，请通过电子邮件admin@devblog.pro联系，而不是使用问题跟踪器。

鸣谢

• Alex Khijnij
• 所有贡献者

许可证

MIT许可证（MIT）。请参阅许可证文件以获取更多信息。