APIエラー

Vonage API がエラーを返した場合、たとえばアカウントの残高がない場合など、API はRFC 7807 形式のエラーを返します。

ここでは、問題の内容、発生原因、および解決手順について基本的な説明を行います。out-of-credit の書式については、例をご覧ください。

アプリケーションでどのようなエラーに対処する必要があるかを、あらかじめ検討しておくことをお勧めします。このページでは、発生しうるすべてのエラーの一覧と、それらへの対処方法についてより詳しく説明しています。

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>"
}

10 DLC API

コード情報
brand-conflict

説明

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

決議

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

brand-parameters

説明

There are errors in the brand data submitted.

決議

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

invalid-usecase-data

説明

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

決議

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

use-case-denied

説明

The use case requested has been denied for this brand.

決議

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

vetting-conflict

説明

A conflict during the brand vetting request has occurred.

決議

If the error persists, contact support.

invalid-vetting-data

説明

There are errors in the vetting request data submitted.

決議

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

invalid-json

説明

Your request cannot be parsed.

決議

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

brand-not-qualified

説明

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

決議

Verify the brand use case qualifies before submitting the campaign.

invalid-campaign-data

説明

There are errors in the campaign data submitted.

決議

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

numbers-already-linked

説明

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

決議

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

invalid-number-data

説明

There are errors in the number data submitted.

決議

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