アプリケーションの SMS (プレビュー)
Retarus SMS コネクタを使用すると、組織は Microsoft ワークフローからテキスト メッセージを自動化し、確実に配信できます。 SMS ジョブの送信、ジョブの状態の照会、受信者ごとの配信結果の取得、API バージョンの詳細の取得に使用します。 アクティブな Retarus アカウントと有効な API 資格情報が必要です。 このサービスまたはその他の SMS サービスのテスト アカウントを取得するには、Retarus にお問い合わせください。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate(パワーオートメート) | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | レタラス |
| URL | https://www.retarus.com/ |
| info@retarus.com |
| コネクタ メタデータ | |
|---|---|
| パブリッシャー | retarus GmbH |
| Website | https://www.retarus.com/ |
| プライバシー ポリシー | https://www.retarus.com/data-privacy-policy/ |
| カテゴリ | 通信;マーケティング |
Retarus SMS
Retarus SMS コネクタを使用すると、組織はテキスト メッセージの送信を自動化し、配信状態を追跡できます。
これは、大規模な SMS 配信を必要とするビジネス ワークフローに対して、セキュリティで保護された信頼性の高い通信機能を提供します。 コネクタを使用すると、メッセージの送信、ジョブの状態の確認、受信者ごとの配信結果の取得、API のバージョン情報へのアクセスを行うことができます。
[前提条件]
有効な API 資格情報を持つ Retarus SMS アカウント。 管理者特権を持つ Azure アカウントとサブスクリプション。 サポートされる操作 コネクタは、次の操作をサポートします。
- SMS ジョブを送信する: 1 つ以上の SMS メッセージを 1 人以上の受信者に送信します。
- ジョブの状態を取得する: 以前に送信されたジョブの状態と SMS ID を取得します。
- 指定された条件のすべてのジョブを取得する: 時間範囲またはその他の条件でフィルター処理されたジョブ ID の一覧を取得します。
- ジョブのすべての受信者の状態を取得する: 特定の SMS ジョブの各受信者の配信結果を取得します。
- バージョン情報を取得する: Retarus SMS API の現在のバージョン情報を取得します。
デプロイ手順
このコネクタを使用するには:
- をカスタム コネクタとして環境に構成します。
- Retarus アカウントに関連付けられている有効な Retarus API 資格情報を指定します。
- API によって公開される SMS ジョブとクエリ ジョブ情報を送信できるように、アカウントが SMS for-Applications 用にプロビジョニングされていることを確認します。
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有不可 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| ユーザー名 | securestring | この API のユーザー名 | 正しい |
| パスワード | securestring | この API のパスワード | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| SMS ジョブを送信する |
この操作では、1 つ以上の受信者がそれぞれ 1 つ以上の SMS メッセージを送信します。 応答には、新しい SMS ジョブのジョブ ID (jobId) が含まれています。 |
| ジョブのすべての受信者の状態を取得する |
この操作は、特定のジョブのすべての受信者の個々のメッセージの状態を取得します。 |
| ジョブの状態を取得する |
この操作は、ジョブの状態とジョブの SMS ID の一覧を取得します。 ジョブ内のすべてのメッセージの個々のメッセージ状態を取得するには、対応する jobId パラメーターで SMS エンドポイントを使用します。 |
| バージョン情報を取得する |
この操作は、API の現在のバージョン情報を取得します。 |
| 指定された条件のすべてのジョブを取得する |
この操作では、指定した期間のジョブ ID の一覧と任意のフィルターを取得します。 |
SMS ジョブを送信する
この操作では、1 つ以上の受信者がそれぞれ 1 つ以上の SMS メッセージを送信します。 応答には、新しい SMS ジョブのジョブ ID (jobId) が含まれています。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
src
|
src | string |
受信者に表示される送信者 ID。 |
|
|
エンコード
|
encoding | string | ||
|
billcode
|
billcode | string |
マックス。 70 文字。 |
|
|
statusRequested
|
statusRequested | boolean |
配信通知が要求されました。 |
|
|
フラッシュ
|
flash | boolean | ||
|
customerRef
|
customerRef | string |
推奨される最大 64 文字。 |
|
|
validityMin
|
validityMin | integer |
SMS の有効性 (分単位)。 0 の場合、プロバイダーの既定値が使用されます。 それ以外の場合、値は 5 から 2880 分の間である必要があります。 |
|
|
maxParts
|
maxParts | integer |
マルチパート メッセージで許容される最大部分数。 値は 1 から 20 の間である必要があります。 長いメッセージは切り捨てられます。 |
|
|
invalidCharacters
|
invalidCharacters | string |
SMS で無効な文字を処理する方法を定義します。 |
|
|
qos
|
qos | string |
サービスの品質。 |
|
|
jobPeriod
|
jobPeriod | date-time |
SMS ジョブの処理を開始するタイミングをスケジュールするタイムスタンプ (iso-8601)。 |
|
|
duplicateDetection
|
duplicateDetection | boolean | ||
|
blackoutPeriods
|
blackoutPeriods | array of string | ||
|
SMS 送信
|
text | True | string |
foo |
|
dst
|
dst | True | string | |
|
customerRef
|
customerRef | string |
推奨される最大 64 文字。 既定として使用される受信者の携帯電話番号。 |
|
|
blackoutPeriods
|
blackoutPeriods | array of string |
戻り値
- Body
- JobResponse
ジョブのすべての受信者の状態を取得する
この操作は、特定のジョブのすべての受信者の個々のメッセージの状態を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
職務 ID
|
jobId | True | string |
Retarus ジョブ ID。 |
戻り値
- response
- array of RecipientReport
ジョブの状態を取得する
この操作は、ジョブの状態とジョブの SMS ID の一覧を取得します。 ジョブ内のすべてのメッセージの個々のメッセージ状態を取得するには、対応する jobId パラメーターで SMS エンドポイントを使用します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
職務 ID
|
jobId | True | string |
Retarus ジョブ ID。 |
戻り値
- Body
- JobReport
バージョン情報を取得する
指定された条件のすべてのジョブを取得する
この操作では、指定した期間のジョブ ID の一覧と任意のフィルターを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
jobID のみを返す
|
jobIdsOnly | True | boolean |
jobID のみを返します。 現在、サポートされているのは 'true' のみです。 |
|
タイムスタンプから
|
fromTs | date-time |
タイムスタンプ (ISO-8601) から。 fromT と toT の間隔は最大で 30 日です。 |
|
|
タイムスタンプへ
|
toTs | date-time |
タイムスタンプ (ISO-8601)。 fromT と toT の間隔は最大で 30 日です。 |
|
|
開いているジョブのみを返す
|
open | boolean |
開いているジョブのみを返します。 |
|
|
オフセット
|
offset | integer |
改ページ位置の修正に使用されるパラメーター。 オフセット値で始まるレコードのサブセットを取得します。 |
|
|
返された結果の最大数
|
limit | integer |
返される結果の数を制限します。 値は 0 から 1000 の間である必要があります。 |
戻り値
- response
- array of JobReport
定義
JobResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
jobId
|
jobId | string |
JobReport
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
jobId
|
jobId | string | |
|
src
|
src | string |
送信者 ID。 |
|
エンコード
|
encoding | string | |
|
billcode
|
billcode | string | |
|
statusRequested
|
statusRequested | boolean |
配信通知が要求されました。 |
|
フラッシュ
|
flash | boolean | |
|
validityMin
|
validityMin | integer |
SMS の有効性 (分単位)。 |
|
customerRef
|
customerRef | string |
推奨される最大 64 文字。 |
|
qos
|
qos | string |
サービスの品質。 |
|
receiptT
|
receiptTs | date-time |
ジョブが Retarus (iso-8601) によって受信された日時を示すタイムスタンプ。 |
|
finishedT
|
finishedTs | date-time |
SMS が最終状態 (iso-8601) を受信したことを示すタイムスタンプ。 |
|
recipientIds
|
recipientIds | array of string |
RecipientReport
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
smsId
|
smsId | string | |
|
dst
|
dst | string |
受信者の携帯電話番号。 |
|
processStatus
|
processStatus | string |
現在のプロセスの状態 (SMS 送信状態コードを参照)。 |
|
状態
|
status | string |
状態 (SMS 送信状態コードを参照)。 |
|
customerRef
|
customerRef | string |
推奨される最大 64 文字。 |
|
理由
|
reason | string | |
|
sentT
|
sentTs | date-time |
SMS が送信されたときのタイムスタンプ (iso-8601)。 |
|
finishedT
|
finishedTs | date-time |
SMS が最終状態 (iso-8601) を受信した日時を示すタイムスタンプ。 |
VersionInfoResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
buildNumber
|
buildNumber | integer | |
|
buildTimestamp
|
buildTimestamp | string | |
|
majorVersion
|
majorVersion | integer | |
|
minorVersion
|
minorVersion | integer | |
|
versionInfo
|
versionInfo | string | |
|
メッセージ
|
message | string |