与接触表7的最大集成

与接触表7的最大集成

简短描述

该插件通过聊天机器人API将联系表单7表单的成功请求发送到MAX messenger（platform-api.max.ru )。 它适用于在群聊中通知管理者或向用户发送私人消息。

该插件只有一种方式：关于新应用程序的传出通知。 传入消息和bot事件需要在MAX端进行单独的Webhook设置，并且不在此版本中处理。

要求

-WordPress5.8及以上
-PHP7.4及以上
-联系人表单7插件已安装并处于活动状态
-合作伙伴平台上的MAX chatbot和access_token令牌
-"Max For Contact Form7"产品的Active PluginHub许可证

API MAX文档：https://dev.max.ru/docs-api
方法的参考：https://dev.max.ru/docs

安装工程

1. 将max-cf7-integration文件夹复制到服务器上的wp-content/plugins/目录。
2. 在WordPress管理面板中，打开"插件"部分并激活"MAX For Contact Form7"。
3. 确保联系表格7处于活动状态。 如果不是，请从WordPress目录安装插件。
4. 转到联系人→MAX并按照以下说明操作。

设置位于何处

插件页面：联系人→MAX（联系表格7子菜单）。

页面上有两个选项卡:
—"设置"-许可证，机器人令牌，chat_id，一般消息参数;
-"说明"-管理面板内的简要参考。

设置单个表单：联系人→联系人表单→打开所需的表单→"最大通知"块。

"设置"链接也可在"插件"屏幕上的插件列表中找到。

第1部分。 PluginHub许可证

1. 打开联系人→最大→设置选项卡。
2. 在"PluginHub许可证"块中，输入您在网站上收到的许可证密钥pluginhub.pro 购买产品后。
3. 单击表单底部的"保存"。

许可证密钥仅在此插件页面上输入，而不是在一般的WordPress设置中输入。

保存后，状态显示在块标题下:
-"许可证处于活动状态—-您可以使用发送到MAX;
-错误消息-密钥不正确、已过期、已撤销、站点域不匹配或与许可证服务器没有连接。

当许可证未激活时，插件不会向MAX发送消息。 机器人令牌的验证也不可用。

如果购买条款提供，单个PluginHub密钥可用于同一站点上的多个PluginHub插件。

第2部分。 在MAX中准备聊天机器人

1. 在MAX平台上为合作伙伴连接组织（对于法人实体和独资经营者—俄罗斯联邦居民）。
2. 创建一个聊天机器人并等待审核。
3. 获取访问令牌："聊天机器人"→"集成"→"获取令牌"部分。 这是access_token值。
4. 将机器人添加到应该发送应用程序的群聊，或为私人消息准备user_id。
5. 找出聊天ID（chat_id）或用户（user_id）。 获取它的方法取决于MAX平台工具和API文档。

对安全很重要:
-在发出API请求时，只在授权标头中传递令牌，而不是在URL或网站的公共页面上传递令牌;
-不要将令牌发布在具有请求全文的开放存储库、屏幕截图或日志中。

第三部分。 全局插件设置

打开联系人→最大→"设置"。

"机器人令牌（access_token）"字段
从MAX平台插入令牌。 第一次保存后，该字段显示一个掩码：如果不需要更改令牌，请将其留空。 要替换它，请输入新令牌并保存设置。

"聊天ID"
字段是已添加机器人的群聊的数字标识符。 建议用于有关应用程序的团队通知。

"用户ID（可选）"
字段是最大用户ID。 如果未指定chat_id，则使用：消息将发送给此用户。

寻址优先级：如果指定了chat_id，则发送转到聊天;否则，使用user_id。 其中至少有一个必须填写。

"文本格式"
field-Markdown-使用星号和下划线格式化（默认情况下）;
-HTML标记标记;
-没有格式-纯文本。

"默认前缀"字段
如果没有为特定表单指定前缀，则每条消息开头的文本。 示例："来自网站的新应用程序。"

"通知聊天参与者"复选框
被启用，并且聊天参与者根据MAX规则接收新消息的通知。

"禁用链接预览"复选框
已启用，但消息中的链接不显示预览。

填写字段后，单击"保存"。

"验证令牌"按钮
向MAX API发送GET/me请求，并在按钮旁边显示结果。 验证需要一个有效的许可证. 如果已保存令牌，则即使输入字段为空，也会对保存的值执行验证。

第4部分。 设定每个联络表格7表格

1. 打开联系人→联系人表单。
2. 选择表单并打开它进行编辑。
3. 在表单编辑器下找到"Max中的通知"块。

块参数:

"将此表格的申请寄给MAX"
启用它，以便在网站上成功提交表单时，数据转到MAX。

"讯息文本"
一个CF7表单字段的名称-只有其值将包含在消息中。
或者，指定一个特殊值__all__（两侧有两个下划线），在这种情况下，带有签名的表单的所有字段都将包含在消息中。

"讯息前缀"
消息主体之前的文本。 如果留空，则使用插件设置中的全局前缀。

前缀中的替换（花括号中）:
-{form_title—-表单名称;
-{form_id}-WordPress表单的数字ID;
-{网站}-网站主页的地址;
-{字段名称}是CF7字段的值，例如{your-name}，{your-email}，{tel}。

"添加发送页面的URL"
提交表单的页面地址将添加到消息的末尾。

"添加网站地址"
网站主页的URL添加到消息的末尾。

4. 点击CF7表单上的"保存"。

第5部分。 如何在MAX中生成消息

消息部分的顺序:
1. 前缀（来自表单设置或全局）。
2. 空行。
3. 正文：一个字段或所有字段（__all__）。
4. 启用选项后，网站地址和发送页面的URL。

在__all__格式中，消息头包含方括号中的表单名称，后跟每个具有名称和值的字段。 服务字段（以下划线开头），reCAPTCHA和hCaptcha不包括在列表中。

根据MAX API，最大文本长度为4000个字符。 插件会截断过长到可接受大小的文本。

第6部分。 职位核实

1. 确保许可证处于活动状态（"PluginHub许可证"块）。
2. 保存令牌，chat_id或user_id，然后单击"验证令牌"。
3. 在metabox中启用发送到MAX的测试表单。
4. 使用此表单打开网站页面，并按照访问者的方式提交测试应用程序。
5. 检查最大聊天:一个新的消息应该出现.

即使MAX暂时不可用，网站上表单的成功提交也不会中断：访问者仍然会看到标准的CF7成功消息。 在MAX中发送错误不会阻止电子邮件和其他CF7操作，如果它们是单独配置的。

空气污染指数上限

-消息文本的长度最多为4000个字符;
-大约每秒30个请求platform-api.max.ru （api限制在重载下是可能的）;
—您需要目标聊天中的有效令牌和机器人权限才能工作。;
-插件使用发送消息POST/消息的方法，不处理传入事件。

故障排除问题

申请最多未收到

-检查设置选项卡上的许可证状态;
-点击"验证令牌"并修复错误，如果有一个。;
-确保指定了chat_id或user_id;
-机器人必须添加到群聊（对于chat_id）;
-在表单的metabox中启用发送到MAX。;
-网站上的表单发送时没有CF7错误（红色验证错误消息）;
-主机允许传出HTTPS请求到platform-api.max.ru 和pluginhub.pro ...

许可证未激活

-检查密钥的正确性，没有不必要的空格;
-地址栏中的站点域必须与链接到插件的域匹配license.pro;
—如果连接失败，请检查服务器对Internet和SSL的访问。

"验证令牌"返回错误

-令牌完整复制，开头和结尾没有空格;
-机器人尚未在MAX平台上删除或阻止;
-令牌尚未过期（如有必要，在平台上发行新令牌）。

消息到达，但没有必填字段

-"消息文本"字段包含__all__或CF7标记中字段的确切名称（您的-电子邮件，电话等）。);
-前缀替换中的字段名称与表单中的名称匹配。

未安装联系表格7

一个通知将出现在插件屏幕和管理面板与建议安装联系表格7。 没有它，集成就不起作用。

此外，对于开发人员

默认情况下，PluginHub产品ID在插件代码中设置。 它可以在wp-config中重新定义。php的:

定义（'MAX_CF7_PLUGINHUB_PLUGIN_ID'，'your-product-uuid'）;

设置访问权限的过滤器是max_cf7_capability（默认情况下，它与编辑CF7或manage_options表单的权限相匹配）。

产品ID过滤器：max_cf7_pluginhub_plugin_id。

删除插件

通过WordPress管理面板删除插件时（不仅仅是停用），文件卸载。php删除此产品的插件设置和许可证状态缓存。 如果站点上的共享pluginhub_license_key被其他PluginHub插件使用，则不会删除该站点上的共享pluginhub_license_key。

支援及连结

插件提示：https://pluginhub.pro
最大文件：https://dev.max.ru/docs
最大API参考：https://dev.max.ru/docs-api