Courier (獨立發行者) (預覽)
Courier 是一個服務和網絡工作室,供開發團隊在一個地方管理所有產品觸發的通信(電子郵件、聊天、應用內、短信、推送等)。 Courier 專為想要提供卓越通知體驗的開發人員而打造。
此連接器適用於以下產品和區域:
| 服務 | 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.courier.com/ |
| 隱私策略 | https://www.courier.com/privacy/ |
| 類別 | 傳達;社交媒體 |
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 代幣(以「Bearer yourToken」的形式) | securestring | 此 API 的權杖 (以「持有人 yourToken」的形式) | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 傳送訊息 |
傳送訊息給一或多個收件者。 |
| 列出品牌 |
擷取品牌清單。 |
| 列出對象成員 |
擷取對象成員清單。 |
| 列出所有目標對象 |
擷取與您的帳戶相關聯的所有對象。 |
| 列出訊息 |
擷取先前傳送訊息的狀態。 |
| 刪除對象 |
刪除指定的收件者對象。 |
| 刪除清單 |
依清單識別碼刪除清單。 |
| 刪除資料檔 |
刪除指定的收件者設定檔。 |
| 創建品牌 |
從提供的設定建立新品牌。 |
| 取得個人檔案 |
擷取指定的收件者設定檔。 |
| 取得品牌 |
依識別碼擷取特定品牌。 |
| 取得大量作業的使用者 |
擷取大量工作的使用者。 |
| 取得所有收件者清單 |
擷取所有收件者清單的清單。 |
| 取得所有稽核事件 |
擷取稽核事件清單。 |
| 取得清單 |
擷取清單的項目。 |
| 取得清單的訂閱 |
擷取清單的訂閱。 |
| 取得稽核事件 |
依識別碼擷取特定稽核事件。 |
| 取得訊息 |
擷取訊息的狀態。 |
| 取得訊息的內容 |
擷取先前傳送的訊息內容。 |
| 取得訊息的記錄 |
擷取先前傳送訊息的事件。 |
| 吸引觀眾 |
依識別碼傳回指定的對象。 |
| 執行大量作業 |
開始執行大量作業。 |
| 執行範本化自動化 |
從自動化範本叫用自動化執行。 |
| 執行臨機操作自動化 |
在臨機操作執行中叫用自動化。 |
| 封存訊息 |
要求封存訊息。 |
| 將使用者新增至大量作業 |
將使用者資料擷取到大量作業中。 |
| 將訂閱者新增至清單 |
將其他訂閱者新增至清單。 |
| 建立個人檔案 |
將提供的值與現有的設定檔合併,或建立新的設定檔(如果尚不存在)。 |
| 建立大量作業 |
為提供的訊息參數建立大量工作。 |
| 建立或更新廣告受眾 |
根據提供的引數和篩選器建立或更新對象。 |
| 從清單中取消訂閱使用者 |
依清單和收件者識別碼刪除清單的訂閱。 |
| 更新清單 |
使用提供的值建立或取代現有清單。 |
| 更新設定檔 |
設定檔部分的更新。 |
| 清單通知 |
擷取通知清單。 |
| 獲得大量工作 |
擷取大量工作的相關資訊。 |
| 還原清單 |
依識別碼還原現有清單。 |
傳送訊息
傳送訊息給一或多個收件者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
冪等性
|
idempotency | True | string |
冪等鍵。 |
|
Title
|
title | string |
標題。 |
|
|
身體
|
body | string |
身體。 |
|
|
使用者識別碼
|
user_id | string |
使用者識別碼。 |
|
|
清單識別碼
|
list_id | string |
清單識別碼。 |
|
|
對象ID
|
audience_id | string |
對象識別碼。 |
|
|
Email
|
string |
電子郵件地址。 |
||
|
電話號碼
|
phone_number | string |
電話號碼。 |
|
|
Locale
|
locale | string |
地區設定。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
請求編號
|
requestId | string |
要求識別碼。 |
列出品牌
擷取品牌清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
游標。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
游標。 |
|
More
|
paging.more | boolean |
是否還有更多。 |
|
Results
|
results | array of object | |
|
已建立
|
results.created | integer |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
名稱
|
results.name | string |
名稱。 |
|
發布
|
results.published | integer |
發佈時。 |
|
Updated
|
results.updated | integer |
更新時。 |
|
版本
|
results.version | string |
版本。 |
|
Primary
|
results.settings.colors.primary | string |
主要。 |
|
Secondary
|
results.settings.colors.secondary | string |
次要的。 |
|
第三紀
|
results.settings.colors.tertiary | string |
第三級。 |
|
長條顏色
|
results.settings.email.header.barColor | string |
條形顏色。 |
|
HREF
|
results.settings.email.header.logo.href | string |
The HREF. |
|
影像
|
results.settings.email.header.logo.image | string |
圖像。 |
|
Markdown
|
results.settings.email.footer.markdown | string |
降價。 |
|
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 |
是否停用訊息圖示。 |
|
放置
|
results.settings.inapp.placement | string |
放置。 |
|
物品
|
results.snippets.items | array of string |
項目。 |
列出對象成員
擷取對象成員清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
對象ID
|
audience_id | True | string |
對象識別碼。 |
|
Cursor
|
cursor | string |
游標。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
items | array of object | |
|
會員編號
|
items.member_id | string |
成員識別碼。 |
|
添加於
|
items.added_at | string |
當添加到。 |
|
對象ID
|
items.audience_id | string |
對象識別碼。 |
|
觀眾版本
|
items.audience_version | integer |
觀眾版本。 |
|
原因
|
items.reason | string |
原因。 |
|
Cursor
|
paging.cursor | string |
游標。 |
|
More
|
paging.more | boolean |
是否還有更多。 |
列出所有目標對象
擷取與您的帳戶相關聯的所有對象。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
游標。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
items | array of object | |
|
ID
|
items.id | string |
識別碼。 |
|
名稱
|
items.name | string |
名稱。 |
|
Description
|
items.description | string |
描述。 |
|
Operator
|
items.filter.operator | string |
運算子。 |
|
價值觀
|
items.filter.value | string |
值。 |
|
路徑
|
items.filter.path | string |
路徑。 |
|
Cursor
|
paging.cursor | string |
游標。 |
|
More
|
paging.more | boolean |
是否還有更多。 |
列出訊息
擷取先前傳送訊息的狀態。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
是否存檔。 |
|
|
Cursor
|
cursor | string |
游標。 |
|
|
Event
|
event | string |
活動。 |
|
|
清單
|
list | string |
清單。 |
|
|
訊息 ID
|
messageId | string |
訊息識別碼。 |
|
|
Notification
|
notification | string |
通知。 |
|
|
Recipient
|
recipient | string |
收件者。 |
|
|
地位
|
status | string |
狀態。 |
|
|
Tags
|
tags | string |
標記。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
游標。 |
|
More
|
paging.more | boolean |
是否還有更多。 |
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
識別碼。 |
|
地位
|
results.status | string |
狀態。 |
|
已排入佇列
|
results.enqueued | integer |
排隊的。 |
|
寄件日期
|
results.sent | integer |
發送的。 |
|
Delivered
|
results.delivered | integer |
交付了。 |
|
已開業
|
results.opened | integer |
打開了。 |
|
點擊
|
results.clicked | integer |
點擊了。 |
|
Recipient
|
results.recipient | string |
收件者。 |
|
Event
|
results.event | string |
活動。 |
|
Notification
|
results.notification | string |
通知。 |
|
錯誤
|
results.error | string |
錯誤。 |
|
原因
|
results.reason | string |
原因。 |
刪除對象
刪除清單
刪除資料檔
刪除指定的收件者設定檔。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
收件者 ID
|
recipient_id | True | string |
收件者識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
地位
|
status | string |
狀態。 |
創建品牌
從提供的設定建立新品牌。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
|
名稱
|
name | True | string |
名稱。 |
|
Primary
|
primary | string |
主要。 |
|
|
Secondary
|
secondary | string |
次要的。 |
|
|
第三紀
|
tertiary | string |
第三級。 |
|
|
長條顏色
|
barColor | string |
條形顏色。 |
|
|
HREF
|
href | string |
The HREF. |
|
|
影像
|
image | string |
圖像。 |
|
|
Markdown
|
markdown | string |
降價。 |
|
|
URL
|
url | string |
URL 位址。 |
|
|
URL
|
url | string |
URL 位址。 |
|
|
URL
|
url | string |
URL 位址。 |
|
|
URL
|
url | string |
URL 位址。 |
|
|
URL
|
url | string |
URL 位址。 |
|
|
停用訊息圖示
|
disableMessageIcon | boolean |
是否停用訊息圖示。 |
|
|
放置
|
placement | string |
放置。 |
|
|
物品
|
items | array of string |
項目。 |
傳回
- response
- string
取得個人檔案
擷取指定的收件者設定檔。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
收件者 ID
|
recipient_id | True | string |
收件者識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Email
|
profile.email | string |
電子郵件地址。 |
|
電話號碼
|
profile.phone_number | string |
電話號碼。 |
取得品牌
依識別碼擷取特定品牌。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
品牌 ID
|
brand_id | True | string |
品牌識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
已建立
|
created | integer |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
名稱
|
name | string |
名稱。 |
|
發布
|
published | integer |
發佈時。 |
|
Updated
|
updated | integer |
更新了。 |
|
版本
|
version | string |
版本。 |
|
Primary
|
settings.colors.primary | string |
主要。 |
|
Secondary
|
settings.colors.secondary | string |
次要的。 |
|
第三紀
|
settings.colors.tertiary | string |
第三級。 |
|
長條顏色
|
settings.email.header.barColor | string |
條形顏色。 |
|
HREF
|
settings.email.header.logo.href | string |
The HREF. |
|
影像
|
settings.email.header.logo.image | string |
圖像。 |
|
Markdown
|
settings.email.footer.markdown | string |
降價。 |
|
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 |
是否停用訊息圖示。 |
|
放置
|
settings.inapp.placement | string |
放置。 |
|
物品
|
snippets.items | array of string |
項目。 |
取得大量作業的使用者
擷取大量工作的使用者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
作業識別碼
|
job_id | True | string |
工作識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
items | array of object | |
|
Recipient
|
items.recipient | string |
收件者。 |
|
Email
|
items.email | string |
電子郵件地址。 |
|
Locale
|
items.locale | string |
地區設定。 |
|
Cursor
|
paging.cursor | string |
游標。 |
|
More
|
paging.more | boolean |
是否還有更多。 |
取得所有收件者清單
擷取所有收件者清單的清單。
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
游標。 |
|
More
|
paging.more | boolean |
是否還有更多。 |
|
Results
|
results | array of object | |
|
已建立
|
results.created | string |
建立時。 |
|
ID
|
results.id | string |
識別碼。 |
|
名稱
|
results.name | string |
名稱。 |
|
Updated
|
results.updated | string |
更新時。 |
取得所有稽核事件
擷取稽核事件清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
游標。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
游標。 |
|
More
|
paging.more | boolean |
是否還有更多。 |
|
Results
|
results | array of object | |
|
稽核事件識別碼
|
results.auditEventId | string |
稽核事件識別碼。 |
|
ID
|
results.actor.id | string |
識別碼。 |
|
Email
|
results.actor.email | string |
電子郵件地址。 |
|
ID
|
results.target.id | string |
識別碼。 |
|
Email
|
results.target.email | string |
電子郵件地址。 |
|
來源
|
results.source | string |
來源。 |
|
時間戳
|
results.timestamp | string |
時間戳記。 |
|
類型
|
results.type | string |
型別。 |
取得清單
擷取清單的項目。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
清單識別碼
|
list_id | True | string |
清單識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
已建立
|
created | string |
建立時。 |
|
ID
|
id | string |
識別碼。 |
|
名稱
|
name | string |
名稱。 |
|
Updated
|
updated | string |
更新了。 |
取得清單的訂閱
擷取清單的訂閱。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
清單識別碼
|
list_id | True | string |
清單識別碼。 |
|
Cursor
|
cursor | string |
游標。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
游標。 |
|
More
|
paging.more | boolean |
是否還有更多。 |
|
物品
|
items | array of object | |
|
收件者 ID
|
items.recipientId | string |
收件者識別碼。 |
|
已建立
|
items.created | string |
建立時。 |
取得稽核事件
依識別碼擷取特定稽核事件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
稽核事件識別碼
|
audit-event-id | True | string |
稽核事件識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
稽核事件識別碼
|
auditEventId | string |
稽核事件識別碼。 |
|
ID
|
actor.id | string |
識別碼。 |
|
Email
|
actor.email | string |
電子郵件地址。 |
|
ID
|
target.id | string |
識別碼。 |
|
Email
|
target.email | string |
電子郵件地址。 |
|
來源
|
source | string |
來源。 |
|
時間戳
|
timestamp | string |
時間戳記。 |
|
類型
|
type | string |
型別。 |
取得訊息
擷取訊息的狀態。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
訊息 ID
|
message_id | True | string |
訊息識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
地位
|
status | string |
狀態。 |
|
已排入佇列
|
enqueued | integer |
排隊的。 |
|
寄件日期
|
sent | integer |
發送的。 |
|
Delivered
|
delivered | integer |
交付了。 |
|
已開業
|
opened | integer |
打開了。 |
|
點擊
|
clicked | integer |
點擊了。 |
|
Recipient
|
recipient | string |
收件者。 |
|
Event
|
event | string |
活動。 |
|
Notification
|
notification | string |
通知。 |
|
錯誤
|
error | string |
錯誤。 |
|
原因
|
reason | string |
原因。 |
|
供應商
|
providers | array of object | |
|
寄件日期
|
providers.sent | integer |
發送的。 |
|
Delivered
|
providers.delivered | integer |
交付了。 |
|
點擊
|
providers.clicked | integer |
點擊了。 |
|
已開業
|
providers.opened | integer |
打開了。 |
|
錯誤
|
providers.error | string |
錯誤。 |
|
Provider
|
providers.provider | string |
提供者。 |
|
地位
|
providers.status | string |
狀態。 |
取得訊息的內容
擷取先前傳送的訊息內容。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
訊息 ID
|
message_id | True | string |
訊息識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Channel
|
results.channel | string |
頻道。 |
|
頻道 ID
|
results.channel_id | string |
通道識別碼。 |
|
HTML
|
results.content.html | string |
HTML 的 HTML. |
|
主旨
|
results.content.subject | string |
主題。 |
|
文字
|
results.content.text | string |
文字。 |
|
區塊
|
results.content.blocks | array of object | |
|
類型
|
results.content.blocks.type | string |
型別。 |
|
文字
|
results.content.blocks.text | string |
文字。 |
取得訊息的記錄
擷取先前傳送訊息的事件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
訊息 ID
|
message_id | True | string |
訊息識別碼。 |
|
類型
|
type | string |
型別。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
名稱
|
results.data.name | string |
名稱。 |
|
Event
|
results.event | string |
活動。 |
|
Recipient
|
results.recipient | string |
收件者。 |
|
TS
|
results.ts | integer |
The TS. |
|
類型
|
results.type | string |
型別。 |
|
事件識別碼
|
results.event_id | string |
事件識別碼。 |
|
通知標識碼
|
results.notification_id | string |
通知識別碼。 |
|
ID
|
results.channel.id | string |
識別碼。 |
|
ID
|
results.integration.id | string |
識別碼。 |
|
Provider
|
results.integration.provider | string |
提供者。 |
吸引觀眾
依識別碼傳回指定的對象。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
對象ID
|
audience_id | True | string |
對象識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
名稱
|
name | string |
名稱。 |
|
Description
|
description | string |
描述。 |
|
Operator
|
filter.operator | string |
運算子。 |
|
價值觀
|
filter.value | string |
值。 |
|
路徑
|
filter.path | string |
路徑。 |
執行大量作業
執行範本化自動化
從自動化範本叫用自動化執行。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
範本識別碼
|
templateId | True | string |
範本識別碼。 |
|
品牌
|
brand | string |
品牌。 |
|
|
Template
|
template | string |
模板。 |
|
|
Recipient
|
recipient | string |
收件者。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
執行標識碼
|
runId | string |
執行識別碼。 |
執行臨機操作自動化
在臨機操作執行中叫用自動化。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
取消權杖
|
cancelation_token | string |
取消權杖。 |
|
|
品牌
|
brand | string |
品牌。 |
|
|
Template
|
template | string |
模板。 |
|
|
Recipient
|
recipient | string |
收件者。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
執行標識碼
|
runId | string |
執行識別碼。 |
封存訊息
將使用者新增至大量作業
將使用者資料擷取到大量作業中。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
作業識別碼
|
job_id | True | string |
工作識別碼。 |
|
Recipient
|
recipient | string |
收件者。 |
傳回
- response
- string
將訂閱者新增至清單
將其他訂閱者新增至清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
清單識別碼
|
list_id | True | string |
清單識別碼。 |
|
收件者 ID
|
recipientId | string |
收件者識別碼。 |
傳回
- response
- string
建立個人檔案
將提供的值與現有的設定檔合併,或建立新的設定檔(如果尚不存在)。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
收件者 ID
|
recipient_id | True | string |
收件者識別碼。 |
|
Email
|
string |
電子郵件地址。 |
||
|
電話號碼
|
phone_number | string |
電話號碼。 |
|
|
格式化
|
formatted | string |
格式化的地址。 |
|
|
地址
|
street_address | string |
街道地址。 |
|
|
地區
|
locality | string |
當地。 |
|
|
區域
|
region | string |
所在區域。 |
|
|
郵遞區號
|
postal_code | string |
郵遞區號。 |
|
|
國家
|
country | string |
國家。 |
|
|
出生日期
|
birthdate | string |
出生日期。 |
|
|
電子郵件已驗證
|
email_verified | boolean |
電子郵件是否經過驗證。 |
|
|
電話號碼已驗證
|
phone_number_verified | boolean |
電話號碼是否經過驗證。 |
|
|
名字
|
given_name | string |
名字。 |
|
|
中間名
|
middle_name | string |
中間名。 |
|
|
姓
|
family_name | string |
姓氏。 |
|
|
偏好名稱
|
preferred_name | string |
偏好的名稱。 |
|
|
性別
|
gender | string |
性別。 |
|
|
Locale
|
locale | string |
地區設定。 |
|
|
圖片
|
picture | string |
圖片。 |
|
|
Profile
|
profile | string |
設定檔。 |
|
|
子
|
sub | string |
潛艇。 |
|
|
更新於
|
updated_at | string |
更新時。 |
|
|
網站
|
website | string |
網站。 |
|
|
區域資訊
|
zoneinfo | string |
區域資訊。 |
|
|
具名使用者
|
named_user | string |
具名使用者。 |
|
|
設備類型
|
device_types | array of string |
裝置類型。 |
|
|
APN的
|
apn | string |
APN。 |
|
|
目標 ARN
|
target_arn | string |
目標 ARN。 |
|
|
頻道 ID
|
channel_id | string |
通道識別碼。 |
|
|
使用者識別碼
|
user_id | string |
使用者識別碼。 |
|
|
代幣
|
token | string |
權杖。 |
|
|
Tokens
|
tokens | array of string |
代幣。 |
|
|
Facebook PS ID
|
facebookPSID | string |
Facebook PS 識別碼。 |
|
|
Firebase 代幣
|
firebaseToken | string |
Firebase 權杖。 |
|
|
寄件者
|
from | string |
從。 |
|
|
ID
|
id | string |
識別碼。 |
|
|
使用者識別碼
|
user_id | string |
使用者識別碼。 |
|
|
交談識別碼
|
conversation_id | string |
交談識別碼。 |
|
|
租戶識別碼
|
tenant_id | string |
租用戶識別碼。 |
|
|
服務網址
|
service_url | string |
服務 URL 位址。 |
|
|
OneSignal 玩家 ID
|
oneSignalPlayerID | string |
OneSignal 播放器識別碼。 |
|
|
存取令牌
|
access_token | string |
存取令牌。 |
|
|
Channel
|
channel | string |
頻道。 |
|
|
Email
|
string |
電子郵件地址。 |
||
|
使用者識別碼
|
user_id | string |
使用者識別碼。 |
|
|
URL
|
url | string |
URL 位址。 |
|
|
URL
|
url | string |
URL 位址。 |
|
|
方法
|
method | string |
方法。 |
|
|
Mode
|
mode | string |
模式。 |
|
|
用戶名稱
|
username | string |
用戶名稱。 |
|
|
密碼
|
password | string |
密碼。 |
|
|
代幣
|
token | string |
權杖。 |
|
|
Profile
|
profile | string |
設定檔。 |
傳回
- response
- string
建立大量作業
為提供的訊息參數建立大量工作。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Event
|
event | string |
活動。 |
|
|
品牌
|
brand | string |
品牌。 |
|
|
Template
|
template | string |
模板。 |
|
|
品牌 ID
|
brand_id | string |
品牌識別碼。 |
|
|
方法
|
method | string |
方法。 |
|
|
渠道
|
channels | array of string |
頻道。 |
|
|
Event
|
event | string |
活動。 |
|
|
Tags
|
tags | array of string |
標記。 |
|
|
追蹤識別碼
|
trace_id | string |
追蹤識別碼。 |
|
|
活動
|
campaign | string |
競選活動。 |
|
|
Content
|
content | string |
內容。 |
|
|
中等
|
medium | string |
媒介。 |
|
|
來源
|
source | string |
來源。 |
|
|
術語
|
term | string |
術語。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
作業識別碼
|
jobId | string |
工作識別碼。 |
建立或更新廣告受眾
根據提供的引數和篩選器建立或更新對象。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
對象ID
|
audience_id | True | string |
對象識別碼。 |
|
名稱
|
name | string |
名稱。 |
|
|
路徑
|
path | string |
路徑。 |
|
|
Operator
|
operator | string |
運算子。 |
|
|
價值觀
|
value | string |
值。 |
|
|
路徑
|
path | string |
路徑。 |
|
|
Operator
|
operator | string |
運算子。 |
|
|
價值觀
|
value | string |
值。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
識別碼。 |
|
名稱
|
name | string |
名稱。 |
|
Description
|
description | string |
描述。 |
|
Operator
|
filter.operator | string |
運算子。 |
|
價值觀
|
filter.value | string |
值。 |
|
路徑
|
filter.path | string |
路徑。 |
|
篩選
|
filter.filters | array of object | |
|
路徑
|
filter.filters.path | string |
路徑。 |
|
Operator
|
filter.filters.operator | string |
運算子。 |
|
價值觀
|
filter.filters.value | string |
值。 |
從清單中取消訂閱使用者
依清單和收件者識別碼刪除清單的訂閱。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
清單識別碼
|
list_id | True | string |
清單識別碼。 |
|
收件者 ID
|
recipient_id | True | string |
收件者識別碼。 |
傳回
- response
- string
更新清單
使用提供的值建立或取代現有清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
清單識別碼
|
list_id | True | string |
清單識別碼。 |
|
名稱
|
name | string |
名稱。 |
傳回
- response
- string
更新設定檔
設定檔部分的更新。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
收件者 ID
|
recipient_id | True | string |
收件者識別碼。 |
|
行動
|
op | string |
作業。 |
|
|
路徑
|
path | string |
路徑。 |
|
|
價值觀
|
value | string |
值。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
地位
|
status | string |
狀態。 |
清單通知
擷取通知清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
游標。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
游標。 |
|
More
|
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 |
名稱。 |
|
Title
|
results.title | string |
標題。 |
|
更新於
|
results.updated_at | integer |
更新時。 |
獲得大量工作
擷取大量工作的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
作業識別碼
|
job_id | True | string |
工作識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Event
|
job.definition.event | string |
活動。 |
|
已排入佇列
|
job.enqueued | integer |
排隊的。 |
|
失敗
|
job.failures | integer |
失敗。 |
|
收到
|
job.received | integer |
收到時。 |
|
地位
|
job.status | string |
狀態。 |
還原清單
定義
字串
這是基本資料類型「string」。
物件
這是類型 'object'。