Skip to content

Activate a custom telephony provider

Request

Identity Engine
OAuth 2.0 scope:
  • okta.customTelephonyProvider.manage

Activates a custom telephony provider by its ID. You must activate a provider before it can be used.

Path
customTelephonyProviderIdstringrequired

The ID of the custom telephony provider

curl -i -X POST \
  'https://subdomain.okta.com/api/v1/telephony-providers/{customTelephonyProviderId}/lifecycle/activate'

Responses

OK

Bodyapplication/json
enabledboolean

Indicates whether the provider is enabled and can be used

idstring

ID of the custom telephony provider

isPrimaryProviderboolean

Indicates whether the provider is the primary telephony provider

providerCapabilitystring

The types of telephony operations (SMS or Voice) that you use with your telephony provider.

ALL is the only valid value. It indicates that your provider can handle both SMS messages and voice calls. You're not required to use both types of telephony operations, but your provider can support both.

Value:"ALL"
providerNamestring

Name of the telephony provider

Enum:"TWILIO""TELESIGN"
providerSettingsobject(CustomTelephonyProviderSettings)

Settings for custom telephony provider.

These settings vary based on the telephony provider and the type of telephony operation (SMS or Voice). For sms and call, you can select one method per telephony operation (sms and call) for sending messages or voice calls.

Note: Configure your telephony provider settings before selecting the methods for sending SMS messages or making voice calls. For example, if you select Twilio as your telephony provider, and you want to send SMS messages using Twilio's Verify Service, ensure that you have the Verify Service set up in your Twilio account. You can then use the twilioVerifySid field under sms to provide the necessary SID.

providerSidstring

The account string identifier (SID) for your telephony provider account. Your telephony provider gives you this SID.

Response
{ "id": "oct3v00k4iOFlEJmQ806", "isPrimaryProvider": true, "enabled": true, "providerCapability": "ALL", "providerName": "TWILIO", "providerSid": "ACb49fb19a09b2f5d2f121fe1c207689dt", "providerSettings": { "sms": { … }, "call": { … } } }