This guide will explain how the API key can be created and what configurational changes will you be able to do to the API key on our Dashboard.
Creating the API key
If you’re looking to send SMS messages through the Omnichannel API, then head to the Developers section for the API key creation. All the API keys you’ve created will be displayed on the given page.
To create an API key, click on the Create New API Key. You’ll be asked to name your API key, which will help you to distinguish it from the other API keys you may create. After the creation, there will be multiple options that you can configure.
API key configuration
To add one extra layer of security to your API key, we recommend adding the IPs to the whitelist, from which the SMS message requests will be sent. Messente allows API users to define a list of IP addresses and IP address ranges using CIDR notation.
If you need to whitelist a few specific IP addresses, you can just provide them as a list:
Or, you can also provide an IP address ranges:
If you need to disable the IP address whitelist, you can just allow all IP addresses instead, using the following IP address range:
While submitting the SMS message requests via the API, one of the required fields is From, which is for the sender name. If you configure the API’s Default Sender to one of your available Sender IDs, then the From field within the API request can be left out, and the sender name will be taken from the API key configuration.
While both From field within the SMS request and the Default Sender within the API key are populated, then the API request will overrule the API key configuration, and thus the message will be sent with the Sender ID from the API request.
The Auto-Replace function has been described further in a separate guide, please make sure to check it out also.
In the API key configuration and within the SMS request, three options are available:
- OFF - Turns off all auto-replacements
- ON - Only replaces the user-defined characters
- FULL - Replaces all characters automatically, which aren’t present in the GSM7 alphabet
While both the autoconvert field within the SMS request and the Auto Replace within the API key are populated, then the API request will overrule the API key configuration.
Delivery Report Webhook
Whenever Messente receives a Delivery Report for a message, it will make an HTTP POST callback request to your server, indicating the new status for this message. The Delivery Report will be forwarded to the callback URL provided within the API key, or to the URL specified within the SMS message request. More has been explained in our Delivery Report Webhook guide.
While both dlr_url field within the SMS request and the Delivery Report Webhook within the API key are populated, then the API request will overrule the API key configuration.