Markdownで表示

WebhooksList

GET/v2/whks/list
ベース URL
https://us1.proctorapi.com
利用可能なリージョン10 リージョン
Webhook リストリクエストにより、ユーザーはアクティブな Webhook サブスクリプションの概要、または "?type=available" クエリパラメータが指定された場合は利用可能な Webhook のリストを取得できます。

クエリパラメータ

type
string
オプションパラメータ。値 'available'

レスポンス

200application/json

成功を示し、サブスクリプション済みの Webhook リスト、または ?type=available クエリパラメータが指定された場合は利用可能な Webhook リストを返します。

400application/json

不正なリクエストを示します。

401application/json

未承認のレスポンスを示します。

2154 - アカウントが有効ではありません。

2155 - リージョンが正しくありません。

2655 - api_key が無効です。

GET/v2/whks/list
curl --request GET \
  --url https://us1.proctorapi.com/v2/whks/list \
  --header 'api_key: $API_KEY'
import requests

url = "https://us1.proctorapi.com/v2/whks/list"

headers = {"api_key": "$API_KEY"}

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

print(response.json())
const fetch = require('node-fetch');

const url = 'https://us1.proctorapi.com/v2/whks/list';
const options = {method: 'GET', headers: {api_key: '$API_KEY'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://us1.proctorapi.com/v2/whks/list"),
    Headers =
    {
        { "api_key", "$API_KEY" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}