Class Reference¶

Models¶

django_webix_sender.models.save_attachments(files: Dict[str, Any], *args, **kwargs)[source]¶

Save attachments function

Parameters:	files – a dict with attachments args – Optional arguments kwargs – optional keyword arguments
Returns:	list of MessageAttachment instances

class django_webix_sender.models.DjangoWebixSender(*args, **kwargs)[source]¶

Abstract model with basic configuration

get_email¶

Get email address

Returns:	email address

static get_email_fieldpath() → str[source]¶

Get email field name (or complete path with fks)

Returns:	string with email fieldname

get_email_related¶

Get all email related recipients to this instance

Returns:	list of instances of related recipients

classmethod get_filters_viewers(user, *args, **kwargs) → django.db.models.query_utils.Q[source]¶

Filters recipients that can be seen by this user

Parameters:	user – user instance args – Optional arguments kwargs – optional keyword arguments
Returns:	Q object with filters

classmethod get_prefetch_related() → List[str][source]¶

Related field to optimize django queries

Returns:	list of prefetch related fields

classmethod get_representation() → django.db.models.expressions.F[source]¶

Get field to create a sql rapresentation

Returns:	F object

classmethod get_select_related() → List[str][source]¶

Related field to optimize django queries

Returns:	list of select related fields

get_sms¶

Get sms number

Returns:	sms number

static get_sms_fieldpath() → str[source]¶

Get sms field name (or complete path with fks)

Returns:	string with sms fieldname

get_sms_related¶

Get all sms related recipients to this instance

Returns:	list of instances of related recipients

get_telegram¶

Get telegram id

Returns:	telegram id

static get_telegram_fieldpath() → str[source]¶

Get telegram field name (or complete path with fks)

Returns:	string with telegram fieldname

get_telegram_related¶

Get all email related recipients to this instance

Returns:	list of instances of related recipients

class django_webix_sender.models.Customer(*args, **kwargs)[source]¶

Customer model

exception DoesNotExist¶

exception MultipleObjectsReturned¶

get_email¶

Get email address

Returns:	email address

static get_email_fieldpath() → str[source]¶

Get email field name (or complete path with fks)

Returns:	string with email fieldname

classmethod get_filters_viewers(user, *args, **kwargs) → django.db.models.query_utils.Q[source]¶

Filters recipients that can be seen by this user

Parameters:	user – user instance args – Optional arguments kwargs – optional keyword arguments
Returns:	Q object with filters

classmethod get_representation() → django.db.models.expressions.F[source]¶

Get field to create a sql rapresentation

Returns:	F object

get_sms¶

Get sms number

Returns:	sms number

static get_sms_fieldpath() → str[source]¶

Get sms field name (or complete path with fks)

Returns:	string with sms fieldname

get_telegram¶

Get telegram id

Returns:	telegram id

static get_telegram_fieldpath() → str[source]¶

Get telegram field name (or complete path with fks)

Returns:	string with telegram fieldname

class django_webix_sender.models.CustomerTypology(*args, **kwargs)[source]¶

Customer typology model

exception DoesNotExist¶

exception MultipleObjectsReturned¶

class django_webix_sender.models.ExternalSubject(*args, **kwargs)[source]¶

External subject model

exception DoesNotExist¶

exception MultipleObjectsReturned¶

get_email¶

Get email address

Returns:	email address

static get_email_fieldpath() → str[source]¶

Get email field name (or complete path with fks)

Returns:	string with email fieldname

classmethod get_filters_viewers(user, *args, **kwargs) → django.db.models.query_utils.Q[source]¶

Filters recipients that can be seen by this user

Parameters:	user – user instance args – Optional arguments kwargs – optional keyword arguments
Returns:	Q object with filters

classmethod get_representation() → django.db.models.expressions.F[source]¶

Get field to create a sql rapresentation

Returns:	F object

get_sms¶

Get sms number

Returns:	sms number

static get_sms_fieldpath() → str[source]¶

Get sms field name (or complete path with fks)

Returns:	string with sms fieldname

get_telegram¶

Get telegram id

Returns:	telegram id

static get_telegram_fieldpath() → str[source]¶

Get telegram field name (or complete path with fks)

Returns:	string with telegram fieldname

class django_webix_sender.models.ExternalSubjectTypology(*args, **kwargs)[source]¶

External subject typology model

exception DoesNotExist¶

exception MultipleObjectsReturned¶

class django_webix_sender.models.MessageAttachment(*args, **kwargs)[source]¶

Message attachments model

exception DoesNotExist¶

exception MultipleObjectsReturned¶

class django_webix_sender.models.MessageTypology(*args, **kwargs)[source]¶

Message typology model

exception DoesNotExist¶

exception MultipleObjectsReturned¶

class django_webix_sender.models.MessageSent(*args, **kwargs)[source]¶

Message sent model

exception DoesNotExist¶

exception MultipleObjectsReturned¶

class django_webix_sender.models.MessageRecipient(*args, **kwargs)[source]¶

Message recipient model

exception DoesNotExist¶

exception MultipleObjectsReturned¶

class django_webix_sender.models.MessageUserRead(*args, **kwargs)[source]¶

Message readed by user model

exception DoesNotExist¶

exception MultipleObjectsReturned¶

class django_webix_sender.models.TelegramPersistence(*args, **kwargs)[source]¶

Telegram persistence model

exception DoesNotExist¶

exception MultipleObjectsReturned¶

Template Tags¶

django_webix_sender.templatetags.field_type.field_type(context, model, field_name)[source]¶: Returns model field type

django_webix_sender.templatetags.send_methods_utils.is_chat_available(context)[source]¶: Returns boolean to indicate if there are chats configured

django_webix_sender.templatetags.send_methods_utils.is_list_available(context)[source]¶: Returns boolean to indicate if there are lists configured

django_webix_sender.templatetags.send_methods_utils.user_can_send(context)[source]¶: Returns boolean to indicate if user has send permission

django_webix_sender.templatetags.verbose_name.get_verbose_field_name(context, model, field_name)[source]¶: Returns verbose_name for a field.

Views¶

Utils¶

django_webix_sender.utils.my_import(name: str) → callable[source]¶

Load a function from a string

Parameters:	name – function path name (e.g. django_webix_sender.send_methods.email.send_utils)
Returns:	callable

django_webix_sender.utils.send_mixin(send_method: str, typology: Optional[int], subject: str, body: str, recipients: Dict[str, List[int]], presend: Optional[Any], **kwargs) → Tuple[Dict[str, Any], int][source]¶

Function to send the message

Parameters:

send_method – <skebby|email|telegram|storage>.<function> (eg. “skebby.django_webix_sender.send_methods.email.send_utils”)
typology – MessageTypology ID
subject – Subject of message
body – Body of message (email, skebby, telegram or storage)
recipients – Dict {‘<app_label>.<model>’: [<id>, <id>]}
presend – None: verify before the send; Otherwise: send the message
kwargs – user and files (default: user=None, files={})

Returns:

Tuple[Dict, Code]

Send Methods¶

Email¶

Send Utils¶

django_webix_sender.send_methods.email.send_utils.send(recipients: Dict[str, List[int]], subject: str, body: str, message_sent)[source]¶

Send email

Parameters:	recipients – Dict {‘<app_label>.<model>’: [<id>, <id>]} subject – Subject of email body – Body of message message_sent – MessageSent instance
Returns:	MessageSent instance

Skebby¶

Enums¶

class django_webix_sender.send_methods.skebby.enums.SkebbyBoolean[source]¶: An enumeration.

class django_webix_sender.send_methods.skebby.enums.SkebbyEncoding[source]¶: An enumeration.

class django_webix_sender.send_methods.skebby.enums.SkebbyMessageType[source]¶: An enumeration.

Exceptions¶

exception django_webix_sender.send_methods.skebby.exceptions.SkebbyException[source]¶

Gateway¶

class django_webix_sender.send_methods.skebby.gateway.Skebby[source]¶

https://developers.skebby.it

class Authentication[source]¶

Authentication methods

The following are the two available methods to authenticate a user, given a username and a password (registration required): - Using a temporary session key, which expires after a certain amount of time has passed with no performed API calls with that key. - Using an authentication token, which does not expire, except when an account is deactivated or suspended. In both cases, the returned user_key, as well as the session key or the token, are required to be provided in the HTTP request headers in order to perform any API call after the login.

session_key(username, password)[source]¶

Authenticate using a session key

The login with session key API lets you authenticate by using your username and password, and returns a token to be used for authenticating the next API calls. The following HTTP headers should be provided after the login: - user_key:USER_KEY - Session_key:SESSION_KEY Where USER_KEY and SESSION_KEY are the values returned by the login API.

user_token(username, password)[source]¶

Authenticate using a user token

The login with token API lets you authenticate by using your username and password, and returns a token to be used for authenticating the next API calls. The following HTTP headers should be provided after the login: - user_key:USER_KEY - Access_token:ACCESS_TOKEN Where USER_KEY and ACCESS_TOKEN are the values returned by the login API.

class Contacts(authentication)[source]¶

Contacts API

This part of the API is used to manage contacts.

add_contact(email, phone_number, name='', surname='', gender='', fax='', address='', city='', province='', birthdate='', promotiondate='', rememberdate='', zip_code='', group_ids=None, custom1='', custom2='', custom3='', custom4='', custom5='', custom6='', custom7='', custom8='', custom9='', custom10='')[source]¶

Add a contact

Add a contact to the user’s addressbook.

class ContactsGroups(authentication)[source]¶

Contacts groups API

This section describes how groups of contacts are created, updated and deleted. SMS messages can be directly sent to groups of contacts.

class LandingPages(authentication)[source]¶

Landing pages API

This is the part of the API that is concerned with the landing pages service.

class ReceivedSMS(authentication)[source]¶

Received SMS API

This API allows to query the received SMS messages on the owned SIMs.

class SmsBlacklist(authentication)[source]¶

SMS Blacklist / Stop SMS

This is the part of the API that allow to insert and to retrieve the list of SMS blacklist / Stop SMS. The SMS blacklist contains the phone numbers to which you don’t want to send any SMS. If the Stop SMS Service is active, any person who receive an SMS can add their phone number to the blacklist.

class SmsHistory(authentication)[source]¶

SMS History API

This API is used to retrieve the SMS messages sending history.

get_sent_rich_sms_statistics(order_id)[source]¶

Get sent Rich SMS statistics

After sending an sms campaign via API containing a Rich sms shortened link, this api returns that sms link’s opening statistics. Keep in mind that you need to use a unique order_id when sending and store it to request in the near future.

get_sent_sms_history(date_from, date_to='now', timezone=None, page_number=1, page_size=10)[source]¶

Get sent SMS history

Returns the user’s SMS messages history

get_sent_sms_to_recipient(recipient, date_from, date_to='now', timezone=None, page_number=1, page_size=10)[source]¶

Get sent SMS to a recipient

Returns the user’s SMS messages history for the specified recipient

class SmsSend(authentication)[source]¶

SMS send API

This is the part of the API that allows to send SMS messages, to single recipients, saved contacts or groups of contacts.

get_sms_state(order_id)[source]¶

Get SMS message state

Get informations on the SMS delivery status of the given order_id.

send_parametric_sms(message_type: django_webix_sender.send_methods.skebby.enums.SkebbyMessageType, message, recipient, sender='', scheduled_delivery_time=None, scheduled_delivery_timezone=None, order_id=None, return_credits=<SkebbyBoolean.FALSE: 'false'>, return_remaining=<SkebbyBoolean.FALSE: 'false'>, allow_invalid_recipients=<SkebbyBoolean.FALSE: 'false'>, encoding=<SkebbyEncoding.GSM: 'gsm'>, id_landing=None, campaign_name=None, max_fragments=7, truncate=<SkebbyBoolean.TRUE: 'true'>, richsms_url=None, richsms_mode=None)[source]¶

Send a parametric SMS message

Sends a parametric SMS message to a given list of recipients. With this API it is possible to put placeholders in the message body, and then, for each recipient, specify the values that will replace the placeholders in the message body, for that particular recipient message. Placeholders are in the form ${ParameterName}

Landing Pages URLs It is possible to include a link to a published Landing Page by specifying the id_landing parameter and by adding the following placeholder in the message body: %PAGESLINK____________%.

Landing pages must be first created and published in your user panel, since you will need id_landing to send it. A list of published landing pages can be retrieved by using the Landing Pages APIs

SMS Link Analytics When including URLs in the message, it may be convenient to use our SMS Link Analytics short URLs service to limit the number of characters used in the SMS message and having statistic on clic. Our API can automatically generate a short link starting from a long one, and add it in the message. To use this feature, use the %RICHURL____________% placeholder in the message body and set the parameter rich_mode with one of following values: DIRECT_URL: in this case you must add the parameter richsms_url with the url that you want to be shortened RECIPIENT: in this case the url must be set in the url property for each recipient in recipients parameter. You could omit richsms_mode if you specify both the richsms_url params and %RICHURL__________% placeholder.

Aliases can be used only with high-quality message types.

send_sms(message_type: django_webix_sender.send_methods.skebby.enums.SkebbyMessageType, message, recipient, sender='', scheduled_delivery_time=None, scheduled_delivery_timezone=None, order_id=None, return_credits=<SkebbyBoolean.FALSE: 'false'>, return_remaining=<SkebbyBoolean.FALSE: 'false'>, allow_invalid_recipients=<SkebbyBoolean.FALSE: 'false'>, encoding=<SkebbyEncoding.GSM: 'gsm'>, id_landing=None, campaign_name=None, max_fragments=7, truncate=<SkebbyBoolean.TRUE: 'true'>, richsms_url=None)[source]¶

Send an SMS message

Sends an SMS message to a given list of recipients.

Landing Pages URLs It is possible to include a link to a published Landing Page by specifying the id_landing parameter and by adding the following placeholder in the message body: %PAGESLINK____________%.

Landing pages must be first created and published in your user panel, since you will need id_landing to send it. A list of published landing pages can be retrieved by using the Landing Pages APIs

SMS Link Analytics When including URLs in the message, it may be convenient to use our SMS Link Analytics short URLs service to limit the number of characters used in the SMS message and having statistic on clic. Our API can automatically generate a short link starting from a long one, and add it in the message. To use this feature, use the %RICHURL_______% placeholder in the message body, that will be replaced with the generated short link, and the respective richsms_url parameter, that should be set to a valid URL.

Sender Alias Alphanumeric aliases are required to be registered first, and need to be approved both from Us and AGCOM. Aliases can be used only with high-quality message types.

class Subaccount(authentication)[source]¶

Subaccount API

If enabled as a superaccount, the user can create subaccounts that can be assigned to third-parties. Superaccounts may or may not share credits with their subaccounts.

class TPOA(authentication)[source]¶

TPOA API

The TPOA (Transmission Path Originating Address) API is used to deal with TPOA entries (i.e. “SMS sender aliases”) of the user.

class TwoFactorAuthentication(authentication)[source]¶

Two Factor Authentication API

This is the part of the API that provides the Two Factor Authentication. The flow of 2FA is: 1. The user specifies their number in your App. 2. Your app sends a 2FA request via API. 3. The platform sends a text message to the specified recipient. 4. User receives the PIN via text message. 5. User enters the PIN in your App. 6. Your app sends the 2FA verify via API and receives the authorization or an invalid pin error.

The text message is sent with the highest quality on a preferred route, to guarantee a quick delivery.

class User(authentication)[source]¶

User API

The following are utility functions regarding the Authenticated User (e.g. the user status, password reset, etc)

dashboard()[source]¶

Dashboard

API used to retrieve the dashboard URL of the authenticated user

reset_password(password)[source]¶

Reset password

Changes the authenticated user’s password

user_status(get_money=<SkebbyBoolean.FALSE: 'false'>, type_aliases=<SkebbyBoolean.FALSE: 'false'>)[source]¶

User status

Used to retrieve the credits and other information of the user identified by the id.

verify_session()[source]¶

Verify session

Checks whether the user session is still active and valid (without renewal).

Send Utils¶

django_webix_sender.send_methods.skebby.send_utils.send(recipients: Dict[str, List[int]], body: str, message_sent)[source]¶

Send Sebby sms

Parameters:	recipients – Dict {‘<app_label>.<model>’: [<id>, <id>]} body – Body of message message_sent – MessageSent instance
Returns:	MessageSent instance

Tasks¶

Storage¶

Send Utils¶

django_webix_sender.send_methods.storage.send_utils.send(recipients: Dict[str, List[int]], subject: str, body: str, message_sent)[source]¶

Send email

Parameters:	recipients – Dict {‘<app_label>.<model>’: [<id>, <id>]} subject – Subject of message body – Body of message message_sent – MessageSent instance
Returns:	MessageSent instance

Telegram¶

Handlers¶

django_webix_sender.send_methods.telegram.handlers.cancel_phone_number(update: telegram.update.Update, context: telegram.ext.callbackcontext.CallbackContext) → int[source]¶: Cancel phone number registration procedure

django_webix_sender.send_methods.telegram.handlers.check_phone_number(update: telegram.update.Update, context: telegram.ext.callbackcontext.CallbackContext) → int[source]¶: Check if user’s phone number is in recipients records

django_webix_sender.send_methods.telegram.handlers.check_user(update: telegram.update.Update, context: telegram.ext.callbackcontext.CallbackContext) → None[source]¶: Check if user is enabled to chat with bot

django_webix_sender.send_methods.telegram.handlers.echo(update: telegram.update.Update, context: telegram.ext.callbackcontext.CallbackContext) → None[source]¶: Echo the user message.

django_webix_sender.send_methods.telegram.handlers.help_command(update: telegram.update.Update, context: telegram.ext.callbackcontext.CallbackContext) → None[source]¶: Send a message when the command /help is issued.

django_webix_sender.send_methods.telegram.handlers.start(update: telegram.update.Update, context: telegram.ext.callbackcontext.CallbackContext) → None[source]¶: Send a message when the command /start is issued.

django_webix_sender.send_methods.telegram.handlers.start_phone_number(update: telegram.update.Update, context: telegram.ext.callbackcontext.CallbackContext) → int[source]¶: Initial command that requires phone number to register user

Persistence¶

class django_webix_sender.send_methods.telegram.persistences.DatabaseTelegramPersistence(store_user_data: bool = True, store_chat_data: bool = True, store_bot_data: bool = True)[source]¶

get_bot_data() → Dict[Any, Any][source]¶

“Will be called by telegram.ext.Dispatcher upon creation with a persistence object. It should return the bot_data if stored, or an empty dict.

Returns:: dict: The restored bot data.

get_chat_data() → DefaultDict[int, Dict[Any, Any]][source]¶

“Will be called by telegram.ext.Dispatcher upon creation with a persistence object. It should return the chat_data if stored, or an empty defaultdict(dict).

Returns:: defaultdict: The restored chat data.

get_conversations(name: str) → Dict[Tuple[int, ...], Optional[object]][source]¶

“Will be called by telegram.ext.Dispatcher when a telegram.ext.ConversationHandler is added if telegram.ext.ConversationHandler.persistent is True. It should return the conversations for the handler with name or an empty dict

Args:: name (str): The handlers name.
Returns:: dict: The restored conversations for the handler.

get_user_data() → DefaultDict[int, Dict[Any, Any]][source]¶

Will be called by telegram.ext.Dispatcher upon creation with a persistence object. It should return the user_data if stored, or an empty defaultdict(dict).

Returns:: defaultdict: The restored user data.

update_bot_data(data: Dict[KT, VT]) → None[source]¶

Will be called by the telegram.ext.Dispatcher after a handler has handled an update.

Args:: data (dict): The telegram.ext.dispatcher.bot_data .

update_chat_data(chat_id: int, data: Dict[KT, VT]) → None[source]¶

Will be called by the telegram.ext.Dispatcher after a handler has handled an update.

Args:: chat_id (int): The chat the data might have been changed for. data (dict): The telegram.ext.dispatcher.chat_data [chat_id].

update_conversation(name: str, key: Tuple[int, ...], new_state: Optional[object]) → None[source]¶

Will be called when a telegram.ext.ConversationHandler.update_state is called. This allows the storage of the new state in the persistence.

Args:: name (str): The handler’s name. key (tuple): The key the state is changed for. new_state (tuple | any): The new state for the given key.

update_user_data(user_id: int, data: Dict[KT, VT]) → None[source]¶

Will be called by the telegram.ext.Dispatcher after a handler has handled an update.

Args:: user_id (int): The user the data might have been changed for. data (dict): The telegram.ext.dispatcher.user_data [user_id].

Send Utils¶

django_webix_sender.send_methods.telegram.send_utils.send(recipients: Dict[str, List[int]], body: str, message_sent)[source]¶

Send Telegram message

Parameters:	recipients – Dict {‘<app_label>.<model>’: [<id>, <id>]} body – Body of message message_sent – MessageSent instance
Returns:	MessageSent instance