from typing import Dict, Optional
from datetime import datetime
from pydantic import (
Field,
StrictBool,
StrictStr,
conlist,
StrictInt,
)
from sinch.domains.sms.models.v1.types.delivery_report_type import (
DeliveryReportType,
)
from sinch.domains.sms.models.v1.internal.base import (
BaseModelConfigurationRequest,
)
[docs]
class TextRequest(BaseModelConfigurationRequest):
to: conlist(StrictStr) = Field(
default=...,
description="List of Phone numbers and group IDs that will receive the batch. [More info](https://community.sinch.com/t5/Glossary/MSISDN/ta-p/7628)",
)
from_: Optional[StrictStr] = Field(
default=None,
alias="from",
description="Sender number. Must be valid phone number, short code or alphanumeric. Required if Automatic Default Originator not configured.",
)
parameters: Optional[Dict[StrictStr, Dict[StrictStr, StrictStr]]] = Field(
default=None,
description="Contains the parameters that will be used for customizing the message for each recipient. [Click here to learn more about parameterization](/docs/sms/resources/message-info/message-parameterization).",
)
body: StrictStr = Field(default=..., description="The message content")
type: Optional[StrictStr] = Field(
default="mt_text", description="Regular SMS"
)
delivery_report: Optional[DeliveryReportType] = None
send_at: Optional[datetime] = Field(
default=None,
description="If set in the future, the message will be delayed until `send_at` occurs. Must be before `expire_at`. If set in the past, messages will be sent immediately. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`.",
)
expire_at: Optional[datetime] = Field(
default=None,
description="If set, the system will stop trying to deliver the message at this point. Must be after `send_at`. Default and max is 3 days after `send_at`. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`.",
)
event_destination_target: Optional[StrictStr] = Field(
default=None,
alias="callback_url",
description="Override the *default* callback URL for this batch. Must be a valid URL. Learn how to set a default callback URL [here](https://community.sinch.com/t5/SMS/How-do-I-assign-a-callback-URL-to-an-SMS-service-plan/ta-p/8414).",
)
client_reference: Optional[StrictStr] = Field(
default=None,
description="The client identifier of a batch message. If set, the identifier will be added in the delivery report/callback of this batch",
)
feedback_enabled: Optional[StrictBool] = Field(
default=None,
description="If set to `true`, then [feedback](/docs/sms/api-reference/sms/tag/Batches/#tag/Batches/operation/deliveryFeedback) is expected after successful delivery.",
)
flash_message: Optional[StrictBool] = Field(
default=None,
description="Shows message on screen without user interaction while not saving the message to the inbox.",
)
max_number_of_message_parts: Optional[StrictInt] = Field(
default=None,
description="Message will be dispatched only if it is not split to more parts than Max Number of Message Parts",
)
truncate_concat: Optional[StrictBool] = Field(
default=None,
description="If set to `true` the message will be shortened when exceeding one part.",
)
from_ton: Optional[StrictInt] = Field(
default=None,
description="The type of number for the sender number. Use to override the automatic detection.",
)
from_npi: Optional[StrictInt] = Field(
default=None,
description="Number Plan Indicator for the sender number. Use to override the automatic detection.",
)