Bright Patternのリスト管理APIは、従来は 「コンタクトセンター管理者」アプリケーション内でのみ利用可能だった幅広い機能をサポートしています。バージョン3.2では、リストおよびキャンペーン管理機能が拡張され、「DNCリスト（発信禁止リスト）」に対する包括的なAPIサポートが導入されるとともに、架電リストレコードへのアクセス方法が改善されました。
\nBright Patternのリスト管理API 3.2では、以下のことが可能になります：
\n注：前回のAPIバージョンとの互換性を確保し、シームレスな移行を容易にするため、以前に利用可能だったすべてのメソッドはそのまま維持されています。ただし、名前に「DEPRECIATED」というタグが付いているメソッドは使用を推奨しておらず、それぞれの機能に対応する新規のメソッドが定義されています。
\nこのドキュメントでは、利用可能なREST APIメソッドについて説明し、その機能を明記するとともに、リクエストおよびレスポンスの例を示します。個々のメソッド、およびList Management API 3.1の全コレクションをPostmanに読み込み、お客様固有のBright Pattern Contact Centerアクセストークンを経由して操作することができます。
\nnew* - List API 3.0 以降で追加されました
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"58450950","collectionId":"bcdb9a3f-2b1d-49cf-82b5-fdc7182352ff","publishedId":"2sBYB4Lmyi","public":true,"customColor":{"right-sidebar":"303030","top-bar":"FFFFFF","highlight":"FF6C37"},"publishDate":"2026-09-29T10:25:45.000Z"},"item":[{"name":"認証","item":[{"name":"Get Access Token","id":"bd5c6cd7-1b1e-4adb-a81d-fa9038650623","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"Username ","type":"text"},{"key":"client_secret","value":"API secret","type":"text"},{"key":"scope","value":"このメソッドは、このAPI経由で行われるその後の各リクエストの認証に使用されるアクセストークンを返します。
\n注： アクセストークンの有効期限は1時間であり、更新が必要です。
\nいずれかのパラメータに無効な認証情報を指定した場合、401 Authentification failedというレスポンスが返されます。また、選択済のユーザーがロックアウトされているか無効化されている場合、または選択済のテナントが非アクティブである場合も、クライアントの認証は失敗します。
注： クライアントはOAuth 2.0 クライアント認証情報グラントを使用して認証されるため、grant_typeパラメータは常に「client_credentials」に設定されます。その他パラメータ値の例については、以下のリクエスト本文をご参照ください。
このセクションで説明する認証方法は、Bright Patternのリスト管理APIを正常に使用するために必須の最初のステップです。このAPIのクライアントは、OAuth 2.0 クライアント認証情報グラントに従って認証されます。このAPIを経由して行われるリクエストは、アクセストークンを経由して認証されます。
\n注：このAPI経由で特定の操作を実行できるのは、対応する権限を持つユーザーのみです。権限の完全なリストについてはこちらをご覧ください。
\nアクセストークンを取得するには：
\nこのメソッドは、すべてのキャンペーン設定を返します。設定の特定の部分（例：割り当てられたチームのみ）のみを取得するには、includeというクエリパラメータを、カンマ区切りの値とともに使用してください。includeが指定されていない場合、このメソッドの動作はGet Campaign 3.1と同じになります（下位互換性あり）。includeに指定可能な値は以下の通りです：
\\\\*: すべての設定を返しますgeneralSettingscallerIdSettingsoutboundGeneralteamscallerIDsdispositionslistsdncLists注： include クエリパラメータは、アウトバウンドメッセージングキャンペーンではサポートされていません。
このメソッドは、_有効_なアウトバウンドキャンペーンのリスト、それらの現在の状態、および一意の識別子を返します。設定されたユーザー権限に基づいて、このリストにはすべてのキャンペーンが含まれるか、またはこのユーザーに割り当てられたキャンペーンのみが含まれます（こちらを参照）。現在有効なアウトバウンドキャンペーンがない場合、またはユーザーに割り当てられたキャンペーンがない場合は、空のリストが返されます。
\n注：レスポンス本文で返されるキャンペーンの一意の識別子は、その後のAPIリクエストのパス変数において、そのキャンペーンを参照するために使用できます。
\nこのメソッドは、有効_または_無効_になっているキャンペーンの現在の状態（_STOPPED または _RUNNING_）を返します。
\nこのメソッドは、_有効な_キャンペーンを開始します。その際、まずそのキャンペーンが_無効_になっていないか、またはすでに実行中ではないかを確認します。
\n注： キャンペーンの状態を変更するには、ユーザーに追加の「_キャンペーンの開始およびリストの有効化_」権限が必要です。
\nこのメソッドは、_有効な_キャンペーンを停止します。その際、まずそのキャンペーンが_無効_になっていないか、あるいはすでに停止されていないかを確認します。
\n注：キャンペーンの状態を変更するには、ユーザーに追加の 「_キャンペーンの開始およびリストの有効化_」 権限が必要です。
\nこのメソッドは、選択済のキャンペーンにリストを追加します。
\n追加されると、この特定のキャンペーンに関連付けられたリストのインスタンスが作成されます。そのインスタンスのIDは、元のリスト内のレコード合計数とともに、レスポンス本文で返されます。
\n注：インスタンスの一意の識別子は、リストの紐付け解除や更新、キャンペーン結果の取得、またはそのリストからのレコードの照会にさらに使用できます。
\n注：キャンペーンに関連付けられた架電リストを操作するには、ユーザーに追加の 「_キャンペーンの開始およびリストの有効化_」 権限が必要です。
\nこのメソッドは、関連付けられたキャンペーン内のリストのインスタンスのプロパティを変更します。インスタンスは、Get Campaign メソッドのレスポンス本文で返される一意の識別子「instanceID」によって指定されます（こちらを参照）。さらに、このメソッドでは、_オプションの_パラメータに対して「 」またはnullを指定することで、そのパラメータを既定値にリセットすることができます。
リストが更新される前に、指定されたキャンペーンへのバインディングが確認されます。インスタンスが指定されたキャンペーンにバインドされている場合、リストは正常に更新されます。
\n注： キャンペーンに関連付けられた架電リストのコンテンツを操作するには、ユーザーに追加の「_キャンペーンの開始およびリストの有効化_」権限が必要です。
\nこのメソッドは、関連付けられたキャンペーンからリストのインスタンスを削除します。削除対象のインスタンスは、Get Campaign メソッドのレスポンス本文で返される一意の識別子「instanceID」によって指定されます（こちらを参照）。
注： Bright Pattern Contact Centerソリューションは、いくつかの_音声_キャンペーンモードをサポートしています（こちらを参照）。関連付けられたキャンペーンのモードに応じて、アクティブなコールの挙動は次のように異なります：
\n完了したコールの結果はアーカイブされ、「コンタクトセンター管理者」アプリケーションからダウンロード可能です（こちらを参照）。切断されたコールの対話結果は保存されません。
\nこのメソッドは、インスタンス内のすべてのレコードのリストを返します。インスタンスは、Get Campaign メソッドのレスポンス本文で返される一意の識別子instanceIDによって指定されます（こちらを参照）。オプションとして、このメソッドでは行われたリクエストの試行内容も表示できます。レコードは、標準の MongoDB フィールド_idに基づいて並び替えられて返されます。
注： 大量のリストレコードを表示できるようにするため、Bright Pattern Contact Solutionでは_カーソルベースのページネーション_を採用しています（こちらを参照）。_idフィールドは、最後に処理されたレコードを参照するための「カーソル」として使用されます。
このメソッドは、インスタンス内のすべての完了済みレコードのリストを返します。インスタンスは、Get Campaign メソッドのレスポンス本文で返される一意の識別子「instanceID」によって指定されます（こちらを参照）。オプションとして、ユーザーはリクエストの試行履歴を表示したり、完了済みレコードリストを表示したい完了時間帯を指定したりすることができます。レコードは完了日時（MongoDBのcompletedTimeフィールド）順に並び替えられて返されます。
注：大量のリストレコードを表示できるようにするため、Bright Pattern Contact Solutionでは_カーソルベースのページネーション_を採用しています（こちらを参照）。「_id」フィールドと「completedTime」フィールドが連結され、最後に処理されたレコードを参照するための「カーソル」として使用されます。
注：List Management API 3.0 において、このメソッド用に定義された入力パラメータは、前バージョンとは異なります。
\nこのメソッドは、インスタンス内の更新されたすべてのレコードのリストを返します。インスタンスは、Get Campaign メソッドのレスポンス本文で返される一意の識別子であるinstanceIDによって指定されます。オプションとして、ユーザーはリクエストの試行履歴を表示し、更新されたレコードリストを表示したい期間を指定することができます。レコードは、最後の試行日（MongoDBのlastDateフィールド）順に並び替えられて返されます。
Note: 大量のリストレコードを表示できるようにするため、Bright Pattern Contact Solutionでは_カーソルベースのページネーション_を採用しています（hereを参照）。_idフィールドとlastDateフィールドが結合され、最後に処理されたレコードを参照するための「カーソル」として使用されます。
Note: List Management API 3.0 でこのメソッドに対して定義されている入力パラメータは、前バージョンとは異なります。
\nこのメソッドは、インスタンス内の既存のレコードのコピーと、そのレコードに関連付けられている直近のインタラクションに関する情報を返します。インスタンスは、Get Campaign メソッドのレスポンス本文で返される一意の識別子「instanceID」によって指定されます（こちらを参照）。レコードの検索は、定義されたキーフィールドに基づいて行われます。
レコードのクエリを実行する前に、指定されたリスト内にそのレコードが存在するかどうかが確認されます。指定されたリストにレコードが存在する場合、レコードのクエリは正常に実行されます。
\n注： PHONE タイプのフィールドがキーとして定義されている場合、レコードの値がデータベース、または元のソース（データベースへの読み込み時にデータが修正された場合）に格納されている値と完全に一致するかどうかがチェックされます。
\n注： レスポンス本文には、以下の2つのサブオブジェクトで定義される List Record JSONオブジェクトが含まれます：
\nentry object：リストエントリーのコピーが含まれますcustom_」が追加された状態で返されますstatus object：この特定のレコードに関するキャンペーンの結果が含まれますこの方法では、キャンペーンが削除され、そのキャンペーンのすべてのアーカイブ済み結果を含むコール結果が消去されます。
\n注：この方法は、アウトバウンドメッセージングキャンペーンではサポートされていません。
\n関連するキャンペーンのモードに応じて、アクティブなコールの挙動は次のように異なります。
\nこの方法では、選択済のキャンペーンをリンクグループから削除します。削除すると、グループの順序が再編成されます。
\n注：この方法は、アウトバウンドメッセージングキャンペーンではサポートされていません。
\nこの方法では、選択済みのリンクグループにキャンペーンを追加したり、その優先順位を変更したりすることができます。追加する際、キャンペーンの種類、割り当てられたチーム、対応時間、追加スキル、および期間の設定は、そのグループに既に存在するキャンペーンの設定にリセットされます。また、コールクォータは無効になります。追加が完了すると、グループの順序が再編成されます。
\n注： このメソッドは、アウトバンドメッセージングキャンペーンではサポートされていません。
\nこのメソッドは、id（カスタムおよびシステムの両方）に基づいて、選択済みのdispositionおよび関連するダイヤルルールを更新します。
\n注：このメソッドは、アウトバウンド・メッセージング・キャンペーンではサポートされていません。
\n「dispositionフォーマットの追加」を参照してください。
\nこのメソッドは、指定された識別子と一致する複数のカスタムディスポジションをキャンペーンから削除します。ディスポジションIDは、?include=dispositionsを指定して_Get Campaign_メソッドを使用することで取得できます（こちらを参照）。
注： このメソッドは、アウトバウンドメッセージングキャンペーンではサポートされていません。
\nこのメソッドは、リクエストの実行中に以下のエラーが発生した場合、それを捕捉して表示します：
\nidsNotFound - ディスポジションが見つからなかったか、選択されたキャンペーンに関連付けられていませんでした。
isSystem - システムディスポジション（削除できません）
このメソッドは、キャンペーンにdispositionを追加します。
\n注： このメソッドは、アウトバウンドメッセージングキャンペーンではサポートされていません。
\nこのメソッドは、キャンペーンに複数のカスタムdispositionを追加します。
\n注： このメソッドは、Outbound Messagingキャンペーンではサポートされていません。
\nこのメソッドは、リクエストの実行中に以下のエラーが発生した場合、それらを捕捉して表示します：
\nmissingRequired - 1つ以上の必須フィールドの値が見つかりませんでした。formatError - 1つ以上のフィールド値でフォーマットが一致していませんでした（例：整数フィールドに文字列値が定義されていた場合）。リクエスト本文に、1つ以上のサポートされていないフィールドが定義されていました。duplicateName - dispositionが見つからないか、選択済キャンペーンに関連付けられていません。このメソッドは、指定された識別子と適合することで、キャンペーンから1つ以上の発信者IDを削除します。発信者IDは、?include=callerIdsを指定して_Get Campaign_メソッドを使用することで取得できます（こちら）。
注：発信者IDの操作を行うには、ユーザーに追加の「_サービスおよびキャンペーン内での発信者IDの管理_」権限が必要です。
\n注：このメソッドは、アウトバウンド・メッセージング・キャンペーンではサポートされていません。
\nこのメソッドは、リクエストの実行中に以下のエラーが発生した場合、それらを捕捉して表示します：
\nidsNotFound - 1つ以上の発信者IDが見つからないか、選択済キャンペーンに関連付けられていません；isDefault - 1つ以上の発信者IDは、既定(デフォルト）として設定されているため削除できません。また、選択メソッドでは既定値が必須です；この方法では、指定された電話番号と照合することで、キャンペーンに1つ以上の発信者IDを割り当てます。
\n注： 発信者IDを操作するには、ユーザーに追加の 「_サービスおよびキャンペーン内での発信者IDの管理_」 権限が必要です。
\n注： このメソッドは、アウトバウンドメッセージングキャンペーンではサポートされていません。
\nこのメソッドは、リクエストの実行中に以下のエラーが発生した場合、それらを検出して表示します：
\nnumbersNotFound - 番号が見つかりませんでした。formatError - 1つ以上のフィールド値でフォーマットが一致していませんでした（例：整数フィールドに文字列値が定義されていた場合）；リクエスト本文に1つ以上のサポートされていないフィールドが定義されていました；このメソッドは、指定された識別子と照合することで、キャンペーンから複数のチームの割り当てを解除します。チームIDは、Contact Center Administratorアプリケーションで該当のチームを開くと確認できます。「チーム」セクションを参照してください。idは、URLの「#GROUPS:GROUP_PROPERTIES:」という部分に記載されています。
\n注： チームを操作するには、ユーザーに追加の「_すべてのチームを管理_」権限が必要です。
\n注：このメソッドは、アウトバンド・メッセージング・キャンペーンではサポートされていません。
\nこのメソッドは、リクエストの実行中に以下のエラーが発生した場合、それを検出して表示します：
\n![「チーム」セクション](\"https://help.brightpattern.com/File:Teams-Overview-54.PNG\"){kind=link}
idsNotFound - チームが見つからなかったか、選択済キャンペーンに関連付けられていませんでした。このメソッドは、キャンペーンに複数のチームを割り当て、チームメンバーに割り当てるサービススキルレベルを指定します。チームは、指定された識別子に基づいて照合されます。チームIDは、「コンタクトセンター管理者」アプリケーションのTeams sectionでそのチームを開くことで確認できます。idは、URLの「#GROUPS:GROUP_PROPERTIES:」という部分に記載されています。
\nNote: チームを操作するには、ユーザーに追加の\"Manage all teams\"権限が必要です。
\nNote: このメソッドは、Outbound Messagingキャンペーンではサポートされていません。
\nこのメソッドは、リクエストの実行中に以下のエラーが発生した場合、それを検出して表示します（エラーが発生した場合のみ）：
\nidsNotFound - チームが見つかりませんでした。
duplicateIDs - チームがすでに追加されています。
このメソッドは、選択済みのキャンペーンの指定されたプロパティを変更します。また、このメソッドでは、_オプションの_パラメータに「 」またはnullを指定することで、そのパラメータを既定(デフォルト）値にリセットすることができます。
\n注： 発信者ID設定の操作を行うには、ユーザーに追加の 「_サービスおよびキャンペーン内での発信元IDの管理_」 権限が必要です。
\n注： このメソッドは、アウトバンド・メッセージング・キャンペーンではサポートされていません。
\nこのメソッドは、選択済みのキャンペーンの指定されたプロパティを変更します。また、このメソッドでは、_オプションの_パラメータに「 」または null を渡すことで、そのパラメータを既定値にリセットすることができます。
\n注： このメソッドは、アウトバウンドメッセージングキャンペーンではサポートされていません。
\nこのメソッドでは、指定したキャンペーンのコピーを作成します。
\n注： このメソッドは、アウトバンドメッセージングキャンペーンではサポートされていません。
\nBright Patternのリスト管理APIを利用すれば、Contact Center Administratorアプリケーションを使用せずに、日常的なキャンペーン管理業務を行うための便利な手段を提供します。このセクションで説明するAPIメソッドを使用すると、管理者はキャンペーンの複製、更新、削除、リンクグループの管理、キャンペーン状態のコントロール、特定のアウトバウンド発信設定の修正、発信者ID、disposition、ダイヤルルールの設定、およびリストの割り当てや消去を行うことができます。
\nBright Patternコンタクトセンターソリューションでは、いくつかのアウトバウンドキャンペーンタイプが定義されています。アウトバウンド音声、ブレンド型音声、およびアウトバウンドメッセージングです。特に断りがない限り、本セクションおよび以降のセクションで説明するAPIメソッドは、すべてのキャンペーンタイプに対応しています。メソッドがアウトバウンドメッセージングに対応しておらず（アウトバウンド音声およびブレンド型音声にのみ適用される）場合、その旨は当該メソッドの説明に明示的に記載されています。
\n注：すべてのキャンペーンに対して操作を行うには、ユーザーに「すべてのサービスおよびキャンペーンを管理する」権限が、Contact Center Administratorアプリケーションで設定されている必要があります。あるいは、ユーザーが自分に割り当てられたキャンペーンのみを操作できるようにするには、「割り当てられたサービスおよびキャンペーンを管理する」権限を有効にする必要があります。その他に必要な権限については、各メソッドの説明に明示的に記載されています。
\n以下で説明するメソッドでは、操作の対象となるキャンペーンを参照するために、パス変数「campaign_id」を使用します。キャンペーンの一意の識別子は、Contact Center Administratorアプリケーションの「サービスとキャンペーン」セクションでそのキャンペーンを開くと確認できます。このidは、URLの「#SERVICES_CAMPAIGNS:SERVICES_PROPERTIES:」というフラグメント部分に表示されます。
あるいは、campaign_id は、Get Campaigns メソッドのレスポンス本文からも確認できます（こちら）。
このメソッドは、キャンペーンに関連付けられた架電リストからレコードのリストを返します。
\nレコードはインデックスによって参照され、リスト内の各レコードには挿入順（0から開始）でインデックスが割り当てられます。リクエストされたレコードインデックス（fromIndex）以上のインデックスを持つすべてのレコードが、レスポンスとして返されます。
注：返されるレコードセットには、インデックスフィールド順に並び替えられた JSON オブジェクトが含まれます。「リスト Record JSON オブジェクト」には、以下のように定義された 2 つのサブオブジェクト「_entry」と「status_」があります。
\nentry object：リストエントリのコピーが含まれます
フィールドの名前は、リスト作成時に定義されたまま保持されます
\n![「サービスとキャンペーン」セクション](\"https://help.brightpattern.com/File:CCA-Services-and-Campaigns-Overview-53.PNG\"){kind=link}
custom_」が追加された形で返されます注：id フィールドで返される値は、その後の API リクエストにおいてこのレコードを参照するために使用できます。
\nstatusobject：この特定のレコードに関するキャンペーンの結果が含まれます
リストがキャンペーンに割り当てられていない場合、またはキャンペーンが存在しない場合は省略されます
\nフィールド名はあらかじめ定義されています
\ncompleted フィールドは常に存在しますが、レコードが発信されなかった場合やエージェントに到達しなかった場合は、その他のフィールドが存在しないことがあります。
\nこのメソッドは、架電リストの中から、リクエストされた開始時刻（fromTime）以降、関連するキャンペーン内で何らかのアクティビティがあったレコードのリストを返します。
注： 返されるレコードセットには、indexフィールド順に並び替えられたJSONオブジェクトが含まれます。List Record JSON Objectには、_entryおよびstatus_という2つのサブオブジェクトがあり、以下のように定義されています：
\nentry object：リストエントリのコピーが含まれます
フィールドの名前は、リスト作成時に定義されたまま保持されます
\ncustom_」が追加された形で返されます_timeおよびdate_フィールドの値は、UTCフォーマットで返されます
\nstatusオブジェクト：この特定のレコードに関するキャンペーンの結果が含まれます
リストがキャンペーンに割り当てられていない場合、またはキャンペーンが存在しない場合は省略されます
\nフィールド名はあらかじめ定義されています
\n_completed_フィールドは常に存在しますが、レコードが一度も発信されなかった場合やエージェントに到達しなかった場合は、その他のフィールドが存在しないことがあります。
\nこのメソッドは、関連付けられたキャンペーンの架電リストにある_既存の_レコードのコピーを返します。このリストは、パス変数「list_id」において、「_Get Campaign_」メソッドのレスポンス本文で返される一意の識別子によって指定されます（こちら）。キャンペーンは、パス変数「campaign_id」において、「_Get Campaigns_」メソッドのレスポンス本文で返される一意の識別子によって指定されます（こちら）。
レコードの検索は、「_Get All Records_」メソッドのレスポンス本文で返される一意の識別子（id）に基づいて行われます（こちらを参照）。指定されたキャンペーンにリストが複数回追加されている場合、このメソッドはレコードの配列を返します。選択済みのリストに指定された id を持つレコードが存在しない場合は、エラーが返されます。
注：レスポンス本文には、以下の2つのサブオブジェクトで定義される「リスト Record」JSONオブジェクトが含まれます：
\nentry object：リストエントリのコピーを含みますcustom_」というプレフィックスが追加された状態で返されますstatusオブジェクト：この特定のレコードに対するキャンペーンの結果が含まれます注：PHONE タイプのフィールドがキーとして定義されている場合、レコードの値が、データベースまたは元のソース（データベースへの読み込み時にデータが修正された場合）に保存されている値と完全に適合するかどうかがチェックされます。
\nこのメソッドは、path 変数で指定された既存の架電リストから、レコードのリストを返します。
\nレコードはインデックスによって参照され、リスト内の各レコードには挿入順（0から開始）でインデックスが割り当てられます。リクエストされたレコードインデックス（fromIndex）以上のインデックスを持つすべてのレコードが、レスポンスとして返されます。
注：返されるレコードセットには、index フィールド順に並び替えられた JSON オブジェクトが含まれます。リストレコードの JSON オブジェクトには以下が含まれます：
\nentry object：リストエントリのコピーを含みます
フィールドの名前は、リスト作成時に定義されたまま保持されます
\n注：_id_フィールドで返される値は、以降のAPIリクエストにおいてこのレコードを参照するために使用できます。
\nこのメソッドは、架電リスト内の1つ以上の既存レコードのコピーを返します。レコードの検索は、定義されたキーフィールドに基づいて行われます。
\n注：日時フィールドの値は、UTCフォーマットで返されます。
\n注：PHONE タイプのフィールドがキーとして定義されている場合、レコードの値は、データベースまたは元のソース（データベースへの読み込み時にデータが修正された場合）に保存されている値と完全に適合するかどうかがチェックされます。
\nこのメソッドは、MongoDBの標準フィールド「_id」で並び替えられたすべての架電リストを返します。
注： 大量のリストレコードを表示できるようにするため、Bright Pattern Contact Solutionでは_カーソルベースのページネーション_を採用しています（こちらを参照）。「_id」フィールドは、最後に処理されたレコードを参照する「カーソル」として使用されます。
このメソッドは、指定されたリストに関する情報（リストの名前、フォーマット名、タイムゾーン設定、レコード数など）を返します。さらに、そのリストに関連付けられているキャンペーンがある場合は、その情報も返します。
\nこの方法では、リストを削除し、そのリストに関連付けられたキャンペーン結果を含むすべてのレコードをアーカイブします。特定のフォーマットを使用していた最後のリストが削除された場合、そのフォーマットも削除されます。
\n注： Bright Pattern コンタクトセンターソリューションでは、いくつかの_音声_キャンペーンモードがサポートされています（こちらを参照）。関連するキャンペーンのモードに応じて、アクティブなコールの挙動は次のように異なります：
\n完了したコールの結果はアーカイブされ、「コンタクトセンター管理者」アプリケーションからダウンロード可能です（こちらを参照）。切断されたコールのインタラクション結果は保存されません。
\nこのメソッドは、既存のフォーマットを使用して新規の空のリストを作成します。フォーマットは、Get Lists メソッドのレスポンス本文で返される一意の識別子である formatId によって指定されます（こちらを参照）。
このメソッドは、新規の空のリストと、そのリストに対応する新規のフォーマットを作成します。
\n新規のリストフォーマットを作成する際は、以下の_プロパティ_を考慮してフィールドを定義する必要があります。
\n注：このメソッドが呼び出された際、以下のプロパティは使用されません：CUSTOM_DELIMITER（既定値「COMMA」が設定されます）、DEFAULT_ENCODING（既定値「UTF-8」が設定されます）、DELIMITER_TYPE、FORMAT_TYPE（既定値「DELIMITED」が設定されます）、NAMES_IN_FIRST_LINE、SOURCE_TYPE。
このメソッドを使用すると、パス変数「list_id」で指定された既存の架電リストの名前や有効期限の設定を変更することができます。
\nこのメソッドは、架電リスト内の_既存の_レコードのフィールドを更新し、正常に更新されたレコードの数を返します。
\n注： 架電リストのコンテンツを操作するには、ユーザーに追加の「架電リストのコンテンツの更新」権限が必要です。
\nこのメソッドは、リクエストの実行中に以下のエラーが発生した場合、それらを捕捉して表示します：
\nlimitExceeded - 既存のすべてのリストを合わせた合計行数が上限に達しましたmissingKey - 1つ以上のキーフィールドの値が見つかりませんでした；duplicateKey - リスト内に同じキーを持つレコードがすでに存在します；missingRequired - 1つ以上の必須フィールドに値が入力されていません;formatError - 1つ以上のフィールド値でフォーマットが一致していませんでした（例：整数フィールドに文字列値が指定されていました）；リクエスト本文に、1つ以上のサポートされていないフィールドが定義されていましたこのメソッドは、架電リストに新規のレコードを1件追加します。
\nレコードが追加される前に、そのキー値が一意であるかどうかがリストのコンテンツに対してチェックされます。リストに指定されたキー値を持つレコードがまだ存在しない場合、新規のレコードは正常に追加されます。
\n注： 架電リストのコンテンツを操作するには、ユーザーに追加で「架電リストの内容を更新する」権限が必要です。
\nこのメソッドは、架電リスト内の_既存の_レコードのフィールドを更新し、正常に更新されたレコードの数を返します。また、このメソッドでは、_オプションの_パラメータに「 」または null を渡すことで、それらのパラメータを既定値にリセットすることができます。
\n注： 架電リストのコンテンツを操作するには、ユーザーが追加で「架電リストのコンテンツを更新する」権限を持っている必要があります。
\nこのメソッドは、リクエストの実行中に以下のエラーが発生した場合、それらを捕捉して表示します：
\nmissingKey - 1つ以上のキーフィールドの値が見つかりませんでした；keyNotFound - DNCリストに同じキーを持つレコードがすでに存在します；formatError - 1つ以上のフィールド値でフォーマットが一致していませんでした（例：整数フィールドに文字列値が指定されていました）；リクエスト本文に、サポートされていないフィールドが1つ以上定義されていました注： このメソッドは、Update Record メソッドと類似しています。ただし、1回のリクエスト内で複数のレコードを更新できるようにするため、入力パラメータが異なります。これは、各リクエストごとに架電リスト全体の再処理が必要となることを考慮したものです。
\nこのメソッドは、架電リスト内の_既存の_レコードのフィールドを更新します。また、このメソッドでは、_オプションの_パラメータに「 」またはnullを渡すことで、そのパラメータを既定値にリセットすることができます。
\n注： 架電リストのコンテンツを操作するには、ユーザーに追加の「架電リストのコンテンツの更新」権限が必要です。
\nレコードの検索は、定義されたキーフィールドに基づいて行われます。リクエストには、リストレコード JSON オブジェクトのフィールドのすべてまたは一部を含めることができますが、キーフィールドは必須であり、リスト作成時に設定されたとおりに保持する必要があります。
\nレコードのクエリ実行前に、一意のキー値に基づいて、指定されたリスト内でのレコードの存在が確認されます。指定されたリストにレコードが存在する場合、レコードの更新は成功します。
\n注： PHONEタイプのフィールドがキーとして定義されている場合、レコードの値が、データベースまたは元のソース（データベースへの読み込み時にデータが修正された場合）に保存されている値と完全に一致するかどうかがチェックされます。
\nリストの再処理時間によってキャンペーン作業に支障が生じるのを防ぐため、ダイヤラーは、そのレコードへのコールを試行するまで、レコードに加えられた変更を無視します。したがって、更新されたレコードを含むリストに フィルター や 並び替え が設定されている場合、そのレコードに加えられた変更は、そのフィルタリングや並び替えの優先順位には影響しません。
\n注： 更新されたレコードに加えた変更を反映させたい場合は、必ず希望する フィルター または 並び替え 設定を再適用することを忘れないでください。
\nこのメソッドは、リストからレコードを削除し、正常に削除されたレコードの数を返します。
\n注：架電リストのコンテンツを操作するには、ユーザーが追加で「架電リストのコンテンツを更新する」権限を持っている必要があります。
\nレコードは、関連するリストのフィールドに基づいて定義された1つまたは複数の条件によって検索されます。利用可能なフィルタリング条件のうち、少なくとも1つを指定する必要があります。指定がない場合、レコードは削除されません。
\nこのメソッドでは、以下の条件によるレコードのフィルタリングに対応しています：
\nfields.some_fieldパラメータで定義されたもの）；byCampaignResult.policyパラメータで定義されています）；createdFromおよびcreatedToパラメータで定義されます）；注：フィルタリングされたレコードは、そのリストが関連付けられているすべてのキャンペーンから削除されます。
\nこのメソッドは、リストからレコードと、それに関連するすべてのキャンペーン結果を消去します。レコードの検索は、定義されたキーフィールドに基づいて行われます。レコードが存在しない場合は、エラーが返されます。
\n注： 架電リストのコンテンツを操作するには、ユーザーに追加の「架電リストのコンテンツを更新する」権限が必要です。
\nBright Pattern Contact Center ソリューションは、いくつかの_音声_キャンペーンモードに対応しています（こちらを参照）。_最後のレコードが削除される場合_、関連するキャンペーンのモードに応じて、アクティブなコールの挙動は次のように異なります：
\nそれ以外の場合、_リストにまだ他のレコードが残っている場合_、この操作はどのコールにも影響を与えません。
\n通話完了済みの削除済みレコードのリストおよびその結果はアーカイブされ、コンタクトセンター管理者アプリケーションでダウンロード可能です（こちらを参照）。切断されたコールのインタラクション結果は保存されません。
\n注： このメソッドでは、連絡先、アクティビティ、音声録音、トランスクリプト、およびスクリーン録画は削除されません。これらの機能については、その他のAPIで対応されています。
\nこのメソッドは、リストからすべてのレコードを削除し、正常に削除されたレコードの数を返します。
\n注： 架電リストのコンテンツを操作するには、ユーザーが追加で「架電リストの内容を更新する」権限を持っている必要があります。
\nBright Pattern コンタクトセンターソリューションは、複数の_音声_キャンペーンモードに対応しています（こちらを参照）。関連するキャンペーンのモードに応じて、アクティブなコールの挙動は次のように異なります：
\n通話完了済みの削除済みレコードのリストおよびその結果はアーカイブされ、「コンタクトセンター管理者」アプリケーションからダウンロード可能です（こちらを参照）。切断されたコールのインタラクション結果は保存されません。
\nBright Patternのリスト管理APIは、リストやフォーマットの作成・削除を効率化し、リストレコードを管理するための便利な手段を提供します。
\n注： リストに対する操作を行うには、ユーザーに「リストの管理」権限が必要です。この権限は、Contact Center Administratorアプリケーションで設定されます。その他に必要な権限については、各メソッドの説明で明示的に記載されています。
\n以下で説明するすべてのメソッドでは、操作の対象となるリストを指定するために、パス変数 list_id を使用します。リストの一意の識別子は、Contact Center Administrator アプリケーションの「リスト」セクションでそのリストを開くと確認できます。idは、URLの「#LISTS:LISTS_PROPERTIES:」という部分に記載されています。
あるいは、list_id は、Get Lists メソッドのレスポンス本文内でも確認できます（こちら）。
以前のバージョンのリスト管理APIから引き継がれ、「DEPRECIATED」とタグ付けされたメソッドでは、選択済のリストに関連付けられたキャンペーンを参照するために、追加のパス変数campaign_idが必要です。キャンペーンの一意の識別子は、Contact Center Administrator アプリケーションの「サービスとキャンペーン」セクションでそのキャンペーンを開くと確認できます。idは、URLの「#SERVICES_CAMPAIGNS:SERVICES_PROPERTIES:」という部分に記載されています。
あるいは、campaign_id は、Get Campaigns メソッドのレスポンス本文からも確認できます（こちら）。
注： レコードのインポートや更新を行う際は、以下の点に留意することが重要です：
\n先頭および末尾の空白はすべて削除する必要があります。
\nすべてのPHONE番号について：
\n番号が「+」で始まる場合、先頭の「+」記号は消去されます。
\n番号に数字以外の文字が含まれている場合は、それらが消去されます。
\n電話番号は少なくとも1つ必須です。
\n米国およびカナダのPHONE番号については：
\n番号が「011」で始まる場合は、そのまま保持されます。
\n番号が「1」で始まり、11桁の場合は、そのまま保持されます。
\n番号が「1」で始まらず、10桁の場合は、先頭に「1」が追加されます。
\n番号が「1」で始まり、10桁の場合は、レコードはインポートされず、フォーマットエラーが返されます。
\nそれ以外の場合は、レコードはインポートされず、フォーマットエラーが返されます。
\n「プレフィックスを削除」および「既定(デフォルト）の国コード」フィールドは無視されます。
\nその他の国のPHONE番号の場合：
\n番号の先頭が「プレフィックスを削除」に適合するプレフィックスで始まる場合、そのプレフィックスは削除されます。
\n番号の先頭が「プレフィックスを削除」に適合するプレフィックスで始まっていない場合は、そのまま保持されます。
\n番号の先頭が「既定(デフォルト）の国コード」に適合するプレフィックスで始まっていない場合、「既定(デフォルト）の国コード」が追加されます。
\nすべてのINTEGERフィールドについて：
\n値が文字列として指定されている場合は、整数に変換する必要があります。
\n整数として提示された値は、そのままサポートされる必要があります。
\n文字列を期待するすべてのフィールド（ACCOUNT、AGENT_LOGIN_ID、FIRST_NAME、LAST_NAMEなど）については、整数値を文字列に変換する必要があります。
\n大文字と小文字は区別されます。大文字と小文字が異なる値は、異なる値として扱われます。
\nすべてのDATE/TIMEおよびDATE/TIME - SCHEDULE CALL ATフィールドについて：
\n検索は、サードパーティシステムで作成された元の値と、Contact Center Administrator アプリケーションおよびエージェントデスクトップに表示される変換後の値の双方で行えます。
\n必須の権限：
\nこのメソッドは、指定されたDNCリストからすべてのレコードを削除し、削除されたレコードの数を返します。
\n応答コード：
\n","urlObject":{"protocol":"https","path":["configapi","v3","donotcalllist","deleteAll",":do_not_call_list_id"],"host":["必須の権限：
\nこのメソッドは、DNCリストから指定されたレコードのリストを削除し、削除されたレコードの数と、エラーがある場合はそのリストを返します。
\n以下のエラーが発生した場合は、処理する必要があります：
\n入力パラメータ：DNCリストのレコードのJSONオブジェクトのリスト。キーフィールドのみが必須です。
\n応答コード：
\n","urlObject":{"protocol":"https","path":["configapi","v3","donotcalllist","delete",":do_not_call_list_id"],"host":["必須の権限：
\nこのメソッドは、指定された「DNC（発信禁止）リスト」に新規のレコードを追加し、追加（つまり、末尾に付加）されたレコードの数を返します。重複は無視されます。
\n以下のエラーが発生した場合は、適切に処理してください：
\n入力パラメータ：DNCリストのレコードのJSONオブジェクトのリスト。
\n応答コード：
\n","urlObject":{"protocol":"https","path":["configapi","v3","donotcalllist","addAll",":do_not_call_list_id"],"host":["必須の権限：
\nこのメソッドは、指定された発信禁止（DNC）リストに新規のレコードを追加し、追加（つまり、末尾に付加）されたレコードの数を返します。重複は無視されます。
\n応答コード：
\n","urlObject":{"protocol":"https","path":["configapi","v3","donotcalllist","add",":do_not_call_list_id"],"host":["必須の権限：
\nこのメソッドは、指定された発信禁止（DNC）リスト内のすべてのレコードを削除し、新規のレコードを挿入して、新たに挿入されたレコードの数を返します。重複レコードは無視されます。
\n応答コード：
\n","urlObject":{"protocol":"https","path":["configapi","v3","donotcalllist","replaceAll",":do_not_call_list_id"],"host":["このメソッドは、パス変数do_not_call_list_idで指定された既存のDNCリスト内のすべてのレコードのリストを返します。レコードは、MongoDBの標準フィールド_idに基づいて並び替えられて返されます。
注： 大量のリストレコードを表示できるようにするため、Bright Pattern Contact Solutionでは_カーソルベースのページネーション_を採用しています（こちらを参照）。_idフィールドは、最後に処理されたレコードを参照するための「カーソル」として使用されます。
このメソッドは、MongoDBの標準フィールドである_idで並び替えられたすべてのDNCリストを返します。
注： 大量のリストレコードを表示できるようにするため、Bright Pattern Contact Solutionでは_カーソルベースのページネーション_を採用しています（こちらを参照）。_idフィールドは、最後に処理されたレコードを参照するための「カーソル」として使用されます。
このメソッドは、指定されたDNCリストに関する詳細情報（リストの名前、種類、レコード総数など）を返します。また、該当する場合は、有効期限やリセットの設定も返します。
\nさらに、このメソッドは、そのDNCリストに関連付けられているキャンペーン（存在する場合）に関する情報も返します。
\nこのメソッドでは、新規の空のDNCリストを作成します。指定されたDNCリストの種類に応じて、作成プロセスは以下の通りです：
\n![「リスト」セクション](\"https://help.brightpattern.com/File:CCA-Lists-Properties-54.PNG\"){kind=link}