Intercom

在 Intercom 中管理联系人、公司、对话、工单和消息

配置

创建联系人

操作
创建联系人
访问令牌*
••••••••
角色
Select...
邮箱
联系人邮箱
外部 ID
联系人的外部标识符
电话
联系人电话号码
姓名
联系人姓名
头像 URL
头像图片 URL
注册时间
Unix 时间戳
最后查看时间
Unix 时间戳
所有者 ID
管理员 ID
已退订邮件
Select...
自定义属性
包含自定义属性的 JSON 对象
公司 ID
要关联到联系人的公司 ID
创建联系人(intercom_create_contact)

使用 email、external_id 或 role 在 Intercom 中创建新联系人

输入
参数类型必填说明
rolestring否联系人角色。可接受 'user' 或 'lead'。未指定时默认为 'lead'。
emailstring否联系人的邮箱地址
external_idstring否客户端提供的联系人唯一标识符
phonestring否联系人的电话号码
namestring否联系人的姓名
avatarstring否联系人的头像图片 URL
signed_up_atnumber否用户注册时间,Unix 时间戳
last_seen_atnumber否用户上次出现时间,Unix 时间戳
owner_idstring否被指定为该联系人账户所有者的管理员 ID
unsubscribed_from_emailsboolean否联系人是否已退订邮件
custom_attributesstring否自定义属性,JSON 对象 (例如 {"attribute_name": "value"})
company_idstring否创建时要关联到该联系人的公司 ID
输出
参数类型说明
contactobject已创建的联系人对象
metadataobject操作元数据
successboolean操作成功状态

获取联系人

操作
获取联系人
访问令牌*
••••••••
联系人 ID*
联系人 ID
获取联系人 (intercom_get_contact)

通过 ID 从 Intercom 获取单个联系人

输入
参数类型必填说明
contactIdstring是要获取的联系人 ID
输出
参数类型说明
contactobject联系人对象
metadataobject操作元数据
successboolean操作成功状态

更新联系人

操作
更新联系人
访问令牌*
••••••••
角色
Select...
联系人 ID*
联系人 ID
邮箱
联系人邮箱
外部 ID
联系人的外部标识符
电话
联系人电话号码
姓名
联系人姓名
头像 URL
头像图片 URL
注册时间
Unix 时间戳
上次查看时间
Unix 时间戳
所有者 ID
管理员 ID
已退订邮件
Select...
自定义属性
包含自定义属性的 JSON 对象
公司 ID
要关联到联系人的公司 ID
更新联系人(intercom_update_contact)

更新 Intercom 中的现有联系人

输入
参数类型必填描述
contactIdstring是要更新的联系人 ID
rolestring否联系人角色。接受 “user” 或 “lead”。
external_idstring否客户端提供的联系人唯一标识符
emailstring否联系人的邮箱地址
phonestring否联系人的电话号码
namestring否联系人姓名
avatarstring否联系人头像图片 URL
signed_up_atnumber否用户注册时间,Unix 时间戳
last_seen_atnumber否用户上次出现时间,Unix 时间戳
owner_idstring否已获分配该联系人账户所有权的管理员 ID
unsubscribed_from_emailsboolean否联系人是否已退订邮件
custom_attributesstring否自定义属性,JSON 对象 (例如 {"attribute_name": "value"})
company_idstring否要与该联系人关联的公司 ID
输出
参数类型描述
contactobject更新后的联系人对象
metadataobject操作元数据
successboolean操作成功状态

列出联系人

操作
列出联系人
访问令牌*
••••••••
每页条数
每页结果数(最多 150)
起始于
分页游标
列出联系人 (intercom_list_contacts)

从 Intercom 列出所有联系人,支持分页

输入
参数类型必填说明
per_pagenumber否每页结果数 (最多: 150)
starting_afterstring否分页游标 - 从此 ID 之后开始
输出
参数类型说明
contactsarray联系人对象数组
pagesobject分页信息
metadataobject操作元数据
successboolean操作成功状态

搜索联系人

操作
搜索联系人
访问令牌*
••••••••
搜索查询*
JSON 搜索查询或文本
排序字段
用于排序的字段(例如 name、created_at)
排序顺序
Select...
每页条数
每页结果数(最多 150)
起始游标
分页游标
搜索联系人 (intercom_search_contacts)

使用查询在 Intercom 中搜索联系人

输入
参数类型必填说明
querystring是搜索查询(例如:{"field":"email","operator":"=","value":"user@example.com"})
per_pagenumber否每页结果数(最多 150)
starting_afterstring否分页游标
sort_fieldstring否排序字段(例如:"name"、"created_at"、"last_seen_at")
sort_orderstring否排序顺序:"ascending" 或 "descending"
输出
参数类型说明
contactsarray匹配的联系人对象数组
pagesobject分页信息
metadataobject操作元数据
successboolean操作成功状态

删除联系人

操作
删除联系人
访问令牌*
••••••••
联系人 ID*
联系人 ID
删除联系人 (intercom_delete_contact)

根据 ID 从 Intercom 删除联系人

输入
参数类型必填说明
contactIdstring是要删除的联系人 ID
输出
参数类型说明
idstring已删除联系人的 ID
deletedboolean联系人是否已删除
metadataobject操作元数据
successboolean操作成功状态

创建公司

操作
创建公司
访问令牌*
••••••••
公司 ID(外部)*
公司的唯一标识符
公司名称
公司名称
网站
公司网站
套餐
订阅套餐
规模
员工人数
行业
公司行业
月消费
收入金额
远程创建时间
公司创建时的 Unix 时间戳
创建公司(intercom_create_company)

在 Intercom 中创建或更新公司

输入
参数类型必填说明
company_idstring是你为该公司设定的唯一标识符
namestring否公司名称
websitestring否公司网站
planstring否公司套餐名称
sizenumber否公司员工人数
industrystring否公司所属行业
monthly_spendnumber否该公司为你的业务带来的收入。注意:此字段会将浮点数截断为整数 (例如 155.98 变为 155)
custom_attributesstring否自定义属性,JSON 对象
remote_created_atnumber否你创建该公司的时间,Unix 时间戳
输出
参数类型说明
companyobject已创建或已更新的公司对象
metadataobject操作元数据
successboolean操作成功状态

获取公司

操作
获取公司
访问令牌*
••••••••
公司 ID*
Intercom 公司 ID
获取公司(intercom_get_company)

按 ID 从 Intercom 获取单个公司

输入
参数类型必填说明
companyIdstring是要获取的公司 ID
输出
参数类型说明
companyobject公司对象
metadataobject操作元数据
successboolean操作成功状态

列出公司

操作
列出公司
访问令牌*
••••••••
每页条数
每页结果数(最多 150)
起始游标
分页游标
页码
页码
列出公司(intercom_list_companies)

列出 Intercom 中的所有公司,支持分页。注意:此端点通过分页最多可返回 10,000 家公司。若数据集超过 10,000 家公司,请改用 Scroll API。

输入
参数类型必填说明
per_pagenumber否每页结果数
pagenumber否页码
starting_afterstring否分页游标(优先于基于页码的分页)
输出
参数类型说明
companiesarray公司对象数组
pagesobject分页信息
metadataobject操作元数据
successboolean操作成功状态

获取对话

操作
获取对话
访问令牌*
••••••••
对话 ID*
对话 ID
显示为
Select...
包含翻译
Select...
获取对话 (intercom_get_conversation)

根据 ID 从 Intercom 获取单条对话

输入
参数类型必填说明
conversationIdstring是要获取的对话 ID
display_asstring否设为 "plaintext" 以纯文本形式获取消息
include_translationsboolean否为 true 时,对话片段将翻译为检测到的对话语言
输出
参数类型说明
conversationobject对话对象
metadataobject操作元数据
successboolean操作成功状态

列出对话

操作
列出对话
访问令牌*
••••••••
排序字段
排序字段(例如 waiting_since、updated_at)
排序
Select...
每页条数
每页结果数(最多 150)
起始游标
分页游标
列出对话 (intercom_list_conversations)

列出 Intercom 中的所有对话,支持分页

输入
参数类型必填说明
per_pagenumber否每页结果数量(最多 150)
starting_afterstring否分页游标
sortstring否排序字段(例如 "waiting_since"、"updated_at"、"created_at")
orderstring否排序顺序:"asc"(升序)或 "desc"(降序)
输出
参数类型说明
conversationsarray对话对象数组
pagesobject分页信息
metadataobject操作元数据
successboolean操作成功状态

回复对话

操作
回复对话
访问令牌*
••••••••
对话 ID*
对话 ID
消息类型*
Select...
消息正文*
消息文本
管理员 ID*
发送消息的管理员 ID
附件 URL
逗号分隔的图片 URL(最多 10 个)
创建时间
回复创建时间的 Unix 时间戳
回复对话 (intercom_reply_conversation)

在 Intercom 中以管理员身份回复对话

输入
参数类型必填说明
conversationIdstring是要回复的对话 ID
message_typestring是消息类型:"comment" 或 "note"
bodystring是回复正文
admin_idstring否撰写该回复的管理员 ID。未提供时,将使用默认管理员(Operator/Fin)。
attachment_urlsstring否逗号分隔的图片 URL 列表(最多 10 个)
created_atnumber否回复创建时的 Unix 时间戳。未提供时使用当前时间。
输出
参数类型说明
conversationobject更新后的对话对象
metadataobject操作元数据
successboolean操作成功状态

搜索对话

操作
搜索对话
访问令牌*
••••••••
搜索查询*
JSON 搜索查询或文本
排序字段
用于排序的字段(例如 name、created_at)
排序顺序
Select...
每页条数
每页结果数(最多 150)
起始游标
分页游标
搜索对话 (intercom_search_conversations)

使用查询在 Intercom 中搜索对话

输入
参数类型必填说明
querystring是作为 JSON 对象的搜索查询
per_pagenumber否每页结果数 (最多:150)
starting_afterstring否分页游标
sort_fieldstring否排序字段 (例如 "created_at"、"updated_at")
sort_orderstring否排序顺序:"ascending" 或 "descending"
输出
参数类型说明
conversationsarray匹配的对话对象数组
pagesobject分页信息
metadataobject操作元数据
successboolean操作成功状态

创建工单

操作
创建工单
访问令牌*
••••••••
工单类型 ID*
工单类型的 ID
联系人*
联系人标识符的 JSON 数组
工单属性*
包含工单属性的 JSON 对象
公司 ID
要关联到工单的公司 ID
创建时间
工单创建时间的 Unix 时间戳
要关联的对话
要关联到工单的对话 ID
禁用通知
Select...
创建工单(intercom_create_ticket)

在 Intercom 中创建新工单

输入
参数类型必填说明
ticket_type_idstring是工单类型的 ID
contactsstring是联系人标识符的 JSON 数组(例如:[{"id": "contact_id"}])
ticket_attributesstring是包含 default_title 和 default_description 的工单属性 JSON 对象
company_idstring否要与该工单关联的公司 ID
created_atnumber否工单创建时的 Unix 时间戳。未提供时使用当前时间。
conversation_to_link_idstring否要关联到该工单的现有对话 ID
disable_notificationsboolean否为 true 时,创建工单时不发送通知
输出
参数类型说明
ticketobject已创建的工单对象
metadataobject操作元数据
successboolean操作成功状态

获取工单

操作
获取工单
访问令牌*
••••••••
工单 ID*
工单 ID
获取工单 (intercom_get_ticket)

根据 ID 从 Intercom 获取单个工单

输入
参数类型必填说明
ticketIdstring是要获取的工单 ID
输出
参数类型说明
ticketobject工单对象
metadataobject操作元数据
successboolean操作成功状态

创建消息

操作
创建消息
访问令牌*
••••••••
消息正文*
消息文本
消息类型*
Select...
模板*
Select...
主题
邮件主题(邮件类型时填写)
发送方类型*
Select...
发送方 ID*
管理员 ID
接收方类型*
Select...
接收方 ID*
联系人 ID
创建时间
消息创建时间的 Unix 时间戳
创建消息 (intercom_create_message)

在 Intercom 中创建并发送管理员发起的新消息

输入
参数类型必填说明
message_typestring是消息类型:"inapp" 表示应用内消息,"email" 表示电子邮件消息
templatestring是消息模板样式:"plain" 表示纯文本,"personal" 表示个性化样式
subjectstring否消息主题(电子邮件类型)
bodystring是消息正文
from_typestring是发送者类型:"admin"
from_idstring是发送该消息的管理员 ID
to_typestring是接收者类型:"contact"
to_idstring是接收该消息的联系人 ID
created_atnumber否消息创建时的 Unix 时间戳。未提供时使用当前时间。
输出
参数类型说明
messageobject已创建的消息对象
metadataobject操作元数据
successboolean操作成功状态

使用说明

将 Intercom 集成到工作流。可创建、获取、更新、列出、搜索和删除联系人;创建、获取和列出公司;获取、列出、回复和搜索对话;创建和获取工单;以及创建消息。

备注

  • 类别:tools
  • 类型:intercom