Send us the information

This defines how you send us the document & customer details. The information can be sent to us using two methods.

  1. Rest API: You pass the information to us as JSON payload. Document is encoded as base 64 string or URL of the document is shared. Customer ID and other variables are provided in the JSON.
  2. Email: You send us the email with document attached. Customer ID is sent in <customerid>@mail.Sendocs.io and other variables provided in the email headers.

1. Sending information over Rest API

Request

{ "UserId": "<userid /email/ phone>", "Country": "US", "TemplateId": "<Template Id Here>", "LocationID": "<Location Id Here>", "Document": { "Url": "<http url if you want to serve document from your server>", "Name": "sample.pdf", "Base64": "<document as base 64 encoded string>" } "CustomData": { "Channel": { "storename": "Yosemite Valley", "brand": "Aven" }, "Template": { "amount": "$500", "quantity": "3", "date": "05 August, 2021", "receipt": "UCB-001-3456" } } }

Request Headers
  • Content-Type: You need to set content-type as application/json in the request header.
  • X-Api-Key: For security purpose, api key is required. You will get this key from Portal > Configuration.

  • After getting the key as shown above, you need to send this in the header with key x-api-key and value as Your Key
  • Note: Do not share your api-key with any one for security reasons.

Request Body Variables

Standard Variables
  • Country: Two letter ISO country code which is used to distinguish analytics on the dashboard. You can skip this if you are sending data in your registered country.
  • UserId: Unique Identity of the customer to whom the document is to be sent. Can be the phone number, email id, internal customer id, etc.
  • LocationId: Unique Identity of the store from which document is to be sent. You will need to add this on the portal as well.
  • TemplateId: Unique 10-digit template id which defines the template that will be displayed to the customer for this communication. Template ID value can be found at Portal > Templates. You need to publish a template to production before you can send any data associated with that template.
Document Variables
  • Name: File name of the document which is being sent.
  • Base64: Document to be sent as Base64 encoded string. Max Limit is 2MB.
  • URL: Http(s) url of the document if you want to store and serve the document from your server.
Custom Data Variables

Sendocs allow a high degree of personalisation in communication with customers. Both the message that is sent to customer over any channel and the template that is displayed to the customer can have several personalised elements. These are to be passed to us as key value pairs.

  1. a. Channel Data Variables:Any number of variables can be personalised in the message that is sent to the customer over SMS, Whatsapp, email or other channels
  2. b. Template Data Variables:Any number of variables can be personalised in the template that is displayed to the customer on clicking the link. All variables need to be created in the Template header in the dashboard.
a. Channel Data Variables

Example 1: (Text Message)

  • Personalising the Customer name and store name in the text message to be sent to customer as shown alongside
  • The message to be sent should be configured as below (with your messaging service provider – SMS, Whatsapp, etc.): Dear {name}, Thanks for shopping at our store in {storename}. To view your bill, please click {link}
  • In the channel data field, provide following keys and their values:
  • Values ‘John’ and ‘Boston’ are picked from information provided by you and the link https://sd1.link/df/?ySvSANna is inserted by Sendocs

Example 2: (Email Message)

b. Template Data Variables

Any number of variables can be personalised in the template that is displayed to the customer on clicking the link. All variables need to be created in the Page Header in the Portal > Templates.

  • Free form text message: Any number of variables can be inserted in curly brackets
  • Structured fields: A base template has defined number of fields where variable name and its value can be inserted. Nunber if such fields is different in different templates – Please chose the one that works for you. The value for each variable is to passed as key value in the API.
  • Some examples of common variables used by our clients :
    • Name: Customer name
    • Amount : Bill amount
    • CustomerID: Customer Account number
    • Date: Transaction Date
    • DueDate: Due date for the bill payment
    • City: City of business
    • Storename: Store name
    • LocationID: Office or store ID

Example 1: (Free Form Text Message)

  • Template for a travel ticket could display customer name, travel date, and from and to travel location in the page header of the display template. The fields can be named in the template design portal as per requirements - shown as A in the bottom left in the figure below.
  • Page header in the Customer display template is shown as B on the right side in the figure
  • In the user data field, provide following keys and their values for that specific document:

Example 2: (Structured Fields)

  • Template for a utility bill could display specific information about the bill in the page header of the display template. The fields can be named in the template design portal as per requirements - shown as A in the bottom left in the figure below.
  • Page header in the Customer display template is shown as B on the right side in the figure
  • In the user data field, provide following keys and their values for that specific document:
Response Codes

    Below are Http status codes that are returned over a post request.

    1. 200: Request sent was successful and will be processed by Sendocs.
    2. 401: Business Details not found / Wrong Api Key Used.
    3. 402: Not enough credits or current plan expired.
    4. 404: Template Id is invalid or not found.
    5. 451: Account blocked/ suspended. Contact Sendocs team.

2. Sending information over Email

  • Sendocs supports a very easy and popular email based integration to receive documents & information. This works well for many businesses as most IT Systems are enabled to send emails.
  • You send an email to <userid>@mail.Sendocs.io from your whitelisted email ID, with the document attached.
    • Most common user ID is customer’s mobile number; so a document meant for a customer with mobile number +1 987 654 3210 will be sent to the email ID: 19876543210@mail.Sendocs.io
    • Other user IDs can also be used e.g. customer account number, etc. A user ID should enable your business to uniquely identify the customer.
    • However, user ID in this option cannot be the customer’s email ID.
  • We will create the link and send it to the channel endpoint configured by you – In this case, this can be the http endpoint, Twilio SMS or Twilio Whatsapp - for onward communication to end customer.
  • The Sender Email ID must be whitelisted at Portal > Configuration.
Understanding Data Variables

Integration over Email requires very limited information to be shared with Sendocs.

  • Document: Is sent as email attachment
  • Userid: Sent in the ‘To:’ field of the email as <userid>@mail.Sendocs.io
  • Template ID: Default Template ID as set up you on portal > templates
  • This is what will be displayed to your end customer on clicking the link. You need to configure a Default Template ID at Portal > Templates.
Custom data variables

Standard messages need to be created for both channel messages (message shown in the SMS or whatsapp) and display template headers (message shown on top of the display template).

Channel Messages

Configuring the message that is sent to the customer over SMS, Whatsapp, or other channels.

  • Standard message templates can be configured in the portal > templates > channel configuration - shown as A at the bottom of the figure below. Template type must be selected as Text Message.
  • Example: Thanks for shopping with us. To view your bill and give feedback, please click {link}
  • Message to the customer can be sent through your Twilio account or any other messaging service provider.
Display Template Header
  • Customised Display Message Templates can be configured at Portal > Templates > Display Template Configuration - shown as A in the bottom left in the figure below. No variables fields can be configured.
  • Page header in the Customer display template is shown as B on the right side in the figure
  • Example: Dear customer, Thanks for visiting Aven. Your purchase bill is enclosed. We look forward to serving you again.

Overview

Sendocs helps businesses like yours, to send documents to their customers in exciting, interactive templates. Once initial setup is done, the typical process works in steps described below.

  • You send us the document (or the document url) and ID of the customer to whom the document it is to be sent – using our API or in an Email.
  • Sendocs stores the document and associates it with a display template selected by you.
  • We create a unique url link that is sent to the customer over your desired communication channel.
  • On clicking this url, customer will see the display template on her device where she can view the document and perform other interactions.
  • All these customer interactions are tracked on your Sendocs dashboard.

Key activities you need to do to start using Sendocs after you signup

1. Create the templates
  • This is the html page that is displayed on customer device on link click.
  • At least one template needs to be created with desired components.
2. Configure your channels
  • Configure the channels over which your customer will receive the link.
  • This can be SMS, Email, Whatsapp or any other messenger channels.
3. Send us the information
  • Configure how you send the document and customer Id for each transaction to Sendocs.
  • This can be done in two ways
    • Use our rest API
    • Send over an email

Create your templates

There are two type of templates that need to be created to start using Sendocs

  1. Display Template: Template visible to customer on clicking the link
  2. Channel Template: Template for the message that is sent to the customer over the chosen communication channel - SMS, Email, etc

1. Display Templates

  • This is the page that is displayed to your customers when they click the link that is sent to them over any channel
  • You can have multiple templates in production at any time. The template that is associated with a particular document can be selected by you when you send the document to us.
    • For example: You can use distinct templates for different sub-brands, locations, customer segments, languages, etc.
  • To get started, you need to create a new template or access your existing templates. You can do this rom dashboard-template
Create New Template
  • Create a new template using any of the existing base templates
  • Sendocs provides a range of base template options. You can pick any of them and customise to your requirements. There are base templates for retail, ecommerce, healthcare, pharmacy, service centres, utilities, financial services and some general templates. However every business is different. You do not need to restrict yourself to the sectoral template. Browse through different base templates, get some ideas on what will work for you and feel free to use any template as a starting point. Many of our retail customers prefer a financial services template.
Configure The Template
  • You can change various widgets from template configuration section below.
  • ‘Refresh’ button allows you to save your changes and preview them on the right side panel
  • ‘Update to Production’ button will make the template live in production.

Configure The Components

  • Customisation includes inserting your brand logo, brand colours and set of widgets you need – feedback, banner ads, carousel ads, videos, social media links, etc.
  • Template configuration allows you to add and customer a range of widgets to your needs. You can chose to have or not have any of the widgets. Each widget has some customizable elements to meet your requirements. You can play around with these to see how this will look of a smartphone screen. Refresh to preview & save the changes. The changed template will go live into production only if you click update to production button.

Page Header Details

Top page that customer sees on clicking the link

  • Insert brand logo, color theme and Link expiry period
  • Define clickable buttons & their titles – View bill, Email bill, etc.
  • Insert fixed and variable content to be displayed to customer – customer name, bill amount, store name, etc
  • Personalised Message can be added for the customer with variables like customer name, document date, amount, etc. inserted
Feedback Form
  • Five stars rating with textbox to capture customer inputs
Optional
  • Different follow up question can to be asked if rating is 1-2 or 3-4 or 5
  • All these customer feedback inputs are instantly available in the dashboard.
Net Promoter Score (NPS)
  • Add the request for NPS along with up to 6 reasons and free text suggestion box
Single Action Card
  • Show an image, description and a call to action button
Twin Action Card
  • Can be used for app downloads, selling gift cards, store locator, register complaint, etc.
  • Has two distinct cards on left and right side. Each card has an image, title, description and call to action button
Image Carousel
  • Useful for showing special offers and product. Redirect traffic to website. Show description with multiple images in a carousel format. Each image can redirect to a destination url.
Ad Banner with two action buttons
  • Useful for driving sales and provide more information to customer
  • Insert title, image, description, button titles and destination urls
Video Box
  • Use to show any corporate videos, advertisements, product information , upcoming launch information, tutorials, etc
  • Insert the video title, description and URL
Banner Ad
  • Use to show any image & advertisement with a call to action on clicking the image
  • Insert Image, destination url
Opt-ins / Subscription
  • Useful for getting customer consent for newsletters, whatsapp opt-ins, loyalty programs, call back requests, etc.,
  • Show Title & description with an image.
  • Check box with opt in action.
Survey / Input Form
  • Useful for surveys, customer profile, registration or specific information capture.
  • Show description with multiple questions.
  • Questions can be customised to have radio button, free text or rating.
FAQs / Q&A
  • Insert multiple questions and answers in accordion format
Social Channels
  • Add all the social channels that you are active on.
  • Insert url for each social channel.
Contact Us
  • Insert your email ID and contact phone number for customers to connect with you.

2. Channel Templates

You may chose to send the link to your customers using our integrations with various communication providers like Twilio, etc. In that case you need to define the content to be displayed in the SMS, Whatsapp or Email. We call these channel templates.

Text Messenger Templates – SMS, Whatsapp, etc.
  1. We can trigger an SMS to the customer through your Twilio account or any other service provider url. In the portal you just need to enter the text message to be displayed to the customer along with the link.
  2. Example: Dear customer, Thanks for shopping with us. To view your bill and give feedback, please click {link}
  3. Image alongside shows how the message will be displayed on customer's phone
Email Template
  1. We can directly send an email to the customer using integrations with providers like Sendgrid or Amazon SES. An email template for this needs to be designed with the link url embedded as a button. Clicking the button will open the display template associated with this link.
  2. Image alongside shows how the email will be displayed on customer's phone

Configure Your Channel

This defines how the unique link generated by Sendocs is sent to your customers. There are two generic ways to do this.

  1. 1. We return the link to you and you send it to the customer through your communication service provider over any channel – SMS, Email, Whatsapp, etc.
  2. 2. We directly send the link to your service provider for further delivery to the customer.

This is achieved by providing different callback configurations as below.

  • HTTP endpoint
  • Amazon Simple Email Service
  • Sendgrid Email
  • Twilio SMS
  • Twilio Whatsapp

You can configure the desired callback in portal > configuration

a. Http Endpoint

  • You need to provide the url where you want to get the data from us. This needs to be configured in the url field in the http endpoint form as shown below.
  • A basic url could look like this:
  • The above link can then be sent by you to the user over any channel – SMS, Email, whatsapp, FB messenger.
  • For sending message over SMS or Whatsapp, userid must be the customer mobile number with country code. Example of a US mobile number : 19876543210 (where 1 is the country code), Example of India mobile no. : 919876543210 (where 91 is the country code)
  • A more complex url could directly provide the link and userid to your communication service provider using their http endpoint. Illustrative examples for the same are provided below.

Example 1: Message configured in the URL

http://api.domain.com/httpapi/QueryStringReceiver?ver=1.0&key=YOURKEY&encrpt=0&dest={userid}&send=SENDERID&text=Thanks for shopping at {storename}! To view your bill, give your feedback and get offers, pls click {link}

  • Above is just an illustration of a service provider template for sending SMS through urls. Please take the actual format and key from your service provider
Example 2: Message configured in the Channel Template in Sendocs portal

http://api.domain.com/httpapi/QueryStringReceiver?ver=1.0&key=YOURKEY&encrpt=0&dest={userid}&send=SENDERID&text={message}

  • The message configured in channel template will be : Thanks for shopping at {storename}! To view your bill, give your feedback and get offers, pls click {link}

b. Amazon Simple Email Service:

  • We can directly send the information in an email to your customer over Amazon SES. The email sent will be in the template that you configure in Channel template section.
  • For sending message over email, Userid must be the customer email ID
  • You will need to get an Amazon SES account for this. This can be obtained at https://aws.amazon.com/ses/getting-started/
  • After registering for Amazon SES, please configure the fields provided in portal > configuration > Amazon Simple Email Service

c. Sendgrid Email Service:

  • We can directly send the information in an email to your customer over Sendgrid. The email sent will be in the template that you configure in Channel template section.
  • For sending message over email, Userid must be the customer email ID
  • You will need to get a Sendgrid account for this.
  • After registering for Sendgrid, please configure the fields provided in portal > configuration > Sendgrid Email
  • Refer the link to know how to get Sendgrid api keys https://sendgrid.com/docs/ui/account-and-settings/api-keys/

d.Twilio SMS:

  • We can directly send the information in an SMS to your customer over Twilio. You will need to get a Twilio account for this.
  • For sending message over SMS, userid must be the customer mobile number with country code. Example of a US mobile number : 19876543210 (where 1 is the country code), Example of India mobile no. : 919876543210 (where 91 is the country code)
  • The SMS message sent will be in the template that you configure in Channel template section.
  • After registering for Twilio, please configure the fields provided in portal > configuration > Twilio SMS

e.Twilio Whatsapp:

  • We can directly send the information in an Whatsapp to your customer over Twilio. You will need to get a Twilio account for this.
  • For sending message over Whatsapp, userid must be the customer mobile number with country code. Example of a US mobile number : 19876543210 (where 1 is the country code), Example of India mobile no. : 919876543210 (where 91 is the country code)
  • The Whatsapp message sent will be in the template that you configure in Channel template section.
  • After registering for Twilio, please configure the fields provided in portal > configuration > Twilio Whatsapp