Reference Guide
Approval Management

Approval Workflow SMS Settings

6min

There are two methods for sending approval SMS:

  • Over HTTP (via SMS Proxy)
  • Over SMPP (via SMSC)

Choose one of them:

  1. Navigate to Administration > System Config Man.
  2. Set the value of the “sms.channel” parameter and click Save.

sms.channel: This parameter defines the channel to be used. Available values are HTTP and SMPP. The default value is HTTP.

The mandatory System Config. Man. parameters starting with “smpp.” should be defined in order to be able to send/receive approvals via SMS over SMPP. Please refer to APPENDIX 1: System Config Manager Parameters for these parameters.

Configuration for SMS over HTTP

In order to use the Single Connect connection and command approval workflows via SMS using an HTTP-based SMS Proxy:

  1. Navigate to Administration > System Config Man.
  2. Set the value of the approval.sms.http.url, approval.sms.http.headers, approval.sms.http.encoding, connection.approval.sms.http.body, and command.approval.sms.http.body parameters and click Save.

approval.sms.http.url: SMS sender http URL Ex: http://api.smsexample.com/v1/send-sms

approval.sms.http.headers: HTTP SMS Header Ex: Content-Type:text/xml approval.sms.http.encoding: Encoding format. Possible values: UTF-8, UTF-16BE Ex: UTF-8

connection.approval.sms.http.body: The parameter must be set in the format below. Bold values must be replaced with real values.

command.approval.sms.http.body: The parameter must be set in the format below. Bold values must be replaced with real values.

Configuration for SMS over SMPP

In order to use the Single Connect connection and command approval workflows via SMS using SMPP connection:

  1. Navigate to Administration > System Config Man.
  2. Set the value of the “command.approval.sms.smpp.body” and “connection.approval.sms.smpp.body” parameters and click Save.

connection.approval.sms.smpp.body: SMS template for connection approvals. It should be defined in the template below. Parameters with %...% should be kept.

Approval request with id '%approval_id%' has been made by %requester_username% from the host '%requested_host%', Reply this message with '%approval_keyword% %approval_id%' to approve, '%rejection_keyword% %approval_id%' to reject.

The available keywords to be used in these templates are: %approval_id%, %approval_keyword%, %rejection_keyword%, %requester_username%, %requested_host%, %selected_username%

command.approval.sms.smpp.body: SMS template for command approvals. It should be defined in the template below. Parameters with %...% should be kept.

 %requester_username% requests your approval (ID: %approval_id%) for the command '%command%'. Reply this message with '%approval_keyword% %approval_id%' to approve, '%rejection_keyword% %approval_id%' to reject.

The available keywords to be used in these templates are: %approval_id%, %approval_keyword%, %rejection_keyword%, %requester_username%, %requested_host%, %command%

The user can send an SMS response in the following format: keyword_response  approval_id Example: APPROVE Gwt674h