curl --request POST 'https://api.voicecheap.ai/v1/actions/webhooks_update' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","url":"https://example.com/voicecheap-events"}'
const input = {
requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
url: 'https://example.com/voicecheap-events',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/webhooks_update', {
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_update",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "url": "https://example.com/voicecheap-events"},
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
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
{
"data": {
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
"operation": "webhooks_update",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
{
"data": {
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
"operation": "webhooks_update",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
Webhooks
Webhook-URL bijwerken
Stel voor je persoonlijke account een openbaar HTTPS-webhookendpoint op poort 443 in. Toekomstige webhookgebeurtenissen worden naar dit endpoint verstuurd. Configureer een ondertekeningsgeheim in de accountinstellingen voordat je een URL instelt. Privénetwerkadressen en redirects worden niet ondersteund.
POST
/
v1
/
actions
/
webhooks_update
curl --request POST 'https://api.voicecheap.ai/v1/actions/webhooks_update' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","url":"https://example.com/voicecheap-events"}'
const input = {
requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
url: 'https://example.com/voicecheap-events',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/webhooks_update', {
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_update",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "url": "https://example.com/voicecheap-events"},
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
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
{
"data": {
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
"operation": "webhooks_update",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
{
"data": {
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
"operation": "webhooks_update",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
Stel voor je persoonlijke account een openbaar HTTPS-webhookendpoint op poort 443 in. Toekomstige webhookgebeurtenissen worden naar dit endpoint verstuurd. Configureer een ondertekeningsgeheim in de accountinstellingen voordat je een URL instelt. Privénetwerkadressen en redirects worden niet ondersteund.
Vereiste machtigingen:
POST https://api.voicecheap.ai/v1/actions/webhooks_update
Authenticatie en machtigingen
string
vereist
Stuur een VoiceCheap API-sleutel mee in deze header. Authorization: Bearer met dezelfde API-sleutel wordt ook ondersteund. OAuth-toegangstokens
worden alleen door MCP geaccepteerd, niet door dit REST-endpoint.
webhooks:write.
Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.
Parameters
string
Optioneel op transportniveau: als de identificatie ontbreekt, voegt de server deze vóór de validatie toe. Geef zelf een stabiele UUID v4 op om veilig te kunnen herstellen als een antwoord verloren gaat.Formaat: “uuid”. Patroon:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.string
vereist
Tekstwaarde.Maximale lengte: 2048. Formaat: “uri”.
Volledig invoerschema
Volledig invoerschema
Het onderstaande JSON Schema behoudt de exacte veldnamen, geneste typen, standaardwaarden, grenzen en toegestane waarden die discovery beschikbaar stelt. Aanvullende regels tussen velden staan in de opmerkingen bij de bewerking.
{
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries."
},
"url": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": ["url"],
"additionalProperties": false
}
Idempotentie
Gebruik voor elke wijziging een UUID v4 in requestId of de HTTP-header Idempotency-Key. Gebruik na een netwerkfout dezelfde identificatie en identieke argumenten opnieuw. Als je beide opgeeft, moeten ze overeenkomen. Het opnieuw versturen van een opgeslagen aanvraag herhaalt de bewerking niet en verbruikt geen extra maandelijkse aanroep. Mislukte of onderbroken aanvragen worden niet automatisch opnieuw gestart. Elke wijziging kan HTTP 202 retourneren wanneer een nieuwe poging vaststelt dat dezelfde aanvraag nog loopt, ook wanneer de eerste uitvoering normaal synchroon is. Als de uitvoering is voltooid maar resultStored false is, retourneert een nieuwe poging HTTP 200 met de opgeslagen aanvraagstatus in plaats van het oorspronkelijke resultaat. Haal de uitvoer op via de geschiedenis-, resultaat- of downloadactie van het betreffende domein.Voorbeeldaanvragen
Vervang de voorbeeldidentificaties van resources en mediasleutels door waarden die voor je account zijn geretourneerd. Behoud dezelfde aanvraagidentificatie wanneer je dezelfde wijziging opnieuw probeert.curl --request POST 'https://api.voicecheap.ai/v1/actions/webhooks_update' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","url":"https://example.com/voicecheap-events"}'
const input = {
requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
url: 'https://example.com/voicecheap-events',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/webhooks_update', {
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_update",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "url": "https://example.com/voicecheap-events"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
Antwoord
Een geslaagde eerste uitvoering retourneert HTTP 200 met het resultaat van de bewerking onder data. Een herhaalde aanvraag kan in plaats daarvan de opgeslagen aanvraagstatus retourneren. Het voorbeeld toont één ondersteund antwoord, niet alle optionele velden. Retourneert de openbare webhookinstellingen na het opslaan van de bestemmings-URL.{
"data": {
"url": "https://example.com/voicecheap-events",
"secretPrefix": "whsec_REP",
"secretSuffix": "CRET",
"createdAt": 1792065600000,
"updatedAt": 1792152000000
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
{
"data": {
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
"operation": "webhooks_update",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
{
"data": {
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
"operation": "webhooks_update",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
Resultaatvelden
| Veld | Beschrijving |
|---|---|
data.url | Opgeslagen webhookbestemming; een lege tekenreeks wanneer er wel een geheim bestaat maar geen URL is geconfigureerd. |
data.secretPrefix | Zichtbaar begin van het geheim voor ondertekening. |
data.secretSuffix | Zichtbaar uiteinde van het ondertekeningsgeheim. |
data.createdAt | Aanmaaktijdstip van de webhookconfiguratie in milliseconden. |
data.updatedAt | Tijdstempel van de meest recente update van de webhookconfiguratie in milliseconden. |
Deze aanvraag herstellen en controleren
Gebruik dezelfde identificatie, ook nadat de verbinding is verbroken. Als resultStored false is, haal je de uitvoer op via de bijbehorende geschiedenis-, resultaat- of downloadactie. Start nooit een tweede generatie alleen om de voortgang te controleren.curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","operation":"webhooks_update"}'
HTTP 200
{
"data": {
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
"operation": "webhooks_update",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"url": "https://example.com/voicecheap-events",
"secretPrefix": "whsec_REP",
"secretSuffix": "CRET",
"createdAt": 1792065600000,
"updatedAt": 1792152000000
}
}
}
Opmerkingen bij de bewerking
- Maak een geheim voor ondertekening aan voordat je de URL instelt.
- De URL moet openbare HTTPS op poort 443 gebruiken, maximaal 2,048 tekens bevatten en geen inloggegevens of fragment bevatten. Privé- of gereserveerde adressen en privé-DNS-antwoorden worden geweigerd.
- Omleidingen vanaf de bestemming worden niet ondersteund. Het geheim voor ondertekening blijft gemaskeerd.
Verbruik
Elke geslaagde aanroep verbruikt één maandelijkse API/MCP-aanroep. Ook het mediategoed en de eigen generatielimieten van de bewerking zijn van toepassing.Fouten
| HTTP-status | Code | Betekenis of herstel |
|---|---|---|
| 400 | BAD_REQUEST | Het account is niet gevonden, of er bestaat nog geen ondertekeningsgeheim. |
| 400 | CREDENTIAL_IN_QUERY | Inloggegevens zijn opgegeven in een queryparameter access_token of api_key. Stuur inloggegevens in headers. |
| 400 | IDEMPOTENCY_CONFLICT | De header Idempotency-Key en het bodyveld requestId moeten overeenkomen. |
| 400 | INVALID_REQUEST_ID | Geef een UUID v4 op als requestId of Idempotency-Key. |
| 400 | UNSAFE_WEBHOOK_URL | De bestemming is onveilig, kan niet worden omgezet naar een adres of wordt omgezet naar een privé- of gereserveerd netwerkadres. |
| 400 | VALIDATION_ERROR | Het JSON-object bevat een niet-ondersteund veld, een ongeldige waarde of een ontbrekend verplicht argument. |
| 401 | API_KEY_EXPIRED | De API-sleutel is verlopen. |
| 401 | INVALID_API_KEY | Geef een geldige, niet-verlopen API-sleutel op. |
| 401 | INVALID_CREDENTIAL | De Authorization-header heeft een ongeldige indeling of is in strijd met x-api-key. |
| 401 | MISSING_CREDENTIAL | Er is geen bruikbaar authenticatiemiddel in de header opgegeven, of het overschreed 4096 tekens. |
| 401 | USER_NOT_FOUND | Het account dat bij de toegangsgegevens hoort, bestaat niet meer. |
| 403 | ACCOUNT_UNAVAILABLE | Het uitvoerende of factureringsaccount is niet beschikbaar of wordt verwijderd. |
| 403 | AMBIGUOUS_TEAM_API_KEY | De gebruiker van het authenticatiemiddel behoort tot meer dan één team, waardoor de factureringscontext onduidelijk is. |
| 403 | INSUFFICIENT_SCOPE | Verleen alle vereiste machtigingen of kies andere toegangsgegevens. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | De integratielimieten van het account konden niet worden geverifieerd. |
| 403 | SUBSCRIPTION_REQUIRED | Gebruik een actief betaald abonnement. |
| 403 | TEAM_OWNER_NOT_FOUND | Het effectieve account van de teameigenaar kon niet worden gevonden. |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | Voor dit account worden al 10 integratieacties uitgevoerd. Controleer een bestaande aanvraag voordat je een nieuwe start. |
| 409 | IDEMPOTENCY_CONFLICT | Gebruik een identificatie alleen opnieuw met dezelfde bewerking en argumenten. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Wacht tot de maandelijkse reset of wijzig je abonnement. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Wacht de tijd uit Retry-After af wanneer deze aanwezig is en vergroot de wachttijd tussen nieuwe pogingen. |
| 500 | INTERNAL_ERROR | Controleer de opgeslagen aanvraagstatus en de resourcegeschiedenis voordat je besluit een wijziging opnieuw te proberen. |
| 503 | ACTION_RESULT_UNAVAILABLE | De actie is uitgevoerd, maar het resultaat kon niet worden opgeslagen. Controleer de opgeslagen aanvraagstatus en resourcegeschiedenis voordat je een nieuwe generatie start. |
| 503 | SERVER_RESTARTING | De server wordt opnieuw gestart. Probeer het zo opnieuw en behoud bij een wijziging dezelfde aanvraagidentificatie. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["webhooks:write"]
}
}
Was deze pagina nuttig?

