• English

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

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

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

メモ：

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

MacのターミナルとWindowsのターミナルでリクエストを行う場合、それぞれ異なる構文が必須となります。以下に参考記事

手順

Bright Pattern Contact Centerのユーザーが適切なAPIへのアクセス権限を持っているか
ターミナルを開いてください。
1. Macをご利用の場合は、こちらようにしてターミナルを開いてください。
2. Windowsが実行中の場合は、こちらがターミナルの設定方法です
3. ターミナルを開いてください
  1. Mac ようにターミナルを設定してください
4. Macをご利用の場合は、ターミナルが実行中であることを確認してください。 bash が実行中であることを必ずご確認ください。
  1. zsh が実行中の場合は、こちら bashに変更する方法です。
「Get Access Token」による API 認証の取得

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

この方法では、クライアントの認証にクライアント認証情報を使用します。認証されたユーザーに対して、要求された操作を実行するための適切な権限があるかどうかが確認されます。権限は、Contact Center Administrator 内の役割経由でユーザーに割り当てられます。
1. 以下のコードを、メモ帳などの基本的なテキストエディタにコピーして貼り付けてください。
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シークレット>' \

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

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

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

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

Bearer アクセストークンを取得した後、リスト API のをテストします。レコードの追加メソッドをテストします。このメソッドは、既存の架電リストに新しいレコードを 1 件追加します。
1. 以下のコードをメモ帳などの基本的なテキストエディタにコピーして貼り付け、下線が引かれた部分を変更してください。
curl --location --request POST '<tenant_URL>/configapi/v3/callinglist/追加/<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"

}'

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

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

リスト API のさらなるテストには、を使用しますすべてのレコードを取得メソッドを使用して、既存の架電リストの内容を確認します。返されたリストのレコードは、カスタムCRMなどのその他システムに渡すために使用できます。
さらに、返されたリストには、インデックス順に並び替えられたJSONオブジェクトが含まれています。最後の fromIndex を覚えておくことをお勧めします。これにより、システムへのクエリ処理を高速化できます。
1. 以下のコードをメモ帳などの基本的なテキストエディタにコピーして貼り付け、下線部の箇所を変更してください。
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"

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

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

手順

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

レコードの追加

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