sinch.domains.conversation.models.v1.messages.types package

• sinch.domains.conversation.models.v1.messages.types.agent_type module
• sinch.domains.conversation.models.v1.messages.types.app_message_dict module
  • AppMessageDict
• sinch.domains.conversation.models.v1.messages.types.calendar_message_dict module
  • CalendarMessageDict
• sinch.domains.conversation.models.v1.messages.types.call_message_dict module
  • CallMessageDict
• sinch.domains.conversation.models.v1.messages.types.card_height_type module
• sinch.domains.conversation.models.v1.messages.types.card_message_dict module
  • CardMessageDict
• sinch.domains.conversation.models.v1.messages.types.carousel_message_dict module
  • CarouselMessageDict
• sinch.domains.conversation.models.v1.messages.types.channel_specific_message_type module
• sinch.domains.conversation.models.v1.messages.types.choice_message_dict module
  • ChoiceMessageDict
• sinch.domains.conversation.models.v1.messages.types.choice_message_properties_dict module
  • ChoiceMessagePropertiesDict
• sinch.domains.conversation.models.v1.messages.types.choice_option_dict module
  • ChoiceOptionDict
• sinch.domains.conversation.models.v1.messages.types.contact_info_message_dict module
  • NameInfoDict
  • PhoneNumberInfoDict
  • AddressInfoDict
  • EmailInfoDict
  • OrganizationInfoDict
  • UrlInfoDict
  • ContactInfoMessageDict
• sinch.domains.conversation.models.v1.messages.types.contact_message_dict module
  • WhatsAppInteractiveNfmReplyDict
  • WhatsAppInteractiveNfmReplyMessageDict
  • ChannelSpecificContactMessageDict
  • ChoiceResponseMessageDict
  • ReasonDict
  • FallbackMessageDict
  • MediaCardMessageDict
  • ProductResponseMessageDict
  • ReplyToDict
  • ContactMessageDict
• sinch.domains.conversation.models.v1.messages.types.conversation_channel_type module
• sinch.domains.conversation.models.v1.messages.types.conversation_direction_type module
• sinch.domains.conversation.models.v1.messages.types.conversation_messages_view_type module
• sinch.domains.conversation.models.v1.messages.types.coordinates_dict module
  • CoordinatesDict
• sinch.domains.conversation.models.v1.messages.types.display_mode_type module
• sinch.domains.conversation.models.v1.messages.types.list_message_dict module
  • ChoiceItemDict
  • ProductItemDict
  • ListItemChoiceDict
  • ListItemProductDict
  • ListSectionDict
  • ListMessagePropertiesDict
  • ListMessageDict
• sinch.domains.conversation.models.v1.messages.types.location_message_dict module
  • LocationMessageDict
• sinch.domains.conversation.models.v1.messages.types.media_properties_dict module
  • MediaPropertiesDict
• sinch.domains.conversation.models.v1.messages.types.message_content_type module
• sinch.domains.conversation.models.v1.messages.types.message_properties_dict module
  • MessagePropertiesDict
• sinch.domains.conversation.models.v1.messages.types.message_queue_type module
• sinch.domains.conversation.models.v1.messages.types.messages_source_type module
• sinch.domains.conversation.models.v1.messages.types.metadata_update_strategy_type module
• sinch.domains.conversation.models.v1.messages.types.payment_order_goods_type module
• sinch.domains.conversation.models.v1.messages.types.payment_order_status_type module
• sinch.domains.conversation.models.v1.messages.types.payment_order_type module
• sinch.domains.conversation.models.v1.messages.types.pix_key_type module
• sinch.domains.conversation.models.v1.messages.types.processing_mode_type module
• sinch.domains.conversation.models.v1.messages.types.processing_strategy_type module
• sinch.domains.conversation.models.v1.messages.types.reason_code_type module
• sinch.domains.conversation.models.v1.messages.types.reason_sub_code_type module
• sinch.domains.conversation.models.v1.messages.types.recipient_dict module
  • ChannelRecipientIdentityDict
  • RecipientIdentifiedByDict
  • RecipientContactIdDict
• sinch.domains.conversation.models.v1.messages.types.send_message_request_body_dict module
  • SendMessageRequestBodyDict
• sinch.domains.conversation.models.v1.messages.types.share_location_message_dict module
  • ShareLocationMessageDict
• sinch.domains.conversation.models.v1.messages.types.template_message_dict module
  • TemplateReferenceChannelSpecificDict
  • TemplateReferenceOmniChannelDict
  • TemplateMessageDict
• sinch.domains.conversation.models.v1.messages.types.text_message_dict module
  • TextMessageDict
• sinch.domains.conversation.models.v1.messages.types.url_message_dict module
  • UrlMessageDict
• sinch.domains.conversation.models.v1.messages.types.whatsapp_interactive_nfm_reply_name_type module

class sinch.domains.conversation.models.v1.messages.types.ListMessageDict

Bases: TypedDict

title: str

sections: List[ListSectionDict]

description: NotRequired[str]

media: NotRequired[MediaPropertiesDict]

message_properties: NotRequired[ListMessagePropertiesDict]

class sinch.domains.conversation.models.v1.messages.types.MediaPropertiesDict

Bases: TypedDict

url: str

thumbnail_url: NotRequired[str]

filename_override: NotRequired[str]

class sinch.domains.conversation.models.v1.messages.types.CardMessageDict

Bases: TypedDict

choices: NotRequired[List[ChoiceOptionDict]]

description: NotRequired[str]

height: NotRequired[Literal['UNSPECIFIED_HEIGHT', 'SHORT', 'MEDIUM', 'TALL'] | Annotated[str, Strict(strict=True)]]

title: NotRequired[str]

media_message: NotRequired[MediaPropertiesDict]

message_properties: NotRequired[MessagePropertiesDict]

class sinch.domains.conversation.models.v1.messages.types.CarouselMessageDict

Bases: TypedDict

cards: List[CardMessageDict]

choices: NotRequired[List[ChoiceOptionDict]]

class sinch.domains.conversation.models.v1.messages.types.ChoiceMessageDict

Bases: TypedDict

choices: List[ChoiceOptionDict]

text_message: NotRequired[TextMessageDict]

message_properties: NotRequired[ChoiceMessagePropertiesDict]

class sinch.domains.conversation.models.v1.messages.types.ContactInfoMessageDict

Bases: TypedDict

name: NameInfoDict

phone_numbers: List[PhoneNumberInfoDict]

addresses: NotRequired[List[AddressInfoDict]]

email_addresses: NotRequired[List[EmailInfoDict]]

organization: NotRequired[OrganizationInfoDict]

urls: NotRequired[List[UrlInfoDict]]

birthday: NotRequired[date]

class sinch.domains.conversation.models.v1.messages.types.LocationMessageDict

Bases: TypedDict

coordinates: CoordinatesDict

title: str

label: NotRequired[str]

class sinch.domains.conversation.models.v1.messages.types.TemplateMessageDict

Bases: TypedDict

channel_template: NotRequired[Dict[str, TemplateReferenceChannelSpecificDict]]

omni_template: NotRequired[TemplateReferenceOmniChannelDict]

class sinch.domains.conversation.models.v1.messages.types.ChannelRecipientIdentityDict

Bases: TypedDict

channel: Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | Annotated[str, Strict(strict=True)]

identity: str

class sinch.domains.conversation.models.v1.messages.types.SendMessageRequestBodyDict

Bases: TypedDict

TypedDict for the message body in send message requests. At least one message type must be provided.

text_message: NotRequired[TextMessageDict]

card_message: NotRequired[CardMessageDict]

carousel_message: NotRequired[CarouselMessageDict]

choice_message: NotRequired[ChoiceMessageDict]

contact_info_message: NotRequired[ContactInfoMessageDict]

list_message: NotRequired[ListMessageDict]

location_message: NotRequired[LocationMessageDict]

media_message: NotRequired[MediaPropertiesDict]

template_message: NotRequired[TemplateMessageDict]

class sinch.domains.conversation.models.v1.messages.types.AppMessageDict

Bases: dict

explicit_channel_message: NotRequired[Dict[str, str]]

explicit_channel_omni_message: NotRequired[Dict[str, Dict[str, Any]]]

channel_specific_message: NotRequired[Dict[str, Dict[str, Any]]]

agent: NotRequired[AgentDict]

text_message: NotRequired[TextMessageDict]

card_message: NotRequired[CardMessageDict]

carousel_message: NotRequired[CarouselMessageDict]

choice_message: NotRequired[ChoiceMessageDict]

contact_info_message: NotRequired[ContactInfoMessageDict]

list_message: NotRequired[ListMessageDict]

location_message: NotRequired[LocationMessageDict]

media_message: NotRequired[MediaPropertiesDict]

template_message: NotRequired[TemplateMessageDict]

class sinch.domains.conversation.models.v1.messages.types.ContactMessageDict

Bases: TypedDict

channel_specific_message: NotRequired[ChannelSpecificContactMessageDict]

choice_response_message: NotRequired[ChoiceResponseMessageDict]

fallback_message: NotRequired[FallbackMessageDict]

location_message: NotRequired[LocationMessageDict]

media_card_message: NotRequired[MediaCardMessageDict]

media_message: NotRequired[MediaPropertiesDict]

product_response_message: NotRequired[ProductResponseMessageDict]

text_message: NotRequired[TextMessageDict]

reply_to: NotRequired[ReplyToDict]

class sinch.domains.conversation.models.v1.messages.types.ChannelSpecificContactMessageDict

Bases: TypedDict

message_type: Literal['nfm_reply'] | str

message: WhatsAppInteractiveNfmReplyMessageDict

class sinch.domains.conversation.models.v1.messages.types.ChoiceResponseMessageDict

Bases: TypedDict

message_id: str

postback_data: str

class sinch.domains.conversation.models.v1.messages.types.FallbackMessageDict

Bases: TypedDict

raw_message: NotRequired[str]

reason: NotRequired[ReasonDict]

class sinch.domains.conversation.models.v1.messages.types.MediaCardMessageDict

Bases: TypedDict

url: str

caption: NotRequired[str]

class sinch.domains.conversation.models.v1.messages.types.ProductResponseMessageDict

Bases: TypedDict

products: NotRequired[List[ProductItemDict]]

title: NotRequired[str]

catalog_id: NotRequired[str]

class sinch.domains.conversation.models.v1.messages.types.ReasonDict

Bases: TypedDict

code: NotRequired[Literal['UNKNOWN', 'INTERNAL_ERROR', 'RATE_LIMITED', 'RECIPIENT_INVALID_CHANNEL_IDENTITY', 'RECIPIENT_NOT_REACHABLE', 'RECIPIENT_NOT_OPTED_IN', 'OUTSIDE_ALLOWED_SENDING_WINDOW', 'CHANNEL_FAILURE', 'CHANNEL_BAD_CONFIGURATION', 'CHANNEL_CONFIGURATION_MISSING', 'MEDIA_TYPE_UNSUPPORTED', 'MEDIA_TOO_LARGE', 'MEDIA_NOT_REACHABLE', 'NO_CHANNELS_LEFT', 'TEMPLATE_NOT_FOUND', 'TEMPLATE_INSUFFICIENT_PARAMETERS', 'TEMPLATE_NON_EXISTING_LANGUAGE_OR_VERSION', 'DELIVERY_TIMED_OUT', 'DELIVERY_REJECTED_DUE_TO_POLICY', 'CONTACT_NOT_FOUND', 'BAD_REQUEST', 'UNKNOWN_APP', 'NO_CHANNEL_IDENTITY_FOR_CONTACT', 'CHANNEL_REJECT', 'NO_PERMISSION', 'NO_PROFILE_AVAILABLE', 'UNSUPPORTED_OPERATION'] | Annotated[str, Strict(strict=True)]]

description: NotRequired[str]

sub_code: NotRequired[Literal['UNSPECIFIED_SUB_CODE', 'ATTACHMENT_REJECTED', 'MEDIA_TYPE_UNDETERMINED', 'INACTIVE_SENDER'] | Annotated[str, Strict(strict=True)]]

channel_code: NotRequired[str]

class sinch.domains.conversation.models.v1.messages.types.ReplyToDict

Bases: TypedDict

message_id: str

class sinch.domains.conversation.models.v1.messages.types.WhatsAppInteractiveNfmReplyDict

Bases: TypedDict

name: Literal['flow', 'address_message'] | Annotated[str, Strict(strict=True)]

response_json: str

body: str

class sinch.domains.conversation.models.v1.messages.types.WhatsAppInteractiveNfmReplyMessageDict

Bases: TypedDict

type: Literal['nfm_reply'] | str

nfm_reply: WhatsAppInteractiveNfmReplyDict