Text Request

  • リファレンス

Text Request は、企業が会話を顧客に変えるのに役立つビジネス テキスト メッセージ プラットフォームです。

このコネクタは、次の製品および地域で利用可能です:

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   US Government (GCC)
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   US Government (GCC)
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Text Request API サポート
[URL] https://www.textrequest.com/contact
メール apidev@textrequest.com
Connector Metadata
発行者 Text Request
Web サイト https://www.textrequest.com/
プライバシー ポリシー https://www.textrequest.com/privacy-policy/
カテゴリー 通信; 営業と CRM

Text Request は、顧客とつながり、エンゲージメントを促進し、顧客を売上に変えるのに役立つビジネス テキスト メッセージ ソリューションです。 Text Request を使用すると、ビジネス テキスト メッセージを別々の電話回線に編成し、顧客へのマーケティングを迅速かつ効率的に開始できます。

前提条件

このコネクタには、API アクセス を持った Text Request アカウントが必要です。 詳細については、私たちの Web サイト をご覧ください。

資格情報の入手方法

この統合を使用するには、テキスト リクエストから API キーを取得する必要があります。 Text Request プランに API アクセスがあるかどうかを確認するには、プランの内訳 をご覧ください。 API アクセスがないプランをお持ちの場合は、50$/月のアドオン機能として追加できます。

  • Text Request アカウントにサインインします
  • 左側のナビゲーション サイドバーの統合ページをクリックします
  • API タイルを検索します。 リンクに "今すぐ追加" と表示されている場合は、API アクセスのプランがありません。 "今すぐ追加" リンクをクリックして追加できます。 それ以外の場合は、"API キーと Webhook" のリンクをクリックします
  • API キーを選択して、コピーします。 このキーは、接続を承認するために必要なすべてです

コネクタの使用を開始する

Power Automate でこの接続を選択して接続するには、API キーを入力するよう求められます。 その後、接続を使用して、他の接続でトリガーが設定されるたびに、テキスト メッセージを送信し、テキスト リクエストで連絡先情報を更新できます。 顧客が Hubspot にサインオンしたときにトリガーする自動化を作成して、最初のテキストを送信したり、特別なグループに配置したりできます。 Survey Monkey に接続して、連絡先がフォームを送信したときに Text Request に追加できます。

既知の問題と制限事項

このコネクタに含まれていない Text Request API の呼び出しがいくつかあります。 具体的には、Text Request の Webhook をフロー トリガーとして使用することは含まれていません。 Text Request アカウントにアクセスし、API キーを取得したのと同じ場所に移動して、アカウントに Webhook を追加できます。ただし、自動化を有効にすることはできません。 含まれていない API 呼び出しについては、API ドキュメントに こちら からアクセスでき、Power Automate の HTTP アクションを使って未使用の呼び出しへの呼び出しを作成します。

一般的なエラーと解決策

いずれかのリクエストで 404 エラーが発生した場合は、渡されたダッシュボード ID を再確認してください。 GetDashboards アクションを使用して、ダッシュボードとその ID のリストを表示できます。

連絡先またはその他の値を取得している場合、自動的に入力される yes/no の値に気付く場合があります。 これらの値は 必須ではありません が、無効な回答が含まれないように、デフォルトで含まれています。 連絡先が非表示、アーカイブ、ブロック、またはオプトアウトされているかどうかに関係なく、すべての連絡先を取得するには、そのフィールドからデフォルトの "いいえ" の値を削除します。

接続を作成する

このコネクタは、次の認証タイプをサポートしています:
既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

件名 タイプ 内容 必要
API キー securestring この API の API キー True

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

ID を指定してグループを取得します

指定された ID を持つグループを取得します。
このダッシュボードのすべての会話を取得する

このダッシュボードのすべての会話を取得し、各会話の最後のメッセージに関する情報を含めます。
この特定のダッシュボードに関する情報を取得する

ダッシュボードの名前と電話番号を返します。
すべてのカスタム フィールドの取得

このダッシュボードのすべてのカスタム フィールドを取得します。 カスタム フィールドは、ダッシュボード間で一意です。
すべてのグループを取得します

ユーザーのアカウントのすべてのグループを取得します。
すべてのタグを取得する

このダッシュボードのすべてのタグを取得します。 タグは、ダッシュボード間で一意です。
すべての支払いを取得

キャンセルされた支払いと支払い済みの支払いを含む、すべての支払いを取得します。 これらは、クエリ パラメーターを使用してフィルター処理できます。
アカウント内のすべてのダッシュボードを取得する

アカウント内のすべてのダッシュボードを返します。
会話をアーカイブする

会話をアーカイブすると、すべての会話取得エンドポイントの結果から会話が削除されます。 顧客がテキスト リクエスト番号にテキストを送信した場合、または Text Request 番号から顧客にテキストを送信した場合、会話は自動的にアーカイブ解除されます。 会話をアーカイブすることは、今後話す予定のない顧客から混乱を取り除く良い方法です。 顧客がこれ以上 SMS メッセージを送信できないように "STOP" とテキスト メッセージを送信した場合、会話は自動的にアーカイブされることに注意してください。
会話をアーカイブ解除する

会話をアーカイブ解除します。 会話がアーカイブ解除されると、再びキューに表示されます。 /conversations エンドポイント によって返される会話にも表示されます。 会話が既にアーカイブ解除されている場合、このメソッドは効果がありません。
指定された ID でグループを更新します

グループの数値IDを使用してグループの名前を更新します。渡されたグループ ID が存在しない場合、呼び出しは失敗します。
指定された ID を持つグループを削除します

指定された ID を持つグループを削除します。これは、グループのメンバーである連絡先がある場合でも成功します (連絡先は削除されません)。
指定された ID を持つ支払いを取得する

指定された ID を持つ支払いを取得します。
指定されたフィルタリング条件に一致するすべての連絡先を取得する

指定されたフィルタリング条件に一致するすべての連絡先を取得します。 指定されたダッシュボードのみが検索されます。使用可能な番号のアカウント レベルの検索はありません。
指定された名前と電話番号で新しいダッシュボードを作成します

アカウントに新しいダッシュボードを作成します。 ダッシュボードが作成されると、管理者に変更に関するメールが送信され、ユーザーの割り当てを開始できます。 このエンドポイントは、プロビジョニングされた番号のダッシュボードを作成できます。 GET /dashboards/provisioning を使用して、特定の市外局番でプロビジョニングされた番号を検索できます。 電話番号が既に使用されている場合は、Bad Request 例外がスローされます。
指定された支払いをキャンセルする

指定された支払いをキャンセルし、支払いがキャンセルされたことをユーザーに通知します。 支払いは編集できないため、キャンセルして新しい支払いを発行することが、支払いを修正する最善の方法です。
指定された支払いを支払うようユーザーに通知するフォローアップ テキストを送信する

指定された支払いを支払うよう連絡先にリマインダーを送信します。 メッセージの内容は自動生成されます。 スパムを避けるため、支払いごとに送信できるリマインダーは 1 つだけです
指定された電話番号の連絡先にメッセージを送信します

メッセージを送信します (指定された電話番号にメッセージ履歴がない場合は、新しい会話を開始します)。
指定したダッシュボードを削除します

指定したダッシュボードを削除します。
指定した電話番号の連絡先を削除します

このダッシュボードにこの電話番号の連絡先が存在しない場合、コンテンツは返されません。 連絡先が存在するが、メッセージ履歴がない場合、コンテンツは返されず、正常な状態コードは削除されたことを示します。 連絡先にメッセージ履歴がある場合は削除できず、Bad Request エラーが返されます。
指定した電話番号の連絡先を取得します

このダッシュボードにこの電話番号の連絡先が存在しない場合、コンテンツは返されず、エラーはスローされません。 指定されたダッシュボードのみ検索され、連絡先はダッシュボードごとに整理され、アカウント レベルで番号を検索することはできません。
支払いを支払い済としてマークする

支払いを "支払い済" としてクローズします。 この エンドポイント は、支払いリクエスト ポータル以外の手段で支払いが行われる場合に使用します。 これにより支払いが終了し、その支払い額が統計に追加されます。 このエンドポイントは、テキスト リクエストを通じて送信された支払いポータルを通じて支払われる支払いには必要ありません。これにより、支払いが自動的に支払い済みとしてマークされます。
新しい支払いの作成

指定された連絡先への指定されたメッセージで新しい支払いを作成します。
新規グループの作成

提供された名前を持つ新規グループを作成する。
特定のダッシュボード名を更新する

ダッシュボードを更新します。 これにより、ダッシュボードの電話番号が変更されることはありません。 別のダッシュボードの連絡先で新しい番号が必要な場合は、POST で新しいダッシュボードを作成し、一括エクスポート/インポートで連絡先を追加する必要があります。
連絡先の一括更新

指定されたダッシュボードのみに連絡先が追加されます。連絡先はダッシュボードごとに整理されており、アカウント レベルで番号を検索することはできません。
連絡先の電話番号で会話のメッセージを取得する

指定されたダッシュボードと電話番号の間の会話を取得します。
連絡先を作成または更新する

連絡先を作成または更新します (指定された電話番号の連絡先が既に存在するかどうかによって異なります)。

ID を指定してグループを取得します

操作 ID:
GetGroupById

指定された ID を持つグループを取得します。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
グループの ID
 group_id True integer

取得するグループの数値 ID。

戻り値

名前 パス 型 説明
id
 id integer

グループの数値 ID。
group_member_count
 group_member_count integer

グループ内のメンバーの数。
is_keyword
 is_keyword boolean

このグループがキーワード グループかどうか。 このようなグループは、ユーザーがキーワードを設定すると自動生成されます。 連絡先は、登録時に自動的に追加されます。
名称
 name string

このグループの名前。
メモ
 notes string

このグループに関するメモ。
last_message_sent_utc
 last_message_sent_utc string

最後のグループ メッセージがこのグループに送信されたときのタイムスタンプ。

このダッシュボードのすべての会話を取得する

操作 ID:
GetConversations

このダッシュボードのすべての会話を取得し、各会話の最後のメッセージに関する情報を含めます。

パラメーター

名前 キー 必須 型 説明
連絡先タグ
 tags string

会話をフィルター処理するタグを参照する GUID のカンマ区切りリスト。
解決済みの会話のみを表示するかどうか
 show_unresolved_only string

会話が解決された連絡先のみを検索するかどうか。 これがfalseの場合、解決済みの会話と未解決の会話の両方が表示されます。
アーカイブした会話を含めるかどうか
 include_archived string

アーカイブされた連絡先との会話を含めるかどうか。
電話番号と連絡先名をフィルターする用語
 search string

電話番号または表示名で会話をフィルタリングするための 検索語句。 検索語句 が氏名または電話番号よりも小さい場合、検索はそれに部分的に一致するすべての会話を返します。
取得するページ番号
 page integer

取得するエンティティのページ。 値を取得する場合、page_size で定義されたページあたりの最大サイズがあります。 ページが最後のページより大きい場合、空の配列が返されます。
ページごとに取得する各エンティティの量
 page_size integer

取得する各ページのサイズ。 値を取得する場合、これはページごとの最大サイズであり、後続のページへのアクセスはページ パラメータによって行われます。
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。

戻り値

名前 パス 型 説明
page
 meta.page integer

取得するエンティティのページ。 このページ内のエンティティの量は、page_size によって定義されます。
page_size
 meta.page_size integer

このページで取得したエンティティの数。
total_items
 meta.total_items integer

ページのサイズや数に関係なく、データベースで使用できるエンティティの数。 他のページを表示するには、リクエストでページ番号を変更します。
アイテム
 items array of object

Text Request から取得した会話エンティティのリスト。
phone_number
 items.phone_number string

取引先担当者の電話番号。
message_id
 items.last_message.message_id string

メッセージの ID。 この値は各メッセージに対して固有のものです。
body
 items.last_message.body string

このメッセージのコンテンツ。
message_direction
 items.last_message.message_direction string

R または S のいずれかの単数文字で、このメッセージが連絡先から受信されたか、連絡先に送信されたかをそれぞれ示します。
response_by_username
 items.last_message.response_by_username string

このユーザーに最後にメッセージを送信した Text Request ユーザーのユーザー名。
message_timestamp_utc
 items.last_message.message_timestamp_utc string

Text Request によってメッセージが送信、または受信されたときのタイムスタンプ。
delivery_status
 items.last_message.delivery_status string

このメッセージの現在の状態。 これは、'送信中'、'配信済み'、'エラー'、または '送信' のいずれかです。
delivery_error
 items.last_message.delivery_error string

このメッセージが配信されない原因となったエラー。 delivery_status が 'エラー' でない場合、この値は null になります。
mms_media
 items.last_message.mms_media array of string

このメッセージの添付ファイルを指す URL のリスト。 すべての URL は、テキスト リクエストによって生成された URL になります。

この特定のダッシュボードに関する情報を取得する

操作 ID:
GetDashboard

ダッシュボードの名前と電話番号を返します。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。

戻り値

名前 パス 型 説明
id
 id integer

ダッシュボードの数値 ID。
名称
 name string

ダッシュボードの名前。
電話番号
 phone string

このダッシュボードに関連付けられたテキスト番号。

すべてのカスタム フィールドの取得

操作 ID:
GetCustomFields

このダッシュボードのすべてのカスタム フィールドを取得します。 カスタム フィールドは、ダッシュボード間で一意です。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。

戻り値

名前 パス 型 説明
array of object
id
 id string

フィールドの数値 ID。
名称
 name string

カスタム フィールドの名前。

すべてのグループを取得します

操作 ID:
GetGroups

ユーザーのアカウントのすべてのグループを取得します。

パラメーター

名前 キー 必須 型 説明
取得するページ番号
 page True integer

取得するエンティティのページ。 値を取得する場合、page_size で定義されたページあたりの最大サイズがあります。 ページが最後のページより大きい場合、空の配列が返されます。
ページごとに取得する各エンティティの量
 page_size True integer

取得する各ページのサイズ。 値を取得する場合、これはページごとの最大サイズであり、後続のページへのアクセスはページ パラメータによって行われます。
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。

戻り値

名前 パス 型 説明
page
 meta.page integer

取得するエンティティのページ。 このページ内のエンティティの量は、page_size によって定義されます。
page_size
 meta.page_size integer

このページで取得したエンティティの数。
total_items
 meta.total_items integer

ページのサイズや数に関係なく、データベースで使用できるエンティティの数。 他のページを表示するには、リクエストでページ番号を変更します。
アイテム
 items array of object

Text Request から取得したグループ エンティティのリスト。
id
 items.id integer

グループの数値 ID。
group_member_count
 items.group_member_count integer

グループ内のメンバーの数。
is_keyword
 items.is_keyword boolean

このグループがキーワード グループかどうか。 このようなグループは、ユーザーがキーワードを設定すると自動生成されます。 連絡先は、登録時に自動的に追加されます。
名称
 items.name string

このグループの名前。
メモ
 items.notes string

このグループに関するメモ。
last_message_sent_utc
 items.last_message_sent_utc string

最後のグループ メッセージがこのグループに送信されたときのタイムスタンプ。

すべてのタグを取得する

操作 ID:
GetTags

このダッシュボードのすべてのタグを取得します。 タグは、ダッシュボード間で一意です。

パラメーター

名前 キー 必須 型 説明
取得するページ番号
 page True integer

取得するエンティティのページ。 値を取得する場合、page_size で定義されたページあたりの最大サイズがあります。 ページが最後のページより大きい場合、空の配列が返されます。
ページごとに取得する各エンティティの量
 page_size True integer

取得する各ページのサイズ。 値を取得する場合、これはページごとの最大サイズであり、後続のページへのアクセスはページ パラメータによって行われます。
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。

戻り値

名前 パス 型 説明
page
 meta.page integer

取得するエンティティのページ。 このページ内のエンティティの量は、page_size によって定義されます。
page_size
 meta.page_size integer

このページで取得したエンティティの数。
total_items
 meta.total_items integer

ページのサイズや数に関係なく、データベースで使用できるエンティティの数。 他のページを表示するには、リクエストでページ番号を変更します。
アイテム
 items array of object

Text Request から取得したタグ エンティティのリスト。
id
 items.id string

タグの数値 ID。
tag_color
 items.tag_color string

タグの色。 これは、有効な 16 進数のカラー コードである必要があります。
tag
 items.tag string

タグの名前。

すべての支払いを取得

操作 ID:
GetPayments

キャンセルされた支払いと支払い済みの支払いを含む、すべての支払いを取得します。 これらは、クエリ パラメーターを使用してフィルター処理できます。

パラメーター

名前 キー 必須 型 説明
支払いの参照文字列
 reference_number string

支払いをすばやく見つけるために使用できる、支払いの作成時に定義されたユーザー定義の ID。 参照番号は一意ではありません。多くの支払いが同じ参照を持つことができます。
支払いの電話番号
 phone_number string

送信されるこの支払いの連絡先の電話番号。
並べ替え順
 sort_type string

支払いを並べ替えるプロパティ条件。 "金額"、"連絡先"、"日付"、"ステータス" のいずれかです。
ソート方向
 sort_direction string

支払いを並べ替える方向。 "desc" は降順、または "asc" は昇順で指定できます。
取得するページ番号
 page True integer

取得するエンティティのページ。 値を取得する場合、page_size で定義されたページあたりの最大サイズがあります。 ページが最後のページより大きい場合、空の配列が返されます。
ページごとに取得する各エンティティの量
 page_size True integer

取得する各ページのサイズ。 値を取得する場合、これはページごとの最大サイズであり、後続のページへのアクセスはページ パラメータによって行われます。
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。

戻り値

名前 パス 型 説明
page
 meta.page integer

取得するエンティティのページ。 このページ内のエンティティの量は、page_size によって定義されます。
page_size
 meta.page_size integer

このページで取得したエンティティの数。
total_items
 meta.total_items integer

ページのサイズや数に関係なく、データベースで使用できるエンティティの数。 他のページを表示するには、リクエストでページ番号を変更します。
アイテム
 items array of object

Text Request から取得した連絡先エンティティのリスト。
payment_id
 items.payment_id integer

支払いの数値 ID。
request_date
 items.request_date string

この支払いの最初のメッセージが送信キューに入れられたときのタイムスタンプ。
受信者
 items.recipient string

支払い受信者の名前。 連絡先の電話番号に名前が関連付けられていない場合、これは null になる可能性があります。
description
 items.description string

支払いの説明。 これは連絡先に表示されません。 これは、支払いに関するコンテキストのために内部ユーザーによってのみ使用されます。
customer_phone
 items.customer_phone string

この支払いの送信先の連絡先の電話番号。
amount_requested
 items.amount_requested float

この支払いで要求されたドル単位の金額。
is_past_due
 items.is_past_due boolean

この支払いが要求日を過ぎているかどうか。
reminder_was_sent
 items.reminder_was_sent boolean

この支払いに対してテキスト リマインダーが既に送信されているかどうか。
transaction_status
 items.transaction_status string

authvia のトランザクションの状態。 この値は不明として開始します。
textrequest_payment_status
 items.textrequest_payment_status string

Text Request のトランザクションの状態。 これは、Text Request アプリの支払いページに表示されるステータスを表します。 これは送信済みとして開始されます。
reference_number
 items.reference_number string

支払いをすばやく見つけるために使用できる、支払いの作成時に定義されたユーザー定義の ID。 参照番号は一意ではありません。多くの支払いが同じ参照を持つことができます。

アカウント内のすべてのダッシュボードを取得する

操作 ID:
GetDashboards

アカウント内のすべてのダッシュボードを返します。

パラメーター

名前 キー 必須 型 説明
取得するページ番号
 page True integer

取得するエンティティのページ。 値を取得する場合、page_size で定義されたページあたりの最大サイズがあります。 ページが最後のページより大きい場合、空の配列が返されます。
ページごとに取得する各エンティティの量
 page_size True integer

取得する各ページのサイズ。 値を取得する場合、これはページごとの最大サイズであり、後続のページへのアクセスはページ パラメータによって行われます。

戻り値

名前 パス 型 説明
page
 meta.page integer

取得するエンティティのページ。 このページ内のエンティティの量は、page_size によって定義されます。
page_size
 meta.page_size integer

このページで取得したエンティティの数。
total_items
 meta.total_items integer

ページのサイズや数に関係なく、データベースで使用できるエンティティの数。 他のページを表示するには、リクエストでページ番号を変更します。
アイテム
 items array of object

Text Request から取得したダッシュボード エンティティのリスト。
id
 items.id integer

ダッシュボードの数値 ID。
名称
 items.name string

ダッシュボードの名前。
電話番号
 items.phone string

このダッシュボードに関連付けられたテキスト番号。

会話をアーカイブする

操作 ID:
ArchiveConversation

会話をアーカイブすると、すべての会話取得エンドポイントの結果から会話が削除されます。 顧客がテキスト リクエスト番号にテキストを送信した場合、または Text Request 番号から顧客にテキストを送信した場合、会話は自動的にアーカイブ解除されます。 会話をアーカイブすることは、今後話す予定のない顧客から混乱を取り除く良い方法です。 顧客がこれ以上 SMS メッセージを送信できないように "STOP" とテキスト メッセージを送信した場合、会話は自動的にアーカイブされることに注意してください。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
会話の電話番号
 phone_number True string

アーカイブする会話の電話番号。

戻り値

返答
string

会話をアーカイブ解除する

操作 ID:
UnarchiveConversation

会話をアーカイブ解除します。 会話がアーカイブ解除されると、再びキューに表示されます。 /conversations エンドポイント によって返される会話にも表示されます。 会話が既にアーカイブ解除されている場合、このメソッドは効果がありません。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
会話の電話番号
 phone_number True string

アーカイブする会話の電話番号。

戻り値

返答
string

指定された ID でグループを更新します

操作 ID:
UpdateGroup

グループの数値IDを使用してグループの名前を更新します。渡されたグループ ID が存在しない場合、呼び出しは失敗します。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
グループの ID
 group_id True integer

更新するグループの数値 ID。
Group name
 name string

グループの新しい名前。
グループ ノート
 notes string

グループを説明する短いフレーズ。 便宜上の使用。

戻り値

名前 パス 型 説明
id
 id integer

グループの数値 ID。
group_member_count
 group_member_count integer

グループ内のメンバーの数。
is_keyword
 is_keyword boolean

このグループがキーワード グループかどうか。 このようなグループは、ユーザーがキーワードを設定すると自動生成されます。 連絡先は、登録時に自動的に追加されます。
名称
 name string

このグループの名前。
メモ
 notes string

このグループに関するメモ。
last_message_sent_utc
 last_message_sent_utc string

最後のグループ メッセージがこのグループに送信されたときのタイムスタンプ。

指定された ID を持つグループを削除します

操作 ID:
DeleteGroup

指定された ID を持つグループを削除します。これは、グループのメンバーである連絡先がある場合でも成功します (連絡先は削除されません)。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
グループの ID
 group_id True integer

削除するグループの数値 ID。

戻り値

返答
string

指定された ID を持つ支払いを取得する

操作 ID:
GetPayment

指定された ID を持つ支払いを取得します。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
支払いの ID
 payment_id True integer

取得する支払いの数値 ID。

戻り値

名前 パス 型 説明
payment_id
 payment_id integer

支払いの数値 ID。
request_date
 request_date string

この支払いの最初のメッセージが送信キューに入れられたときのタイムスタンプ。
受信者
 recipient string

支払い受信者の名前。 連絡先の電話番号に名前が関連付けられていない場合、これは null になる可能性があります。
description
 description string

支払いの説明。 これは連絡先に表示されません。 これは、支払いに関するコンテキストのために内部ユーザーによってのみ使用されます。
customer_phone
 customer_phone string

この支払いの送信先の連絡先の電話番号。
amount_requested
 amount_requested float

この支払いで要求されたドル単位の金額。
is_past_due
 is_past_due boolean

この支払いが要求日を過ぎているかどうか。
reminder_was_sent
 reminder_was_sent boolean

この支払いに対してテキスト リマインダーが既に送信されているかどうか。
transaction_status
 transaction_status string

authvia のトランザクションの状態。 この値は不明として開始します。
textrequest_payment_status
 textrequest_payment_status string

Text Request のトランザクションの状態。 これは、Text Request アプリの支払いページに表示されるステータスを表します。 これは送信済みとして開始されます。
reference_number
 reference_number string

支払いをすばやく見つけるために使用できる、支払いの作成時に定義されたユーザー定義の ID。 参照番号は一意ではありません。多くの支払いが同じ参照を持つことができます。

指定されたフィルタリング条件に一致するすべての連絡先を取得する

操作 ID:
GetContacts

指定されたフィルタリング条件に一致するすべての連絡先を取得します。 指定されたダッシュボードのみが検索されます。使用可能な番号のアカウント レベルの検索はありません。

パラメーター

名前 キー 必須 型 説明
検索する連絡先の電話番号
 contact_phone_number string

連絡先をフィルタリングする電話番号。
'Last-message-time sent before' 検索タイムスタンプ (UTC 時間)
 last_message_timestamp_before_utc date-time

最後に送受信されたメッセージで連絡先を検索するためのカットオフ時間。 この時間以降にメッセージを送信した連絡先は表示されません。
'Last-message-time sent after' 検索タイムスタンプ (UTC 時間)
 last_message_timestamp_after_utc date-time

最後に送受信されたメッセージで連絡先を検索するためのカットオフ時間。 この時間以前にメッセージを送信した連絡先は表示されません。
'これ以前に作成' の検索タイムスタンプ
 contact_created_before date-time

連絡先を作成日で検索するための締め切り時間。 この時間以降にメッセージを作成した連絡先は表示されません。
'これ以後に作成' の検索タイムスタンプ
 contact_created_after date-time

連絡先を作成日で検索するための締め切り時間。 この時間以前にメッセージを作成した連絡先は表示されません。
連絡先との現在の会話が解決されたかどうか
 is_resolved boolean

会話が解決された連絡先を検索するかどうか。
連絡先がブロックされているかどうか
 is_blocked boolean

ブロックされた連絡先を検索するかどうか。
連絡先がアーカイブされているかどうか
 is_archived boolean

アーカイブされた連絡先を検索するかどうか。
連絡先が非表示にされているかどうか
 is_suppressed boolean

非表示にされた連絡先を検索するかどうか。
連絡先がオプトアウトしたかどうか
 has_opted_out boolean

テキストの受信をオプトアウトした連絡先を検索するかどうか。
'Last-message-time sent before' 検索タイムスタンプ
 last_message_sent_before date-time

最後にメッセージが顧客に送信されたされた時別で連絡先を検索するためのカットオフ時間。 この時間以降にメッセージを送信した連絡先は表示されません。 ローカル タイムでのタイムスタンプを使います。 UTC 時間のタイムスタンプでフィルタリングするには、last_message_sent_before_utc を使用します
'Last-message-time sent after' 検索タイムスタンプ
 last_message_sent_after date-time

最後にメッセージが顧客に送信されたされた時別で連絡先を検索するためのカットオフ時間。 この時間以前にメッセージを送信した連絡先は表示されません。 ローカル タイムでのタイムスタンプを使います。 UTC 時間のタイムスタンプでフィルタリングするには、last_message_sent_after_utc を使用します
'Last-message-time received before' 検索タイムスタンプ
 last_message_received_before date-time

最後にメッセージが顧客から受信されたされた時別で連絡先を検索するためのカットオフ時間。 この時間以降にメッセージを受信した連絡先は表示されません。 ローカル タイムでのタイムスタンプを使います。 UTC 時間のタイムスタンプでフィルタリングするには、last_message_sent_before_utc を使用します
'Last-message-time received after' 検索タイムスタンプ
 last_message_received_after date-time

最後にメッセージが顧客から受信されたされた時別で連絡先を検索するためのカットオフ時間。 この時間以前にメッセージを送信した連絡先は表示されません。 ローカル タイムでのタイムスタンプを使います。 UTC 時間のタイムスタンプでフィルタリングするには、last_message_sent_before_utc を使用します
連絡先タグ
 tags string

連絡先をフィルター処理するタグを参照する GUID のカンマ区切りリスト。
連絡先グループ
 groups string

連絡先をフィルター処理するグループを参照する 整数 ID のカンマ区切りリスト。
フィルターするカスタム フィールドの ID
 custom_field_id_1 string

連絡先をフィルター処理するためのカスタム フィールドを参照するガイド。
フィルターするカスタム フィールドの値
 custom_field_value_1 string

連絡先をフィルター処理するためのカスタム フィールドを参照する値。
フィルターする二次カスタム フィールドの ID
 custom_field_id_2 string

連絡先をフィルター処理するための 2 番目のカスタム フィールドを参照するガイド。
フィルターする 2 番目のカスタム フィールドの値
 custom_field_value_2 string

連絡先をフィルター処理するための二次カスタム フィールドを参照する値。
フィルターする 3 番目のカスタム フィールドの ID
 custom_field_id_3 string

連絡先をフィルター処理するための 3 番目のカスタム フィールドを参照するガイド。
フィルターする 3 番目のカスタム フィールドの値
 custom_field_value_3 string

連絡先をフィルター処理するための 3 番目のカスタム フィールドを参照する値。
取得するページ番号
 page True integer

取得するエンティティのページ。 値を取得する場合、page_size で定義されたページあたりの最大サイズがあります。 ページが最後のページより大きい場合、空の配列が返されます。
ページごとに取得する各エンティティの量
 page_size True integer

取得する各ページのサイズ。 値を取得する場合、これはページごとの最大サイズであり、後続のページへのアクセスはページ パラメータによって行われます。
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。

戻り値

名前 パス 型 説明
page
 meta.page integer

取得するエンティティのページ。 このページ内のエンティティの量は、page_size によって定義されます。
page_size
 meta.page_size integer

このページで取得したエンティティの数。
total_items
 meta.total_items integer

ページのサイズや数に関係なく、データベースで使用できるエンティティの数。 他のページを表示するには、リクエストでページ番号を変更します。
アイテム
 items array of object

テキスト リクエストから取得した連絡先エンティティのリスト。
phone_number
 items.phone_number string

この連絡先の電話番号。
first_name
 items.first_name string

この連絡先の名。
姓
 items.last_name string

この連絡先の姓。
display_name
 items.display_name string

この連絡先の氏名。 これは、連絡先を表示するときに Web アプリに表示されるデフォルトの名前です。
is_suppressed
 items.is_suppressed boolean

この連絡先との会話を抑制して、受信時にメッセージ キューの先頭にプッシュしないかどうか。
is_archived
 items.is_archived boolean

この連絡先との会話をアーカイブするかどうか、したがって、会話のクエリを実行しても表示されません (デフォルトで)。
is_blocked
 items.is_blocked boolean

この連絡先との会話をブロックするかどうか、したがって、受信も保存もされません。
suppressed_reason
 items.suppressed_reason string

連絡を差し控える理由を説明するフレーズ。 is_suppressed が false の場合、これは null になります。
note
 items.note string

連絡先を説明する短いフレーズ。 便宜上の使用。 これは連絡先に表示されることはありません。
groups
 items.groups array of integer

この連絡先が属するグループを参照する整数 ID の配列。
contact_tags
 items.contact_tags array of string

この連絡先に添付されたタグを参照する GUID の配列。
custom_fields
 items.custom_fields array of object

この連絡先に定義されたカスタム フィールド ID と値の配列。
id
 items.custom_fields.id string

カスタム フィールドを参照するガイド。
価値
 items.custom_fields.value string

このカスタム フィールドのこの連絡先の値。
is_resolved
 items.is_resolved boolean

この連絡先との現在の会話が解決されたかどうか。 この連絡先が新しいテキストを受信すると、これは false に設定されます。
first_contact_utc
 items.first_contact_utc string

この連絡先に最初のメッセージが送信されたときのタイムスタンプ。
opted_out_utc
 items.opted_out_utc string

この連絡先がメッセージの受信をオプトアウトしたときのタイムスタンプ。
last_msg_sent_utc
 items.last_msg_sent_utc string

この連絡先に最後のメッセージが送信されたときのタイムスタンプ。
last_msg_received_utc
 items.last_msg_received_utc string

この連絡先から最後のメッセージが受信されたときのタイムスタンプ。
total_msgs_sent
 items.total_msgs_sent integer

この連絡先に送信されたメッセージの合計数。
total_msgs_received
 items.total_msgs_received integer

この連絡先から受信されたメッセージの合計数。
response_count
 items.response_count integer

この連絡先からの応答メッセージの合計数。
date_created_utc
 items.date_created_utc string

連絡先が作成されたときのタイムスタンプ。
last_contact_date_utc
 items.last_contact_date_utc string

この連絡先から最後のメッセージが送信、または受信されたときのタイムスタンプ。
message_id
 items.last_message.message_id string

メッセージの ID。 この値は各メッセージに対して固有のものです。
body
 items.last_message.body string

このメッセージのコンテンツ。
message_direction
 items.last_message.message_direction string

R または S のいずれかの単数文字で、このメッセージが連絡先から受信されたか、連絡先に送信されたかをそれぞれ示します。
response_by_username
 items.last_message.response_by_username string

このユーザーに最後にメッセージを送信した Text Request ユーザーのユーザー名。
message_timestamp_utc
 items.last_message.message_timestamp_utc string

Text Request によってメッセージが送信、または受信されたときのタイムスタンプ。
delivery_status
 items.last_message.delivery_status string

このメッセージの現在の状態。 これは、'送信中'、'配信済み'、'エラー'、または '送信' のいずれかです。
delivery_error
 items.last_message.delivery_error string

このメッセージが配信されない原因となったエラー。 delivery_status が 'エラー' でない場合、この値は null になります。
mms_media
 items.last_message.mms_media array of string

このメッセージの添付ファイルを指す URL のリスト。 すべての URL は、テキスト リクエストによって生成された URL になります。

指定された名前と電話番号で新しいダッシュボードを作成します

操作 ID:
CreateDashboard

アカウントに新しいダッシュボードを作成します。 ダッシュボードが作成されると、管理者に変更に関するメールが送信され、ユーザーの割り当てを開始できます。 このエンドポイントは、プロビジョニングされた番号のダッシュボードを作成できます。 GET /dashboards/provisioning を使用して、特定の市外局番でプロビジョニングされた番号を検索できます。 電話番号が既に使用されている場合は、Bad Request 例外がスローされます。

パラメーター

名前 キー 必須 型 説明
名称
 name string

ダッシュボードの名前。
電話番号
 phone string

このダッシュボードに関連付けられたテキスト番号。

戻り値

名前 パス 型 説明
id
 id integer

ダッシュボードの数値 ID。
名称
 name string

ダッシュボードの名前。
電話番号
 phone string

このダッシュボードに関連付けられたテキスト番号。

指定された支払いをキャンセルする

操作 ID:
CancelPayment

指定された支払いをキャンセルし、支払いがキャンセルされたことをユーザーに通知します。 支払いは編集できないため、キャンセルして新しい支払いを発行することが、支払いを修正する最善の方法です。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
支払いの ID
 payment_id True integer

更新する支払いの数値 ID。

戻り値

名前 パス 型 説明
payment_id
 payment_id integer

支払いの数値 ID。
request_date
 request_date string

この支払いの最初のメッセージが送信キューに入れられたときのタイムスタンプ。
受信者
 recipient string

支払い受信者の名前。 連絡先の電話番号に名前が関連付けられていない場合、これは null になる可能性があります。
description
 description string

支払いの説明。 これは連絡先に表示されません。 これは、支払いに関するコンテキストのために内部ユーザーによってのみ使用されます。
customer_phone
 customer_phone string

この支払いの送信先の連絡先の電話番号。
amount_requested
 amount_requested float

この支払いで要求されたドル単位の金額。
is_past_due
 is_past_due boolean

この支払いが要求日を過ぎているかどうか。
reminder_was_sent
 reminder_was_sent boolean

この支払いに対してテキスト リマインダーが既に送信されているかどうか。
transaction_status
 transaction_status string

authvia のトランザクションの状態。 この値は不明として開始します。
textrequest_payment_status
 textrequest_payment_status string

Text Request のトランザクションの状態。 これは、Text Request アプリの支払いページに表示されるステータスを表します。 これは送信済みとして開始されます。
reference_number
 reference_number string

支払いをすばやく見つけるために使用できる、支払いの作成時に定義されたユーザー定義の ID。 参照番号は一意ではありません。多くの支払いが同じ参照を持つことができます。

指定された支払いを支払うようユーザーに通知するフォローアップ テキストを送信する

操作 ID:
SendPaymentReminder

指定された支払いを支払うよう連絡先にリマインダーを送信します。 メッセージの内容は自動生成されます。 スパムを避けるため、支払いごとに送信できるリマインダーは 1 つだけです

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
支払いの ID
 payment_id True integer

更新する支払いの数値 ID。

戻り値

名前 パス 型 説明
payment_id
 payment_id integer

支払いの数値 ID。
request_date
 request_date string

この支払いの最初のメッセージが送信キューに入れられたときのタイムスタンプ。
受信者
 recipient string

支払い受信者の名前。 連絡先の電話番号に名前が関連付けられていない場合、これは null になる可能性があります。
description
 description string

支払いの説明。 これは連絡先に表示されません。 これは、支払いに関するコンテキストのために内部ユーザーによってのみ使用されます。
customer_phone
 customer_phone string

この支払いの送信先の連絡先の電話番号。
amount_requested
 amount_requested float

この支払いで要求されたドル単位の金額。
is_past_due
 is_past_due boolean

この支払いが要求日を過ぎているかどうか。
reminder_was_sent
 reminder_was_sent boolean

この支払いに対してテキスト リマインダーが既に送信されているかどうか。
transaction_status
 transaction_status string

authvia のトランザクションの状態。 この値は不明として開始します。
textrequest_payment_status
 textrequest_payment_status string

Text Request のトランザクションの状態。 これは、Text Request アプリの支払いページに表示されるステータスを表します。 これは送信済みとして開始されます。
reference_number
 reference_number string

支払いをすばやく見つけるために使用できる、支払いの作成時に定義されたユーザー定義の ID。 参照番号は一意ではありません。多くの支払いが同じ参照を持つことができます。

指定された電話番号の連絡先にメッセージを送信します

操作 ID:
SendMessageByPhoneNumber

メッセージを送信します (指定された電話番号にメッセージ履歴がない場合は、新しい会話を開始します)。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
メッセージへの電話番号
 phone_number True string

メッセージを送信する連絡先の電話番号。
メッセージの本文
 body string

送信するメッセージの内容。
送信者の名前
 sender_name string

メッセージの送信者の名前。 これは、このメッセージを取得するときに TextRequest Web アプリと API に表示されます。
メッセージのステータスが更新されたときのコールバック URL
 status_callback string

このメッセージのステータスが未配信から送信済み (またはエラー) になるたびに、Web アプリが POST コマンドでヒットする URL。
このメッセージにロケーション リクエストが含まれている場合は、ロケーション リクエストのコールバック URL
 location_callback string

ユーザーが位置情報にアクセスして送信者との位置情報の共有を承認したときに、POST コマンドでヒットする位置情報コールバック URL。 リンクを含めるには、メッセージ本文に [Location Request] を追加します。 このコールバックは位置情報のリクエストには必要ありませんが、API には役立ちます。
このメッセージの MMS メディア添付ファイル
 mms_media array of string

このメッセージの MMS メディア添付ファイルの配列。 添付ファイルは、投稿 /mms エンドポイント (このコネクタには含まれていません) から取得した URL でなければなりません。 外部添付リンクは受け付けません。

戻り値

名前 パス 型 説明
message_id
 message_id string

メッセージの ID。 この値は各メッセージに対して固有のものです。
body
 body string

このメッセージのコンテンツ。
message_direction
 message_direction string

R または S のいずれかの単数文字で、このメッセージが連絡先から受信されたか、連絡先に送信されたかをそれぞれ示します。
response_by_username
 response_by_username string

このユーザーに最後にメッセージを送信した Text Request ユーザーのユーザー名。
message_timestamp_utc
 message_timestamp_utc string

Text Request によってメッセージが送信、または受信されたときのタイムスタンプ。
delivery_status
 delivery_status string

このメッセージの現在の状態。 これは、'送信中'、'配信済み'、'エラー'、または '送信' のいずれかです。
delivery_error
 delivery_error string

このメッセージが配信されない原因となったエラー。 delivery_status が 'エラー' でない場合、この値は null になります。
mms_media
 mms_media array of string

このメッセージの添付ファイルを指す URL のリスト。 すべての URL は、テキスト リクエストによって生成された URL になります。

指定したダッシュボードを削除します

操作 ID:
DeleteDashboard

指定したダッシュボードを削除します。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。

戻り値

返答
string

指定した電話番号の連絡先を削除します

操作 ID:
DeleteContact

このダッシュボードにこの電話番号の連絡先が存在しない場合、コンテンツは返されません。 連絡先が存在するが、メッセージ履歴がない場合、コンテンツは返されず、正常な状態コードは削除されたことを示します。 連絡先にメッセージ履歴がある場合は削除できず、Bad Request エラーが返されます。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
連絡先の電話番号
 phone_number True string

削除する連絡先の電話番号。

戻り値

返答
string

指定した電話番号の連絡先を取得します

操作 ID:
GetContactByPhoneNumber

このダッシュボードにこの電話番号の連絡先が存在しない場合、コンテンツは返されず、エラーはスローされません。 指定されたダッシュボードのみ検索され、連絡先はダッシュボードごとに整理され、アカウント レベルで番号を検索することはできません。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
連絡先の電話番号
 phone_number True string

取得する連絡先の電話番号。

戻り値

名前 パス 型 説明
phone_number
 phone_number string

この連絡先の電話番号。
first_name
 first_name string

この連絡先の名。
姓
 last_name string

この連絡先の姓。
display_name
 display_name string

この連絡先の氏名。 これは、連絡先を表示するときに Web アプリに表示されるデフォルトの名前です。
is_suppressed
 is_suppressed boolean

この連絡先との会話を抑制して、受信時にメッセージ キューの先頭にプッシュしないかどうか。
is_archived
 is_archived boolean

この連絡先との会話をアーカイブするかどうか、したがって、会話のクエリを実行しても表示されません (デフォルトで)。
is_blocked
 is_blocked boolean

この連絡先との会話をブロックするかどうか、したがって、受信も保存もされません。
suppressed_reason
 suppressed_reason string

連絡を差し控える理由を説明するフレーズ。 is_suppressed が false の場合、これは null になります。
note
 note string

連絡先を説明する短いフレーズ。 便宜上の使用。 これは連絡先に表示されることはありません。
groups
 groups array of integer

この連絡先が属するグループを参照する整数 ID の配列。
contact_tags
 contact_tags array of string

この連絡先に添付されたタグを参照する GUID の配列。
custom_fields
 custom_fields array of object

この連絡先に定義されたカスタム フィールド ID と値の配列。
id
 custom_fields.id string

カスタム フィールドを参照するガイド。
価値
 custom_fields.value string

このカスタム フィールドのこの連絡先の値。
is_resolved
 is_resolved boolean

この連絡先との現在の会話が解決されたかどうか。 この連絡先が新しいテキストを受信すると、これは false に設定されます。
first_contact_utc
 first_contact_utc string

この連絡先に最初のメッセージが送信されたときのタイムスタンプ。
opted_out_utc
 opted_out_utc string

この連絡先がメッセージの受信をオプトアウトしたときのタイムスタンプ。
last_msg_sent_utc
 last_msg_sent_utc string

この連絡先に最後のメッセージが送信されたときのタイムスタンプ。
last_msg_received_utc
 last_msg_received_utc string

この連絡先から最後のメッセージが受信されたときのタイムスタンプ。
total_msgs_sent
 total_msgs_sent integer

この連絡先に送信されたメッセージの合計数。
total_msgs_received
 total_msgs_received integer

この連絡先から受信されたメッセージの合計数。
response_count
 response_count integer

この連絡先からの応答メッセージの合計数。
date_created_utc
 date_created_utc string

連絡先が作成されたときのタイムスタンプ。
last_contact_date_utc
 last_contact_date_utc string

この連絡先から最後のメッセージが送信、または受信されたときのタイムスタンプ。
message_id
 last_message.message_id string

メッセージの ID。 この値は各メッセージに対して固有のものです。
body
 last_message.body string

このメッセージのコンテンツ。
message_direction
 last_message.message_direction string

R または S のいずれかの単数文字で、このメッセージが連絡先から受信されたか、連絡先に送信されたかをそれぞれ示します。
response_by_username
 last_message.response_by_username string

このユーザーに最後にメッセージを送信した Text Request ユーザーのユーザー名。
message_timestamp_utc
 last_message.message_timestamp_utc string

Text Request によってメッセージが送信、または受信されたときのタイムスタンプ。
delivery_status
 last_message.delivery_status string

このメッセージの現在の状態。 これは、'送信中'、'配信済み'、'エラー'、または '送信' のいずれかです。
delivery_error
 last_message.delivery_error string

このメッセージが配信されない原因となったエラー。 delivery_status が 'エラー' でない場合、この値は null になります。
mms_media
 last_message.mms_media array of string

このメッセージの添付ファイルを指す URL のリスト。 すべての URL は、テキスト リクエストによって生成された URL になります。

支払いを支払い済としてマークする

操作 ID:
MarkPaymentPaid

支払いを "支払い済" としてクローズします。 この エンドポイント は、支払いリクエスト ポータル以外の手段で支払いが行われる場合に使用します。 これにより支払いが終了し、その支払い額が統計に追加されます。 このエンドポイントは、テキスト リクエストを通じて送信された支払いポータルを通じて支払われる支払いには必要ありません。これにより、支払いが自動的に支払い済みとしてマークされます。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
支払いの ID
 payment_id True integer

更新する支払いの数値 ID。

戻り値

名前 パス 型 説明
payment_id
 payment_id integer

支払いの数値 ID。
request_date
 request_date string

この支払いの最初のメッセージが送信キューに入れられたときのタイムスタンプ。
受信者
 recipient string

支払い受信者の名前。 連絡先の電話番号に名前が関連付けられていない場合、これは null になる可能性があります。
description
 description string

支払いの説明。 これは連絡先に表示されません。 これは、支払いに関するコンテキストのために内部ユーザーによってのみ使用されます。
customer_phone
 customer_phone string

この支払いの送信先の連絡先の電話番号。
amount_requested
 amount_requested float

この支払いで要求されたドル単位の金額。
is_past_due
 is_past_due boolean

この支払いが要求日を過ぎているかどうか。
reminder_was_sent
 reminder_was_sent boolean

この支払いに対してテキスト リマインダーが既に送信されているかどうか。
transaction_status
 transaction_status string

authvia のトランザクションの状態。 この値は不明として開始します。
textrequest_payment_status
 textrequest_payment_status string

Text Request のトランザクションの状態。 これは、Text Request アプリの支払いページに表示されるステータスを表します。 これは送信済みとして開始されます。
reference_number
 reference_number string

支払いをすばやく見つけるために使用できる、支払いの作成時に定義されたユーザー定義の ID。 参照番号は一意ではありません。多くの支払いが同じ参照を持つことができます。

新しい支払いの作成

操作 ID:
CreatePayment

指定された連絡先への指定されたメッセージで新しい支払いを作成します。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
支払いの説明
 description string

支払い方法の説明。 説明は連絡先には表示されず、支払いに関するコンテキストのために内部ユーザーによってのみ使用されます。
受信者の電話番号
 customer_phone string

送信されるこの支払いの連絡先の電話番号。
要求された金額 (ドル)
 amount_requested float

この支払いで要求されたドル単位の金額。
支払いメッセージ本文のテキスト
 message string

支払いリンクとともに連絡先に送信するメッセージ テキスト。
支払いの参照文字列
 reference_number string

支払いをすばやく見つけるために使用できる、支払いの作成時に定義されたユーザー定義の ID。 参照番号は一意ではありません。多くの支払いが同じ参照を持つことができます。

戻り値

名前 パス 型 説明
payment_id
 payment_id integer

支払いの数値 ID。
request_date
 request_date string

この支払いの最初のメッセージが送信キューに入れられたときのタイムスタンプ。
受信者
 recipient string

支払い受信者の名前。 連絡先の電話番号に名前が関連付けられていない場合、これは null になる可能性があります。
description
 description string

支払いの説明。 これは連絡先に表示されません。 これは、支払いに関するコンテキストのために内部ユーザーによってのみ使用されます。
customer_phone
 customer_phone string

この支払いの送信先の連絡先の電話番号。
amount_requested
 amount_requested float

この支払いで要求されたドル単位の金額。
is_past_due
 is_past_due boolean

この支払いが要求日を過ぎているかどうか。
reminder_was_sent
 reminder_was_sent boolean

この支払いに対してテキスト リマインダーが既に送信されているかどうか。
transaction_status
 transaction_status string

authvia のトランザクションの状態。 この値は不明として開始します。
textrequest_payment_status
 textrequest_payment_status string

Text Request のトランザクションの状態。 これは、Text Request アプリの支払いページに表示されるステータスを表します。 これは送信済みとして開始されます。
reference_number
 reference_number string

支払いをすばやく見つけるために使用できる、支払いの作成時に定義されたユーザー定義の ID。 参照番号は一意ではありません。多くの支払いが同じ参照を持つことができます。

新規グループの作成

操作 ID:
CreateGroup

提供された名前を持つ新規グループを作成する。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
Group name
 name string

グループの新しい名前。
グループ ノート
 notes string

グループを説明する短いフレーズ。 便宜上の使用。

戻り値

名前 パス 型 説明
id
 id integer

グループの数値 ID。
group_member_count
 group_member_count integer

グループ内のメンバーの数。
is_keyword
 is_keyword boolean

このグループがキーワード グループかどうか。 このようなグループは、ユーザーがキーワードを設定すると自動生成されます。 連絡先は、登録時に自動的に追加されます。
名称
 name string

このグループの名前。
メモ
 notes string

このグループに関するメモ。
last_message_sent_utc
 last_message_sent_utc string

最後のグループ メッセージがこのグループに送信されたときのタイムスタンプ。

特定のダッシュボード名を更新する

操作 ID:
UpdateDashboardsName

ダッシュボードを更新します。 これにより、ダッシュボードの電話番号が変更されることはありません。 別のダッシュボードの連絡先で新しい番号が必要な場合は、POST で新しいダッシュボードを作成し、一括エクスポート/インポートで連絡先を追加する必要があります。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
ダッシュボード名
 name string

ダッシュボードの新しい名前

戻り値

名前 パス 型 説明
id
 id integer

ダッシュボードの数値 ID。
名称
 name string

ダッシュボードの名前。
電話番号
 phone string

このダッシュボードに関連付けられたテキスト番号。

連絡先の一括更新

操作 ID:
BulkUpdateContacts

指定されたダッシュボードのみに連絡先が追加されます。連絡先はダッシュボードごとに整理されており、アカウント レベルで番号を検索することはできません。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
連絡先の電話番号
 phone_number string

作成または更新する連絡先の電話番号。
連絡先の名
 first_name string

新しい連絡先の名。
連絡先の姓
 last_name string

新しい連絡先の姓。
連絡先の氏名
 display_name string

新しい連絡先の氏名。 これは、連絡先を表示するときに Web アプリに表示されるデフォルトの名前です。
この連絡先からのメッセージを非表示にするかどうか
 is_suppressed boolean

この連絡先との会話を抑制し、受信時にメッセージ キューの先頭にプッシュしないかどうかを決定します。
この連絡先からのメッセージをアーカイブするかどうか
 is_archived boolean

この連絡先との会話をアーカイブするかどうかを決定します。したがって、会話のクエリを実行しても表示されません (デフォルトで)。
この連絡先からのメッセージをブロックするかどうか
 is_blocked boolean

この連絡先との会話をブロックするかどうかを決定します。したがって、受信も保存もされません。
この連絡を差し控える理由
 suppressed_reason string

連絡を差し控える理由を説明するフレーズ。
連絡先メモ
 note string

連絡先を説明する短いフレーズ。 便宜上の使用。 これは連絡先に表示されることはありません。
連絡先グループ
 groups array of integer

この連絡先が属する予定のグループを参照する整数 ID の配列。
連絡先タグ
 contact_tags array of string

この連絡先に添付されたタグを参照する GUID の配列。
カスタム フィールド ID
 id string

カスタム フィールドを参照するガイド。
カスタム フィールド値
 value string

このカスタム フィールドのこの連絡先の値。
この連絡先との現在の会話が解決されたかどうか
 is_resolved boolean

この連絡先との現在の会話が解決されたかどうかを決定します。 この連絡先が新しいテキストを受信すると、これは false に設定されます。

戻り値

名前 パス 型 説明
array of object
phone_number
 phone_number string

この連絡先の電話番号。
first_name
 first_name string

この連絡先の名。
姓
 last_name string

この連絡先の姓。
display_name
 display_name string

この連絡先の氏名。 これは、連絡先を表示するときに Web アプリに表示されるデフォルトの名前です。
is_suppressed
 is_suppressed boolean

この連絡先との会話を抑制して、受信時にメッセージ キューの先頭にプッシュしないかどうか。
is_archived
 is_archived boolean

この連絡先との会話をアーカイブするかどうか、したがって、会話のクエリを実行しても表示されません (デフォルトで)。
is_blocked
 is_blocked boolean

この連絡先との会話をブロックするかどうか、したがって、受信も保存もされません。
suppressed_reason
 suppressed_reason string

連絡を差し控える理由を説明するフレーズ。 is_suppressed が false の場合、これは null になります。
note
 note string

連絡先を説明する短いフレーズ。 便宜上の使用。 これは連絡先に表示されることはありません。
groups
 groups array of integer

この連絡先が属するグループを参照する整数 ID の配列。
contact_tags
 contact_tags array of string

この連絡先に添付されたタグを参照する GUID の配列。
custom_fields
 custom_fields array of object

この連絡先に定義されたカスタム フィールド ID と値の配列。
id
 custom_fields.id string

カスタム フィールドを参照するガイド。
価値
 custom_fields.value string

このカスタム フィールドのこの連絡先の値。
is_resolved
 is_resolved boolean

この連絡先との現在の会話が解決されたかどうか。 この連絡先が新しいテキストを受信すると、これは false に設定されます。
first_contact_utc
 first_contact_utc string

この連絡先に最初のメッセージが送信されたときのタイムスタンプ。
opted_out_utc
 opted_out_utc string

この連絡先がメッセージの受信をオプトアウトしたときのタイムスタンプ。
last_msg_sent_utc
 last_msg_sent_utc string

この連絡先に最後のメッセージが送信されたときのタイムスタンプ。
last_msg_received_utc
 last_msg_received_utc string

この連絡先から最後のメッセージが受信されたときのタイムスタンプ。
total_msgs_sent
 total_msgs_sent integer

この連絡先に送信されたメッセージの合計数。
total_msgs_received
 total_msgs_received integer

この連絡先から受信されたメッセージの合計数。
response_count
 response_count integer

この連絡先からの応答メッセージの合計数。
date_created_utc
 date_created_utc string

連絡先が作成されたときのタイムスタンプ。
last_contact_date_utc
 last_contact_date_utc string

この連絡先から最後のメッセージが送信、または受信されたときのタイムスタンプ。
message_id
 last_message.message_id string

メッセージの ID。 この値は各メッセージに対して固有のものです。
body
 last_message.body string

このメッセージのコンテンツ。
message_direction
 last_message.message_direction string

R または S のいずれかの単数文字で、このメッセージが連絡先から受信されたか、連絡先に送信されたかをそれぞれ示します。
response_by_username
 last_message.response_by_username string

このユーザーに最後にメッセージを送信した Text Request ユーザーのユーザー名。
message_timestamp_utc
 last_message.message_timestamp_utc string

Text Request によってメッセージが送信、または受信されたときのタイムスタンプ。
delivery_status
 last_message.delivery_status string

このメッセージの現在の状態。 これは、'送信中'、'配信済み'、'エラー'、または '送信' のいずれかです。
delivery_error
 last_message.delivery_error string

このメッセージが配信されない原因となったエラー。 delivery_status が 'エラー' でない場合、この値は null になります。
mms_media
 last_message.mms_media array of string

このメッセージの添付ファイルを指す URL のリスト。 すべての URL は、テキスト リクエストによって生成された URL になります。

連絡先の電話番号で会話のメッセージを取得する

操作 ID:
GetMessagesByContactPhone

指定されたダッシュボードと電話番号の間の会話を取得します。

パラメーター

名前 キー 必須 型 説明
取得するページ番号
 page True integer

取得するエンティティのページ。 値を取得する場合、page_size で定義されたページあたりの最大サイズがあります。 ページが最後のページより大きい場合、空の配列が返されます。
ページごとに取得する各エンティティの量
 page_size True integer

取得する各ページのサイズ。 値を取得する場合、これはページごとの最大サイズであり、後続のページへのアクセスはページ パラメータによって行われます。
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
検索する連絡先の電話番号
 phone_number True string

メッセージを取得する連絡先の電話番号。

戻り値

名前 パス 型 説明
page
 meta.page integer

取得するエンティティのページ。 このページ内のエンティティの量は、page_size によって定義されます。
page_size
 meta.page_size integer

このページで取得したエンティティの数。
total_items
 meta.total_items integer

ページのサイズや数に関係なく、データベースで使用できるエンティティの数。 他のページを表示するには、リクエストでページ番号を変更します。
アイテム
 items array of object

テキスト リクエストから取得したメッセージ エンティティのリスト。
message_id
 items.message_id string

メッセージの ID。 この値は各メッセージに対して固有のものです。
body
 items.body string

このメッセージのコンテンツ。
message_direction
 items.message_direction string

R または S のいずれかの単数文字で、このメッセージが連絡先から受信されたか、連絡先に送信されたかをそれぞれ示します。
response_by_username
 items.response_by_username string

このユーザーに最後にメッセージを送信した Text Request ユーザーのユーザー名。
message_timestamp_utc
 items.message_timestamp_utc string

Text Request によってメッセージが送信、または受信されたときのタイムスタンプ。
delivery_status
 items.delivery_status string

このメッセージの現在の状態。 これは、'送信中'、'配信済み'、'エラー'、または '送信' のいずれかです。
delivery_error
 items.delivery_error string

このメッセージが配信されない原因となったエラー。 delivery_status が 'エラー' でない場合、この値は null になります。
mms_media
 items.mms_media array of string

このメッセージの添付ファイルを指す URL のリスト。 すべての URL は、テキスト リクエストによって生成された URL になります。

連絡先を作成または更新する

操作 ID:
CreateContact

連絡先を作成または更新します (指定された電話番号の連絡先が既に存在するかどうかによって異なります)。

パラメーター

名前 キー 必須 型 説明
この呼び出しを行うダッシュボードの ID
 dashboard_id True integer

作業する電話番号ダッシュボード。 1 つのアカウントに、顧客のさまざまな電話回線を表す複数のダッシュボードを含めることができます。
連絡先の電話番号
 phone_number True string

作成または更新する連絡先の電話番号。
連絡先の名
 first_name string

新しい連絡先の名。
連絡先の姓
 last_name string

新しい連絡先の姓。
連絡先の氏名
 display_name string

新しい連絡先の氏名。 これは、連絡先を表示するときに Web アプリに表示されるデフォルトの名前です。
この連絡先からのメッセージを非表示にするかどうか
 is_suppressed boolean

この連絡先との会話を抑制し、受信時にメッセージ キューの先頭にプッシュしないかどうかを決定します。
この連絡先からのメッセージをアーカイブするかどうか
 is_archived boolean

この連絡先との会話をアーカイブするかどうかを決定します。したがって、会話のクエリを実行しても表示されません (デフォルトで)。
この連絡先からのメッセージをブロックするかどうか
 is_blocked boolean

この連絡先との会話をブロックするかどうかを決定します。したがって、受信も保存もされません。
この連絡を差し控える理由
 suppressed_reason string

連絡を差し控える理由を説明するフレーズ。
連絡先メモ
 note string

連絡先を説明する短いフレーズ。 便宜上の使用。 これは連絡先に表示されることはありません。
連絡先グループ
 groups array of integer

この連絡先が属する予定のグループを参照する整数 ID の配列。
連絡先タグ
 contact_tags array of string

この連絡先に添付されたタグを参照する GUID の配列。
カスタム フィールド ID
 id string

カスタム フィールドを参照するガイド。
カスタム フィールド値
 value string

このカスタム フィールドのこの連絡先の値。
この連絡先との現在の会話が解決されたかどうか
 is_resolved boolean

この連絡先との現在の会話が解決されたかどうかを決定します。 この連絡先が新しいテキストを受信すると、これは false に設定されます。

戻り値

名前 パス 型 説明
phone_number
 phone_number string

この連絡先の電話番号。
first_name
 first_name string

この連絡先の名。
姓
 last_name string

この連絡先の姓。
display_name
 display_name string

この連絡先の氏名。 これは、連絡先を表示するときに Web アプリに表示されるデフォルトの名前です。
is_suppressed
 is_suppressed boolean

この連絡先との会話を抑制して、受信時にメッセージ キューの先頭にプッシュしないかどうか。
is_archived
 is_archived boolean

この連絡先との会話をアーカイブするかどうか、したがって、会話のクエリを実行しても表示されません (デフォルトで)。
is_blocked
 is_blocked boolean

この連絡先との会話をブロックするかどうか、したがって、受信も保存もされません。
suppressed_reason
 suppressed_reason string

連絡を差し控える理由を説明するフレーズ。 is_suppressed が false の場合、これは null になります。
note
 note string

連絡先を説明する短いフレーズ。 便宜上の使用。 これは連絡先に表示されることはありません。
groups
 groups array of integer

この連絡先が属するグループを参照する整数 ID の配列。
contact_tags
 contact_tags array of string

この連絡先に添付されたタグを参照する GUID の配列。
custom_fields
 custom_fields array of object

この連絡先に定義されたカスタム フィールド ID と値の配列。
id
 custom_fields.id string

カスタム フィールドを参照するガイド。
価値
 custom_fields.value string

このカスタム フィールドのこの連絡先の値。
is_resolved
 is_resolved boolean

この連絡先との現在の会話が解決されたかどうか。 この連絡先が新しいテキストを受信すると、これは false に設定されます。
first_contact_utc
 first_contact_utc string

この連絡先に最初のメッセージが送信されたときのタイムスタンプ。
opted_out_utc
 opted_out_utc string

この連絡先がメッセージの受信をオプトアウトしたときのタイムスタンプ。
last_msg_sent_utc
 last_msg_sent_utc string

この連絡先に最後のメッセージが送信されたときのタイムスタンプ。
last_msg_received_utc
 last_msg_received_utc string

この連絡先から最後のメッセージが受信されたときのタイムスタンプ。
total_msgs_sent
 total_msgs_sent integer

この連絡先に送信されたメッセージの合計数。
total_msgs_received
 total_msgs_received integer

この連絡先から受信されたメッセージの合計数。
response_count
 response_count integer

この連絡先からの応答メッセージの合計数。
date_created_utc
 date_created_utc string

連絡先が作成されたときのタイムスタンプ。
last_contact_date_utc
 last_contact_date_utc string

この連絡先から最後のメッセージが送信、または受信されたときのタイムスタンプ。
message_id
 last_message.message_id string

メッセージの ID。 この値は各メッセージに対して固有のものです。
body
 last_message.body string

このメッセージのコンテンツ。
message_direction
 last_message.message_direction string

R または S のいずれかの単数文字で、このメッセージが連絡先から受信されたか、連絡先に送信されたかをそれぞれ示します。
response_by_username
 last_message.response_by_username string

このユーザーに最後にメッセージを送信した Text Request ユーザーのユーザー名。
message_timestamp_utc
 last_message.message_timestamp_utc string

Text Request によってメッセージが送信、または受信されたときのタイムスタンプ。
delivery_status
 last_message.delivery_status string

このメッセージの現在の状態。 これは、'送信中'、'配信済み'、'エラー'、または '送信' のいずれかです。
delivery_error
 last_message.delivery_error string

このメッセージが配信されない原因となったエラー。 delivery_status が 'エラー' でない場合、この値は null になります。
mms_media
 last_message.mms_media array of string

このメッセージの添付ファイルを指す URL のリスト。 すべての URL は、テキスト リクエストによって生成された URL になります。

定義

string

これは基本的なデータ型 '文字列' です。