QANT API (1.0.0)

QANT API リファレンスドキュメントです。

ドメイン

ドメインは https://api.qant.jp です。

Host ヘッダ

Host ヘッダに api.qant.jp を指定してください。

認証

アクセストークンの取得

header Parameters
content-type
required
string
Enum: "application/json" "application/x-www-form-urlencoded"
Request Body schema:
required
grant_type
required
string
Value: "client_credentials"

Grant Type

client_id
required
string non-empty

サービスアカウントの ID

client_secret
required
string non-empty

サービスアカウントのシークレット

Responses

Request samples

Content type
{
  • "grant_type": "client_credentials",
  • "client_id": "string",
  • "client_secret": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 0
}

VoC

CSV から VoC ソースをインポートします。

リクエスト数制限: 10回/分

制限値の引上げをご希望の場合は担当までご連絡ください。

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJSUzI1NiIs...

Bearer {token} 形式。トークン取得 API で発行したトークンを利用。

Request Body schema: multipart/form-data
required
file
required
object

取り込む CSV ファイル

importFormatId
required
string non-empty

取り込む CSV のフォーマット ID

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": { }
}

JSON から VoC ソースをインポートします。

リクエスト数制限: 60回/分

制限値の引上げをご希望の場合は担当までご連絡ください。

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJSUzI1NiIs...

Bearer {token} 形式。トークン取得 API で発行したトークンを利用。

Request Body schema: application/json
required
importFormatId
required
string non-empty

取り込む JSON のフォーマット ID

sources
required
Array of objects

取り込む JSON データの配列(QANT VoC の管理画面を参照)

Responses

Request samples

Content type
application/json
{
  • "importFormatId": "string",
  • "sources": [
    ]
}

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": { }
}

Speak

QANT Speakのコール情報を取得します。

リクエスト数制限: 60回/分

月間リクエスト数制限: 10000回/月

制限値の引上げをご希望の場合は担当までご連絡ください。

header Parameters
content-type
required
string
Value: "application/json"
Authorization
required
string
Example: Bearer eyJhbGciOiJSUzI1NiIs...

Bearer {token} 形式。トークン取得 API で発行したトークンを利用。

Request Body schema: application/json
required
token
required
string

QANT Speak側で発行した、コールを特定するための識別番号(QANT コネクトの問い合わせ番号とは異なります)

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "callId": "string",
  • "userNum": "string",
  • "assignmentCode": "string",
  • "errCode": "callInfoNotFound"
}

応対ログを検索します。

リクエスト数制限: 60回/分

月間リクエスト数制限: 10000回/月

制限値の引上げをご希望の場合は担当までご連絡ください。

header Parameters
content-type
required
string
Value: "application/json"
Authorization
required
string
Example: Bearer eyJhbGciOiJSUzI1NiIs...

Bearer {token} 形式。トークン取得 API で発行したトークンを利用。

Request Body schema: application/json
required
size
required
integer [ 1 .. 100 ]

取得する応対ログの件数(最大100件)

userNum
string [ 1 .. 15 ] characters

ユーザー電話番号

userNumDuringCall
string [ 1 .. 15 ] characters

ボイスボットの通話中で取得した電話番号

object

前ページ最後の応対ID。カーソルページネーションとして利用します。(2ページ目以降で指定)

object

日付範囲(ミリ秒タイムスタンプ)

object

時刻範囲(JST 0時からの分数、0-1439)

phoneIds
Array of strings

ダイヤルIDの配列(OR条件)

flowIds
Array of strings

フローIDの配列(OR条件)

statusIds
Array of strings

ステータスIDの配列(OR条件)

callIds
Array of strings

応対ログIDの配列(OR条件)

variableKeys
Array of strings

レスポンスのvariablesに含めるキーの配列。指定しない場合はすべてのキーを返します。

onlyOngoing
boolean

通話中のもののみ取得するかどうか(デフォルト: false)

Responses

Request samples

Content type
application/json
{
  • "size": 1,
  • "userNum": "string",
  • "userNumDuringCall": "string",
  • "cursor": {
    },
  • "dateRange": {
    },
  • "timeRange": {
    },
  • "phoneIds": [
    ],
  • "flowIds": [
    ],
  • "statusIds": [
    ],
  • "callIds": [
    ],
  • "variableKeys": [
    ],
  • "onlyOngoing": true
}

Response samples

Content type
application/json
{
  • "logs": [
    ],
  • "meta": {
    }
}

通話フローで利用できる変数を取得します。

リクエスト数制限: 60回/分

月間リクエスト数制限: 10000回/月

制限値の引上げをご希望の場合は担当までご連絡ください。

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJSUzI1NiIs...

Bearer {token} 形式。トークン取得 API で発行したトークンを利用。

Request Body schema: application/json
required
flowId
required
string non-empty

通話フローID

Responses

Request samples

Content type
application/json
{
  • "flowId": "string"
}

Response samples

Content type
application/json
{
  • "variables": [
    ]
}