Client tagging allows resellers to quickly and efficiently manage and bill their onward customers transparently.
Introduction
divergent Connect introduces the concept of "Client Tagging", a method by which each Email or SMS (as a single or bulk send) can be tagged against a Client when sent via API.
This exists to allow our API Integration customers with their own products to transparently provide comprehensive, reliable Email and SMS services to their customers, with accurate tracking for counters or billing management.
Once an Email or SMS is tagged, it is able to reported on either through our online portal or via an API method to retrieve usage for any given period.
By default, your periods are aligned to your own billing periods, but this can be changed for example to report from the 1st of each month.
Enabling Client Tagging
From within the portal select Settings from the top navigation, then from the sidebar navigation select "Advanced".
You will see a toggle for "Client Tagging". Toggle this on to enable the functionality.
Creating Clients
Once you have enabled the functionality (see above), you will see a new "Clients" item in your top navigation bar. Click this to enter the Client management area.
You will see a button named "Add Client", clicking this will pop up a dialog where you are able to enter the name of the client.
Once created, they will show in the list with their Email and SMS counts within the current period (these should be 0) as well as an ID that you can use for requests (see below). Clicking this ID will copy it to your clipboard.
Via API
You may also use our API to create new clients using the PUT Client method.
Updating the Default Billing Period
From within the portal, select "Clients" from the top navigation, then click "Settings".
A pop up dialog will appear where you are able to configure the Default Billing Period. This is an anchor date for the period start.
If you set this to 1st , this will use the billing period from, for example 1st January to 31st January, 1st February to 28th February, and so on. If this were set to 2nd, the period would run from for example 2nd January to 1st February, 2nd February to 1st March, and so on.
This currently can't be set on a per client period, please let us know if this is functionality that would be applicable to your use case.
Tagging Sends
If you're using our API via HTTP, you can set the Dvgt-Client-Id header on each request.
When using our libraries, you can set the appropriate ClientId property on each message or bulk send batch.
Please note that SMS sent via the portal can not be tagged against a client. This is a feature exclusive to users of the Connect API.
Reporting Usage Data
You can instantly see usage data within the Portal by navigating to "Clients". Each client is listed within the interface alongside their usage in the period that you have configured.
You should also see a "Download Report" button. On clicking this, you will see a drop down appear to download a report as a PDF or CSV. We recommend using the CSV file for most billing options as it is a more basic format suitable for using within your own billing processes, however the PDF offers a more user friendly overview of usage within the period.
Each Report has an associated Cost, showing not only the usage count but the true cost of the messages sent within the period.
Via API
If you automate your billing processes, you are able to get usage data via API.
Simply call GET Client/{id} to get information on a per client basis. Alternatively, you may call GET Client to get client usage for all Clients that are set up in your instance of Connect.
The API currently does not include Cost information, only the usage counts. Please let us know if this functionality is desired for your use case.