テキスト要求
Text Request は、顧客エンゲージメントを促進するために構築されたビジネス テキスト プラットフォームです。 日常のコミュニケーションに関する問題に対応したプラグ アンド プレイ メッセージング ソリューションを作成しました。これにより、ノイズをカットし、いつでも、どこでも顧客とつながることができます。 お客様のような忙しいビジネス リーダーを支援する方法の詳細をご覧ください。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | 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) |
| お問い合わせ | |
|---|---|
| 名前 | テキスト要求 API のサポート |
| URL | https://www.textrequest.com/contact |
| apidev@textrequest.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | テキスト要求 |
| Website | https://www.textrequest.com/ |
| プライバシー ポリシー | https://www.textrequest.com/privacy-policy/ |
| カテゴリ | 通信;売上と CRM |
Aranda Service Management Suite (ASMS)
ビジネス プロセスとサービスを管理、統合、自動化できるマルチテナント ソリューションである Aranda Service Management Suite を使用して、会社の生産性を向上させ、ユーザーのエクスペリエンスを変革します。 インシデント、要件、変更など、ASMS の任意のワークスペース (プロジェクト) に格納されているレコードを作成、検索、更新します。
前提条件
続行するには、次の前提条件に注意してください。
- サブスクリプションと Aranda Service Management Suite (ASMS) のインスタンス。 ここから始めます。 https://arandasoft.com/
- Premium コネクタ機能を備えたアクティブな Microsoft Power Automate サブスクリプション。
資格情報の取得
- 認証を実行するには、統合トークンを使用します。 次のリンクでは、統合トークンを取得する方法に関する情報を確認できます。
コネクタの概要
Aranda Service Management Suite (ASMS) のサブスクリプションが必要です。
統合トークンを取得する
Aranda Service Management ASMS API (ApiAsms) のインスタンス URL を取得します。
Aranda Service Management Suite コネクタとの接続を確立します。
コネクタによって提供される次の関数のいずれかを選択します。
コネクタに関する詳細なドキュメントについては、 https://docs.arandasoft.com/connectors
このコネクタは、次の場合に使用できます。
- チケットの作成、検索、更新など、使用可能なアクションが含まれます。
- チケットの追跡可能性を取得します。
- チケットに関連する添付ファイルをダウンロードします。
- Aranda Service Management Suite でナレッジ ベース (KB) の記事を検索します。
- ナレッジ ベース (KB) の記事から添付ファイルをダウンロードします。
- 構成項目 (UI) を作成、検索、更新します。
- これにより、組織は内部サポート要求を解決し、技術的な問題解決プロセスを管理および合理化できます。
- 要求者とサポート エージェント間の通信を追跡できます。
- 要求者にチケットの状態を通知する自動応答を提供します。
成功応答
| Code | 名前 | Description |
|---|---|---|
| 200 | [OK] | 要求は成功しました |
| 204 | コンテンツなし | 要求にデータが見つかりません |
一般的なエラーと解決方法
| Code | 名前 | Description | 解決策 |
|---|---|---|---|
| 400 | 不正なリクエスト | CriteriaNeedsSomeArguments | 検索パラメーターが空でないことを確認する |
| 400 | 不正なリクエスト | InvalidAdditionalFieldId | 追加フィールドの ID が正しいことを確認する |
| 400 | 不正なリクエスト | InvalidItemType | ケースの種類が正しくありません。ケースの種類 ID を変更します |
| 400 | 不正なリクエスト | InvalidProjectId | プロジェクト ID が正しくありません。ケースを関連付けるプロジェクト ID を変更します |
| 400 | 不正なリクエスト | InvalidStateId | チケットを作成または更新するときに追加された状態を確認する |
| 400 | 不正なリクエスト | InvalidUploadType | ファイルの添付時にエラーが発生しました。システム管理者にサポートを依頼してください |
| 400 | 不正なリクエスト | RequestNeedsSomeArguments | チケットの必須フィールドを確認し、コネクタに対応する値を追加します |
| 400 | 不正なリクエスト | SearchListIsRequired | システム管理者にサポートを依頼する |
| 400 | 不正なリクエスト | パラメーター名: {Name parameter} | エラーに記載されているプロパティが null ではないことを確認します |
| 400 | 不正なリクエスト | null パラメーター名: {Name parameter} | エラーに記載されているプロパティが null ではないことを確認します |
| 400 | 不正なリクエスト | ItemTypeIsRequired | ケースの種類を追加する |
| 400 | 不正なリクエスト | ModelIdIsEmpty | modelId パラメーターを追加します。 必須です。 |
| 400 | 不正なリクエスト | StateIdIsEmpty | stateId パラメーターを追加します。 必須です。 |
| 400 | 不正なリクエスト | ServiceIdIsEmpty | serviceId パラメーターを追加します。 必須です。 |
| 400 | 不正なリクエスト | CategoryIdIsEmpty | categoryId パラメーターを追加します。 必須です。 |
| 400 | 不正なリクエスト | TypesListNeedsSomeArguments | チケットを検索するときにケースの種類を追加する必要があります。システム管理者にサポートを要求する |
| 400 | 不正なリクエスト | '{PARAMETER_NAME}' AdditionalFieldIsRequired | 追加フィールド '{PARAMETER_NAME}' は必須です |
| 400 | 不正なリクエスト | ModelNotActive | ケースに関連付けられているモデルがアクティブではありません |
| 400 | 不正なリクエスト | FailedToCloseTaskPendingCloseTasksPredecessors | ケースを閉じようとし、親ケースに終了する保留中のタスクがある場合 |
| 400 | 不正なリクエスト | DuplicatedObject | Ci はデータベースに既に存在します |
| 400 | 不正なリクエスト | EmptyValue パラメーター名: {PARAMETER_NAME} | {PARAMETER_NAME} パラメーターが必要です |
| 400 | 不正なリクエスト | EmptyEnumeration パラメーター名: {PARAMETER_NAME} | {PARAMETER_NAME} パラメーターはリストであり、必須です |
| 4:03 | 許可されていません | DoNotHavePermissionForThisAction | システム管理者に連絡してアクセス許可を割り当てる |
| Code | 名前 | Description | 解決策 |
|---|---|---|---|
| 500 | サーバー内部エラー | システム管理者にサポートを依頼する | |
| 500 | サーバー内部エラー | FailureExportExcel | システム管理者にサポートを依頼する |
| 500 | サーバー内部エラー | FailureGetAdditionalFields | システム管理者にサポートを依頼する |
| 500 | サーバー内部エラー | FailureGetCategoriesByService | システム管理者にサポートを依頼する |
| 500 | サーバー内部エラー | FailureGetChangeFSC | システム管理者にサポートを依頼する |
| 500 | サーバー内部エラー | FailureGetFields | システム管理者にサポートを依頼する |
| 500 | サーバー内部エラー | FailureGetFieldsList | システム管理者にサポートを依頼する |
| 500 | サーバー内部エラー | FailureGetFiles | システム管理者にサポートを依頼する |
| 500 | サーバー内部エラー | FailureGetLookupValues | システム管理者にサポートを依頼する |
| 500 | サーバー内部エラー | FailureGetMailTemplates | システム管理者にサポートを依頼する |
| 500 | サーバー内部エラー | FailureGetModelByCategory | システム管理者にサポートを依頼する |
| 500 | サーバー内部エラー | FailureGetOperators | システム管理者にサポートを依頼する |
| 500 | サーバー内部エラー | FailureGetReassignmentReasons | システム管理者にサポートを依頼する |
| 500 | サーバー内部エラー | FailureGetSimilarItems | システム管理者にサポートを依頼する |
| 500 | サーバー内部エラー | FailureSearchQuickManagement | システム管理者にサポートを依頼する |
FAQ
コネクタのさまざまなアクション (プロジェクト、サービス、カテゴリ、グループ、スペシャリストなど) を使用するために必要な属性の ID を取得する方法
ID は、さまざまな方法で取得できます。
- Aranda Query Manager を使用すると、必要なデータが配置されている Aranda Service Management Suite (ASMS) テーブルに対してクエリを実行するレポートを作成できます。 ソリューション内のデータ オブジェクトに関するガイダンスが必要な場合は、次のリンク https://docs.arandasoft.com/docs/database.html にアクセスし、ASMS インストールに対応する Aranda データベースのバージョンを特定します。
- ASMS On Premise インストールを使用している場合は、SQL クライアントを介して必要なデータが配置されている ASMS テーブルに対してクエリを実行できます。
- Aranda サポート センターを介して、次の Web サイトのサポートに示されている連絡先チャネルを介して サポート 要求を作成します。
[添付ファイルの追加] アクションを使用する場合、添付するファイルの最大サイズは何ですか?
最大サイズは、ASMS インスタンス/インストールの特定の構成によって異なります。 ASMS 管理者に問い合わせてください。
コネクタで必要な ASMS 接続の構成でトークンが使用されている技術者アカウントに必要なデータ アクセス レベルは何ですか?
アクセス レベルは、ASMS で定期的に使用される技術者アカウントと同じです。 つまり、ASMS の対応する技術者の役割とアクセス許可に基づいて、コネクタでデータにアクセスできます。
コネクタでトークンを使用する技術者アカウントは、名前付きまたは同時実行にする必要がありますか?
コネクタは関連する ASMS インスタンスに 1 時間に複数回アクセスできるため、アカウントを名前付き型にすることを強くお勧めします。
コネクタを使用したケースの作成または変更は、ASMS インターフェイスに存在するのと同じデータ検証規則に従いますか。
はい。同じ検証規則に従います。 たとえば、特定のプロジェクト、サービス、カテゴリのケースを作成するときに、ネイティブ フィールドと追加フィールドを入力する必要がある場合は、コネクタを介してケースを送信するときにもこれらのデータが必要になります。
コネクタは、クラウド環境とオンプレミス環境の ASMS インスタンスに使用できますか?
はい。ASMS のクラウドインストールとオンプレミスインストールの両方で使用できます。 オンプレミスのインストールでは、ASMS サーバーと Power Automate 環境の間の接続を考慮する必要があります。
Standard コネクタのみを使用できる Power Automate ライセンスがあります。 ASMS コネクタを使用できますか?
ASMS コネクタは Premium 型ではありません。
ASMS のイベントから始まるフローを Power Automate で作成する必要があります (ケースが作成されたとき、ケースが特定のグループに割り当てられている場合など)。 ASMS で発生するイベントから開始するトリガーを使用できますか?
はい、可能です。 次の手順をお勧めします。
- トリガー "HTTP 要求の受信時" を初期化し、ASMS から受信することが予想されるデータ構造を含む要求本文の JSON スキーマを作成します。 トリガーが作成されると、ASMS インスタンスで使用する HTTP POST URL (WebHook URL) が取得されます。 WebHook URL (トークンなど) にアクセスするための認証メカニズムを忘れないでください。
- 満たされたときに Power Automate でフローを開始する必要がある一連の条件に対して、ASMS でビジネス ルールを作成します。 ルール内のアクションとして、[Invoke Webhook]\(Webhook の呼び出し\) を選択し、呼び出し先 URL に、前に取得した WebHook URL、送信するパラメーター、および要求の本文 (要求本文の JSON スキーマと一致する必要があります) を入力します。 ASMS のルールから Webhook を呼び出す方法の詳細については、Webhook ルールのリンクを参照してください。
- 作成されたルールをテストし、HTTP 要求が WebHook URL に送信されていることを検証し、Power Automate でフローを初期化します。
Power Automate のフローからのアクションとして ASMS REST API エンドポイントを呼び出すことができますか?
はい、可能です。 "HTTP" アクションを使用し、必要なデータ (URI、メソッド、ヘッダー、本文など) を入力します。
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有不可 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| API キー | securestring | この API の API キー | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| ID でグループを取得する |
指定した ID のグループを取得します。 |
| このダッシュボードのすべての会話を取得します |
このダッシュボードのすべての会話を取得し、各会話の最後のメッセージに関する情報を含めます。 |
| この特定のダッシュボードに関する情報を取得する |
ダッシュボードの名前と電話を返します。 |
| すべてのグループを取得します |
ユーザーのアカウントのすべてのグループを取得します。 |
| すべてのタグを取得します |
このダッシュボードのすべてのタグを取得します。 タグはダッシュボード間で一意です。 |
| すべてのユーザー設定フィールドを取得します |
このダッシュボードのすべてのユーザー設定フィールドを取得します。 ユーザー設定フィールドは、ダッシュボード間で一意です。 |
| すべての支払いを取得します |
取り消された支払いと有料の支払いを含むすべての支払いを取得します。 これらは、クエリ パラメーターを使用してフィルター処理できます。 |
| アカウント内のすべてのダッシュボードを取得する |
アカウント内のすべてのダッシュボードを取得します。 |
| 会話の整理を解除する |
会話の整理を解除します。 会話がアーカイブ解除されると、もう一度キューに表示されます。 /conversations エンドポイントによって返される会話にも表示されます。 会話が既にアーカイブされていない場合、このメソッドは無効になります。 |
| 会話をアーカイブする |
会話をアーカイブし、すべての会話取得エンドポイントの結果から削除します。 顧客がテキスト要求番号にテキストを送信した場合、または顧客にテキスト要求番号からテキストを送信した場合、会話は自動的に整理されなくなります。 会話のアーカイブは、今後話をする予定のない顧客から煩雑さを取り除くための優れた方法です。 顧客が "STOP" にテキストを送信して SMS メッセージを送信できないようにすると、会話は自動的にアーカイブされることに注意してください。 |
| 指定された ID でグループを更新します |
グループの数値 ID を使用して、グループの名前を更新します。渡されたグループ ID が存在しない場合、呼び出しは失敗します。 |
| 指定された名前と電話番号を使用して新しいダッシュボードを作成する |
アカウントに新しいダッシュボードを作成します。 ダッシュボードが作成されると、管理者に変更に関する電子メールが送信され、ユーザーの割り当てを開始できます。 このエンドポイントは、プロビジョニングされた任意の番号のダッシュボードを作成できます。 GET /dashboards/provisioning を使用して、特定のエリア コードでプロビジョニングされた番号を検索できます。 電話番号が既に使用されている場合は、無効な要求例外がスローされます。 |
| 指定された電話番号を使用して連絡先にメッセージを送信する |
メッセージを送信します (指定された電話番号にメッセージ履歴がない場合は、新しい会話を開始します)。 |
| 指定した ID のグループを削除します。 |
指定した ID のグループを削除します。これは、グループのメンバーである連絡先がある場合でも成功します (連絡先は削除されません)。 |
| 指定した ID の支払いを取得します。 |
指定した ID の支払いを取得します。 |
| 指定したダッシュボードを削除します |
指定したダッシュボードを削除します。 |
| 指定したフィルター条件に一致するすべての連絡先を取得する |
指定したフィルター条件に一致するすべての連絡先を取得します。 指定されたダッシュボードのみが検索されます。使用可能な数値のアカウント レベルの検索はありません。 |
| 指定した支払いをユーザーに通知するフォローアップ テキストを送信する |
指定した支払いを支払うリマインダーを連絡先に送信します。 メッセージの内容は自動生成されます。 スパムを回避するために、支払いごとに 1 つのリマインダーのみを送信できます |
| 指定した支払いを取り消します |
指定した支払いを取り消し、支払いが取り消されたことをユーザーに示します。 支払いを編集できないため、新しい支払いを取り消して発行するのが、支払いを修正するための最良の方法です。 |
| 指定した電話番号の連絡先を削除します |
指定した電話番号の連絡先を削除します |
| 指定した電話番号を持つ連絡先を取得します。 |
指定した電話番号を持つ連絡先を取得します。 |
| 支払いを有料としてマークする |
支払いを "有料" として閉じます。 このエンドポイントは、支払い要求ポータル以外の方法で支払いを行う場合に使用します。 これにより、支払いが終了し、その支払額が統計情報に追加されます。 このエンドポイントは、Text Request 経由で送信された payments ポータルを通じて支払われる支払いには必要ありません。支払いを有料として自動的にマークします。 |
| 新しいグループを作成します |
指定された名前の新しいグループを作成します。 |
| 新しい支払いを作成します |
指定された連絡先に対して、指定されたメッセージを含む新しい支払いを作成します。 |
| 特定のダッシュボードの名前を更新する |
ダッシュボードを更新します。 ダッシュボードの電話番号は変更されません。 別のダッシュボードの連絡先で新しい番号が必要な場合は、POST を使用して新しいダッシュボードを作成し、連絡先を一括エクスポート/インポートで追加する必要があります。 |
| 連絡先の電話番号で会話のメッセージを取得する |
指定したダッシュボードと電話番号の間の会話を取得します。 |
| 連絡先を一括更新する |
指定されたダッシュボードにのみ連絡先が追加されます。連絡先はダッシュボード別に整理され、アカウント レベルで使用可能な番号の検索はありません。 |
| 連絡先を作成または更新する |
連絡先を作成または更新します (指定した電話番号を持つ連絡先が既に存在するかどうかによって異なります)。 |
ID でグループを取得する
指定した 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 |
このグループに対して最後のグループ メッセージが送信された日時のタイムスタンプ。 |
このダッシュボードのすべての会話を取得します
このダッシュボードのすべての会話を取得し、各会話の最後のメッセージに関する情報を含めます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
連絡先タグ
|
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
|
items | array of object |
テキスト要求から取得された会話エンティティの一覧。 |
|
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 |
このユーザーに最後にメッセージを送信したテキスト要求ユーザーのユーザー名。 |
|
message_timestamp_utc
|
items.last_message.message_timestamp_utc | string |
テキスト要求によってメッセージが送受信された日時のタイムスタンプ。 |
|
delivery_status
|
items.last_message.delivery_status | string |
このメッセージの現在の状態。 これには、"送信"、"配信済み"、"エラー"、または "送信" を指定できます。 |
|
delivery_error
|
items.last_message.delivery_error | string |
このメッセージが配信されない原因となったエラー。 delivery_statusが 'error' でない場合、この値は null になります。 |
|
mms_media
|
items.last_message.mms_media | array of string |
このメッセージの添付ファイルを指す URL の一覧。 すべての URL は、テキスト要求で生成された URL になります。 |
この特定のダッシュボードに関する情報を取得する
ダッシュボードの名前と電話を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
この呼び出しを行うダッシュボードの ID
|
dashboard_id | True | integer |
作業する電話番号ダッシュボード。 1 つのアカウントに複数のダッシュボードを含めることができます。これは、顧客向けの異なる電話回線を表します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
ダッシュボードの数値 ID。 |
|
名前
|
name | string |
ダッシュボードの名前。 |
|
phone
|
phone | string |
このダッシュボードに関連付けられているテキスト番号。 |
すべてのグループを取得します
ユーザーのアカウントのすべてのグループを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
取得する数値ページ
|
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
|
items | array of object |
テキスト要求から取得されたグループ エンティティの一覧。 |
|
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
|
dashboard_id | True | integer |
作業する電話番号ダッシュボード。 1 つのアカウントに複数のダッシュボードを含めることができます。これは、顧客向けの異なる電話回線を表します。 |
|
取得する数値ページ
|
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
|
items | array of object |
テキスト要求から取得されたタグ エンティティの一覧。 |
|
id
|
items.id | string |
タグの数値 ID。 |
|
tag_color
|
items.tag_color | string |
タグの色。 これは有効な 16 進数の色コードである必要があります。 |
|
タグ
|
items.tag | string |
タグの名前。 |
すべてのユーザー設定フィールドを取得します
このダッシュボードのすべてのユーザー設定フィールドを取得します。 ユーザー設定フィールドは、ダッシュボード間で一意です。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
この呼び出しを行うダッシュボードの ID
|
dashboard_id | True | integer |
作業する電話番号ダッシュボード。 1 つのアカウントに複数のダッシュボードを含めることができます。これは、顧客向けの異なる電話回線を表します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
フィールドの数値 ID。 |
|
名前
|
name | string |
ユーザー設定フィールドの名前。 |
すべての支払いを取得します
取り消された支払いと有料の支払いを含むすべての支払いを取得します。 これらは、クエリ パラメーターを使用してフィルター処理できます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
支払いの参照文字列
|
reference_number | string |
支払いをすばやく見つけるために使用できる支払いの作成時に定義されるユーザー定義 ID。 参照番号は一意ではありません。多くの支払いは同じ参照を持つことができます。 |
|
|
支払い電話番号
|
phone_number | string |
この支払いが送信された連絡先の電話番号。 |
|
|
並べ替え
|
sort_type | string |
支払いを並べ替えるプロパティ。 "amount"、"contact"、"date"、"status" を指定できます。 |
|
|
並べ替えの方向
|
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
|
items | array of object |
テキスト要求から取得した支払エンティティの一覧。 |
|
payment_id
|
items.payment_id | integer |
支払いの数値 ID。 |
|
request_date
|
items.request_date | string |
この支払いの最初のメッセージがキューに登録されて送信されたときのタイムスタンプ。 |
|
受信者
|
items.recipient | string |
支払い先の名前。 連絡先に電話番号に関連付けられている名前がない場合、これは null になる可能性があります。 |
|
説明
|
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 でのトランザクションの状態。 この値は Unknown から始まります。 |
|
textrequest_payment_status
|
items.textrequest_payment_status | string |
テキスト要求のトランザクションの状態。 これは、テキスト要求アプリの支払いページに表示される状態を表します。 送信済みとして開始されます。 |
|
reference_number
|
items.reference_number | string |
支払いを迅速に検索するために使用できる支払いの作成時に定義されたユーザー定義 ID。 参照番号は一意ではありません。多くの支払いは同じ参照を持つことができます。 |
アカウント内のすべてのダッシュボードを取得する
アカウント内のすべてのダッシュボードを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
取得する数値ページ
|
page | integer |
取得するエンティティのページ。 値を取得するときは、page_sizeによって定義されたページあたりの最大サイズがあります。 ページが最後のページより大きい場合は、空の配列が返されます。 |
|
|
ページごとに取得する各エンティティの量
|
page_size | integer |
取得する各ページのサイズ。 値を取得する場合、これはページあたりの最大サイズであり、ページ パラメーターによって後続のページにアクセスします。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
page
|
meta.page | integer |
取得したエンティティのページ。 このページのエンティティの量は、page_sizeによって定義されます。 |
|
page_size
|
meta.page_size | integer |
このページで取得されたエンティティの数。 |
|
total_items
|
meta.total_items | integer |
ページ サイズまたは数に関係なく、データベースで使用できるエンティティの数。 他のページを表示するには、要求のページ番号を変更します。 |
|
items
|
items | array of object |
テキスト要求から取得されたダッシュボード エンティティの一覧。 |
|
id
|
items.id | integer |
ダッシュボードの数値 ID。 |
|
名前
|
items.name | string |
ダッシュボードの名前。 |
|
phone
|
items.phone | string |
このダッシュボードに関連付けられているテキスト番号。 |
会話の整理を解除する
会話の整理を解除します。 会話がアーカイブ解除されると、もう一度キューに表示されます。 /conversations エンドポイントによって返される会話にも表示されます。 会話が既にアーカイブされていない場合、このメソッドは無効になります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
この呼び出しを行うダッシュボードの ID
|
dashboard_id | True | integer |
作業する電話番号ダッシュボード。 1 つのアカウントに複数のダッシュボードを含めることができます。これは、顧客向けの異なる電話回線を表します。 |
|
会話の電話番号
|
phone_number | True | string |
アーカイブする会話の電話番号。 |
戻り値
- response
- string
会話をアーカイブする
会話をアーカイブし、すべての会話取得エンドポイントの結果から削除します。 顧客がテキスト要求番号にテキストを送信した場合、または顧客にテキスト要求番号からテキストを送信した場合、会話は自動的に整理されなくなります。 会話のアーカイブは、今後話をする予定のない顧客から煩雑さを取り除くための優れた方法です。 顧客が "STOP" にテキストを送信して SMS メッセージを送信できないようにすると、会話は自動的にアーカイブされることに注意してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
この呼び出しを行うダッシュボードの ID
|
dashboard_id | True | integer |
作業する電話番号ダッシュボード。 1 つのアカウントに複数のダッシュボードを含めることができます。これは、顧客向けの異なる電話回線を表します。 |
|
会話の電話番号
|
phone_number | True | string |
アーカイブする会話の電話番号。 |
戻り値
- response
- string
指定された ID でグループを更新します
グループの数値 ID を使用して、グループの名前を更新します。渡されたグループ ID が存在しない場合、呼び出しは失敗します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
この呼び出しを行うダッシュボードの ID
|
dashboard_id | True | integer |
作業する電話番号ダッシュボード。 1 つのアカウントに複数のダッシュボードを含めることができます。これは、顧客向けの異なる電話回線を表します。 |
|
グループの ID
|
group_id | True | integer |
更新するグループの数値 ID。 |
|
グループ名
|
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 |
このグループに対して最後のグループ メッセージが送信された日時のタイムスタンプ。 |
指定された名前と電話番号を使用して新しいダッシュボードを作成する
アカウントに新しいダッシュボードを作成します。 ダッシュボードが作成されると、管理者に変更に関する電子メールが送信され、ユーザーの割り当てを開始できます。 このエンドポイントは、プロビジョニングされた任意の番号のダッシュボードを作成できます。 GET /dashboards/provisioning を使用して、特定のエリア コードでプロビジョニングされた番号を検索できます。 電話番号が既に使用されている場合は、無効な要求例外がスローされます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前
|
name | string |
ダッシュボードの名前。 |
|
|
phone
|
phone | string |
このダッシュボードに関連付けられているテキスト番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
ダッシュボードの数値 ID。 |
|
名前
|
name | string |
ダッシュボードの名前。 |
|
phone
|
phone | string |
このダッシュボードに関連付けられているテキスト番号。 |
指定された電話番号を使用して連絡先にメッセージを送信する
メッセージを送信します (指定された電話番号にメッセージ履歴がない場合は、新しい会話を開始します)。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
この呼び出しを行うダッシュボードの ID
|
dashboard_id | True | integer |
作業する電話番号ダッシュボード。 1 つのアカウントに複数のダッシュボードを含めることができます。これは、顧客向けの異なる電話回線を表します。 |
|
メッセージへの電話番号
|
phone_number | True | string |
メッセージを送信する連絡先の電話番号。 |
|
メッセージ本文
|
body | string |
送信するメッセージの内容。 |
|
|
送信者の名前
|
sender_name | string |
メッセージ送信者の名前。 これは、このメッセージを取得するときに TextRequest Web アプリと API に表示されます。 |
|
|
メッセージの状態が更新されたときのコールバック URL
|
status_callback | string |
このメッセージの状態が未配信から送信 (またはエラー) になった場合に POST コマンドでヒットする Web アプリの URL。 |
|
|
このメッセージに 1 つが含まれている場合の場所要求のコールバック URL
|
location_callback | string |
ユーザーが送信者との場所の共有にアクセスして承認したときに POST コマンドでヒットする場所コールバック URL。 リンクを含めるには、メッセージ本文に [Location Request] を追加します。 このコールバックは場所の要求には必要ありませんが、API に役立つ場合があります。 |
|
|
このメッセージの MMS メディア添付ファイル
|
mms_media | array of string |
このメッセージの MMS メディア添付ファイルの配列。 添付ファイルは、post /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 |
このユーザーに最後にメッセージを送信したテキスト要求ユーザーのユーザー名。 |
|
message_timestamp_utc
|
message_timestamp_utc | string |
テキスト要求によってメッセージが送受信された日時のタイムスタンプ。 |
|
delivery_status
|
delivery_status | string |
このメッセージの現在の状態。 これには、"送信"、"配信済み"、"エラー"、または "送信" を指定できます。 |
|
delivery_error
|
delivery_error | string |
このメッセージが配信されない原因となったエラー。 delivery_statusが 'error' でない場合、この値は null になります。 |
|
mms_media
|
mms_media | array of string |
このメッセージの添付ファイルを指す URL の一覧。 すべての URL は、テキスト要求で生成された URL になります。 |
指定した ID のグループを削除します。
指定した ID のグループを削除します。これは、グループのメンバーである連絡先がある場合でも成功します (連絡先は削除されません)。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
この呼び出しを行うダッシュボードの ID
|
dashboard_id | True | integer |
作業する電話番号ダッシュボード。 1 つのアカウントに複数のダッシュボードを含めることができます。これは、顧客向けの異なる電話回線を表します。 |
|
グループの ID
|
group_id | True | integer |
削除するグループの数値 ID。 |
戻り値
- response
- string
指定した ID の支払いを取得します。
指定した 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 | 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 でのトランザクションの状態。 この値は Unknown から始まります。 |
|
textrequest_payment_status
|
textrequest_payment_status | string |
テキスト要求のトランザクションの状態。 これは、テキスト要求アプリの支払いページに表示される状態を表します。 送信済みとして開始されます。 |
|
reference_number
|
reference_number | string |
支払いを迅速に検索するために使用できる支払いの作成時に定義されたユーザー定義 ID。 参照番号は一意ではありません。多くの支払いは同じ参照を持つことができます。 |
指定したダッシュボードを削除します
指定したダッシュボードを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
この呼び出しを行うダッシュボードの ID
|
dashboard_id | True | integer |
作業する電話番号ダッシュボード。 1 つのアカウントに複数のダッシュボードを含めることができます。これは、顧客向けの異なる電話回線を表します。 |
戻り値
- response
- string
指定したフィルター条件に一致するすべての連絡先を取得する
指定したフィルター条件に一致するすべての連絡先を取得します。 指定されたダッシュボードのみが検索されます。使用可能な数値のアカウント レベルの検索はありません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
検索する連絡先の電話番号
|
contact_phone_number | string |
連絡先をフィルター処理する電話番号。 |
|
|
'Last-message-time sent before' search timestamp in UTC time
|
last_message_timestamp_before_utc | date-time |
最後に送信または受信したメッセージによる連絡先検索のカットオフ時間。 この時刻より後にメッセージを送信した連絡先は表示されません。 |
|
|
'Last-message-time sent after' search timestamp in UTC time
|
last_message_timestamp_after_utc | date-time |
最後に送信または受信したメッセージによる連絡先検索のカットオフ時間。 最後に送信されたメッセージがこの時刻より前の連絡先は表示されません。 |
|
|
'Created before' search timestamp
|
contact_created_before | date-time |
連絡先が作成された時点で連絡先を検索するためのカットオフ時間。 この時刻以降に作成された連絡先は表示されません。 |
|
|
'Created after' search timestamp
|
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' search timestamp
|
last_message_sent_before | date-time |
最後のメッセージが顧客に送信された時点で連絡先を検索するためのカットオフ時間。 この時刻より後にメッセージを送信した連絡先は表示されません。 タイムスタンプをローカル時刻として使用します。 UTC 時刻のタイムスタンプでフィルター処理するには、last_message_sent_before_utc |
|
|
'Last-message-time sent after' search timestamp
|
last_message_sent_after | date-time |
最後のメッセージが顧客に送信された時点で連絡先を検索するためのカットオフ時間。 最後に送信されたメッセージがこの時刻より前の連絡先は表示されません。 タイムスタンプをローカル時刻として使用します。 UTC 時刻のタイムスタンプでフィルター処理するには、last_message_sent_after_utc |
|
|
'Last-message-time received before' search timestamp
|
last_message_received_before | date-time |
顧客から最後に受信したメッセージで連絡先を検索するためのカットオフ時間。 この時刻より後にメッセージを受信した連絡先は表示されません。 タイムスタンプをローカル時刻として使用します。 UTC 時刻のタイムスタンプでフィルター処理するには、last_message_sent_before_utc |
|
|
'Last-message-time received after' search timestamp
|
last_message_received_after | date-time |
顧客から最後に受信したメッセージで連絡先を検索するためのカットオフ時間。 最後に送信されたメッセージがこの時刻より前の連絡先は表示されません。 タイムスタンプをローカル時刻として使用します。 UTC 時刻のタイムスタンプでフィルター処理するには、last_message_sent_before_utc |
|
|
連絡先タグ
|
tags | string |
連絡先をフィルター処理するタグを参照する guid のコンマ区切りのリスト。 |
|
|
連絡先グループ
|
groups | string |
連絡先をフィルター処理するグループを参照する整数 ID のコンマ区切りリスト。 |
|
|
フィルター処理するユーザー設定フィールドの ID
|
custom_field_id_1 | string |
連絡先をフィルター処理するユーザー設定フィールドを参照する Guid。 |
|
|
フィルター処理するユーザー設定フィールドの値
|
custom_field_value_1 | string |
連絡先をフィルター処理するユーザー設定フィールドを参照する値。 |
|
|
フィルター処理する 2 番目のユーザー設定フィールドの ID
|
custom_field_id_2 | string |
連絡先をフィルター処理する 2 番目のユーザー設定フィールドを参照する Guid。 |
|
|
フィルター処理する 2 番目のユーザー設定フィールドの値
|
custom_field_value_2 | string |
連絡先をフィルター処理する 2 番目のユーザー設定フィールドを参照する値。 |
|
|
フィルター処理する 3 番目のユーザー設定フィールドの ID
|
custom_field_id_3 | string |
連絡先をフィルター処理する 3 番目のユーザー設定フィールドを参照する Guid。 |
|
|
フィルター処理する 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
|
items | array of object |
テキスト要求から取得された連絡先エンティティの一覧。 |
|
phone_number
|
items.phone_number | string |
この連絡先の電話番号。 |
|
first_name
|
items.first_name | string |
この連絡先の名。 |
|
last_name
|
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 になります。 |
|
手記
|
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 |
ユーザー設定フィールドを参照する Guid。 |
|
value
|
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 |
このユーザーに最後にメッセージを送信したテキスト要求ユーザーのユーザー名。 |
|
message_timestamp_utc
|
items.last_message.message_timestamp_utc | string |
テキスト要求によってメッセージが送受信された日時のタイムスタンプ。 |
|
delivery_status
|
items.last_message.delivery_status | string |
このメッセージの現在の状態。 これには、"送信"、"配信済み"、"エラー"、または "送信" を指定できます。 |
|
delivery_error
|
items.last_message.delivery_error | string |
このメッセージが配信されない原因となったエラー。 delivery_statusが 'error' でない場合、この値は null になります。 |
|
mms_media
|
items.last_message.mms_media | array of string |
このメッセージの添付ファイルを指す URL の一覧。 すべての URL は、テキスト要求で生成された URL になります。 |
指定した支払いをユーザーに通知するフォローアップ テキストを送信する
指定した支払いを支払うリマインダーを連絡先に送信します。 メッセージの内容は自動生成されます。 スパムを回避するために、支払いごとに 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 | 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 でのトランザクションの状態。 この値は Unknown から始まります。 |
|
textrequest_payment_status
|
textrequest_payment_status | string |
テキスト要求のトランザクションの状態。 これは、テキスト要求アプリの支払いページに表示される状態を表します。 送信済みとして開始されます。 |
|
reference_number
|
reference_number | string |
支払いを迅速に検索するために使用できる支払いの作成時に定義されたユーザー定義 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 | 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 でのトランザクションの状態。 この値は Unknown から始まります。 |
|
textrequest_payment_status
|
textrequest_payment_status | string |
テキスト要求のトランザクションの状態。 これは、テキスト要求アプリの支払いページに表示される状態を表します。 送信済みとして開始されます。 |
|
reference_number
|
reference_number | string |
支払いを迅速に検索するために使用できる支払いの作成時に定義されたユーザー定義 ID。 参照番号は一意ではありません。多くの支払いは同じ参照を持つことができます。 |
指定した電話番号の連絡先を削除します
指定した電話番号の連絡先を削除します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
この呼び出しを行うダッシュボードの ID
|
dashboard_id | True | integer |
作業する電話番号ダッシュボード。 1 つのアカウントに複数のダッシュボードを含めることができます。これは、顧客向けの異なる電話回線を表します。 |
|
連絡先の電話番号
|
phone_number | True | string |
削除する連絡先の電話番号。 |
戻り値
- response
- string
指定した電話番号を持つ連絡先を取得します。
指定した電話番号を持つ連絡先を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
この呼び出しを行うダッシュボードの ID
|
dashboard_id | True | integer |
作業する電話番号ダッシュボード。 1 つのアカウントに複数のダッシュボードを含めることができます。これは、顧客向けの異なる電話回線を表します。 |
|
連絡先の電話番号
|
phone_number | True | string |
取得する連絡先の電話番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
phone_number
|
phone_number | string |
この連絡先の電話番号。 |
|
first_name
|
first_name | string |
この連絡先の名。 |
|
last_name
|
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 | 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 |
ユーザー設定フィールドを参照する Guid。 |
|
value
|
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 |
このユーザーに最後にメッセージを送信したテキスト要求ユーザーのユーザー名。 |
|
message_timestamp_utc
|
last_message.message_timestamp_utc | string |
テキスト要求によってメッセージが送受信された日時のタイムスタンプ。 |
|
delivery_status
|
last_message.delivery_status | string |
このメッセージの現在の状態。 これには、"送信"、"配信済み"、"エラー"、または "送信" を指定できます。 |
|
delivery_error
|
last_message.delivery_error | string |
このメッセージが配信されない原因となったエラー。 delivery_statusが 'error' でない場合、この値は null になります。 |
|
mms_media
|
last_message.mms_media | array of string |
このメッセージの添付ファイルを指す URL の一覧。 すべての URL は、テキスト要求で生成された URL になります。 |
支払いを有料としてマークする
支払いを "有料" として閉じます。 このエンドポイントは、支払い要求ポータル以外の方法で支払いを行う場合に使用します。 これにより、支払いが終了し、その支払額が統計情報に追加されます。 このエンドポイントは、Text Request 経由で送信された payments ポータルを通じて支払われる支払いには必要ありません。支払いを有料として自動的にマークします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
この呼び出しを行うダッシュボードの 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 | 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 でのトランザクションの状態。 この値は Unknown から始まります。 |
|
textrequest_payment_status
|
textrequest_payment_status | string |
テキスト要求のトランザクションの状態。 これは、テキスト要求アプリの支払いページに表示される状態を表します。 送信済みとして開始されます。 |
|
reference_number
|
reference_number | string |
支払いを迅速に検索するために使用できる支払いの作成時に定義されたユーザー定義 ID。 参照番号は一意ではありません。多くの支払いは同じ参照を持つことができます。 |
新しいグループを作成します
指定された名前の新しいグループを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
この呼び出しを行うダッシュボードの ID
|
dashboard_id | True | integer |
作業する電話番号ダッシュボード。 1 つのアカウントに複数のダッシュボードを含めることができます。これは、顧客向けの異なる電話回線を表します。 |
|
グループ名
|
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
|
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 | 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 でのトランザクションの状態。 この値は Unknown から始まります。 |
|
textrequest_payment_status
|
textrequest_payment_status | string |
テキスト要求のトランザクションの状態。 これは、テキスト要求アプリの支払いページに表示される状態を表します。 送信済みとして開始されます。 |
|
reference_number
|
reference_number | string |
支払いを迅速に検索するために使用できる支払いの作成時に定義されたユーザー定義 ID。 参照番号は一意ではありません。多くの支払いは同じ参照を持つことができます。 |
特定のダッシュボードの名前を更新する
ダッシュボードを更新します。 ダッシュボードの電話番号は変更されません。 別のダッシュボードの連絡先で新しい番号が必要な場合は、POST を使用して新しいダッシュボードを作成し、連絡先を一括エクスポート/インポートで追加する必要があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
この呼び出しを行うダッシュボードの ID
|
dashboard_id | True | integer |
作業する電話番号ダッシュボード。 1 つのアカウントに複数のダッシュボードを含めることができます。これは、顧客向けの異なる電話回線を表します。 |
|
ダッシュボード名
|
name | string |
ダッシュボードの新しい名前。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
ダッシュボードの数値 ID。 |
|
名前
|
name | string |
ダッシュボードの名前。 |
|
phone
|
phone | string |
このダッシュボードに関連付けられているテキスト番号。 |
連絡先の電話番号で会話のメッセージを取得する
指定したダッシュボードと電話番号の間の会話を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
取得する数値ページ
|
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
|
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 |
このユーザーに最後にメッセージを送信したテキスト要求ユーザーのユーザー名。 |
|
message_timestamp_utc
|
items.message_timestamp_utc | string |
テキスト要求によってメッセージが送受信された日時のタイムスタンプ。 |
|
delivery_status
|
items.delivery_status | string |
このメッセージの現在の状態。 これには、"送信"、"配信済み"、"エラー"、または "送信" を指定できます。 |
|
delivery_error
|
items.delivery_error | string |
このメッセージが配信されない原因となったエラー。 delivery_statusが 'error' でない場合、この値は null になります。 |
|
mms_media
|
items.mms_media | array of string |
このメッセージの添付ファイルを指す URL の一覧。 すべての URL は、テキスト要求で生成された URL になります。 |
連絡先を一括更新する
指定されたダッシュボードにのみ連絡先が追加されます。連絡先はダッシュボード別に整理され、アカウント レベルで使用可能な番号の検索はありません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
この呼び出しを行うダッシュボードの 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 |
ユーザー設定フィールドを参照する Guid。 |
|
|
ユーザー設定フィールドの値
|
value | string |
このユーザー設定フィールドのこの連絡先の値。 |
|
|
この連絡先との現在の会話が解決されたかどうか
|
is_resolved | boolean |
この連絡先との現在の会話が解決されるかどうかを判断します。 この連絡先が受信した新しいテキストでは、この false が設定されます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
phone_number
|
phone_number | string |
この連絡先の電話番号。 |
|
first_name
|
first_name | string |
この連絡先の名。 |
|
last_name
|
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 | 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 |
ユーザー設定フィールドを参照する Guid。 |
|
value
|
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 |
このユーザーに最後にメッセージを送信したテキスト要求ユーザーのユーザー名。 |
|
message_timestamp_utc
|
last_message.message_timestamp_utc | string |
テキスト要求によってメッセージが送受信された日時のタイムスタンプ。 |
|
delivery_status
|
last_message.delivery_status | string |
このメッセージの現在の状態。 これには、"送信"、"配信済み"、"エラー"、または "送信" を指定できます。 |
|
delivery_error
|
last_message.delivery_error | string |
このメッセージが配信されない原因となったエラー。 delivery_statusが 'error' でない場合、この値は null になります。 |
|
mms_media
|
last_message.mms_media | array of string |
このメッセージの添付ファイルを指す URL の一覧。 すべての URL は、テキスト要求で生成された URL になります。 |
連絡先を作成または更新する
連絡先を作成または更新します (指定した電話番号を持つ連絡先が既に存在するかどうかによって異なります)。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
この呼び出しを行うダッシュボードの 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 |
ユーザー設定フィールドを参照する Guid。 |
|
|
ユーザー設定フィールドの値
|
value | string |
このユーザー設定フィールドのこの連絡先の値。 |
|
|
この連絡先との現在の会話が解決されたかどうか
|
is_resolved | boolean |
この連絡先との現在の会話が解決されるかどうかを判断します。 この連絡先が受信した新しいテキストでは、この false が設定されます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
phone_number
|
phone_number | string |
この連絡先の電話番号。 |
|
first_name
|
first_name | string |
この連絡先の名。 |
|
last_name
|
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 | 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 |
ユーザー設定フィールドを参照する Guid。 |
|
value
|
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 |
このユーザーに最後にメッセージを送信したテキスト要求ユーザーのユーザー名。 |
|
message_timestamp_utc
|
last_message.message_timestamp_utc | string |
テキスト要求によってメッセージが送受信された日時のタイムスタンプ。 |
|
delivery_status
|
last_message.delivery_status | string |
このメッセージの現在の状態。 これには、"送信"、"配信済み"、"エラー"、または "送信" を指定できます。 |
|
delivery_error
|
last_message.delivery_error | string |
このメッセージが配信されない原因となったエラー。 delivery_statusが 'error' でない場合、この値は null になります。 |
|
mms_media
|
last_message.mms_media | array of string |
このメッセージの添付ファイルを指す URL の一覧。 すべての URL は、テキスト要求で生成された URL になります。 |
トリガー
| テキストが送受信されたときにトリガーされます |
テキストが送受信されたときにトリガーされます |
テキストが送受信されたときにトリガーされます
テキストが送受信されたときにトリガーされます
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トリガーがイベントをリッスンするダッシュボード
|
dashboard_id | True | string |
トリガーを追加するダッシュボードの ID |
|
イベント
|
event | True | string |
イベント |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
メッセージの一意の ID
|
messageUniqueIdentifier | string |
messageUniqueIdentifier |
|
アカウント ID
|
account.id | integer |
id |
|
会話 ID
|
yourPhoneNumber.id | integer |
id |
|
ダッシュボード名
|
yourPhoneNumber.description | string |
説明 |
|
ダッシュボードの電話番号
|
yourPhoneNumber.phoneNumber | string |
phoneNumber |
|
ダッシュボード ID
|
conversation.id | integer |
id |
|
date
|
conversation.date | string |
date |
|
連絡先の電話番号
|
conversation.consumerPhoneNumber | string |
consumerPhoneNumber |
|
messageDirection
|
conversation.messageDirection | string |
messageDirection |
|
メッセージ
|
conversation.message | string |
メッセージ |
|
numSegments
|
conversation.numSegments | integer |
numSegments |
|
状態
|
conversation.status | string |
状態 |
|
要求者の会話
|
conversation.claimedBy | string |
claimedBy |
|
連絡先の表示名
|
conversation.consumerFriendlyName | string |
consumerFriendlyName |
定義
文字列
これは基本的なデータ型 'string' です。