Das OpenAPI-Dokument der Aktionen abrufen

GET https://api.voicecheap.ai/v1/openapi.json

​

Authentifizierung

​

Anfragebeispiele

curl --request GET 'https://api.voicecheap.ai/v1/openapi.json'

const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/openapi.json', {
  method: 'GET',
  headers: {},
  redirect: 'manual',
});
console.log(response.status, await response.text());

import os
import requests

response = requests.request(
    "GET",
    "https://api.voicecheap.ai/v1/openapi.json",
    headers={},
    timeout=120,
    allow_redirects=False,
)
print(response.status_code, response.text)

​

Antwort

{
  "openapi": "3.1.0",
  "info": {
    "title": "VoiceCheap API",
    "version": "1.0.0",
    "description": "Public customer actions shared with the VoiceCheap MCP. Existing multipart v1 routes remain documented separately."
  },
  "servers": [
    {
      "url": "https://api.voicecheap.ai/v1"
    }
  ],
  "security": [
    {
      "ApiKey": []
    },
    {
      "BearerApiKey": []
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key"
      },
      "BearerApiKey": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "VoiceCheap API key"
      }
    }
  }
}

​

Hinweise zur Operation

• Die zurückgegebene servers[0].url enthält /v1. Aktionspfade im Dokument beginnen mit /actions/, fügen Sie /v1 daher nicht ein zweites Mal hinzu.
• Dies ist der vollständige ungefilterte Aktionskatalog. Ermitteln Sie mit einem authentifizierten GET /v1/actions, welche Aktionen ein bestimmter Berechtigungsnachweis verwenden darf.
• Das zur Laufzeit bereitgestellte OpenAPI-Dokument deckt nur die Aktionsausführung ab; es enthält weder OAuth-Routen noch /mcp, Discovery selbst oder die bestehenden Multipart-Routen.
• Dieser Lesezugriff verbraucht weder einen monatlichen Integrationsaufruf noch den Integrationsratenzähler des Kontos. Die öffentlichen HTTP-Schutzmechanismen des Dienstes gelten weiterhin.
• Die Beispiele verwenden Produktions-Origins. Lesen Sie die Metadaten aus der ausgewählten Umgebung, um Produktion und Entwicklung nicht zu vermischen.