HubSpot Conversations v2(獨立發佈者)(預覽版)
HubSpot對話服務可讓您管理對話收件匣、頻道和訊息並與之互動。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | 特洛伊·泰勒 |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 特洛伊·泰勒 |
| 網站 | https://www.hubspot.com/products/crm/conversations |
| 隱私策略 | https://legal.hubspot.com/privacy-policy |
| 類別 | 營銷;銷售和客戶關係管理 |
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 存取權杖 (以「持有人YOUR_ACCESS_TOKEN」的形式) | securestring | 此 API 的存取權杖 (以「持有人YOUR_ACCESS_TOKEN」的形式) | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 傳送訊息至討論串 |
在目前時間戳記的執行緒上傳送新訊息。 |
| 取得交談收件匣 |
擷取交談收件匣清單。 |
| 取得單一交談收件匣 |
擷取單一交談收件匣。 |
| 取得單一執行緒 |
擷取單一執行緒。 |
| 取得單一演員 |
擷取單一動作者。 |
| 取得單一訊息 |
擷取單一訊息。 |
| 取得單一訊息的原始內容 |
傳回訊息的完整原始文字和RTF內文。 如果訊息的 truncationStatus 不是 NOT_TRUNCATED,這將與訊息本身中的文字和 RTF 不同。 |
| 取得單一頻道 |
擷取單一通道。 |
| 取得單一頻道帳戶 |
擷取單一通道帳戶。 |
| 取得執行緒 |
擷取執行緒清單。 |
| 取得演員 |
將動作者識別碼解析為基礎動作者和參與者。 |
| 取得討論串的訊息記錄 |
擷取執行緒的訊息歷程記錄清單。 |
| 取得頻道 |
擷取通道清單。 |
| 取得頻道帳戶 |
擷取頻道帳戶清單。 |
| 封存一個線程 |
封存單一執行緒。 該線程將在置於存檔狀態 30 天後永久刪除。 |
| 更新執行緒 |
更新單一執行緒。 可以更新執行緒的狀態,也可以還原執行緒。 |
| 產生權杖 |
產生新的訪客識別權杖。 每次呼叫此端點時,此權杖都是唯一的,即使使用相同的電子郵件地址呼叫也一樣。 該代幣是臨時的,將在 12 小時後過期。 |
傳送訊息至討論串
在目前時間戳記的執行緒上傳送新訊息。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
執行緒識別碼
|
threadId | True | string |
執行緒識別碼。 |
|
Attachments
|
attachments | array of |
附件物件。 |
|
|
頻道帳戶ID
|
channelAccountId | string |
頻道帳戶識別碼。 |
|
|
頻道 ID
|
channelId | string |
通道識別碼。 |
|
|
類型
|
type | string |
型別。 |
|
|
價值觀
|
value | string |
值。 |
|
|
執行者ID
|
actorId | string |
動作者識別碼。 |
|
|
名稱
|
name | string |
名稱。 |
|
|
收件者欄位
|
recipientField | string |
收件者欄位。 |
|
|
類型
|
type | string |
型別。 |
|
|
價值觀
|
value | string |
值。 |
|
|
寄件者動作者識別碼
|
senderActorId | string |
寄件者執行者識別碼。 |
|
|
文字
|
text | string |
文字。 |
|
|
類型
|
type | string |
型別。 |
|
|
RTF 格式
|
richText | string |
瑞克文本。 |
|
|
主旨
|
subject | string |
主題。 |
傳回
- response
- string
取得交談收件匣
擷取交談收件匣清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
之後
|
after | string |
之後連結。 |
|
|
限制
|
limit | string |
回應限制。 |
|
|
排序
|
sort | string |
排序順序。 |
|
|
頁面長度
|
defaultPageLength | string |
預設頁面長度。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
識別碼。 |
|
名稱
|
results.name | string |
名稱。 |
|
創建於
|
results.createdAt | string |
建立時。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
總數
|
total | integer |
總計。 |
|
之後
|
paging.next.after | string |
之後連結。 |
|
Link
|
paging.next.link | string |
鏈接。 |
取得單一交談收件匣
擷取單一交談收件匣。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
收件匣識別碼
|
inboxId | True | string |
收件匣識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
名稱
|
name | string |
名稱。 |
|
創建於
|
createdAt | string |
建立時。 |
|
更新於
|
updatedAt | string |
更新時。 |
取得單一執行緒
擷取單一執行緒。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
屬性
|
property | string |
屬性。 |
|
|
執行緒識別碼
|
threadId | True | string |
執行緒識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
相關聯的連絡人識別碼
|
associatedContactId | string |
相關聯的連絡人識別碼。 |
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
收件匣識別碼
|
inboxId | string |
收件匣識別碼。 |
|
垃圾郵件
|
spam | boolean |
垃圾郵件。 |
|
地位
|
status | string |
狀態。 |
|
關閉時間
|
closedAt | string |
當關閉時。 |
|
最新訊息時間戳記
|
latestMessageTimestamp | string |
最新的訊息時間戳記。 |
|
最新訊息傳送時間戳記
|
latestMessageSentTimestamp | string |
最新傳送的訊息時間戳記。 |
|
最新收到的訊息時間戳記
|
latestMessageReceivedTimestamp | string |
收到的最新訊息時間戳記。 |
|
指派至
|
assignedTo | string |
分配給。 |
|
Archived
|
archived | boolean |
是否存檔。 |
取得單一演員
擷取單一動作者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
屬性
|
property | string |
屬性。 |
|
|
執行者ID
|
actorId | True | string |
動作者識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
類型
|
type | string |
型別。 |
|
名稱
|
name | string |
名稱。 |
|
Email
|
string |
電子郵件地址。 |
|
|
阿凡達
|
avatar | string |
化身。 |
取得單一訊息
擷取單一訊息。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
屬性
|
property | string |
屬性。 |
|
|
執行緒識別碼
|
threadId | True | string |
執行緒識別碼。 |
|
訊息 ID
|
messageId | True | string |
訊息識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | string |
值。 |
取得單一訊息的原始內容
傳回訊息的完整原始文字和RTF內文。 如果訊息的 truncationStatus 不是 NOT_TRUNCATED,這將與訊息本身中的文字和 RTF 不同。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
屬性
|
property | string |
屬性。 |
|
|
執行緒識別碼
|
threadId | True | string |
執行緒識別碼。 |
|
訊息 ID
|
messageId | True | string |
訊息識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文字
|
text | string |
文字。 |
|
RTF 格式
|
richText | string |
瑞克文本。 |
取得單一頻道
擷取單一通道。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
頻道 ID
|
channelId | True | string |
通道識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
名稱
|
name | string |
名稱。 |
取得單一頻道帳戶
擷取單一通道帳戶。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
頻道帳戶ID
|
channelAccountId | True | string |
頻道帳戶識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
頻道 ID
|
channelId | string |
通道識別碼。 |
|
名稱
|
name | string |
名稱。 |
|
收件匣識別碼
|
inboxId | string |
收件匣識別碼。 |
|
Active
|
active | boolean |
是否活躍。 |
|
授權
|
authorized | boolean |
是否授權。 |
|
創建於
|
createdAt | string |
建立時。 |
|
類型
|
deliveryIdentifier.type | string |
型別。 |
|
價值觀
|
deliveryIdentifier.value | string |
值。 |
取得執行緒
擷取執行緒清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
之後
|
after | string |
之後連結。 |
|
|
限制
|
limit | string |
回應限制。 |
|
|
排序
|
sort | string |
排序順序。 |
|
|
收件匣識別碼
|
inboxId | string |
收件匣識別碼。 |
|
|
相關聯的連絡人識別碼
|
associatedContactId | string |
相關聯的連絡人識別碼。 |
|
|
執行緒狀態
|
threadStatus | string |
執行緒狀態。 |
|
|
最新時間戳記
|
latestMessageTimestampAfter | string |
之後的最新訊息時間戳記。 |
|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
屬性
|
property | string |
屬性。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
相關聯的連絡人識別碼
|
results.associatedContactId | string |
相關聯的連絡人識別碼。 |
|
創建於
|
results.createdAt | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
收件匣識別碼
|
results.inboxId | string |
收件匣識別碼。 |
|
垃圾郵件
|
results.spam | boolean |
無論是垃圾郵件。 |
|
地位
|
results.status | string |
狀態。 |
|
關閉時間
|
results.closedAt | string |
當關閉時。 |
|
最新訊息時間戳記
|
results.latestMessageTimestamp | string |
最新的訊息時間戳記。 |
|
最新訊息傳送時間戳記
|
results.latestMessageSentTimestamp | string |
最新傳送的訊息時間戳記。 |
|
最新收到的訊息時間戳記
|
results.latestMessageReceivedTimestamp | string |
收到的最新訊息時間戳記。 |
|
指派至
|
results.assignedTo | string |
分配給。 |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
之後
|
paging.next.after | string |
之後連結。 |
|
Link
|
paging.next.link | string |
鏈接。 |
取得演員
將動作者識別碼解析為基礎動作者和參與者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
屬性
|
property | string |
屬性。 |
|
|
輸入
|
inputs | array of string |
輸入。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成時間
|
completedAt | string |
完成後。 |
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
識別碼。 |
|
類型
|
results.type | string |
型別。 |
|
名稱
|
results.name | string |
名稱。 |
|
Email
|
results.email | string |
電子郵件地址。 |
|
阿凡達
|
results.avatar | string |
化身。 |
|
開始於
|
startedAt | string |
當開始時。 |
|
地位
|
status | string |
狀態。 |
|
請求時間
|
requestedAt | string |
當要求時。 |
取得討論串的訊息記錄
擷取執行緒的訊息歷程記錄清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
之後
|
after | string |
之後連結。 |
|
|
限制
|
limit | string |
回應限制。 |
|
|
排序
|
sort | string |
排序順序。 |
|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
屬性
|
property | string |
屬性。 |
|
|
執行緒識別碼
|
threadId | True | string |
執行緒識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Archived
|
results.archived | boolean |
是否存檔。 |
|
客戶類型
|
results.client.clientType | string |
用戶端類型。 |
|
整合應用程式ID
|
results.client.integrationAppId | string |
整合應用程式識別碼。 |
|
創建於
|
results.createdAt | string |
建立時。 |
|
作者
|
results.createdBy | string |
創建者。 |
|
方向
|
results.direction | string |
方向。 |
|
ID
|
results.id | string |
識別碼。 |
|
收件者
|
results.recipients | array of object | |
|
類型
|
results.recipients.deliveryIdentifier.type | string |
型別。 |
|
價值觀
|
results.recipients.deliveryIdentifier.value | string |
值。 |
|
執行者ID
|
results.recipients.actorId | string |
動作者識別碼。 |
|
名稱
|
results.recipients.name | string |
名稱。 |
|
收件者欄位
|
results.recipients.recipientField | string |
收件者欄位。 |
|
寄件者
|
results.senders | array of object | |
|
執行者ID
|
results.senders.actorId | string |
動作者識別碼。 |
|
名稱
|
results.senders.name | string |
名稱。 |
|
寄件者欄位
|
results.senders.senderField | string |
寄件者欄位。 |
|
類型
|
results.senders.deliveryIdentifier.type | string |
型別。 |
|
價值觀
|
results.senders.deliveryIdentifier.value | string |
值。 |
|
文字
|
results.text | string |
文字。 |
|
截斷狀態
|
results.truncationStatus | string |
截斷狀態。 |
|
類型
|
results.type | string |
型別。 |
|
更新於
|
results.updatedAt | string |
更新時。 |
|
RTF 格式
|
results.richText | string |
RTF 文本。 |
|
主旨
|
results.subject | string |
主題。 |
|
回覆身分證
|
results.inReplyToId | string |
回覆識別碼。 |
|
狀態類型
|
results.status.statusType | string |
狀態類型。 |
|
錯誤訊息
|
results.status.failureDetails.errorMessage | string |
錯誤訊息。 |
|
頻道 ID
|
results.channelId | string |
通道識別碼。 |
|
頻道帳戶ID
|
results.channelAccountId | string |
頻道帳戶識別碼。 |
|
交談討論串識別碼
|
results.conversationsThreadId | string |
交談執行緒識別碼。 |
|
之後
|
paging.next.after | string |
之後連結。 |
|
Link
|
paging.next.link | string |
鏈接。 |
取得頻道
擷取通道清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
之後
|
after | string |
之後連結。 |
|
|
限制
|
limit | string |
回應限制。 |
|
|
排序
|
sort | string |
排序順序。 |
|
|
頁面長度
|
defaultPageLength | string |
預設頁面長度。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
識別碼。 |
|
名稱
|
results.name | string |
名稱。 |
|
總數
|
total | integer |
總計。 |
|
之後
|
paging.next.after | string |
之後連結。 |
|
Link
|
paging.next.link | string |
鏈接。 |
取得頻道帳戶
擷取頻道帳戶清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
頻道 ID
|
channelId | string |
通道識別碼。 |
|
|
收件匣識別碼
|
inboxId | string |
收件匣識別碼。 |
|
|
之後
|
after | string |
之後連結。 |
|
|
限制
|
limit | string |
回應限制。 |
|
|
排序
|
sort | string |
排序順序。 |
|
|
頁面長度
|
defaultPageLength | string |
預設頁面長度。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
識別碼。 |
|
頻道 ID
|
results.channelId | string |
通道識別碼。 |
|
名稱
|
results.name | string |
名稱。 |
|
收件匣識別碼
|
results.inboxId | string |
收件匣識別碼。 |
|
Active
|
results.active | boolean |
是否活躍。 |
|
授權
|
results.authorized | boolean |
是否授權。 |
|
創建於
|
results.createdAt | string |
建立時。 |
|
類型
|
results.deliveryIdentifier.type | string |
型別。 |
|
價值觀
|
results.deliveryIdentifier.value | string |
值。 |
|
總數
|
total | integer |
總計。 |
|
之後
|
paging.next.after | string |
之後連結。 |
|
Link
|
paging.next.link | string |
鏈接。 |
封存一個線程
封存單一執行緒。 該線程將在置於存檔狀態 30 天後永久刪除。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
執行緒識別碼
|
threadId | True | string |
執行緒識別碼。 |
傳回
- response
- string
更新執行緒
更新單一執行緒。 可以更新執行緒的狀態,也可以還原執行緒。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
執行緒識別碼
|
threadId | True | string |
執行緒識別碼。 |
|
地位
|
status | string |
狀態。 |
|
|
Archived
|
archived | boolean |
是否存檔。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
相關聯的連絡人識別碼
|
associatedContactId | string |
相關聯的連絡人識別碼。 |
|
創建於
|
createdAt | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
收件匣識別碼
|
inboxId | string |
收件匣識別碼。 |
|
垃圾郵件
|
spam | boolean |
垃圾郵件。 |
|
地位
|
status | string |
狀態。 |
|
關閉時間
|
closedAt | string |
當關閉時。 |
|
最新訊息時間戳記
|
latestMessageTimestamp | string |
最新的訊息時間戳記。 |
|
最新訊息傳送時間戳記
|
latestMessageSentTimestamp | string |
最新傳送的訊息時間戳記。 |
|
最新收到的訊息時間戳記
|
latestMessageReceivedTimestamp | string |
收到的最新訊息時間戳記。 |
|
指派至
|
assignedTo | string |
分配給。 |
|
Archived
|
archived | boolean |
是否存檔。 |
產生權杖
產生新的訪客識別權杖。 每次呼叫此端點時,此權杖都是唯一的,即使使用相同的電子郵件地址呼叫也一樣。 該代幣是臨時的,將在 12 小時後過期。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Email
|
string |
電子郵件地址。 |
||
|
名字
|
firstName | string |
第一個名字。 |
|
|
姓氏
|
lastName | string |
姓氏。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
代幣
|
token | string |
權杖。 |
定義
字串
這是基本資料類型「string」。