REST API - localizable

vapi std: localizable message

The localizable_message structure represents a localizable string or message template. Services include one or more localizable message templates in the errors they report so that clients can display diagnostic messages in the native language of the user. Services can include localizable strings in the data returned from operations to allow clients to display localized status information in the native language of the user.

Representation:

JSON

{
    "args": [
        "string",
        "string"
    ],
    "default_message": "string",
    "id": "string"
}

Attributes:

Name	Type	Description
Required
id	string	Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
default_message	string	The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
args	string[]	Arguments to be substituted into a message template.