Data Governance Broker Documentation Index
Configuration Reference Home

SMS Twilio Telephony Messaging Provider

Note: this component stores cluster-wide configuration data and is mirrored across all servers in the topology within the the same cluster.

Note: changes to cluster-wide configuration objects are immediately and automatically mirrored across all servers within the same cluster, so offline changes are not supported.

The SMS Twilio Telephony Messaging Provider may be used to send messages via SMS through the Twilio web service.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The SMS Twilio Telephony Messaging Provider component inherits from the Twilio Telephony Messaging Provider

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ twilio-account-sid
↓ twilio-auth-token
↓ sender-phone-number

Basic Properties

description

Description
A description for this Telephony Messaging Provider
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

twilio-account-sid

Description
The unique identifier assigned to the Twilio account that will be used.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

twilio-auth-token

Description
The auth token for the Twilio account that will be used.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

sender-phone-number

Description
The outgoing phone number to use for the messages. Values must be phone numbers you have obtained for use with your Twilio account. If a high message volume is anticipated, then it may be beneficial to provide multiple sender phone number values, which will be used in a round-robin manner. This may help overcome the Twilio limit of one message per outbound phone number per second.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Telephony Messaging Providers:

dsconfig list-telephony-messaging-providers
     [--property {propertyName}] ...

To view the configuration for an existing Telephony Messaging Provider:

dsconfig get-telephony-messaging-provider-prop
     --provider-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Telephony Messaging Provider:

dsconfig set-telephony-messaging-provider-prop
     --provider-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new SMS Twilio Telephony Messaging Provider:

dsconfig create-telephony-messaging-provider
     --provider-name {name}
     --type sms
     --set twilio-account-sid:{propertyValue}
     --set twilio-auth-token:{propertyValue}
     --set sender-phone-number:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Telephony Messaging Provider:

dsconfig delete-telephony-messaging-provider
     --provider-name {name}