KAkarte
CallInfo

Get call info

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

Required Scope

APIの実行に必要なScopeです。

beta.speak.callInfo.get

Required Role

管理画面でScopeを追加する際に必要な権限です。

Speak > Speakの閲覧
post/v2beta/speak/callInfo/get

Request

  • Base URL
    https://api.karte.io
  • URL
    https://api.karte.io/v2beta/speak/callInfo/get
  • Auth
    HTTP bearer

Headers

x-karte-apistring

今後利用する可能性のある予約語です。現在は設定不要です。

authorizationstring

認証情報を含むトークンです。"Authorization" ヘッダーに Bearer <token> の形式で設定してください。

content-typestring

リクエストのコンテンツタイプを指定します。通常は application/json を使用してください。

Request body

tokenstring required

Voicebot側で発行した、コールを特定するための識別番号(RightConnectの問い合わせ番号とは別ですのでご注意ください)

Example request

{
  "token": "1234"
}

Response

A successful response.

successboolean required

リクエストが成功したかどうか

callIdstring

Voicebot側で付与された、コールのID

userNumstring

架電元ユーザーの電話番号

assignmentCodestring nullable

フローで付与された窓口振り分けコード(もしあれば)

errCodestring

Example response

{
  "success": true,
  "callId": "xxxxxxxxx",
  "userNum": "xxxxxxxxx",
  "assignmentCode": "1",
  "errCode": "callInfoNotFound"
}

Changes

No recorded changes to this operation across all 1 revision of this API.