顧客リストの取得

commubo に登録した 顧客のリストを取得します。

リクエスト

GET <ベースURL>/v1/customers
クエリ・パラメータ
expand

string

取得する顧客リストに含む詳細情報を、次のいずれかの値で指定します。
詳細情報を多く含むことで、応答が遅くなる場合があることに注意してください。
none

default

リスト中の個々の顧客情報は、customerId, familyName, personalName, phoneNumber および operatorId のみを含む operator となります。
customer
個々の顧客情報は、すべての顧客情報を含みますが、顧客情報中の operator は operatorId のみを含みます。
operator
個々の顧客情報は、customerId, familyName, personalName, phoneNumber および すべてのAIオペレータ情報を含む operator となります。
all
個々の顧客情報は、すべての顧客情報とすべてのAIオペレータ情報を含みます。
リクエスト・ヘッダ
x-commubo-tenantId

stringrequired

commubo契約時に発行される、ご契約事業者さま固有のテナントID。 「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の 「設定 / テナント」メニューから確認できます。
x-commubo-accessToken

stringrequired

commubo契約時に発行される、ご契約事業者さま固有のアクセストークン。 「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の 「設定 / テナント」メニューから確認できます。
リクエスト・ボディ
リクエスト・ボディは必要ありません。
curl コマンドにおける例
顧客リストの取得
curl -X GET \
  "https://connect.commubo.com:65536/v1/customers" \
  -H "x-commubo-tenantId: 12345678-90AB-CDEF-1234-567890ABCDEF" \
  -H "x-commubo-accessToken: FEDCBA09-8765-4321-FEDC-BA0987654321"
各顧客情報の詳細を含む顧客リストの取得
curl -X GET \
  "https://connect.commubo.com:65536/v1/customers?expand=customer" \
  -H "x-commubo-tenantId: 12345678-90AB-CDEF-1234-567890ABCDEF" \
  -H "x-commubo-accessToken: FEDCBA09-8765-4321-FEDC-BA0987654321"

※ 赤字部分はご契約事業者さまの環境に合わせ、適切なパラメータを指定してください。

レスポンス

200 OK
リクエストが成功したことを示し、顧客のリストをレスポンス・ボディで返します。
顧客が存在しない場合も、空のリストを含む 200 OK を返します。
レスポンス・ヘッダ
Content-type
application/json
レスポンス・ボディ
顧客のオブジェクトが配列形式で返ります。
[
    {
        "customerId": "0000AAAA-BBBB-CCCC-DDDD-EEEEFFFF11112222",
        "createdDateTime": "2018-09-01T13:01:23+09:00",
        "updatedDateTime": "2018-09-01T13:01:23+09:00",
        "familyName": "鈴木",
        "familyNameKana": "スズキ",
        "personalName": "一郎",
        "personalNameKana": "イチロウ",
        "middleName": "スミス",
        "middleNameKana": "スミス",
        "phoneNumbers": [
            "0330001234"
        ],
        "orgName": "エーアイ化粧品株式会社",
        "orgNameKana": "エーアイケショウヒンカブシキガイシャ",
        "orgShortName": "エーアイ化粧品",
        "orgShortNameKana": "エーアイケショウヒン",
        "deptName": "経営企画部",
        "deptNameKana": "経営企画部",
        "deptShortName": "経企",
        "deptShortNameKana": "ケイキ",
        "operator": {
            "operatorId": "11112222-3333-4444-5555-6666777788889999",
            "createdDateTime": "2018-09-01T13:01:23+09:00",
            "updatedDateTime": "2018-09-01T13:01:23+09:00",
            "operatorVoiceId": "123",
            "name": "AIオペレータのコミュボ",
            "nameKana": "エーアイオペレータノコミュボ",
            "shortName": "コミュボ",
            "shortNameKana": "コミュボ",
            "orgName": "株式会社ソフトフロントホールディングス",
            "orgNameKana": "ガイシャソフトフロントホールディングス",
            "orgShortName": "ソフトフロント",
            "orgShortNameKana": "ソフトフロント",
            "deptName": "研究開発",
            "deptNameKana": "ケンキュウカイハツ",
            "deptShortName": "R&D",
            "deptShortNameKana": "アールアンドディー"
        },
        "scenario": {
            "scenarioId": "FFFFEEEE-DDDD-CCCC-BBBB-AAAA000099998888"
        },
        "note": "あいうえお"
    }
]
customerId

string

顧客のID。
個々の顧客を識別するIDです。
createdDateTime

string

顧客を作成(登録)した日時。
リクエストのクエリ・パラメータで expand に customer または all を指定した場合以外では、この情報は含まれません。
updatedDateTime

string

顧客の情報を更新した日時。
リクエストのクエリ・パラメータで expand に customer または all を指定した場合以外では、この情報は含まれません。
familyName

string

顧客の姓の文字列。
familyNameKana

string

顧客の姓の読み仮名の文字列 (カタカナ)。
リクエストのクエリ・パラメータで expand に customer または all を指定した場合以外では、この情報は含まれません。
personalName

string

顧客の名の文字列。
personalNameKana

string

顧客の名の読み仮名の文字列 (カタカナ)。
リクエストのクエリ・パラメータで expand に customer または all を指定した場合以外では、この情報は含まれません。
middleName

string

顧客のミドルネームの文字列。
リクエストのクエリ・パラメータで expand に customer または all を指定した場合以外では、この情報は含まれません。
middleNameKana

string

顧客のミドルネームの読み仮名の文字列 (カタカナ)。
リクエストのクエリ・パラメータで expand に customer または all を指定した場合以外では、この情報は含まれません。
phoneNumbers

string array

顧客の電話番号のリスト (最大5個)。
orgName

string

顧客の組織名の文字列。
リクエストのクエリ・パラメータで expand に customer または all を指定した場合以外では、この情報は含まれません。
orgNameKana

string

顧客の組織名の読み仮名の文字列 (カタカナ)。
リクエストのクエリ・パラメータで expand に customer または all を指定した場合以外では、この情報は含まれません。
orgShortName

string

顧客の短縮組織名の文字列。
リクエストのクエリ・パラメータで expand に customer または all を指定した場合以外では、この情報は含まれません。
orgShortNameKana

string

顧客の短縮組織名の読み仮名の文字列 (カタカナ)。
リクエストのクエリ・パラメータで expand に customer または all を指定した場合以外では、この情報は含まれません。
deptName

string

顧客の部門名の文字列。
リクエストのクエリ・パラメータで expand に customer または all を指定した場合以外では、この情報は含まれません。
deptNameKana

string

顧客の部門名の読み仮名の文字列 (カタカナ)。
リクエストのクエリ・パラメータで expand に customer または all を指定した場合以外では、この情報は含まれません。
deptShortName

string

顧客の短縮部門名の文字列。
リクエストのクエリ・パラメータで expand に customer または all を指定した場合以外では、この情報は含まれません。
deptShortNameKana

string

顧客の短縮部門名の読み仮名の文字列 (カタカナ)。
リクエストのクエリ・パラメータで expand に customer または all を指定した場合以外では、この情報は含まれません。
operator

object

顧客へ発信する際に、会話するAIオペレータのオブジェクト。
顧客に対して明確にAIオペレータが指定されていない場合には、この情報(オブジェクト)は含まれません。
operatorId

string

AIオペレータのID。
個々のAIオペレータを識別するIDです。
createdDateTime

string

AIオペレータを作成(登録)した日時。
リクエストのクエリ・パラメータで expand に operator または all を指定した場合以外では、この情報は含まれません。
updatedDateTime

string

AIオペレータの情報を更新した日時。
リクエストのクエリ・パラメータで expand に operator または all を指定した場合以外では、この情報は含まれません。
operatorVocieId

integer

AIオペレータの「音声」のタイプを識別する、AIオペレータ音声のID。
IDの値は「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の 「AIオペレータ管理 / AIオペレータ音声」メニューから確認できます。
リクエストのクエリ・パラメータで expand に operator または all を指定した場合以外では、この情報は含まれません。
name

string

AIオペレータの名前の文字列。
リクエストのクエリ・パラメータで expand に operator または all を指定した場合以外では、この情報は含まれません。
nameKana

string

AIオペレータの名前の読み仮名の文字列 (カタカナ)。
リクエストのクエリ・パラメータで expand に operator または all を指定した場合以外では、この情報は含まれません。
shortName

string

AIオペレータの短縮名の文字列。
リクエストのクエリ・パラメータで expand に operator または all を指定した場合以外では、この情報は含まれません。
shortNameKana

string

AIオペレータの短縮名の読み仮名の文字列 (カタカナ)。
リクエストのクエリ・パラメータで expand に operator または all を指定した場合以外では、この情報は含まれません。
orgName

string

AIオペレータの組織名の文字列。
リクエストのクエリ・パラメータで expand に operator または all を指定した場合以外では、この情報は含まれません。
orgNameKana

string

AIオペレータの組織名の読み仮名の文字列 (カタカナ)。
リクエストのクエリ・パラメータで expand に operator または all を指定した場合以外では、この情報は含まれません。
orgShortName

string

AIオペレータの短縮組織名の文字列。
リクエストのクエリ・パラメータで expand に operator または all を指定した場合以外では、この情報は含まれません。
orgShortNameKana

string

AIオペレータの短縮組織名の読み仮名の文字列 (カタカナ)。
リクエストのクエリ・パラメータで expand に operator または all を指定した場合以外では、この情報は含まれません。
deptName

string

AIオペレータの部門名の文字列。
リクエストのクエリ・パラメータで expand に operator または all を指定した場合以外では、この情報は含まれません。
deptNameKana

string

AIオペレータの部門名の読み仮名の文字列 (カタカナ)。
リクエストのクエリ・パラメータで expand に operator または all を指定した場合以外では、この情報は含まれません。
deptShortName

string

AIオペレータの短縮部門名の文字列。
リクエストのクエリ・パラメータで expand に operator または all を指定した場合以外では、この情報は含まれません。
deptShortNameKana

string

AIオペレータの短縮部門名の読み仮名の文字列 (カタカナ)。
リクエストのクエリ・パラメータで expand に operator または all を指定した場合以外では、この情報は含まれません。
scenario

object

顧客へ発信する際に、会話するシナリオのオブジェクト。
顧客に対して明確にシナリオが指定されていない場合や、リクエストのクエリ・パラメータで expand に customer または all を指定した場合以外では、この情報(オブジェクト)は含まれません。
scenarioId

string

会話シナリオのID。
IDの値は「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の 「AIオペレータ管理 / 会話シナリオ」メニューから確認できます。
note

string

顧客の備考情報。
リクエストのクエリ・パラメータで expand に customer または all を指定した場合以外では、この情報は含まれません。

403 Forbidden
テナントID または アクセストークン が正しくないなど、アクセスが許可されないことを示します。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。

406 Not Acceptable
リクエストのクエリ・パラメータなどに誤りが含まれていることを示します。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。