curl --request POST 'https://api.voicecheap.ai/v1/actions/webhooks_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/webhooks_get', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/webhooks_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"url": "https://example.com/voicecheap-events",
"secretPrefix": "whsec_REP",
"secretSuffix": "CRET",
"createdAt": 1792065600000,
"updatedAt": 1792152000000
}
}
Webhooks
Webhook-Einstellungen abrufen
Rufen Sie die Webhook-URL Ihres Kontos, die maskierte Kennung des Signaturgeheimnisses und den Aktualisierungszeitpunkt ab. Vorhandene Signaturgeheimnisse werden niemals zurückgegeben.
POST
/
v1
/
actions
/
webhooks_get
curl --request POST 'https://api.voicecheap.ai/v1/actions/webhooks_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/webhooks_get', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/webhooks_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"url": "https://example.com/voicecheap-events",
"secretPrefix": "whsec_REP",
"secretSuffix": "CRET",
"createdAt": 1792065600000,
"updatedAt": 1792152000000
}
}
Rufen Sie die Webhook-URL Ihres Kontos, die maskierte Kennung des Signaturgeheimnisses und den Aktualisierungszeitpunkt ab. Vorhandene Signaturgeheimnisse werden niemals zurückgegeben.
Erforderliche Berechtigungen:
POST https://api.voicecheap.ai/v1/actions/webhooks_get
Authentifizierung und Berechtigungen
string
erforderlich
Senden Sie einen VoiceCheap-API-Schlüssel in diesem Header. Authorization: Bearer mit demselben API-Schlüssel wird ebenfalls unterstützt.
OAuth-Zugriffstoken werden nur von MCP akzeptiert, nicht von diesem REST-Endpunkt.
webhooks:read.
Ein aktives kostenpflichtiges Abonnement ist erforderlich. Berechtigungen ändern weder Teamrollen noch Ressourceneigentum, Medienguthaben oder Tariflimits.
Parameter
Senden Sie ein leeres JSON-Objekt. Diese Aktion hat keine Eingabefelder.Vollständiges Eingabeschema
Vollständiges Eingabeschema
Das folgende JSON Schema enthält die exakten Feldnamen, verschachtelten Typen, Standardwerte, Grenzen und akzeptierten Werte aus der Discovery. Zusätzliche feldübergreifende Regeln finden Sie in den Hinweisen zur Operation.
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Anfragebeispiele
Ersetzen Sie die beispielhaften Ressourcenkennungen und Medienschlüssel durch Werte, die für Ihr Konto zurückgegeben wurden. Behalten Sie bei Wiederholungen derselben Mutation dieselbe Anfragekennung bei.curl --request POST 'https://api.voicecheap.ai/v1/actions/webhooks_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/webhooks_get', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/webhooks_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
Antwort
Eine erfolgreiche erste Ausführung gibt HTTP 200 mit dem Ergebnis der Operation unter data zurück. Bei einer Wiederholung kann stattdessen der gespeicherte Anfragestatus zurückgegeben werden. Das Beispiel zeigt eine unterstützte Antwort, nicht alle optionalen Felder. Gibt die öffentlichen Webhook-Einstellungen des Kontos zurück oder null, wenn keine Webhook-Konfiguration existiert.{
"data": {
"url": "https://example.com/voicecheap-events",
"secretPrefix": "whsec_REP",
"secretSuffix": "CRET",
"createdAt": 1792065600000,
"updatedAt": 1792152000000
}
}
Ergebnisfelder
| Feld | Beschreibung |
|---|---|
data.url | Gespeichertes Webhook-Ziel; eine leere Zeichenfolge, wenn ein Geheimnis existiert, aber keine URL konfiguriert ist. |
data.secretPrefix | Sichtbarer Anfang des Signaturgeheimnisses. |
data.secretSuffix | Sichtbares Ende des Signaturgeheimnisses. |
data.createdAt | Erstellungszeitstempel der Webhook-Konfiguration in Millisekunden. |
data.updatedAt | Zeitstempel der letzten Aktualisierung der Webhook-Konfiguration in Millisekunden. |
Hinweise zur Operation
- Vorhandene Signaturgeheimnisse werden von dieser Aktion niemals zurückgegeben.
- Die Webhook-Konfiguration gehört dem authentifizierten persönlichen Konto.
Nutzung
Jeder erfolgreiche Aufruf verbraucht einen monatlichen API/MCP-Aufruf. Zusätzlich gelten das Medienguthaben und die eigenen Generierungskontingente der Operation.Fehler
| HTTP-Status | Code | Bedeutung oder Behebung |
|---|---|---|
| 400 | BAD_REQUEST | Das authentifizierte Konto konnte nicht gefunden werden. |
| 400 | CREDENTIAL_IN_QUERY | Zugangsdaten wurden in einem Abfrageparameter namens access_token oder api_key übergeben. Senden Sie Zugangsdaten in Headern. |
| 400 | VALIDATION_ERROR | Das JSON-Objekt enthält ein nicht unterstütztes Feld, einen ungültigen Wert oder ein fehlendes erforderliches Argument. |
| 401 | API_KEY_EXPIRED | Der API-Schlüssel ist abgelaufen. |
| 401 | INVALID_API_KEY | Geben Sie einen gültigen, nicht abgelaufenen API-Schlüssel an. |
| 401 | INVALID_CREDENTIAL | Der Authorization-Header ist fehlerhaft oder steht im Konflikt mit x-api-key. |
| 401 | MISSING_CREDENTIAL | Es wurde kein nutzbarer Berechtigungsnachweis im Header übergeben, oder er überschritt 4096 Zeichen. |
| 401 | USER_NOT_FOUND | Das Konto des Zugangsnachweises existiert nicht mehr. |
| 403 | AMBIGUOUS_TEAM_API_KEY | Der Benutzer des Berechtigungsnachweises gehört mehr als einem Team an, weshalb der Abrechnungskontext nicht eindeutig ist. |
| 403 | INSUFFICIENT_SCOPE | Erteilen Sie alle erforderlichen Berechtigungen oder verwenden Sie andere Zugangsdaten. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Die Integrationslimits des Kontos konnten nicht verifiziert werden. |
| 403 | SUBSCRIPTION_REQUIRED | Verwenden Sie ein aktives kostenpflichtiges Abonnement. |
| 403 | TEAM_OWNER_NOT_FOUND | Das maßgebliche Konto des Teaminhabers wurde nicht gefunden. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Warten Sie auf die monatliche Zurücksetzung oder wechseln Sie den Tarif. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Warten Sie gegebenenfalls die in Retry-After angegebene Zeit und verwenden Sie zunehmend längere Warteintervalle. |
| 500 | INTERNAL_ERROR | Prüfen Sie den Status der gespeicherten Anfrage und den Ressourcenverlauf, bevor Sie eine Mutation erneut versuchen. |
| 503 | SERVER_RESTARTING | Der Server wird neu gestartet. Versuchen Sie es in Kürze erneut und behalten Sie bei einer Mutation dieselbe Anfragekennung bei. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["webhooks:read"]
}
}
War diese Seite hilfreich?