Overview
Configuration is provided for establishing connections with the ClickSend service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from a service resource.
Insert data
Use REST Destination component to insert data into service resource.
Demonstration
Quick Start
In this task, we will show you step-by-step how to create a connection to ClickSend REST API using COZYROC's REST Connection Manager.
Step 1. You have to generate an API key to connect to the service. You can get your API credentials by clicking 'API Credentials' on the top right of the dashboard in ClickSend.
Step 2. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 3. From the drop-down menu Configuration select ClickSend. Enter the ClickSend API user name and key you have acquired.
Step 4. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your ClickSend instance.
In this guide, we will show how to read data from the ClickSend service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select ClickSend connection from the combo. Select from available ClickSend resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select ClickSend resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from ClickSend service.
In this guide, we will show how to write data to the ClickSend service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select ClickSend connection from the combo. Also, select resource action and ClickSend resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the ClickSend resource.
Configuration
Base URL address: https://rest.clicksend.com/v3.
- Basic
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Name:
- APIKey:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Basic {{=Base64.encode(connection.user.Name + ':' + connection.user.APIKey)}}
Documentation: https://en.wikipedia.org/wiki/Basic_access_authentication.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/account.Documentation: https://developers.clicksend.com/docs/rest/v3/#create-account.
- username
Template: ShortText.
- user_email
Template: ShortText.
- user_phone
Template: ShortText.
- user_first_name
Template: ShortText.
- user_last_name
Template: ShortText.
- country
Template: ShortText.
- password
Template: ShortText.
- account_name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/recharge/packages.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-recharge-packages.
- package_id
Data type: DT_I4
- package_price
Data type: DT_R8
- sms_price
Data type: DT_R8
- sms_quantity
Data type: DT_I4
- voice_mobile_price
Data type: DT_R8
- voice_mobile_quantity
Data type: DT_I4
- voice_landline_price
Data type: DT_R8
- voice_landline_quantity
Data type: DT_I4
- fax_price
Data type: DT_R8
- fax_quantity
Data type: DT_I4
- email_price
Data type: DT_R8
- email_quantity
Data type: DT_I4
- post_letter_black_price
Data type: DT_R8
- post_letter_colour_price
Data type: DT_R8
- post_page_black_price
Data type: DT_R8
- post_page_colour_price
Data type: DT_R8
- post_letter_black_quantity
Data type: DT_I4
- post_letter_colour_quantity
Data type: DT_I4
- post_direct_mail_dl_price
Data type: DT_R8
- post_direct_mail_a5_price
Data type: DT_R8
- post_direct_mail_min_quantity
Data type: DT_I4
- postcard_price
Data type: DT_I4
- postcard_quantity
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/recharge/transactions.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-all-transactions.
- invoice_number
Data type: DT_GUID
- amount
Data type: DT_R8
- currency
Template: ShortText.
- date
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/lists/{{=parameters.list_id}}/contacts.The action has the following user-defined parameters:
- list_id: Required. Specify list identifier.
Documentation: https://developers.clicksend.com/docs/rest/v3/#view-list-contacts.
- [Create] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/contacts.Documentation: https://developers.clicksend.com/docs/rest/v3/#create-new-contact.
- [Update] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/contacts/{{=item.contact_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#update-contact.
- [Delete] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/contacts/{{=item.contact_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#delete-contact.
- contact_id
A key field. Data type: DT_I4
- list_id
Data type: DT_I4
- phone_number
Template: ShortText.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- custom_1
Template: ShortText.
- custom_2
Template: ShortText.
- custom_3
Template: ShortText.
- custom_4
Template: ShortText.
- date_added
Template: DateTime. A read-only field.
- fax_number
Template: ShortText.
- organization_name
Template: ShortText.
Template: ShortText.
- address_line_1
Template: ShortText.
- address_line_2
Template: ShortText.
- address_city
Template: ShortText.
- address_state
Template: ShortText.
- address_postal_code
Template: ShortText.
- address_country
Template: ShortText.
- _list_name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/lists.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-lists.
- [Update] action
-
Endpoint URL address:
/lists/{{=item.list_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#update-list.
- [Delete] action
-
Endpoint URL address:
/lists/{{=item.list_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#delete-list.
- list_id
A key field. Data type: DT_I4
- list_name
Template: ShortText.
- list_email_id
Template: ShortText.
- _contacts_count
Data type: DT_I4 A read-only field.
- _import_in_progress
Data type: DT_I4 A read-only field.
- _optout_in_progress
Data type: DT_I4 A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sms/email-sms.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-allowed-emails.
- [Create] action
-
Endpoint URL address:
/sms/email-sms.Documentation: https://developers.clicksend.com/docs/rest/v3/#add-allowed-email.
- email_address_id
A key field. Data type: DT_I4
- email_address
Template: ShortText.
- from
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sms/email-sms-stripped-strings.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-stripped-string-rules.
- [Create] action
-
Endpoint URL address:
/sms/email-sms-stripped-strings.Documentation: https://developers.clicksend.com/docs/rest/v3/#create-stripped-string-rule.
- [Update] action
-
Endpoint URL address:
/sms/email-sms-stripped-strings/{{=item.rule_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#update-stripped-string-rule.
- [Delete] action
-
Endpoint URL address:
/sms/email-sms-stripped-strings/{{=item.rule_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#delete-stripped-string-rule.
- rule_id
A key field. Data type: DT_I4
- strip_string
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/email/master-templates.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-master-email-templates.
- template_id_master
A key field. Data type: DT_I4
- template_name
Template: ShortText.
- date_added
Template: DateTime. A read-only field.
- thumbnail
Field components:
-
Uses template:
ShortText. - Contains the following components: small, large.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/email/templates.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-email-templates.
- [Create] action
-
Endpoint URL address:
/email/templates.Documentation: https://developers.clicksend.com/docs/rest/v3/#create-email-template.
- [Update] action
-
Endpoint URL address:
/email/templates/{{=item.template_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#update-email-template.
- [Delete] action
-
Endpoint URL address:
/email/templates/{{=item.template_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#delete-email-template.
- template_id
A key field. Data type: DT_I4
- template_name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/email/addresses.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-allowed-email-addresses.
- [Create] action
-
Endpoint URL address:
/email/addresses.Documentation: https://developers.clicksend.com/docs/rest/v3/#create-allowed-email-address.
- [Delete] action
-
Endpoint URL address:
/email/addresses/{{=item.email_address_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#delete-allowed-email-address.
- email_address_id
A key field. Data type: DT_I4
- email_address
Template: ShortText.
- verified
Data type: DT_I4
- date_added
Template: DateTime. A read-only field.
- body
Template: LongText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/email-campaigns.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-all-email-campaigns.
- [Update] action
-
Endpoint URL address:
/email-campaigns/{{=item.email_campaign_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#update-email-campaign.
- email_campaign_id
A key field. Data type: DT_I4
- name
Template: ShortText.
- user_id
Data type: DT_I4
- subaccount_id
Data type: DT_I4
- subject
Template: ShortText.
- list_id
Data type: DT_I4
- from_email_address_id
Data type: DT_I4
- from_name
Template: ShortText.
- template_id
Data type: DT_I4
- schedule
Template: ShortText.
- status
Template: ShortText. A read-only field.
- date_added
Template: DateTime. A read-only field.
- custom_string
Template: ShortText.
- send_count
Data type: DT_I4 A read-only field.
- open_count
Data type: DT_I4 A read-only field.
- click_count
Data type: DT_I4 A read-only field.
- hard_bounce_count
Data type: DT_I4 A read-only field.
- soft_bounce_count
Data type: DT_I4 A read-only field.
- abuse_count
Data type: DT_I4 A read-only field.
- unsubscribe_count
Data type: DT_I4 A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/email/history.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-email-history.
The resource includes the fields from the History template.
- from
Template: ShortText.
- carrier
Template: ShortText.
- country
Template: ShortText.
- from_email_address_id
Data type: DT_I4
- from_name
Template: ShortText.
- to
Field components:
- An array.
- cc
Template: ShortText.
- bcc
Template: ShortText.
- subject
Template: ShortText.
- body
Template: ShortText.
- body_plain_text
Template: ShortText.
- soft_bounce_count
Data type: DT_I4
- hard_bounce_count
Data type: DT_I4
- price
Data type: DT_R8
- _attachments
Field components:
- An array.
- Contains the following components: file_name, content_type, content_disposition, content_id, _attachment_file_url.
- _currency
Template: Currency.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/automations/email/receipts.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-email-delivery-receipt-rules.
- [Create] action
-
Endpoint URL address:
/automations/email/receipts.Documentation: https://developers.clicksend.com/docs/rest/v3/#create-email-delivery-receipt-rule.
- [Update] action
-
Endpoint URL address:
/automations/email/receipts/{{=item.receipt_rule_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#update-email-delivery-receipt-rule.
- [Delete] action
-
Endpoint URL address:
/automations/email/receipts/{{=item.receipt_rule_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#delete-email-delivery-receipt-rule.
The resource includes the fields from the ReceiptRule template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/fax/receipts.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-fax-receipts.
The resource includes the fields from the Receipt template.
- subaccount_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/fax/history.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-fax-history.
The resource includes the fields from the History template.
- to
Template: ShortText.
- from
Template: ShortText.
- carrier
Template: ShortText.
- country
Template: ShortText.
- message_pages
Template: ShortText.
- from_email
Template: ShortText.
- _file_url
Template: ShortText.
- date
Template: DateTime.
- _api_username
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/automations/fax/inbound.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-fax-inbound-rules.
- [Create] action
-
Endpoint URL address:
/automations/fax/inbound.Documentation: https://developers.clicksend.com/docs/rest/v3/#create-fax-inbound-rule.
- [Update] action
-
Endpoint URL address:
/automations/fax/inbound/{{=item.inbound_rule_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#update-fax-inbound-rule.
- [Delete] action
-
Endpoint URL address:
/automations/fax/inbound/{{=item.inbound_rule_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#delete-fax-inbound-rule.
- inbound_rule_id
A key field. Data type: DT_I4
- dedicated_number
Template: ShortText.
- rule_name
Template: ShortText.
- user_id
Data type: DT_I4
- action
Template: ShortText.
- action_address
Template: ShortText.
- enabled
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/automations/fax/receipts.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-fax-delivery-receipt-rules.
- [Create] action
-
Endpoint URL address:
/automations/fax/receipts.Documentation: https://developers.clicksend.com/docs/rest/v3/#create-fax-delivery-receipt-rule.
- [Update] action
-
Endpoint URL address:
/automations/fax/receipts/{{=item.receipt_rule_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#update-fax-delivery-receipt-rule.
- [Delete] action
-
Endpoint URL address:
/automations/fax/receipts/{{=item.receipt_rule_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#delete-fax-delivery-receipt-rule.
The resource includes the fields from the ReceiptRule template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/mms-campaigns.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-all-mms-campaigns.
- [Update] action
-
Endpoint URL address:
/mms-campaigns/{{=item.mms_campaign_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#update-mms-campaign.
- mms_campaign_id
A key field. Data type: DT_I4
- name
Template: ShortText.
- user_id
Data type: DT_I4
- subaccount_id
Data type: DT_I4
- list_id
Data type: DT_I4
- from
Template: ShortText.
- subject
Template: ShortText.
- file_name
Template: ShortText.
- body
Template: ShortText.
- schedule
Data type: DT_I4
- status
Template: ShortText. A read-only field.
- date_added
Template: DateTime. A read-only field.
- custom_string
Template: ShortText.
- country
Template: ShortText.
- unsubscribe_link
Data type: DT_I4
- _total_count
Data type: DT_I4
- _list_name
Template: ShortText.
- _media_file_url
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/numbers.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-your-numbers.
- [Read available] action
-
Endpoint URL address:
/numbers/search/{{=parameters.country}}.The action has the following user-defined parameters:
- country: Required. Specify country code.
Documentation: https://developers.clicksend.com/docs/rest/v3/#view-available-numbers.
- dedicated_number
Template: ShortText.
- country
Template: ShortText.
- price
Data type: DT_R8
- _country_name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/post/letters/history.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-letter-history.
The resource includes the fields from the History template.
- address_name
Template: ShortText.
- address_line_1
Template: ShortText.
- address_line_2
Template: ShortText.
- address_city
Template: ShortText.
- address_state
Template: ShortText.
- address_postal_code
Template: ShortText.
- address_country
Template: ShortText.
- return_address_id
Data type: DT_I4
- source
Template: ShortText.
- colour
Data type: DT_I4
- duplex
Data type: DT_I4
- post_pages
Data type: DT_I4
- post_price
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/post/postcards/history.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-postcard-history.
The resource includes the fields from the History template.
- message_id_supplier
Template: ShortText.
- address_name
Template: ShortText.
- address_line_1
Template: ShortText.
- address_line_2
Template: ShortText.
- address_city
Template: ShortText.
- address_state
Template: ShortText.
- address_postal_code
Template: ShortText.
- address_country
Template: ShortText.
- return_address_id
Data type: DT_I4
- letter_file_name
Template: ShortText.
- ip_address
Template: ShortText.
- source
Template: ShortText.
- post_price
Template: ShortText.
- post_price_supplier
Template: ShortText.
- priority
Data type: DT_I4
- _file_url
Template: ShortText.
- _return_address
Template: ReturnAddress.
- _api_username
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/post/return-addresses.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-your-return-addresses.
- [Create] action
-
Endpoint URL address:
/post/return-addresses.Documentation: https://developers.clicksend.com/docs/rest/v3/#create-return-address.
- [Update] action
-
Endpoint URL address:
/post/return-addresses/{{=item.return_address_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#update-return-address.
- [Delete] action
-
Endpoint URL address:
/post/return-addresses/{{=item.return_address_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#delete-return-address.
The resource includes the fields from the ReturnAddress template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/referral/accounts.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-referral-accounts.
- referral_rule_id
Data type: DT_I4
- refered_user_id
Data type: DT_I4
- date_referred
Template: DateTime.
- percentage_referral
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/reseller/accounts.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-client-accounts.
- [Create] action
-
Endpoint URL address:
/reseller/accounts.Documentation: https://developers.clicksend.com/docs/rest/v3/#create-reseller-account.
- [Update] action
-
Endpoint URL address:
/reseller/accounts/{{=item.user_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#update-client-account.
- user_id
Data type: DT_I4
- username
Template: ShortText.
- user_email
Template: ShortText.
- active
Data type: DT_I4
- banned
Data type: DT_I4
- balance
Template: ShortText.
- user_phone
Template: ShortText.
- reply_to
Template: ShortText.
- delivery_to
Template: ShortText.
- user_first_name
Template: ShortText.
- user_last_name
Template: ShortText.
- account
Data type: DT_I4
- account_name
Template: ShortText.
- account_billing_email
Template: ShortText.
- account_billing_mobile
Template: ShortText.
- country
Template: ShortText.
- default_country_sms
Template: ShortText.
- unsubscribe_mail
Data type: DT_I4
- auto_recharge
Data type: DT_I4
- auto_recharge_amount
Template: ShortText.
- low_credit_amount
Template: ShortText.
- setting_unicode_sms
Data type: DT_I4
- setting_beta
Data type: DT_I4
- setting_email_sms_subject
Data type: DT_I4
- setting_fix_sender_id
Data type: DT_I4
- setting_sms_message_char_limit
Data type: DT_I4
- _currency
Template: Currency. A read-only field.
- _subaccount
Template: Subaccount. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sms/receipts.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-sms-receipts.
The resource includes the fields from the Receipt template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sms/inbound.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-inbound-sms.
- timestamp
Template: DateTime.
- from
Template: ShortText.
- body
Template: ShortText.
- original_body
Template: ShortText.
- original_message_id
Template: ShortText.
- to
Template: ShortText.
- custom_string
Template: ShortText.
- message_id
Template: ShortText.
- _keyword
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sms/templates.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-sms-templates.
- [Create] action
-
Endpoint URL address:
/sms/templates.Documentation: https://developers.clicksend.com/docs/rest/v3/#create-sms-template.
- [Update] action
-
Endpoint URL address:
/sms/templates/{{=item.template_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#update-sms-template.
- [Delete] action
-
Endpoint URL address:
/sms/templates/{{=item.template_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#delete-sms-template.
- template_id
A key field. Data type: DT_I4
- body
Template: LongText.
- template_name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sms/history.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-sms-history.
The resource includes the fields from the History template.
- direction
Template: ShortText.
- date
Template: DateTime.
- to
Template: ShortText.
- body
Template: ShortText.
- from
Template: ShortText.
- error_code
Template: ShortText.
- error_text
Template: ShortText.
- message_parts
Data type: DT_R8
- from_email
Template: ShortText.
- contact_id
Data type: DT_I4
- country
Template: ShortText.
- carrier
Template: ShortText.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- _api_username
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sms-campaigns.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-sms-campaigns.
- [Update] action
-
Endpoint URL address:
/sms-campaigns/{{=item.sms_campaign_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#update-sms-campaign.
- sms_campaign_id
A key field. Data type: DT_I4
- name
Template: ShortText.
- user_id
Data type: DT_I4
- subaccount_id
Data type: DT_I4
- list_id
Data type: DT_I4
- from
Template: ShortText.
- body
Template: LongText.
- schedule
Template: ShortText.
- status
Template: ShortText.
- date_added
Template: DateTime. A read-only field.
- ip_address
Template: ShortText.
- custom_string
Template: ShortText.
- source
Template: ShortText.
- _total_count
Data type: DT_I4 A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/automations/sms/inbound.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-sms-inbound-automations.
- [Create] action
-
Endpoint URL address:
/automations/sms/inbound.Documentation: https://developers.clicksend.com/docs/rest/v3/#create-sms-inbound-automation.
- [Update] action
-
Endpoint URL address:
/automations/sms/inbound/{{=item.inbound_rule_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#update-sms-inbound-automation.
- [Delete] action
-
Endpoint URL address:
/automations/sms/inbound/{{=item.inbound_rule_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#delete-sms-inbound-automation.
- inbound_rule_id
A key field. Data type: DT_I4
- dedicated_number
Template: ShortText.
- rule_name
Template: ShortText.
- message_search_type
Data type: DT_I4
- message_search_term
Template: ShortText.
- action
Template: ShortText.
- action_address
Template: ShortText.
- body
Template: LongText.
- enabled
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/automations/sms/receipts.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-sms-delivery-receipt-rules.
- [Create] action
-
Endpoint URL address:
/automations/sms/receipts.Documentation: https://developers.clicksend.com/docs/rest/v3/#create-sms-delivery-receipt-rule.
- [Update] action
-
Endpoint URL address:
/automations/sms/receipts/{{=item.receipt_rule_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#update-sms-delivery-receipt-rule.
- [Delete] action
-
Endpoint URL address:
/automations/sms/receipts/{{=item.receipt_rule_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#delete-sms-delivery-receipt-rule.
The resource includes the fields from the ReceiptRule template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/subaccounts.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-subaccounts.
- [Create] action
-
Endpoint URL address:
/subaccounts.Documentation: https://developers.clicksend.com/docs/rest/v3/#create-subaccount.
- [Update] action
-
Endpoint URL address:
/subaccounts/{{=item.subaccount_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#update-subaccount.
- [Delete] action
-
Endpoint URL address:
/subaccounts/{{=item.subaccount_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#delete-subaccount.
The resource includes the fields from the Subaccount template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/voice/receipts.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-voice-receipts.
The resource includes the fields from the Receipt template.
- digits
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/voice/history.Documentation: https://developers.clicksend.com/docs/rest/v3/#get-voice-history.
The resource includes the fields from the History template.
- to
Template: ShortText.
- to_type
Template: ShortText.
- from
Template: ShortText.
- voice
Template: ShortText.
- lang
Template: ShortText.
- body
Template: LongText.
- carrier
Template: ShortText.
- country
Template: ShortText.
- message_parts
Template: ShortText.
- digits
Template: ShortText.
- machine_detected
Data type: DT_I4
- require_input
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/automations/voice/receipts.Documentation: https://developers.clicksend.com/docs/rest/v3/#view-voice-delivery-receipt-rules.
- [Create] action
-
Endpoint URL address:
/automations/voice/receipts.Documentation: https://developers.clicksend.com/docs/rest/v3/#create-voice-delivery-receipt-rule.
- [Update] action
-
Endpoint URL address:
/automations/voice/receipts/{{=item.receipt_rule_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#update-voice-delivery-receipt-rule.
- [Delete] action
-
Endpoint URL address:
/automations/voice/receipts/{{=item.receipt_rule_id}}.Documentation: https://developers.clicksend.com/docs/rest/v3/#delete-voice-delivery-receipt-rule.
The resource includes the fields from the ReceiptRule template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/delivery-issues.Documentation: https://developers.clicksend.com/docs/rest/v3/#delivery-issues.
- [Create] action
-
Endpoint URL address:
/delivery-issues.Documentation: https://developers.clicksend.com/docs/rest/v3/#delivery-issues-2.
- issue_id
A key field. Data type: DT_I4
- user_id
Data type: DT_I4
- message_id
Template: ShortText.
- type
Template: ShortText.
- description
Template: ShortText.
- client_comments
Template: ShortText.
- support_comments
Template: ShortText.
- status
Template: ShortText.
- date_added
Template: DateTime. A read-only field.
- resolved
Data type: DT_I4
- email_address
Template: ShortText.
- [Read] action
-
The result is extracted from:{{=response.data.data}}.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=new Date(parseFloat(value) * 1000).toUTCString()}}expression.- ReturnAddress
Field components:
-
Uses template:
ShortText. - Contains the following components: return_address_id, user_id, address_name, address_line_1, address_line_2, address_city, address_state, address_postal_code, address_country.
-
Uses template:
- Currency
Field components:
-
Uses template:
ShortText. - Contains the following components: currency_name_short, currency_prefix_d, currency_prefix_c, currency_name_long.
-
Uses template:
- ReceiptRule
Field components:
-
Uses template:
ShortText. - Contains the following components: receipt_rule_id, rule_name, match_type, action, action_address, enabled.
-
Uses template:
- Subaccount
Field components:
-
Uses template:
ShortText. - Contains the following components: subaccount_id, api_username, email, phone_number, first_name, last_name, api_key, access_users, access_billing, access_reporting, access_contacts, access_settings, access_sms, access_email, access_voice, access_fax, access_post, access_reseller, access_mms, share_campaigns, notes.
-
Uses template:
- Receipt
Field components:
-
Uses template:
DateTime. - Contains the following components: timestamp_send, timestamp, message_id, status_code, status_text, error_code, error_text, custom_string, message_type.
-
Uses template:
- History
Field components:
-
Uses template:
ShortText. - Contains the following components: user_id, subaccount_id, list_id, message_id, custom_string, schedule, message_price, status, status_code, status_text, date_added.
-
Uses template:
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.