ClicksendsmsClient

Attributes

TRIGGER_OPERATIONS `module-attribute`

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'sms_inbound_automation': {'operation_id': 'sms_inbound_automation', 'path': '/{connectionId}/ms-flow/automations/sms/inbound', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}}

Classes

SmsSendInput `dataclass`

SmsSendInput(messages: Optional[List[Dict[str, Any]]] = None)

Send SMS

Attributes

messages `class-attribute` `instance-attribute`

messages: Optional[List[Dict[str, Any]]] = None

Message

SmsSendResponse `dataclass`

SmsSendResponse(http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)

Response for Send SMS

Attributes

http_code `class-attribute` `instance-attribute`

http_code: Optional[int] = None

Http Code

response_code `class-attribute` `instance-attribute`

response_code: Optional[str] = None

Response Code

response_msg `class-attribute` `instance-attribute`

response_msg: Optional[str] = None

Response Msg

data `class-attribute` `instance-attribute`

data: Optional[Dict[str, Any]] = None

data

CreateListInput `dataclass`

CreateListInput(list_name: Optional[str] = None)

Create New Contact List

Attributes

list_name `class-attribute` `instance-attribute`

list_name: Optional[str] = None

Your contact list name

CreateListResponse `dataclass`

CreateListResponse(http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)

Response for Create New Contact List

Attributes

http_code `class-attribute` `instance-attribute`

http_code: Optional[int] = None

Http Code

response_code `class-attribute` `instance-attribute`

response_code: Optional[str] = None

Response Code

response_msg `class-attribute` `instance-attribute`

response_msg: Optional[str] = None

Response Message

data `class-attribute` `instance-attribute`

data: Optional[Dict[str, Any]] = None

data

GetContactListsResponse `dataclass`

GetContactListsResponse(http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)

Response for Get Contact Lists

Attributes

http_code `class-attribute` `instance-attribute`

http_code: Optional[int] = None

Http Code

response_code `class-attribute` `instance-attribute`

response_code: Optional[str] = None

Response Code

response_msg `class-attribute` `instance-attribute`

response_msg: Optional[str] = None

Response Message

data `class-attribute` `instance-attribute`

data: Optional[Dict[str, Any]] = None

data

SendVoiceInput `dataclass`

SendVoiceInput(messages: Optional[List[Dict[str, Any]]] = None)

Send Voice Message

Attributes

messages `class-attribute` `instance-attribute`

messages: Optional[List[Dict[str, Any]]] = None

Message

SendVoiceResponse `dataclass`

SendVoiceResponse(http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)

Response for Send Voice Message

Attributes

http_code `class-attribute` `instance-attribute`

http_code: Optional[int] = None

Http Code

response_code `class-attribute` `instance-attribute`

response_code: Optional[str] = None

Response Code

response_msg `class-attribute` `instance-attribute`

response_msg: Optional[str] = None

Response Message

data `class-attribute` `instance-attribute`

data: Optional[Dict[str, Any]] = None

data

DeleteListResponse `dataclass`

DeleteListResponse(http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None)

Response for Delete List

Attributes

http_code `class-attribute` `instance-attribute`

http_code: Optional[int] = None

Http Code

response_code `class-attribute` `instance-attribute`

response_code: Optional[str] = None

Response Code

response_msg `class-attribute` `instance-attribute`

response_msg: Optional[str] = None

Response Message

CreateListContactInput `dataclass`

CreateListContactInput(first_name: Optional[str] = None, last_name: Optional[str] = None, phone_number: Optional[str] = None, email: Optional[str] = None, fax_number: Optional[str] = None, organization_name: Optional[str] = None, address_country: Optional[str] = None, address_state: Optional[str] = None, address_city: Optional[str] = None, custom1: Optional[str] = None, custom3: Optional[str] = None, address_postal_code: Optional[str] = None, custom2: Optional[str] = None, custom4: Optional[str] = None, address_line1: Optional[str] = None, address_line2: Optional[str] = None)

Create New Contact

Attributes

first_name `class-attribute` `instance-attribute`

first_name: Optional[str] = None

Contact's first name.

last_name `class-attribute` `instance-attribute`

last_name: Optional[str] = None

Contact's last name.

phone_number `class-attribute` `instance-attribute`

phone_number: Optional[str] = None

The contact phone in local or international format e.g. +61411111111.

email `class-attribute` `instance-attribute`

email: Optional[str] = None

Contact's email address.

fax_number `class-attribute` `instance-attribute`

fax_number: Optional[str] = None

Contact's fax number.

organization_name `class-attribute` `instance-attribute`

organization_name: Optional[str] = None

Contact's organization name.

address_country `class-attribute` `instance-attribute`

address_country: Optional[str] = None

The contact's country.

address_state `class-attribute` `instance-attribute`

address_state: Optional[str] = None

State

address_city `class-attribute` `instance-attribute`

address_city: Optional[str] = None

Address City

custom1 `class-attribute` `instance-attribute`

custom1: Optional[str] = field(default=None, metadata={'wire_name': 'custom_1'})

Custom 1

custom3 `class-attribute` `instance-attribute`

custom3: Optional[str] = field(default=None, metadata={'wire_name': 'custom_3'})

Custom 3

custom2 `class-attribute` `instance-attribute`

custom2: Optional[str] = field(default=None, metadata={'wire_name': 'custom_2'})

Custom 2

custom4 `class-attribute` `instance-attribute`

custom4: Optional[str] = field(default=None, metadata={'wire_name': 'custom_4'})

Custom 4

address_line1 `class-attribute` `instance-attribute`

address_line1: Optional[str] = field(default=None, metadata={'wire_name': 'address_line_1'})

Address Line 1

address_line2 `class-attribute` `instance-attribute`

address_line2: Optional[str] = field(default=None, metadata={'wire_name': 'address_line_2'})

Address Line 2

CreateListContactResponse `dataclass`

CreateListContactResponse(http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)

Response for Create New Contact

Attributes

http_code `class-attribute` `instance-attribute`

http_code: Optional[int] = None

Http Code

response_code `class-attribute` `instance-attribute`

response_code: Optional[str] = None

Response Code

response_msg `class-attribute` `instance-attribute`

response_msg: Optional[str] = None

Response Message

data `class-attribute` `instance-attribute`

data: Optional[Dict[str, Any]] = None

data

ViewListContactsResponse `dataclass`

ViewListContactsResponse(http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)

Response for Get Contacts in a List

Attributes

http_code `class-attribute` `instance-attribute`

http_code: Optional[int] = None

Http Code

response_code `class-attribute` `instance-attribute`

response_code: Optional[str] = None

Response Code

response_msg `class-attribute` `instance-attribute`

response_msg: Optional[str] = None

Response Message

data `class-attribute` `instance-attribute`

data: Optional[Dict[str, Any]] = None

data

DeleteListContactResponse `dataclass`

DeleteListContactResponse(http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None)

Response for Delete a Contact

Attributes

http_code `class-attribute` `instance-attribute`

http_code: Optional[int] = None

Http Code

response_code `class-attribute` `instance-attribute`

response_code: Optional[str] = None

Response Code

response_msg `class-attribute` `instance-attribute`

response_msg: Optional[str] = None

Response Message

SendMmsInput `dataclass`

SendMmsInput(messages: Optional[List[Dict[str, Any]]] = None, media_file: Optional[str] = None)

Send MMS

Attributes

messages `class-attribute` `instance-attribute`

messages: Optional[List[Dict[str, Any]]] = None

Message

media_file `class-attribute` `instance-attribute`

media_file: Optional[str] = None

Supports maximum file size of 250kB, Gif can only be supported if it below 100 kB file size

SendMmsResponse `dataclass`

SendMmsResponse(http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)

Response for Send MMS

Attributes

http_code `class-attribute` `instance-attribute`

http_code: Optional[int] = None

Http Code

response_code `class-attribute` `instance-attribute`

response_code: Optional[str] = None

Response Code

response_msg `class-attribute` `instance-attribute`

response_msg: Optional[str] = None

Response Message

data `class-attribute` `instance-attribute`

data: Optional[Dict[str, Any]] = None

data

SendFaxInput `dataclass`

SendFaxInput(messages: Optional[List[Dict[str, Any]]] = None, file_url: Optional[str] = None)

Send Fax

Attributes

messages `class-attribute` `instance-attribute`

messages: Optional[List[Dict[str, Any]]] = None

Message

file_url `class-attribute` `instance-attribute`

file_url: Optional[str] = None

Maximum file size is 4 MB. All pages should be in portrait. Chat with ClickSend Support for complete specifications

SendFaxResponse `dataclass`

SendFaxResponse(http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)

Response for Send Fax

Attributes

http_code `class-attribute` `instance-attribute`

http_code: Optional[int] = None

Http Code

response_code `class-attribute` `instance-attribute`

response_code: Optional[str] = None

Response Code

response_msg `class-attribute` `instance-attribute`

response_msg: Optional[str] = None

Response Message

data `class-attribute` `instance-attribute`

data: Optional[Dict[str, Any]] = None

data

UploadMediaInput `dataclass`

UploadMediaInput(content: Optional[str] = None)

Convert Media File Format

Attributes

content `class-attribute` `instance-attribute`

content: Optional[str] = None

File Content (base64)

UploadMediaResponse `dataclass`

UploadMediaResponse(http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)

Response for Convert Media File Format

Attributes

http_code `class-attribute` `instance-attribute`

http_code: Optional[int] = None

Http Code

response_code `class-attribute` `instance-attribute`

response_code: Optional[str] = None

Response Code

response_msg `class-attribute` `instance-attribute`

response_msg: Optional[str] = None

Response Message

data `class-attribute` `instance-attribute`

data: Optional[Dict[str, Any]] = None

data

SearchContactListResponse `dataclass`

SearchContactListResponse(http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)

Response for Search Contact Lists

Attributes

http_code `class-attribute` `instance-attribute`

http_code: Optional[int] = None

Http Code

response_code `class-attribute` `instance-attribute`

response_code: Optional[str] = None

Response Code

response_msg `class-attribute` `instance-attribute`

response_msg: Optional[str] = None

Response Message

data `class-attribute` `instance-attribute`

data: Optional[Dict[str, Any]] = None

data

SendLetterInput `dataclass`

SendLetterInput(file_url: Optional[str] = None, template_used: Optional[int] = None, colour: Optional[int] = None, duplex: Optional[int] = None, priority_post: Optional[int] = None, recipients: Optional[List[Dict[str, Any]]] = None, source: Optional[str] = None)

Send Letter

Attributes

file_url `class-attribute` `instance-attribute`

file_url: Optional[str] = None

Maximum file size is 10 MB. All pages should be in portrait. Chat with ClickSend Support for complete specifications.

template_used `class-attribute` `instance-attribute`

template_used: Optional[int] = None

Whether using letter template. Flag value must be 1 for yes or 0 for no.

colour `class-attribute` `instance-attribute`

colour: Optional[int] = None

Choose to use colour or B&W printing. (Black & White = 0, Colour = 1)

duplex `class-attribute` `instance-attribute`

duplex: Optional[int] = None

Choose to use Duplex = 1 (double-sided) or Simplex = 0(single sided) printing.

priority_post `class-attribute` `instance-attribute`

priority_post: Optional[int] = None

Whether letter is priority, Flag value must be 1 for yes or 0 for no.

recipients `class-attribute` `instance-attribute`

recipients: Optional[List[Dict[str, Any]]] = None

Recipient

source `class-attribute` `instance-attribute`

source: Optional[str] = None

Source

SendLetterResponse `dataclass`

SendLetterResponse(http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)

Response for Send Letter

Attributes

http_code `class-attribute` `instance-attribute`

http_code: Optional[int] = None

Http Code

response_code `class-attribute` `instance-attribute`

response_code: Optional[str] = None

Response Code

response_msg `class-attribute` `instance-attribute`

response_msg: Optional[str] = None

Response Message

data `class-attribute` `instance-attribute`

data: Optional[Dict[str, Any]] = None

data

SendPostcardInput `dataclass`

SendPostcardInput(recipients: Optional[List[Dict[str, Any]]] = None, file_urls: Optional[List[str]] = None)

Send Postcard

Attributes

recipients `class-attribute` `instance-attribute`

recipients: Optional[List[Dict[str, Any]]] = None

item

file_urls `class-attribute` `instance-attribute`

file_urls: Optional[List[str]] = None

PDF File URL

SendPostcardResponse `dataclass`

SendPostcardResponse(http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)

Response for Send Postcard

Attributes

http_code `class-attribute` `instance-attribute`

http_code: Optional[int] = None

Http Code

response_code `class-attribute` `instance-attribute`

response_code: Optional[str] = None

Response Code

response_msg `class-attribute` `instance-attribute`

response_msg: Optional[str] = None

Response Message

data `class-attribute` `instance-attribute`

data: Optional[Dict[str, Any]] = None

data

SmsInboundAutomationInput `dataclass`

SmsInboundAutomationInput(message_search_type: Optional[int] = None, message_search_term: Optional[str] = None, action_address: Optional[str] = None, dedicated_number: Optional[str] = None, rule_name: Optional[str] = None, webhook_type: Optional[str] = None, action: Optional[str] = None, enabled: Optional[int] = None)

SMS Inbound Automation

Attributes

message_search_type `class-attribute` `instance-attribute`

message_search_type: Optional[int] = None

Message Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain.

message_search_term `class-attribute` `instance-attribute`

message_search_term: Optional[str] = None

word or phrase in the SMS

action_address `class-attribute` `instance-attribute`

action_address: Optional[str] = None

Action address

dedicated_number `class-attribute` `instance-attribute`

dedicated_number: Optional[str] = None

Decicated Number. Can be '*' to apply to all numbers.

rule_name `class-attribute` `instance-attribute`

rule_name: Optional[str] = None

Rule Name

webhook_type `class-attribute` `instance-attribute`

webhook_type: Optional[str] = None

Webhook Type

action `class-attribute` `instance-attribute`

action: Optional[str] = None

Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE).

enabled `class-attribute` `instance-attribute`

enabled: Optional[int] = None

enabled