Intercom
在 Intercom 中管理联系人、公司、对话、工单和消息
配置
创建联系人
操作
创建联系人
访问令牌*
••••••••
角色
Select...
邮箱
联系人邮箱
外部 ID
联系人的外部标识符
电话
联系人电话号码
姓名
联系人姓名
头像 URL
头像图片 URL
注册时间
Unix 时间戳
最后查看时间
Unix 时间戳
所有者 ID
管理员 ID
已退订邮件
Select...
自定义属性
包含自定义属性的 JSON 对象
公司 ID
要关联到联系人的公司 ID
创建联系人(
intercom_create_contact)使用 email、external_id 或 role 在 Intercom 中创建新联系人
输入
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
role | string | 否 | 联系人角色。可接受 'user' 或 'lead'。未指定时默认为 'lead'。 |
email | string | 否 | 联系人的邮箱地址 |
external_id | string | 否 | 客户端提供的联系人唯一标识符 |
phone | string | 否 | 联系人的电话号码 |
name | string | 否 | 联系人的姓名 |
avatar | string | 否 | 联系人的头像图片 URL |
signed_up_at | number | 否 | 用户注册时间,Unix 时间戳 |
last_seen_at | number | 否 | 用户上次出现时间,Unix 时间戳 |
owner_id | string | 否 | 被指定为该联系人账户所有者的管理员 ID |
unsubscribed_from_emails | boolean | 否 | 联系人是否已退订邮件 |
custom_attributes | string | 否 | 自定义属性,JSON 对象 (例如 {"attribute_name": "value"}) |
company_id | string | 否 | 创建时要关联到该联系人的公司 ID |
输出
| 参数 | 类型 | 说明 |
|---|---|---|
contact | object | 已创建的联系人对象 |
metadata | object | 操作元数据 |
success | boolean | 操作成功状态 |
获取联系人
操作
获取联系人
访问令牌*
••••••••
联系人 ID*
联系人 ID
获取联系人 (
intercom_get_contact)通过 ID 从 Intercom 获取单个联系人
输入
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
contactId | string | 是 | 要获取的联系人 ID |
输出
| 参数 | 类型 | 说明 |
|---|---|---|
contact | object | 联系人对象 |
metadata | object | 操作元数据 |
success | boolean | 操作成功状态 |
更新联系人
操作
更新联系人
访问令牌*
••••••••
角色
Select...
联系人 ID*
联系人 ID
邮箱
联系人邮箱
外部 ID
联系人的外部标识符
电话
联系人电话号码
姓名
联系人姓名
头像 URL
头像图片 URL
注册时间
Unix 时间戳
上次查看时间
Unix 时间戳
所有者 ID
管理员 ID
已退订邮件
Select...
自定义属性
包含自定义属性的 JSON 对象
公司 ID
要关联到联系人的公司 ID
更新联系人(
intercom_update_contact)更新 Intercom 中的现有联系人
输入
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
contactId | string | 是 | 要更新的联系人 ID |
role | string | 否 | 联系人角色。接受 “user” 或 “lead”。 |
external_id | string | 否 | 客户端提供的联系人唯一标识符 |
email | string | 否 | 联系人的邮箱地址 |
phone | string | 否 | 联系人的电话号码 |
name | string | 否 | 联系人姓名 |
avatar | string | 否 | 联系人头像图片 URL |
signed_up_at | number | 否 | 用户注册时间,Unix 时间戳 |
last_seen_at | number | 否 | 用户上次出现时间,Unix 时间戳 |
owner_id | string | 否 | 已获分配该联系人账户所有权的管理员 ID |
unsubscribed_from_emails | boolean | 否 | 联系人是否已退订邮件 |
custom_attributes | string | 否 | 自定义属性,JSON 对象 (例如 {"attribute_name": "value"}) |
company_id | string | 否 | 要与该联系人关联的公司 ID |
输出
| 参数 | 类型 | 描述 |
|---|---|---|
contact | object | 更新后的联系人对象 |
metadata | object | 操作元数据 |
success | boolean | 操作成功状态 |
列出联系人
操作
列出联系人
访问令牌*
••••••••
每页条数
每页结果数(最多 150)
起始于
分页游标
列出联系人 (
intercom_list_contacts)从 Intercom 列出所有联系人,支持分页
输入
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
per_page | number | 否 | 每页结果数 (最多: 150) |
starting_after | string | 否 | 分页游标 - 从此 ID 之后开始 |
输出
| 参数 | 类型 | 说明 |
|---|---|---|
contacts | array | 联系人对象数组 |
pages | object | 分页信息 |
metadata | object | 操作元数据 |
success | boolean | 操作成功状态 |
搜索联系人
操作
搜索联系人
访问令牌*
••••••••
搜索查询*
JSON 搜索查询或文本
排序字段
用于排序的字段(例如 name、created_at)
排序顺序
Select...
每页条数
每页结果数(最多 150)
起始游标
分页游标
搜索联系人 (
intercom_search_contacts)使用查询在 Intercom 中搜索联系人
输入
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
query | string | 是 | 搜索查询(例如:{"field":"email","operator":"=","value":"user@example.com"}) |
per_page | number | 否 | 每页结果数(最多 150) |
starting_after | string | 否 | 分页游标 |
sort_field | string | 否 | 排序字段(例如:"name"、"created_at"、"last_seen_at") |
sort_order | string | 否 | 排序顺序:"ascending" 或 "descending" |
输出
| 参数 | 类型 | 说明 |
|---|---|---|
contacts | array | 匹配的联系人对象数组 |
pages | object | 分页信息 |
metadata | object | 操作元数据 |
success | boolean | 操作成功状态 |
删除联系人
操作
删除联系人
访问令牌*
••••••••
联系人 ID*
联系人 ID
删除联系人 (
intercom_delete_contact)根据 ID 从 Intercom 删除联系人
输入
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
contactId | string | 是 | 要删除的联系人 ID |
输出
| 参数 | 类型 | 说明 |
|---|---|---|
id | string | 已删除联系人的 ID |
deleted | boolean | 联系人是否已删除 |
metadata | object | 操作元数据 |
success | boolean | 操作成功状态 |
创建公司
操作
创建公司
访问令牌*
••••••••
公司 ID(外部)*
公司的唯一标识符
公司名称
公司名称
网站
公司网站
套餐
订阅套餐
规模
员工人数
行业
公司行业
月消费
收入金额
远程创建时间
公司创建时的 Unix 时间戳
创建公司(
intercom_create_company)在 Intercom 中创建或更新公司
输入
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
company_id | string | 是 | 你为该公司设定的唯一标识符 |
name | string | 否 | 公司名称 |
website | string | 否 | 公司网站 |
plan | string | 否 | 公司套餐名称 |
size | number | 否 | 公司员工人数 |
industry | string | 否 | 公司所属行业 |
monthly_spend | number | 否 | 该公司为你的业务带来的收入。注意:此字段会将浮点数截断为整数 (例如 155.98 变为 155) |
custom_attributes | string | 否 | 自定义属性,JSON 对象 |
remote_created_at | number | 否 | 你创建该公司的时间,Unix 时间戳 |
输出
| 参数 | 类型 | 说明 |
|---|---|---|
company | object | 已创建或已更新的公司对象 |
metadata | object | 操作元数据 |
success | boolean | 操作成功状态 |
获取公司
操作
获取公司
访问令牌*
••••••••
公司 ID*
Intercom 公司 ID
获取公司(
intercom_get_company)按 ID 从 Intercom 获取单个公司
输入
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
companyId | string | 是 | 要获取的公司 ID |
输出
| 参数 | 类型 | 说明 |
|---|---|---|
company | object | 公司对象 |
metadata | object | 操作元数据 |
success | boolean | 操作成功状态 |
列出公司
操作
列出公司
访问令牌*
••••••••
每页条数
每页结果数(最多 150)
起始游标
分页游标
页码
页码
列出公司(
intercom_list_companies)列出 Intercom 中的所有公司,支持分页。注意:此端点通过分页最多可返回 10,000 家公司。若数据集超过 10,000 家公司,请改用 Scroll API。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
per_page | number | 否 | 每页结果数 |
page | number | 否 | 页码 |
starting_after | string | 否 | 分页游标(优先于基于页码的分页) |
输出
| 参数 | 类型 | 说明 |
|---|---|---|
companies | array | 公司对象数组 |
pages | object | 分页信息 |
metadata | object | 操作元数据 |
success | boolean | 操作成功状态 |
获取对话
操作
获取对话
访问令牌*
••••••••
对话 ID*
对话 ID
显示为
Select...
包含翻译
Select...
获取对话 (
intercom_get_conversation)根据 ID 从 Intercom 获取单条对话
输入
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
conversationId | string | 是 | 要获取的对话 ID |
display_as | string | 否 | 设为 "plaintext" 以纯文本形式获取消息 |
include_translations | boolean | 否 | 为 true 时,对话片段将翻译为检测到的对话语言 |
输出
| 参数 | 类型 | 说明 |
|---|---|---|
conversation | object | 对话对象 |
metadata | object | 操作元数据 |
success | boolean | 操作成功状态 |
列出对话
操作
列出对话
访问令牌*
••••••••
排序字段
排序字段(例如 waiting_since、updated_at)
排序
Select...
每页条数
每页结果数(最多 150)
起始游标
分页游标
列出对话 (
intercom_list_conversations)列出 Intercom 中的所有对话,支持分页
输入
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
per_page | number | 否 | 每页结果数量(最多 150) |
starting_after | string | 否 | 分页游标 |
sort | string | 否 | 排序字段(例如 "waiting_since"、"updated_at"、"created_at") |
order | string | 否 | 排序顺序:"asc"(升序)或 "desc"(降序) |
输出
| 参数 | 类型 | 说明 |
|---|---|---|
conversations | array | 对话对象数组 |
pages | object | 分页信息 |
metadata | object | 操作元数据 |
success | boolean | 操作成功状态 |
回复对话
操作
回复对话
访问令牌*
••••••••
对话 ID*
对话 ID
消息类型*
Select...
消息正文*
消息文本
管理员 ID*
发送消息的管理员 ID
附件 URL
逗号分隔的图片 URL(最多 10 个)
创建时间
回复创建时间的 Unix 时间戳
回复对话 (
intercom_reply_conversation)在 Intercom 中以管理员身份回复对话
输入
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
conversationId | string | 是 | 要回复的对话 ID |
message_type | string | 是 | 消息类型:"comment" 或 "note" |
body | string | 是 | 回复正文 |
admin_id | string | 否 | 撰写该回复的管理员 ID。未提供时,将使用默认管理员(Operator/Fin)。 |
attachment_urls | string | 否 | 逗号分隔的图片 URL 列表(最多 10 个) |
created_at | number | 否 | 回复创建时的 Unix 时间戳。未提供时使用当前时间。 |
输出
| 参数 | 类型 | 说明 |
|---|---|---|
conversation | object | 更新后的对话对象 |
metadata | object | 操作元数据 |
success | boolean | 操作成功状态 |
搜索对话
操作
搜索对话
访问令牌*
••••••••
搜索查询*
JSON 搜索查询或文本
排序字段
用于排序的字段(例如 name、created_at)
排序顺序
Select...
每页条数
每页结果数(最多 150)
起始游标
分页游标
搜索对话 (
intercom_search_conversations)使用查询在 Intercom 中搜索对话
输入
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
query | string | 是 | 作为 JSON 对象的搜索查询 |
per_page | number | 否 | 每页结果数 (最多:150) |
starting_after | string | 否 | 分页游标 |
sort_field | string | 否 | 排序字段 (例如 "created_at"、"updated_at") |
sort_order | string | 否 | 排序顺序:"ascending" 或 "descending" |
输出
| 参数 | 类型 | 说明 |
|---|---|---|
conversations | array | 匹配的对话对象数组 |
pages | object | 分页信息 |
metadata | object | 操作元数据 |
success | boolean | 操作成功状态 |
创建工单
操作
创建工单
访问令牌*
••••••••
工单类型 ID*
工单类型的 ID
联系人*
联系人标识符的 JSON 数组
工单属性*
包含工单属性的 JSON 对象
公司 ID
要关联到工单的公司 ID
创建时间
工单创建时间的 Unix 时间戳
要关联的对话
要关联到工单的对话 ID
禁用通知
Select...
创建工单(
intercom_create_ticket)在 Intercom 中创建新工单
输入
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
ticket_type_id | string | 是 | 工单类型的 ID |
contacts | string | 是 | 联系人标识符的 JSON 数组(例如:[{"id": "contact_id"}]) |
ticket_attributes | string | 是 | 包含 default_title 和 default_description 的工单属性 JSON 对象 |
company_id | string | 否 | 要与该工单关联的公司 ID |
created_at | number | 否 | 工单创建时的 Unix 时间戳。未提供时使用当前时间。 |
conversation_to_link_id | string | 否 | 要关联到该工单的现有对话 ID |
disable_notifications | boolean | 否 | 为 true 时,创建工单时不发送通知 |
输出
| 参数 | 类型 | 说明 |
|---|---|---|
ticket | object | 已创建的工单对象 |
metadata | object | 操作元数据 |
success | boolean | 操作成功状态 |
获取工单
操作
获取工单
访问令牌*
••••••••
工单 ID*
工单 ID
获取工单 (
intercom_get_ticket)根据 ID 从 Intercom 获取单个工单
输入
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
ticketId | string | 是 | 要获取的工单 ID |
输出
| 参数 | 类型 | 说明 |
|---|---|---|
ticket | object | 工单对象 |
metadata | object | 操作元数据 |
success | boolean | 操作成功状态 |
创建消息
操作
创建消息
访问令牌*
••••••••
消息正文*
消息文本
消息类型*
Select...
模板*
Select...
主题
邮件主题(邮件类型时填写)
发送方类型*
Select...
发送方 ID*
管理员 ID
接收方类型*
Select...
接收方 ID*
联系人 ID
创建时间
消息创建时间的 Unix 时间戳
创建消息 (
intercom_create_message)在 Intercom 中创建并发送管理员发起的新消息
输入
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
message_type | string | 是 | 消息类型:"inapp" 表示应用内消息,"email" 表示电子邮件消息 |
template | string | 是 | 消息模板样式:"plain" 表示纯文本,"personal" 表示个性化样式 |
subject | string | 否 | 消息主题(电子邮件类型) |
body | string | 是 | 消息正文 |
from_type | string | 是 | 发送者类型:"admin" |
from_id | string | 是 | 发送该消息的管理员 ID |
to_type | string | 是 | 接收者类型:"contact" |
to_id | string | 是 | 接收该消息的联系人 ID |
created_at | number | 否 | 消息创建时的 Unix 时间戳。未提供时使用当前时间。 |
输出
| 参数 | 类型 | 说明 |
|---|---|---|
message | object | 已创建的消息对象 |
metadata | object | 操作元数据 |
success | boolean | 操作成功状态 |
使用说明
将 Intercom 集成到工作流。可创建、获取、更新、列出、搜索和删除联系人;创建、获取和列出公司;获取、列出、回复和搜索对话;创建和获取工单;以及创建消息。
备注
- 类别:
tools - 类型:
intercom