跳转到主要内容

ERP 集成

ERP 集成实现了我们系统与您的 ERP 之间的信息实时交换。通过此集成，您可以从 ERP 获取数据并将其整合到客户服务互动中。此外，集成还允许您接收系统生成的各种事件通知。

启用 ERP 集成​

要使用 ERP 集成，请编辑已注册的实例，并通过勾选激活框来启用该功能：

联系人面板​

在 Contact Panel 字段中注册一个 URL，将您系统的功能直接嵌入到服务窗口中：

注意

建议您的 iframe 在最大宽度 300px 下工作。

提示

强烈建议使用 https 协议。

一旦注册了 URL，每次打开配置文件时都会触发一个 POST 请求。此请求将发送所有可用的联系人信息：

{
    "tipo_envio": "common",
    "referencia": "api send",
    "mensagens": [
        {
            "numero": "11999999999",
            "mensagem": "test message 1"
        },
        {
            "numero": "11999999998",
            "mensagem": "test message 2"
        }
    ]
}

}

自定义​

使用可自定义的模板自定义发送消息的内容。

可用的文本格式：​

_text_ 斜体 文本
*text* 粗体 文本
~text~ 删除线 文本

可用变量：​

变量描述示例
$UsuarioNome$发送消息的客服代表姓名Maria
$UsuarioLogin$发送消息的客服代表登录邮箱maria@erp.com
$IdUsuario$客服代表的唯一标识码001
$Departamento$客服代表所属部门名称Support
$JidDestiny$被协助联系人的 JID5511987654321@s.whatsapp.net
$TextMessage$客服代表输入的消息Good morning!
注意

所有可用变量都用符号 $ 包裹，例如：$var_name$

Events​

与您的 ERP 集成允许您注册用于接收系统生成的各种事件的 URL。对于下列每个事件，您都可以注册一个专属的回调 URL：

事件描述
OnLoadContact加载联系人时。在选择并加载联系人配置文件后立即触发。可用于在数据显示在屏幕上之前更新配置文件字段。示例 ↓
OnBeforeSaveContact保存联系人之前。主要用于验证用户数据和/或在保存联系人之前应用业务规则。
OnSaveContact保存联系人之后。如果 OnBeforeSaveContact 事件返回 true 则发生。
OnStartConversation开始对话后。当向联系人发送第一条消息时发生。
OnEndConversation结束对话时。当服务由系统自动完成或由操作员手动完成时发生。
即将推出！
OnGetChatMessageSugestion要调用的事件以返回响应建议矩阵。每次联系人的新回复都会触发。 即将推出！

注册要在上述字段之一中触发的事件 URL，使用以下格式：

https://my-erp.com.br/api/OnLoadContact.php?jid=`$Jid$`&status=`$Status$`

可用变量​

变量描述返回
$InstanceId$实例的唯一标识码。integer
$ProfileId$配置文件的唯一标识码。integer
$Jid$联系人 JID - 由 WhatsApp 提供。string
示例: 5511987654321@s.whatsapp.net
$name$联系人姓名string
示例: Maria
$isGroup$联系人是否为群组。true 或 false
$StatusInt$数字格式的联系人状态。0 Normal
1 Locked
2 Archived
3 Blocked
$Status$联系人状态。string
示例: Locked
$LockedUserId$联系人被锁定给的操作员的唯一代码。integer
$LockedUserName$联系人被锁定给的操作员姓名。string
示例: Agent Maria
$LockedUserLogin$联系人被锁定给的操作员邮箱。string
示例: maria@company.com
$DepartmentId$联系人所属部门的唯一代码。integer
$Department$联系人被转移到或所属部门的名称。string
示例: Finance
$SegmentName$为联系人选择的细分名称，之前在
实例设置的 Classifications 下注册。		string
$LastMessageId$最后一条聊天消息的唯一代码。integer
$MsgRead$发送并被联系人阅读的消息数量。integer
$MsgUnread$来自联系人的未读消息数量。integer
$Email$为联系人注册的邮箱。string
示例: felipe@gmail.com
$Phone$为联系人注册的电话号码。
如果未注册，则根据联系人的 JID 返回电话号码。		string
示例: (54) 9876-5432
$Document$为联系人注册的文档。string
示例: 123.456.789-10
$Note$在联系人记录的 ... 标签中注册的备注，
显示在联系人列表中档案照片下方。		string
$CreateDate$联系人创建的日期和时间。timestamp
示例:20210205 13:47:00
$LastStatusDateTime$联系人最后状态更新的日期和时间。timestamp
示例: 20210205 13:47:00
$LockedUserDate$联系人被锁定的日期和时间。timestamp
示例: 20210205 15:55:00
$wid$实例 WIDstring
示例: C61BBC40-D019-427A-A31C-230243E27242

OnLoadContact​

您可以返回带有更新的联系人配置文件的 json。要返回的配置文件示例：

在提供的 URL 中使用变量 $jid$ 和 $webid$，以在您的 API 中接收当前联系人的标识符。

{
    "Name": "Maria",
    "Email": "maria@gmail.com",
    "SegmentName": "",
    "Telefone": "(11) 98765-4321",
    "UrlInfo": "http://my-erp.com.br/panel?jid=5511987654321@s.whatsapp.net", // custom iframe
    "UrlPicture": "http://my-erp.com.br/updatedPicture?jid=5511987654321@s.whatsapp.net",
    "MemoText": "Call tomorrow",
    "Document": "123.456.789-10",
    "Priority": 1, // 1, 2 or 3
    "Group": "",
    "CSS": "", 
    "InternalID": ""
}
提示

无需填写所有字段。

注意

返回的配置文件将永久替换现有的配置文件内容。

UrlInfo 字段中返回的 URL 将在联系人的 iframe 中使用：

变量 API​

如果您需要在我们的平台上保存变量，请使用我们的变量 API。

EndPoint  https://witi.me/api/witime/savevars.aspx?key=API_KEY&WID=INSTANCE_WID&NAME=VARIABLE_NAME
Method     POST
Body       要保存的 json 或 text 内容
Return    如果成功保存则返回"OK"

注意

变量名称 必须是唯一的，否则现有变量将被替换。

检索变量​

EndPoint  https://witi.me/api/witime/loadvars.aspx?key=API_KEY&WID=INSTANCE_WID&NAME=VARIABLE_NAME
Method     GET
Return     之前保存的数据