Skip to main content

Uniphore Customer Portal

Create or Update Connector Properties at Organization level

Creates and Updates Twilio, Exotel connector properties and TTS subscription details at Organizational level.

Endpoint

Method: PUT

URL: https://uselfserve-<tenant-name>.uniphore.com/cse/organization/{orgId}/properties

curl -X PUT "https://hostname:port/organization/1/properties" 
-H "accept: text/plain" -H "Authorization: Bearer IfRu6hOkoFn9LdvayNPDP3azTbk8TLAxud3wpnhnO675L7Yhk0p7l_OaQVUPSk7DqvjmYY1cikzu2eEQ-FWUEZ2FsENl2oYelS6-342G--aN5qRtaQ3rW0rndrxN0J5e6zQiS3PnYiBODu7WoMpBdcFnC_K3DekoBSMeg2U1Wgf1JgmwChSpLI7t2Q" 
-H "Content-Type: application/json" 
-d " {
  "exotelBingTtsconfigs": [
    {
      "ttsBingSubscriptionKey": "ABCDEFGHIJKLMNOP1234567890",
      "ttsBingSubscriptionRegion": "eastus",
      "ttsBingMaxTotalConnections": 100,
      "ttsBingMaxIdleConnections": 50,
      "ttsBingMinIdleConnections": 10
    }
  ],
  "pollyTtsconfigs": [
    {
      "accessKeyId": "ABCDEFGHIJKLMNOP1234567890",
      "secretAccessKey": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
      "region": "us-east-1",
      "ttsPollyMaxTotalConnections": 100,
      "ttsPollyMaxIdleConnections": 50,
      "ttsPollyMinIdleConnections": 10
    }
  ],
  "twilioAccountSid": "ABCDEFGHIJKLMNOP1234567890",
  "twilioAuthToken": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
  "twilioApiKey": "ABCDEFGHIJKLMNOPqrstuvwxyz1234567890",
  "twilioApiSecret": "PLKIdfrt54WASDXZ567kuygbvfrTIKU",
  "exotelApiKey": "ABCDEFGHIJKLMNOP1234567890",
  "exotelApiToken": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
  "exotelUserId": "uniphore-uss",
  "exotelFlowId": "691333",
  "exotelSubDomain": "api.exotel.com"
}

Note

The parameters -twilioApiKey and twilioApiSecret are available from U-Self Serve 2024.1.1 release onward.

Warning

Do not change any Parameter Value when a call is in progress.

Header Parameter

Authorization - Bearer <Token>

Path Parameter

Parameter Name

Data Type

Description

Required/ Optional

orgId

Integer

Id of the organization for which the properties need to be created or updated

Required

Request Parameter

Parameter Name

Data Type

Description

Required/ Optional

exotelApiKey

String

The API KEY (USERNAME) that is available in Exotel.

Refer API Settings in Exotel Connector Integration.

Required

exotelApiToken

String

The API TOKEN (PASSWORD) that is available in Exotel.

Refer API Settings in Exotel Connector Integration.

Required

exotelFlowId

String

The APP ID that is available in Exotel.

Refer App Bazaar Dashboard in Exotel Connector Integration.

Required

exotelSubDomain

String

The Exotel Sub Domain is available in API Settings in Exotel Connector.

Required

exotelUserId

String

The Account SID that is available in API Settings in Exotel Connector Integration.

Required

ttsBingSubscriptionKey

String

The subscription for Microsoft TTS and the server region are configured depending upon where the services are hosted.

Applicable for both Twilio and Exotel connector.

Required

twilioAccountSid

String

The Account SID that is available in Account Info in Twilio dashboard.

Refer View Account ID and Token in Twilio Connector Integration.

Required

twilioAuthToken

String

The Auth Token available in Account Info in Twilio dashboard.

Refer View Account ID and Token in Twilio Connector Integration.

Required

twilioApiKey

String

The SID that is available in API keys & tokens under Twilio Account menu.

Refer View Account ID and Token in Twilio Connector Integration.

Note

Required only when the customer is not using Auth Token.

Available from U-Self Serve 2024.1.1 release.

Optional

twilioApiSecret

String

The Secret that is available in API keys & tokens under Twilio Account menu.

Refer View Account ID and Token in Twilio Connector Integration.

Note

Required only when the customer is not using Auth Token.

Available from U-Self Serve 2024.1.1 release.

Optional

ttsBingMaxIdleConnections

Number

This field belongs to the connection pooling of the Microsoft TTS. Retain the default value 50 which is mentioned in the sample response and do not modify unless required.

Applicable for both Twilio and Exotel connector.

Required

ttsBingMaxTotalConnections

Number

This field belongs to the connection pooling of the Microsoft TTS. Retain the default value 100 which is mentioned in the sample response and do not modify unless required.

Applicable for both Twilio and Exotel connector.

Required

ttsBingMinIdleConnections

Number

This field belongs to the connection pooling of the Microsoft TTS. Retain the default value 50 which is mentioned in the sample response and do not modify unless required.

Applicable for both Twilio and Exotel connector.

Required

ttsBingSubscriptionRegion

String

Enter the Bing TTS region name for the corresponding license key.

Applicable for both Twilio and Exotel connector.

Required

accessKeyId

String

Access Key Id of the Polly TTS.

Required

region

String

Polly TTS region name for the corresponding access key id.

Applicable for Twilio connector only.

Required

secretAccessKey

String

Secret Access Key of the Polly TTS.

Applicable for Twilio connector only.

Required

ttsPollyMaxIdleConnections

String

This field belongs to the connection pooling of the Polly TTS. Retain the default value 50 which is mentioned in the sample response and do not modify unless required.

Applicable for Twilio connector only.

Required

ttsPollyMaxTotalConnections

String

This field belongs to the connection pooling of the Polly TTS. Retain the default value 100 which is mentioned in the sample response and do not modify unless required.

Applicable for Twilio connector only.

Required

ttsPollyMinIdleConnections

String

This field belongs to the connection pooling of the Polly TTS. Retain the default value 50 which is mentioned in the sample response and do not modify unless required.

Applicable for Twilio connector only.

Required

Example Request
{
  "exotelBingTtsconfigs": [
    {
      "ttsBingSubscriptionKey": "ABCDEFGHIJKLMNOP1234567890",
      "ttsBingSubscriptionRegion": "eastus",
      "ttsBingMaxTotalConnections": 100,
      "ttsBingMaxIdleConnections": 50,
      "ttsBingMinIdleConnections": 10
    }
  ],
  "pollyTtsconfigs": [
    {
      "accessKeyId": "ABCDEFGHIJKLMNOP1234567890",
      "secretAccessKey": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
      "region": "us-east-1",
      "ttsPollyMaxTotalConnections": 100,
      "ttsPollyMaxIdleConnections": 50,
      "ttsPollyMinIdleConnections": 10
    }
  ],
  "twilioAccountSid": "ABCDEFGHIJKLMNOP1234567890",
  "twilioAuthToken": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
  "twilioApiKey": "ABCDEFGHIJKLMNOPqrstuvwxyz1234567890",
  "twilioApiSecret": "PLKIdfrt54WASDXZ567kuygbvfrTIKU",
  "exotelApiKey": "ABCDEFGHIJKLMNOP1234567890",
  "exotelApiToken": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
  "exotelUserId": "uniphore-uss",
  "exotelFlowId": "691333",
  "exotelSubDomain": "api.exotel.com"
}

Note

The parameters -twilioApiKey and twilioApiSecret are available from U-Self Serve 2024.1.1 release onward.

Response and Error Codes

Response Code

Condition

200

OK

403

Forbidden

500

Internal Server Error

Note

With the error codes, a summary containing the reason for failure is provided.

In this section: