Courier (独立系発行者) (プレビュー)
Courier は、開発チームが製品によって引き起こされるすべてのコミュニケーション (電子メール、チャット、アプリ内、SMS、プッシュなど) を 1 か所で管理するためのサービスおよび Web スタジオです。 Courier は、優れた通知エクスペリエンスを提供したい開発者向けに構築されています。
このコネクタは、次の製品および地域で利用可能です:
Service | クラス | 地域 |
---|---|---|
Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
お問い合わせ先 | |
---|---|
件名 | Troy Taylor |
[URL] | https://www.hitachisolutions.com |
メール | ttaylor@hitachisolutions.com |
Connector Metadata | |
---|---|
発行者 | Troy Taylor |
Web サイト | https://www.courier.com/ |
プライバシー ポリシー | https://www.courier.com/privacy/ |
カテゴリー | コミュニケーション: ソーシャル メディア |
このコネクタは、次の認証タイプをサポートしています:
既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
件名 | タイプ | Description | Required |
---|---|---|---|
トークン ('Bearer yourToken' 形式) | securestring | この API に対するトークン ('Bearer yourToken' の形式) | True |
名前 | 呼び出し | 更新期間 |
---|---|---|
接続ごとの API 呼び出し | 100 | 60 秒 |
すべての受信者リストを取得 |
すべての受信者リストのリストを取得します。 |
すべての対象ユーザーを一覧表示 |
アカウントに関連付けられているすべての対象ユーザーを取得します。 |
すべての監査イベントを取得 |
監査イベントのリストを取得します。 |
アドホック オートメーションを実行 |
アドホック実行でオートメーションを呼び出します。 |
テンプレート化されたオートメーションを実行 |
オートメーション テンプレートからオートメーション実行を呼び出します。 |
ブランドを一覧表示 |
ブランドの一覧を取得 |
ブランドを作成する |
提供された設定から新しいブランドを作成します。 |
ブランドを取得する |
識別子によって特定のブランドを取得します。 |
プロファイルの作成 |
指定された値を既存のプロファイルとマージするか、プロファイルがまだ存在しない場合は新しいプロファイルを作成します。 |
プロファイルの更新 |
プロファイルの一部を更新します。 |
プロファイルを削除 |
指定された受信者プロファイルを削除します。 |
プロファイルを取得 |
指定された受信者プロファイルを取得します。 |
メッセージのアーカイブ |
メッセージをアーカイブするよう要求します。 |
メッセージのコンテンツを取得 |
以前に送信されたメッセージの内容を取得します。 |
メッセージの取得 |
メッセージのステータスを取得します。 |
メッセージの履歴を取得 |
以前に送信されたメッセージのイベントを取得します。 |
メッセージの送信 |
1 人以上の受信者にメッセージを送信します。 |
メッセージを一覧表示 |
以前に送信されたメッセージのステータスを取得します。 |
ユーザーを一括ジョブに追加する |
ユーザー データを一括ジョブに取り込みます。 |
リストからユーザー登録を解除 |
リストおよび受信者識別子に基づいて、リストへのサブスクリプションを削除します。 |
リストにサブスクライバーを追加する |
追加のサブスクライバーをリストに追加します。 |
リストのサブスクリプションを取得 |
リストのサブスクリプションを取得します。 |
リストの削除 |
リスト識別子でリストを削除します。 |
リストの復元 |
識別子に基づいて既存のリストを復元します。 |
リストを取得 |
リストの項目を取得します。 |
リストを更新する |
既存のリストを作成するか、指定された値で置き換えます。 |
一括ジョブのユーザーを取得する |
一括ジョブのユーザーを取得します。 |
一括ジョブを作成する |
指定されたメッセージ パラメータの一括ジョブを作成します。 |
一括ジョブを取得 |
一括ジョブに関する情報を取得します。 |
一括ジョブを実行 |
一括ジョブの実行を開始します。 |
対象ユーザー メンバーを一覧表示 |
対象ユーザーのメンバーのリストを取得します。 |
対象ユーザーの作成または更新 |
指定されたパラメーターとフィルターに基づいて対象ユーザーを作成または更新します。 |
対象ユーザーを取得 |
指定された対象ユーザーを識別子によって返します。 |
対象ユーザーを選択する |
指定された受信者対象ユーザーを削除します。 |
監査イベントを取得 |
識別子によって特定の監査イベントを取得します。 |
通知を一覧表示 |
通知のリストを取得 |
すべての受信者リストのリストを取得します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Cursor
|
paging.cursor | string |
カーソル。 |
その他
|
paging.more | boolean |
さらにないかどうか。 |
Results
|
results | array of object | |
Created
|
results.created | string |
作成日。 |
ID
|
results.id | string |
識別子。 |
件名
|
results.name | string |
名前。 |
更新済み
|
results.updated | string |
更新日。 |
アカウントに関連付けられているすべての対象ユーザーを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Cursor
|
cursor | string |
カーソル。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
アイテム
|
items | array of object | |
ID
|
items.id | string |
識別子。 |
件名
|
items.name | string |
名前。 |
Description
|
items.description | string |
説明設定。 |
Operator
|
items.filter.operator | string |
演算子です。 |
価値
|
items.filter.value | string |
値。 |
Path
|
items.filter.path | string |
パス。 |
Cursor
|
paging.cursor | string |
カーソル。 |
その他
|
paging.more | boolean |
さらにないかどうか。 |
監査イベントのリストを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Cursor
|
cursor | string |
カーソル。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Cursor
|
paging.cursor | string |
カーソル。 |
その他
|
paging.more | boolean |
さらにないかどうか。 |
Results
|
results | array of object | |
監査イベント ID
|
results.auditEventId | string |
監査イベント識別子。 |
ID
|
results.actor.id | string |
識別子。 |
メール
|
results.actor.email | string |
メール アドレス。 |
ID
|
results.target.id | string |
識別子。 |
メール
|
results.target.email | string |
メール アドレス。 |
Source
|
results.source | string |
ソース。 |
Timestamp
|
results.timestamp | string |
タイムスタンプ。 |
タイプ
|
results.type | string |
種類。 |
アドホック実行でオートメーションを呼び出します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
キャンセル トークン
|
cancelation_token | string |
キャンセル トークン。 |
|
ブランド
|
brand | string |
ブランド。 |
|
Template
|
template | string |
テンプレートです。 |
|
Recipient
|
recipient | string |
受信者。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
実行 ID
|
runId | string |
実行識別子。 |
オートメーション テンプレートからオートメーション実行を呼び出します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テンプレート ID
|
templateId | True | string |
テンプレートの識別子。 |
ブランド
|
brand | string |
ブランド。 |
|
Template
|
template | string |
テンプレートです。 |
|
Recipient
|
recipient | string |
受信者。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
実行 ID
|
runId | string |
実行識別子。 |
ブランドの一覧を取得
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Cursor
|
cursor | string |
カーソル。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Cursor
|
paging.cursor | string |
カーソル。 |
その他
|
paging.more | boolean |
さらにないかどうか。 |
Results
|
results | array of object | |
Created
|
results.created | integer |
作成日。 |
ID
|
results.id | string |
識別子。 |
件名
|
results.name | string |
名前。 |
Published
|
results.published | integer |
公開された時点。 |
更新済み
|
results.updated | integer |
更新日。 |
Version
|
results.version | string |
バージョン。 |
主要
|
results.settings.colors.primary | string |
主要。 |
予備
|
results.settings.colors.secondary | string |
予備。 |
三次
|
results.settings.colors.tertiary | string |
三次。 |
バーの色
|
results.settings.email.header.barColor | string |
バーの色。 |
HREF
|
results.settings.email.header.logo.href | string |
HREF。 |
Image
|
results.settings.email.header.logo.image | string |
画像。 |
Markdown
|
results.settings.email.footer.markdown | string |
Markdown。 |
[URL]
|
results.settings.email.footer.social.facebook.url | string |
URL アドレス。 |
[URL]
|
results.settings.email.footer.social.instagram.url | string |
URL アドレス。 |
[URL]
|
results.settings.email.footer.social.linkedin.url | string |
URL アドレス。 |
[URL]
|
results.settings.email.footer.social.medium.url | string |
URL アドレス。 |
[URL]
|
results.settings.email.footer.social.twitter.url | string |
URL アドレス。 |
メッセージ アイコンの無効化
|
results.settings.inapp.disableMessageIcon | boolean |
メッセージアイコンを無効にするかどうか。 |
Placement
|
results.settings.inapp.placement | string |
配置。 |
アイテム
|
results.snippets.items | array of string |
項目。 |
提供された設定から新しいブランドを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ID
|
id | string |
識別子。 |
|
件名
|
name | True | string |
名前。 |
主要
|
primary | string |
主要。 |
|
予備
|
secondary | string |
予備。 |
|
三次
|
tertiary | string |
三次。 |
|
バーの色
|
barColor | string |
バーの色。 |
|
HREF
|
href | string |
HREF。 |
|
Image
|
image | string |
画像。 |
|
Markdown
|
markdown | string |
Markdown。 |
|
[URL]
|
url | string |
URL アドレス。 |
|
[URL]
|
url | string |
URL アドレス。 |
|
[URL]
|
url | string |
URL アドレス。 |
|
[URL]
|
url | string |
URL アドレス。 |
|
[URL]
|
url | string |
URL アドレス。 |
|
メッセージ アイコンの無効化
|
disableMessageIcon | boolean |
メッセージアイコンを無効にするかどうか。 |
|
Placement
|
placement | string |
配置。 |
|
アイテム
|
items | array of string |
項目。 |
戻り値
- 返答
- string
識別子によって特定のブランドを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ブランド ID
|
brand_id | True | string |
ブランドの識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Created
|
created | integer |
作成日。 |
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
Published
|
published | integer |
公開された時点。 |
更新済み
|
updated | integer |
更新済み。 |
Version
|
version | string |
バージョン。 |
主要
|
settings.colors.primary | string |
主要。 |
予備
|
settings.colors.secondary | string |
予備。 |
三次
|
settings.colors.tertiary | string |
三次。 |
バーの色
|
settings.email.header.barColor | string |
バーの色。 |
HREF
|
settings.email.header.logo.href | string |
HREF。 |
Image
|
settings.email.header.logo.image | string |
画像。 |
Markdown
|
settings.email.footer.markdown | string |
Markdown。 |
[URL]
|
settings.email.footer.social.facebook.url | string |
URL アドレス。 |
[URL]
|
settings.email.footer.social.instagram.url | string |
URL アドレス。 |
[URL]
|
settings.email.footer.social.linkedin.url | string |
URL アドレス。 |
[URL]
|
settings.email.footer.social.medium.url | string |
URL アドレス。 |
[URL]
|
settings.email.footer.social.twitter.url | string |
URL アドレス。 |
メッセージ アイコンの無効化
|
settings.inapp.disableMessageIcon | boolean |
メッセージアイコンを無効にするかどうか。 |
Placement
|
settings.inapp.placement | string |
配置。 |
アイテム
|
snippets.items | array of string |
項目。 |
指定された値を既存のプロファイルとマージするか、プロファイルがまだ存在しない場合は新しいプロファイルを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
受信者 ID
|
recipient_id | True | string |
受信者識別子。 |
メール
|
string |
メール アドレス。 |
||
Phone Number
|
phone_number | string |
電話番号。 |
|
書式設定済み
|
formatted | string |
書式設定された住所。 |
|
住所
|
street_address | string |
番地。 |
|
ローカリティ
|
locality | string |
地域。 |
|
Region
|
region | string |
リージョン。 |
|
Postal Code
|
postal_code | string |
郵便番号。 |
|
Country
|
country | string |
国。 |
|
生年月日
|
birthdate | string |
生年月日。 |
|
メールアドレス検証済み
|
email_verified | boolean |
メールアドレスが検証済みかどうか。 |
|
電話番号検証済み
|
phone_number_verified | boolean |
電話番号が検証済みかどうか。 |
|
姓
|
given_name | string |
名。 |
|
Middle Name
|
middle_name | string |
ミドル ネーム。 |
|
Family Name
|
family_name | string |
姓。 |
|
希望する名前
|
preferred_name | string |
希望する名前。 |
|
Gender
|
gender | string |
性別。 |
|
Locale
|
locale | string |
ロケール。 |
|
写真
|
picture | string |
写真。 |
|
Profile
|
profile | string |
プロファイル。 |
|
Sub
|
sub | string |
サブ。 |
|
更新日
|
updated_at | string |
更新時刻。 |
|
Web サイト
|
website | string |
Web サイト。 |
|
ゾーン情報
|
zoneinfo | string |
ゾーン情報。 |
|
指名されたユーザー
|
named_user | string |
指名されたユーザー。 |
|
デバイスの種類
|
device_types | array of string |
デバイスの種類。 |
|
APN
|
apn | string |
APN。 |
|
ターゲット ARN
|
target_arn | string |
ターゲット ARN。 |
|
Channel ID
|
channel_id | string |
チャネル識別子。 |
|
User ID
|
user_id | string |
ユーザー識別子。 |
|
Token
|
token | string |
トークンです。 |
|
トークン
|
tokens | array of string |
トークン。 |
|
Facebook PS ID
|
facebookPSID | string |
Facebook PS 識別子。 |
|
Firebase トークン
|
firebaseToken | string |
Firebase トークン。 |
|
送信者
|
from | string |
送信者。 |
|
ID
|
id | string |
識別子。 |
|
User ID
|
user_id | string |
ユーザー識別子。 |
|
会話 ID
|
conversation_id | string |
会話識別子。 |
|
Tenant ID
|
tenant_id | string |
テナント識別子。 |
|
サービス URL
|
service_url | string |
サービス URL アドレス。 |
|
OneSignal プレーヤー ID
|
oneSignalPlayerID | string |
OneSignal プレーヤーの識別子。 |
|
Access Token
|
access_token | string |
アクセス トークン。 |
|
Channel
|
channel | string |
チャネル。 |
|
メール
|
string |
メール アドレス。 |
||
User ID
|
user_id | string |
ユーザー識別子。 |
|
[URL]
|
url | string |
URL アドレス。 |
|
[URL]
|
url | string |
URL アドレス。 |
|
メソッド
|
method | string |
メソッド。 |
|
Mode
|
mode | string |
モード。 |
|
Username
|
username | string |
ユーザー名。 |
|
Password
|
password | string |
パスワード。 |
|
Token
|
token | string |
トークンです。 |
|
Profile
|
profile | string |
プロファイル。 |
戻り値
- 返答
- string
プロファイルの一部を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
受信者 ID
|
recipient_id | True | string |
受信者識別子。 |
オペレーション
|
op | string |
操作。 |
|
Path
|
path | string |
パス。 |
|
価値
|
value | string |
値。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Status
|
status | string |
状態。 |
指定された受信者プロファイルを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
受信者 ID
|
recipient_id | True | string |
受信者識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Status
|
status | string |
状態。 |
指定された受信者プロファイルを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
受信者 ID
|
recipient_id | True | string |
受信者識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
メール
|
profile.email | string |
メール アドレス。 |
Phone Number
|
profile.phone_number | string |
電話番号。 |
以前に送信されたメッセージの内容を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
メッセージ ID
|
message_id | True | string |
メッセージの識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Results
|
results | array of object | |
Channel
|
results.channel | string |
チャネル。 |
Channel ID
|
results.channel_id | string |
チャネル識別子。 |
HTML
|
results.content.html | string |
HTML。 |
サブジェクト
|
results.content.subject | string |
件名。 |
Text
|
results.content.text | string |
テキスト。 |
ブロック
|
results.content.blocks | array of object | |
タイプ
|
results.content.blocks.type | string |
種類。 |
Text
|
results.content.blocks.text | string |
テキスト。 |
メッセージのステータスを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
メッセージ ID
|
message_id | True | string |
メッセージの識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
Status
|
status | string |
状態。 |
キューに登録済み
|
enqueued | integer |
キューに登録されたもの。 |
送信数
|
sent | integer |
送信されたもの。 |
Delivered
|
delivered | integer |
配送されたもの。 |
開封数
|
opened | integer |
開かれたもの。 |
クリック済み
|
clicked | integer |
クリックされたもの。 |
Recipient
|
recipient | string |
受信者。 |
イベント
|
event | string |
イベント。 |
通知
|
notification | string |
通知。 |
Error
|
error | string |
エラーです。 |
Reason
|
reason | string |
理由。 |
プロバイダー
|
providers | array of object | |
送信数
|
providers.sent | integer |
送信されたもの。 |
Delivered
|
providers.delivered | integer |
配送されたもの。 |
クリック済み
|
providers.clicked | integer |
クリックされたもの。 |
開封数
|
providers.opened | integer |
開かれたもの。 |
Error
|
providers.error | string |
エラーです。 |
Provider
|
providers.provider | string |
プロバイダー。 |
Status
|
providers.status | string |
状態。 |
以前に送信されたメッセージのイベントを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
メッセージ ID
|
message_id | True | string |
メッセージの識別子。 |
タイプ
|
type | string |
種類。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Results
|
results | array of object | |
件名
|
results.data.name | string |
名前。 |
イベント
|
results.event | string |
イベント。 |
Recipient
|
results.recipient | string |
受信者。 |
TS
|
results.ts | integer |
TS。 |
タイプ
|
results.type | string |
種類。 |
イベント ID
|
results.event_id | string |
イベント識別子。 |
通知 ID
|
results.notification_id | string |
通知識別子。 |
ID
|
results.channel.id | string |
識別子。 |
ID
|
results.integration.id | string |
識別子。 |
Provider
|
results.integration.provider | string |
プロバイダー。 |
1 人以上の受信者にメッセージを送信します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
べき等
|
idempotency | True | string |
べき等キー。 |
肩書き
|
title | string |
肩書き。 |
|
Body
|
body | string |
ボディ。 |
|
User ID
|
user_id | string |
ユーザー識別子。 |
|
リスト ID
|
list_id | string |
リスト識別子です。 |
|
対象ユーザー ID
|
audience_id | string |
対象ユーザー識別子。 |
|
メール
|
string |
メール アドレス。 |
||
Phone Number
|
phone_number | string |
電話番号。 |
|
Locale
|
locale | string |
ロケール。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
要求 ID
|
requestId | string |
要求識別子。 |
以前に送信されたメッセージのステータスを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
Cursor
|
cursor | string |
カーソル。 |
|
イベント
|
event | string |
イベント。 |
|
リスト
|
list | string |
リストです。 |
|
メッセージ ID
|
messageId | string |
メッセージの識別子。 |
|
通知
|
notification | string |
通知。 |
|
Recipient
|
recipient | string |
受信者。 |
|
Status
|
status | string |
状態。 |
|
Tags
|
tags | string |
タグ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Cursor
|
paging.cursor | string |
カーソル。 |
その他
|
paging.more | boolean |
さらにないかどうか。 |
Results
|
results | array of object | |
ID
|
results.id | string |
識別子。 |
Status
|
results.status | string |
状態。 |
キューに登録済み
|
results.enqueued | integer |
キューに登録されたもの。 |
送信数
|
results.sent | integer |
送信されたもの。 |
Delivered
|
results.delivered | integer |
配送されたもの。 |
開封数
|
results.opened | integer |
開かれたもの。 |
クリック済み
|
results.clicked | integer |
クリックされたもの。 |
Recipient
|
results.recipient | string |
受信者。 |
イベント
|
results.event | string |
イベント。 |
通知
|
results.notification | string |
通知。 |
Error
|
results.error | string |
エラーです。 |
Reason
|
results.reason | string |
理由。 |
ユーザー データを一括ジョブに取り込みます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ジョブ ID
|
job_id | True | string |
ジョブ識別子。 |
Recipient
|
recipient | string |
受信者。 |
戻り値
- 返答
- string
リストおよび受信者識別子に基づいて、リストへのサブスクリプションを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
リスト ID
|
list_id | True | string |
リスト識別子です。 |
受信者 ID
|
recipient_id | True | string |
受信者識別子。 |
戻り値
- 返答
- string
追加のサブスクライバーをリストに追加します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
リスト ID
|
list_id | True | string |
リスト識別子です。 |
受信者 ID
|
recipientId | string |
受信者識別子。 |
戻り値
- 返答
- string
リストのサブスクリプションを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
リスト ID
|
list_id | True | string |
リスト識別子です。 |
Cursor
|
cursor | string |
カーソル。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Cursor
|
paging.cursor | string |
カーソル。 |
その他
|
paging.more | boolean |
さらにないかどうか。 |
アイテム
|
items | array of object | |
受信者 ID
|
items.recipientId | string |
受信者識別子。 |
Created
|
items.created | string |
作成日。 |
リストの項目を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
リスト ID
|
list_id | True | string |
リスト識別子です。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Created
|
created | string |
作成日。 |
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
更新済み
|
updated | string |
更新済み。 |
既存のリストを作成するか、指定された値で置き換えます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
リスト ID
|
list_id | True | string |
リスト識別子です。 |
件名
|
name | string |
名前。 |
戻り値
- 返答
- string
一括ジョブのユーザーを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ジョブ ID
|
job_id | True | string |
ジョブ識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
アイテム
|
items | array of object | |
Recipient
|
items.recipient | string |
受信者。 |
メール
|
items.email | string |
メール アドレス。 |
Locale
|
items.locale | string |
ロケール。 |
Cursor
|
paging.cursor | string |
カーソル。 |
その他
|
paging.more | boolean |
さらにないかどうか。 |
指定されたメッセージ パラメータの一括ジョブを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
イベント
|
event | string |
イベント。 |
|
ブランド
|
brand | string |
ブランド。 |
|
Template
|
template | string |
テンプレートです。 |
|
ブランド ID
|
brand_id | string |
ブランドの識別子。 |
|
メソッド
|
method | string |
方法。 |
|
Channels
|
channels | array of string |
チャネル。 |
|
イベント
|
event | string |
イベント。 |
|
Tags
|
tags | array of string |
タグ。 |
|
トレース ID
|
trace_id | string |
トレース識別子。 |
|
Campaign
|
campaign | string |
キャンペーン。 |
|
コンテンツ
|
content | string |
コンテンツ。 |
|
ミディアム
|
medium | string |
ミディアムです。 |
|
Source
|
source | string |
ソース。 |
|
任期
|
term | string |
用語。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ジョブ ID
|
jobId | string |
ジョブ識別子。 |
一括ジョブに関する情報を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ジョブ ID
|
job_id | True | string |
ジョブ識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
イベント
|
job.definition.event | string |
イベント。 |
キューに登録済み
|
job.enqueued | integer |
キューに登録されました。 |
失敗
|
job.failures | integer |
失敗。 |
受信済み
|
job.received | integer |
受信したとき。 |
Status
|
job.status | string |
状態。 |
対象ユーザーのメンバーのリストを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
対象ユーザー ID
|
audience_id | True | string |
対象ユーザー識別子。 |
Cursor
|
cursor | string |
カーソル。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
アイテム
|
items | array of object | |
Member ID
|
items.member_id | string |
メンバーの識別子。 |
追加時点
|
items.added_at | string |
追加された時点。 |
対象ユーザー ID
|
items.audience_id | string |
対象ユーザー識別子。 |
対象ユーザー バージョン
|
items.audience_version | integer |
対象ユーザー バージョン。 |
Reason
|
items.reason | string |
理由。 |
Cursor
|
paging.cursor | string |
カーソル。 |
その他
|
paging.more | boolean |
さらにないかどうか。 |
指定されたパラメーターとフィルターに基づいて対象ユーザーを作成または更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
対象ユーザー ID
|
audience_id | True | string |
対象ユーザー識別子。 |
件名
|
name | string |
名前。 |
|
Path
|
path | string |
パス。 |
|
Operator
|
operator | string |
演算子です。 |
|
価値
|
value | string |
値。 |
|
Path
|
path | string |
パス。 |
|
Operator
|
operator | string |
演算子です。 |
|
価値
|
value | string |
値。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
Description
|
description | string |
説明設定。 |
Operator
|
filter.operator | string |
演算子です。 |
価値
|
filter.value | string |
値。 |
Path
|
filter.path | string |
パス。 |
Filters
|
filter.filters | array of object | |
Path
|
filter.filters.path | string |
パス。 |
Operator
|
filter.filters.operator | string |
演算子です。 |
価値
|
filter.filters.value | string |
値。 |
指定された対象ユーザーを識別子によって返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
対象ユーザー ID
|
audience_id | True | string |
対象ユーザー識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
Description
|
description | string |
説明設定。 |
Operator
|
filter.operator | string |
演算子です。 |
価値
|
filter.value | string |
値。 |
Path
|
filter.path | string |
パス。 |
指定された受信者対象ユーザーを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
対象ユーザー ID
|
audience_id | True | string |
対象ユーザー識別子。 |
戻り値
- 返答
- string
識別子によって特定の監査イベントを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
監査イベント ID
|
audit-event-id | True | string |
監査イベント識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
監査イベント ID
|
auditEventId | string |
監査イベント識別子。 |
ID
|
actor.id | string |
識別子。 |
メール
|
actor.email | string |
メール アドレス。 |
ID
|
target.id | string |
識別子。 |
メール
|
target.email | string |
メール アドレス。 |
Source
|
source | string |
ソース。 |
Timestamp
|
timestamp | string |
タイムスタンプ。 |
タイプ
|
type | string |
種類。 |
通知のリストを取得
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Cursor
|
cursor | string |
カーソル。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Cursor
|
paging.cursor | string |
カーソル。 |
その他
|
paging.more | boolean |
さらにないかどうか。 |
Results
|
results | array of object | |
作成日
|
results.created_at | integer |
作成日時。 |
ID
|
results.id | string |
識別子。 |
日付
|
results.tags.data | array of object | |
ID
|
results.tags.data.id | string |
識別子。 |
件名
|
results.tags.data.name | string |
名前。 |
肩書き
|
results.title | string |
肩書き。 |
更新日
|
results.updated_at | integer |
更新時刻。 |
これは基本的なデータ型 '文字列' です。
’オブジェクト’ という種類です。