• English

cURLとターミナルを使用してBPCC REST APIをテストする

Bright Pattern Contact Center（BPCC）のREST APIをテストする必要がある場合は、cURLとお使いのコンピュータのターミナルを使用してテストを行うことができます。貴社がウェブサイトを運営している場合、同様のアクションはサーバーサイドのスクリプトを使用して行われます。Windows OSへのcURLのインストール手順は比較的簡単です。Mac OSには、既定でcURLがインストールされています。

このチュートリアルでは、BPCC リスト管理APIを使用して、既存の.CSVリストにレコードを追加し、その後、そのリストからすべてのレコードを取得します。架電リストのアップロードに関する詳細については、『管理者向けチュートリアル』のセクションリストをご参照ください。

メモ:

ターミナルは、波括弧の引用符とストレートクォート（活字上「スマートクォート」と「ダムクォート」と呼ばれます）を、まったく異なるものとして認識します。一部のワードプロセッサでは、すべての引用符が自動的にカーリークォートに変換されます。ターミナルにコードをコピーして貼り付ける際は、使用されている引用符がカーリークォートではなくストレートクォートであることを必ず確認してください。

MacのターミナルとWindowsのターミナルでリクエストを行う場合、それぞれ異なる構文が必要となります。この点について解説した参考記事があります。

手順

Bright Pattern Contact Centerのユーザーが該当するAPIへのアクセス権限を持っているかを確認してください。
ターミナルを開いてください。
1. Macをご利用の場合は、こちらの方法でターミナルを開いてください。
2. Windowsをご利用の場合は、こちらの方法でターミナルを設定してください。
Macをご利用の場合は、zshではなくbashが実行されていることを確認してください。
1. zshが実行されている場合は、こちらの方法でbashに変更してください。

「Get Access Token」によるAPI認証の取得

BPCC REST APIリクエストを行う前に、まずシステムによる認証を受ける必要があります。ほとんどのBPCC APIは認証にOAuthを使用しており、これによりユーザーには、その後の各APIリクエストのヘッダーに含める「Bearer」アクセストークンが提供されます。このために使用されるメソッドは「Get Access Token」と呼ばれます。

この方法では、クライアント認証情報を使用してクライアントを認証します。認証されたユーザーに対して、要求された操作を実行するための適切な権限があるかどうかが確認されます。権限は、Contact Center Administrator内のロールを介してユーザーに割り当てられます。

以下のコードを、メモ帳などの基本的なテキストエディタにコピーして貼り付けてください。

curl --location --request POST 'https://<tenant_URL>/configapi/v3/oauth/token' \

--header 'Content-Type: application/x-www-form-urlencoded' \

--data-urlencode 'client_id=<user_name>' \

--data-urlencode 'client_secret=<API_Secret_Generated_Code>' \

--data-urlencode 'scope=<yourcompany.brightpattern.com>' \

--data-urlencode 'grant_type=client_credentials'

下線部の内容を変更してください。
（なお、ここで提供されているデータはあくまでこの例のための架空のデータですので、ご自身の認証情報およびウェブサイトのデータに置き換える必要があります。）
例：<tenant_URL> は「server.website.com」となります。

<user_name> は「yourwebsiteadminloginname」となります。

<API_Secret_Generated_Code> は「A1B2C3D4E5F6H7I8J9K0L0M9N8P7Q6R5S4T3U2V1W0」となります。

<yourcompany.brightpattern.com> は「server.website.com」となります。

編集済みのコードをコピーしてください。
ターミナルにコードを貼り付け、「Enter」キーを押してください。
ターミナルには、次のような出力が表示されます：
access_tokenの文字列をコピーして、基本的なテキストエディタやメモ帳などのファイルに貼り付け、次の手順のために保存してください。
1. この例では、access_tokenは「A1B2C3D4E5F6H7I8J9K0L0M9N8P7Q6R5S4T3U2V1W0」です。
2. token_typeは「Bearer」です。

レコードの追加

Bearerアクセストークンを取得した後、リストAPIのレコードの追加メソッドをテストします。このメソッドは、既存の架電リストに新しいレコードを1件追加します。

以下のコードをメモ帳などの基本的なテキストエディタにコピーして貼り付け、下線が引かれた部分を変更してください。

curl --location --request POST '<tenant_URL>/configapi/v3/callinglist/add/<CSV_list_name>' \

--header 'Content-Type: application/json' \

--header 'Authorization: Bearer <access_token_number>' \

--data-raw '{

"ID": "some_number",

"firstName": "some_first_name",

"lastName": "some_last_name",

"Email": "some_email_address",

"PhoneNumber": "some_phone_number"

}'

編集したコードをコピーし、ターミナルに貼り付けて「Enter」キーを押してください。
リストがレコードを受け取れるようになったか確認するには、Contact Center Administratorアプリケーションの「リスト」セクションに移動してください。
中央のタブ「Contents」をクリックし、リストを確認してください。
1. テスト情報が投稿されていれば、成功です。
2. 投稿されていない場合は、リクエストコードを確認し、フォーマット上の誤り（例：カーリークォート）がないか見直してください。なお、返されるHTTPレスポンスコードについては、リストAPIドキュメントで説明されています。

入力したテスト情報がリストに表示されれば、成功です。代替テキスト：特定のエリアがハイライトされた、Bright Patternの「リストの内容」ページのスクリーンショット

すべてのレコードを取得する

リストAPIのさらなるテストでは、すべてのレコードを取得メソッドを使用して、既存の架電リストの内容を確認します。返されたリストのレコードは、カスタムCRMなど、他のシステムに渡すために使用できます。
さらに、返されたリストには、インデックス順に並べ替えられたJSONオブジェクトが含まれています。クエリ処理を高速化するために、最後のfromIndexを記憶しておくことをお勧めします。

以下のコードをメモ帳などの基本的なテキストエディタにコピーして貼り付け、下線部の箇所を変更してください。

curl --location --request POST 'https://<tenant_URL>/configapi/v3/callinglist/getAll/<CSV_list_name>/<campaign_name>' \

--header 'Content-Type: application/json' \

--header 'Authorization: Bearer <access_token_number>' \

--data-raw '{

"fromIndex": 0,

"maxSize": "100"

}'

編集したコードをコピーしてターミナルに貼り付け、「Enter」キーを押してください。
リクエストが成功すると、指定したリストのすべてのレコードが返されます。

< 前へ | 次へ >