Communication
Manages email, sms, push notifications sent to users
"When you want to communicate with your customers, you can either send the message right away in real-time or or in asynchronous manner. The communication will be received by customer soon afterward in a deferred manner. Choose this method when the context and relevance of the message and the contents are time insensitive like order related notifications."
Send communication asynchronously.
sendCommunicationAsynchronously
"An audience is dataset that primiraily consists of records containing contact details of customers. This dataset can contain any number of records right from a single record to millions of records, stored in a csv file format. You can link audience with an campaign and send communication to all the emails or phone numbers available through records in the selected audience. Additionally to tailor messaging content to your customer you can add templating variables like first and last name in the same record along with that customers contact details. When a campaign is run, the templating variables and contact details will be picked from all the record in an audience, messaging template will be customised with all the templating variables and communication will be triggered to all available contact details. This resource allows you to create and manage datasets "
Get audiences.
getAudiences
Create audience.
createAudience
Get audience by ID.
getAudienceById
Get N sample records from CSV.
getNSampleRecordsFromCsv
"Campaigns are used to send message or content in the form of email or SMS message text to large number of people. These campaigns are generally part of marketing or advertisement promotions that are sent to customers. Campaigns can range in size from a few hundred recipients to millions of recipients. A campaign requires a message template i.e an email or sms template , a audience which is a dataset about customer contact details and templating variables to be added in messaging template and a messaging provider. This resource gives an interface for creating new campaigns, managing existing ones and scheduling it. You can also change configurations of existing campaign like changing messaging template, selected messaging provider ot the campaigns recipents."
Trigger campaign job.
triggerCampaignJob
Get jobs.
getJobs
Get job logs.
getJobLogs
Get campaigns.
getCampaigns
Create campaign.
createCampaign
Get campaign by ID.
getCampaignById
Update campaign by ID.
updateCampaignById
Get campaign statistics by ID.
getStatsOfCampaignById
"To send a email communication to your customer you need a email template. A email template consists of a template definition, which is stored in the form of html making it highly customisable and tailor made to descibe a customer journey. This html definition can also be made dynamic by making use of variables through jinja templating. Along with html definition there are more options available for better managing multiple email templates like name and desctiption of email template and tags which are labels used to group similar templates. This resource gives can be used to add new email template as well as editing the contents and definitions of existing ones. "
Get email templates.
getEmailTemplates
Create email template.
createEmailTemplate
Get email template by ID.
getEmailTemplateById
Update email template by ID.
updateEmailTemplateById
Delete email template by ID.
deleteEmailTemplateById
Get system email templates.
getSystemEmailTemplates
Get subscribed email templates.
getSubscribedEmailTemplates
"An Event is a specific scenario that is responsible for dispatching certain actions. An event occurs when ertain conditions are satisfied like an order is placed or an order is canceled for a specific product. When you want to communicate with your customers for certain special scenarios you can use events. You can link an email and/or a sms depending on the event and when that event is triggered, the linked email and/or sms template will be sent to the customer. With this resource you can add new events and delete events. you can also choose whether you want to subscribe to a particular event. By subscribing to an event you opt in to recieve all communications for that event."
Get event subscriptions.
getEventSubscriptions
Create event subscriptions by bulk
createEventSubscriptionsByBulk
"Variables are used in email and sms templates to make them dynamic and tailored to customer. There are variables that are available for an event called event variables which can be used for a particular template linked to that event like shipment id and order id for oms related events, OTP for authentication events as well as custom user defined variables called as global variables. Users and Admin can create and edit these global variables and use them as templating variables. Global variables contain two types of variables, read only variables and editable variables. For editable global variables there are no predefined values and you can add as many variables as you want. For read only variables there are fixed set of variables that cannot be modified, added or removed like for example company domain or social media handles and support contact details. Use this resource to add, remove and edit editable global variables."
Get global variables.
getGlobalVariables
Post global variables.
postGlobalVariables
"One time passwords(OTP) are an easy an secure way to authenticate customers. OTP is a secret codeword which is randomly generated and sent to customer over email or SMS communication. The customer in response shares this code back and authenticates themselves. Using this resource you can make use of OTP engine which is responsible for generating a OTP plus sending it to a customer and verifying the OTP sent by the customer. There are multiple option available with using this service like what template is to be send or which messaging provider is to be selected as well as some other advanced options available in OTP Configuration Management. By using OTP Configuration Manager you can set the way in which otp should be generated. you can choose with options like numric only otp or alphanumeric otp and the lenght of the otp. Availabe otp configuration are : options: - Length (4,6,8) - Type (Numeric/Alpha Numeric) - Expiry time etc. "
Send OTP.
sendOtp
Verify OTP.
verfiyOtp
Get otp-configuration, if not present in db then return default settings
getOtpConfiguration
Update/insert otp configurations
updateOtpConfiguration
"To send communications to your customers, you'll require a messaging service provider. With this provider resource, you can add new provider integrations and manage both new and existing integrations along with their configurations along with default settings which defines what provider will always be used . With this resource, you have the flexibility to add various email providers such as SMTP, Pepipost, Falconide and SMS providers like Netcore, SMPP, Telspiel,Viva Connect, Times Internet. You also have option to change the default provide to a custom integration across transaction, OTP and promotional categories for both email and SMS."
Get email providers.
getEmailProviders
Create email provider.
createEmailProvider
Get email provider by ID.
getEmailProviderById
Update email provider by ID.
updateEmailProviderById
Get app providers.
getDefaultEmailProviders
Get SMS providers.
getSmsProviders
Create SMS provider.
createSmsProvider
Get SMS provider by ID.
getSmsProviderById
Update SMS provider by ID.
updateSmsProviderById
Get default SMS providers.
getDefaultSmsProviders
Update application providers.
updateAppProviders
Get application providers.
getAppProviders
Get global providers.
getGlobalProviders
"Communication Reports are records that provide information about all the communications across a sales channel. A report encompasses all details concerning email and SMS communication, including status (such as delivery confirmation), error codes, and error messages associated with any errors encountered. Use this resource to get all reports within a specified date range. You also have options to filter based on different parameters. filters available: - communication type(email, sms, both) - email address / phone number - status(error/success) - date range - template id - job id - campaign id"
Get communication logs.
getCommunicationLogs
"To send a SMS communication to your customer you need a SMS template. A SMS template consists of a template definition, which is stored in the form of html making it highly customisable and tailor made to descibe a customer journey. This html definition can also be made dynamic by making use of variables through jinja templating. Along with html definition there are more options available for better managing multiple SMS templates like name and desctiption of email template and tags which are labels used to group similar templates. This resource gives can be used to add new SMS template as well as edititing the contents and definitions of existing ones. "
Get SMS templates.
getSmsTemplates
Create SMS template.
createSmsTemplate
Get SMS template by ID.
getSmsTemplateById
Update SMS template by ID.
updateSmsTemplateById
Delete SMS template by ID.
deleteSmsTemplateById
Get system SMS templates.
getSystemSmsTemplates
Get subscribed SMS templates.
getSubscribedSmsTemplates
"When you want to communicate with your customers, you can either send the message right away in real-time or in asynchronous or batched manner. This method will directly call the messaging service provider in a synchronous manner, making it ideal for time critical functions. Choose this method when the operation is time sensitive, such as for authentication events. "