ClickSend SMS
アラート、通知、招待、マーケティング メッセージなど、ビジネス用 SMS の送信には ClickSend をご利用ください。 ClickSend は、あらゆる形態と規模の企業が Web アプリや API を使用して SMS、電子メール、音声から郵便までを世界中で簡単に送受信できるようにするビジネス通信ソフトウェアです。 ClickSend は SMS を中心とし、世界中の数十億のメッセージを直接ルートによってサポートしていますが、ビジネス通信に選択肢とコンテキストをもたらす一連の製品を提供するために拡張されました。
このコネクタは、次の製品および地域で利用可能です。
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) |
お問い合わせ先 | |
---|---|
件名 | ClickSend SMS サポート |
[URL] | https://www.clicksend.com/au/help |
メール | Support@clicksend.com |
Connector Metadata | |
---|---|
発行者 | ClickSend SMS |
Web サイト | https://www.clicksend.com |
プライバシー ポリシー | https://www.clicksend.com/us/legal/privacy-policy |
カテゴリ | 通信;マーケティング |
ClickSend SMS コネクタを使用すると、コネクタのトリガーが発生したときに、世界中の SMS、MMS、音声、FAX、郵便を通じて、ビジネス メッセージ、通知、アラート、招待状を送信することができます。 また、ユーザーが他の何百もの一意のコネクタ アクションに接続できる受信用 SMS トリガーがあります。 ClickSend SMS コネクタは、組み込みアクションおよびトリガーでも機能します。
前提条件
ClickSend SMS コネクタを使用して、ワークフローを構築するには、ClickSend アカウントが必要です。 ユーザーはまず ClickSend Web サイト、https://clicksend.com/signup にサインアップする必要があります。その後、テスト目的でテスト クレジットを付与します�。 これらのクレジットが不足した場合、アカウントの請求セクション、https://dashboard.clicksend.com/#/account/billing-recharge/top-up-account でクレジット パッケージを購入することで、メッセージの送信を継続することができます。 ClickSend は無料の統合であり、ユーザーが送信したメッセージに対してのみ課金します。
資格情報の入手方法
ClickSend アカウントを作成する必要があります。 ここでサインアップすることができます: https://clicksend.com/signup アカウントが作成されると、API 資格情報が生成されます。 API 資格情報は、アカウント内の �API 資格情報� ページ https://dashboard.clicksend.com/#/account/subaccount にあります。
資格情報の取得場所と ClickSend の接続方法に関するヘルプ記事は、https://help.clicksend.com/article/zasfmfisot-how-to-connect-click-send-account-to-microsoft-power-automate を参照してください。
既知の問題と制限事項
制限:
- SMS の送信 - 最大 1,224 文字まで送信できます。
- SMS、MMS、FAX、音声の送信は、当社の番号から送信されます。 現在、送信者番号を変更することはできません
接続の作成
コネクタは、次の認証タイプをサポートしています:
既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
件名 | タイプ | 内容 | 必要 |
---|---|---|---|
ユーザー名 | securestring | この API のユーザー名 | 真 |
API キー | securestring | この API の API キー | 真 |
調整制限
名前 | 呼び出し | 更新期間 |
---|---|---|
接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
FAX の送信 |
FAX を送信します |
MMS の送信 |
MMS の送信 |
SMS の送信 |
各 160 文字 = 1 SMS。 最大 1,224 標準文字まで送信できます。 |
ボイス メッセージを送信する |
各 300 文字 = 1 ボイス メッセージ。 最大 1,200 標準文字まで送信できます |
ポストカードを送信する |
1 つ以上のポストカードを送信します |
メディア ファイル形式を変換する |
メディア ファイル形式を変換する |
レターの送信 |
レターを送信します |
一覧で取引先担当者を取得する |
一覧ですべての取引先担当者を取得します |
一覧を削除する |
特定の取引先担当者一覧を削除する |
取引先担当者の一覧を取得する |
詳細オプションで指定されていない限り、すべての取引先担当者の一覧を取得します |
取引先担当者を削除する |
取引先担当者を削除する |
取引先担当者一覧を検索する |
検索された取引先担当者一覧を取得します |
新しい取引先担当者の作成 |
新しい取引先担当者の作成 |
新しい取引先担当者一覧を作成する |
新しい取引先担当者一覧を作成する |
FAX の送信
FAX を送信します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
発信先
|
to | True | string |
E.164 形式の電話番号。 例: +61261111111。 |
カスタム文字列
|
custom_string | string |
これは自分用の参照情報です。 すべてのレポートに表示され、返信とともに返されます。 |
|
PDF ファイルの URL
|
file_url | True | string |
ファイルの最大サイズは 4 MB です。 すべてのページは縦方向である必要があります。 詳細な仕様については、ClickSend サポートとのチャットでご確認ください |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
HTTP コード
|
http_code | integer |
HTTP コード |
反応コード
|
response_code | string |
反応コード |
回答メッセージ
|
response_msg | string |
回答メッセージ |
合計価格
|
data.total_price | float |
合計価格 |
総数
|
data.total_count | integer |
総数 |
キュー登録済み数
|
data.queued_count | integer |
キュー登録済み数 |
メッセージ
|
data.messages | array of object |
メッセージ |
ユーザー ID
|
data.messages.user_id | integer |
ユーザー ID |
サブアカウント ID
|
data.messages.subaccount_id | integer |
サブアカウント ID |
一覧 ID
|
data.messages.list_id | string |
一覧 ID |
メッセージ ID
|
data.messages.message_id | string |
メッセージ ID |
発信先
|
data.messages.to | string |
発信先 |
From
|
data.messages.from | string |
From |
運送業者
|
data.messages.carrier | string |
運送業者 |
国
|
data.messages.country | string |
国 |
カスタム文字列
|
data.messages.custom_string | string |
カスタム文字列 |
メッセージ ページ
|
data.messages.message_pages | integer |
メッセージ ページ |
メッセージ価格
|
data.messages.message_price | string |
メッセージ価格 |
状態コード
|
data.messages.status_code | string |
状態コード |
状態テキスト
|
data.messages.status_text | string |
状態テキスト |
追加された日付
|
data.messages.date_added | integer |
追加された日付 |
電子メールから
|
data.messages.from_email | string |
電子メールから |
ファイルの URL
|
data.messages._file_url | string |
ファイルの URL |
ステータス
|
data.messages.status | string |
ステータス |
通貨名ショート
|
data._currency.currency_name_short | string |
通貨名ショート |
通貨の接頭辞 D
|
data._currency.currency_prefix_d | string |
通貨の接頭辞 D |
通貨の接頭辞 C
|
data._currency.currency_prefix_c | string |
通貨の接頭辞 C |
長い通貨名
|
data._currency.currency_name_long | string |
長い通貨名 |
MMS の送信
MMS の送信
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
終了
|
to | True | string |
携帯電話番号。 ローカルまたは国際形式にすることができます。 他の国に送信する場合は、国際 (E.164) 形式である必要があります。 例: +61411111111。 |
件名
|
subject | True | string |
件名行。 最大 20 文字。 |
メッセージ
|
body | True | string |
メッセージの本文。 最大 1500 文字または 500 Unicode 文字 |
カスタム文字列
|
custom_string | string |
これは自分用の参照情報です。 すべてのレポートに表示され、返信とともに返されます。 |
|
メディアの URL
|
media_file | True | string |
250KB の最大ファイル サイズをサポートしますが、GIF はファイル サイズが 100 KB 未満の場合にのみサポートされます |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
HTTP コード
|
http_code | integer |
HTTP コード |
反応コード
|
response_code | string |
反応コード |
回答メッセージ
|
response_msg | string |
回答メッセージ |
合計価格
|
data.total_price | float |
合計価格 |
総数
|
data.total_count | integer |
総数 |
キュー登録済み数
|
data.queued_count | integer |
キュー登録済み数 |
メッセージ
|
data.messages | array of object |
メッセージ |
一覧 ID
|
data.messages.list_id | integer |
一覧 ID |
取引先担当者 ID
|
data.messages.contact_id | integer |
取引先担当者 ID |
メッセージ ID
|
data.messages.message_id | string |
メッセージ ID |
発信先
|
data.messages.to | string |
発信先 |
情報カテゴリ
|
data.messages.subject | string |
情報カテゴリ |
From
|
data.messages.from | string |
From |
本文
|
data.messages.body | string |
本文 |
国
|
data.messages.country | string |
国 |
カスタム文字列
|
data.messages.custom_string | string |
カスタム文字列 |
メッセージ パーツ
|
data.messages.message_parts | integer |
メッセージ パーツ |
メッセージ価格
|
data.messages.message_price | string |
メッセージ価格 |
メディア ファイルの URL
|
data.messages._media_file_url | string |
メディア ファイルの URL |
ステータス
|
data.messages.status | string |
ステータス |
SMS の送信
各 160 文字 = 1 SMS。 最大 1,224 標準文字まで送信できます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
発信先
|
to | True | string |
携帯電話番号。 ローカルまたは国際形式にすることができます。 他の国に送信する場合は、国際 (E.164) 形式である必要があります。 例: +61411111111。 |
本文
|
body | True | string |
160 文字で 1 SMS です。 最大 1,224 標準文字まで送信できます。 |
カスタム文字列
|
custom_string | string |
これは自分用の参照情報です。 すべてのレポートに表示され、返信とともに返されます。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
HTTP コード
|
http_code | integer |
HTTP コード |
反応コード
|
response_code | string |
反応コード |
応答メッセージ
|
response_msg | string |
応答メッセージ |
合計価格
|
data.total_price | float |
合計価格 |
総数
|
data.total_count | integer |
総数 |
キュー登録済み数
|
data.queued_count | integer |
キュー登録済み数 |
メッセージ
|
data.messages | array of object |
メッセージ |
通信方向
|
data.messages.direction | string |
通信方向 |
日
|
data.messages.date | integer |
日 |
発信先
|
data.messages.to | string |
発信先 |
本文
|
data.messages.body | string |
本文 |
From
|
data.messages.from | string |
From |
メッセージ ID
|
data.messages.message_id | string |
メッセージ ID |
メッセージ パーツ
|
data.messages.message_parts | integer |
メッセージ パーツ |
メッセージ価格
|
data.messages.message_price | string |
メッセージ価格 |
電子メールから
|
data.messages.from_email | string |
電子メールから |
リスト ID
|
data.messages.list_id | string |
リスト ID |
カスタム文字列
|
data.messages.custom_string | string |
カスタム文字列 |
取引先担当者 ID
|
data.messages.contact_id | string |
取引先担当者 ID |
ユーザー ID
|
data.messages.user_id | integer |
ユーザー ID |
サブアカウント ID
|
data.messages.subaccount_id | integer |
サブアカウント ID |
国
|
data.messages.country | string |
国 |
運送業者
|
data.messages.carrier | string |
運送業者 |
ステータス
|
data.messages.status | string |
ステータス |
通貨名ショート
|
data._currency.currency_name_short | string |
通貨名ショート |
通貨の接頭辞 D
|
data._currency.currency_prefix_d | string |
通貨の接頭辞 D |
通貨の接頭辞 C
|
data._currency.currency_prefix_c | string |
通貨の接頭辞 C |
長い通貨名
|
data._currency.currency_name_long | string |
長い通貨名 |
ボイス メッセージを送信する
各 300 文字 = 1 ボイス メッセージ。 最大 1,200 標準文字まで送信できます
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
発信先
|
to | True | string |
ローカルまたは国際形式の携帯電話または固定電話の電話番号。 別の国に送信する場合は、国際形式 (E.164) である必要があります。例: +61411111111。 |
本文
|
body | True | string |
読み上げるメッセージの本文。 |
言語
|
lang | True | string |
使用する言語を選択してください。 |
音声
|
voice | True | string |
メッセージを男性と女性のどちらの声で読み上げるかを選択します。 |
カスタム文字列
|
custom_string | string |
これは自分用の参照情報です。 すべてのレポートに表示され、返信とともに返されます。 |
|
入力が必要
|
require_input | integer |
受信者からのキー入力を受け取ります。 フラグ値は、はいの場合は 1、いいえの場合は 0 である必要があります。 |
|
マシン検出
|
machine_detection | integer |
留守番電話またはボイスメールを検出し、メッセージを残します。 フラグ値は、はいの場合は 1、いいえの場合は 0 である必要があります。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
HTTP コード
|
http_code | integer |
HTTP コード |
反応コード
|
response_code | string |
反応コード |
回答メッセージ
|
response_msg | string |
回答メッセージ |
合計価格
|
data.total_price | float |
合計価格 |
総数
|
data.total_count | integer |
総数 |
キュー登録済み数
|
data.queued_count | integer |
キュー登録済み数 |
メッセージ
|
data.messages | array of object |
メッセージ |
ユーザー ID
|
data.messages.user_id | integer |
ユーザー ID |
サブアカウント ID
|
data.messages.subaccount_id | integer |
サブアカウント ID |
メッセージ ID
|
data.messages.message_id | string |
メッセージ ID |
発信先
|
data.messages.to | string |
発信先 |
宛先の種類
|
data.messages.to_type | string |
宛先の種類 |
From
|
data.messages.from | string |
From |
音声
|
data.messages.voice | string |
音声 |
言語
|
data.messages.lang | string |
言語 |
本文
|
data.messages.body | string |
本文 |
運送業者
|
data.messages.carrier | string |
運送業者 |
国
|
data.messages.country | string |
国 |
カスタム文字列
|
data.messages.custom_string | string |
カスタム文字列 |
スケジュール
|
data.messages.schedule | integer |
スケジュール |
メッセージ パーツ
|
data.messages.message_parts | integer |
メッセージ パーツ |
メッセージ価格
|
data.messages.message_price | string |
メッセージ価格 |
追加された日付
|
data.messages.date_added | integer |
追加された日付 |
入力が必要
|
data.messages.require_input | integer |
入力が必要 |
マシン検出
|
data.messages.machine_detection | integer |
マシン検出 |
ステータス
|
data.messages.status | string |
ステータス |
通貨名ショート
|
data._currency.currency_name_short | string |
通貨名ショート |
通貨の接頭辞 D
|
data._currency.currency_prefix_d | string |
通貨の接頭辞 D |
通貨の接頭辞 C
|
data._currency.currency_prefix_c | string |
通貨の接頭辞 C |
長い通貨名
|
data._currency.currency_name_long | string |
長い通貨名 |
ポストカードを送信する
1 つ以上のポストカードを送信します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
件名
|
address_name | True | string |
事業所名 |
市
|
address_city | True | string |
市 |
完了状態
|
address_state | True | string |
完了状態 |
郵便番号
|
address_postal_code | True | string |
郵便番号 |
国
|
address_country | True | string |
国 |
差出人住所 ID
|
return_address_id | True | integer |
使用する差出人住所 ID |
Address Line 1
|
address_line_1 | True | string |
住所の 1 行目 |
住所行 2
|
address_line_2 | string |
住所の 2 行目 |
|
file_urls
|
file_urls | True | array of string |
PDF ファイルの URL |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
HTTP コード
|
http_code | integer |
HTTP コード |
応答コード
|
response_code | string |
応答コード |
回答メッセージ
|
response_msg | string |
回答メッセージ |
合計価格
|
data.total_price | double |
合計価格 |
総数
|
data.total_count | integer |
総数 |
キュー登録済み数
|
data.queued_count | integer |
キュー登録済み数 |
受信者
|
data.recipients | array of object |
受信者 |
ユーザー ID
|
data.recipients.user_id | integer |
ユーザー ID |
サブアカウント ID
|
data.recipients.subaccount_id | integer |
サブアカウント ID |
メッセージ ID
|
data.recipients.message_id | string |
メッセージ ID |
事業所名
|
data.recipients.address_name | string |
事業所名 |
住所 1
|
data.recipients.address_line_1 | string |
住所 1 |
住所 2
|
data.recipients.address_line_2 | string |
住所 2 |
住所の市区町村
|
data.recipients.address_city | string |
住所の市区町村 |
住所の都道府県
|
data.recipients.address_state | string |
住所の都道府県 |
住所の郵便番号
|
data.recipients.address_postal_code | string |
住所の郵便番号 |
住所の国
|
data.recipients.address_country | string |
住所の国 |
差出人住所 ID
|
data.recipients.return_address_id | integer |
差出人住所 ID |
スケジュール
|
data.recipients.schedule | integer |
スケジュール |
郵送料金
|
data.recipients.post_price | string |
郵送料金 |
ステータス
|
data.recipients.status | string |
ステータス |
追加された日付
|
data.recipients.date_added | integer |
追加された日付 |
ファイルの URL
|
data.recipients._file_url | string |
ファイルの URL |
差出人住所 ID
|
data.recipients._return_address.return_address_id | integer |
差出人住所 ID |
ユーザー ID
|
data.recipients._return_address.user_id | integer |
ユーザー ID |
事業所名
|
data.recipients._return_address.address_name | string |
事業所名 |
住所 1
|
data.recipients._return_address.address_line_1 | string |
住所 1 |
住所 2
|
data.recipients._return_address.address_line_2 | string |
住所 2 |
住所の市区町村
|
data.recipients._return_address.address_city | string |
住所の市区町村 |
住所の都道府県
|
data.recipients._return_address.address_state | string |
住所の都道府県 |
住所の郵便番号
|
data.recipients._return_address.address_postal_code | string |
住所の郵便番号 |
住所の国
|
data.recipients._return_address.address_country | string |
住所の国 |
API ユーザー名
|
data.recipients._api_username | string |
API ユーザー名 |
通貨名ショート
|
data._currency.currency_name_short | string |
通貨名ショート |
通貨の接頭辞 D
|
data._currency.currency_prefix_d | string |
通貨の接頭辞 D |
通貨の接頭辞 C
|
data._currency.currency_prefix_c | string |
通貨の接頭辞 C |
長い通貨名
|
data._currency.currency_name_long | string |
長い通貨名 |
メディア ファイル形式を変換する
メディア ファイル形式を変換する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ファイルを必要とするアクションを選択します
|
convert | True | string |
ファイルを必要とするアクションを選択します |
ファイル
|
content | True | byte |
ファイル コンテンツ (Base64) |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
HTTP コード
|
http_code | integer |
HTTP コード |
反応コード
|
response_code | string |
反応コード |
回答メッセージ
|
response_msg | string |
回答メッセージ |
アップロード ID
|
data.upload_id | integer |
アップロード ID |
ファイル名
|
data.file_name | string |
ファイル名 |
追加された日付
|
data.date_added | integer |
追加された日付 |
日付の削除
|
data.date_delete | integer |
日付の削除 |
ユーザー ID
|
data.user_id | integer |
ユーザー ID |
URL
|
data._url | string |
URL |
レターの送信
レターを送信します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
PDF ファイルの URL
|
file_url | True | string |
ファイルの最大サイズは 10 MB です。 すべてのページは縦方向である必要があります。 詳細な仕様については、ClickSend サポートとのチャットでご確認ください。 |
使用されているテンプレート
|
template_used | integer |
レター テンプレートを使用するかどうかを示します。 フラグ値は、はいの場合は 1、いいえの場合は 0 である必要があります。 |
|
色
|
colour | True | integer |
カラー印刷または白黒印刷のどちらを使用するかを選択します。 (白黒 = 0、カラー = 1) |
両面
|
duplex | True | integer |
両面印刷 = 1 (両面) または片面印刷 = 0 (片面) のどちらを使用するかを選択します。 |
郵便優先
|
priority_post | integer |
レターが優先事項であるかどうかにかかわらず、フラグ値は、はいの場合は 1、いいえの場合は 0 を指定します。 |
|
件名
|
address_name | True | string |
住所の名前 |
市
|
address_city | True | string |
市 |
完了状態
|
address_state | True | string |
完了状態 |
郵便番号
|
address_postal_code | True | string |
郵便番号 |
国
|
address_country | True | string |
国 |
差出人住所の選択
|
return_address_id | True | integer |
使用する差出人住所 ID |
住所 1
|
address_line_1 | True | string |
住所の 1 行目 |
住所 2
|
address_line_2 | string |
住所の 2 行目 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
HTTP コード
|
http_code | integer |
HTTP コード |
反応コード
|
response_code | string |
反応コード |
回答メッセージ
|
response_msg | string |
回答メッセージ |
合計価格
|
data.total_price | float |
合計価格 |
総数
|
data.total_count | integer |
総数 |
キュー登録済み数
|
data.queued_count | integer |
キュー登録済み数 |
受信者
|
data.recipients | array of object |
項目 |
ユーザー ID
|
data.recipients.user_id | integer |
ユーザー ID |
サブアカウント ID
|
data.recipients.subaccount_id | integer |
サブアカウント ID |
メッセージ ID
|
data.recipients.message_id | string |
メッセージ ID |
事業所名
|
data.recipients.address_name | string |
事業所名 |
住所 1
|
data.recipients.address_line_1 | string |
住所 1 |
住所 2
|
data.recipients.address_line_2 | string |
住所 2 |
住所の市区町村
|
data.recipients.address_city | string |
住所の市区町村 |
住所の都道府県
|
data.recipients.address_state | string |
住所の都道府県 |
住所の郵便番号
|
data.recipients.address_postal_code | string |
住所の郵便番号 |
住所の国
|
data.recipients.address_country | string |
住所の国 |
差出人住所 ID
|
data.recipients.return_address_id | integer |
差出人住所 ID |
カスタム文字列
|
data.recipients.custom_string | string |
カスタム文字列 |
ソース
|
data.recipients.source | string |
ソース |
色
|
data.recipients.colour | integer |
色 |
両面
|
data.recipients.duplex | integer |
両面 |
郵便ページ
|
data.recipients.post_pages | integer |
郵便ページ |
郵送料金
|
data.recipients.post_price | string |
郵送料金 |
郵便優先
|
data.recipients.priority_post | integer |
郵便優先 |
追加された日付
|
data.recipients.date_added | integer |
追加された日付 |
ステータス
|
data.recipients.status | string |
ステータス |
ファイルの URL
|
data.recipients._file_url | string |
ファイルの URL |
差出人住所 ID
|
data.recipients._return_address.return_address_id | integer |
差出人住所 ID |
ユーザー ID
|
data.recipients._return_address.user_id | integer |
ユーザー ID |
事業所名
|
data.recipients._return_address.address_name | string |
事業所名 |
住所 1
|
data.recipients._return_address.address_line_1 | string |
住所 1 |
住所 2
|
data.recipients._return_address.address_line_2 | string |
住所 2 |
住所の市区町村
|
data.recipients._return_address.address_city | string |
住所の市区町村 |
住所の都道府県
|
data.recipients._return_address.address_state | string |
住所の都道府県 |
住所の郵便番号
|
data.recipients._return_address.address_postal_code | string |
住所の郵便番号 |
住所の国
|
data.recipients._return_address.address_country | string |
住所の国 |
API ユーザー名
|
data.recipients._api_username | string |
API ユーザー名 |
通貨名ショート
|
data._currency.currency_name_short | string |
通貨名ショート |
通貨の接頭辞 D
|
data._currency.currency_prefix_d | string |
通貨の接頭辞 D |
通貨の接頭辞 C
|
data._currency.currency_prefix_c | string |
通貨の接頭辞 C |
長い通貨名
|
data._currency.currency_name_long | string |
長い通貨名 |
一覧で取引先担当者を取得する
一覧ですべての取引先担当者を取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
一覧 ID
|
list_id | True | integer |
一覧 ID の取得には、取引先担当者一覧の検索アクションまたは取引先担当者一覧の取得アクションを使用することができます |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
HTTP コード
|
http_code | integer |
HTTP コード |
反応コード
|
response_code | string |
反応コード |
回答メッセージ
|
response_msg | string |
回答メッセージ |
合計
|
data.total | integer |
合計 |
ページあたり
|
data.per_page | integer |
ページあたり |
現在のページ
|
data.current_page | integer |
現在のページ |
最後のページ
|
data.last_page | integer |
最後のページ |
次のページの URL
|
data.next_page_url | string |
次のページの URL |
前のページの URL
|
data.prev_page_url | string |
前のページの URL |
From
|
data.from | integer |
From |
発信先
|
data.to | integer |
発信先 |
data
|
data.data | array of object |
data |
取引先担当者 ID
|
data.data.contact_id | integer |
取引先担当者 ID |
一覧 ID
|
data.data.list_id | integer |
一覧 ID |
電話番号
|
data.data.phone_number | string |
電話番号 |
名
|
data.data.first_name | string |
名 |
姓
|
data.data.last_name | string |
姓 |
カスタム 1
|
data.data.custom_1 | string |
カスタム 1 |
カスタム 2
|
data.data.custom_2 | string |
カスタム 2 |
カスタム 3
|
data.data.custom_3 | string |
カスタム 3 |
カスタム 4
|
data.data.custom_4 | string |
カスタム 4 |
date_added
|
data.data.date_added | integer |
追加された日付 |
更新された日付
|
data.data.date_updated | integer |
更新された日付 |
FAX 番号
|
data.data.fax_number | string |
FAX 番号 |
組織名
|
data.data.organization_name | string |
組織名 |
電子メール
|
data.data.email | string |
電子メール |
住所 1
|
data.data.address_line_1 | string |
住所 1 |
住所 2
|
data.data.address_line_2 | string |
住所 2 |
住所の市区町村
|
data.data.address_city | string |
住所の市区町村 |
住所の都道府県
|
data.data.address_state | string |
住所の都道府県 |
住所の郵便番号
|
data.data.address_postal_code | string |
住所の郵便番号 |
住所の国
|
data.data.address_country | string |
住所の国 |
一覧名
|
data.data._list_name | string |
一覧名 |
一覧を削除する
特定の取引先担当者一覧を削除する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
一覧 ID
|
list_id | True | integer |
一覧 ID の取得には、取引先担当者一覧の検索アクションまたは取引先担当者一覧の取得アクションを使用することができます |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
HTTP コード
|
http_code | integer |
HTTP コード |
反応コード
|
response_code | string |
反応コード |
回答メッセージ
|
response_msg | string |
回答メッセージ |
取引先担当者の一覧を取得する
詳細オプションで指定されていない限り、すべての取引先担当者の一覧を取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ番号
|
page | integer |
ページ番号 |
|
ページあたりのレコード数
|
limit | integer |
ページあたりのレコード数 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
HTTP コード
|
http_code | integer |
HTTP コード |
反応コード
|
response_code | string |
反応コード |
回答メッセージ
|
response_msg | string |
回答メッセージ |
合計
|
data.total | integer |
合計 |
ページあたり
|
data.per_page | integer |
ページあたり |
現在のページ
|
data.current_page | integer |
現在のページ |
最後のページ
|
data.last_page | integer |
最後のページ |
次のページの URL
|
data.next_page_url | string |
次のページの URL |
前のページの URL
|
data.prev_page_url | string |
前のページの URL |
From
|
data.from | integer |
From |
発信先
|
data.to | integer |
終了 |
data
|
data.data | array of object |
data |
一覧 ID
|
data.data.list_id | integer |
一覧 ID |
一覧名
|
data.data.list_name | string |
一覧名 |
一覧の電子メール ID
|
data.data.list_email_id | string |
一覧の電子メール ID |
取引先担当者数
|
data.data._contacts_count | integer |
取引先担当者数 |
インポート処理中
|
data.data._import_in_progress | integer |
インポート処理中 |
OptOut 処理中
|
data.data._optout_in_progress | integer |
OptOut 処理中 |
取引先担当者を削除する
取引先担当者を削除する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
一覧 ID
|
list_id | True | integer |
一覧 ID の取得には、取引先担当者一覧の検索アクションまたは取引先担当者一覧の取得アクションを使用することができます |
取引先担当者 ID
|
contact_id | True | integer |
取引先担当者 ID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
HTTP コード
|
http_code | integer |
HTTP コード |
反応コード
|
response_code | string |
反応コード |
回答メッセージ
|
response_msg | string |
回答メッセージ |
取引先担当者一覧を検索する
検索された取引先担当者一覧を取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
一覧名
|
q | True | string |
検索対象 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
HTTP コード
|
http_code | integer |
HTTP コード |
反応コード
|
response_code | string |
反応コード |
回答メッセージ
|
response_msg | string |
回答メッセージ |
合計
|
data.total | integer |
合計 |
ページあたり
|
data.per_page | integer |
ページあたり |
現在のページ
|
data.current_page | integer |
現在のページ |
最後のページ
|
data.last_page | integer |
最後のページ |
次のページの URL
|
data.next_page_url | string |
次のページの URL |
前のページの URL
|
data.prev_page_url | string |
前のページの URL |
From
|
data.from | integer |
From |
発信先
|
data.to | integer |
発信先 |
data
|
data.data | array of object |
data |
ID
|
data.data.id | integer |
ID |
件名
|
data.data.name | string |
件名 |
連絡先
|
data.data.contact | string |
連絡先 |
タイプ
|
data.data.type | string |
タイプ |
取引先担当者数
|
data.data.contacts_count | integer |
取引先担当者数 |
新しい取引先担当者の作成
新しい取引先担当者の作成
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
一覧 ID
|
list_id | True | integer |
一覧 ID の取得には、取引先担当者一覧の検索アクションまたは取引先担当者一覧の取得アクションを使用することができます |
名
|
first_name | True | string |
取引先担当者の名。 |
姓
|
last_name | True | string |
取引先担当者の姓。 |
電話番号
|
phone_number | True | string |
ローカルまたは国際形式の取引先担当者の電話番号 例: +61411111111。 |
電子メール
|
string |
取引先担当者の電子メール アドレス。 |
||
FAX 番号
|
fax_number | string |
取引先担当者の FAX 番号。 |
|
組織名
|
organization_name | string |
取引先担当者の組織名。 |
|
国
|
address_country | string |
取引先担当者の国。 |
|
完了状態
|
address_state | string |
完了状態 |
|
市
|
address_city | string |
住所の市区町村 |
|
カスタム 1
|
custom_1 | string |
カスタム 1 |
|
カスタム 3
|
custom_3 | string |
カスタム 3 |
|
郵便番号
|
address_postal_code | string | ||
カスタム 2
|
custom_2 | string |
カスタム 2 |
|
カスタム 4
|
custom_4 | string |
カスタム 4 |
|
住所 1
|
address_line_1 | string |
住所 1 |
|
住所 2
|
address_line_2 | string |
住所 2 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
HTTP コード
|
http_code | integer |
HTTP コード |
反応コード
|
response_code | string |
反応コード |
回答メッセージ
|
response_msg | string |
回答メッセージ |
取引先担当者 ID
|
data.contact_id | integer |
取引先担当者 ID |
一覧 ID
|
data.list_id | integer |
一覧 ID |
電話番号
|
data.phone_number | string |
電話番号 |
名
|
data.first_name | string |
名 |
姓
|
data.last_name | string |
姓 |
カスタム 1
|
data.custom_1 | string |
カスタム 1 |
カスタム 2
|
data.custom_2 | string |
カスタム 2 |
カスタム 3
|
data.custom_3 | string |
カスタム 3 |
カスタム 4
|
data.custom_4 | string |
カスタム 4 |
追加された日付
|
data.date_added | integer |
追加された日付 |
FAX 番号
|
data.fax_number | string |
FAX 番号 |
組織名
|
data.organization_name | string |
組織名 |
電子メール
|
data.email | string |
電子メール |
住所 1
|
data.address_line_1 | string |
住所 1 |
住所 2
|
data.address_line_2 | string |
住所 2 |
住所の市区町村
|
data.address_city | string |
住所の市区町村 |
住所の都道府県
|
data.address_state | string |
住所の都道府県 |
住所の郵便番号
|
data.address_postal_code | string |
住所の郵便番号 |
住所の国
|
data.address_country | string |
住所の国 |
一覧名
|
data._list_name | string |
一覧名 |
新しい取引先担当者一覧を作成する
新しい取引先担当者一覧を作成する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
一覧名
|
list_name | True | string |
取引先担当者一覧の名前 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
HTTP コード
|
http_code | integer |
HTTP コード |
反応コード
|
response_code | string |
反応コード |
回答メッセージ
|
response_msg | string |
回答メッセージ |
一覧 ID
|
data.list_id | integer |
一覧 ID |
一覧名
|
data.list_name | string |
一覧名 |
一覧の電子メール ID
|
data.list_email_id | string |
一覧の電子メール ID |
取引先担当者数
|
data._contacts_count | integer |
取引先担当者数 |
トリガー
SMS 受信の自動化 |
新しい SMS 受信の自動化を作成します |
SMS 受信の自動化
新しい SMS 受信の自動化を作成します
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
本文
|
body | string |
本文 |
発信先
|
to | string |
受信者の電話番号 |
From
|
from | string |
送信者 ID |
カスタム文字列
|
custom_string | string |
custom_string |
元のメッセージの ID
|
original_message_id | string |
original_message_id |
元の本文
|
original_body | string |
元の本文 |
ユーザー ID
|
user_id | integer |
メッセージを送信したユーザーのユーザー ID。 |
サブアカウント ID
|
subaccount_id | integer |
メッセージを送信したユーザーのサブアカウント ID。 |
タイムスタンプ
|
timestamp | string |
UNIX 形式のタイムスタンプ |
メッセージ ID
|
message_id | string |
受信メッセージのメッセージ ID |