Advanced JSON configuration properties

Example JSON configuration file

For example, the following JSON file configures a tenant at the number 234-555-6789 as a self-service agent that publishes reporting events, plus another tenant at 234-555-7890 on the myhost.com host whose details are not shown.

To deploy this configuration, you must set the file path to your JSON configuration file as the MULTI_TENANT_CONFIG_FILE environment variable in your Voice Gateway deployment configuration file.

{
"tenants": [{
"tenantURI": "2345556789",
"description": "Voice Gateway Demo US",
"whitelistFromUri": "8765554321",
"putCallerOnHoldOnTransfer": "false",
"conversation": {
"url": "https://api.us-south.assistant.watson.cloud.ibm.com/instances/{instance_id}",
"workspaceID": "a23de67h-e527-40d5-a867-5c0ce9e72d0d",
"apikey": "{apikey}",
"tokenServiceProviderUrl": "https://iam.cloud.ibm.com/identity/token"
			},
"stt": {
"credentials": {
"url": "https://api.us-south.speech-to-text.watson.cloud.ibm.com/instances/{instance_id}",
"apikey": "{apikey}",
"tokenServiceProviderUrl": "https://iam.cloud.ibm.com/identity/token"
				},
"config": {
"model": "en-US_NarrowbandModel",
"profanity_filter": true,
"smart_formatting": true
				},
"broadbandConfig": {
"model": "en-US_BroadbandModel",
"profanity_filter": true,
"smart_formatting": true
				},
"bandPreference": "broadband",
"confidenceScoreThreshold": 0.2,
"echoSuppression": true,
"bargeInResume": true,
"trackLatency": false
			},
"tts": {
"cacheTimeToLive": 336,
"credentials": {
"url": "https://api.us-south.text-to-speech.watson.cloud.ibm.com/instances/{instance_id}",
"apikey": "{apikey}",
"tokenServiceProviderUrl": "https://iam.cloud.ibm.com/identity/token"
				},
"config": {
"voice": "en-US_MichaelVoice"
				}
			},
"reporting": {
"url": "http://10.10.10.10:8080",
"username": "john.smith",
"password": "HcmzFp1kec1P",
"cdrEventInd": "cdr",
"convEventInd": "conv",
"transcriptionEventInd": "transcription"
			},
"smsPipe": {
"url": "http://host:port/sms.gateway/smsPipe",
"username": "tR3qNZ12-u53qmz93",
"password": "Qz34x05e",
"tenantPhoneNumber": "+18765554321"
			},
"enableOutboundCalls": true,
"outboundCalls": {
"statusWebhook": "http://need.example.webhook.url.com/",
"tenantURI": "same as tenant URI above?",
"connectTimeout": 3,
"readTimeout": 5,
        "maxRetyNo": 2
      },
"restAPI": {
        "username": "exampleusername",
        "password": "examplepassword"
      },
"mediaEncryption": {
"encryptionType": "srtp",
"forceMediaEncryption": true
    }
  },
    {
"tenantURI": "2345557890@example.com"
		}
	]
}

1. Add your tenant configuration to the Voice Gateway configuration, and deploy your environment. For more information, see Deploying a multi-tenant JSON configuration.

Important: The multi-tenant configuration properties are related to Docker environment variables in the Voice Gateway configuration. If a value isn't defined in the configuration JSON file, some values of the related Docker environment variables are used as noted in the following sections.

Back to the beginning

Required tenant properties

Optional tenant properties

You can define the following configuration properties for each tenant individually. The properties are optional, but if you do want to define them, they must be defined as JSON properties. The values of the related Docker environment variables are not used.

Back to the beginning

Properties for the conversation object

The IBM Watson™ Assistant service that you want to use for each tenant must be defined as JSON properties. The values of the related Docker environment variables are not used.

As with other configuration methods, both the conversation object and the wva object can't be defined within a single tenant.

To configure the tenant to connect to Watson Assistant through a service orchestration engine (SOE), configure the SOE on the properties instead. If the SOE is configured to require authentication, specify the user name and password for HTTP basic authentication.

Back to the beginning

Properties for the wva object

Note: You can't create new instances of Watson Virtual Agent after June 19, 2018. This service was removed from the IBM Cloud Catalog on March 19, 2019.

The Watson Virtual Agent chatbot that you want to use for each tenant must be defined as JSON properties. The values of the related Docker environment variables are not used. To connect to Virtual Agent through a service orchestration engine (SOE), configure the SOE on the conversation object.

As with other configuration methods, both the conversation object and the wva object can't be defined within a single tenant.

Back to the beginning

Properties for the stt object

The stt object contains configuration for either the Speech to Text service or the speech recognition services enabled by the Speech to Text Adapter. If a JSON property isn't defined, the value of the related Docker environment variable is used.

You can define the following properties to configure the Speech to Text service.

Back to the beginning

Properties for the tts object

If a JSON property isn't defined, the value of the related Docker environment variable is used.

Back to the beginning

Properties for the reporting object

To enable reporting in a tenant, the reporting server and event type must be defined as JSON properties. The values of the related Docker environment variables are not used.

Back to the beginning

Properties for the sipAuth object

To enable SIP authentication for inbound calls in a tenant, the SIP authentication JSON properties must be defined.

Back to the beginning

Properties for the smsPipe object

To enable SMS messaging integration during a call, you can configure a tenant with information about your SMS Gateway instance. See Integrating SMS Gateway with Voice Gateway.

Back to the beginning

Properties for the outboundCalls object

To enable outbound calling in a tenant, the outbound calling JSON properties must be defined.

Back to the beginning

Properties of the mediaEncryption object

The mediaEncryption object contains configuration properties for the securing media streams. If a JSON property is not defined, the value of the related Docker environment variable is used. Version 1.0.3.0 and later.

Back to the beginning