HubSpot Conversations V2 (Independent Publisher) (プレビュー)
HubSpot の会話サービスを使用して、会話の受信トレイ、チャネル、メッセージの管理と操作ができます。
このコネクタは、次の製品および地域で利用可能です:
Service | クラス | 地域 |
---|---|---|
Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
お問い合わせ先 | |
---|---|
件名 | Troy Taylor |
[URL] | https://www.hitachisolutions.com |
メール | ttaylor@hitachisolutions.com |
Connector Metadata | |
---|---|
発行者 | Troy Taylor |
Web サイト | https://www.hubspot.com/products/crm/conversations |
プライバシー ポリシー | https://legal.hubspot.com/privacy-policy |
カテゴリー | マーケティング、営業、CRM |
接続の作成
コネクタは、次の認証タイプをサポートしています:
既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
件名 | タイプ | Description | Required |
---|---|---|---|
アクセス トークン ('Bearer YOUR_ACCESS_TOKEN' の形式) | securestring | この API のアクセストークン ('Bearer YOUR_ACCESS_TOKEN' 形式) | True |
調整制限
名前 | 呼び出し | 更新期間 |
---|---|---|
接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
アクターを取得する |
アクターの識別子を基になるアクターと参加者に対して解決します。 |
スレッドにメッセージを送信する |
現在のタイムスタンプでスレッドに新しいメッセージを送信します。 |
スレッドのメッセージ履歴を取得する |
スレッドのメッセージ履歴の一覧を取得します。 |
スレッドをアーカイブする |
単一のスレッドをアーカイブします。 スレッドはアーカイブ状態になってから 30 日後に完全に削除されます。 |
スレッドを取得する |
スレッドの一覧を取得します。 |
スレッドを更新する |
単一のスレッドを更新します。 スレッドのステータスを更新するか、スレッドを復元することができます。 |
チャネル アカウントを取得する |
チャネル アカウントの一覧を取得します。 |
チャネルを取得する |
チャネルの一覧を取得します。 |
トークンを生成 |
新しい訪問者識別トークンを生成します。 このトークンは、同じメール アドレスで呼び出された場合でも、このエンドポイントが呼び出されるたびに一意になります。 このトークンは一時的なもので、12 時間後に期限切れになります。 |
会話受信ボックスを取得する |
会話受信ボックスの一覧を取得します。 |
単一のアクターを取得する |
単一のアクターを取得します。 |
単一のスレッドを取得する |
単一のスレッドを取得します。 |
単一のチャネル アカウントを取得する |
単一のチャネル アカウントを取得します。 |
単一のチャネルを取得する |
単一のチャネルを取得します。 |
単一のメッセージを取得する |
単一のメッセージを取得します。 |
単一の会話受信トレイを取得する |
単一の会話受信トレイを取得します。 |
単一メッセージの元のコンテンツを取得する |
メッセージの元の完全なテキストとリッチ テキスト本文を返します。 メッセージの truncationStatus が NOT_TRUNCATED 以外の場合、これはメッセージ自体のテキストやリッチ テキストとは異なります。 |
アクターを取得する
アクターの識別子を基になるアクターと参加者に対して解決します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
property
|
property | string |
プロパティ。 |
|
入力
|
inputs | array of string |
入力。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
完了日時
|
completedAt | string |
完了日時。 |
Results
|
results | array of object | |
ID
|
results.id | string |
識別子。 |
タイプ
|
results.type | string |
種類。 |
件名
|
results.name | string |
名前。 |
メール
|
results.email | string |
メール アドレス。 |
アバター
|
results.avatar | string |
アバター。 |
開始した
|
startedAt | string |
開始日時。 |
Status
|
status | string |
状態。 |
依頼者
|
requestedAt | string |
要求時刻。 |
スレッドにメッセージを送信する
現在のタイムスタンプでスレッドに新しいメッセージを送信します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
スレッド ID
|
threadId | True | string |
スレッド識別子。 |
Attachments
|
attachments | array of |
添付ファイル オブジェクト。 |
|
チャネル アカウント ID
|
channelAccountId | string |
チャネル アカウント識別子。 |
|
Channel ID
|
channelId | string |
チャネル識別子。 |
|
タイプ
|
type | string |
種類。 |
|
価値
|
value | string |
値。 |
|
アクター ID
|
actorId | string |
アクター識別子。 |
|
件名
|
name | string |
名前。 |
|
受信者フィールド
|
recipientField | string |
受信者フィールド。 |
|
タイプ
|
type | string |
種類。 |
|
価値
|
value | string |
値。 |
|
送信者アクター ID
|
senderActorId | string |
送信者アクター識別子。 |
|
Text
|
text | string |
テキスト。 |
|
タイプ
|
type | string |
種類。 |
|
リッチ テキスト
|
richText | string |
リッチ テキスト。 |
|
サブジェクト
|
subject | string |
件名。 |
戻り値
- 返答
- string
スレッドのメッセージ履歴を取得する
スレッドのメッセージ履歴の一覧を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
後
|
after | string |
リンクの後。 |
|
Limit
|
limit | string |
応答制限。 |
|
並び替え
|
sort | string |
並べ替え順。 |
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
property
|
property | string |
プロパティ。 |
|
スレッド ID
|
threadId | True | string |
スレッド識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
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 |
識別子。 |
Recipients
|
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 |
値。 |
Text
|
results.text | string |
テキスト。 |
切り捨ての状態
|
results.truncationStatus | string |
切り捨ての状態。 |
タイプ
|
results.type | string |
種類。 |
更新日
|
results.updatedAt | string |
更新時刻。 |
リッチ テキスト
|
results.richText | string |
リッチ テキスト。 |
サブジェクト
|
results.subject | string |
件名。 |
返信先 ID
|
results.inReplyToId | string |
返信先の識別子。 |
状態の種類
|
results.status.statusType | string |
状態タイプ。 |
エラー メッセージ
|
results.status.failureDetails.errorMessage | string |
エラー メッセージ。 |
Channel ID
|
results.channelId | string |
チャネル識別子。 |
チャネル アカウント ID
|
results.channelAccountId | string |
チャネル アカウント識別子。 |
会話スレッド ID
|
results.conversationsThreadId | string |
会話スレッド識別子。 |
後
|
paging.next.after | string |
リンクの後。 |
Link
|
paging.next.link | string |
リンク。 |
スレッドをアーカイブする
単一のスレッドをアーカイブします。 スレッドはアーカイブ状態になってから 30 日後に完全に削除されます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
スレッド ID
|
threadId | True | string |
スレッド識別子。 |
戻り値
- 返答
- string
スレッドを取得する
スレッドの一覧を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
後
|
after | string |
リンクの後。 |
|
Limit
|
limit | string |
応答制限。 |
|
並び替え
|
sort | string |
並べ替え順。 |
|
受信トレイ ID
|
inboxId | string |
受信トレイ識別子。 |
|
関連取引先担当者 ID
|
associatedContactId | string |
関連取引先担当者識別子。 |
|
スレッドの状態
|
threadStatus | string |
スレッドの状態。 |
|
最終タイムスタンプ
|
latestMessageTimestampAfter | string |
以降の最新のメッセージ タイムスタンプ。 |
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
property
|
property | string |
プロパティ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Results
|
results | array of object | |
関連取引先担当者 ID
|
results.associatedContactId | string |
関連取引先担当者識別子。 |
作成日
|
results.createdAt | string |
作成日時。 |
ID
|
results.id | string |
識別子。 |
受信トレイ ID
|
results.inboxId | string |
受信トレイ識別子。 |
スパム
|
results.spam | boolean |
スパムかどうか。 |
Status
|
results.status | string |
状態。 |
Closed At
|
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 |
リンク。 |
スレッドを更新する
単一のスレッドを更新します。 スレッドのステータスを更新するか、スレッドを復元することができます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
スレッド ID
|
threadId | True | string |
スレッド識別子。 |
Status
|
status | string |
状態。 |
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
関連取引先担当者 ID
|
associatedContactId | string |
関連取引先担当者識別子。 |
作成日
|
createdAt | string |
作成日時。 |
ID
|
id | string |
識別子。 |
受信トレイ ID
|
inboxId | string |
受信トレイ識別子。 |
スパム
|
spam | boolean |
スパム。 |
Status
|
status | string |
状態。 |
Closed At
|
closedAt | string |
クローズ時刻。 |
最新メッセージ タイムスタンプ
|
latestMessageTimestamp | string |
最新のメッセージのタイムスタンプ。 |
最終送信メッセージ タイムスタンプ
|
latestMessageSentTimestamp | string |
最後に送信したメッセージのタイムスタンプ。 |
最終受信メッセージ タイムスタンプ
|
latestMessageReceivedTimestamp | string |
最後に受信したメッセージのタイムスタンプ |
割り当て先
|
assignedTo | string |
割り当て先ユーザー。 |
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
チャネル アカウントを取得する
チャネル アカウントの一覧を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Channel ID
|
channelId | string |
チャネル識別子。 |
|
受信トレイ ID
|
inboxId | string |
受信トレイ識別子。 |
|
後
|
after | string |
リンクの後。 |
|
Limit
|
limit | string |
応答制限。 |
|
並び替え
|
sort | string |
並べ替え順。 |
|
ページの長さ
|
defaultPageLength | string |
既定のページの長さ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Results
|
results | array of object | |
ID
|
results.id | string |
識別子。 |
Channel ID
|
results.channelId | string |
チャネル識別子。 |
件名
|
results.name | string |
名前。 |
受信トレイ ID
|
results.inboxId | string |
受信トレイ識別子。 |
アクティブです
|
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 |
リンク。 |
チャネルを取得する
チャネルの一覧を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
後
|
after | string |
リンクの後。 |
|
Limit
|
limit | string |
応答制限。 |
|
並び替え
|
sort | string |
並べ替え順。 |
|
ページの長さ
|
defaultPageLength | string |
既定のページの長さ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Results
|
results | array of object | |
ID
|
results.id | string |
識別子。 |
件名
|
results.name | string |
名前。 |
トータル
|
total | integer |
総数。 |
後
|
paging.next.after | string |
リンクの後。 |
Link
|
paging.next.link | string |
リンク。 |
トークンを生成
新しい訪問者識別トークンを生成します。 このトークンは、同じメール アドレスで呼び出された場合でも、このエンドポイントが呼び出されるたびに一意になります。 このトークンは一時的なもので、12 時間後に期限切れになります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
メール
|
string |
メール アドレス。 |
||
First Name
|
firstName | string |
名。 |
|
Last Name
|
lastName | string |
姓。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Token
|
token | string |
トークンです。 |
会話受信ボックスを取得する
会話受信ボックスの一覧を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
後
|
after | string |
リンクの後。 |
|
Limit
|
limit | string |
応答制限。 |
|
並び替え
|
sort | string |
並べ替え順。 |
|
ページの長さ
|
defaultPageLength | string |
既定のページの長さ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
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 |
リンク。 |
単一のアクターを取得する
単一のアクターを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
property
|
property | string |
プロパティ。 |
|
アクター ID
|
actorId | True | string |
アクター識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
タイプ
|
type | string |
種類。 |
件名
|
name | string |
名前。 |
メール
|
string |
メール アドレス。 |
|
アバター
|
avatar | string |
アバター。 |
単一のスレッドを取得する
単一のスレッドを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
property
|
property | string |
プロパティ。 |
|
スレッド ID
|
threadId | True | string |
スレッド識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
関連取引先担当者 ID
|
associatedContactId | string |
関連取引先担当者識別子。 |
作成日
|
createdAt | string |
作成日時。 |
ID
|
id | string |
識別子。 |
受信トレイ ID
|
inboxId | string |
受信トレイ識別子。 |
スパム
|
spam | boolean |
スパム。 |
Status
|
status | string |
状態。 |
Closed At
|
closedAt | string |
クローズ時刻。 |
最新メッセージ タイムスタンプ
|
latestMessageTimestamp | string |
最新のメッセージのタイムスタンプ。 |
最終送信メッセージ タイムスタンプ
|
latestMessageSentTimestamp | string |
最後に送信したメッセージのタイムスタンプ。 |
最終受信メッセージ タイムスタンプ
|
latestMessageReceivedTimestamp | string |
最後に受信したメッセージのタイムスタンプ |
割り当て先
|
assignedTo | string |
割り当て先ユーザー。 |
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
単一のチャネル アカウントを取得する
単一のチャネル アカウントを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
チャネル アカウント ID
|
channelAccountId | True | string |
チャネル アカウント識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
Channel ID
|
channelId | string |
チャネル識別子。 |
件名
|
name | string |
名前。 |
受信トレイ ID
|
inboxId | string |
受信トレイ識別子。 |
アクティブです
|
active | boolean |
アクティブかどうか。 |
承認済み
|
authorized | boolean |
認可されているかどうか。 |
作成日
|
createdAt | string |
作成日時。 |
タイプ
|
deliveryIdentifier.type | string |
種類。 |
価値
|
deliveryIdentifier.value | string |
値。 |
単一のチャネルを取得する
単一のチャネルを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Channel ID
|
channelId | True | string |
チャネル識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
単一のメッセージを取得する
単一のメッセージを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
property
|
property | string |
プロパティ。 |
|
スレッド ID
|
threadId | True | string |
スレッド識別子。 |
メッセージ ID
|
messageId | True | string |
メッセージの識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
価値
|
value | string |
値。 |
単一の会話受信トレイを取得する
単一の会話受信トレイを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
受信トレイ ID
|
inboxId | True | string |
受信トレイ識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
作成日
|
createdAt | string |
作成日時。 |
更新日
|
updatedAt | string |
更新時刻。 |
単一メッセージの元のコンテンツを取得する
メッセージの元の完全なテキストとリッチ テキスト本文を返します。 メッセージの truncationStatus が NOT_TRUNCATED 以外の場合、これはメッセージ自体のテキストやリッチ テキストとは異なります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
property
|
property | string |
プロパティ。 |
|
スレッド ID
|
threadId | True | string |
スレッド識別子。 |
メッセージ ID
|
messageId | True | string |
メッセージの識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Text
|
text | string |
テキスト。 |
リッチ テキスト
|
richText | string |
リッチ テキスト。 |
定義
string
これは基本的なデータ型 '文字列' です。