API Errors

When a Vonage API returns an error, for instance, if your account has no credit, the API will return an error in RFC 7807 format.

This provides a basic explanation of what the issue is, why it occurred and steps to resolve it. Check out the example to see how an out-of-credit is formatted.

You'll likely want to consider up-front what errors your application will need to handle, this page provides a list of all the possible errors that could occur with a more detailed explanation of how they can be addressed.

HTTP/1.1 403 Forbidden
Content-Type: application/problem+json
Content-Language: en
{
  "type": "https://example.com/Error#out-of-credit",
  "title": "You do not have enough credit",
  "detail": "Your current balance is 30, but that costs 50.",
  "instance": "<trace_id>"
}

Subaccount API

Code	Information	Actions
`validation`	Description The request failed due to validation errors Resolution See the `detail` (and, if present, the `invalid_parameters`) fields for the exact reason this request was rejected and review the documentation.
`invalid-transfers`	Description Invalid transfer Resolution See the `detail` field for the reason this transfer is invalid.
`provisioning`	Description Maximum number of sub-accounts reached Resolution If you need more subaccounts, contact Vonage Support.
`internal-error`	Description An error has occurred in the platform while processing this request Resolution If the error persists, contact Vonage Support.
`invalid-number-transfer`	Description Failed to perform transfer number from source account to destination account Resolution See the `detail` field for the reason this transfer is invalid.
`missing-number-transfer`	Description Could not transfer number from source account to destination account - ShortCode not found Resolution See the `detail` field for the reason this transfer is invalid.
`transfer-conflict`	Description Could not transfer number from source account to destination account - ShortCode is already owned by requesting account Resolution See the `detail` field for the reason this transfer is invalid.