Wipple CPaaS
メニュー
REST API / 通話の取得

通話の取得

GEThttps://{API_ENDPOINT}/v1/Accounts/{AccountSid}/Calls/{CallSid}

認証

  • Authorization ヘッダー (ベアラートークン, 必須) — Bearer <token> 形式のベアラー認証です。token にはご自身の認証トークンを指定します。

リクエスト

パスパラメータ

  • AccountSidstring必須
  • CallSidstring必須

レスポンス

200

通話が見つかりました

  • account_sidstring必須
  • call_idstring必須
  • call_sidstring必須
  • call_statusenum必須
  • 指定可能な値: trying, ringing, alerting, in-progress, completed, busy, no-answer, failed, queued
  • directionenum必須
  • 指定可能な値: inbound, outbound
  • fromstring必須
  • service_urlstring必須
  • sip_statusinteger必須
  • tostring必須
  • application_sidstring任意
  • caller_namestring任意
  • durationinteger任意
  • originating_sip_trunk_namestring任意
  • parent_call_sidstring任意

エラー

404 Not Found Error

通話が見つかりません

  • any

500 Internal Server Error

システムエラー

  • msgstring必須

例

リクエスト

{}

レスポンス

{
  "account_sid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "call_id": "call_1234567890abcdef",
  "call_sid": "1c9e6679-7425-40de-944b-e07fc1f90ae7",
  "call_status": "in-progress",
  "direction": "inbound",
  "from": "+815099990009",
  "service_url": "https://{API_ENDPOINT}/v1/Accounts/3fa85f64-5717-4562-b3fc-2c963f66afa6/Calls/1c9e6679-7425-40de-944b-e07fc1f90ae7",
  "sip_status": 200,
  "to": "+815099990008",
  "application_sid": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "caller_name": "Miraicom Taro",
  "duration": 125,
  "originating_sip_trunk_name": "MainSIPTrunk",
  "parent_call_sid": "2a9e6679-7425-40de-944b-e07fc1f90ae7"
}

cURL

curl -X GET "https://{API_ENDPOINT}/v1/Accounts/AccountSid/Calls/CallSid" \
  -H "Authorization: Bearer <token>"

Python

import requests

url = "https://{API_ENDPOINT}/v1/Accounts/AccountSid/Calls/CallSid"

headers = {
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.json())

JavaScript

const url = 'https://{API_ENDPOINT}/v1/Accounts/AccountSid/Calls/CallSid';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}