← Back to plugin index

SMS Service
Description

Enables the following SMS endpoints in the Adminapp REST API when configured:

  • POST /<adminapp-uri>/rest/sms
  • GET /<adminapp-uri>/rest/sms/<messageId>

This permits sending SMS, as well as verifying the delivery status of a previously sent SMS using its identity. See the Airlock IAM REST documentation for more information.

Type name
SmsService
Class
com.airlock.iam.common.application.configuration.SmsServiceConfig
May be used by
Adminapp REST API Configuration
Properties
Originator (originator)
Description
The originator is displayed as the sender of the SMS on the recipient's phone. If configured, clients are not allowed to specify an originator in the request.
Attributes
String
Optional
Length <= 16
Length >= 1
SMS Gateway (smsGateway)
Description
SMS gateway to use when sending an SMS and checking its delivery status.
Attributes
Plugin-Link
Mandatory
Assignable plugins
ASP SMS Gateway Dummy SMS Gateway Email SMS Gateway Failover SMS Gateway HTTP SMS Gateway Kannel SMS Gateway Null SMS Gateway Number-based Selection SMS Gateway SMPP SMS Gateway SMS Finder Gateway Swisscom REST SMS Gateway Swissphone SMS Gateway True Senses SMS Gateway UCP SMS Gateway eCall SMS Gateway (v1)
YAML Template (with default values) 

type: SmsService
id: SmsService-xxxxxx
displayName: 
comment: 
properties:
  originator:
  smsGateway: