使用 CRM 集成向导集成 CRM

介绍

CX 可以与任何具有 REST API 的 CRM 集成，以便将电子邮件或电话号码与您的 CRM、帮助台或工单系统中的客户账户进行匹配。

当 3CX 接收到呼入电话时，为了将主叫号码与客户匹配，它会查询 CRM 系统以查找客户名称。如果找到，该联系人会被添加到 3CX 联系人中，主叫方名称会显示在网页客户端中，并且联系人条目包含一个用于打开 CRM 联系人的链接。

3CX 开箱即用地支持大量CRM。如果您的 CRM 不在列表中，您可以使用我们的 CRM 集成向导轻松创建模板以与您的 CRM 集成。您只需要基本的编码/网络技能以及您 CRM 的 REST API 文档。

本指南描述了如何安装和使用模板生成器工具，通过基于示例的 3CX CRM 模板，引导您完成为您的 CRM 创建新模板所需的步骤。

步骤 1 - 获取并测试 REST API URLs

Obtain & Test REST API URls - Contact Lookup

第一步是通过搜索 CRM / 帮助台 / 工单系统网站或联系供应商来获取必要的 URL 和身份验证方法。请确保您拥有所有必需的文档，最好在供应商处有支持联系人以便咨询问题。您将需要：

  • 查明您的 CRM 支持“基本认证 (Basic)”还是“OAuth2”身份验证。
  • 身份验证是通过用户名和密码还是 API 密钥
  • 以下操作的 Web 调用和响应：
  1. 通过电话号码查找联系人
  2. 通过电子邮件查找联系人
  3. 按任意字段搜索联系人（可选）
  4. 创建联系人（可选）
  5. 通话日志（可选）
  6. 聊天日志 （可选的）

使用 Postman 测试 API 调用！

通过测试节省时间这些 API 调用首先使用免费的Postman 工具Postman 工具允许您输入 URL 并实时查看响应结果。Postman 比 3CX 拥有更多的调试工具，因此最好在创建和上传集成之前确保您的 API 调用安全可靠。

Postman 提供了一些非常好的入门指南点击这里。

步骤 2 - 下载 CRM 集成向导

从客户门户下载并安装 3CX CRM 集成向导。它将引导您完成为 3CX 创建模板的步骤。要创建您的 CRM 模板：

  1. 登录客户门户并下载向导。
  2. 在 Windows 计算机上安装向导。
  3. 启动“3CX CRM 模板生成器”，单击“文件”>“新建”>“CRM 模板向导...”，然后单击“下一步”。

步骤 3 -配置身份验证

3CX CRM Integration Wizard - Configure Authentication

  1. 设置合适的“模板名称”。
  2. 根据您的 CRM 的 API 文档，将身份验证方法设置为：
  1. “无”
  2. “基本”并选择使用以下方式进行身份验证：
  1. “用户名和密码”
  2. “API 密钥”
  1. “OAuth2”并设置这些：
  1. “授权端点” URL，例如 https://api.example.com/oauth2/auth
  2. “令牌端点” URL，例如 https://api.example.com/oauth2/token
  3. “范围”-可选
  4. “附加查询字符串”-可选
  1. 单击“下一步”继续。

步骤 4 - 配置联系人查找

3CX CRM Integration Wizard - Configure Contact Search

现在，您需要指定需要在 CRM 系统中调用的 API 调用，以便识别客户。3CX 可以使用呼叫者的号码（用于电话、短信和 Whatsapp 消息）或电子邮件地址（用于实时聊天对话）来搜索联系人。

  1. “按号码查找 API URL (GET)” - 根据电话号码向 CRM 查询联系人的 URL。例如，对于 Freshdesk:
  1. https://domain.freshdesk.com/api/v2/contacts?phone=[Number]
  1. “通过邮箱地址查询 API URL (GET)” - 根据邮箱地址查询 CRM 系统的 URL。例如， Freshdesk:
  1. https://domain.freshdesk.com/api/v2/contacts?email=[Email]
  1. 点击“下一步”。

将联系人查询响应映射到 3CX

3CX CRM Integration Wizard - Map Query Response

  1. 现在我们需要将 CRM 的查询响应映射到 3CX 字段。为此，您需要为 3CX 所需的每个字段指定 JSON 响应中的路径：
  1. “Contact ID” - 匹配到的联系人的ID，必填。
  2. 至少设置以下字段之一：
  1. “First Name”, e.g. contact.firstname
  2. “Last Name”, e.g. contact.lastname
  3. “Company Name”, e.g. contact.company
  1. “Email” - 必填项,e.g. contact.email
  2. 单击“下一步”继续。
  1. 现在您需要将 CRM Web 调用返回的相应响应元素映射到至少以下一个系统变量：
  1. “Business Phone”, e.g. contact.businessphone
  2. “Business Phone 2”, e.g. contact.businessphone2
  3. “Mobile Phone”, e.g. contact.mobilephone
  4. “Mobile Phone 2”, e.g. contact.mobilephone2
  5. “Custom Value” - optionally map a custom response element to a variable.
  6. Set an appropriate “Contact URL” based on:
  7. an expression, e.g. https://api.example.com/show?ContactID=[ContactID]
  8. 服务器响应， e.g. contact.profile_url
  9. 点击“下一步”。

步骤 5 - 配置联系人搜索

Configure contact search using 3CX CRM Integration Wizard

现在，您需要指定在 CRM 系统中需要调用的 API 调用，以便按任意字段搜索联系人。当用户从网页客户端按电话号码、电子邮件、姓名或公司名称搜索联系人时，会用到此功能。

  1. “Search Contacts API URL (GET)” - 根据任意字段查询 CRM 联系人的 URL。例如，对于Freshdesk:
  1. https://domain.freshdesk.com/api/v2/contacts/autocomplete?term=[SearchText]
  1. 点击“下一步”。

将联系人查询响应映射到 3CX

3CX CRM Integration Wizard - Map Query Response

  1. 现在我们需要将 CRM 的查询响应映射到 3CX 字段。为此，您需要为 3CX 所需的每个字段指定 JSON 响应中的路径：
  1. “Contact ID” - 匹配联系人的 ID，必填项。
  2. 至少设置以下字段之一：
  1. “First Name”, e.g. contact.firstname
  2. “Last Name”, e.g. contact.lastname
  3. “Company Name”, e.g. contact.company
  1. “Email”- 必填项，e.g. contact.email
  2. 单击“下一步”继续。
  1. 现在您需要将 CRM Web 调用返回的相应响应元素映射到至少以下一个系统变量：
  1. “Business Phone”, e.g. contact.businessphone
  2. “Business Phone 2”, e.g. contact.businessphone2
  3. “Mobile Phone”, e.g. contact.mobilephone
  4. “Mobile Phone 2”, e.g. contact.mobilephone2
  5. “Custom Value” - 可选地将自定义响应元素映射到变量。
  6. Set an appropriate “Contact URL” based on:
  7. 一个表达式， e.g. https://api.example.com/show?ContactID=[ContactID]
  8. 服务器响应， e.g. contact.profile_url
  9. 点击“下一步”。

步骤 6 - 在 CRM 中配置创建客户

3CX CRM Integration Wizard - Create a customer

此步骤为可选步骤。如果您想在 CRM 系统中启用当来电者号码与现有客户不匹配时创建新联系人的功能，请启用“联系人创建”选项。请配置：

  1. The “API URL (POST)” - 3CX 使用此 URL 在 CRM 系统中创建新联系人。例如，对 Freshdesk 这里使用的 API URL 应为：
  1. https://domain.freshdesk.com/api/v2/contacts
  1. “Request Data”- 为创建联系人而发送到 CRM 的数据，e.g. {"firstname":"[FirstName]", "lastname":"[LastName]", "phone":"[Number]"}
  2. 单击“下一步”继续。

映射联系人创建响应

3CX CRM Integration Wizard - Map query response

  1. 现在我们需要将 CRM 的查询响应映射到 3CX 字段。为此，您需要为 3CX 所需的每个字段指定 JSON 响应中的路径：
  1. “Contact ID”- 匹配联系人的 ID，必填项。
  2. 至少设置以下字段之一：
  1. “First Name”, e.g. contact.firstname
  2. “Last Name”, e.g. contact.lastname
  3. “Company Name”, e.g. contact.company
  1. “Email”- 可选设置，e.g. contact.email
  2. 单击“下一步”继续。
  1. 现在您需要将 CRM Web 调用返回的相应响应元素映射到至少以下一个系统变量：
  1. “Business Phone”, e.g. contact.businessphone
  2. “Business Phone 2”, e.g. contact.businessphone2
  3. “Mobile Phone”, e.g. contact.mobilephone
  4. “Mobile Phone 2”, e.g. contact.mobilephone2
  5. “Custom Value”- 可选地将自定义响应元素映射到变量。
  6. Set an appropriate “Contact URL” based on:
  7. 一个表达式，e.g. https://api.example.com/show?ContactID=[ContactID]
  8. 服务器响应，e.g. contact.profile_url
  1. 点击“下一步”。

步骤 7 - 配置呼叫日志

3CX CRM Integration Wizard - Track Call Activity

此步骤为可选步骤。如果您想将通话记录为 CRM 中的活动，请启用“通话记录”选项。

  1. “API URL (POST)” - 3CX使用此 URL 在 CRM 系统中创建新的呼叫活动。例如，对于Freshdesk这将是此处使用的 API URL：

https://domain.freshdesk.com/api/v2/tickets[/code]

  1. 使用相应的字段来定义用于记录呼入已接电话和未接电话以及呼出已接电话和未接电话的通话日志条目的数据集。例如，对于Freshdesk这将是用于此处应答来电的 JSON 数据：

{"phone":"[Number]","description":"[InboundCallText]","requester_id":[EntityId],"subject":"[Subject]","type":"Question","status":2,"priority":1,"source":3}

  1. 单击“下一步”继续。

第 8 步 - 配置聊天日志

3CX CRM Integration Wizard - Chat Conversation

此步骤为可选步骤。如果您想将聊天对话注册为 CRM 中的活动，请启用“聊天日志”选项。

  1. “API URL（POST）” - 3CX使用此 URL 在 CRM 系统中创建新的聊天活动。例如，对于Freshdesk这将是此处使用的 API URL：

https://domain.freshdesk.com/api/v2/tickets

  1. “Request Data”-用于创建聊天日志条目的数据集。例如，对于Freshdesk这将是此处要使用的 JSON 数据：

{"phone":"[Number]","email":"[Email]","description":"[ChatMessages]","subject":"[ChatSubject]","requester_id":[EntityId],"type":"Question","status":2,"priority":1,"source":7}

  1. 单击“下一步”继续。

步骤 9 - 保存并测试 CRM 集成

3CX CRM Template Generator - Parameter Values

您已到达向导的末尾。点击“完成”，保存生成的 CRM 模板并开始测试。您必须检查向导过程中输入的所有 URL 和 JSON 数据是否按预期工作。生成的模板包含一些静态部分，例如 URL 或 JSON 数据，以及需要设置的变量，例如 CRM 凭证或记录通话时使用的描述。

要填充这些变量，请在左侧树状视图中展开带有模板名称的节点，然后点击“参数值”节点。右侧将显示一个网格，其中包含所有可设置的变量。某些变量有默认值（例如用于通话记录的文本），而其他变量则为空（例如您的 CRM 凭证）。上传模板后，您将在 3CX 管理控制台中配置这些值。

测试联系人查找

Testing Contact Lookup / Contact Creation

选择“参数值”节点后，树视图下的“属性”窗口将显示用于测试的值。例如，您可以在此处输入触发联系人查找的电话号码或电子邮件地址。

  1. 选择交互类型（InboundCall、OutboundCall 或 Chat），并将号码或电子邮件设置为您想要在 CRM 中搜索的值。
  2. 右键单击“参数值”节点，然后选择“按号码查找联系人”或“通过电子邮件查找联系人”。

3CX CRM Template Generator - Parameter Values (Contact Lookup by Number or Email)

  1. 参数值下将显示一个带有日期/时间戳的新节点。点击该节点即可显示场景结果。
  2. “请求/响应”选项卡显示发送到 CRM 的请求以及收到的 JSON 响应。“响应文本”显示该号码已映射到名为“Joe Black”的联系人。

3CX CRM Template Generator - Response Tree3CX CRM Template Generator - Variables

  1. “响应树”选项卡显示了 JSON 响应如何映射到 3CX 变量。粗体变量表示匹配。
  2. 变量选项卡显示在联系人查找期间映射的所有变量。
  3. 输出选项卡显示返回到 3CX 的数据。
  4. 您可以以相同的方式通过任何字段测试联系人搜索、通话日志或聊天日志。

步骤 10 - 将模板上传至 3CX

模板测试和调试完成后，就可以将其上传到 3CX 了。具体操作如下：到 3CX“管理控制台”>“设置”>“CRM”>“服务器端”选项卡并单击“添加”将您的模板上传至 3CX。

另请参阅

上次更新

本文件最后更新于 2023 年 9 月 11 日

https://www.3cx.cn/docs/crm-integration/