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.

10 DLC API

CodeInformation
brand-conflict

Description

A conflict when a brand is being created or edited and there is an issue with a 3rd party vendor.

Resolution

Ensure all required fields have values and there are no errors in those values. If the error persists, contact support.

brand-parameters

Description

There are errors in the brand data submitted.

Resolution

Ensure all required fields have values included and correct any errors to values in the specified fields.

invalid-usecase-data

Description

There are errors in the data submitted for use case qualification.

Resolution

Ensure all required fields have values included and correct any errors to values in the specified fields.

use-case-denied

Description

The use case requested has been denied for this brand.

Resolution

Ensure your use case does not require additional brand vetting or pre/post Mobile Network Operator approval.

vetting-conflict

Description

A conflict during the brand vetting request has occurred.

Resolution

If the error persists, contact support.

invalid-vetting-data

Description

There are errors in the vetting request data submitted.

Resolution

Ensure all required fields have values and correct any errors to values in the specified fields.

invalid-json

Description

Your request cannot be parsed.

Resolution

Ensure there are no invalid characters or values in your request.

brand-not-qualified

Description

A conflict when a campaign is being created under a brand that hasn't qualified for the specified use case.

Resolution

Verify the brand use case qualifies before submitting the campaign.

invalid-campaign-data

Description

There are errors in the campaign data submitted.

Resolution

Ensure all required fields have values and correct any errors to values in the specified fields.

numbers-already-linked

Description

The number you are attempting to link is already linked to another campaign.

Resolution

You must link a unique number to a campaign. Link a different number to this campaign.

invalid-number-data

Description

There are errors in the number data submitted.

Resolution

Ensure all required fields have values and correct any errors to values in the specified fields.