Create an SMS Connector
The SMS connector allows SigningHub to connect with any SMS Gateway to provide SMS gateway services to SigningHub Desktop Web. It is a generic connector that can accept:
URL of the SMS Gateway to send an HTTP request
HTTP method, i.e. POST or GET
A dynamic key-value pair of attributes that are sent in the HTTP request
By using this connector, SigningHub can seamlessly connect with any SMS gateway(s) through the provided parameters to send off OTP messages to the recipients.
Create an SMS connector
Click the 'Configurations' option from the navigation panel.
Click the 'Connectors' option.
Click the
icon from the grid header.
The 'Add' connector screen will appear to add the connector details. It comprises of two sections, i.e. Basic Information and Details. Specify the basic information and click the
button to provide the respective connector details. Click the 'Create' button. A new connector will be saved and displayed in the list. See the table below for field descriptions.
Basic Information
Fields
Description
Name
Specify a unique name for this connector, i.e. My SMS. This connector will be used in the configuration of Global Settings and service plans.
Provider
Select the provider for this connector, i.e. "SMS".
Purpose
This field will display the purpose of the selected provider above, i.e. the purpose of "SMS" is "SMS Gateway".
Active
Tick this check box to make this connector active. Inactive connectors cannot be configured in the Global Settings and service plans.
The following table describes the fields on the "Details" section of this screen.
Details
Fields
Description
Logo
Select an appropriate image in the jpeg, jpg, gif or png format for the connector's logo that will be displayed on the login screen.
URL
Specify the server URL on which system will request to send SMS. If you specify {}, then system will look for AccountSid in the Request parameter and will replace the URL with AccountSid.
Method
Choose a method for this SMS connector as required, i.e. GET or Post. GET is used to send the Request Parameters in the query string. POST is used to send the Request Parameters in the body. It will also add the value of the "Content Type" drop down in the Request Header, i.e. application/json, application/x-www-form-urlencoded, or multipart/form-data.
Request Headers
Authorization
Choose an authorisation header while sending the request, i.e.:
No Auth: When this option is selected, there will be no authorisation in the request.
Basic Auth: When this option is selected, the "User Name" and "Password" fields will appear, and the user will be required to provide a user name and password of the SMS Gateway.
Bearer Token: When this option is selected, the "Authorisation Token" field will appear, and the user will be required to provide the authentication token of the SMS Gateway.
OAuth 2.0: When this option is selected, the "Configurations" button will appear to configure the access token of the SMS Gateway.
Clicking on the "Configurations" button will open the "Access Token Configurations" dialogue, containing the following fields.
Fields
Description
Access Token URL
Enter the endpoint as provided by the third-party authentication server to get the Access Token
Client Id
Enter the registered client ID as provided by the third-party authentication server.
Client Secret
Enter the client secret as provided by the third-party authentication server.
Scope
Enter the scope if required by the third-party authentication server. If not required, leave empty.
Request Headers
Add Request Header
Click this button to add more request header fields. A pair of fields will be added to specify the custom header that will be sent to the URL while sending the request. Please note, you cannot delete a request header field after adding it. If you have mistakenly added the one, then better to keep it empty so that the system may ignore it.
Request Parameters
Add Request Parameter
Click this button to add more request parameter fields. A pair of fields will be added to specify any additional parameters which is required by the SMS gateway. Please note, you cannot delete a request parameter field after adding it. If you have mistakenly added the one, then better to keep it empty so that the system may ignore it.
Content Type
Choose a content type for this SMS connector, i.e.:
application/json,
application/x-www-form-urlencoded,
multipart/form-data
Add Request Header
Click this button to add more request header fields. A pair of fields will be added, to specify the custom header that will be sent to the URL while sending the request, e.g. "X-Version: 1" is a custom header.
Please note, you cannot delete a request header field after adding it. If you have mistakenly added the one, then better to keep it empty so that system may ignore it.
Request Parameters
Param Number
This parameter is filled in by the server itself while sending OTP to a client. Specify the parameter number that is being used by the SMS Gateway API.
Param Number is used to identify the Number parameter. The SMS API may treat number differently, e.g. eskon web service calls it PrmMobileNumber.
Param Message
This parameter is filled in by the server itself while sending OTP to a client. Specify the parameter message that is being used by the SMS Gateway API.
Param Message is used to identify the Message parameter. The SMS API may treat the message differently, e.g. Eskon web service calls it PrmMessageText.
Add Request Parameter
Click this button to add more request parameter fields. A pair of fields will be added to specify any additional parameter which is required by the SMS gateway, but is not available in the default request parameters as provided above, e.g. Twilio requires Account SID. So you can add a field pair, and specify "Account SID" in the left field and its corresponding value in the right field.
Please note, you cannot delete a request parameter field after adding it. If you have mistakenly added the one, then better to keep it empty so that the system may ignore it.
Send Message
Click this button to validate the provided SMS gateway configurations by sending a test SMS. A dialogue will appear, specify your mobile number along with the correct country code and click the "Send" button. Based on the server reply, a toaster message of success or failure will be displayed.
In case of successful configurations, you will receive a test SMS on your mobile device. However, if you do not receive the message, then revisit your provided SMS gateway configurations.
Last updated