應用程式簡訊(預覽)
Retarus SMS 連接器使組織能自動化並可靠地傳送來自 Microsoft 工作流程的簡訊。 用它來提交簡訊工作、查詢工作狀態、取得每個收件人的交付結果,以及取得 API 版本細節。 需要啟用 Retarus 帳號並持有有效的 API 憑證。 如需取得本服務或我們其他簡訊服務的測試帳號,請聯絡 Retarus。
此連接器適用於以下產品和區域:
| 服務 | 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.retarus.com/ |
| info@retarus.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | retarus 有限責任公司 |
| 網站 | https://www.retarus.com/ |
| 隱私策略 | https://www.retarus.com/data-privacy-policy/ |
| 類別 | 傳達;行銷 |
雷塔魯斯簡訊
Retarus SMS 連接器讓組織能自動化簡訊發送並追蹤其送達狀態。
它為需要大規模簡訊傳送的業務工作流程提供安全且可靠的通訊能力。 你可以使用連接器發送訊息、檢查作業狀態、取得每個收件人的交付結果,以及存取 API 的版本資訊。
先決條件
一個擁有有效 API 憑證的 Retarus 簡訊帳號。 一個 Azure 帳號和帶有管理員權限的訂閱。 支援操作 連接器支援以下操作:
- 發送簡訊工作:向一位或多位收件人發送一則或多則簡訊。
- 取得工作狀態:取得先前提交工作的狀態及簡訊識別碼。
- 依照指定條件取得所有工作:取得依時間範圍或其他條件篩選的工作 ID 清單。
- 取得所有工作收件人的狀態:取得特定簡訊工作中每位收件人的送達結果。
- 取得版本資訊:取得 Retarus SMS API 的最新版本資訊。
部署指示
使用此連接器:
- 在你的環境中將它設定成自訂連接器。
- 提供與你的 Retarus 帳戶相關的有效 Retarus API 憑證。
- 請確保您的帳號已設定為 SMS-for-Applications,這樣您才能提交 SMS 工作並查詢 API 暴露的工作資訊。
正在建立連線
連接器支援以下認證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 使用者名稱 | securestring | 此 API 的使用者名稱 | 對 |
| 密碼 | securestring | 此 API 的密碼 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 依照給定條件取得所有職缺 |
此操作會取得指定時間段內的工作 ID 清單及任何可選的篩選器。 |
| 取得所有工作收件人的狀態 |
此操作會取得所有特定工作收件人的個別訊息狀態。 |
| 取得版本資訊 |
此操作會取得 API 目前的版本資訊。 |
| 查詢工作狀態 |
此操作會取得工作狀態及該工作的 SMS ID 清單。 要取得工作中所有訊息的個別訊息狀態,請使用帶有對應 jobId 參數的 SMS 端點。 |
| 發送簡訊工作 |
此操作會發送一則或多則由一位或多位收件人發送的簡訊。 回應包含新 SMS 工作的 JOB ID(JOBId)。 |
依照給定條件取得所有職缺
此操作會取得指定時間段內的工作 ID 清單及任何可選的篩選器。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
只回傳工作ID
|
jobIdsOnly | True | boolean |
只回傳工作ID。 目前只支援「真實」字樣。 |
|
時間戳記
|
fromTs | date-time |
資料來源:時間戳記(ISO-8601)。 fromTs與toTs之間的間隔最多可達30天。 |
|
|
到時間戳記
|
toTs | date-time |
時間戳記(ISO-8601)。 fromTs與toTs之間的間隔最多可達30天。 |
|
|
只回放職缺
|
open | boolean |
只回放空缺工作。 |
|
|
Offset
|
offset | integer |
用於分頁的參數。 擷取以偏移值開頭的記錄子集。 |
|
|
傳回的結果上限
|
limit | integer |
回傳結果數量有限。 數值必須介於0到1000之間。 |
傳回
- response
- array of JobReport
取得所有工作收件人的狀態
此操作會取得所有特定工作收件人的個別訊息狀態。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
作業識別碼
|
jobId | True | string |
Retarus 職缺 ID。 |
傳回
- response
- array of RecipientReport
取得版本資訊
查詢工作狀態
此操作會取得工作狀態及該工作的 SMS ID 清單。 要取得工作中所有訊息的個別訊息狀態,請使用帶有對應 jobId 參數的 SMS 端點。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
作業識別碼
|
jobId | True | string |
Retarus 職缺 ID。 |
傳回
- 身體
- JobReport
發送簡訊工作
此操作會發送一則或多則由一位或多位收件人發送的簡訊。 回應包含新 SMS 工作的 JOB ID(JOBId)。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
src
|
src | string |
收件人會顯示寄件人ID。 |
|
|
編碼
|
encoding | string | ||
|
法案代碼
|
billcode | string |
最大 70字元。 |
|
|
狀態請求
|
statusRequested | boolean |
請求送達通知。 |
|
|
閃光燈
|
flash | boolean | ||
|
客戶參考
|
customerRef | string |
建議最多64字元。 |
|
|
效度最小
|
validityMin | integer |
簡訊的有效時間在幾分鐘內。 當 0 時,則使用提供者的預設值。 否則,數值必須介於5到2880分鐘之間。 |
|
|
maxParts(最大零件)
|
maxParts | integer |
多部分訊息中允許的最大部分。 數值必須介於1到20之間。 較長的訊息會被截斷。 |
|
|
invalidCharacters
|
invalidCharacters | string |
請定義如何在簡訊中處理無效字元。 |
|
|
QoS
|
qos | string |
服務品質。 |
|
|
工作期限
|
jobPeriod | date-time |
時間戳記以排程何時開始處理 SMS 工作(iso-8601)。 |
|
|
重複偵測
|
duplicateDetection | boolean | ||
|
停電期間
|
blackoutPeriods | array of string | ||
|
收發簡訊
|
text | True | string |
福 |
|
夏令時
|
dst | True | string | |
|
客戶參考
|
customerRef | string |
建議最多64字元。 預設使用收件人手機號碼。 |
|
|
停電期間
|
blackoutPeriods | array of string |
傳回
- 身體
- JobResponse
定義
工作回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
jobId
|
jobId | string |
工作報告
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
jobId
|
jobId | string | |
|
src
|
src | string |
寄件人識別碼。 |
|
編碼
|
encoding | string | |
|
法案代碼
|
billcode | string | |
|
狀態請求
|
statusRequested | boolean |
請求送達通知。 |
|
閃光燈
|
flash | boolean | |
|
效度最小
|
validityMin | integer |
簡訊的有效時間在幾分鐘內。 |
|
客戶參考
|
customerRef | string |
建議最多64字元。 |
|
QoS
|
qos | string |
服務品質。 |
|
收據
|
receiptTs | date-time |
時間戳記顯示 Retarus 收到該工作(iso-8601)。 |
|
完成的Ts
|
finishedTs | date-time |
時間戳記顯示 SMS 何時收到最終狀態(iso-8601)。 |
|
收件人ID(收件人ID)
|
recipientIds | array of string |
收件人報告
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
smsID
|
smsId | string | |
|
夏令時
|
dst | string |
收件人的手機號碼。 |
|
程序狀態
|
processStatus | string |
目前的流程狀態(參見 SMS 外撥狀態碼)。 |
|
狀態
|
status | string |
狀態(參見簡訊外撥狀態碼)。 |
|
客戶參考
|
customerRef | string |
建議最多64字元。 |
|
reason
|
reason | string | |
|
sentT
|
sentTs | date-time |
發送簡訊的時間戳記(iso-8601)。 |
|
完成的Ts
|
finishedTs | date-time |
時間戳記,表示簡訊何時收到最終狀態(iso-8601)。 |
版本InfoResponse(版本資訊回應)
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
構建編號
|
buildNumber | integer | |
|
buildTimestamp
|
buildTimestamp | string | |
|
主要版本
|
majorVersion | integer | |
|
小版本
|
minorVersion | integer | |
|
版本資訊
|
versionInfo | string | |
|
訊息
|
message | string |