@dialstack/sdk-dev / js/src / PhoneNumberOrderErrorEvent
Interface: PhoneNumberOrderErrorEvent
Defined in: sdk/js/src/types/phone-number-ordering.ts:49
Passed to the ordering component's onOrderError callback, for an order the
API refused or the carrier could not fulfill.
Properties
code?
optional code?: string;
Defined in: sdk/js/src/types/phone-number-ordering.ts:65
The API's stable error code when it sent one, such as
phone_number_limit_exceeded or phone_numbers_already_claimed.
details?
optional details?: Record<string, unknown>;
Defined in: sdk/js/src/types/phone-number-ordering.ts:69
The API's details for the code, when it sent any.
error
error: string;
Defined in: sdk/js/src/types/phone-number-ordering.ts:54
What went wrong, in the component's locale: the same text the component shows, so it is safe to display.
message?
optional message?: string;
Defined in: sdk/js/src/types/phone-number-ordering.ts:60
The underlying error text: the API's message for a refused order, or the carrier's reason for a failed one. For logs, not for display: it is in English and may be technical.
order?
optional order?: NumberOrder;
Defined in: sdk/js/src/types/phone-number-ordering.ts:71
The order, when it was placed and then failed.
status?
optional status?: number;
Defined in: sdk/js/src/types/phone-number-ordering.ts:67
HTTP status of the rejected request. Absent when a placed order failed.