Bright Patternのリスト管理APIは、これまで「コンタクトセンター管理者」アプリケーション内でのみ利用可能だった幅広い機能に対応しています。バージョン3.0では、運用上の課題を克服し、キャンペーン管理プロセスを効率化するための、新規および強化されたAPIメソッドが搭載されています。
\nBright Patternのリスト管理API 3.0では、以下のことが可能になります：
\n注：前回の API バージョンとの互換性を確保し、シームレスな移行を容易にするため、以前に利用可能だったすべてのメソッドはそのまま維持されています。ただし、名前に「DEPRECATED」というタグが付いているメソッドは使用を推奨しておらず、それぞれの機能に対応する新規のメソッドが定義されています。
\nこのドキュメントでは、利用可能なREST APIメソッドについて説明し、その機能を明記するとともに、リクエストおよびレスポンスの例を示します。個々のメソッド、および「List Management API 3.0」の全コレクションをPostmanに読み込み、お客様固有のBright Pattern Contact Centerアクセストークンを経由して操作することができます。
\nnew* - List Management API 2.0以降で追加されました
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"58450950","collectionId":"01fe87ed-43f2-423b-925c-b58a430c6e49","publishedId":"2sBYB4Lmyh","public":true,"customColor":{"right-sidebar":"303030","top-bar":"FFFFFF","highlight":"FF6C37"},"publishDate":"2026-09-29T10:25:40.000Z"},"item":[{"name":"認証","item":[{"name":"Get Access Token","id":"19b1922c-6573-4bdc-954d-9f338f1020f6","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このメソッドは、_有効_になっているアウトバウンドキャンペーンのリスト、それらの現在の状態、および一意の識別子を返します。設定されたユーザーの権限に基づいて、このリストにはすべてのキャンペーンが含まれるか、またはこのユーザーに割り当てられたキャンペーンのみが含まれます（こちらを参照）。現在有効なアウトバウンドキャンペーンがない場合、またはユーザーに割り当てられたキャンペーンがない場合は、空のリストが返されます。
\n注：レスポンス本文で返されるキャンペーンの一意の識別子は、その後のAPIリクエストのパス変数において、そのキャンペーンを参照するために使用できます。
\nこのメソッドは、有効_または_無効な_キャンペーンの現在の状態（_STOPPED または _RUNNING_）と、それに関連付けられた架電リストおよびDNCリストを返します。
\n注：レスポンス本文で返されるリストおよびDNCリストの一意の識別子は、その後のAPIリクエストにおいてこれらのリストを参照するために使用できます。
\n注：Bright Pattern Contact Center ソリューションは、内部、地理的（郵便番号）、地理的（州/県）、地理的（市外局番）、およびレコード除外という、いくつかの DNCリストタイプをサポートしています（ こちら）。これらのリストタイプには、レスポンス本文内でそれぞれ以下の値が割り当てられています：INTERNAL、GEOGRAPHIC_POSTAL、GEOGRAPHIC_STATE、GEOGRAPHIC_AREACODE、EXCLUSION。
このメソッドは、有効_または_無効_なキャンペーンの現在の状態（_STOPPED または _RUNNING_）を返します。
\nこのメソッドは、_有効な_キャンペーンを開始します。その際、まずそのキャンペーンが_無効_になっていないか、あるいはすでに実行中ではないかを確認します。
\n注： キャンペーンの状態を変更するには、ユーザーに追加の 「_キャンペーンの開始およびリストの有効化_」 権限が必要です。
\nこのメソッドは、_有効な_キャンペーンを停止します。その際、まずそのキャンペーンが_無効_になっていないか、あるいはすでに停止されていないかを確認します。
\n注： キャンペーンの状態を変更するには、ユーザーに追加の 「_キャンペーンの開始およびリストの有効化_」 権限が必要です。
\nこのメソッドは、選択済のキャンペーンにリストを追加します。
\n追加されると、この特定のキャンペーンに関連付けられたリストのインスタンスが作成されます。そのインスタンスのIDは、元のリスト内のレコードの合計数とともに、レスポンス本文で返されます。
\n注: インスタンスの一意の識別子は、リストの紐付け解除や更新、キャンペーン結果の取得、またはそのリストからのレコードの照会にさらに使用できます。
\n注： キャンペーンに関連付けられた架電リストを操作するには、ユーザーに追加の 「_Start campaigns and enable lists_」 権限が必要です。
\nこのメソッドは、関連付けられたキャンペーン内のリストのインスタンスのプロパティを変更します。インスタンスは、Get Campaign メソッドのレスポンス本文で返される一意の識別子「instanceID」によって指定されます（こちらを参照）。さらに、このメソッドでは、_オプション_のパラメータに「 」または null を渡すことで、そのパラメータを既定値にリセットすることができます。
リストが更新される前に、指定されたキャンペーンとの紐付けが確認されます。インスタンスが指定されたキャンペーンに紐付けられている場合、リストは正常に更新されます。
\n注： キャンペーンに関連付けられた架電リストのコンテンツを操作するには、ユーザーに追加の「_キャンペーンの開始およびリストの有効化_」権限が必要です。
\nこのメソッドは、関連付けられたキャンペーンからリストのインスタンスを削除します。削除対象のインスタンスは、Get Campaign メソッドのレスポンス本文で返される一意の識別子「instanceID」によって指定されます（こちらを参照）。
注： Bright Pattern Contact Centerソリューションは、いくつかの_音声_キャンペーンモードに対応しています（こちらを参照）。関連付けられたキャンペーンのモードに応じて、アクティブなコールの挙動は次のように異なります：
\n完了したコールの結果はアーカイブされ、「コンタクトセンター管理者」アプリケーションからダウンロード可能です（こちらを参照）。切断されたコールの対話結果は保存されません。
\nこのメソッドは、インスタンス内のすべてのレコードのリストを返し、必要に応じてリクエストの試行回数を表示します。返されるレコードは、MongoDB の標準フィールドである_idでソートされます。クエリの対象となるインスタンスは、一意の識別子であるinstanceIDによって指定されます。この識別子は、Get Lists メソッドを使用して取得できます。
Note: 大量のリストレコードを表示できるようにするため、Bright Pattern Contact Solution では_カーソルベースのページネーション_を採用しています（hereを参照）。_idフィールドは、最後に処理されたレコードを参照するための「カーソル」として使用されます。
Note: List Management API 3.0 でこのメソッドに対して定義されている入力パラメータは、Lists.Get All Records DEPRECATED バージョンとは異なります。
\nNote: レスポンス本文には、リストレコードの JSON オブジェクトが含まれており、以下の 2 つのサブオブジェクトで構成されています。
\nentry object：リストエントリーのコピーを含みます
フィールド名は、リスト作成時に定義されたまま保持されます
\ncustom_」というプレフィックスが追加された形で返されますstatusobject：この特定のレコードに関するキャンペーンの結果が含まれます
フィールド名はあらかじめ定義されています
\ncompleted フィールドは常に存在しますが、レコードが発信されなかった場合やエージェントに到達しなかった場合、その他のフィールドが存在しないことがあります。
\nattempts list：行われたすべてのリクエストの試行が含まれます（有効になっている場合）
Note: Time および date フィールドの値は、UTC フォーマットで返されます。
\nこのメソッドは、インスタンス内のすべての完了済みレコードのリストを返します。インスタンスは、Get キャンペーン メソッドのレスポンス本文で返される一意の識別子「instanceID」によって指定されます（こちらを参照）。オプションとして、ユーザーはリクエストの試行履歴を確認したり、完了済みレコードリストを表示したい期間を指定したりすることができます。レコードは完了日時（MongoDBのcompletedTimeフィールド）順に並び替えられて返されます。
注：大量のリストレコードを表示できるようにするため、Bright Pattern Contact Solutionでは_カーソルベースのページネーション_を採用しています（こちらを参照）。_idフィールドとcompletedTimeフィールドは連結され、最後に処理されたレコードを参照するための「カーソル」として使用されます。
注：レスポンス本文には、リストレコードのJSONオブジェクトが含まれており、以下の2つのサブオブジェクトで定義されています：
\nentry object：リストエントリのコピーを含みます
フィールドの名前は、リスト作成時に定義されたまま保持されます
\ncustom_」というプレフィックスが追加された形で返されますstatusobject：この特定のレコードに関するキャンペーン結果が含まれます
フィールド名はあらかじめ定義されています
\n_completed_フィールドは常に存在しますが、レコードが発信されなかった場合やエージェントに到達しなかった場合は、他のフィールドが存在しない場合があります。
\nattempts リスト：行われたすべてのリクエストの試行が含まれます（有効になっている場合）
注：_時刻および日付_フィールドの値は、UTC フォーマットで返されます。
\nこのメソッドは、インスタンス内の更新されたすべてのレコードのリストを返します。インスタンスは、Get キャンペーン メソッドのレスポンス本文で返される一意の識別子「instanceID」によって指定されます（こちらを参照）。オプションとして、ユーザーはリクエストの試行履歴を確認したり、更新されたレコードリストを表示したい期間を指定したりすることができます。レコードは、最後の試行日（MongoDBのlastDateフィールド）順に並び替えられて返されます。
Note: 大量のリストレコードを表示できるようにするため、Bright Pattern Contact Solutionでは_カーソルベースのページネーション_を採用しています（こちらを参照）。_id と lastDateフィールドが連結され、最後に処理されたレコードを参照するための「カーソル」として使用されます。
Note: List Management API 3.0 でこのメソッドに対して定義されている入力パラメータは、Lists - Get Updated Records DEPRECATED版とは異なります。
\nNote: レスポンス本文には、以下の2つのサブオブジェクトで定義される「リストレコード」JSONオブジェクトが含まれます：
\nentry object: リストエントリのコピーが含まれます
フィールドの名前は、リスト作成時に定義されたまま保持されます
\ncustom_」というプレフィックスが追加された形で返されますstatusobject: この特定のレコードに関するキャンペーン結果が含まれます
フィールドの名前はあらかじめ定義されています
\ncompleted フィールドは常に存在しますが、レコードが発信されなかった場合やエージェントに到達しなかった場合は、その他のフィールドが存在しない場合があります。
\nattempts list: 行われたすべてのリクエストの試行が含まれます（有効になっている場合）
Note: Time および date フィールドの値は、UTC フォーマットで返されます。
\nこのメソッドは、インスタンス内の既存のレコードのコピーと、そのレコードに関連付けられた最新のインタラクションに関する情報を返します。インスタンスは、Get Campaign メソッドのレスポンス本文で返される一意の識別子「instanceID」によって指定されます（こちらを参照）。オプションとして、行われたすべてのリクエストの試行履歴を表示することも可能です。
レコードの検索は、定義されたキーフィールドに基づいて行われます。レコードのクエリを実行する前に、指定されたリスト内にそのレコードが存在するかどうかが確認されます。指定されたリストにレコードが存在する場合、レコードのクエリは正常に実行されます。
\nNote: PHONE タイプのフィールドがキーとして定義されている場合、レコードの値が、データベースまたは元のソース（データベースへの読み込み時にデータが修正された場合）に保存されている値と完全に一致するかどうかがチェックされます。
\nNote: レスポンス本文には、以下の2つのサブオブジェクトで定義される「リストレコード」JSONオブジェクトが含まれます：
\nentry object: リストエントリのコピーが含まれます
フィールドの名前は、リスト作成時に定義されたまま保持されます
\ncustom_」というプレフィックスが追加された形で返されますstatusobject: この特定のレコードに関するキャンペーンの結果が含まれます
フィールド名はあらかじめ定義されています
\n_completed_フィールドは常に存在しますが、レコードが発信されなかった場合やエージェントに到達しなかった場合は、その他のフィールドが存在しないことがあります。
\nattempts list: 行われたすべてのリクエストの試行が含まれます（有効化されている場合）
Note: Time および date フィールドの値は、UTC フォーマットで返されます。
\nBright Patternのリスト管理APIを利用すれば、Contact Center Administratorアプリケーションを使用せずに、日常的なキャンペーン管理業務を効率的に行うことができます。このセクションで説明するAPIメソッドを使用することで、管理者はキャンペーンのアクティビティを操作したり、キャンペーンデータを表示したり、関連する架電リストに対してアクションを実行したりすることができます。
\nBright Patternのコンタクトセンターソリューションでは、いくつかのアウトバウンドキャンペーンタイプが定義されています。アウトバウンド音声、ブレンド型音声、およびアウトバウンド・メッセージングです。本セクションおよび続く各セクションで説明するAPIメソッドは、これらの各キャンペーンタイプを完全にサポートしています。
\n注：すべてのキャンペーンに対して操作を行うには、ユーザーに「すべてのサービスおよびキャンペーンを管理する」権限が必要です。または、「割り当てられたサービスおよびキャンペーンの管理」権限を有効にすることで、ユーザーは自分に割り当てられたキャンペーンのみを操作できるようになります。その他必須の権限については、対応するメソッドの説明で明示的に指定されています。
\n以下で説明するメソッドでは、操作の対象となるキャンペーンを参照するために、パス変数「campaign_id」を使用します。キャンペーンの一意の識別子は、Contact Center Administratorアプリケーションの「サービスおよびキャンペーン」セクションで、そのキャンペーンを開くことで確認できます。この id は、URL の「#SERVICES_CAMPAIGNS:SERVICES_PROPERTIES:」という部分に記載されています。
あるいは、campaign_id は、Get Campaigns メソッドのレスポンス本文からも確認できます（こちら）。
このメソッドは、キャンペーンに関連付けられた架電リストからレコードのリストを返します。
\n注： このメソッドは、以前のバージョンのリスト管理APIから引き継がれたものであり、使用は推奨されません。代わりに、機能強化された キャンペーン - Get All Records メソッドを使用することをお勧めします。
\nレコードはインデックスによって参照され、リスト内の各レコードには挿入順（0 から開始）にインデックスが割り当てられます。リクエストされたレコードインデックス（fromIndex）以上のインデックスを持つすべてのレコードが、レスポンスとして返されます。
注： 返されるレコードセットには、インデックスフィールド順に並び替えられた JSON オブジェクトが含まれます。「リストレコード JSON オブジェクト」には、_entry_ および status という 2 つのサブオブジェクトがあり、以下のように定義されています：
\nentry object：リストエントリのコピーを含みます
statusobject：この特定のレコードに関するキャンペーンの結果が含まれています
フィールド名はあらかじめ定義されています
\ncompleted フィールドは常に存在しますが、レコードが発信されなかった場合やエージェントに到達しなかった場合は、その他のフィールドが存在しない場合があります
\n注： 指定されたリストがキャンペーンに紐付けられていない場合、このメソッドは空のリスト、つまり([]).を返します
このメソッドは、架電リストの中から、リクエストされた開始時刻（fromTime）以降、関連するキャンペーン内で何らかのアクティビティがあったレコードのリストを返します。
注：このメソッドは、以前のリスト管理 API バージョンから引き継がれたものであり、使用は推奨されません。代わりに、機能強化された 「キャンペーン - 更新されたレコードを取得する」 メソッドを使用することをお勧めします。
\n注：返されるレコードセットには、インデックスフィールド順に並び替えられた JSON オブジェクトが含まれます。リストレコードの JSON オブジェクトには、_entry_ および status という 2 つのサブオブジェクトがあり、以下のように定義されています。
\nentry object：リストエントリのコピーが含まれます
フィールドの名前は、リスト作成時に定義されたまま保持されます
\nstatusobject：この特定のレコードに関するキャンペーンの結果が含まれます
フィールドの名前はあらかじめ定義されています
\n_completed_フィールドは常に存在しますが、レコードが発信されなかった場合やエージェントに到達しなかった場合は、その他のフィールドが存在しないことがあります
\nattempts リスト：行われたすべてのリクエストの試行が含まれます
注：time および date フィールドの値は、UTC フォーマットで返されます。
\n注：指定されたリストがキャンペーンに紐付けられていない場合、このメソッドは空のリスト、つまり ([]). を返します。
このメソッドは、関連付けられたキャンペーンの架電リストにある_既存の_レコードのコピーを返します。レコードの検索は、定義されたキーフィールドに基づいて行われます。
\n注：このメソッドは、以前のリスト管理 API バージョンから引き継がれたものであり、使用は推奨されません。代わりに、機能強化された 「キャンペーン - レコードのクエリ」 メソッドを使用することをお勧めします。
\nリストが指定されたキャンペーンに複数回追加されている場合、このメソッドはレコードの配列を返します。リストがいずれのキャンペーンにも紐付けられていない場合でも、任意の文字列（例：'aaa'）をcampaign_idとして渡すことで、レコードをクエリできます。
注：レスポンス本文には、リストレコードの JSON オブジェクトが含まれており、以下の 2 つのサブオブジェクトで定義されています：
\n![「サービスおよびキャンペーン」セクション](\"https://help.brightpattern.com/File:CCA-Services-and-Campaigns-Overview-53.PNG\"){kind=link}
entry object：リストエントリのコピーが含まれますstatusobject：この特定のレコードに関するキャンペーン結果が含まれています注：日時フィールドの値は、UTC フォーマットで返されます。
\n注：PHONE タイプのフィールドがキーとして定義されている場合、レコードの値が、データベースまたは元のソース（データベースへの読み込み時にデータが修正された場合）に保存されている値と完全に適合するかどうかがチェックされます。
\n注：指定されたリストがキャンペーンに紐付けられていない場合、このメソッドはステータスオブジェクトを返しません。
\nこのメソッドは、MongoDBの標準フィールド「_id」で並び替えられたすべての架電リストを返します。
注：大量のリストレコードを表示できるようにするため、Bright Pattern Contact Solutionでは_カーソルベースのページネーション_を採用しています（こちらを参照）。「_id」フィールドは、最後に処理されたレコードを参照するための「カーソル」として使用されます。
このメソッドは、指定されたリストに関する情報（リストの名前、フォーマット名、レコード数など）を返します。さらに、そのリストに関連付けられているキャンペーンがある場合は、その情報も返します。
\nこの方法では、リストを削除し、そのリストに関連付けられたすべてのキャンペーン結果を含むレコードをアーカイブします。特定のフォーマットを使用していた最後のリストが削除された場合、そのフォーマットも削除されます。
\n注： Bright Pattern Contact Centerソリューションでは、いくつかの_音声_キャンペーンモードに対応しています（こちらを参照）。関連するキャンペーンのモードに応じて、アクティブなコールの挙動は次のように異なります：
\n完了したコールの結果はアーカイブされ、「コンタクトセンター管理者」アプリケーションからダウンロードできます（こちらを参照）。切断されたコールのインタラクション結果は保存されません。
\nこのメソッドは、既存のフォーマットを使用して、新規の空のリストを作成します。フォーマットは、Get Lists メソッドのレスポンス本文で返される一意の識別子「formatId」によって指定されます（こちらを参照）。
このメソッドは、新規の空のリストと、そのリストに対応する新規のフォーマットを作成します。
\n注： 既定では、新しく作成されたフォーマットには以下の設定が適用され、これらは変更_できません_：
\n入力ファイルのエンコーディング は UTF-8 に設定されています
\nフィールド名を含むヘッダー行は追加されません
\n区切り文字 は「コンマ」文字に設定されています
\n新規のリストフォーマットを作成する際は、以下の_プロパティ_を念頭に置いてフィールドを定義する必要があります：
\nこのメソッドは、架電リストに複数の新規レコードを追加し、正常に追加されたレコードの数を返します。
\n注： 架電リストのコンテンツを操作するには、ユーザーに追加の「架電リストの内容を更新する」権限が必要です。
\nこのメソッドは、リクエストの実行中に以下のエラーが発生した場合、それらを捕捉して表示します：
\nlimitExceeded - 既存のすべてのリストを合わせた行数の最大合計数に達しましたmissingKey - 1つ以上のキーフィールドの値が見つかりませんでした；duplicateKey - リスト内に同じキーを持つレコードがすでに存在します;missingRequired - 1つ以上の必須フィールドに値が入力されていません；formatError - 1つ以上のフィールド値のフォーマットが一致していませんでした（例：整数フィールドにブール値が指定されていました）；リクエスト本文に1つ以上の未サポートのフィールドが定義されていました注：発生したエラーの種類は、そのエラーにより追加できなかったオブジェクトのリストとともに、レスポンス本文で返されます。以下の例は、説明されたすべてのエラーに対するレスポンスフォーマットを示しています。
\nこのメソッドは、架電リストに新規のレコードを1件追加します。
\nレコードが追加される前に、そのキー値が一意であるかどうかがリストのコンテンツと照合されます。リストに指定されたキー値を持つレコードがまだ存在しない場合、新規のレコードは正常に追加されます。
\n注：架電リストのコンテンツを操作するには、ユーザーが追加の「架電リストの内容を更新する」権限を持っている必要があります。
\nこのメソッドは、架電リスト内の_既存の_レコードのフィールドを更新し、正常に更新されたレコードの数を返します。また、このメソッドでは、_オプションの_パラメータに「 」または null を渡すことで、それらのパラメータを既定値にリセットすることができます。
\n注：架電リストのコンテンツを操作するには、ユーザーが追加の「架電リストの内容を更新する」権限を持っている必要があります。
\nこのメソッドは、リクエストの実行中に以下のエラーが発生した場合（発生した場合は）、それらを捕捉して表示します：
\nmissingKey - 1つ以上のキーフィールドの値が見つかりませんでした。keyNotFound - DNCリストに同じキーを持つレコードがすでに存在します；formatError - 1つ以上のフィールド値でフォーマットが一致していませんでした（例：整数フィールドに文字列値が定義されていた場合）；リクエスト本文に1つ以上のサポートされていないフィールドが定義されていました注：発生したエラーの種類は、そのエラーにより更新できなかったオブジェクトのリストとともに、レスポンス本文で返されます。以下の例は、記載されたすべてのエラーに対するレスポンスフォーマットを示しています。
\nこのメソッドは、Update Record メソッドと似ています。ただし、1回のリクエスト内で複数のレコードを更新できるようにするため、入力パラメータが異なります。これは、各リクエストごとに架電リスト全体を再処理する必要があるという事実を考慮して行われています。
\nこのメソッドは、架電リスト内の_既存の_レコードのフィールドを更新します。また、このメソッドでは、_オプションの_パラメータに「 」またはnullを指定することで、そのパラメータを既定値にリセットすることができます。
\n注：架電リストのコンテンツを操作するには、ユーザーに追加の「架電リストの内容を更新する」権限が必要です。
\nレコードの検索は、定義されたキーフィールドに基づいて行われます。リクエストには、リストレコードJSONオブジェクトのフィールドのすべてまたは一部を含めることができますが、キーフィールドは必須であり、リスト作成時に設定されたとおりに保持する必要があります。
\nレコードのクエリを実行する前に、一意のキー値に基づいて、指定されたリスト内にそのレコードが存在するかどうかが確認されます。指定されたリストにレコードが存在する場合、レコードの更新は成功します。
\n注：PHONEタイプのフィールドがキーとして定義されている場合、レコードの値が、データベースまたは元のソース（データベースへの読み込み時にデータが修正された場合）に保存されている値と完全に一致するかどうかがチェックされます。
\nリストの再処理にかかる時間によってキャンペーン作業に支障が生じるのを防ぐため、ダイヤラーは、そのレコードへのコールを試行するまで、レコードに加えられた変更を無視します。したがって、更新されたレコードを含むリストに フィルター や 並び替え が設定されている場合、そのレコードに加えられた変更は、そのフィルタリングや並び替えの優先順位には影響しません。
\n注：更新されたレコードに加えた変更を反映させたい場合は、必ず希望する フィルター または 並び替え 設定を再適用してください。
\nこのメソッドは、リストからレコードと、それに関連付けられたすべてのキャンペーン結果を消去します。レコードの検索は、定義されたキーフィールドに基づいて行われます。レコードが存在しない場合は、エラーが返されます。
\n注： 架電リストのコンテンツを操作するには、ユーザーに追加の「架電リストの内容を更新する」権限が必要です。
\nBright Pattern Contact Center ソリューションは、いくつかの_音声_キャンペーンモードに対応しています（こちらを参照）。_最後のレコードが削除される場合_、関連するキャンペーンのモードに応じて、アクティブなコールの挙動は次のように異なります：
\nプログレッシブ、プレディクティブ、または自動（IVR）キャンペーン
\nプレビューキャンペーン
\nそれ以外の場合、_リストにまだ他のレコードが残っている場合_、このメソッドはどのコールにも影響を与えません。
\n注： 完了したコールとその結果を含む消去されたレコードは、アーカイブされません。切断されたコールの対話結果は保存されません。
\n注： このメソッドでは、連絡先、アクティビティ、音声録音、トランスクリプト、スクリーン録画は削除されません。これらの機能については、その他の API が対応しています。
\nこのメソッドは、リストからレコードを削除します。
\n注： 架電リストのコンテンツを操作するには、ユーザーが追加の「架電リストの内容を更新する」権限を持っている必要があります。
\nリクエストを受けると、一意の id を持つ非同期ジョブが作成されます。この id は、推定完了時間とともにレスポンスで返されます。
\nこのジョブ id を使用すると、削除の進行状況を確認することができます。詳細については、「ジョブステータスの取得」メソッドの説明を参照してください。
\n注： このメソッドは、指定されたリストごとに一度に1つのレコード削除ジョブを処理します。別のジョブを開始する前に、既存のレコード削除ジョブのステータスを確認することをお勧めします。
\nレコードの検索は、関連するリストフィールドに基づいて定義された1つまたは複数の条件によって行われます。利用可能なフィルタリング条件のうち、少なくとも1つは指定する必要があります。指定がない場合、レコードは削除されません。
\nこのメソッドでは、以下の条件によるレコードのフィルタリングに対応しています：
\n関連するキャンペーンのステータス（byCampaignResult.policy パラメータで定義されています）；
作成日（createdFrom および createdTo パラメータで定義されています）；
上記の組み合わせ
\n注： フィルタリングされたレコードは、そのリストが関連付けられているすべてのキャンペーンから削除されます。
\nこのメソッドは、リストからすべてのレコードを削除します。
\n注：架電リストのコンテンツを操作するには、ユーザーが追加で「架電リストの内容を更新する」権限を持っている必要があります。
\nリクエストを受けると、一意の id を持つ非同期ジョブが作成されます。この id は、推定完了時間とともにレスポンスで返されます。
\nこのジョブ id を使用して、削除の進行状況を確認することができます。詳細については、「ジョブステータスの取得」メソッドの説明を参照してください。
\n注：このメソッドは、指定されたリストごとに一度に1つのレコード削除ジョブを処理します。別のジョブを開始する前に、既存のレコード削除ジョブのステータスを確認することをお勧めします。
\nBright Pattern コンタクトセンターソリューションは、いくつかの_音声_キャンペーンモードに対応しています（こちらを参照）。関連するキャンペーンのモードに応じて、アクティブなコールの挙動は次のように異なります：
\nプログレッシブ、プレディクティブ、または自動（IVR）キャンペーン
\nプレビューキャンペーン
\n通話完了済みの削除済みレコードのリストおよびその結果はアーカイブされ、コンタクトセンター管理者アプリケーションからダウンロード可能です（こちらを参照）。切断されたコールのインタラクション結果は保存されません。
\nこのメソッドは、Delete Many Records または Delete All Records メソッドで要求されたレコード削除ジョブのステータスを返します。このジョブは、上記のメソッドのレスポンス本文で返される一意の識別子により、path変数で参照されます。
\nレコード削除ジョブのステータスに応じて、レスポンス本文には以下のパラメータが返されます：
\ncompletion_percentage：削除対象レコード総数に対する、現在までに正常に削除されたレコード数の割合（100倍した値）
job_complete：レコード削除ジョブのステータス。具体的には、complete、processing、またはfailedのいずれかとなります
error_message: レコード削除ジョブが完了できなかった理由
job_complete= failed)deleted: 正常に削除されたレコードの合計数
job_complete= complete）Bright 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このメソッドは、DNCリストからすべてのレコードを削除し、削除されたレコードの数を返します。
\nこのメソッドは、選択済みのDNCリストからレコードのコレクションを削除し、正常に削除されたレコードの数を返します。削除対象のレコードは、_キー_フィールドの値によって指定されます。
\nさらに、このメソッドは、リクエストの実行中に以下のエラーが発生した場合、それらを捕捉して表示します：
\n![「リスト」セクション](\"https://help.brightpattern.com/File:CCA-Lists-Properties-54.PNG\"){kind=link}
missingKey - 1つ以上のキーフィールドの値が見つかりませんでした；formatError - 1つ以上のフィールド値でフォーマットが一致していませんでした（例：文字列フィールドにブール値が指定されていました）。注：発生したエラーの種類は、そのエラーのために削除できなかったオブジェクトのリストとともに、レスポンス本文で返されます。以下の例は、説明されたすべてのエラーに対するレスポンスフォーマットを示しています。
\nこのメソッドは、DNCリストに新規のレコードを追加し、追加に成功した（つまり末尾に付加された）レコードの数を返します。
\n追加するレコードは、対応するDNCリストレコードのJSONオブジェクト（こちらを参照）のフィールドによって定義されます。重複レコード、すなわちkeyフィールドの値がすでに追加済みのレコードと同一であるレコードは、無視されます。
\nさらに、このメソッドは、リクエストの実行中に以下のエラーが発生した場合、それらを捕捉して表示します：
\nmissingKey - 1つ以上のキーフィールドの値が見つかりませんでした。duplicateKey - DNCリストに同じキーを持つレコードがすでに存在しています；formatError - 1つ以上のフィールド値のフォーマットが一致していませんでした（例：整数フィールドに文字列値が定義されていた場合）；リクエスト本文に1つ以上のサポートされていないフィールドが定義されていました注：発生したエラーの種類は、そのエラーにより追加できなかったオブジェクトのリストとともに、レスポンス本文で返されます。以下の例は、説明されたすべてのエラーに対するレスポンスフォーマットを示しています。
\nこのメソッドは、DNCリストに新規のレコードを追加し、正常に追加（つまり、末尾に付加）されたレコードの数を返します。
\n注： このメソッドは、以前のリスト管理APIバージョンから引き継がれたものであり、使用は推奨されません。代わりに、機能強化された Add Many Records メソッドの使用をお勧めします。
\n追加するレコードは、対象の DNCリストのフィールドに対応する値を列挙することで定義されます。重複レコード、すなわち、すでに追加されているレコードと同じ値を持つレコードは無視されます。
\nこのメソッドは、DNCリスト内のすべてのレコードを削除し、新規レコードに置き換え、正常に追加（つまり、末尾に追加）された新規レコードの数を返します。
\n注：このメソッドは、以前のリスト管理APIバージョンから引き継がれたものであり、使用は推奨されません。代わりに、機能強化された 「すべてのレコードを削除」 および 「レコードを多数追加」 メソッドを組み合わせて使用することをお勧めします。
\n追加するレコードは、対象のDNCリストのフィールドに対応する値を列挙することで定義されます。重複レコード、すなわち、すでに追加されているレコードと同じ値を持つレコードは無視されます。
\nBright Patternのリスト管理APIを使用すると、一括削除、追加、置換などのアクションにより、DNCリスト（発信禁止リスト）のコンテンツを簡単に管理できます。このセクションで説明するAPIメソッドは、内部、地理的（郵便番号）、地理的（市外局番）、およびレコード除外 のDNCリストの種類を完全にサポートしています。地理的（州／県） のDNCリストの種類は、現在の実装ではサポートされていません。
\n注：DNCリストに対して操作を行うには、ユーザーがContact Center Administrator アプリケーションで設定された「リストの管理」権限を持っている必要があります。
\n以下で説明するすべてのメソッドでは、パス変数「do_not_call_list_id」を使用して、操作の対象となるDNCリストを指定します。DNCリストの一意の識別子は、Contact Center Administrator アプリケーションの「Do Not Call Lists」セクションで、そのDNCリストを開くことで確認できます。idは、URLの「#DNC_LISTS:DNC_PROPERTIES:」という部分に表示されます。
あるいは、do_not_call_list_id は、Get キャンペーン メソッドのレスポンス本文からも確認できます（こちら）。
このセクションで説明するAPIメソッドの機能は、必須の空にできない key フィールドとオプションの comment フィールドを持つ「DNCリストレコード」JSONオブジェクトに基づいています。DNCリストの種類に応じて、オブジェクトのフィールド値は次のように異なります：
\n注：レコードのインポートや更新を行う際は、以下の点にご注意ください：
\nBright Patternのリスト管理APIの多くのメソッドで採用されている_カーソルベースのページネーション_は、大量のデータを扱う上で、現在最先端の手法です。
\nAPIリクエストに膨大な数のレコード行が含まれると予想される場合、それらを一度にすべて返すことは現実的ではありません。その代わりに、あらかじめ定義されたサイズ（1_ページ_分）のサブセットを、一度に1ページずつ返すのが合理的です。この「_ページング_」と呼ばれる手法は、ほとんどのAPIで一般的に採用されています。当社のアプローチにおける_「カーソルベース」_という部分は、「カーソル」——つまり、最後に閲覧した場所を正確に指し示すしおりのようなもの——を使用するという考え方に由来しています。
\n_カーソルベースのページネーション_の中核には、_ポインタ_というかなり基本的な概念があります。この場合のポインタは「カーソル」と呼ばれ、データベース内の特定のレコードを参照するために使用されます。各リクエストにおいて、クライアントはcursorに加え、1ページあたりの返されるレコード数を指定するpage_sizeパラメータを渡します。
次の点に留意することが重要です：
\n![「Do Not Call Lists」セクション](\"https://help.brightpattern.com/File:Do_not_call_lists.png\"){kind=link}
cursorは、データベース内の特定の_一意の_値を参照している必要があります。cursorの値が指定されていない場合、既定ではデータベースの最初のレコードが使用されます。page_sizeで指定されたレコード数について、対応するフィールドの値がcursorの値よりも小さいレコードが返されます。page_sizeより少ない場合、それ以上のレコードが存在しないことを意味し、返されたページが最後のページとなります。page_size + 1の位置にあるレコードが、next_cursorとしてクライアントに返されます。注：このセクションでは、実行に失敗した場合の応答に関する一般的な情報をご説明します。発生したエラーに関するより具体的な情報については、各メソッドごとに記載されている「_応答コード_」の説明をご参照いただくことをお勧めします。
\nBright Patternのリスト管理APIでは、実行が成功したことを示すとともに、エラーが発生した場合はそれをフラグ付きで通知するために、標準的なHTTPコードを使用しています。このドキュメントに記載されている各エラーについて、レスポンスには以下の情報が含まれます：
\n\"bad_request\"\"'parameter_name' has unsupported value 'parameter_value': integer is expected\"また、以下のフォーマットで表示されます：
\n{ \n “error”: “name”, //error name\n “error_description”: “description” //detailed description of the reasons that led to this error\n}\n\n注：error_description のコンテンツには、デバッグに役立つ有益な情報が含まれていますので、十分にご注意いただくことを強くお勧めします。
以下の表には、HTTPエラーの完全なリストと、それぞれのエラーの考えられる根本理由が記載されています。
\n","_postman_id":"bcab04cf-1726-4372-8e7b-8d5d70f3656e"}]}