Skip to content

NotifyTemplateInformation

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/notify_template_information.py
class NotifyTemplateInformation(TypedDict, closed=True):
    template_id: "capo_pinpoint_sms_voice_v2.types.notify_template_id.NotifyTemplateId"
    """<p>The unique identifier for the template.</p>"""
    version: (
        "capo_pinpoint_sms_voice_v2.types.notify_template_version.NotifyTemplateVersion"
    )
    """<p>The version of the template.</p>"""
    template_type: (
        "capo_pinpoint_sms_voice_v2.types.notify_template_type.NotifyTemplateType"
    )
    """<p>The type of the template.</p>"""
    channels: (
        "capo_pinpoint_sms_voice_v2.types.number_capability_list.NumberCapabilityList"
    )
    """<p>The channels for the template. Supported values are <code>SMS</code> and <code>VOICE</code>.</p>"""
    tier_access: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.notify_configuration_tier_list.NotifyConfigurationTierList"
    ]
    """<p>The tier access level for the template.</p>"""
    status: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.notify_template_status.NotifyTemplateStatus"
    ]
    """<p>The current status of the template.</p>"""
    supported_countries: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.iso_country_code_list.IsoCountryCodeList"
    ]
    """<p>An array of supported country codes for the template.</p>"""
    language_code: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.notify_language_code.NotifyLanguageCode"
    ]
    """<p>The language code for the template.</p>"""
    content: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.template_content.TemplateContent"
    ]
    """<p>The content of the template.</p>"""
    variables: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.template_variables_map.TemplateVariablesMap"
    ]
    """<p>An array of template variable metadata for the template.</p>"""
    supported_voice_ids: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.voice_id_list.VoiceIdList"
    ]
    """<p>An array of supported voice IDs for voice templates.</p>"""
    created_timestamp: "datetime.datetime"
    """<p>The time when the notify template was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>"""

channels instance-attribute

The channels for the template. Supported values are SMS and VOICE.

content instance-attribute

content: NotRequired[TemplateContent]

The content of the template.

created_timestamp instance-attribute

created_timestamp: datetime

The time when the notify template was created, in UNIX epoch time format.

language_code instance-attribute

language_code: NotRequired[NotifyLanguageCode]

The language code for the template.

status instance-attribute

status: NotRequired[NotifyTemplateStatus]

The current status of the template.

supported_countries instance-attribute

supported_countries: NotRequired[IsoCountryCodeList]

An array of supported country codes for the template.

supported_voice_ids instance-attribute

supported_voice_ids: NotRequired[VoiceIdList]

An array of supported voice IDs for voice templates.

template_id instance-attribute

template_id: NotifyTemplateId

The unique identifier for the template.

template_type instance-attribute

template_type: NotifyTemplateType

The type of the template.

tier_access instance-attribute

tier_access: NotRequired[NotifyConfigurationTierList]

The tier access level for the template.

variables instance-attribute

variables: NotRequired[TemplateVariablesMap]

An array of template variable metadata for the template.

version instance-attribute

The version of the template.