Clicksend v3 API
The generated SDK relies on Node Package Manager (NPM) being available to resolve dependencies. If you don't already have NPM installed, please go ahead and follow instructions to install NPM from here. The SDK also requires Node to be installed. If Node isn't already installed, please install it from here
NPM is installed by default when Node is installed
To check if node and npm have been successfully installed, write the following commands in command prompt:
node --versionnpm -versionNow use npm to resolve all dependencies by running the following command in the root directory (of the SDK folder):
npm install
This will install all dependencies in the node_modules folder.
Once dependencies are resolved, you will need to move the folder ClickSend in to your node_modules folder.
The following section explains how to use the library in a new project.
Open an IDE/Text Editor for JavaScript like Sublime Text. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
Click on File and select Open Folder.
Select the folder of your SDK and click on Select Folder to open it up in Sublime Text. The folder will become visible in the bar on the left.
Now right click on the folder name and select the New File option to create a new test file. Save it as index.js Now import the generated NodeJS library using the following lines of code:
var lib = require('lib');
Save changes.
To run the index.js file, open up the command prompt and navigate to the Path where the SDK folder resides. Type the following command to run the file:
node index.js
These tests use Mocha framework for testing, coupled with Chai for assertions. These dependencies need to be installed for tests to run. Tests can be run in a number of ways:
mocha --recursive to run all the tests.../test/Controllers/ directory from command prompt.mocha * to run all the tests.../test/Controllers/ directory from command prompt.mocha ClickSend v3 APIController to run all the tests in that controller file.To increase mocha's default timeout, you can change the
TEST_TIMEOUTparameter's value inTestBootstrap.js.
In order to setup authentication in the API client, you need the following information.
| Parameter | Description |
|---|---|
| username | your username |
| key | your api key |
API client can be initialized as following:
const lib = require('lib');
// Configuration parameters and credentials
lib.Configuration.username = "username"; // your username
lib.Configuration.key = "key"; // your api key
CountriesControllerThe singleton instance of the CountriesController class can be accessed from the API Client.
var controller = lib.CountriesController;
getCountriesTags:
Skips Authentication
Get all countries
function getCountries(callback)
controller.getCountries(function(error, response, context) {
});
The singleton instance of the SMSController class can be accessed from the API Client.
var controller = lib.SMSController;
Send one or more SMS messages
function sendSms(smsMessages, callback)
| Parameter | Tags | Description |
|---|---|---|
| smsMessages | Required | SmsMessageCollection model |
var smsMessages = new SmsMessageCollection({"key":"value"});
controller.sendSms(smsMessages, function(error, response, context) {
});
Calculate sms price
function calculatePrice(smsMessages, callback)
| Parameter | Tags | Description |
|---|---|---|
| smsMessages | Required | SmsMessageCollection model |
var smsMessages = new SmsMessageCollection({"key":"value"});
controller.calculatePrice(smsMessages, function(error, response, context) {
});
Export all sms history
function exportHistory(filename, callback)
| Parameter | Tags | Description |
|---|---|---|
| filename | Required | Filename to download history as |
var filename = 'filename';
controller.exportHistory(filename, function(error, response, context) {
});
Add a delivery receipt
function createReceipt(url, callback)
| Parameter | Tags | Description |
|---|---|---|
| url | Required | Your url |
var url = 'url';
controller.createReceipt(url, function(error, response, context) {
});
Marked delivery receipts as read
function markReceiptsAsRead(dateBefore, callback)
| Parameter | Tags | Description |
|---|---|---|
| dateBefore | Optional | Mark all as read before this timestamp |
var dateBefore = date_before;
controller.markReceiptsAsRead(dateBefore, function(error, response, context) {
});
Get all inbound sms
function getInboundSms(callback)
controller.getInboundSms(function(error, response, context) {
});
Create inbound sms
function createInboundSms(url, callback)
| Parameter | Tags | Description |
|---|---|---|
| url | Required | Your url |
var url = 'url';
controller.createInboundSms(url, function(error, response, context) {
});
Update scheduled message as cancel
function cancelScheduledSms(messageId, callback)
| Parameter | Tags | Description |
|---|---|---|
| messageId | Required | The message ID you want to cancel |
var messageId = message_id;
controller.cancelScheduledSms(messageId, function(error, response, context) {
});
Update all scheduled message as cancelled
function cancelAllScheduledSms(callback)
controller.cancelAllScheduledSms(function(error, response, context) {
});
Create sms template
function createSmsTemplate(smsTemplate, callback)
| Parameter | Tags | Description |
|---|---|---|
| smsTemplate | Required | SmsTemplate model |
var smsTemplate = new SmsTemplate({"key":"value"});
controller.createSmsTemplate(smsTemplate, function(error, response, context) {
});
Delete sms template
function deleteSmsTemplate(templateId, callback)
| Parameter | Tags | Description |
|---|---|---|
| templateId | Required | Template id |
var templateId = 145;
controller.deleteSmsTemplate(templateId, function(error, response, context) {
});
Update sms template
function updateSmsTemplate(templateId, smsTemplate, callback)
| Parameter | Tags | Description |
|---|---|---|
| templateId | Required | Template id |
| smsTemplate | Required | Template item |
var templateId = 145;
var smsTemplate = new SmsTemplate({"key":"value"});
controller.updateSmsTemplate(templateId, smsTemplate, function(error, response, context) {
});
Get all delivery receipts
function getDeliveryReceipts(callback)
controller.getDeliveryReceipts(function(error, response, context) {
});
Get lists of all sms templates
function getSmsTemplates(callback)
controller.getSmsTemplates(function(error, response, context) {
});
Mark all inbound SMS as read optionally before a certain date
function markAllInboundSMSAsRead(dateBefore, callback)
| Parameter | Tags | Description |
|---|---|---|
| dateBefore | Optional | An optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read. |
var dateBefore = date_before;
controller.markAllInboundSMSAsRead(dateBefore, function(error, response, context) {
});
Get a Specific Delivery Receipt
function getSpecificDeliveryReceipt(messageId, callback)
| Parameter | Tags | Description |
|---|---|---|
| messageId | Required | Message ID |
var messageId = message_id;
controller.getSpecificDeliveryReceipt(messageId, function(error, response, context) {
});
Get all sms history
function getSmsHistory(dateFrom, dateTo, callback)
| Parameter | Tags | Description |
|---|---|---|
| dateFrom | Optional | Start date |
| dateTo | Optional | End date |
var dateFrom = 145;
var dateTo = 145;
controller.getSmsHistory(dateFrom, dateTo, function(error, response, context) {
});
The singleton instance of the VoiceController class can be accessed from the API Client.
var controller = lib.VoiceController;
Send a voice call
function sendVoice(voiceMessages, callback)
| Parameter | Tags | Description |
|---|---|---|
| voiceMessages | Required | VoiceMessageCollection model |
var voiceMessages = new VoiceMessageCollection({"key":"value"});
controller.sendVoice(voiceMessages, function(error, response, context) {
});
Calculate voice price
function calculatePrice(voiceMessages, callback)
| Parameter | Tags | Description |
|---|---|---|
| voiceMessages | Required | VoiceMessageCollection model |
var voiceMessages = new VoiceMessageCollection({"key":"value"});
controller.calculatePrice(voiceMessages, function(error, response, context) {
});
Get all voice languages
function getVoiceLanguages(callback)
controller.getVoiceLanguages(function(error, response, context) {
});
Get all voice receipts
function getVoiceReceipts(callback)
controller.getVoiceReceipts(function(error, response, context) {
});
Update voice message status as cancelled
function cancelVoiceMessage(messageId, callback)
| Parameter | Tags | Description |
|---|---|---|
| messageId | Required | Your voice message id |
var messageId = message_id;
controller.cancelVoiceMessage(messageId, function(error, response, context) {
});
Update all voice messages as cancelled
function cancelVoiceMessages(callback)
controller.cancelVoiceMessages(function(error, response, context) {
});
Export voice history
function exportVoiceHistory(filename, callback)
| Parameter | Tags | Description |
|---|---|---|
| filename | Required | Filename to export to |
var filename = 'filename';
controller.exportVoiceHistory(filename, function(error, response, context) {
});
Get all voice history
function getVoiceHistory(dateFrom, dateTo, callback)
| Parameter | Tags | Description |
|---|---|---|
| dateFrom | Optional | Timestamp (from) used to show records by date. |
| dateTo | Optional | Timestamp (to) used to show records by date |
var dateFrom = 145;
var dateTo = 145;
controller.getVoiceHistory(dateFrom, dateTo, function(error, response, context) {
});
The singleton instance of the AccountController class can be accessed from the API Client.
var controller = lib.AccountController;
Get account details
function getAccount(callback)
controller.getAccount(function(error, response, context) {
});
Create An Account
function createAccount(account, callback)
| Parameter | Tags | Description |
|---|---|---|
| account | Required | Account model |
var account = new Account({"key":"value"});
controller.createAccount(account, function(error, response, context) {
});
Send account activation token
function accountVerifySend(accountVerify, callback)
| Parameter | Tags | Description |
|---|---|---|
| accountVerify | Required | Account details |
var accountVerify = new AccountVerify({"key":"value"});
controller.accountVerifySend(accountVerify, function(error, response, context) {
});
Verify new account
function accountVerify(activationToken, callback)
| Parameter | Tags | Description |
|---|---|---|
| activationToken | Required | TODO: Add a parameter description |
var activationToken = 145;
controller.accountVerify(activationToken, function(error, response, context) {
});
Tags:
Skips Authentication
Forgot username
function forgotUsername(email, callback)
| Parameter | Tags | Description |
|---|---|---|
Required | Email belonging to account |
var email = 'email';
controller.forgotUsername(email, function(error, response, context) {
});
Forgot password
function forgotPassword(username, callback)
| Parameter | Tags | Description |
|---|---|---|
| username | Required | Username belonging to account |
var username = 'username';
controller.forgotPassword(username, function(error, response, context) {
});
Verify forgot password
function verifyForgotPassword(verifyPassword, callback)
| Parameter | Tags | Description |
|---|---|---|
| verifyPassword | Required | verifyPassword data |
var verifyPassword = new AccountForgotPasswordVerify({"key":"value"});
controller.verifyForgotPassword(verifyPassword, function(error, response, context) {
});
The singleton instance of the SubaccountController class can be accessed from the API Client.
var controller = lib.SubaccountController;
Get all subaccounts
function getSubaccounts(callback)
controller.getSubaccounts(function(error, response, context) {
});
Create new subaccount
function createSubaccount(subaccount, callback)
| Parameter | Tags | Description |
|---|---|---|
| subaccount | Required | Subaccount model |
var subaccount = new Subaccount({"key":"value"});
controller.createSubaccount(subaccount, function(error, response, context) {
});
Get specific subaccount
function getSubaccount(subaccountId, callback)
| Parameter | Tags | Description |
|---|---|---|
| subaccountId | Required | ID of subaccount to get |
var subaccountId = 103;
controller.getSubaccount(subaccountId, function(error, response, context) {
});
Delete a subaccount
function deleteSubaccount(subaccountId, callback)
| Parameter | Tags | Description |
|---|---|---|
| subaccountId | Required | ID of subaccount to delete |
var subaccountId = 103;
controller.deleteSubaccount(subaccountId, function(error, response, context) {
});
Regenerate an API Key
function regenerateApiKey(subaccountId, callback)
| Parameter | Tags | Description |
|---|---|---|
| subaccountId | Required | ID of subaccount to regenerate API key for |
var subaccountId = 103;
controller.regenerateApiKey(subaccountId, function(error, response, context) {
});
Update subaccount
function updateSubaccount(subaccountId, subaccount, callback)
| Parameter | Tags | Description |
|---|---|---|
| subaccountId | Required | ID of subaccount to update |
| subaccount | Required | Subaccount model |
var subaccountId = 103;
var subaccount = new Subaccount({"key":"value"});
controller.updateSubaccount(subaccountId, subaccount, function(error, response, context) {
});
The singleton instance of the ContactListController class can be accessed from the API Client.
var controller = lib.ContactListController;
Get all contact lists
function getContactLists(callback)
controller.getContactLists(function(error, response, context) {
});
Create new contact list
function createContactList(listName, callback)
| Parameter | Tags | Description |
|---|---|---|
| listName | Required | Your contact list name |
var listName = list_name;
controller.createContactList(listName, function(error, response, context) {
});
Get specific contact list
function getContactList(listId, callback)
| Parameter | Tags | Description |
|---|---|---|
| listId | Required | List ID |
var listId = 103;
controller.getContactList(listId, function(error, response, context) {
});
Delete a specific contact list
function deleteContactList(listId, callback)
| Parameter | Tags | Description |
|---|---|---|
| listId | Required | List ID |
var listId = 103;
controller.deleteContactList(listId, function(error, response, context) {
});
Remove duplicate contacts
function removeDuplicateContacts(listId, callback)
| Parameter | Tags | Description |
|---|---|---|
| listId | Required | Your list id |
var listId = 103;
controller.removeDuplicateContacts(listId, function(error, response, context) {
});
Update specific contact list
function updateContactList(listId, listName, callback)
| Parameter | Tags | Description |
|---|---|---|
| listId | Required | Your list id |
| listName | Required | Your new list name |
var listId = 103;
var listName = list_name;
controller.updateContactList(listId, listName, function(error, response, context) {
});
Import contacts to list
function importContactsToList(listId, file, callback)
| Parameter | Tags | Description |
|---|---|---|
| listId | Required | Your contact list id you want to access. |
| file | Required | ContactListImport model |
var listId = 103;
var file = new ContactListImport({"key":"value"});
controller.importContactsToList(listId, file, function(error, response, context) {
});
The singleton instance of the ContactController class can be accessed from the API Client.
var controller = lib.ContactController;
Get all contacts in a list
function getContacts(listId, callback)
| Parameter | Tags | Description |
|---|---|---|
| listId | Required | Contact list ID |
var listId = 103;
controller.getContacts(listId, function(error, response, context) {
});
Create new contact
function createContact(contact, listId, callback)
| Parameter | Tags | Description |
|---|---|---|
| contact | Required | Contact model |
| listId | Required | List id |
var contact = new Contact({"key":"value"});
var listId = 103;
controller.createContact(contact, listId, function(error, response, context) {
});
Get a specific contact
function getContact(listId, contactId, callback)
| Parameter | Tags | Description |
|---|---|---|
| listId | Required | Your contact list id you want to access. |
| contactId | Required | Your contact id you want to access. |
var listId = 103;
var contactId = 103;
controller.getContact(listId, contactId, function(error, response, context) {
});
Update contact
function updateContact(listId, contactId, contact, callback)
| Parameter | Tags | Description |
|---|---|---|
| listId | Required | Contact list id |
| contactId | Required | Contact ID |
| contact | Required | Contact model |
var listId = 103;
var contactId = 103;
var contact = new Contact({"key":"value"});
controller.updateContact(listId, contactId, contact, function(error, response, context) {
});
Remove all opted out contacts
function removeOptedOutContacts(listId, optOutListId, callback)
| Parameter | Tags | Description |
|---|---|---|
| listId | Required | Your list id |
| optOutListId | Required | Your opt out list id |
var listId = 103;
var optOutListId = 103;
controller.removeOptedOutContacts(listId, optOutListId, function(error, response, context) {
});
Delete a contact
function deleteContact(listId, contactId, callback)
| Parameter | Tags | Description |
|---|---|---|
| listId | Required | List ID |
| contactId | Required | Contact ID |
var listId = 103;
var contactId = 103;
controller.deleteContact(listId, contactId, function(error, response, context) {
});
The singleton instance of the NumberController class can be accessed from the API Client.
var controller = lib.NumberController;
Get all dedicated numbers
function getDedicatedNumbers(callback)
controller.getDedicatedNumbers(function(error, response, context) {
});
Buy dedicated number
function purchaseDedicatedNumber(dedicatedNumber, callback)
| Parameter | Tags | Description |
|---|---|---|
| dedicatedNumber | Required | Phone number to purchase |
var dedicatedNumber = dedicated_number;
controller.purchaseDedicatedNumber(dedicatedNumber, function(error, response, context) {
});
Get all dedicated numbers by country
function getDedicatedNumbersByCountry(country, search, searchType, callback)
| Parameter | Tags | Description |
|---|---|---|
| country | Required | Country code to search |
| search | Optional | Your search pattern or query. |
| searchType | Optional | Your strategy for searching, 0 = starts with, 1 = anywhere, 2 = ends with. |
var country = 'country';
var search = 'search';
var searchType = 103;
controller.getDedicatedNumbersByCountry(country, search, searchType, function(error, response, context) {
});
The singleton instance of the StatisticsController class can be accessed from the API Client.
var controller = lib.StatisticsController;
Get voice statistics
function getVoiceStatistics(callback)
controller.getVoiceStatistics(function(error, response, context) {
});
Get sms statistics
function getSmsStatistics(callback)
controller.getSmsStatistics(function(error, response, context) {
});
The singleton instance of the EmailToSmsController class can be accessed from the API Client.
var controller = lib.EmailToSmsController;
Create email to sms allowed address
function createAllowedAddress(emailSmsAddress, callback)
| Parameter | Tags | Description |
|---|---|---|
| emailSmsAddress | Required | EmailSMSAddress model |
var emailSmsAddress = new EmailSMSAddress({"key":"value"});
controller.createAllowedAddress(emailSmsAddress, function(error, response, context) {
});
Get list of email to sms allowed addresses
function getAllowedAddress(callback)
controller.getAllowedAddress(function(error, response, context) {
});
The singleton instance of the SearchController class can be accessed from the API Client.
var controller = lib.SearchController;
Get list of searched contact list
function searchContactList(q, callback)
| Parameter | Tags | Description |
|---|---|---|
| q | Required | Your keyword or query. |
var q = 'q';
controller.searchContactList(q, function(error, response, context) {
});
The singleton instance of the ReferralAccountController class can be accessed from the API Client.
var controller = lib.ReferralAccountController;
Get all referral accounts
function getReferralAccounts(callback)
controller.getReferralAccounts(function(error, response, context) {
});
The singleton instance of the ResellerAccountController class can be accessed from the API Client.
var controller = lib.ResellerAccountController;
Get list of reseller accounts
function getResellerAccounts(callback)
controller.getResellerAccounts(function(error, response, context) {
});
Create reseller account
function createResellerAccount(resellerAccount, callback)
| Parameter | Tags | Description |
|---|---|---|
| resellerAccount | Required | ResellerAccount model |
var resellerAccount = new ResellerAccount({"key":"value"});
controller.createResellerAccount(resellerAccount, function(error, response, context) {
});
Get Reseller Account
function getResellerAccount(clientUserId, callback)
| Parameter | Tags | Description |
|---|---|---|
| clientUserId | Required | User ID of client |
var clientUserId = 103;
controller.getResellerAccount(clientUserId, function(error, response, context) {
});
Reseller Account
function updateResellerAccount(clientUserId, resellerAccount, callback)
| Parameter | Tags | Description |
|---|---|---|
| clientUserId | Required | User ID of client |
| resellerAccount | Required | ResellerAccount model |
var clientUserId = 103;
var resellerAccount = new ResellerAccount({"key":"value"});
controller.updateResellerAccount(clientUserId, resellerAccount, function(error, response, context) {
});
The singleton instance of the TransferCreditController class can be accessed from the API Client.
var controller = lib.TransferCreditController;
Transfer Credit
function transferCredit(resellerAccountTransferCredit, callback)
| Parameter | Tags | Description |
|---|---|---|
| resellerAccountTransferCredit | Required | ResellerAccountTransferCredit model |
var resellerAccountTransferCredit = new ResellerAccountTransferCredit({"key":"value"});
controller.transferCredit(resellerAccountTransferCredit, function(error, response, context) {
});
The singleton instance of the AccountRechargeController class can be accessed from the API Client.
var controller = lib.AccountRechargeController;
Get Credit Card info
function getCreditCardInfo(callback)
controller.getCreditCardInfo(function(error, response, context) {
});
Update credit card info
function updateCreditCardInfo(creditCard, callback)
| Parameter | Tags | Description |
|---|---|---|
| creditCard | Required | CreditCard model |
var creditCard = new CreditCard({"key":"value"});
controller.updateCreditCardInfo(creditCard, function(error, response, context) {
});
Get list of all packages
function getPackagesList(country, callback)
| Parameter | Tags | Description |
|---|---|---|
| country | Optional | Country code |
var country = 'country';
controller.getPackagesList(country, function(error, response, context) {
});
Purchase a package
function purchasePackage(packageId, callback)
| Parameter | Tags | Description |
|---|---|---|
| packageId | Required | ID of package to purchase |
var packageId = 103;
controller.purchasePackage(packageId, function(error, response, context) {
});
Get all transactions
function getTransactions(callback)
controller.getTransactions(function(error, response, context) {
});
Get specific Transaction
function getTransaction(transactionId, callback)
| Parameter | Tags | Description |
|---|---|---|
| transactionId | Required | ID of transaction to retrieve |
var transactionId = transaction_id;
controller.getTransaction(transactionId, function(error, response, context) {
});
The singleton instance of the SmsCampaignController class can be accessed from the API Client.
var controller = lib.SmsCampaignController;
Create sms campaign
function createSmsCampaign(campaign, callback)
| Parameter | Tags | Description |
|---|---|---|
| campaign | Required | SmsCampaign model |
var campaign = new SmsCampaign({"key":"value"});
controller.createSmsCampaign(campaign, function(error, response, context) {
});
Calculate price for sms campaign
function calculatePrice(campaign, callback)
| Parameter | Tags | Description |
|---|---|---|
| campaign | Required | SmsCampaign model |
var campaign = new SmsCampaign({"key":"value"});
controller.calculatePrice(campaign, function(error, response, context) {
});
Update sms campaign
function updateSmsCampaign(smsCampaignId, campaign, callback)
| Parameter | Tags | Description |
|---|---|---|
| smsCampaignId | Required | ID of SMS campaign to update |
| campaign | Required | SmsCampaign model |
var smsCampaignId = 103;
var campaign = new SmsCampaign({"key":"value"});
controller.updateSmsCampaign(smsCampaignId, campaign, function(error, response, context) {
});
Cancel sms campaign
function cancelSmsCampaign(smsCampaignId, callback)
| Parameter | Tags | Description |
|---|---|---|
| smsCampaignId | Required | ID of SMS Campaign to cancel |
var smsCampaignId = 103;
controller.cancelSmsCampaign(smsCampaignId, function(error, response, context) {
});
Get list of sms campaigns
function getSmsCampaigns(callback)
controller.getSmsCampaigns(function(error, response, context) {
});
Get specific sms campaign
function getSmsCampaign(smsCampaignId, callback)
| Parameter | Tags | Description |
|---|---|---|
| smsCampaignId | Required | ID of SMS campaign to retrieve |
var smsCampaignId = 103;
controller.getSmsCampaign(smsCampaignId, function(error, response, context) {
});
The singleton instance of the PostLetterController class can be accessed from the API Client.
var controller = lib.PostLetterController;
Send post letter
function sendPostLetter(postLetter, callback)
| Parameter | Tags | Description |
|---|---|---|
| postLetter | Required | PostLetter model |
var postLetter = new PostLetter({"key":"value"});
controller.sendPostLetter(postLetter, function(error, response, context) {
});
Calculate post letter price
function calculatePrice(postLetter, callback)
| Parameter | Tags | Description |
|---|---|---|
| postLetter | Required | PostLetter model |
var postLetter = new PostLetter({"key":"value"});
controller.calculatePrice(postLetter, function(error, response, context) {
});
Get all post letter history
function getPostLetterHistory(callback)
controller.getPostLetterHistory(function(error, response, context) {
});
export post letter history
function exportPostLetterHistory(filename, callback)
| Parameter | Tags | Description |
|---|---|---|
| filename | Required | Filename to export to |
var filename = 'filename';
controller.exportPostLetterHistory(filename, function(error, response, context) {
});
The singleton instance of the PostReturnAddressController class can be accessed from the API Client.
var controller = lib.PostReturnAddressController;
Create post return address
function createPostReturnAddress(returnAddress, callback)
| Parameter | Tags | Description |
|---|---|---|
| returnAddress | Required | Address model |
var returnAddress = new Address({"key":"value"});
controller.createPostReturnAddress(returnAddress, function(error, response, context) {
});
Get list of post return addresses
function getPostReturnAddresses(callback)
controller.getPostReturnAddresses(function(error, response, context) {
});
Get specific post return address
function getPostReturnAddress(returnAddressId, callback)
| Parameter | Tags | Description |
|---|---|---|
| returnAddressId | Required | Return address ID |
var returnAddressId = 103;
controller.getPostReturnAddress(returnAddressId, function(error, response, context) {
});
Update post return address
function updatePostReturnAddress(returnAddressId, returnAddress, callback)
| Parameter | Tags | Description |
|---|---|---|
| returnAddressId | Required | Return address ID |
| returnAddress | Required | Address model |
var returnAddressId = 103;
var returnAddress = new Address({"key":"value"});
controller.updatePostReturnAddress(returnAddressId, returnAddress, function(error, response, context) {
});
Delete specific post return address
function deletePostReturnAddress(returnAddressId, callback)
| Parameter | Tags | Description |
|---|---|---|
| returnAddressId | Required | Return address ID |
var returnAddressId = 103;
controller.deletePostReturnAddress(returnAddressId, function(error, response, context) {
});
The singleton instance of the FaxController class can be accessed from the API Client.
var controller = lib.FaxController;
Get List of Fax Receipts
function faxReceiptList(callback)
controller.faxReceiptList(function(error, response, context) {
});
Get a single fax receipt based on message id.
function getFaxReceipt(messageId, callback)
| Parameter | Tags | Description |
|---|---|---|
| messageId | Required | ID of the message receipt to retrieve |
var messageId = message_id;
controller.getFaxReceipt(messageId, function(error, response, context) {
});
Get a list of Fax History.
function getFaxHistory(dateFrom, dateTo, q, order, callback)
| Parameter | Tags | Description |
|---|---|---|
| dateFrom | Optional | Customize result by setting from date (timestsamp) Example: 1457572619. |
| dateTo | Optional | Customize result by setting to date (timestamp) Example: 1457573000. |
| q | Optional | Custom query Example: status:Sent,status_code:201. |
| order | Optional | Order result by Example: date_added:desc,list_id:desc. |
var dateFrom = 103;
var dateTo = 103;
var q = 'q';
var order = 'order';
controller.getFaxHistory(dateFrom, dateTo, q, order, function(error, response, context) {
});
Calculate Total Price for Fax Messages sent
function calculatePrice(faxMessage, callback)
| Parameter | Tags | Description |
|---|---|---|
| faxMessage | Required | FaxMessageCollection model |
var faxMessage = new FaxMessageCollection({"key":"value"});
controller.calculatePrice(faxMessage, function(error, response, context) {
});
Send a fax using supplied supported file-types.
function sendFax(faxMessage, callback)
| Parameter | Tags | Description |
|---|---|---|
| faxMessage | Required | FaxMessageCollection model |
var faxMessage = new FaxMessageCollection({"key":"value"});
controller.sendFax(faxMessage, function(error, response, context) {
});
The singleton instance of the MMSController class can be accessed from the API Client.
var controller = lib.MMSController;
TODO: Add a method description
function sendMMS(mmsMessages, callback)
| Parameter | Tags | Description |
|---|---|---|
| mmsMessages | Required | MmsMessageCollection model |
var mmsMessages = new MmsMessageCollection({"key":"value"});
controller.sendMMS(mmsMessages, function(error, response, context) {
});
Get Price for MMS sent
function getPrice(mmsMessages, callback)
| Parameter | Tags | Description |
|---|---|---|
| mmsMessages | Required | MmsMessageCollection model |
var mmsMessages = new MmsMessageCollection({"key":"value"});
controller.getPrice(mmsMessages, function(error, response, context) {
});
The singleton instance of the PostPostcardController class can be accessed from the API Client.
var controller = lib.PostPostcardController;
Send one or more postcards
function sendPostcard(postPostcards, callback)
| Parameter | Tags | Description |
|---|---|---|
| postPostcards | Required | PostPostcard model |
var postPostcards = new PostPostcard({"key":"value"});
controller.sendPostcard(postPostcards, function(error, response, context) {
});
Calculate price for sending one or more postcards
function calculatePrice(postPostcards, callback)
| Parameter | Tags | Description |
|---|---|---|
| postPostcards | Required | PostPostcard model |
var postPostcards = new PostPostcard({"key":"value"});
controller.calculatePrice(postPostcards, function(error, response, context) {
});
Retrieve the history of postcards sent or scheduled
function getPostcardHistory(callback)
controller.getPostcardHistory(function(error, response, context) {
});
Export postcard history to a CSV file
function exportPostcardHistory(filename, callback)
| Parameter | Tags | Description |
|---|---|---|
| filename | Required | Filename to export to |
var filename = 'filename';
controller.exportPostcardHistory(filename, function(error, response, context) {
});
The singleton instance of the UploadController class can be accessed from the API Client.
var controller = lib.UploadController;
Upload a file
function uploadFile(file, convert, callback)
| Parameter | Tags | Description |
|---|---|---|
| file | Required | The file to be uploaded |
| convert | Required | The product that this file will be used with e.g. 'fax', 'mms', 'csv' or 'post' |
TestHelper.getFilePath('url', function(data) {
var file = data;
var convert = 'convert';
controller.uploadFile(file, convert, function(error, response, context) {
});
});
TODO: Add a method description
function uploadFile1(content, convert, callback)
| Parameter | Tags | Description |
|---|---|---|
| content | Required | Base64-encoded file contents |
| convert | Required | TODO: Add a parameter description |
var content = 'content';
var convert = 'convert';
controller.uploadFile1(content, convert, function(error, response, context) {
});
The singleton instance of the PostDirectMailController class can be accessed from the API Client.
var controller = lib.PostDirectMailController;
Search for a location
function locationSearch(country, q, callback)
| Parameter | Tags | Description |
|---|---|---|
| country | Required | Country Code to search |
| q | Required | Search term (e.g. post code, city name) |
var country = 'country';
var q = 'q';
controller.locationSearch(country, q, function(error, response, context) {
});
TODO: Add a method description
function sendCampaign(postDirectMail, callback)
| Parameter | Tags | Description |
|---|---|---|
| postDirectMail | Required | PostDirectMail model |
var postDirectMail = new PostDirectMail({"key":"value"});
controller.sendCampaign(postDirectMail, function(error, response, context) {
});
Calculate direct mail campaign price
function calculatePrice(postDirectMail, callback)
| Parameter | Tags | Description |
|---|---|---|
| postDirectMail | Required | PostDirectMail model |
var postDirectMail = new PostDirectMail({"key":"value"});
controller.calculatePrice(postDirectMail, function(error, response, context) {
});
Get direct mail campaigns
function campaigns(callback)
controller.campaigns(function(error, response, context) {
});
FAQs
This is the official [ClickSend](https://clicksend.com) SDK. Documentation can be found [here](https://developers.clicksend.com/docs/rest/v3/?nodejs#introduction).
The npm package clicksend receives a total of 1,520 weekly downloads. As such, clicksend popularity was classified as popular.
We found that clicksend demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
Security News
Michigan TypeScript founder Dimitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.
Security News
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.