View all errors
API Errors
When a Nexmo 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>"
}
WhatsApp Provisioning
Error ID | Information | Actions |
---|---|---|
number-in-use |
Details:
Cannot use number because it's already in use by another deployment. Resolution:Use the existing deployment. |
|
invalid-json |
Details:
The request body did not contain valid JSON Resolution:Send a JSON request body, including a Content-Type header of application/json |
|
unprocessable |
Details:
Parameters were valid JSON but something was missing or wrongly formatted Resolution:Fix the incorrect request parameters and try again |
|
unprocessable-profile-update |
Details:
Parameters were valid JSON but something was missing or wrongly formatted Resolution:Fix the incorrect request parameters and try again |
|
throttled |
Details:
Too many requests have been made on this endpoint Resolution:Wait a moment and try again |
|
verification-failed |
Details:
Verification step failed. Either because the the provided code was incorrect or because too many attempts have been made Resolution:Try again with the correct OTP, or call resend-otp |
|
conflict-deployment-state |
Details:
Deployment could not be modified because it is currently in a transitional state. Resolution:If the deployment is transitioning into the state you want it in no action is required. If the state is |
|
conflict-resend-otp |
Details:
Could not resend OTP because the current state of the deployment did not allow it Resolution:The deployment has either already finished, or is in an error state (in which case you should delete it and run it again). |