Requests
AuthenticationRequest(OCIRequest)
AuthenticationRequest() is 1st stage of the 2 stage OCI login process.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
AuthenticationVerifyRequest(OCIRequest)
AuthenticationVerifyRequest() is used to authenticate a user using the user Id and
password.
The response is a AuthenticationVerifyResponse() or an ErrorResponse()
Replaced By: AuthenticationVerifyRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| password | str | password |
AuthenticationVerifyRequest14sp8(OCIRequest)
AuthenticationVerifyRequest14sp8() is used to authenticate a user either by
userId/password, userId/sip username/sip password, dn/passcode or a token previously
authorized with the ExternalAuthenticationAuthorizeTokenRequest().
The phone number may be any DN associated with a user.
The response is a AuthenticationVerifyResponse14sp8() or an ErrorResponse()
Replaced by AuthenticationVerifyRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId Optional |
| password | str | password Optional |
| phone_number | str | phoneNumber Optional |
| passcode | str | passcode Optional |
| login_token | str | loginToken Optional |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
AuthenticationVerifyRequest21sp1(OCIRequest)
AuthenticationVerifyRequest21sp1() is used to authenticate a user either by
userId/password, userId/sip username/sip password, dn/passcode, lineport/password or a
token previously authorized with the ExternalAuthenticationAuthorizeTokenRequest().
The phone number may be any DN associated with a user. The lineport may be any lineport associated with a user. The password used for the lineport is the user's password associated with userId.
The response is a AuthenticationVerifyResponse21sp1() or an ErrorResponse()
Replaced by AuthenticationVerifyRequest22V2().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId Optional |
| password | str | password Optional |
| phone_number | str | phoneNumber Optional |
| passcode | str | passcode Optional |
| line_port | str | linePort Optional |
| login_token | str | loginToken Optional |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
AuthenticationVerifyRequest22(OCIRequest)
AuthenticationVerifyRequest22() is used to authenticate a user either by
userId/password, userId/sip username/sip password, dn/passcode, lineport/password or a
token previously authorized with the ExternalAuthenticationAuthorizeTokenRequest().
The phone number may be any DN associated with a user. The lineport may be any lineport associated with a user. The password used for the lineport is the user's password associated with userId.
The response is a AuthenticationVerifyResponse22() or an ErrorResponse() Replaced
by AuthenticationVerifyRequest22V2().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId Optional |
| password | str | password Optional |
| phone_number | str | phoneNumber Optional |
| passcode | str | passcode Optional |
| line_port | str | linePort Optional |
| login_token | str | loginToken Optional |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
AuthenticationVerifyRequest22V2(OCIRequest)
AuthenticationVerifyRequest22V2() is used to authenticate a user either by
userId/password, userId/sip username/sip password, dn/passcode, lineport/password or a
token previously authorized with the ExternalAuthenticationAuthorizeTokenRequest().
The phone number may be any DN associated with a user. The lineport may be any lineport associated with a user. The password used for the lineport is the user's password associated with userId.
The response is a AuthenticationVerifyResponse22V2() or an ErrorResponse()
Replaced by AuthenticationVerifyRequest22V3()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId Optional |
| password | str | password Optional |
| phone_number | str | phoneNumber Optional |
| passcode | str | passcode Optional |
| line_port | str | linePort Optional |
| login_token | str | loginToken Optional |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
AuthenticationVerifyRequest22V3(OCIRequest)
AuthenticationVerifyRequest22V3() is used to authenticate a user either by
userId/password, userId/sip username/sip password, dn/passcode, lineport/password or a
token previously authorized with the ExternalAuthenticationAuthorizeTokenRequest().
The phone number may be any DN associated with a user. The lineport may be any lineport associated with a user. The password used for the lineport is the user's password associated with userId.
The response is a AuthenticationVerifyResponse22V3() or an ErrorResponse()
Replaced by AuthenticationVerifyRequest22V4().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId Optional |
| password | str | password Optional |
| phone_number | str | phoneNumber Optional |
| passcode | str | passcode Optional |
| line_port | str | linePort Optional |
| login_token | str | loginToken Optional |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
AuthenticationVerifyRequest22V4(OCIRequest)
AuthenticationVerifyRequest22V4() is used to authenticate a user either by
userId/password, userId/sip username/sip password, dn/passcode, lineport/password or a
token previously authorized with the ExternalAuthenticationAuthorizeTokenRequest().
The phone number may be any DN associated with a user. The lineport may be any lineport associated with a user. The password used for the lineport is the user's password associated with userId.
The response is a AuthenticationVerifyResponse22V4() or an ErrorResponse()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId Optional |
| password | str | password Optional |
| phone_number | str | phoneNumber Optional |
| passcode | str | passcode Optional |
| line_port | str | linePort Optional |
| login_token | str | loginToken Optional |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
AvailabilityTestRequest(OCIRequest)
AvailabilityTestRequest() is for high-availability support.
Response is either SuccessResponse() or ErrorResponse().
DeviceManagementFileAuthLocationGetRequest(OCIRequest)
Get the address and credentials of the File Repository hosting the requested access device file.
Also get the file name and path on the File Repository.
The response is either a DeviceManagementFileAuthLocationGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_access_protocol | str | deviceAccessProtocol |
| device_access_method | str | deviceAccessMethod |
| device_access_uri | str | deviceAccessURI |
| access_device_user_name | str | accessDeviceUserName Optional |
| access_device_user_password | str | accessDeviceUserPassword Optional |
| signed_password | str | signedPassword Optional |
| mac_address | str | macAddress Optional |
| realm_name | str | realmName Optional |
| digest_ha1_complement | str | digestHa1Complement Optional |
| digest_response | str | digestResponse Optional |
DeviceManagementFileAuthLocationGetRequest17(OCIRequest)
Get the address and credentials of the File Repository hosting the requested access device file.
Also get the file name and path on the File Repository.
The response is either a DeviceManagementFileAuthLocationGetResponse17() or an
ErrorResponse(). Replaced by: DeviceManagementFileAuthLocationGetRequest18()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_access_protocol | str | deviceAccessProtocol |
| device_access_method | str | deviceAccessMethod |
| device_access_uri | str | deviceAccessURI |
| access_device_user_name | str | accessDeviceUserName Optional |
| access_device_user_password | str | accessDeviceUserPassword Optional |
| signed_password | str | signedPassword Optional |
| mac_address | str | macAddress Optional |
| realm_name | str | realmName Optional |
| digest_ha1_complement | str | digestHa1Complement Optional |
| digest_response | str | digestResponse Optional |
DeviceManagementFileAuthLocationGetRequest18(OCIRequest)
Get the address and credentials of the File Repository hosting the requested access device file.
Also get the file name and path on the File Repository.
The response is either a DeviceManagementFileAuthLocationGetResponse18() or an
ErrorResponse(). Replaced by: DeviceManagementFileAuthLocationGetRequest21().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_access_protocol | str | deviceAccessProtocol |
| device_access_method | str | deviceAccessMethod |
| device_access_uri | str | deviceAccessURI |
| access_device_user_name | str | accessDeviceUserName Optional |
| access_device_user_password | str | accessDeviceUserPassword Optional |
| signed_password | str | signedPassword Optional |
| mac_address | str | macAddress Optional |
| realm_name | str | realmName Optional |
| digest_ha1_complement | str | digestHa1Complement Optional |
| digest_response | str | digestResponse Optional |
DeviceManagementFileAuthLocationGetRequest20sp1(OCIRequest)
Get the address and credentials of the File Repository hosting the requested access device file.
Also get the file name and path on the File Repository.
The response is either a DeviceManagementFileAuthLocationGetResponse20sp1() or an
ErrorResponse(). Replaced by: DeviceManagementFileAuthLocationGetRequest21sp1().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_access_protocol | str | deviceAccessProtocol |
| device_access_method | str | deviceAccessMethod |
| device_access_uri | str | deviceAccessURI |
| access_device_user_name | str | accessDeviceUserName Optional |
| access_device_user_password | str | accessDeviceUserPassword Optional |
| signed_password | str | signedPassword Optional |
| mac_address | str | macAddress Optional |
| realm_name | str | realmName Optional |
| digest_ha1_complement | str | digestHa1Complement Optional |
| digest_response | str | digestResponse Optional |
DeviceManagementFileAuthLocationGetRequest21(OCIRequest)
Get the address and credentials of the File Repository hosting the requested access device file.
Also get the file name and path on the File Repository.
The response is either DeviceManagementFileAuthLocationGetResponse21() or
ErrorResponse(). The following elements are only used in AS data mode and will fail
in XS data mode: deviceToken Replaced by:
DeviceManagementFileAuthLocationGetRequest21sp1().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_access_protocol | str | deviceAccessProtocol |
| device_access_method | str | deviceAccessMethod |
| device_access_uri | str | deviceAccessURI |
| access_device_user_name | str | accessDeviceUserName Optional |
| access_device_user_password | str | accessDeviceUserPassword Optional |
| device_token | str | deviceToken Optional |
| signed_password | str | signedPassword Optional |
| mac_address | str | macAddress Optional |
| realm_name | str | realmName Optional |
| digest_ha1_complement | str | digestHa1Complement Optional |
| digest_response | str | digestResponse Optional |
DeviceManagementFileAuthLocationGetRequest21sp1(OCIRequest)
Get the address and credentials of the File Repository hosting the requested access device file.
Also get the file name and path on the File Repository.
The response is either DeviceManagementFileAuthLocationGetResponse21sp1() or
ErrorResponse(). The following elements are only used in AS data mode and will fail
in XS data mode: deviceToken Replaced by
DeviceManagementFileAuthLocationGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_access_protocol | str | deviceAccessProtocol |
| device_access_method | str | deviceAccessMethod |
| device_access_uri | str | deviceAccessURI |
| access_device_user_name | str | accessDeviceUserName Optional |
| access_device_user_password | str | accessDeviceUserPassword Optional |
| device_token | str | deviceToken Optional |
| signed_password | str | signedPassword Optional |
| mac_address | str | macAddress Optional |
| realm_name | str | realmName Optional |
| digest_ha1_complement | str | digestHa1Complement Optional |
| digest_response | str | digestResponse Optional |
DeviceManagementFileAuthLocationGetRequest22(OCIRequest)
Get the address and credentials of the File Repository hosting the requested access device file.
Also get the file name and path on the File Repository.
The response is either DeviceManagementFileAuthLocationGetResponse22() or
ErrorResponse(). The following elements are only used in AS data mode and will fail
in XS data mode: deviceToken
Attributes:
| Name | Type | Description |
|---|---|---|
| device_access_protocol | str | deviceAccessProtocol |
| device_access_method | str | deviceAccessMethod |
| device_access_uri | str | deviceAccessURI |
| access_device_user_name | str | accessDeviceUserName Optional |
| access_device_user_password | str | accessDeviceUserPassword Optional |
| device_token | str | deviceToken Optional |
| signed_password | str | signedPassword Optional |
| mac_address | str | macAddress Optional |
| realm_name | str | realmName Optional |
| digest_ha1_complement | str | digestHa1Complement Optional |
| digest_response | str | digestResponse Optional |
DeviceManagementFileAuthLocationGetRequest22V2(OCIRequest)
Get the address and credentials of the File Repository hosting the requested access device file.
Also get the file name and path on the File Repository.
The response is either DeviceManagementFileAuthLocationGetResponse22V2() or
ErrorResponse(). The following elements are only used in AS data mode and will fail
in XS data mode: deviceToken The following elements are only used in XS data mode and
will be ignored in AS data mode: fileNameLookup fileNameOnDisk
Attributes:
| Name | Type | Description |
|---|---|---|
| device_access_protocol | str | deviceAccessProtocol |
| device_access_method | str | deviceAccessMethod |
| device_access_uri | str | deviceAccessURI |
| access_device_user_name | str | accessDeviceUserName Optional |
| access_device_user_password | str | accessDeviceUserPassword Optional |
| device_token | str | deviceToken Optional |
| signed_password | str | signedPassword Optional |
| mac_address | str | macAddress Optional |
| realm_name | str | realmName Optional |
| digest_ha1_complement | str | digestHa1Complement Optional |
| digest_response | str | digestResponse Optional |
| file_name_lookup | bool | fileNameLookup Optional |
| file_name_on_disk | str | fileNameOnDisk Optional |
DeviceManagementFileAuthLocationGetRequest22V3(OCIRequest)
Get the address and credentials of the File Repository hosting the requested access device file.
Also get the file name and path on the File Repository.
The response is either DeviceManagementFileAuthLocationGetResponse22V3() or
ErrorResponse(). The following elements are only used in AS data mode and will fail
in XS data mode: deviceToken The following elements are only used in XS data mode and
will be ignored in AS data mode: fileNameLookup fileNameOnDisk
Attributes:
| Name | Type | Description |
|---|---|---|
| device_access_protocol | str | deviceAccessProtocol |
| device_access_method | str | deviceAccessMethod |
| device_access_uri | str | deviceAccessURI |
| access_device_user_name | str | accessDeviceUserName Optional |
| access_device_user_password | str | accessDeviceUserPassword Optional |
| device_token | str | deviceToken Optional |
| signed_password | str | signedPassword Optional |
| mac_address | str | macAddress Optional |
| realm_name | str | realmName Optional |
| digest_ha1_complement | str | digestHa1Complement Optional |
| digest_response | str | digestResponse Optional |
| file_name_lookup | bool | fileNameLookup Optional |
| file_name_on_disk | str | fileNameOnDisk Optional |
DeviceManagementFileAuthLocationGetRequest22V4(OCIRequest)
Get the address and credentials of the File Repository hosting the requested access device file.
Also get the file name and path on the File Repository.
The response is either DeviceManagementFileAuthLocationGetResponse22V4() or
ErrorResponse(). The following elements are only used in AS data mode and will fail
in XS data mode: deviceToken The following elements are only used in XS data mode and
will be ignored in AS data mode: fileNameLookup fileNameOnDisk
Attributes:
| Name | Type | Description |
|---|---|---|
| device_access_protocol | str | deviceAccessProtocol |
| device_access_method | str | deviceAccessMethod |
| device_access_uri | str | deviceAccessURI |
| access_device_user_name | str | accessDeviceUserName Optional |
| access_device_user_password | str | accessDeviceUserPassword Optional |
| device_token | str | deviceToken Optional |
| signed_password | str | signedPassword Optional |
| mac_address | str | macAddress Optional |
| realm_name | str | realmName Optional |
| digest_ha1_complement | str | digestHa1Complement Optional |
| digest_response | str | digestResponse Optional |
| file_name_lookup | bool | fileNameLookup Optional |
| file_name_on_disk | str | fileNameOnDisk Optional |
DeviceManagementPutFileRequest(OCIRequest)
Informs BroadWorks that a file was uploaded to the repository.
The response is always a SuccessResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_access_uri | str | deviceAccessURI |
| ip_address | str | ipAddress |
EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailableListRequest(OCIRequest)
Request a list of available Mobile Subscriber Directory Numbers not yet assigned to any user.
The response is either
EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailableListResponse()
or ErrorResponse(). Replaced by:
EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailableListRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailableListRequest22(OCIRequest)
Request a list of available Mobile Subscriber Directory Numbers not yet assigned to any user.
The response is either
EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailableListResponse22()
or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallCenterAgentThresholdProfileAddAgentListRequest(OCIRequest)
Add agent(s) to a Agent Threshold Profile.
When an agent is assigned (added) to a profile, it is automatically unassigned (deleted) from the previous profile it was assigned to.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| profile_name | str | profileName |
| agent_user_id | List[str] | agentUserId |
EnterpriseCallCenterAgentThresholdProfileAddRequest(OCIRequest)
Add a new Call Center Agent Threshold Profile in an Enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| profile_name | str | profileName |
| profile_description | str | profileDescription Optional |
| threshold_current_call_state_idle_time_yellow | int | thresholdCurrentCallStateIdleTimeYellow Optional |
| threshold_current_call_state_idle_time_red | int | thresholdCurrentCallStateIdleTimeRed Optional |
| threshold_current_call_state_on_call_time_yellow | int | thresholdCurrentCallStateOnCallTimeYellow Optional |
| threshold_current_call_state_on_call_time_red | int | thresholdCurrentCallStateOnCallTimeRed Optional |
| threshold_current_agent_state_unavailable_time_yellow | int | thresholdCurrentAgentStateUnavailableTimeYellow Optional |
| threshold_current_agent_state_unavailable_time_red | int | thresholdCurrentAgentStateUnavailableTimeRed Optional |
| threshold_average_busy_in_time_yellow | int | thresholdAverageBusyInTimeYellow Optional |
| threshold_average_busy_in_time_red | int | thresholdAverageBusyInTimeRed Optional |
| threshold_average_busy_out_time_yellow | int | thresholdAverageBusyOutTimeYellow Optional |
| threshold_average_busy_out_time_red | int | thresholdAverageBusyOutTimeRed Optional |
| threshold_average_wrap_up_time_yellow | int | thresholdAverageWrapUpTimeYellow Optional |
| threshold_average_wrap_up_time_red | int | thresholdAverageWrapUpTimeRed Optional |
| enable_notification_email | bool | enableNotificationEmail |
| notification_email_address | List[str] | notificationEmailAddress Optional |
| agent_user_id | List[str] | agentUserId Optional |
EnterpriseCallCenterAgentThresholdProfileDeleteAgentListRequest(OCIRequest)
Delete agent(s) from a Agent Threshold Profile.
Agents cannot be unassigned (deleted) directly from the default profile, they need to be assigned (added) to a different profile.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| profile_name | str | profileName |
| agent_user_id | List[str] | agentUserId |
EnterpriseCallCenterAgentThresholdProfileDeleteRequest(OCIRequest)
Deletes an existing Call Center Agent Threshold Profile in an Enterprise.
The default profile cannot be deleted.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| profile_name | str | profileName |
EnterpriseCallCenterAgentThresholdProfileGetListRequest(OCIRequest)
Get the list of Call Center Agent Threshold Profiles in the Enterprise.
The response is either EnterpriseCallCenterAgentThresholdProfileGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallCenterAgentThresholdProfileGetRequest(OCIRequest)
Gets an existing non-default Call Center Agent Threshold Profile in an Enterprise.
The response is either a EnterpriseCallCenterAgentThresholdProfileGetResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| profile_name | str | profileName |
EnterpriseCallCenterAgentUnavailableCodeAddRequest(OCIRequest)
Add a Call Center Agent Unavailable Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| is_active | bool | isActive |
| code | str | code |
| description | str | description Optional |
EnterpriseCallCenterAgentUnavailableCodeDeleteRequest(OCIRequest)
Delete a Call Center Agent Unavailable Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| code | str | code |
EnterpriseCallCenterAgentUnavailableCodeGetListRequest(OCIRequest)
Get the list of Call Center Agent Unavailable Codes.
The response is either EnterpriseCallCenterAgentUnavailableCodeGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallCenterAgentUnavailableCodeGetRequest(OCIRequest)
Get a Call Center Agent Unavailable Code.
The response is either EnterpriseCallCenterAgentUnavailableCodeGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| code | str | code |
EnterpriseCallCenterAgentUnavailableCodeModifyRequest(OCIRequest)
Modify a Call Center Agent Unavailable Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| code | str | code |
| is_active | bool | isActive Optional |
| description | str | description Optional |
EnterpriseCallCenterAgentUnavailableCodeSettingsGetRequest(OCIRequest)
Request the enterprise level data associated with Call Center Agents Unavailable Code Settings.
The response is either an
EnterpriseCallCenterAgentUnavailableCodeSettingsGetResponse() or an
ErrorResponse(). Replaced by
EnterpriseCallCenterAgentUnavailableCodeSettingsGetRequest17sp4().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallCenterAgentUnavailableCodeSettingsGetRequest17sp4(OCIRequest)
Request the enterprise level data associated with Call Center Agents Unavailable Code Settings.
The response is either an
EnterpriseCallCenterAgentUnavailableCodeSettingsGetResponse17sp4() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallCenterCallDispositionCodeAddRequest(OCIRequest)
Add a Call Center Call Disposition Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| code | str | code |
| is_active | bool | isActive |
| description | str | description Optional |
EnterpriseCallCenterCallDispositionCodeDeleteRequest(OCIRequest)
Delete a Call Center Call Disposition Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| code | str | code |
EnterpriseCallCenterCallDispositionCodeGetListRequest(OCIRequest)
Get the list of Call Center Call Disposition Codes.
The response is either EnterpriseCallCenterCallDispositionCodeGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallCenterCallDispositionCodeGetRequest(OCIRequest)
Get a Call Center Call Disposition Code.
The response is either EnterpriseCallCenterCallDispositionCodeGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| code | str | code |
EnterpriseCallCenterCallDispositionCodeGetUsageListRequest(OCIRequest)
Get the list of Call Centers and Route Points using the specified disposition code.
The response is either EnterpriseCallCenterCallDispositionCodeGetUsageListResponse()
or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| code | str | code |
EnterpriseCallCenterCallDispositionCodeModifyRequest(OCIRequest)
Modify a Call Center Call Disposition Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| code | str | code |
| is_active | bool | isActive Optional |
| description | str | description Optional |
EnterpriseCallCenterCurrentAndPastDNISGetListRequest(OCIRequest)
Request to get all the past and current DNIS for the Call Center for the enterprise.
The response is either EnterpriseCallCenterCurrentAndPastDNISGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| service_user_id | str | serviceUserId |
EnterpriseCallCenterEnhancedReportingBrandingGetRequest(OCIRequest)
Request to get the enterprise branding information.
The response is either EnterpriseCallCenterEnhancedReportingBrandingGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallCenterEnhancedReportingGetAvailableReportTemplateListRequest(OCIRequest)
Request to get all enabled call center report template for an enterprise.
The response is either an
EnterpriseCallCenterEnhancedReportingGetAvailableReportTemplateListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallCenterEnhancedReportingGetRequest(OCIRequest)
Request to get an enterprise level call center enhanced reporting setting.
The response is either an EnterpriseCallCenterEnhancedReportingGetResponse() or an
ErrorResponse(). Replaced by EnterpriseCallCenterEnhancedReportingGetRequest19()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallCenterEnhancedReportingGetRequest19(OCIRequest)
Request to get an enterprise level call center enhanced reporting setting.
The response is either an EnterpriseCallCenterEnhancedReportingGetResponse19() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallCenterEnhancedReportingModifyRequest(OCIRequest)
Request to modify enterprise level call center enhanced reporting settings.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by
EnterpriseCallCenterEnhancedReportingModifyRequest19()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| reporting_server | str | reportingServer Optional |
| web_statistic_source | str | webStatisticSource Optional |
EnterpriseCallCenterEnhancedReportingModifyRequest19(OCIRequest)
Request to modify enterprise level call center enhanced reporting settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| reporting_server | str | reportingServer Optional |
EnterpriseCallCenterEnhancedReportingReportTemplateDeleteRequest(OCIRequest)
Request to delete an enterprise level call center report template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
EnterpriseCallCenterEnhancedReportingReportTemplateGetListRequest(OCIRequest)
Request to get enterprise level call center report template list.
The response is either an
EnterpriseCallCenterEnhancedReportingReportTemplateGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallCenterEnhancedReportingReportTemplateGetRequest(OCIRequest)
Request to get an enterprise level call center report template.
The response is either an
EnterpriseCallCenterEnhancedReportingReportTemplateGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
EnterpriseCallCenterEnhancedReportingScheduledReportDeleteRequest(OCIRequest)
Request to delete an enterprise level call center reporting scheduled report.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
EnterpriseCallCenterEnhancedReportingScheduledReportGetReportTemplateUsageListRequest(OCIRequest)
Request to get all the call center reporting scheduled report in an enterprise that uses a given enterprise level report template.
The response is either a
EnterpriseCallCenterEnhancedReportingScheduledReportGetReportTemplateUsageListResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
EnterpriseCallCenterEnhancedReportingScheduledReportGetRequest(OCIRequest)
Request to get an enterprise level call center reporting scheduled report.
The response is either an
EnterpriseCallCenterEnhancedReportingScheduledReportGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
EnterpriseCallCenterGetRequest(OCIRequest)
Request the enterprise level data associated with Call Center.
The response is either an EnterpriseCallCenterGetResponse() or an ErrorResponse().
Replaced by EnterpriseCallCenterGetRequest17sp4().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallCenterGetRequest17sp4(OCIRequest)
Request the enterprise level data associated with Call Center.
The response is either an EnterpriseCallCenterGetResponse17sp4() or an
ErrorResponse(). Replaced by: EnterpriseCallCenterGetResponse23() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallCenterGetRequest23(OCIRequest)
Request the enterprise level data associated with Call Center.
The response is either an EnterpriseCallCenterGetResponse23() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallCenterGetRoutingPolicyRequest(OCIRequest)
Request the enterprise call center routing policy.
The response is either an EnterpriseCallCenterGetRoutingPolicyResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallCenterModifyRequest(OCIRequest)
Modify the enterprise level data associated with Call Center The response is either a
SuccessResponse() or an ErrorResponse().
The following elements are only used in AS data mode and ignored in XS data mode: useSystemDefaultUnavailableSettings forceAgentUnavailableOnDNDActivation forceAgentUnavailableOnPersonalCalls forceAgentUnavailableOnBouncedCallLimit numberConsecutiveBouncedCallsToForceAgentUnavailable forceAgentUnavailableOnNotReachable wrapUpDestination
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| use_system_default_guard_timer | bool | useSystemDefaultGuardTimer Optional |
| enable_guard_timer | bool | enableGuardTimer Optional |
| guard_timer_seconds | int | guardTimerSeconds Optional |
| use_system_default_unavailable_settings | bool | useSystemDefaultUnavailableSettings Optional |
| force_agent_unavailable_on_dnd_activation | bool | forceAgentUnavailableOnDNDActivation Optional |
| force_agent_unavailable_on_personal_calls | bool | forceAgentUnavailableOnPersonalCalls Optional |
| force_agent_unavailable_on_bounced_call_limit | bool | forceAgentUnavailableOnBouncedCallLimit Optional |
| number_consecutive_bounced_calls_to_force_agent_unavailable | int | numberConsecutiveBouncedCallsToForceAgentUnavailable Optional |
| force_agent_unavailable_on_not_reachable | bool | forceAgentUnavailableOnNotReachable Optional |
| wrap_up_destination | str | wrapUpDestination Optional |
EnterpriseCallCenterMonitoringGetRequest(OCIRequest)
Request the enterprise level data associated with Call Center Monitoring.
The response is either an EnterpriseCallCenterMonitoringGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallCenterMonitoringGetRequest23(OCIRequest)
Request the enterprise level data associated with Call Center Monitoring.
The response is either an EnterpriseCallCenterMonitoringGetResponse23() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallCenterMonitoringModifyRequest(OCIRequest)
Modify the enterprise level data associated with Call Center Monitoring The response
is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| enable_supervisor_coaching | bool | enableSupervisorCoaching Optional |
| bypass_enforcement_of_supervisor_agent_relationship | bool | bypassEnforcementOfSupervisorAgentRelationship Optional |
EnterpriseCallRecordingGetRequest(OCIRequest)
Get the Call Recording attributes for a enterprise.
The response is either a EnterpriseCallRecordingGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseCallRecordingModifyRequest(OCIRequest)
Modify the Call Recording attributes for a enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| use_cloud_pbx | bool | useCloudPBX Optional |
| use_enterprise_setting | bool | useEnterpriseSetting Optional |
| fqdn | str | FQDN Optional |
EnterpriseCommonPhoneListDeleteListRequest(OCIRequest)
Delete one or more entries from an enterprise's common phone list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| entry_name | List[str] | entryName |
EnterpriseCommonPhoneListModifyRequest(OCIRequest)
Modify an entry in an enterprise's common phone list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| entry_name | str | entryName |
| new_entry_name | str | newEntryName Optional |
| phone_number | str | phoneNumber Optional |
EnterpriseCommunicationBarringAuthorizationCodeDeleteListRequest(OCIRequest)
Delete a list of Communication Barring Authorization Codes from an enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| code | List[str] | code Optional |
EnterpriseCommunicationBarringAuthorizationCodeGetRequest(OCIRequest)
Request the enterprise Communication Barring Authorization code settings.
The response is either a
EnterpriseCommunicationBarringAuthorizationCodeGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| code | str | code |
EnterpriseCommunicationBarringAuthorizationCodeModifyRequest(OCIRequest)
Modify the enterprise Communication Barring Authorization code settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| code | str | code |
| description | str | description Optional |
| network_class_of_service | str | networkClassOfService Optional |
EnterpriseDepartmentDeleteRequest(OCIRequest)
Delete a department from an enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enterprise_id | str | enterpriseId |
| department_name | str | departmentName |
EnterpriseDepartmentGetAvailableParentListRequest(OCIRequest)
Get a list of enterprise level departments in an enterprise that could be the parent of the specified department.
The department itself and all its decendents are not eligible to be the parent department.
The response is either EnterpriseDepartmentGetAvailableParentListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enterprise_id | str | enterpriseId |
| department_name | str | departmentName |
EnterpriseDepartmentGetListRequest(OCIRequest)
Request a list of departments in an enterprise.
You may request only the list of departments defined at the enterprise-level, or you may request the list of all departments in the enterprise including all the departments defined within the groups inside the enterprise.
The response is either EnterpriseDepartmentGetListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enterprise_id | str | enterpriseId |
| include_group_departments | bool | includeGroupDepartments |
EnterpriseEnterpriseTrunkAddRequest(OCIRequest)
Request to add an enterprise trunk in an enterprise.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
EnterpriseEnterpriseTrunkAddRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| enterprise_trunk_name | str | enterpriseTrunkName |
| maximum_reroute_attempts | int | maximumRerouteAttempts |
| route_exhaustion_action | str | routeExhaustionAction |
| route_exhaustion_forward_address | str | routeExhaustionForwardAddress Optional |
| ordered_routing | OCI.orderedRouting | orderedRouting Optional |
| priority_weighted_routing | OCI.priorityWeightedRouting | priorityWeightedRouting Optional |
EnterpriseEnterpriseTrunkAddRequest21(OCIRequest)
Request to add an enterprise trunk in an enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| enterprise_trunk_name | str | enterpriseTrunkName |
| maximum_reroute_attempts | int | maximumRerouteAttempts |
| route_exhaustion_action | str | routeExhaustionAction |
| route_exhaustion_forward_address | str | routeExhaustionForwardAddress Optional |
| ordered_routing | OCI.orderedRouting | orderedRouting Optional |
| priority_weighted_routing | OCI.priorityWeightedRouting | priorityWeightedRouting Optional |
| enable_capacity_management | bool | enableCapacityManagement |
| max_active_calls | int | maxActiveCalls Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls Optional |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls Optional |
| maximum_active_incoming_calls_allowed | int | maximumActiveIncomingCallsAllowed Optional |
| maximum_active_outgoing_calls_allowed | int | maximumActiveOutgoingCallsAllowed Optional |
| minimum_active_calls_reserved | int | minimumActiveCallsReserved Optional |
EnterpriseEnterpriseTrunkAddUserListRequest(OCIRequest)
Request to add users to an enterprise trunk in an enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| enterprise_trunk_name | str | enterpriseTrunkName |
| user_id | List[str] | userId |
EnterpriseEnterpriseTrunkDeleteRequest(OCIRequest)
Request to delete an enterprise trunk in an enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| enterprise_trunk_name | str | enterpriseTrunkName |
EnterpriseEnterpriseTrunkDeleteUserListRequest(OCIRequest)
Request to delete users from an enterprise trunk in an enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| enterprise_trunk_name | str | enterpriseTrunkName |
| user_id | List[str] | userId |
EnterpriseEnterpriseTrunkForceAssignUserListRequest(OCIRequest)
Request to add users to an enterprise trunk in an enterprise.
If the user is already assigned to another enterprise trunk, it will be unassigned from the old enterprise trunk and assigned to the new enterprise trunk specified in this request.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| enterprise_trunk_name | str | enterpriseTrunkName |
| user_id | List[str] | userId |
EnterpriseEnterpriseTrunkGetListRequest(OCIRequest)
Request to get the list of all enterprise trunks defined in an enterprise.
The response is either a EnterpriseEnterpriseTrunkGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseEnterpriseTrunkGetRequest(OCIRequest)
Request to get an enterprise trunk The response is either an
EnterpriseEnterpriseTrunkGetResponse() or an ErrorResponse().
Replaced by: EnterpriseEnterpriseTrunkGetRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| enterprise_trunk_name | str | enterpriseTrunkName |
EnterpriseEnterpriseTrunkGetRequest21(OCIRequest)
Request to get an enterprise trunk The response is either an
EnterpriseEnterpriseTrunkGetResponse21() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| enterprise_trunk_name | str | enterpriseTrunkName |
EnterpriseEnterpriseTrunkGetRequest22(OCIRequest)
Request to get an enterprise trunk The response is either an
EnterpriseEnterpriseTrunkGetResponse21() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| enterprise_trunk_name | str | enterpriseTrunkName |
EnterpriseEnterpriseTrunkModifyRequest(OCIRequest)
Request to modify an enterprise trunk in an enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| enterprise_trunk_name | str | enterpriseTrunkName |
| new_enterprise_trunk_name | str | newEnterpriseTrunkName Optional |
| maximum_reroute_attempts | int | maximumRerouteAttempts Optional |
| route_exhaustion_action | str | routeExhaustionAction Optional |
| route_exhaustion_forward_address | str | routeExhaustionForwardAddress Optional |
| ordered_routing | OCI.orderedRouting | orderedRouting Optional |
| priority_weighted_routing | OCI.priorityWeightedRouting | priorityWeightedRouting Optional |
| enable_capacity_management | bool | enableCapacityManagement Optional |
| max_active_calls | int | maxActiveCalls Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls Optional |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls Optional |
| maximum_active_incoming_calls_allowed | int | maximumActiveIncomingCallsAllowed Optional |
| maximum_active_outgoing_calls_allowed | int | maximumActiveOutgoingCallsAllowed Optional |
| minimum_active_calls_reserved | int | minimumActiveCallsReserved Optional |
EnterpriseLocalGatewayGetUsageRequest(OCIRequest)
Get usage details of a local gateway under an enterprise.
The response is either EnterpriseLocalGatewayGetUsageResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| trunk_group_name | str | trunkGroupName |
EnterprisePreAlertingAnnouncementGetRequest(OCIRequest)
Get the Enterprise pre-alerting service settings.
The response is either a EnterprisePreAlertingAnnouncementGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseRouteListEnterpriseTrunkNumberPrefixGetAvailableListRequest(OCIRequest)
Request a list of number prefixes that are assigned to an enterprise and still available for assignment to users within the enterprise.
The response is either
EnterpriseRouteListEnterpriseTrunkNumberPrefixGetAvailableListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseRouteListEnterpriseTrunkNumberPrefixGetSummaryListRequest(OCIRequest)
Request a summary table of all enterprise trunk number prefixes in the enterprise.
The response is either
EnterpriseRouteListEnterpriseTrunkNumberPrefixGetSummaryListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest(OCIRequest)
Request a list of number ranges that are assigned to an enterprise and still available for assignment to users within the enterprise.
The response is either
EnterpriseRouteListEnterpriseTrunkNumberRangeGetAvailableListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest(OCIRequest)
Request a summary table of all enterprise trunk number ranges in the enterprise.
The response is either
EnterpriseRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseSecurityClassificationCustomizationGetAvailableListRequest(OCIRequest)
Get the enterprise security classification list.
If it is not customized, it returns the system default list.
The response is either an
EnterpriseSecurityClassificationCustomizationGetAvailableListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseSessionAdmissionControlGroupDeleteListRequest(OCIRequest)
Request to delete one or more session admission control groups for the enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | List[str] | name |
EnterpriseSessionAdmissionControlGroupGetListRequest(OCIRequest)
Request to get the list of session admission control group for the enterprise.
The response is either an EnterpriseSessionAdmissionControlGroupGetListResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseSessionAdmissionControlGroupGetRequest(OCIRequest)
Request to get a session admission control group for the enterprise.
The response is either an EnterpriseSessionAdmissionControlGroupGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
EnterpriseSessionAdmissionControlGroupGetRequest19sp1(OCIRequest)
Request to get a session admission control group for the enterprise.
The response is either an EnterpriseSessionAdmissionControlGroupGetResponse19sp1()
or an ErrorResponse(). Replaced by:
EnterpriseSessionAdmissionControlGroupGetRequest21sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
EnterpriseSessionAdmissionControlGroupGetRequest21sp1(OCIRequest)
Request to get a session admission control group for the enterprise.
The response is either an EnterpriseSessionAdmissionControlGroupGetResponse21sp1()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
EnterpriseVoiceVPNDeletePolicyRequest(OCIRequest)
Delete a enterprise voice VPN location.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| location_dialing_code | str | locationDialingCode |
EnterpriseVoiceVPNGetDefaultRequest(OCIRequest)
Request the Voice VPN default settings for the enterprise.
The response is EnterpriseVoiceVPNGetDefaultResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseVoiceVPNGetPolicyRequest(OCIRequest)
Request the enterprise level data associated with Voice VPN location code.
The response is either a EnterpriseVoiceVPNGetPolicyResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| location_dialing_code | str | locationDialingCode |
EnterpriseVoiceVPNGetRequest(OCIRequest)
Request the enterprise level data associated with Voice VPN.
The response is either a EnterpriseVoiceVPNGetResponse() or an ErrorResponse().
Replaced By: EnterpriseVoiceVPNGetRequest14sp3()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseVoiceVPNGetRequest14sp3(OCIRequest)
Request the enterprise level data associated with Voice VPN.
The response is either a EnterpriseVoiceVPNGetResponse14sp3() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
EnterpriseVoiceVPNModifyRequest(OCIRequest)
Modify the enterprise voice VPN level data associated with voice VPN.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| is_active | bool | isActive Optional |
| default_selection | str | defaultSelection Optional |
| e164_selection | str | e164Selection Optional |
| use_phone_context | bool | usePhoneContext Optional |
ExternalAuthenticationAuthorizeTokenRequest(OCIRequest)
This command is part of the Portal API.
Sent when a Web or CLI user logs in using external authentication. The password must be hashed. The password hashing algorithm is: 1) The message digest of the user's plain password is calculated using the SHA algorithm. 2) For every four bits in the 160-bit digest, starting from the first bit, it is converted into a character in ASCII Hex format (0 through 9, a through f). The result is a 40-character string, for example, f7a9e24777ec23212c54d7a350bc5bea5477fdbb. 3) The above string then is used to populate the password field in the request.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| password | str | password Optional |
| login_token | str | loginToken |
ExternalAuthenticationAuthorizeTokenRequest22(OCIRequest)
This command is part of the Portal API.
Sent when a Web or CLI user logs in using external authentication. The hashed password value in the request is supported only when the request is sent from the CommPilot web portal.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| password | str | password Optional |
| is_password_hashed | bool | isPasswordHashed Optional |
| login_token | str | loginToken |
ExternalAuthenticationCreateLoginTokenRequest(OCIRequest)
This command allows a BroadWorks or Third-Party Client Application to create a Single Sign-On token for a user.
The response is either ExternalAuthenticationCreateLoginTokenResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupAccessDeviceCustomTagAddRequest(OCIRequest)
Request to add a static configuration tag for a group access device.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| tag_name | str | tagName |
| tag_value | str | tagValue Optional |
GroupAccessDeviceCustomTagDeleteListRequest(OCIRequest)
Request to delete static configuration tags for a group access device.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| tag_name | List[str] | tagName |
GroupAccessDeviceCustomTagGetListRequest(OCIRequest)
Request to get the list of custom configuration tags managed by the Device Management System, on a per-device profile basis.
The response is either GroupAccessDeviceCustomTagGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupAccessDeviceCustomTagModifyRequest(OCIRequest)
Request to modify a static configuration tag for a group access device.
The tagValueToEncrypt element can only be used by a system administrator. The following elements are only used in XS data mode and ignored in AS data mode: tagValueToEncrypt
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| tag_name | str | tagName |
| tag_value | str | tagValue Optional |
| tag_value_to_encrypt | str | tagValueToEncrypt Optional |
GroupAccessDeviceDeleteRequest(OCIRequest)
Request to delete a specified group access device.
The following elements are only used in AS data mode and ignored in XS data mode: deviceExternalId
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
GroupAccessDeviceDeviceActivationGetRequest(OCIRequest)
Requests the activation information for a device configured at the Group level.
Returns a GroupAccessDeviceDeviceActivationGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupAccessDeviceDeviceActivationModifyRequest(OCIRequest)
Activates or deactivates a device configured at the Group level.
It is only possible for this request to activate a device which is deactivated.
Trying to activate a device in the activating state will result in an error response
since only the DAS is allowed to execute this operation. Returns a
SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| activate_device | bool | activateDevice |
GroupAccessDeviceFileGetListRequest(OCIRequest)
Request to get the list of device files managed by the Device Management System, on a per-device profile basis.
The response is either GroupAccessDeviceFileGetListResponse() or ErrorResponse().
Replaced By: GroupAccessDeviceFileGetListRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupAccessDeviceFileGetListRequest14sp8(OCIRequest)
Request to get the list of device files managed by the Device Management System, on a per-device profile basis.
The response is either GroupAccessDeviceFileGetListResponse14sp8() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupAccessDeviceFileGetRequest(OCIRequest)
Request to get a group device profile file.
The response is either GroupAccessDeviceFileGetResponse() or ErrorResponse().
Replaced By: GroupAccessDeviceFileGetRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| file_type | str | fileType |
GroupAccessDeviceFileGetRequest14sp8(OCIRequest)
Request to get a group device profile file.
The response is either GroupAccessDeviceFileGetResponse14sp8() or ErrorResponse().
Replaced by: GroupAccessDeviceFileGetRequest16sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| file_format | str | fileFormat |
GroupAccessDeviceFileGetRequest16sp1(OCIRequest)
Request to get a group device profile file.
The response is either GroupAccessDeviceFileGetResponse16sp1() or ErrorResponse().
Replaced by: GroupAccessDeviceFileGetRequest20()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| file_format | str | fileFormat |
GroupAccessDeviceFileGetRequest20(OCIRequest)
Request to get a group device profile file.
The response is either GroupAccessDeviceFileGetResponse20() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| file_format | str | fileFormat |
GroupAccessDeviceGenerateActivationCodeRequest(OCIRequest)
Requests a new activation code for a device configured at the Group level.
Returns a SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupAccessDeviceGetAvailableCustomTagListRequest(OCIRequest)
Get the list of all available custom tags managed by the Device Management System, on a per-device profile basis.
The response is either GroupAccessDeviceGetAvailableCustomTagListResponse() or
ErrorResponse(). The following elements are used in AS mode and ignored in XS data
mode: tagSetName
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| tag_set_name | str | tagSetName Optional |
GroupAccessDeviceGetAvailableDetailListRequest14(OCIRequest)
Requests the list of available access devices for assignment to a user within a group.
The list includes devices created at the system, service provider, and group levels.
The response is either GroupAccessDeviceGetAvailableDetailListResponse14() or
ErrorResponse(). Replaced by: GroupAccessDeviceGetAvailableDetailListRequest19().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| is_music_on_hold | bool | isMusicOnHold |
| only_video_capable | bool | onlyVideoCapable |
GroupAccessDeviceGetAvailableDetailListRequest19(OCIRequest)
Requests the list of available access devices for assignment to a user within a group.
The list includes devices created at the system, service provider, and group levels. The following elements are used in AS mode and ignored in XS data mode: onlyIntelligentDevice
The response is either GroupAccessDeviceGetAvailableDetailListResponse19() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| is_music_on_hold | bool | isMusicOnHold |
| only_video_capable | bool | onlyVideoCapable |
| only_intelligent_device | bool | onlyIntelligentDevice Optional |
GroupAccessDeviceGetEnhancedConfigurationTypeListRequest(OCIRequest)
Requests the list of configurable device types of devices that have already been added to the group.
The response is either GroupAccessDeviceGetEnhancedConfigurationTypeListResponse()
or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupAccessDeviceGetEnhancedConfigurationTypeRequest14(OCIRequest)
Requests the details of a specified configurable device type for a group.
The response is either GroupAccessDeviceGetEnhancedConfigurationTypeResponse14() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
GroupAccessDeviceGetLinkedLeafDeviceListRequest(OCIRequest)
Requests the list of linked leaf devices for the group level tree device passed in the request.
A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device". It can be linked to only one tree device. The list includes devices created at the system, service provider, and group levels.
The response is either GroupAccessDeviceGetLinkedLeafDeviceListResponse() or
ErrorResponse(). Replaced by: GroupAccessDeviceGetLinkedLeafDeviceListRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupAccessDeviceGetLinkedLeafDeviceListRequest22(OCIRequest)
Requests the list of linked leaf devices for the group level tree device passed in the request.
A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device. The list includes devices created at the system, service provider, and group levels. If the leafDeviceCategory is not set in the request, then linked leaf devices of all categories are requested, otherwise only the linked leaf devices of the specified category are requested. The category values are: "Handset", "Base Station", "All".
The response is either GroupAccessDeviceGetLinkedLeafDeviceListResponse22() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| leaf_device_category | str | leafDeviceCategory Optional |
GroupAccessDeviceGetLinkedTreeDeviceRequest(OCIRequest)
Requests the tree device linked with the group level leaf device passed in the request.
A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device.
The response is either GroupAccessDeviceGetLinkedTreeDeviceResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupAccessDeviceGetNativeTagsWithLogicListRequest(OCIRequest)
Get the list of all native tags with logic managed by the Device Management System, on a per-device profile basis.
The response is either GroupAccessDeviceGetAvailableCustomTagListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupAccessDeviceGetRequest14(OCIRequest)
Requests the configuration of a specified group access device.
The response is either GroupAccessDeviceGetResponse14() or ErrorResponse().
Replaced By: GroupAccessDeviceGetRequest14sp3()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupAccessDeviceGetRequest14sp3(OCIRequest)
Requests the configuration of a specified group access device.
The response is either GroupAccessDeviceGetResponse14sp3() or ErrorResponse().
Replaced By: GroupAccessDeviceGetRequest14sp6()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupAccessDeviceGetRequest14sp6(OCIRequest)
Requests the configuration of a specified group access device.
The response is either GroupAccessDeviceGetResponse14sp6() or ErrorResponse().
Replaced by: GroupAccessDeviceGetRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupAccessDeviceGetRequest16(OCIRequest)
Requests the configuration of a specified group access device.
The response is either GroupAccessDeviceGetResponse16() or ErrorResponse().
Replaced by: GroupAccessDeviceGetRequest18sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupAccessDeviceGetRequest18sp1(OCIRequest)
Requests the configuration of a specified group access device.
The response is either GroupAccessDeviceGetResponse18sp1() or ErrorResponse().
Replaced by: GroupAccessDeviceGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupAccessDeviceGetRequest22(OCIRequest)
Requests the configuration of a specified group access device.
The response is either GroupAccessDeviceGetResponse22() or ErrorResponse().
Replaced by: GroupAccessDeviceGetRequest24()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupAccessDeviceGetRequest22V2(OCIRequest)
Requests the configuration of a specified group access device.
The response is either GroupAccessDeviceGetResponse22V2() or ErrorResponse(). The
following elements are only used in AS data mode and ignored in XS data mode:
deviceExternalId Replaced by: GroupAccessDeviceGetRequest24() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
GroupAccessDeviceGetRequest22V3(OCIRequest)
Requests the configuration of a specified group access device.
The response is either GroupAccessDeviceGetResponse22V3() or ErrorResponse().
Replaced by: GroupAccessDeviceGetRequest24()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
GroupAccessDeviceGetRequest22V4(OCIRequest)
Requests the configuration of a specified group access device.
The response is either GroupAccessDeviceGetResponse22V4() or ErrorResponse().
Replaced by: GroupAccessDeviceGetRequest24V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
GroupAccessDeviceGetRequest22V5(OCIRequest)
Requests the configuration of a specified group access device.
The response is either GroupAccessDeviceGetResponse22V5() or ErrorResponse().
Replaced by: GroupAccessDeviceGetRequest24V3()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
GroupAccessDeviceGetRequest24(OCIRequest)
Requests the configuration of a specified group access device.
The response is either GroupAccessDeviceGetResponse24() or ErrorResponse().
Replaced by: GroupAccessDeviceGetRequest24V2() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
GroupAccessDeviceGetRequest24V2(OCIRequest)
Requests the configuration of a specified group access device.
The response is either GroupAccessDeviceGetResponse24V2() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
GroupAccessDeviceGetRequest24V3(OCIRequest)
Requests the configuration of a specified group access device.
The response is either GroupAccessDeviceGetResponse24V3() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
GroupAccessDeviceModifyUserRequest(OCIRequest)
Request to modify attributes for line/ports assigned on the group device profile.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in XS data mode and ignored in AS data mode: privateIdentity
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| line_port | str | linePort |
| private_identity | str | privateIdentity Optional |
| is_primary_line_port | bool | isPrimaryLinePort Optional |
GroupAccessDeviceResetRequest(OCIRequest)
Reset a specific group SIP device that supports the reset operation.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupAccessDeviceTagSetGetRequest(OCIRequest)
Request to get the custom configuration tag set defined at the access device.
The response is either GroupAccessDeviceTagSetGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupAccessDeviceTagSetModifyRequest(OCIRequest)
Request to modify a static configuration tag set.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| tag_set_name | str | tagSetName Optional |
GroupAccountAuthorizationCodesDeleteListRequest(OCIRequest)
Delete a list of account/authorization codes from a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| code | List[str] | code |
GroupAccountAuthorizationCodesGetListRequest(OCIRequest)
Request the list of account/authorization codes for a group.
The response is either a GroupAccountAuthorizationCodesGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupAccountAuthorizationCodesGetRequest(OCIRequest)
Request the group's account/authorization codes setting.
The response is either a GroupAccountAuthorizationCodesGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupAdminAddRequest(OCIRequest)
Add a group administrator.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| user_id | str | userId |
| first_name | str | firstName Optional |
| last_name | str | lastName Optional |
| password | str | password Optional |
| language | str | language Optional |
GroupAdminAlternateIdAddRequest(OCIRequest)
Request to add an alternate admin Id to a group administrator.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| alternate_user_id | str | alternateUserId |
| description | str | description Optional |
GroupAdminAlternateIdDeleteRequest(OCIRequest)
Request to delete an alternate admin user id of a group administrator.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| alternate_user_id | str | alternateUserId |
GroupAdminAlternateIdGetListRequest(OCIRequest)
Request to get the admin id and the list of alternate admin ids of an admin.
The response is either GroupAdminAlternateIdGetListResponse() or ErrorResponse().
The "userId" can be either the admin user Id or an alternate admin user Id.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupAdminAlternateIdModifyRequest(OCIRequest)
Request to modify an alternate id of a group admin.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| alternate_user_id | str | alternateUserId |
| new_alternate_user_id | str | newAlternateUserId Optional |
| description | str | description Optional |
GroupAdminDeleteRequest(OCIRequest)
Delete a group administrator.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupAdminGetListRequest(OCIRequest)
Get a list of group and department administrators within the group.
The response is either a GroupAdminGetListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupAdminGetPolicyRequest(OCIRequest)
Requests the Group administrator's policy settings.
The response is either GroupAdminGetPolicyResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupAdminGetPolicyRequest14sp1(OCIRequest)
Requests the Group administrator's policy settings.
The response is either GroupAdminGetPolicyResponse14sp1() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupAdminGetPolicyRequest16sp1(OCIRequest)
Requests the Group administrator's policy settings.
The response is either GroupAdminGetPolicyResponse16sp1() or ErrorResponse().
Replaced by: GroupAdminGetPolicyRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupAdminGetPolicyRequest16sp2(OCIRequest)
Requests the Group administrator's policy settings.
The response is either GroupAdminGetPolicyResponse16sp2() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupAdminGetPolicyRequest17(OCIRequest)
Requests the Group administrator's policy settings.
The response is either GroupAdminGetPolicyResponse17() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupAdminGetPolicyRequest17sp3(OCIRequest)
Requests the Group administrator's policy settings.
The response is either GroupAdminGetPolicyResponse17sp3() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupAdminGetPolicyRequest18(OCIRequest)
Requests the Group administrator's policy settings.
The response is either GroupAdminGetPolicyResponse18() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupAdminGetPolicyRequest19sp1(OCIRequest)
Requests the Group administrator's policy settings.
The response is either GroupAdminGetPolicyResponse19sp1() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupAdminGetPolicyRequest20(OCIRequest)
Requests the Group administrator's policy settings.
The response is either GroupAdminGetPolicyResponse20() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupAdminGetRequest(OCIRequest)
Get a group administrators profile.
The response is either a GroupAdminGetResponse() or an ErrorResponse(). Replaced
by GroupAdminGetRequest21sp1().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupAdminGetRequest21sp1(OCIRequest)
Get a group administrators profile.
The response is either a GroupAdminGetResponse21sp1() or an ErrorResponse().
Replaced by: GroupAdminGetRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupAdminGetRequest22(OCIRequest)
Get a group administrators profile.
The response is either a GroupAdminGetResponse22() or an ErrorResponse(). Replaced
by: GroupAdminGetRequest22V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupAdminGetRequest22V2(OCIRequest)
Get a group administrators profile.
The response is either a GroupAdminGetResponse22V2() or an ErrorResponse().
Replaced by: GroupAdminGetRequest22V3()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupAdminGetRequest22V3(OCIRequest)
Get a group administrators profile.
The response is either a GroupAdminGetResponse22V3() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupAdminModifyPolicyRequest(OCIRequest)
Request to modify the group administrator's policy settings.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode: dialableCallerIDAccess
verifyTranslationAndRoutingAccess communicationBarringUserProfileAccess (only
applicable to groups in an Enterprise)
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| profile_access | str | profileAccess Optional |
| user_access | str | userAccess Optional |
| admin_access | str | adminAccess Optional |
| department_access | str | departmentAccess Optional |
| access_device_access | str | accessDeviceAccess Optional |
| enhanced_service_instance_access | str | enhancedServiceInstanceAccess Optional |
| feature_access_code_access | str | featureAccessCodeAccess Optional |
| phone_number_extension_access | str | phoneNumberExtensionAccess Optional |
| calling_line_id_number_access | str | callingLineIdNumberAccess Optional |
| service_access | str | serviceAccess Optional |
| trunk_group_access | str | trunkGroupAccess Optional |
| session_admission_control_access | str | sessionAdmissionControlAccess Optional |
| office_zone_access | str | officeZoneAccess Optional |
| dialable_caller_id_access | str | dialableCallerIDAccess Optional |
| number_activation_access | str | numberActivationAccess Optional |
| verify_translation_and_routing_access | str | verifyTranslationAndRoutingAccess Optional |
| communication_barring_user_profile_access | str | communicationBarringUserProfileAccess Optional |
GroupAdminModifyRequest(OCIRequest)
Modify a group administrator.
Since old password is not specified here, any password rule related to old password does not apply.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode. accountDisabled
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| first_name | str | firstName Optional |
| last_name | str | lastName Optional |
| password | str | password Optional |
| language | str | language Optional |
| account_disabled | bool | accountDisabled Optional |
GroupAdministratorPasswordRulesGetRequest(OCIRequest)
Requests the effective password rules setting for a group administrator.
The response is either GroupAdministratorPasswordRulesGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupAdviceOfChargeGetRequest(OCIRequest)
Request to get the list of Advice of Charge group parameters.
The response is either GroupAdviceOfChargeGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupAdviceOfChargeModifyRequest(OCIRequest)
Modify the service provider level Advice Of Charge group settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_group_level_ao_c_settings | bool | useGroupLevelAoCSettings Optional |
| delay_between_notification_seconds | int | delayBetweenNotificationSeconds Optional |
GroupAnnouncementRepositoryGetSettingsRequest(OCIRequest)
Return the disk space being used.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupApplicationServerSetGetRequest(OCIRequest)
Get the Application Server set for a group.
The response is either a GroupApplicationServerSetGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupApplicationServerSetModifyRequest(OCIRequest)
Modify the Application Server set for a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| application_server_set_name | str | applicationServerSetName Optional |
GroupAutoAttendantConsolidatedDeleteInstanceRequest(OCIRequest)
Delete a Auto Attendant instance from a group and free up phone numbers.
If UnassignPhoneNumbersLevel is set to 'Group', the user's primary phone number, fax
number and any alternate numbers, will be un-assigned from the group if the command is
executed by a service provider administrator or above. When set to 'Service
Provider', they will be un-assigned from the group and service provider if the command
is executed by a provisioning administrator or above. When omitted, the number(s)
will be left assigned to the group. An ErrorResponse() will be returned if any
number cannot be unassigned because of insufficient privilege.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| unassign_phone_numbers | str | unassignPhoneNumbers Optional |
GroupAutoAttendantDeleteInstanceRequest(OCIRequest)
Delete a Auto Attendant instance from a group.
If UnassignPhoneNumbersLevel is set to 'Group', the user's primary phone number, fax
number and any alternate numbers, will be unassigned from the group if the command is
executed by a service provider administrator or above. When set to 'Service
Provider', they will be unassigned from the group and service provider if the command
is executed by a provisioning administrator or above. When omitted, the number(s)
will be left assigned to the group. An ErrorResponse() with the type warning will
be returned if any number cannot be unassigned because of insufficient privilege.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupAutoAttendantGetInstanceListRequest(OCIRequest)
Get a list of Auto Attendant instances within a group.
The response is either GroupAutoAttendantGetInstanceListResponse() or
ErrorResponse(). It is possible to get the instances within a specified department.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_department_name | str | groupDepartmentName Optional |
GroupAutoAttendantGetInstanceRequest14(OCIRequest)
Request to get all the information of a Auto Attendant instance.
The response is either GroupAutoAttendantGetInstanceResponse() or ErrorResponse().
Replaced By: GroupAutoAttendantGetInstanceRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupAutoAttendantGetInstanceRequest16(OCIRequest)
Request to get all the information of a Auto Attendant instance.
The response is either GroupAutoAttendantGetInstanceResponse16() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupAutoAttendantGetInstanceRequest17(OCIRequest)
Request to get all the information of a Auto Attendant instance.
The response is either GroupAutoAttendantGetInstanceResponse17() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupAutoAttendantGetInstanceRequest17sp1(OCIRequest)
Request to get all the information of a Auto Attendant instance.
The response is either GroupAutoAttendantGetInstanceResponse17sp1() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupAutoAttendantGetInstanceRequest19(OCIRequest)
Request to get all the information of a Auto Attendant instance.
The response is either GroupAutoAttendantGetInstanceResponse19() or
ErrorResponse(). Replaced by: GroupAutoAttendantGetInstanceRequest19sp1() in AS
data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupAutoAttendantGetInstanceRequest19sp1(OCIRequest)
Request to get all the information of a Auto Attendant instance.
The response is either GroupAutoAttendantGetInstanceResponse19sp1() or
ErrorResponse(). Replaced by: GroupAutoAttendantGetInstanceRequest20() in AS data
mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupAutoAttendantGetInstanceRequest20(OCIRequest)
Request to get all the information of a Auto Attendant instance.
The response is either GroupAutoAttendantGetInstanceResponse20() or
ErrorResponse(). Replaced by: GroupAutoAttendantGetInstanceRequest24() in AS data
mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupAutoAttendantGetInstanceRequest24(OCIRequest)
Request to get all the information of an Auto Attendant instance.
The response is either GroupAutoAttendantGetInstanceResponse24() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupAutoAttendantSubmenuDeleteListRequest(OCIRequest)
Delete a submenu form an auto attendant.
The response is either SuccessResponse() or ErrorResponse(). This request is only
valid for Standard auto attendants.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| submenu_id | List[str] | submenuId |
GroupAutoAttendantSubmenuGetListRequest(OCIRequest)
Get a list of Auto Attendant Submenus.
The response is either GroupAutoAttendantSubmenuGetListResponse() or
ErrorResponse(). This request is only valid for Standard auto attendants.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupAutoAttendantSubmenuGetRequest(OCIRequest)
Request to get an Auto Attendant submenu instance.
The response is either GroupAutoAttendantSubmenuGetResponse() or ErrorResponse().
This request is only valid for Standard auto attendants. Replaced by:
GroupAutoAttendantSubmenuGetRequest20() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| submenu_id | str | submenuId |
GroupAutoAttendantSubmenuGetRequest20(OCIRequest)
Request to get an Auto Attendant submenu instance.
The response is either GroupAutoAttendantSubmenuGetResponse20() or
ErrorResponse(). This request is only valid for Standard auto attendants.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| submenu_id | str | submenuId |
GroupAutoAttendantSubmenuGetUsageListRequest(OCIRequest)
Get a list of Auto Attendant Business Hours Menu,After Hours Menu,Holiday Menu and Submenus that use this submenu.
The response is either GroupAutoAttendantSubmenuGetUsageListResponse() or
ErrorResponse(). This request is only valid for Standard auto attendants.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| submenu_id | str | submenuId |
GroupBroadWorksAnywhereDeleteInstanceRequest(OCIRequest)
Delete a BroadWorks Anywhere instance from a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupBroadWorksAnywhereGetInstanceListRequest(OCIRequest)
Get a list of BroadWorks Anywhere instances within a group.
The response is either GroupBroadWorksAnywhereGetInstanceListResponse() or
ErrorResponse(). It is possible to get the instances within a specified department.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_department_name | str | groupDepartmentName Optional |
GroupBroadWorksAnywhereGetInstanceRequest(OCIRequest)
Request to get all the information of a BroadWorks Anywhere instance.
The response is either GroupBroadWorksAnywhereGetInstanceResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupBroadWorksAnywhereGetInstanceRequest17(OCIRequest)
Request to get all the information of a BroadWorks Anywhere instance.
The response is either GroupBroadWorksAnywhereGetInstanceResponse17() or
ErrorResponse(). Replaced by: GroupBroadWorksAnywhereGetInstanceRequest19sp1() in
AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupBroadWorksAnywhereGetInstanceRequest19sp1(OCIRequest)
Request to get all the information of a BroadWorks Anywhere instance.
The response is either GroupBroadWorksAnywhereGetInstanceResponse19sp1() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupBroadWorksMobilityGetRequest(OCIRequest)
Get the groups BroadWorks Mobility settings.
The response is either a GroupBroadWorksMobilityGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupBroadWorksMobilityGetRequest19sp1(OCIRequest)
Get the group's BroadWorks Mobility settings.
The response is either a GroupBroadWorksMobilityGetResponse19sp1() or an
ErrorResponse(). Replaced by: GroupBroadWorksMobilityGetRequest22() in AS data
mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupBroadWorksMobilityGetRequest21sp1(OCIRequest)
Get the group's BroadWorks Mobility settings.
The response is either a GroupBroadWorksMobilityGetResponse21sp1() or an
ErrorResponse(). Replaced by GroupBroadWorksMobilityGetRequest22V2().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupBroadWorksMobilityGetRequest22(OCIRequest)
Get the group's BroadWorks Mobility settings.
The response is either a GroupBroadWorksMobilityGetResponse22() or an
ErrorResponse(). Replaced by GroupBroadWorksMobilityGetRequest22V2().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupBroadWorksMobilityGetRequest22V2(OCIRequest)
Get the group's BroadWorks Mobility settings.
The response is either a GroupBroadWorksMobilityGetResponse22V2() or an
ErrorResponse(). Replaced by GroupBroadWorksMobilityGetRequest22V3().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupBroadWorksMobilityGetRequest22V3(OCIRequest)
Get the group's BroadWorks Mobility settings.
The response is either a GroupBroadWorksMobilityGetResponse22V3() or an
ErrorResponse(). Replaced by GroupBroadWorksMobilityGetRequest22V4().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupBroadWorksMobilityGetRequest22V4(OCIRequest)
Get the group's BroadWorks Mobility settings.
The response is either a GroupBroadWorksMobilityGetResponse22V4() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupBroadWorksMobilityMobileSubscriberDirectoryNumberAssignListRequest(OCIRequest)
Assign Mobile Subscriber Directory Numbers to a group.
It is possible to add a single DN,or a list of DNs. . This command is applicable only for group in a service provider and will fail for a group in an enterprise.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| mobile_subscriber_directory_number | List[str] | mobileSubscriberDirectoryNumber Optional |
GroupBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailableListRequest(OCIRequest)
Request a list of available Mobile Subscriber Directory Numbers not yet assigned to any user.
. This command is applicable only for group in a service provider and will fail for a group in an enterprise.
The response is either
GroupBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailableListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupBroadWorksMobilityMobileSubscriberDirectoryNumberUnassignListRequest(OCIRequest)
Unassign Mobile Subscriber Directory Numbers from a group.
It is possible to unassign either: a single DN, or a list of DNs. . This command is applicable only for group in a service provider and will fail for a group in an enterprise.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| mobile_subscriber_directory_number | List[str] | mobileSubscriberDirectoryNumber Optional |
GroupCPEConfigRebuildConfigFileRequest(OCIRequest)
Rebuild the group default config file for the specified device type.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
| force | bool | force Optional |
GroupCPEConfigRebuildDeviceConfigFileRequest(OCIRequest)
Rebuild the config file for a specified device.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: force
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| force | bool | force Optional |
GroupCPEConfigReorderDeviceLinePortsRequest(OCIRequest)
Reorder the lines of a group device.
You can not add or delete line ports, only re-ordering the list is allowed. The
ordered list of line ports can be obtained with the GroupAccessDeviceGetRequest16()
command.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| ordered_line_port_list | List[str] | orderedLinePortList |
GroupCPEConfigResetDeviceRequest(OCIRequest)
Reset a specific group device.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupCPEConfigResetDeviceTypeRequest(OCIRequest)
Reset all the devices of the specified device type in a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
GroupCallCapacityManagementAddInstanceRequest(OCIRequest)
Adds a Call Capacity Management group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| max_active_calls_allowed | int | maxActiveCallsAllowed |
| max_incoming_active_calls_allowed | int | maxIncomingActiveCallsAllowed Optional |
| max_outgoing_active_calls_allowed | int | maxOutgoingActiveCallsAllowed Optional |
| become_default_group_for_new_users | bool | becomeDefaultGroupForNewUsers |
| user_id | List[str] | userId Optional |
GroupCallCapacityManagementAddUserListRequest(OCIRequest)
Adds one or more users to a Call Capacity Management group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| user_id | List[str] | userId |
GroupCallCapacityManagementDeleteInstanceListRequest(OCIRequest)
Deletes one or more Call Capacity Management groups.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | List[str] | name |
GroupCallCapacityManagementDeleteUserListRequest(OCIRequest)
Deletes one or more users from a Call Capacity Management group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| user_id | List[str] | userId |
GroupCallCapacityManagementGetInstanceListRequest(OCIRequest)
Request to get a list of Call Capacity Management instances within a group.
The response is either GroupCallCapacityManagementGetInstanceListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallCapacityManagementGetInstanceRequest(OCIRequest)
Gets a Call Capacity Management group.
The response is either GroupCallCapacityManagementGetInstanceResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupCallCenterAddSupervisorListRequest(OCIRequest)
Add supervisor(s) to a call center.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| supervisor_user_id | List[str] | supervisorUserId |
GroupCallCenterAgentThresholdProfileAddAgentListRequest(OCIRequest)
Add agent(s) to a Agent Threshold Profile.
When an agent is assigned (added )to a profile, it is automatically unassigned (deleted) from the previous profile it was assigned to.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| profile_name | str | profileName |
| agent_user_id | List[str] | agentUserId |
GroupCallCenterAgentThresholdProfileAddRequest(OCIRequest)
Add a new Call Center Agent Threshold Profile in a Group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| profile_name | str | profileName |
| profile_description | str | profileDescription Optional |
| threshold_current_call_state_idle_time_yellow | int | thresholdCurrentCallStateIdleTimeYellow Optional |
| threshold_current_call_state_idle_time_red | int | thresholdCurrentCallStateIdleTimeRed Optional |
| threshold_current_call_state_on_call_time_yellow | int | thresholdCurrentCallStateOnCallTimeYellow Optional |
| threshold_current_call_state_on_call_time_red | int | thresholdCurrentCallStateOnCallTimeRed Optional |
| threshold_current_agent_state_unavailable_time_yellow | int | thresholdCurrentAgentStateUnavailableTimeYellow Optional |
| threshold_current_agent_state_unavailable_time_red | int | thresholdCurrentAgentStateUnavailableTimeRed Optional |
| threshold_average_busy_in_time_yellow | int | thresholdAverageBusyInTimeYellow Optional |
| threshold_average_busy_in_time_red | int | thresholdAverageBusyInTimeRed Optional |
| threshold_average_busy_out_time_yellow | int | thresholdAverageBusyOutTimeYellow Optional |
| threshold_average_busy_out_time_red | int | thresholdAverageBusyOutTimeRed Optional |
| threshold_average_wrap_up_time_yellow | int | thresholdAverageWrapUpTimeYellow Optional |
| threshold_average_wrap_up_time_red | int | thresholdAverageWrapUpTimeRed Optional |
| enable_notification_email | bool | enableNotificationEmail |
| notification_email_address | List[str] | notificationEmailAddress Optional |
| agent_user_id | List[str] | agentUserId Optional |
GroupCallCenterAgentThresholdProfileDeleteAgentListRequest(OCIRequest)
Delete agent(s) from a Agent Threshold Profile.
Agents cannot be unassigned (deleted) directly from the default profile, they need to be assigned (added) to a different profile.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| profile_name | str | profileName |
| agent_user_id | List[str] | agentUserId |
GroupCallCenterAgentThresholdProfileDeleteRequest(OCIRequest)
Deletes an existing Call Center Agent Threshold Profile in a Group.
The default profile cannot be deleted.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| profile_name | str | profileName |
GroupCallCenterAgentThresholdProfileGetListRequest(OCIRequest)
Get the list of Call Center Agent Threshold Profiles in the Group.
The response is either GroupCallCenterAgentThresholdProfileGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallCenterAgentThresholdProfileGetRequest(OCIRequest)
Gets an existing non-default Call Center Agent Threshold Profile in a Group.
The response is either a GroupCallCenterAgentThresholdProfileGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| profile_name | str | profileName |
GroupCallCenterAgentUnavailableCodeAddRequest(OCIRequest)
Add a Call Center Agent Unavailable Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| is_active | bool | isActive |
| code | str | code |
| description | str | description Optional |
GroupCallCenterAgentUnavailableCodeDeleteRequest(OCIRequest)
Delete a Call Center Agent Unavailable Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| code | str | code |
GroupCallCenterAgentUnavailableCodeGetListRequest(OCIRequest)
Get the list of Call Center Agent Unavailable Codes.
The response is either GroupCallCenterAgentUnavailableCodeGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallCenterAgentUnavailableCodeGetRequest(OCIRequest)
Get a Call Center Agent Unavailable Code.
The response is either GroupCallCenterAgentUnavailableCodeGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| code | str | code |
GroupCallCenterAgentUnavailableCodeModifyRequest(OCIRequest)
Modify a Call Center Agent Unavailable Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| code | str | code |
| is_active | bool | isActive Optional |
| description | str | description Optional |
GroupCallCenterAgentUnavailableCodeSettingsGetRequest(OCIRequest)
Request the group level data associated with Call Center Agents Unavailable Code Settings.
The response is either an GroupCallCenterAgentUnavailableCodeSettingsGetResponse()
or an ErrorResponse(). Replaced by
GroupCallCenterAgentUnavailableCodeSettingsGetRequest17sp4().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallCenterAgentUnavailableCodeSettingsGetRequest17sp4(OCIRequest)
Request the group level data associated with Call Center Agents Unavailable Code Settings.
The response is either a
GroupCallCenterAgentUnavailableCodeSettingsGetResponse17sp4() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallCenterBouncedCallGetRequest(OCIRequest)
Get a call center's bounced call settings.
The response is either a GroupCallCenterBouncedCallGetResponse() or an
ErrorResponse(). Replaced by: GroupCallCenterBouncedCallGetRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterBouncedCallGetRequest17(OCIRequest)
Get a call center's bounced call settings.
The response is either a GroupCallCenterBouncedCallGetResponse17() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterBouncedCallModifyRequest(OCIRequest)
Modify a call center's bounced call settings.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: enableTransfer
transferPhoneNumber bounceCallWhenAgentUnavailable alertCallCenterCallOnHold
alertCallCenterCallOnHoldSeconds bounceCallCenterCallOnHold
bounceCallCenterCallOnHoldSeconds
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| is_active | bool | isActive Optional |
| number_of_rings_before_bouncing_call | int | numberOfRingsBeforeBouncingCall Optional |
| enable_transfer | bool | enableTransfer Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| bounce_call_when_agent_unavailable | bool | bounceCallWhenAgentUnavailable Optional |
| alert_call_center_call_on_hold | bool | alertCallCenterCallOnHold Optional |
| alert_call_center_call_on_hold_seconds | int | alertCallCenterCallOnHoldSeconds Optional |
| bounce_call_center_call_on_hold | bool | bounceCallCenterCallOnHold Optional |
| bounce_call_center_call_on_hold_seconds | int | bounceCallCenterCallOnHoldSeconds Optional |
GroupCallCenterCallDispositionCodeAddRequest(OCIRequest)
Add a Call Center Call Disposition Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| code | str | code |
| is_active | bool | isActive |
| description | str | description Optional |
GroupCallCenterCallDispositionCodeDeleteRequest(OCIRequest)
Delete a Call Center Call Disposition Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| code | str | code |
GroupCallCenterCallDispositionCodeGetListRequest(OCIRequest)
Get the list of Call Center Call Disposition Codes.
The response is either GroupCallCenterCallDispositionCodeGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallCenterCallDispositionCodeGetRequest(OCIRequest)
Get a Call Center Call Disposition Code.
The response is either GroupCallCenterCallDispositionCodeGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| code | str | code |
GroupCallCenterCallDispositionCodeGetUsageListRequest(OCIRequest)
Get the list of Call Centers and Route Points using the specified disposition code.
The response is either GroupCallCenterCallDispositionCodeGetUsageListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| code | str | code |
GroupCallCenterCallDispositionCodeModifyRequest(OCIRequest)
Modify a Call Center Call Disposition Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| code | str | code |
| is_active | bool | isActive Optional |
| description | str | description Optional |
GroupCallCenterComfortMessageBypassGetRequest(OCIRequest)
Get a call center's comfort message bypass settings.
The response is either a GroupCallCenterComfortMessageBypassGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterComfortMessageBypassGetRequest17(OCIRequest)
Get a call center's comfort message bypass settings.
The response is either a GroupCallCenterComfortMessageBypassGetResponse17() or an
ErrorResponse(). Replaced by: GroupCallCenterComfortMessageBypassGetRequest20()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterComfortMessageBypassGetRequest20(OCIRequest)
Get a call center's comfort message bypass settings.
The response is either a GroupCallCenterComfortMessageBypassGetResponse20() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterCurrentAndPastDNISGetListRequest(OCIRequest)
Request to get all the past and current DNIS for the Call Center for the group.
The response is either GroupCallCenterCurrentAndPastDNISGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
GroupCallCenterDeleteAgentListRequest(OCIRequest)
Delete agent(s) from a call center.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| agent_user_id | List[str] | agentUserId |
GroupCallCenterDeleteInstanceRequest(OCIRequest)
Delete a Call Center instance from a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterDeleteSupervisorListRequest(OCIRequest)
Delete supervisor(s) from a call center.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| supervisor_user_id | List[str] | supervisorUserId |
GroupCallCenterDistinctiveRingingGetRequest(OCIRequest)
Get the distinctive ringing configuration values for call center.
The response is either a GroupCallCenterDistinctiveRingingGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterDistinctiveRingingModifyRequest(OCIRequest)
Modify the distinctive ringing configuration values for call center.
The response is either a SuccessResponse() or an ErrorResponse(). The following
element is only used in AS data mode and ignored in XS data mode:
distinctiveRingingForceDeliveryRingPattern
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| distinctive_ringing_call_center_calls | bool | distinctiveRingingCallCenterCalls Optional |
| distinctive_ringing_ring_pattern_for_call_center | str | distinctiveRingingRingPatternForCallCenter Optional |
| distinctive_ringing_force_delivery_ring_pattern | str | distinctiveRingingForceDeliveryRingPattern Optional |
GroupCallCenterEnhancedGetRequest(OCIRequest)
Request to get the Call Center Enhanced configuration data for a Call Center.
The response is either GroupCallCenterEnhancedGetResponse() or ErrorResponse().
Replaced By: GroupCallCenterGetInstanceResponse16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterEnhancedModifyRequest(OCIRequest)
Modify the Call Center Enhanced configuration data for a Call Center.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: GroupCallCenterModifyInstanceRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| override_agent_wrap_up_time | bool | overrideAgentWrapUpTime Optional |
| wrap_up_seconds | int | wrapUpSeconds Optional |
GroupCallCenterEnhancedReportingBrandingGetRequest(OCIRequest)
Request to get the group branding information.
The response is either GroupCallCenterEnhancedReportingBrandingGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallCenterEnhancedReportingGetAvailableReportTemplateListRequest(OCIRequest)
Request to get all enabled call center report template for a group.
The response is either a
GroupCallCenterEnhancedReportingGetAvailableReportTemplateListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallCenterEnhancedReportingGetRequest(OCIRequest)
Request to get a group level call center enhanced reporting setting.
The response is either a GroupCallCenterEnhancedReportingGetResponse() or an
ErrorResponse(). Replaced by GroupCallCenterEnhancedReportingGetRequest19()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallCenterEnhancedReportingGetRequest19(OCIRequest)
Request to get a group level call center enhanced reporting setting.
The response is either a GroupCallCenterEnhancedReportingGetResponse19() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallCenterEnhancedReportingModifyRequest(OCIRequest)
Request to modify group level call center enhanced reporting settings.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by
GroupCallCenterEnhancedReportingModifyRequest19()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| reporting_server | str | reportingServer Optional |
| web_statistic_source | str | webStatisticSource Optional |
GroupCallCenterEnhancedReportingModifyRequest19(OCIRequest)
Request to modify group level call center enhanced reporting settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| reporting_server | str | reportingServer Optional |
GroupCallCenterEnhancedReportingReportTemplateDeleteRequest(OCIRequest)
Request to delete a group level call center report template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupCallCenterEnhancedReportingReportTemplateGetListRequest(OCIRequest)
Request to get group level call center report template list.
The response is either a
GroupCallCenterEnhancedReportingReportTemplateGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallCenterEnhancedReportingReportTemplateGetRequest(OCIRequest)
Request to get a group level call center report template.
The response is either a GroupCallCenterEnhancedReportingReportTemplateGetResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupCallCenterEnhancedReportingScheduledReportDeleteRequest(OCIRequest)
Request to delete a group level call center reporting scheduled report.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupCallCenterEnhancedReportingScheduledReportGetReportTemplateUsageListRequest(OCIRequest)
Request to get all the call center reporting scheduled report in a group that uses a given group level report template.
The response is either a
GroupCallCenterEnhancedReportingScheduledReportGetReportTemplateUsageListResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupCallCenterEnhancedReportingScheduledReportGetRequest(OCIRequest)
Request to get a group level call center reporting scheduled report.
The response is either a
GroupCallCenterEnhancedReportingScheduledReportGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupCallCenterForcedForwardingGetRequest(OCIRequest)
Get a call center's forced forwarding settings.
The response is either a GroupCallCenterForcedForwardingGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterForcedForwardingGetRequest17(OCIRequest)
Get a call center's forced forwarding settings.
The response is either a GroupCallCenterForcedForwardingGetResponse17() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterForcedForwardingGetRequest20(OCIRequest)
Get a call center's forced forwarding settings.
The response is either a GroupCallCenterForcedForwardingGetResponse20() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetAnnouncementRequest(OCIRequest)
Get a call center's announcement settings.
The response is either a GroupCallCenterGetAnnouncementResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetAnnouncementRequest14sp6(OCIRequest)
Get a call center's announcement settings.
The response is either a GroupCallCenterGetAnnouncementResponse14sp6() or an
ErrorResponse().
Replaced By: GroupCallCenterGetAnnouncementRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetAnnouncementRequest16(OCIRequest)
Get a call center's announcement settings.
The response is either a GroupCallCenterGetAnnouncementResponse16() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetAnnouncementRequest17(OCIRequest)
Get a call center's announcement settings.
The response is either a GroupCallCenterGetAnnouncementResponse17() or an
ErrorResponse(). Replaced by GroupCallCenterGetAnnouncementRequest17sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetAnnouncementRequest17sp4(OCIRequest)
Get a call center's announcement settings.
The response is either a GroupCallCenterGetAnnouncementResponse17sp4() or an
ErrorResponse(). Replaced by: GroupCallCenterGetAnnouncementRequest19().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetAnnouncementRequest19(OCIRequest)
Get a call center's announcement settings.
The response is either a GroupCallCenterGetAnnouncementResponse19() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetAnnouncementRequest20(OCIRequest)
Get a call center's announcement settings.
The response is either a GroupCallCenterGetAnnouncementResponse20() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetAnnouncementRequest22(OCIRequest)
Get a call center's announcement settings.
The response is either a GroupCallCenterGetAnnouncementResponse22() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetDNISListRequest(OCIRequest)
Get a list of DNIS that are configured for a Call Center.
The response is either GroupCallCenterGetDNISListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetDistinctiveRingingRequest(OCIRequest)
Get the distinctive ringing configuration values for call center.
The response is either a GroupCallCenterGetDistinctiveRingingResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetInstanceListRequest(OCIRequest)
Get a list of Call Center instances within a group.
The response is either GroupCallCenterGetInstanceListResponse() or
ErrorResponse(). It is possible to get the instances within a specified department.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_department_name | str | groupDepartmentName Optional |
GroupCallCenterGetInstanceQueueStatusRequest(OCIRequest)
Get Call Center queue status.
The response is either GroupCallCenterGetInstanceQueueStatusResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetInstanceRequest14(OCIRequest)
Request to get all the information of a Call Center instance.
The response is either GroupCallCenterGetInstanceResponse14() or ErrorResponse().
Replaced By: GroupCallCenterGetInstanceRequest14sp3()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetInstanceRequest14sp3(OCIRequest)
Request to get all the information of a Call Center instance.
The response is either GroupCallCenterGetInstanceResponse14sp3() or
ErrorResponse().
Replaced By: GroupCallCenterGetInstanceRequest14sp9()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetInstanceRequest14sp9(OCIRequest)
Request to get all the information of a Call Center instance.
The response is either GroupCallCenterGetInstanceResponse14sp9() or
ErrorResponse().
Replaced By: GroupCallCenterGetInstanceRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetInstanceRequest16(OCIRequest)
Request to get all the information of a Call Center instance.
The response is either GroupCallCenterGetInstanceResponse16() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetInstanceRequest17(OCIRequest)
Request to get all the information of a Call Center instance.
The response is either GroupCallCenterGetInstanceResponse17() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetInstanceRequest17sp1(OCIRequest)
Request to get all the information of a Call Center instance.
The response is either GroupCallCenterGetInstanceResponse17sp1() or
ErrorResponse(). Replaced by: GroupCallCenterGetInstanceRequest17sp3()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetInstanceRequest17sp3(OCIRequest)
Request to get all the information of a Call Center instance.
The response is either GroupCallCenterGetInstanceResponse17sp3() or
ErrorResponse(). Replaced by GroupCallCenterGetInstanceRequest19()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetInstanceRequest19(OCIRequest)
Request to get all the information of a Call Center instance.
The response is either GroupCallCenterGetInstanceResponse19() or ErrorResponse().
Replaced by: GroupCallCenterGetInstanceRequest19sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetInstanceRequest19sp1(OCIRequest)
Request to get all the information of a Call Center instance.
The response is either GroupCallCenterGetInstanceResponse19sp1() or
ErrorResponse(). Replaced by GroupCallCenterGetInstanceRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetInstanceRequest22(OCIRequest)
Request to get all the information of a Call Center instance.
The response is either GroupCallCenterGetInstanceResponse22() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetInstanceStatisticsReportingRequest(OCIRequest)
Request to get the call center statistics reporting settings.
The response is either GroupCallCenterGetInstanceStatisticsReportingResponse() or
ErrorResponse().
Replaced By: GroupCallCenterGetInstanceStatisticsReportingRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetInstanceStatisticsReportingRequest16(OCIRequest)
Request to get the call center statistics reporting settings.
The response is either GroupCallCenterGetInstanceStatisticsReportingResponse16() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetInstanceStatisticsReportingRequest17sp1(OCIRequest)
Request to get the call center statistics reporting settings.
The response is either GroupCallCenterGetInstanceStatisticsReportingResponse17sp1()
or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetInstanceStatisticsRequest13mp8(OCIRequest)
Get Call Center queue and agent statistics.
The response is either GroupCallCenterGetInstanceStatisticsResponse13mp8() or
ErrorResponse().
Replaced By: GroupCallCenterGetInstanceStatisticsRequest14sp9()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetRequest(OCIRequest)
Request the Group level data associated with Call Center.
The response is either a GroupCallCenterGetResponse() or an ErrorResponse().
Replaced by GroupCallCenterGetRequest17sp4().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallCenterGetRequest17sp4(OCIRequest)
Request the Group level data associated with Call Center.
The response is either a GroupCallCenterGetResponse17sp4() or an ErrorResponse().
Replaced by: GroupCallCenterGetRequest23()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallCenterGetRequest23(OCIRequest)
Request the Group level data associated with Call Center.
The response is either a GroupCallCenterGetResponse23() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallCenterGetRoutingPolicyRequest(OCIRequest)
Request the group call center routing policy.
The response is either a GroupCallCenterGetRoutingPolicyResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallCenterGetSupervisorListRequest(OCIRequest)
Get a list of supervisors assigned to a call center.
Only users in the same group or enterprise as this call center can successfully execute this request.
The response is either a GroupCallCenterGetSupervisorListResponse() or an
ErrorResponse().
Replaced By: GroupCallCenterSupervisorReportingGetRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetSupervisorListRequest16(OCIRequest)
Get a list of supervisors assigned to a call center.
The response is either a GroupCallCenterGetSupervisorListResponse16() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterGetUnlicensedAgentListRequest(OCIRequest)
Get a list of unlicensed users who are preventing the Call Center from upgrading to another type.
The response is either GroupCallCenterGetUnlicensedAgentListRequest() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| call_center_type | str | callCenterType |
GroupCallCenterHolidayServiceGetRequest(OCIRequest)
Get a call center's holiday service settings.
The response is either a GroupCallCenterHolidayServiceGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterHolidayServiceGetRequest17(OCIRequest)
Get a call center's holiday service settings.
The response is either a GroupCallCenterHolidayServiceGetResponse17() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterHolidayServiceGetRequest17sp1(OCIRequest)
Get a call center's holiday service settings.
The response is either a GroupCallCenterHolidayServiceGetResponse17sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterHolidayServiceGetRequest20(OCIRequest)
Get a call center's holiday service settings.
The response is either a GroupCallCenterHolidayServiceGetResponse20() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterModifyDNISParametersRequest(OCIRequest)
Modify the setting that are configured for all the DNIS in a Call Center.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| display_dnis_number | bool | displayDNISNumber Optional |
| display_dnis_name | bool | displayDNISName Optional |
| promote_calls_from_priority1to0 | bool | promoteCallsFromPriority1to0 Optional |
| promote_calls_from_priority2to1 | bool | promoteCallsFromPriority2to1 Optional |
| promote_calls_from_priority3to2 | bool | promoteCallsFromPriority3to2 Optional |
| promote_calls_from_priority1to0_seconds | int | promoteCallsFromPriority1to0Seconds Optional |
| promote_calls_from_priority2to1_seconds | int | promoteCallsFromPriority2to1Seconds Optional |
| promote_calls_from_priority3to2_seconds | int | promoteCallsFromPriority3to2Seconds Optional |
GroupCallCenterModifyDistinctiveRingingRequest(OCIRequest)
Modify the distinctive ringing configuration values for call center.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| distinctive_ringing_call_center_calls | bool | distinctiveRingingCallCenterCalls Optional |
| distinctive_ringing_ring_pattern_for_call_center | str | distinctiveRingingRingPatternForCallCenter Optional |
| distinctive_ringing_force_delivery_ring_pattern | str | distinctiveRingingForceDeliveryRingPattern Optional |
GroupCallCenterModifyInstanceStatisticsReportingRequest(OCIRequest)
Modify the Call Center statistics reporting frequency and destination.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: GroupCallCenterModifyInstanceStatisticsReportingRequest14sp9()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| clear_today_statistics | bool | clearTodayStatistics Optional |
| generate_daily_report | bool | generateDailyReport Optional |
| collection_period_minutes | int | collectionPeriodMinutes Optional |
| reporting_email_address1 | str | reportingEmailAddress1 Optional |
| reporting_email_address2 | str | reportingEmailAddress2 Optional |
GroupCallCenterModifyInstanceStatisticsReportingRequest14sp9(OCIRequest)
Modify the Call Center statistics reporting frequency and destination.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| generate_daily_report | bool | generateDailyReport Optional |
| collection_period_minutes | int | collectionPeriodMinutes Optional |
| reporting_email_address1 | str | reportingEmailAddress1 Optional |
| reporting_email_address2 | str | reportingEmailAddress2 Optional |
| statistics_source | str | statisticsSource Optional |
GroupCallCenterModifyInstanceStatisticsReportingRequest17sp1(OCIRequest)
Modify the Call Center statistics reporting frequency and destination.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| generate_daily_report | bool | generateDailyReport Optional |
| collection_period_minutes | int | collectionPeriodMinutes Optional |
| reporting_email_address1 | str | reportingEmailAddress1 Optional |
| reporting_email_address2 | str | reportingEmailAddress2 Optional |
| statistics_source | str | statisticsSource Optional |
GroupCallCenterModifyRequest(OCIRequest)
Modify the group level data associated with Call Center and the active status of Call Center instances.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
useSystemDefaultUnavailableSettings forceAgentUnavailableOnDNDActivation
forceAgentUnavailableOnPersonalCalls forceAgentUnavailableOnBouncedCallLimit
numberConsecutiveBouncedCallsToForceAgentUnavailable
forceAgentUnavailableOnNotReachable wrapUpDestination
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_system_default_guard_timer | bool | useSystemDefaultGuardTimer Optional |
| enable_guard_timer | bool | enableGuardTimer Optional |
| guard_timer_seconds | int | guardTimerSeconds Optional |
| use_system_default_unavailable_settings | bool | useSystemDefaultUnavailableSettings Optional |
| force_agent_unavailable_on_dnd_activation | bool | forceAgentUnavailableOnDNDActivation Optional |
| force_agent_unavailable_on_personal_calls | bool | forceAgentUnavailableOnPersonalCalls Optional |
| force_agent_unavailable_on_bounced_call_limit | bool | forceAgentUnavailableOnBouncedCallLimit Optional |
| number_consecutive_bounced_calls_to_force_agent_unavailable | int | numberConsecutiveBouncedCallsToForceAgentUnavailable Optional |
| force_agent_unavailable_on_not_reachable | bool | forceAgentUnavailableOnNotReachable Optional |
| wrap_up_destination | str | wrapUpDestination Optional |
GroupCallCenterMonitoringGetRequest(OCIRequest)
Request the Group level data associated with Call Center Monitoring.
The response is either a GroupCallCenterMonitoringGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallCenterMonitoringModifyRequest(OCIRequest)
Modify the group level data associated with Call Center Monitoring The response is
either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| enable_supervisor_coaching | bool | enableSupervisorCoaching Optional |
GroupCallCenterNightServiceGetRequest(OCIRequest)
Get a call center's night service settings.
The response is either a GroupCallCenterNightServiceGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterNightServiceGetRequest17(OCIRequest)
Get a call center's night service settings.
The response is either a GroupCallCenterNightServiceGetResponse17() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterNightServiceGetRequest17sp1(OCIRequest)
Get a call center's night service settings.
The response is either a GroupCallCenterNightServiceGetResponse17sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterNightServiceGetRequest20(OCIRequest)
Get a call center's night service settings.
The response is either a GroupCallCenterNightServiceGetResponse20() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterOverflowGetRequest(OCIRequest)
Get a call center's overflow settings.
The response is either a GroupCallCenterOverflowGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterOverflowGetRequest17(OCIRequest)
Get a call center's overflow settings.
The response is either a GroupCallCenterOverflowGetResponse17() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterOverflowGetRequest20(OCIRequest)
Get a call center's overflow settings.
The response is either a GroupCallCenterOverflowGetResponse20() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterQueueCallDispositionCodeAddRequest(OCIRequest)
Add a Call Center Call Disposition Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| code | str | code |
| is_active | bool | isActive |
| description | str | description Optional |
GroupCallCenterQueueCallDispositionCodeDeleteRequest(OCIRequest)
Delete a Call Center Call Disposition Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| code | str | code |
GroupCallCenterQueueCallDispositionCodeGetListRequest(OCIRequest)
Get the list of Call Center Level and Organization Level Call Disposition Codes.
The response is either GroupCallCenterQueueCallDispositionCodeGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterQueueCallDispositionCodeGetRequest(OCIRequest)
Get a Call Center Call Disposition Code.
The response is either GroupCallCenterQueueCallDispositionCodeGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| code | str | code |
GroupCallCenterQueueCallDispositionCodeModifyRequest(OCIRequest)
Modify a Call Center Call Disposition Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| code | str | code |
| is_active | bool | isActive Optional |
| description | str | description Optional |
GroupCallCenterQueueCallDispositionCodeSettingsGetRequest(OCIRequest)
Request the user level data associated with Call Center Call Disposition Code Settings.
The response is either a
GroupCallCenterQueueCallDispositionCodeSettingsGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterQueueStatusNotificationGetRequest(OCIRequest)
Get the status configuration for a given call center.
The response is either a GroupCallCenterQueueStatusNotificationGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterQueueStatusNotificationModifyRequest(OCIRequest)
Set the status configuration for a given call center.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| enable_queue_status_notification | bool | enableQueueStatusNotification Optional |
| enable_queue_depth_threshold | bool | enableQueueDepthThreshold Optional |
| enable_waiting_time_threshold | bool | enableWaitingTimeThreshold Optional |
| number_of_calls_threshold | int | numberOfCallsThreshold Optional |
| waiting_time_of_calls_threshold | int | waitingTimeOfCallsThreshold Optional |
GroupCallCenterQueueThresholdsGetRequest(OCIRequest)
Get a call center's queue Thresholds settings.
The response is either a GroupCallCenterQueueThresholdsGetRequest() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterStrandedCallGetRequest(OCIRequest)
Get a call center's stranded call settings.
The response is either a GroupCallCenterStrandedCallGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterStrandedCallGetRequest17(OCIRequest)
Get a call center's stranded call settings.
The response is either a GroupCallCenterStrandedCallGetResponse17() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterStrandedCallGetRequest20(OCIRequest)
Get a call center's stranded call settings.
The response is either a GroupCallCenterStrandedCallGetResponse20() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterStrandedCallUnavailableGetRequest(OCIRequest)
Get a call center's stranded calls - unavailable settings.
The response is either a GroupCallCenterStrandedCallUnavailableGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterStrandedCallUnavailableGetRequest20(OCIRequest)
Get a call center's stranded calls - unavailable settings.
The response is either a GroupCallCenterStrandedCallUnavailableGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallCenterSupervisorReportingGetRequest(OCIRequest)
Get a list of supervisors assigned to a call center.
Only users in the same group or enterprise as this call center can successfully execute this request.
The response is either a GroupCallCenterSupervisorReportingGetResponse() or an
ErrorResponse().
Replaced By: GroupCallCenterGetSupervisorListRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCallParkAddInstanceRequest(OCIRequest)
Adds a Call Park group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| user_id | List[str] | userId Optional |
GroupCallParkAddInstanceRequest16sp2(OCIRequest)
Adds a Call Park group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| user_id | List[str] | userId Optional |
| recall_alternate_user_id | str | recallAlternateUserId Optional |
| recall_to | str | recallTo |
GroupCallParkDeleteInstanceRequest(OCIRequest)
Deletes a Call Park group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupCallParkGetInstanceListRequest(OCIRequest)
Request to get a list of Call Park group instances within a group.
The response is either GroupCallParkGetInstanceListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallParkGetInstanceRequest(OCIRequest)
Gets a Call Park group.
The response is either GroupCallParkGetInstanceResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupCallParkGetInstanceRequest16sp2(OCIRequest)
Gets a Call Park group.
The response is either GroupCallParkGetInstanceResponse16sp2() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupCallParkGetRequest(OCIRequest)
Gets the Call Park Group settings.
The response is either GroupCallParkGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallParkGetRequest16sp2(OCIRequest)
Gets the Call Park Group settings.
The response is either GroupCallParkGetResponse16sp2() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallParkModifyRequest(OCIRequest)
Modifies the Group's Call Park settings.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| recall_timer_seconds | int | recallTimerSeconds Optional |
| display_timer_seconds | int | displayTimerSeconds Optional |
| enable_destination_announcement | bool | enableDestinationAnnouncement Optional |
| recall_alternate_user_id | str | recallAlternateUserId Optional |
| recall_ring_pattern | str | recallRingPattern Optional |
| recall_to | str | recallTo Optional |
| alternate_user_recall_timer_seconds | int | alternateUserRecallTimerSeconds Optional |
GroupCallPickupAddInstanceRequest(OCIRequest)
Adds a Call Pickup group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| user_id | List[str] | userId Optional |
GroupCallPickupDeleteInstanceRequest(OCIRequest)
Deletes a Call Pickup group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupCallPickupGetInstanceListRequest(OCIRequest)
Request to get a list of Call Pickup instances within a group.
The response is either GroupCallPickupGetInstanceListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallPickupGetInstanceRequest(OCIRequest)
Gets a Call Pickup group.
The response is either GroupCallPickupGetInstanceResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupCallProcessingGetPolicyRequest14(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse14() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest14sp1(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse14sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest14sp4(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse14sp4() or an
ErrorResponse().
Replaced By : GroupCallProcessingGetPolicyRequest15()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest14sp7(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse14sp7() or an
ErrorResponse(). The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity,
useGroupName) The useGroupMediaSetting attribute controls the Media settings
(medisPolicySelection, supportedMediaSetName) The useGroupCallLimitsSetting attribute
controls the Call Limits settings (useMaxSimultaneousCalls, maxSimultaneousCalls,
useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls,
useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes,
useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes,
useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) The
useGroupTranslationRoutingSetting attribute controls the routing and translation
settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan,
allowEnterpriseGroupCallTypingForPublicDialingPlan,
overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan,
enableEnterpriseExtensionDialing)
Replaced By: GroupCallProcessingGetPolicyRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest15(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse15() or an
ErrorResponse().
Replaced By: GroupCallProcessingGetPolicyRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest15sp2(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse15sp2() or an
ErrorResponse(). The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity,
useGroupName) The useGroupMediaSetting attribute controls the Media settings
(medisPolicySelection, supportedMediaSetName) The useGroupCallLimitsSetting attribute
controls the Call Limits settings (useMaxSimultaneousCalls, maxSimultaneousCalls,
useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls,
useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes,
useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes,
useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) The
useGroupTranslationRoutingSetting attribute controls the routing and translation
settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan,
allowEnterpriseGroupCallTypingForPublicDialingPlan,
overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan,
enableEnterpriseExtensionDialing)
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest16(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse16() or an
ErrorResponse(). The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity,
useGroupName) The useGroupMediaSetting attribute controls the Media settings
(medisPolicySelection, supportedMediaSetName) The useGroupCallLimitsSetting attribute
controls the Call Limits settings (useMaxSimultaneousCalls, maxSimultaneousCalls,
useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls,
useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes,
useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes,
useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) The
useGroupTranslationRoutingSetting attribute controls the routing and translation
settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan,
allowEnterpriseGroupCallTypingForPublicDialingPlan,
overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan,
enableEnterpriseExtensionDialing)
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest16sp2(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse16sp2() or an
ErrorResponse(). The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity,
useGroupName) The useGroupMediaSetting attribute controls the Media settings
(medisPolicySelection, supportedMediaSetName) The useGroupCallLimitsSetting attribute
controls the Call Limits settings (useMaxSimultaneousCalls, maxSimultaneousCalls,
useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls,
useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes,
useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes,
useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) The
useGroupTranslationRoutingSetting attribute controls the routing and translation
settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan,
allowEnterpriseGroupCallTypingForPublicDialingPlan,
overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan,
enableEnterpriseExtensionDialing) The useGroupDCLIDSetting controls the Dialable
Caller ID settings (enableDialableCallerID)
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest17(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse17() or an
ErrorResponse(). The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity,
useGroupName) The useGroupMediaSetting attribute controls the Media settings
(medisPolicySelection, supportedMediaSetName) The useGroupCallLimitsSetting attribute
controls the Call Limits settings (useMaxSimultaneousCalls, maxSimultaneousCalls,
useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls,
useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes,
useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes,
useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) The
useGroupTranslationRoutingSetting attribute controls the routing and translation
settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan,
allowEnterpriseGroupCallTypingForPublicDialingPlan,
overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan,
enableEnterpriseExtensionDialing)
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest17sp3(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse17sp3() or an
ErrorResponse(). The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity,
useGroupName) The useGroupMediaSetting attribute controls the Media settings
(medisPolicySelection, supportedMediaSetName) The useGroupCallLimitsSetting attribute
controls the Call Limits settings (useMaxSimultaneousCalls, maxSimultaneousCalls,
useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls,
useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes,
useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes,
useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) The
useGroupTranslationRoutingSetting attribute controls the routing and translation
settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan,
allowEnterpriseGroupCallTypingForPublicDialingPlan,
overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan,
enableEnterpriseExtensionDialing) The useGroupDCLIDSetting controls the Dialable
Caller ID settings (enableDialableCallerID) The following elements are only used in AS
data mode: useGroupDCLIDSetting enableDialableCallerID Replaced by
GroupCallProcessingGetPolicyRequest17sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest17sp4(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse17sp4() or an
ErrorResponse(). The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity,
useGroupName, allowConfigurableCLIDForRedirectingIdentity) The useGroupMediaSetting
attribute controls the Media settings (medisPolicySelection, supportedMediaSetName)
The useGroupCallLimitsSetting attribute controls the Call Limits settings
(useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls,
maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls,
maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls,
maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls,
useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) The
useGroupTranslationRoutingSetting attribute controls the routing and translation
settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan,
allowEnterpriseGroupCallTypingForPublicDialingPlan,
overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan,
enableEnterpriseExtensionDialing) The following elements are only used in AS data
mode: useGroupDCLIDSetting enableDialableCallerID Replaced by
GroupCallProcessingGetPolicyRequest18()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest18(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse18() or an
ErrorResponse(). The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity,
useGroupName, allowDepartmentCLIDNameOverride) The useGroupMediaSetting attribute
controls the Media settings (medisPolicySelection, supportedMediaSetName) The
useGroupCallLimitsSetting attribute controls the Call Limits settings
(useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls,
maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls,
maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls,
maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls,
useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) The
useGroupTranslationRoutingSetting attribute controls the routing and translation
settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan,
allowEnterpriseGroupCallTypingForPublicDialingPlan,
overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan,
enableEnterpriseExtensionDialing) The following elements are only used in AS data
mode: useGroupDCLIDSetting enableDialableCallerID allowDepartmentCLIDNameOverride
Replaced By : GroupCallProcessingGetPolicyRequest18sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest18sp1(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse18sp1() or an
ErrorResponse(). The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy,enterpriseCallsCLIDPolicy, groupCallsCLIDPolicy, emergencyClidPolicy,
allowAlternateNumbersForRedirectingIdentity, useGroupName,
allowDepartmentCLIDNameOverride) The useGroupMediaSetting attribute controls the Media
settings (medisPolicySelection, supportedMediaSetName) The useGroupCallLimitsSetting
attribute controls the Call Limits settings (useMaxSimultaneousCalls,
maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls,
useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes,
useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes,
useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) The
useGroupTranslationRoutingSetting attribute controls the routing and translation
settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan,
allowEnterpriseGroupCallTypingForPublicDialingPlan,
overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan,
enableEnterpriseExtensionDialing) Replaced by:
GroupCallProcessingGetPolicyRequest19sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest19sp1(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse19sp1() or an
ErrorResponse(). The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy,enterpriseCallsCLIDPolicy, groupCallsCLIDPolicy, emergencyClidPolicy,
allowAlternateNumbersForRedirectingIdentity, useGroupName,
allowDepartmentCLIDNameOverride) The useGroupMediaSetting attribute controls the Media
settings (medisPolicySelection, supportedMediaSetName) The useGroupCallLimitsSetting
attribute controls the Call Limits settings (useMaxSimultaneousCalls,
maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls,
useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes,
useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes,
useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) The
useGroupTranslationRoutingSetting attribute controls the routing and translation
settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan,
allowEnterpriseGroupCallTypingForPublicDialingPlan,
overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan,
enableEnterpriseExtensionDialing) Replaced by:
GroupCallProcessingGetPolicyRequest21sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest21sp1(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse21sp1() or an
ErrorResponse(). The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy,enterpriseCallsCLIDPolicy, groupCallsCLIDPolicy, emergencyClidPolicy,
allowAlternateNumbersForRedirectingIdentity, useGroupName,
allowDepartmentCLIDNameOverride) The useGroupMediaSetting attribute controls the Media
settings (medisPolicySelection, supportedMediaSetName) The useGroupCallLimitsSetting
attribute controls the Call Limits settings (useMaxSimultaneousCalls,
maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls,
useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes,
useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes,
useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) The
useGroupTranslationRoutingSetting attribute controls the routing and translation
settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan,
allowEnterpriseGroupCallTypingForPublicDialingPlan,
overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan,
enableEnterpriseExtensionDialing) Replaced by:
GroupCallProcessingGetPolicyRequest21sp2()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest21sp2(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse21sp2() or an
ErrorResponse(). The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy,enterpriseCallsCLIDPolicy, groupCallsCLIDPolicy, emergencyClidPolicy,
allowAlternateNumbersForRedirectingIdentity, useGroupName,
allowDepartmentCLIDNameOverride) The useGroupMediaSetting attribute controls the Media
settings (medisPolicySelection, supportedMediaSetName) The useGroupCallLimitsSetting
attribute controls the Call Limits settings (useMaxSimultaneousCalls,
maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls,
useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes,
useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes,
useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) The
useGroupTranslationRoutingSetting attribute controls the routing and translation
settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan,
allowEnterpriseGroupCallTypingForPublicDialingPlan,
overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan,
enableEnterpriseExtensionDialing, routeOverrideDomain, routeOverridePrefix) Replaced
by: GroupCallProcessingGetPolicyRequest22() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest22(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse22() or an
ErrorResponse(). The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy,enterpriseCallsCLIDPolicy, groupCallsCLIDPolicy, emergencyClidPolicy,
allowAlternateNumbersForRedirectingIdentity, useGroupName,
allowDepartmentCLIDNameOverride) The useGroupMediaSetting attribute controls the Media
settings (medisPolicySelection, supportedMediaSetName) The useGroupCallLimitsSetting
attribute controls the Call Limits settings (useMaxSimultaneousCalls,
maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls,
useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes,
useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes,
useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations,
useMaxConcurrentTerminatingAlertingRequests, maxConcurrentTerminatingAlertingRequests)
The useGroupTranslationRoutingSetting attribute controls the routing and translation
settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan,
allowEnterpriseGroupCallTypingForPublicDialingPlan,
overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan,
enableEnterpriseExtensionDialing) Replaced by:
GroupCallProcessingGetPolicyRequest22V2() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest22V2(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse22V2() or an
ErrorResponse(). The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy,enterpriseCallsCLIDPolicy, groupCallsCLIDPolicy, emergencyClidPolicy,
allowAlternateNumbersForRedirectingIdentity, useGroupName,
allowDepartmentCLIDNameOverride) The useGroupMediaSetting attribute controls the Media
settings (medisPolicySelection, supportedMediaSetName) The useGroupCallLimitsSetting
attribute controls the Call Limits settings (useMaxSimultaneousCalls,
maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls,
useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes,
useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes,
useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations,
useMaxConcurrentTerminatingAlertingRequests, maxConcurrentTerminatingAlertingRequests)
The useGroupTranslationRoutingSetting attribute controls the routing and translation
settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan,
allowEnterpriseGroupCallTypingForPublicDialingPlan,
overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan,
enableEnterpriseExtensionDialing) Replaced by:
GroupCallProcessingGetPolicyRequest22V3() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingGetPolicyRequest22V3(OCIRequest)
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse22V3() or an
ErrorResponse(). The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy,enterpriseCallsCLIDPolicy, groupCallsCLIDPolicy, emergencyClidPolicy,
allowAlternateNumbersForRedirectingIdentity, useGroupName,
allowDepartmentCLIDNameOverride) The useGroupMediaSetting attribute controls the Media
settings (medisPolicySelection, supportedMediaSetName) The useGroupCallLimitsSetting
attribute controls the Call Limits settings (useMaxSimultaneousCalls,
maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls,
useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes,
useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes,
useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations,
useMaxConcurrentTerminatingAlertingRequests, maxConcurrentTerminatingAlertingRequests)
The useGroupTranslationRoutingSetting attribute controls the routing and translation
settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan,
allowEnterpriseGroupCallTypingForPublicDialingPlan,
overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan,
enableEnterpriseExtensionDialing)
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallProcessingModifyPolicyRequest14(OCIRequest)
Modify the group level data associated with Call Processing Policy.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By : GroupCallProcessingModifyPolicyRequest15()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_group_setting | bool | useGroupSetting Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| media_policy_selection | str | mediaPolicySelection Optional |
| supported_media_set_name | str | supportedMediaSetName Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_external_calls_via_private_dialing_plan | bool | overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_max_concurrent_find_me_follow_me_invocations | bool | useMaxConcurrentFindMeFollowMeInvocations Optional |
| max_concurrent_find_me_follow_me_invocations | int | maxConcurrentFindMeFollowMeInvocations Optional |
GroupCallProcessingModifyPolicyRequest14sp7(OCIRequest)
Modify the group level data associated with Call Processing Policy.
The response is either a SuccessResponse() or an ErrorResponse(). The
useGroupCLIDSetting attribute controls the CLID settings (clidPolicy,
emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName) The
useGroupMediaSetting attribute controls the Media settings (medisPolicySelection,
supportedMediaSetName) The useGroupCallLimitsSetting attribute controls the Call
Limits settings (useMaxSimultaneousCalls, maxSimultaneousCalls,
useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls,
useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes,
useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes,
useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) The
useGroupTranslationRoutingSetting attribute controls the routing and translation
settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan,
allowEnterpriseGroupCallTypingForPublicDialingPlan,
overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan,
enableEnterpriseExtensionDialing)
Replaced By: GroupCallProcessingModifyPolicyRequest15sp2()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_group_clid_setting | bool | useGroupCLIDSetting Optional |
| use_group_media_setting | bool | useGroupMediaSetting Optional |
| use_group_call_limits_setting | bool | useGroupCallLimitsSetting Optional |
| use_group_translation_routing_setting | bool | useGroupTranslationRoutingSetting Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| media_policy_selection | str | mediaPolicySelection Optional |
| supported_media_set_name | str | supportedMediaSetName Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_external_calls_via_private_dialing_plan | bool | overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_max_concurrent_find_me_follow_me_invocations | bool | useMaxConcurrentFindMeFollowMeInvocations Optional |
| max_concurrent_find_me_follow_me_invocations | int | maxConcurrentFindMeFollowMeInvocations Optional |
| clid_policy | str | clidPolicy Optional |
| emergency_clid_policy | str | emergencyClidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
| use_group_name | bool | useGroupName Optional |
GroupCallProcessingModifyPolicyRequest15(OCIRequest)
Modify the group level data associated with Call Processing Policy.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: GroupCallProcessingModifyPolicyRequest15sp2()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_group_setting | bool | useGroupSetting Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| media_policy_selection | str | mediaPolicySelection Optional |
| supported_media_set_name | str | supportedMediaSetName Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_enterprise_clid_for_private_call_category | bool | useEnterpriseCLIDForPrivateCallCategory Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_max_concurrent_find_me_follow_me_invocations | bool | useMaxConcurrentFindMeFollowMeInvocations Optional |
| max_concurrent_find_me_follow_me_invocations | int | maxConcurrentFindMeFollowMeInvocations Optional |
GroupCallProcessingModifyPolicyRequest15sp2(OCIRequest)
Modify the group level data associated with Call Processing Policy.
The response is either a SuccessResponse() or an ErrorResponse(). The
useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy,enterpriseCallsCLIDPolicy, groupCallsCLIDPolicy, emergencyClidPolicy,
allowAlternateNumbersForRedirectingIdentity, useGroupName,
allowConfigurableCLIDForRedirectingIdentity, allowDepartmentCLIDNameOverride
useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable,
useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailabl) The
allowDepartmentCLID attribute is automatically set to false when the useGroupName
attribute is set to false. The useGroupMediaSetting attribute controls the Media
settings (medisPolicySelection, supportedMediaSetName) The useGroupCallLimitsSetting
attribute controls the Call Limits settings (useMaxSimultaneousCalls,
maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls,
useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes,
useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes,
useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations,
useMaxConcurrentTerminatingAlertingRequests, maxConcurrentTerminatingAlertingRequests,
includeRedirectionsInMaximumNumberOfConcurrentCalls) The
useGroupTranslationRoutingSetting attribute controls the routing and translation
settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan,
allowEnterpriseGroupCallTypingForPublicDialingPlan,
overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan,
enableEnterpriseExtensionDialing, routeOverrideDomain, routeOverridePrefix) The
useGroupDCLIDSetting controls the Dialable Caller ID settings (enableDialableCallerID)
The useGroupPhoneListLookupSetting controls whether or not to use the
enterprise/service provider setting for the Phone List Lookup policy
(enablePhoneListLookup) The following elements are only used in AS data mode:
useGroupDCLIDSetting enableDialableCallerID
allowConfigurableCLIDForRedirectingIdentity allowDepartmentCLIDNameOverride The
following elements are only used in AS data mode and ignored in XS data mode:
useGroupPhoneListLookupSetting enablePhoneListLookup
useMaxConcurrentTerminatingAlertingRequests maxConcurrentTerminatingAlertingRequests
includeRedirectionsInMaximumNumberOfConcurrentCalls
useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable
useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable
allowMobileDNForRedirectingIdentity enableGatewayRoutePolicy
networkCallsGatewayRouteIdentity networkURLCallsGatewayRouteIdentity
emergencyCallsGatewayRouteIdentity repairCallsGatewayRouteIdentity
callTypingErrorsGatewayRouteIdentity The following elements are only used in XS data
mode and ignored in AS data mode: routeOverrideDomain routeOverridePrefix
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_group_clid_setting | bool | useGroupCLIDSetting Optional |
| use_group_media_setting | bool | useGroupMediaSetting Optional |
| use_group_call_limits_setting | bool | useGroupCallLimitsSetting Optional |
| use_group_translation_routing_setting | bool | useGroupTranslationRoutingSetting Optional |
| use_group_dclid_setting | bool | useGroupDCLIDSetting Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| media_policy_selection | str | mediaPolicySelection Optional |
| supported_media_set_name | str | supportedMediaSetName Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_enterprise_clid_for_private_call_category | bool | useEnterpriseCLIDForPrivateCallCategory Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_max_concurrent_find_me_follow_me_invocations | bool | useMaxConcurrentFindMeFollowMeInvocations Optional |
| max_concurrent_find_me_follow_me_invocations | int | maxConcurrentFindMeFollowMeInvocations Optional |
| clid_policy | str | clidPolicy Optional |
| emergency_clid_policy | str | emergencyClidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
| use_group_name | bool | useGroupName Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| enable_dialable_caller_id | bool | enableDialableCallerID Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| allow_department_clid_name_override | bool | allowDepartmentCLIDNameOverride Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| group_calls_clid_policy | str | groupCallsCLIDPolicy Optional |
| use_group_phone_list_lookup_setting | bool | useGroupPhoneListLookupSetting Optional |
| enable_phone_list_lookup | bool | enablePhoneListLookup Optional |
| use_max_concurrent_terminating_alerting_requests | bool | useMaxConcurrentTerminatingAlertingRequests Optional |
| max_concurrent_terminating_alerting_requests | int | maxConcurrentTerminatingAlertingRequests Optional |
| include_redirections_in_maximum_number_of_concurrent_calls | bool | includeRedirectionsInMaximumNumberOfConcurrentCalls Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
| route_override_domain | str | routeOverrideDomain Optional |
| route_override_prefix | str | routeOverridePrefix Optional |
| allow_mobile_dn_for_redirecting_identity | bool | allowMobileDNForRedirectingIdentity Optional |
| enable_gateway_route_policy | bool | enableGatewayRoutePolicy Optional |
| network_calls_gateway_route_identity | str | networkCallsGatewayRouteIdentity Optional |
| network_url_calls_gateway_route_identity | str | networkURLCallsGatewayRouteIdentity Optional |
| emergency_calls_gateway_route_identity | str | emergencyCallsGatewayRouteIdentity Optional |
| repair_calls_gateway_route_identity | str | repairCallsGatewayRouteIdentity Optional |
| call_typing_errors_gateway_route_identity | str | callTypingErrorsGatewayRouteIdentity Optional |
GroupCallRecordingGetRequest(OCIRequest)
Get the Call Recording platform for a group.
The response is either a GroupCallRecordingGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallRecordingModifyRequest(OCIRequest)
Modify the Call Recording platform assignment for a group.
The response is either a SuccessResponse() or an ErrorResponse(). The following
element is only nillable in XS data mode: name
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name Optional |
GroupCallingLineIdGetRequest(OCIRequest)
Get the calling line id settings for a group.
The response is either a GroupCallingLineIdGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallingLineIdModifyRequest(OCIRequest)
Modify the calling line id settings for a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_group_number | bool | useGroupNumber Optional |
| use_group_name | bool | useGroupName Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
GroupCallingPlanAddDigitPatternRequest(OCIRequest)
Add a new calling plan digit string.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| digit_pattern | str | digitPattern |
GroupCallingPlanDeleteDigitPatternListRequest(OCIRequest)
Delete one or more calling plan digit strings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | List[str] | name |
GroupCallingPlanGetDigitPatternListRequest(OCIRequest)
Get the list of calling plan digit strings for a group.
The response is either a GroupCallingPlanGetDigitPatternListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCallingPlanModifyDigitPatternRequest(OCIRequest)
Modify a calling plan digit string.
The name is a key; it cannot be changed.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| digit_pattern | str | digitPattern Optional |
GroupCollaborateBridgeConsolidatedDeleteInstanceRequest(OCIRequest)
Delete a collaborate bridge from a group.
The request fails when attempting to delete the default collaborate bridge. If
UnassignPhoneNumbersLevel is set to 'Group', the user's primary phone number, fax
number and any alternate numbers, will be un-assigned from the group if the command is
executed by a service provider administrator or above. When set to 'Service
Provider', they will be un-assigned from the group and service provider if the command
is executed by a provisioning administrator or above. When omitted, the number(s)
will be left assigned to the group. An ErrorResponse() will be returned if any
number cannot be unassigned because of insufficient privilege.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| unassign_phone_numbers | str | unassignPhoneNumbers Optional |
GroupCollaborateBridgeDeleteInstanceRequest(OCIRequest)
Delete a collaborate bridge from a group.
The request fails when attempting to delete the default collaborate bridge.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCollaborateBridgeGetInstanceListRequest(OCIRequest)
Get a list of collaborate bridges within a group.
The response is either GroupCollaborateBridgeGetInstanceListResponse() or
ErrorResponse(). It is possible to get the instances within a specified department.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department_name | str | departmentName Optional |
GroupCollaborateBridgeGetInstanceRequest(OCIRequest)
Request to get all the information of a collaborate bridge.
The response is either GroupCollaborateBridgeGetInstanceResponse() or
ErrorResponse(). Replaced by: GroupCollaborateBridgeGetInstanceRequest20sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCollaborateBridgeGetInstanceRequest20sp1(OCIRequest)
Request to get all the information of a collaborate bridge.
The response is either GroupCollaborateBridgeGetInstanceResponse20sp1() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupCommonPhoneListDeleteListRequest(OCIRequest)
Delete one or more entries from a group's common phone list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| entry_name | List[str] | entryName |
GroupCommonPhoneListModifyRequest(OCIRequest)
Modify an entry in a group's common phone list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| entry_name | str | entryName |
| new_entry_name | str | newEntryName Optional |
| phone_number | str | phoneNumber Optional |
GroupCommunicationBarringAuthorizationCodeDeleteListRequest(OCIRequest)
Delete a list of Communication Barring Authorization codes from a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| code | List[str] | code |
GroupCommunicationBarringAuthorizationCodeGetListRequest(OCIRequest)
Get a list of Communication Barring Authorization Codes for a group.
The response is either a GroupCommunicationBarringAuthorizationCodeGetListResponse()
or an ErorResponse(). Replaced by:
GroupCommunicationBarringAuthorizationCodeGetListRequest21sp1() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCommunicationBarringAuthorizationCodeGetRequest(OCIRequest)
Request the group Communication Barring Authorization Code setting.
The response is either a GroupCommunicationBarringAuthorizationCodeGetResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| code | str | code |
GroupCommunicationBarringAuthorizationCodeModifyRequest(OCIRequest)
Modify the group Communication Barring Authorization Code settings The response is
either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| code | str | code |
| description | str | description Optional |
| network_class_of_service | str | networkClassOfService Optional |
GroupCommunicationBarringGetRequest(OCIRequest)
Gets Communication Barring setting for a group.
The response is either a GroupCommunicationBarringGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCommunicationBarringModifyRequest(OCIRequest)
Gets Communication Barring setting for a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_default_service_provider_profile | bool | useDefaultServiceProviderProfile Optional |
| profile | str | profile Optional |
GroupCommunicationBarringProfileGetAssignedListRequest(OCIRequest)
Get the list of all communication barring profiles assigned to the group.
The response is either a GroupCommunicationBarringProfileGetAssignedListResponse()
or an ErrorResponse(). This command only applies to groups in an Enterprise. This
command will fail for groups in a Service Provider.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCustomContactDirectoryAddRequest(OCIRequest)
Adds a Custom Contact Directory to a group.
The response is either SuccessResponse() or ErrorResponse(). Replace by:
GroupCustomContactDirectoryAddRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| user_id | List[str] | userId Optional |
GroupCustomContactDirectoryDeleteRequest(OCIRequest)
Deletes a Custom Contact Directory to a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupCustomContactDirectoryGetListRequest(OCIRequest)
Gets the list of Custom Contact Directories for a group.
The response is either GroupCustomContactDirectoryGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCustomContactDirectoryGetRequest(OCIRequest)
Gets a Custom Contact Directory in a group.
The response is either GroupCustomContactDirectoryGetResponse() or
ErrorResponse(). Replace by: GroupCustomContactDirectoryGetRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupCustomRingbackGroupGetRequest(OCIRequest)
Get the group's custom ring back service settings.
The response is either a GroupCustomRingbackGroupGetResponse() or an
ErrorResponse().
Replaced By: GroupCustomRingbackGroupGetRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCustomRingbackGroupGetRequest16(OCIRequest)
Get the group's custom ring back service settings.
The response is either a GroupCustomRingbackGroupGetResponse16() or an
ErrorResponse(). Replaced by: GroupCustomRingbackGroupGetRequest20() in AS data
mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupCustomRingbackGroupGetRequest20(OCIRequest)
Get the group's custom ring back service settings.
The response is either a GroupCustomRingbackGroupGetResponse20() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupDeleteRequest(OCIRequest)
Delete a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupDepartmentAdminDeleteRequest(OCIRequest)
Delete a group department administrator.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupDepartmentAdminGetRequest(OCIRequest)
Get a group department administrators profile.
The response is either a GroupDepartmentAdminGetResponse() or an ErrorResponse().
Replaced by: GroupDepartmentAdminGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupDepartmentAdminGetRequest22(OCIRequest)
Get a group department administrators profile.
The response is either a GroupDepartmentAdminGetResponse() or an ErrorResponse().
Replaced by: GroupDepartmentAdminGetRequest22V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupDepartmentAdminGetRequest22V2(OCIRequest)
Get a group department administrators profile.
The response is either a GroupDepartmentAdminGetResponse22V2() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
GroupDepartmentAdminModifyRequest(OCIRequest)
Modify a group department administrator.
Since old password is not specified here, any password rule related to old password does not apply.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode. accountDisabled
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| first_name | str | firstName Optional |
| last_name | str | lastName Optional |
| password | str | password Optional |
| language | str | language Optional |
| account_disabled | bool | accountDisabled Optional |
GroupDepartmentDeleteRequest(OCIRequest)
Delete a department from a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department_name | str | departmentName |
GroupDepartmentGetAvailableParentListRequest(OCIRequest)
Get a list of departments that could be the parent department of the specified department.
The department itself and all its descendents are not eligible to be the parent department. If the group belongs to an enterprise, it also returns the departments defined in the enterprise it belongs to.
The response is either GroupDepartmentGetAvailableParentListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department_name | str | departmentName |
GroupDepartmentGetListRequest(OCIRequest)
Request a list of departments in a group.
You may request only the list of departments defined at the group-level, or you may request the list of all departments in the group including all the departments defined within the enterprise the group belongs to.
The response is either GroupDepartmentGetListResponse() or ErrorResponse().
Replaced by: GroupDepartmentGetListRequest18()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| include_enterprise_departments | bool | includeEnterpriseDepartments |
GroupDepartmentGetListRequest18(OCIRequest)
Request a list of departments in a group.
You may request only the list of departments defined at the group-level, or you may request the list of all departments in the group including all the departments defined within the enterprise the group belongs to.
The response is either GroupDepartmentGetListResponse18() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| include_enterprise_departments | bool | includeEnterpriseDepartments |
GroupDepartmentGetRequest(OCIRequest)
Request the attributes of a department.
The response is either a GroupDepartmentGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department_name | str | departmentName |
GroupDeviceActivationPolicyGetRequest(OCIRequest)
Request the Device Activation policy of a group.
The response is either a GroupDeviceActivationPolicyGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupDeviceActivationPolicyModifyRequest(OCIRequest)
Modify the Device Activation policy of a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_group_settings | bool | useGroupSettings Optional |
| allow_activation_code_request_by_user | bool | allowActivationCodeRequestByUser Optional |
| send_activation_code_in_email | bool | sendActivationCodeInEmail Optional |
GroupDeviceManagementGetAccessDeviceCountForDeviceTypeGroupRequest(OCIRequest)
Request the number of access device of a particular device type and group.
If countOnlyResetSupportedDevice is true, count only access devices if the device type supports reset. By default unmanaged device types are not allowed and devices are counted only if their device type supports Device Management. An error is returned if deviceType is specified but does not support device management. When allowUnmanagedDeviceType is true, unmanaged device type will be counted and a successful response is returned.
The response is either
GroupDeviceManagementGetAccessDeviceCountForDeviceTypeGroupResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
| count_only_reset_supported_device | bool | countOnlyResetSupportedDevice Optional |
| allow_unmanaged_device_type | bool | allowUnmanagedDeviceType Optional |
GroupDeviceManagementInProgressAndPendingEventCancelRequest(OCIRequest)
Cancel pending and in progress events.
A list of individual events can be canceled.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| event_id | List[int] | eventId |
GroupDeviceTypeCustomTagAddRequest(OCIRequest)
Request to add a static configuration tag for an access device type used in a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
| tag_name | str | tagName |
| tag_value | str | tagValue Optional |
GroupDeviceTypeCustomTagDeleteListRequest(OCIRequest)
Request to delete static configuration tags for an access device type used in a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
| tag_name | List[str] | tagName |
GroupDeviceTypeCustomTagGetListRequest(OCIRequest)
Request to get the list of custom configuration tags managed by the Device Management System, on a per-device type basis for a group.
The response is either GroupDeviceTypeCustomTagGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
GroupDeviceTypeCustomTagModifyRequest(OCIRequest)
Request to modify a static configuration tag for an access device type used in a group.
The tagValueToEncrypt element can only be used by a system administrator. The following elements are only used in XS data mode and ignored in AS data mode: tagValueToEncrypt
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
| tag_name | str | tagName |
| tag_value | str | tagValue Optional |
| tag_value_to_encrypt | str | tagValueToEncrypt Optional |
GroupDeviceTypeFileGetListRequest(OCIRequest)
Request to get the list of device type files managed by the Device Management System, on a per-group basis.
The response is either GroupDeviceTypeFileGetListResponse() or ErrorResponse().
Replaced By: GroupDeviceTypeFileGetListRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
GroupDeviceTypeFileGetListRequest14sp8(OCIRequest)
Request to get the list of device type files managed by the Device Management System, on a per-group basis.
The response is either GroupDeviceTypeFileGetListResponse14sp8() or
ErrorResponse(). Replaced by: GroupDeviceTypeFileGetListRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
GroupDeviceTypeFileGetListRequest21(OCIRequest)
Request to get the list of device type files managed by the Device Management System, on a per-group basis.
The response is either GroupDeviceTypeFileGetListResponse21() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
GroupDeviceTypeFileGetRequest(OCIRequest)
Request to get a group device type file.
The response is either GroupDeviceTypeFileGetResponse() or ErrorResponse().
Replaced By: GroupDeviceTypeFileGetRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
| file_type | str | fileType |
GroupDeviceTypeFileGetRequest14sp8(OCIRequest)
Request to get a group device type file.
The response is either GroupDeviceTypeFileGetResponse14sp8() or ErrorResponse().
Replaced by: GroupDeviceTypeFileGetRequest16sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
| file_format | str | fileFormat |
GroupDeviceTypeFileGetRequest16sp1(OCIRequest)
Request to get a group device type file.
The response is either GroupDeviceTypeFileGetResponse16sp1() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
| file_format | str | fileFormat |
GroupDeviceTypeTagSetGetRequest(OCIRequest)
Request to get the custom configuration tag set defined for the group and device type.
The response is either GroupDeviceTypeTagSetGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
GroupDeviceTypeTagSetModifyRequest(OCIRequest)
Request to modify a static configuration tag set.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
| tag_set_name | str | tagSetName Optional |
GroupDialPlanPolicyAddAccessCodeRequest(OCIRequest)
Request to add a Group level Dial Plan Access Code and its all attribues.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| access_code | str | accessCode |
| include_code_for_network_translations_and_routing | bool | includeCodeForNetworkTranslationsAndRouting |
| include_code_for_screening_services | bool | includeCodeForScreeningServices |
| enable_secondary_dial_tone | bool | enableSecondaryDialTone |
| description | str | description Optional |
GroupDialPlanPolicyDeleteAccessCodeRequest(OCIRequest)
Request to delete a Group level Dial Plan Access Code and its all attribues.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| access_code | str | accessCode |
GroupDialPlanPolicyGetAccessCodeListRequest(OCIRequest)
Request the Group level data associated with Dial Plan Policy.
The response is either a GroupDialPlanPolicyGetAccessCodeListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupDialPlanPolicyGetAccessCodeRequest(OCIRequest)
Request access code data associated with Group level Dial Plan Policy access codes.
The response is either a GroupDialPlanPolicyGetAccessCodeResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| access_code | str | accessCode |
GroupDialPlanPolicyGetRequest(OCIRequest)
Request the Group level data associated with Dial Plan Policy.
The response is either a GroupDialPlanPolicyGetResponse() or an ErrorResponse().
Replaced by: GroupDialPlanPolicyGetRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupDialPlanPolicyGetRequest17(OCIRequest)
Request the Group level data associated with Dial Plan Policy.
The response is either a GroupDialPlanPolicyGetResponse17() or an ErrorResponse().
Replaced by: GroupDialPlanPolicyGetRequest22() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupDialPlanPolicyGetRequest22(OCIRequest)
Request the Group level data associated with Dial Plan Policy.
The response is either a GroupDialPlanPolicyGetResponse22() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupDialPlanPolicyModifyAccessCodeRequest(OCIRequest)
Request to modify a Group level Dial Plan Access Code and its attribues.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| access_code | str | accessCode |
| include_code_for_network_translations_and_routing | bool | includeCodeForNetworkTranslationsAndRouting Optional |
| include_code_for_screening_services | bool | includeCodeForScreeningServices Optional |
| enable_secondary_dial_tone | bool | enableSecondaryDialTone Optional |
| description | str | description Optional |
GroupDialPlanPolicyModifyRequest(OCIRequest)
Modify the Group level data associated with Dial Plan Policy.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
overrideResolvedDeviceDigitMap deviceDigitMap
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_setting | str | useSetting Optional |
| requires_access_code_for_public_calls | bool | requiresAccessCodeForPublicCalls Optional |
| allow_e164_public_calls | bool | allowE164PublicCalls Optional |
| prefer_e164_number_format_for_callback_services | bool | preferE164NumberFormatForCallbackServices Optional |
| public_digit_map | str | publicDigitMap Optional |
| private_digit_map | str | privateDigitMap Optional |
| override_resolved_device_digit_map | bool | overrideResolvedDeviceDigitMap Optional |
| device_digit_map | str | deviceDigitMap Optional |
GroupDialableCallerIDCriteriaAddRequest(OCIRequest)
Add a new Dialable Caller ID Criteria.
Criteria are added at the bottom of the list with the lowest priority.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| description | str | description Optional |
| prefix_digits | str | prefixDigits Optional |
| match_call_type | List[str] | matchCallType Optional |
| match_alternate_call_indicator | List[str] | matchAlternateCallIndicator Optional |
| match_local_category | bool | matchLocalCategory |
| match_national_category | bool | matchNationalCategory |
| match_interlata_category | bool | matchInterlataCategory |
| match_intralata_category | bool | matchIntralataCategory |
| match_international_category | bool | matchInternationalCategory |
| match_private_category | bool | matchPrivateCategory |
| match_emergency_category | bool | matchEmergencyCategory |
| match_other_category | bool | matchOtherCategory |
GroupDialableCallerIDCriteriaDeleteRequest(OCIRequest)
Delete a Dialable Caller ID Criteria.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupDialableCallerIDCriteriaGetRequest(OCIRequest)
Get an existing Dialable Caller ID Criteria.
The response is either a GroupDialableCallerIDCriteriaGetRequest() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupDialableCallerIDGetRequest(OCIRequest)
Get the Group's Dialable Caller ID settings and criteria list.
The response is either a GroupDialableCallerIDGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupDigitCollectionGetRequest13mp4(OCIRequest)
Request the group's digit collection attributes.
The response is either a GroupDigitCollectionGetResponse13mp4() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupDigitCollectionModifyRequest(OCIRequest)
Modifies the group's digit collection attributes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_setting | str | useSetting Optional |
| access_code | str | accessCode Optional |
| public_digit_map | str | publicDigitMap Optional |
| private_digit_map | str | privateDigitMap Optional |
GroupDirectoryNumberHuntingGetAvailableUserListRequest(OCIRequest)
Request to get the agents of a call center or hunt group that are available to be assigned to a directory number hunting group.
They are agents that are not already assigned to any other directory number hunting group.
The response is either GroupDirectoryNumberHuntingGetAvailableUserListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupDirectoryNumberHuntingGetRequest(OCIRequest)
Request to get the properties of the DNH service for a specified serviceUserId.
It gets the agents of a call center or hunt group that are members of a directory number hunting group. They are agents that are not already assigned to any other directory number hunting group.
The response is either GroupDirectoryNumberHuntingGetResponse() or
ErrorResponse(). Replaced by: GroupDirectoryNumberHuntingGetRequest17sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupDirectoryNumberHuntingGetRequest17sp1(OCIRequest)
Request to get the properties of the DNH service for a specified serviceUserId.
It gets the agents of a call center or hunt group that are members of a directory number hunting group. They are agents that are not already assigned to any other directory number hunting group.
The response is either GroupDirectoryNumberHuntingGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupDnGetActivationListRequest(OCIRequest)
Get the list of activated and deactivated DNs in a group.
Ranges of DNs with identical assignment and activation properties are coalesced to a single table row entry. Only DNs assigned to a users are listed in the response when the number activation Mode is set to "User Activation Enabled" Dns assigned to the IMRN pool are not listed in the response.
The response is either a GroupDnGetActivationListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupDnGetAvailableListRequest(OCIRequest)
Get the list of DNs that are assigned to a group and still available for assignment to users or service instances within the group.
Dns assigned to the IMRN pool are not listed in the response.
The response is either a GroupDnGetAvailableListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupDnGetAvailableRangesListRequest(OCIRequest)
Get a list of group DNs that are not assigned to user, service instances or IMRN pool.
The Dns are returned in a list of DNs or DN ranges and formated in E164 format for display.
The response is either a GroupDnGetAvailableRangeListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupDnGetDetailedAvailableListRequest(OCIRequest)
Get the list of DNs that are assigned to a group and still available for assignment to users within the group with the department name, if the DN is assigned to the department.
Dns assigned to the IMRN pool are not listed in the response.
The response is either a GroupDnGetDetailedAvailableListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupDnGetListRequest(OCIRequest)
Get the list of DNs that are assigned to a group.
Dns assigned to the IMRN pool are not listed in the response.
The response is either a GroupDnGetListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupDnGetStatusListRequest(OCIRequest)
Validates DNs given in the request The response is GroupDnGetStatusListResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| dn | List[str] | dn |
GroupDnGetSummaryListRequest(OCIRequest)
Get the list of assigned and unassigned DN ranges in a group.
Dns assigned to the IMRN pool are not listed in the response.
The response is either a GroupDnGetSummaryListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupDomainAssignListRequest(OCIRequest)
Assign a list of domains to a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| domain | List[str] | domain |
GroupDomainGetAssignedListRequest(OCIRequest)
Requests the list of all domains assigned to a group.
The response is either GroupDomainGetAssignedListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupDomainUnassignListRequest(OCIRequest)
Unassign a list of domains from a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| domain | List[str] | domain |
GroupEmergencyCallNotificationGetRequest(OCIRequest)
Request the group level data associated with Emergency Call Notification.
The response is either a GroupEmergencyCallNotificationGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupEmergencyCallNotificationModifyRequest(OCIRequest)
Modify the group level data associated with Emergency Call Notification.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| send_emergency_call_notification_email | bool | sendEmergencyCallNotificationEmail Optional |
| emergency_call_notify_email_address | str | emergencyCallNotifyEmailAddress Optional |
GroupEmergencyZonesGetHomeZoneListRequest(OCIRequest)
Request the group level data associated with Emergency Zones.
The response is either a GroupEmergencyZonesGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupEmergencyZonesGetRequest(OCIRequest)
Request the group level data associated with Emergency Zones.
The response is either a GroupEmergencyZonesGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupEmergencyZonesModifyHomeZoneListRequest(OCIRequest)
Modify a list of home zones and/or home zone ranges.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| home_zone_ip_address_list | List[OCI.homeZoneIpAddressList] | homeZoneIpAddressList Optional |
| home_zone_ip_address_range_list | List[OCI.homeZoneIpAddressRangeList] | homeZoneIpAddressRangeList Optional |
GroupEmergencyZonesModifyRequest(OCIRequest)
Modify the group level data associated with Emergency Zones.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| is_active | bool | isActive Optional |
| emergency_zones_prohibition | str | emergencyZonesProhibition Optional |
| send_emergency_call_notify_email | bool | sendEmergencyCallNotifyEmail Optional |
| emergency_call_notify_email_address | str | emergencyCallNotifyEmailAddress Optional |
GroupEnhancedCallLogsSchemaInstanceGetRequest(OCIRequest)
Get the enhanced call log database schema instance associated with a group of a service provider.
The response is either a GroupEnhancedCallLogsSchemaInstanceGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupEnhancedCallLogsSchemaInstanceModifyRequest(OCIRequest)
Modify the Enhanced Call Logs schema instance associated with a group of a service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name Optional |
GroupEnterpriseTrunkAddRequest(OCIRequest)
Request to add an enterprise trunk in a group.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
GroupEnterpriseTrunkAddRequest21().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| enterprise_trunk_name | str | enterpriseTrunkName |
| maximum_reroute_attempts | int | maximumRerouteAttempts |
| route_exhaustion_action | str | routeExhaustionAction |
| route_exhaustion_forward_address | str | routeExhaustionForwardAddress Optional |
| ordered_routing | OCI.orderedRouting | orderedRouting Optional |
| priority_weighted_routing | OCI.priorityWeightedRouting | priorityWeightedRouting Optional |
GroupEnterpriseTrunkAddRequest21(OCIRequest)
Request to add an enterprise trunk in a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| enterprise_trunk_name | str | enterpriseTrunkName |
| maximum_reroute_attempts | int | maximumRerouteAttempts |
| route_exhaustion_action | str | routeExhaustionAction |
| route_exhaustion_forward_address | str | routeExhaustionForwardAddress Optional |
| ordered_routing | OCI.orderedRouting | orderedRouting Optional |
| priority_weighted_routing | OCI.priorityWeightedRouting | priorityWeightedRouting Optional |
| enable_capacity_management | bool | enableCapacityManagement |
| max_active_calls | int | maxActiveCalls Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls Optional |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls Optional |
| maximum_active_incoming_calls_allowed | int | maximumActiveIncomingCallsAllowed Optional |
| maximum_active_outgoing_calls_allowed | int | maximumActiveOutgoingCallsAllowed Optional |
| minimum_active_calls_reserved | int | minimumActiveCallsReserved Optional |
GroupEnterpriseTrunkAddUserListRequest(OCIRequest)
Request to add users to an enterprise trunk in a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| enterprise_trunk_name | str | enterpriseTrunkName |
| user_id | List[str] | userId |
GroupEnterpriseTrunkDeleteRequest(OCIRequest)
Request to delete an enterprise trunk in a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| enterprise_trunk_name | str | enterpriseTrunkName |
GroupEnterpriseTrunkDeleteUserListRequest(OCIRequest)
Request to delete users from an enterprise trunk in a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| enterprise_trunk_name | str | enterpriseTrunkName |
| user_id | List[str] | userId |
GroupEnterpriseTrunkForceAssignUserListRequest(OCIRequest)
Request to add users to an enterprise trunk in a group.
If the user is already assigned to another enterprise trunk, it will be unassigned from the old enterprise trunk and assigned to the new enterprise trunk specified in this request.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| enterprise_trunk_name | str | enterpriseTrunkName |
| user_id | List[str] | userId |
GroupEnterpriseTrunkGetListRequest(OCIRequest)
Request to get the list of all enterprise trunks defined in a group.
The response is either a GroupEnterpriseTrunkGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupEnterpriseTrunkGetRequest(OCIRequest)
Request to get an enterprise trunk The response is either an
GroupEnterpriseTrunkGetResponse() or an ErrorResponse().
Replaced by: GroupEnterpriseTrunkGetRequest21().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| enterprise_trunk_name | str | enterpriseTrunkName |
GroupEnterpriseTrunkGetRequest21(OCIRequest)
Request to get an enterprise trunk The response is either an
GroupEnterpriseTrunkGetResponse21() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| enterprise_trunk_name | str | enterpriseTrunkName |
GroupEnterpriseTrunkGetRequest22(OCIRequest)
Request to get an enterprise trunk The response is either an
GroupEnterpriseTrunkGetResponse22() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| enterprise_trunk_name | str | enterpriseTrunkName |
GroupEnterpriseTrunkModifyRequest(OCIRequest)
Request to modify an enterprise trunk in a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| enterprise_trunk_name | str | enterpriseTrunkName |
| new_enterprise_trunk_name | str | newEnterpriseTrunkName Optional |
| maximum_reroute_attempts | int | maximumRerouteAttempts Optional |
| route_exhaustion_action | str | routeExhaustionAction Optional |
| route_exhaustion_forward_address | str | routeExhaustionForwardAddress Optional |
| ordered_routing | OCI.orderedRouting | orderedRouting Optional |
| priority_weighted_routing | OCI.priorityWeightedRouting | priorityWeightedRouting Optional |
| enable_capacity_management | bool | enableCapacityManagement Optional |
| max_active_calls | int | maxActiveCalls Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls Optional |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls Optional |
| maximum_active_incoming_calls_allowed | int | maximumActiveIncomingCallsAllowed Optional |
| maximum_active_outgoing_calls_allowed | int | maximumActiveOutgoingCallsAllowed Optional |
| minimum_active_calls_reserved | int | minimumActiveCallsReserved Optional |
GroupExchangeIntegrationGetRequest(OCIRequest)
Request the group level configuration for Exchange Integration.
The response is either a GroupExchangeIntegrationGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupExistingUsersAssignUserServiceListRequest(OCIRequest)
Request to assign the user services and service packs to all existing users within the group.
BroadSoft recommends using this command only for small groups with less than 100 users. This command will return an error if the group has over 500 users. The recommended way to bulk assign/unassign services is Service Pack Migration.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_name | List[str] | serviceName Optional |
| service_pack_name | List[str] | servicePackName Optional |
GroupExistingUsersUnassignUserServiceListRequest(OCIRequest)
Requests to unassign the user services and service packs for all existing users within the group.
BroadSoft recommends using this command only for small groups with less than 100 users. This command will return an error if the group has over 500 users. The recommended way to bulk assign/unassign services is Service Pack Migration.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_name | List[str] | serviceName Optional |
| service_pack_name | List[str] | servicePackName Optional |
GroupExtensionLengthGetRequest(OCIRequest)
Request the group's extension length.
The response is either a GroupExtensionLengthGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupExtensionLengthGetRequest17(OCIRequest)
Request the group's extension length.
The response is either a GroupExtensionLengthGetResponse17() or an
ErrorResponse(). Replaced by: GroupExtensionLengthGetRequest22() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupExtensionLengthGetRequest22(OCIRequest)
Request the group's extension length.
The response is either a GroupExtensionLengthGetResponse22() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupExtensionLengthModifyRequest(OCIRequest)
Modify the group's extension length.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| extension_length | int | extensionLength Optional |
GroupExtensionLengthModifyRequest17(OCIRequest)
Modify the group's extension length range.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
useExterpriseExtensionLengthSetting
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| min_extension_length | int | minExtensionLength Optional |
| max_extension_length | int | maxExtensionLength Optional |
| default_extension_length | int | defaultExtensionLength Optional |
| use_enterprise_extension_length_setting | bool | useEnterpriseExtensionLengthSetting Optional |
GroupFeatureAccessCodeGetListRequest(OCIRequest)
Get the list of feature access codes for a group.
The response is either a GroupFeatureAccessCodeGetListResponse() or an
ErrorResponse(). Replaced by: GroupFeatureAccessCodeGetRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupFeatureAccessCodeGetRequest(OCIRequest)
Get group FAC code level and the list of feature access codes for a group.
The response is either a GroupFeatureAccessCodeGetResponse() or an
ErrorResponse(). Returned Feature Access Codes may be group specific, or Service
Provider Feature Access Codes, depending on FAC code level. Replaced by:
GroupFeatureAccessCodeGetRequest21() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupFeatureAccessCodeGetRequest20(OCIRequest)
Get group FAC code level and the list of feature access codes for a group.
The response is either a GroupFeatureAccessCodeGetResponse20() or an
ErrorResponse(). Returned Feature Access Codes may be group specific, or Service
Provider Feature Access Codes, depending on FAC code level. In release 20 the "Call
Recording" FAC name is changed to "Call Recording - Start". Replaced by:
GroupFeatureAccessCodeGetRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupFeatureAccessCodeGetRequest21(OCIRequest)
Get group FAC code level and the list of feature access codes for a group.
The response is either a GroupFeatureAccessCodeGetResponse21() or an
ErrorResponse(). Returned Feature Access Codes may be group specific, or Service
Provider Feature Access Codes, depending on FAC code level. In release 20 the "Call
Recording" FAC name is changed to "Call Recording - Start".
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupFileRepositoryDeviceUserAddRequest(OCIRequest)
Add a new group file repository user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| file_repository_name | str | fileRepositoryName |
| user_name | str | userName |
| password | str | password |
| allow_put | bool | allowPut |
| allow_delete | bool | allowDelete |
| allow_get | bool | allowGet |
GroupFileRepositoryDeviceUserDeleteRequest(OCIRequest)
Delete a group file repository user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| file_repository_name | str | fileRepositoryName |
| user_name | str | userName |
GroupFileRepositoryDeviceUserGetListRequest(OCIRequest)
Request the list of group users for a file repository in the system.
The response is either a GroupFileRepositoryDeviceUserGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| file_repository_name | str | fileRepositoryName |
GroupFileRepositoryDeviceUserModifyRequest(OCIRequest)
Modify a group file repository user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| file_repository_name | str | fileRepositoryName |
| user_name | str | userName |
| password | str | password Optional |
| allow_put | bool | allowPut Optional |
| allow_delete | bool | allowDelete Optional |
| allow_get | bool | allowGet Optional |
GroupFindMeFollowMeAddAlertingGroupRequest(OCIRequest)
Add an alerting group to a Find-me/Follow-me instance.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| alerting_group_name | str | alertingGroupName |
| alerting_group_description | str | alertingGroupDescription Optional |
| use_diversion_inhibitor | bool | useDiversionInhibitor |
| answer_confirmation_required | bool | answerConfirmationRequired |
| number_of_rings | int | numberOfRings |
| phone_number | str | phoneNumber Optional |
| user_id | str | userId Optional |
GroupFindMeFollowMeDeleteAlertingGroupRequest(OCIRequest)
Delete an alerting group from a Find-me/Follow-me instance.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| alerting_group_name | str | alertingGroupName |
GroupFindMeFollowMeDeleteAlertingGroupSelectiveCriteriaRequest(OCIRequest)
Delete a criteria from the Find-me/Follow-me alerting group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| alerting_group_name | str | alertingGroupName |
| criteria_name | str | criteriaName |
GroupFindMeFollowMeDeleteInstanceRequest(OCIRequest)
Delete a Find-me/Follow-me instance from a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupFindMeFollowMeGetAlertingGroupListRequest(OCIRequest)
Get a list of Find-me/Follow-me alerting groups within a group.
The response is either GroupFindMeFollowMeGetAlertingGroupListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupFindMeFollowMeGetAlertingGroupRequest(OCIRequest)
Request to get all the information of a Find-me/Follow-me alerting group.
The response is either GroupFindMeFollowMeGetAlertingGroupResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| alerting_group_name | str | alertingGroupName |
GroupFindMeFollowMeGetAlertingGroupSelectiveCriteriaRequest(OCIRequest)
Request to get all the information of a specific Find-me/Follow-me alerting group selective criteria.
The response is either GroupFindMeFollowMeGetAlertingGroupResponse() or
ErrorResponse(). Replaced by:
GroupFindMeFollowMeGetAlertingGroupSelectiveCriteriaRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| alerting_group_name | str | alertingGroupName |
| criteria_name | str | criteriaName |
GroupFindMeFollowMeGetAlertingGroupSelectiveCriteriaRequest21(OCIRequest)
Request to get all the information of a specific Find-me/Follow-me alerting group selective criteria.
The response is either GroupFindMeFollowMeGetAlertingGroupResponse21() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| alerting_group_name | str | alertingGroupName |
| criteria_name | str | criteriaName |
GroupFindMeFollowMeGetInstanceListRequest(OCIRequest)
Get a list of Find-me/Follow-me instances within a group.
The response is either GroupFindMeFollowMeGetInstanceListResponse() or
ErrorResponse(). It is possible to get the instances within a specified department.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_department_name | str | groupDepartmentName Optional |
GroupFindMeFollowMeGetInstanceRequest(OCIRequest)
Request to get all the information of a Find-me/Follow-me instance.
The response is either GroupFindMeFollowMeGetInstanceResponse() or
ErrorResponse(). Replaced by: GroupFindMeFollowMeGetInstanceRequest19sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupFindMeFollowMeGetInstanceRequest19sp1(OCIRequest)
Request to get all the information of a Find-me/Follow-me instance.
The response is either GroupFindMeFollowMeGetInstanceResponse19sp1() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupFindMeFollowMeModifyAlertingGroupListRequest(OCIRequest)
Modify the priorities assigned to alerting groups The response is either a
SuccessResponse() or an ErrorResponse().
NOTE: The command fails if all the alerting groups defined for the user are not provided.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| alerting_group_name | List[str] | alertingGroupName Optional |
GroupFlexibleSeatingAccessDeviceGetListRequest(OCIRequest)
Requests the list of access devices available for assignment to a flexible seating host or guest.
The list includes devices created at the system, service provider, and group levels that support device management.
The response is either GroupFlexibleSeatingAccessDeviceGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupFlexibleSeatingHostDeleteInstanceRequest(OCIRequest)
Delete a flexible seating host instance from a group.
Host cannot be deleted when a guest is associated to a host.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupFlexibleSeatingHostGetInstanceRequest(OCIRequest)
Request to get all the information of a flexible seating host instance.
The response is either GroupFlexibleSeatingHostGetInstanceResponse() or
ErrorResponse(). Replaced by: GroupFlexibleSeatingHostGetInstanceRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupFlexibleSeatingHostGetInstanceRequest22(OCIRequest)
Request to get all the information of a flexible seating host instance.
The response is either GroupFlexibleSeatingHostGetInstanceResponse22() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupFlexibleSeatingHostGuestAssociationGetRequest(OCIRequest)
Request the flexible seating host guest association details.
The response is either a GroupFlexibleSeatingHostGuestAssociationGetResponse() or an
ErrorResponse(). accessLevel is always set to Group for a Service Provider
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupFlexibleSeatingHostGuestAssociationModifyRequest(OCIRequest)
Modify the flexible seating host’s guest association attributes.
The request fails if enforceAssociationLimit or associationLimitHours are changed when the host is associated to a guest.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| enforce_association_limit | bool | enforceAssociationLimit Optional |
| association_limit_hours | int | associationLimitHours Optional |
| access_level | str | accessLevel Optional |
| remove_guest_association | bool | removeGuestAssociation Optional |
GroupFlexibleSeatingHostRoutingPoliciesGetRequest(OCIRequest)
Get a flexible seating host’s routing policies The response is either a
GroupFlexibleSeatingHostRoutingPoliciesGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupFlexibleSeatingHostRoutingPoliciesModifyRequest(OCIRequest)
Modify a flexible seating host’s routing policies The response is either a
SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| allow_emergency_calls | bool | allowEmergencyCalls Optional |
| allow_calls_to_voice_portal | bool | allowCallsToVoicePortal Optional |
GroupGetAvailableLeafDeviceListRequest(OCIRequest)
Requests the list of available leaf devices that can be linked to a tree device within a specific group.
A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device". It can be linked to only one tree device. The list returned includes devices created at the system, service provider, and group levels.
The response is either GroupGetAvailableLeafDeviceListResponse() or
ErrorResponse(). Replaced by: GroupGetAvailableLeafDeviceListRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupGetAvailableLeafDeviceListRequest22(OCIRequest)
Requests the list of available leaf devices that can be linked to a tree device within a specific group.
A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device. The list returned includes devices created at the system, service provider, and group levels. If the leafDeviceCategory is not set in the request, then linked leaf devices of all categories are requested, otherwise only the linked leaf devices of the specified category are requested. The category values are: "Handset", "Base Station", "All".
The response is either GroupGetAvailableLeafDeviceListResponse22() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| leaf_device_category | str | leafDeviceCategory Optional |
GroupGetAvailableTreeDeviceListRequest(OCIRequest)
Requests the list of available tree devices to which leaf devices can be linked to within a specific group.
A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. The list returned includes devices created at the system, service provider, and group levels.
The response is either GroupGetAvailableTreeDeviceListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupGetDefaultRequest(OCIRequest)
Request the default profile for a group.
The response is either a GroupGetDefaultResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
GroupGetRequest(OCIRequest)
Get the profile for a group.
The response is either a GroupGetResponse() or an ErrorResponse().
Replaced By: GroupGetRequest14sp7()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupGetRequest14sp7(OCIRequest)
Get the profile for a group.
The response is either a GroupGetResponse14sp7() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupGetRequest22(OCIRequest)
Get the profile for a group.
The response is either a GroupGetResponse22() or an ErrorResponse(). Replaced by
GroupGetRequest22V2() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupGetRequest22V2(OCIRequest)
Get the profile for a group.
The response is either a GroupGetResponse22V2() or an ErrorResponse(). Replaced
by: GroupGetRequest22V3()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupGetRequest22V3(OCIRequest)
Get the profile for a group.
The response is either a GroupGetResponse22V3() or an ErrorResponse(). Replaced by
GroupGetRequest22V4()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupGetRequest22V4(OCIRequest)
Get the profile for a group.
The response is either a GroupGetResponse22V4() or an ErrorResponse(). Replaced
by: GroupGetRequest22V5() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupGetRequest22V5(OCIRequest)
Get the profile for a group.
The response is either a GroupGetResponse22V5() or an ErrorResponse(). The
following elements are only used in AS data mode and ignored in XS data mode:
groupExternalId
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| group_external_id | str | groupExternalId Optional |
GroupGetUserServiceAssignedUserListRequest(OCIRequest)
Get the list of users assigned the user service or service pack.
The response is either a GroupGetUserServiceAssignedUserListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_name | str | serviceName Optional |
| service_pack_name | str | servicePackName Optional |
GroupGroupNightForwardingGetRequest(OCIRequest)
Request to get the Group Night Forwarding group parameters.
The response is either GroupGroupNightForwardingGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupGroupPagingAddOriginatorListRequest(OCIRequest)
Add originator(s) to a paging group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| originator_user_id | List[str] | originatorUserId |
GroupGroupPagingAddTargetListRequest(OCIRequest)
Add target(s) to a paging group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| target_user_id | List[str] | targetUserId |
GroupGroupPagingDeleteInstanceRequest(OCIRequest)
Delete a Group Paging instance from a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupGroupPagingDeleteOriginatorListRequest(OCIRequest)
Delete originator(s) from a paging group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| originator_user_id | List[str] | originatorUserId |
GroupGroupPagingDeleteTargetListRequest(OCIRequest)
Delete target(s) from a paging group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| target_user_id | List[str] | targetUserId |
GroupGroupPagingGetInstanceListRequest(OCIRequest)
Get a list of Paging Groups instances within a group.
The response is either GroupGroupPagingGetInstanceListResponse() or
ErrorResponse(). It is possible to get the instances within a specified department.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_department_name | str | groupDepartmentName Optional |
GroupGroupPagingGetInstanceRequest(OCIRequest)
Replaced By GroupGroupPagingGetInstanceRequest17sp3() Request to get all the
information of a Group Paging instance.
The response is either GroupGroupPagingGetInstanceResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupGroupPagingGetInstanceRequest17sp3(OCIRequest)
Request to get all the information of a Group Paging instance.
The response is either GroupGroupPagingGetInstanceResponse17sp3() or
ErrorResponse(). Replaced by: GroupGroupPagingGetInstanceRequest19sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupGroupPagingGetInstanceRequest19sp1(OCIRequest)
Request to get all the information of a Group Paging instance.
The response is either GroupGroupPagingGetInstanceResponse19sp1() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupGroupPagingGetOriginatorListRequest(OCIRequest)
Get a list of originators assigned to a paging group.
The response is either a GroupGroupPagingGetOriginatorListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupGroupPagingGetTargetListRequest(OCIRequest)
Get a list of targets assigned to a paging group.
The response is either a GroupGroupPagingGetTargetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupGroupPagingTargetsCapacityGetRequest(OCIRequest)
Request the maximum number of target users per paging group configured for a group.
The response is either a GroupGroupPagingTargetsCapacityGetResponse() or an
ErrorResponse(). Replaced by: GroupGroupPagingTargetsCapacityGetRequest22() in AS
data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupGroupPagingTargetsCapacityGetRequest22(OCIRequest)
Request the maximum number of target users per paging group configured for a group.
The response is either a GroupGroupPagingTargetsCapacityGetResponse22() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupGroupPagingTargetsCapacityModifyRequest(OCIRequest)
Modify the maximum number of target users per paging group configured for a group.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
GroupGroupPagingTargetsCapacityModifyRequest22() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| maximum_target_users | int | maximumTargetUsers Optional |
GroupGroupPagingTargetsCapacityModifyRequest22(OCIRequest)
Modify the maximum number of target users per paging group configured for a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| maximum_target_users | int | maximumTargetUsers Optional |
GroupHolidayScheduleDeleteRequest(OCIRequest)
Delete a holiday schedule from a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| holiday_schedule_name | str | holidayScheduleName |
GroupHolidayScheduleGetListRequest(OCIRequest)
Get a holiday schedule in a group.
The response is either a GroupHolidayScheduleGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupHolidayScheduleGetRequest(OCIRequest)
Get a holiday schedule in a group.
The response is either a GroupHolidayScheduleGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| holiday_schedule_name | str | holidayScheduleName |
GroupHuntGroupConsolidatedDeleteInstanceRequest(OCIRequest)
Delete a Hunt Group instance from a group.
If UnassignPhoneNumbersLevel is set to 'Group', the user's primary phone number, fax
number and any alternate numbers, will be un-assigned from the group if the command is
executed by a service provider administrator or above. When set to 'Service
Provider', they will be un-assigned from the group and service provider if the command
is executed by a provisioning administrator or above. When omitted, the number(s)
will be left assigned to the group. An ErrorResponse() will be returned if any
number cannot be unassigned because of insufficient privilege.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| unassign_phone_numbers | str | unassignPhoneNumbers Optional |
GroupHuntGroupDeleteInstanceRequest(OCIRequest)
Delete a Hunt Group instance from a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupHuntGroupGetInstanceListRequest(OCIRequest)
Get a list of Hunt Group instances within a group.
The response is either GroupHuntGroupGetInstanceListResponse() or ErrorResponse().
It is possible to get the instances within a specified department.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_department_name | str | groupDepartmentName Optional |
GroupHuntGroupGetInstanceRequest14(OCIRequest)
Request to get all the information of a Hunt Group instance.
The response is either GroupHuntGroupGetInstanceResponse14() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupHuntGroupGetInstanceRequest17(OCIRequest)
Request to get all the information of a Hunt Group instance.
The response is either GroupHuntGroupGetInstanceResponse17() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupHuntGroupGetInstanceRequest17sp3(OCIRequest)
Request to get all the information of a Hunt Group instance.
The response is either GroupHuntGroupGetInstanceResponse17sp3() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupHuntGroupGetInstanceRequest17sp4(OCIRequest)
Request to get all the information of a Hunt Group instance.
The response is either GroupHuntGroupGetInstanceResponse17sp4() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupHuntGroupGetInstanceRequest19(OCIRequest)
Request to get all the information of a Hunt Group instance.
The response is either GroupHuntGroupGetInstanceResponse19() or ErrorResponse().
Replaced by: GroupHuntGroupGetInstanceRequest19sp1() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupHuntGroupGetInstanceRequest19sp1(OCIRequest)
Request to get all the information of a Hunt Group instance.
The response is either GroupHuntGroupGetInstanceResponse19sp1() or
ErrorResponse(). Replaced by: GroupHuntGroupGetInstanceRequest20()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupHuntGroupGetInstanceRequest20(OCIRequest)
Request to get all the information of a Hunt Group instance.
The response is either GroupHuntGroupGetInstanceResponse20() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupIMRNGetListRequest(OCIRequest)
Request a summary table of all DNs in a group IMRN pool.
The response is either GroupIMRNGetListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupIncomingCallingPlanGetListRequest(OCIRequest)
Request the group's incoming calling plan settings.
The response is either a GroupIncomingCallingPlanGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupInstantGroupCallDeleteInstanceRequest(OCIRequest)
Request to delete an Instant Group Call service instance from a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupInstantGroupCallGetInstanceListRequest(OCIRequest)
Request to get a list of Instant Group Call service instances within a group.
The response is either GroupInstantGroupCallGetInstanceListResponse() or
ErrorResponse(). It is possible to get the service instances within a specified
department.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_department_name | str | groupDepartmentName Optional |
GroupInstantGroupCallGetInstanceRequest14(OCIRequest)
Request to get all the information of an Instant Group Call service instance.
The response is either GroupInstantGroupCallGetInstanceResponse14() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupInstantGroupCallGetInstanceRequest17(OCIRequest)
Request to get all the information of an Instant Group Call service instance.
The response is either GroupInstantGroupCallGetInstanceResponse17() or
ErrorResponse(). Replaced by: GroupInstantGroupCallGetInstanceRequest19sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupInstantGroupCallGetInstanceRequest19sp1(OCIRequest)
Request to get all the information of an Instant Group Call service instance.
The response is either GroupInstantGroupCallGetInstanceResponse19sp1() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupIntegratedIMPGetRequest(OCIRequest)
Get the Integrated IMP service attributes for the group.
The response is either GroupIntegratedIMPGetResponse() or ErrorResponse().
Replaced by: GroupIntegratedIMPGetRequest21sp1() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupIntegratedIMPGetRequest21sp1(OCIRequest)
Get the Integrated IMP service attributes for the group.
The response is either GroupIntegratedIMPGetResponse21sp1() or ErrorResponse().
Replaced by GroupIntegratedIMPGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupIntegratedIMPGetRequest22(OCIRequest)
Get the Integrated IMP service attributes for the group.
The response is either GroupIntegratedIMPGetResponse22() or ErrorResponse().
Replaced by GroupIntegratedIMPGetRequest23()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupIntegratedIMPGetRequest23(OCIRequest)
Get the Integrated IMP service attributes for the group.
The response is either GroupIntegratedIMPGetResponse23() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupIntegratedIMPModifyRequest(OCIRequest)
Modify the Integrated IMP service attributes for the group.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements can only be used by a reseller administrator or above:
useServiceProviderMessagingServer provisioningUrl provisioningUserId
provisioningPassword
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_service_provider_setting | bool | useServiceProviderSetting Optional |
| service_domain | str | serviceDomain Optional |
| use_service_provider_messaging_server | bool | useServiceProviderMessagingServer Optional |
| provisioning_url | str | provisioningUrl Optional |
| provisioning_user_id | str | provisioningUserId Optional |
| provisioning_password | str | provisioningPassword Optional |
GroupInterceptGroupGetRequest(OCIRequest)
Get the group's intercept group service settings.
The response is either a GroupInterceptGroupGetResponse() or an ErrorResponse().
Replaced By: GroupInterceptGroupGetRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupInterceptGroupGetRequest16(OCIRequest)
Get the group's intercept group service settings.
The response is either a GroupInterceptGroupGetResponse16() or an ErrorResponse().
Replaced By: GroupInterceptGroupGetRequest16sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupInterceptGroupGetRequest16sp1(OCIRequest)
Get the group's intercept group service settings.
The response is either a GroupInterceptGroupGetResponse16sp1() or an
ErrorResponse(). Replaced by: GroupInterceptGroupGetRequest21sp1() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupInterceptGroupGetRequest21sp1(OCIRequest)
Get the group's intercept group service settings.
The response is either a GroupInterceptGroupGetResponse21sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupInventoryReportGetRequest(OCIRequest)
Request the group's inventory report.
The response is either a GroupInventoryReportGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| include_users | bool | includeUsers |
| include_services | bool | includeServices |
| include_dns | bool | includeDns |
| include_access_devices | bool | includeAccessDevices |
| include_departments | bool | includeDepartments |
| report_delivery_email_address | str | reportDeliveryEmailAddress Optional |
GroupMWIDeliveryToMobileEndpointCustomTemplateDeleteRequest(OCIRequest)
Delete a MWI Delivery to Mobile Endpoint Custom Template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| language | str | language |
| type | str | type |
GroupMWIDeliveryToMobileEndpointCustomTemplateDeleteRequest23(OCIRequest)
Delete a MWI Delivery to Mobile Endpoint Custom Template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| language | str | language |
| type | str | type |
GroupMWIDeliveryToMobileEndpointCustomTemplateGetRequest(OCIRequest)
Request a MWI Delivery to Mobile Endpoint Custom Template.
The response is either a GroupMWIDeliveryToMobileEndpointCustomTemplateGetResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| language | str | language |
| type | str | type |
GroupMWIDeliveryToMobileEndpointCustomTemplateGetRequest23(OCIRequest)
Request a MWI Delivery to Mobile Endpoint Custom Template.
The response is either a
GroupMWIDeliveryToMobileEndpointCustomTemplateGetResponse23() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| language | str | language |
| type | str | type |
GroupMWIDeliveryToMobileEndpointGetRequest(OCIRequest)
Requests group MWI custom notifications settings.
The response is either a GroupMWIDeliveryToMobileEndpointGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupMeetMeConferencingDeleteInstanceRequest(OCIRequest)
Delete a Meet-Me Conferencing bridge from a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupMeetMeConferencingGetInstanceListRequest(OCIRequest)
Get a list of Meet-Me Conferencing instances within a group.
The response is either GroupMeetMeConferencingGetInstanceListResponse() or
ErrorResponse(). It is possible to get the instances within a specified department.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department_name | str | departmentName Optional |
GroupMeetMeConferencingGetInstanceRequest(OCIRequest)
Request to get all the information of a Meet-Me Conferencing bridge.
The response is either GroupMeetMeConferencingGetInstanceResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupMeetMeConferencingGetInstanceRequest17sp3(OCIRequest)
Request to get all the information of a Meet-Me Conferencing bridge.
The response is either GroupMeetMeConferencingGetInstanceResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupMeetMeConferencingGetInstanceRequest17sp4(OCIRequest)
Request to get all the information of a Meet-Me Conferencing bridge.
The response is either GroupMeetMeConferencingGetInstanceResponse17sp4() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupMeetMeConferencingGetInstanceRequest18(OCIRequest)
Request to get all the information of a Meet-Me Conferencing bridge.
The response is either GroupMeetMeConferencingGetInstanceResponse18() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupMeetMeConferencingGetInstanceRequest19(OCIRequest)
Request to get all the information of a Meet-Me Conferencing bridge.
The response is either GroupMeetMeConferencingGetInstanceResponse19() or
ErrorResponse(). Replaced by: GroupMeetMeConferencingGetInstanceRequest19sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupMeetMeConferencingGetInstanceRequest19sp1(OCIRequest)
Request to get all the information of a Meet-Me Conferencing bridge.
The response is either GroupMeetMeConferencingGetInstanceResponse19sp1() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupMeetMeConferencingGetRequest(OCIRequest)
Request the group level data associated with Meet-Me Conferencing functions.
The response is either a GroupMeetMeConferencingGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupMusicOnHoldGetDepartmentListRequest(OCIRequest)
Returns a list of all departments that have a Music On Hold instance.
The response is either GroupMusicOnHoldGetDepartmentListResponse() or
ErrorResponse(). It is possible to get the instances within a specified department.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_department_name | str | groupDepartmentName Optional |
GroupNetworkClassOfServiceAssignListRequest(OCIRequest)
Assign a list of Network Classes of Service to a group.
The Element defaultNetworkClassOfService is required only for the first assignment, for subsequent assignments it is optional.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| network_class_of_service | List[str] | networkClassOfService Optional |
| default_network_class_of_service | str | defaultNetworkClassOfService Optional |
GroupNetworkClassOfServiceAssignToAllUsersRequest(OCIRequest)
Assign a Network Classes of Service to all users with in a group.
The Network Classes of Service must be currently assigned to the group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| network_class_of_service | str | networkClassOfService |
GroupNetworkClassOfServiceGetAssignedListRequest(OCIRequest)
Get a list of Network Classes of Service assigned to a group.
The response is either a GroupNetworkClassOfServiceGetAssignedListResponse() or an
ErorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupNetworkClassOfServiceModifyDefaultRequest(OCIRequest)
Modifies the default Network Classes of Service of a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| network_class_of_service | str | networkClassOfService |
GroupNetworkClassOfServiceUnassignListRequest(OCIRequest)
Unassign a list of Network Classes of Service from a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| network_class_of_service | List[str] | networkClassOfService Optional |
| default_network_class_of_service | str | defaultNetworkClassOfService Optional |
GroupNewUserTemplateAssignUserServiceListRequest(OCIRequest)
Request to assign the user services and service packs to all new users created within the group after the completion of this request.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_name | List[str] | serviceName Optional |
| service_pack_name | List[str] | servicePackName Optional |
GroupNewUserTemplateUnassignUserServiceListRequest(OCIRequest)
Requests to unassign the user services and service packs for all new users created within the group after the completion of this request.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_name | List[str] | serviceName Optional |
| service_pack_name | List[str] | servicePackName Optional |
GroupOfficeZoneAssignListRequest(OCIRequest)
Assign a list of Office Zones to a group.
The Element defaultOfficeZone is required only for the first assignment, for subsequent assignments it is optional. Office Zones can only be assigned if the Location-Based Calling Restrictions has been authorized to the group otherwise the request will fail.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| office_zone_name | List[str] | officeZoneName Optional |
| default_office_zone_name | str | defaultOfficeZoneName Optional |
GroupOfficeZoneGetAssignedListRequest(OCIRequest)
Get a list of Office Zones assigned to a group.
The response is either a GroupOfficeZoneGetAssignedListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupOfficeZoneUnassignListRequest(OCIRequest)
Unassign a list of OfficeZones from a group.
Note: a new default must be provided if unassigning the current default.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| office_zone_name | List[str] | officeZoneName Optional |
| default_office_zone_name | str | defaultOfficeZoneName Optional |
GroupOutgoingCallingPlanAuthorizationCodeGetListRequest(OCIRequest)
Request the list of authorization codes for a group default and it's departments.
The response is either a GroupOutgoingCallingPlanAuthorizationCodeGetListResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupOutgoingCallingPlanCallMeNowGetListRequest(OCIRequest)
Request the Call Me Now call permissions for a group default and it's departments.
The response is either a GroupOutgoingCallingPlanCallMeNowGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupOutgoingCallingPlanDigitPlanCallMeNowGetListRequest(OCIRequest)
Request the Call Me Now call permissions for digit patterns for a group default and it's departments.
The response is either a GroupOutgoingCallingPlanDigitPlanCallMeNowGetListResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupOutgoingCallingPlanDigitPlanOriginatingGetListRequest(OCIRequest)
Request the originating permissions for digit patterns for a group default and it's departments.
The response is either a
GroupOutgoingCallingPlanDigitPlanOriginatingGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupOutgoingCallingPlanDigitPlanRedirectingGetListRequest(OCIRequest)
Request the redirecting permissions for digit patterns for a group default and it's departments.
The response is either a
GroupOutgoingCallingPlanDigitPlanRedirectingGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupOutgoingCallingPlanOriginatingGetListRequest(OCIRequest)
Request the originating permissions for a group default and it's departments.
The response is either a GroupOutgoingCallingPlanOriginatingGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupOutgoingCallingPlanPinholeDigitPatternAddRequest(OCIRequest)
Add a new calling plan Pinhole digit string.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| digit_pattern | str | digitPattern |
GroupOutgoingCallingPlanPinholeDigitPatternDeleteListRequest(OCIRequest)
Delete one or more calling plan Pinhole digit strings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | List[str] | name |
GroupOutgoingCallingPlanPinholeDigitPatternGetListRequest(OCIRequest)
Get the list of calling plan Pinhole digit strings for a group.
The response is either a
GroupOutgoingCallingPlanPinholeDigitPatternGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupOutgoingCallingPlanPinholeDigitPatternModifyRequest(OCIRequest)
Modify a calling plan Pinhole digit string.
The name is a key; it cannot be changed.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| digit_pattern | str | digitPattern Optional |
GroupOutgoingCallingPlanPinholeDigitPlanCallMeNowGetListRequest(OCIRequest)
Request the Call Me Now permissions for Pinhole digit patterns for a group default and its departments.
The response is either a
GroupOutgoingCallingPlanPinholeDigitPlanCallMeNowGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupOutgoingCallingPlanPinholeDigitPlanOriginatingGetListRequest(OCIRequest)
Request the originating permissions for Pinhole digit patterns for a group default and its departments.
The response is either a
GroupOutgoingCallingPlanPinholeDigitPlanOriginatingGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupOutgoingCallingPlanPinholeDigitPlanRedirectingGetListRequest(OCIRequest)
Request the redirecting permissions for Pinhole digit patterns for a group default and its departments.
The response is either a
GroupOutgoingCallingPlanPinholeDigitPlanRedirectingGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupOutgoingCallingPlanRedirectedGetListRequest(OCIRequest)
Request the call forwarded/transferred permissions for a group default and it's departments.
The response is either a GroupOutgoingCallingPlanRedirectedGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupOutgoingCallingPlanRedirectingGetListRequest(OCIRequest)
Request the initiating call forwards/transfer permissions for a group default and it's departments.
The response is either a GroupOutgoingCallingPlanRedirectingGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupOutgoingCallingPlanTransferNumbersGetListRequest(OCIRequest)
Request the list of transfer numbers for a group default and it's departments.
The response is either a GroupOutgoingCallingPlanTransferNumbersGetListResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupPasswordRulesGetRequest(OCIRequest)
Requests the group's password rules setting that is applicable to users within the group.
The response is either GroupPasswordRulesGetResponse() or ErrorResponse().
Replaced by: GroupPasswordRulesGetRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupPasswordRulesGetRequest16(OCIRequest)
Requests the group's password rules setting that is applicable to users within the group.
The response is either GroupPasswordRulesGetResponse16() or ErrorResponse().
Replaced by: GroupPasswordRulesGetRequest22() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupPasswordRulesGetRequest22(OCIRequest)
Requests the group's password rules setting that is applicable to users within the group.
The response is either GroupPasswordRulesGetResponse22() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupPasswordRulesModifyRequest(OCIRequest)
Request to modify the group's password rules setting that apply to the users within the group.
The following elements are only used in AS data mode and ignored in XS data mode: forcePasswordChangeAfterReset reenableLogin lockOutInMinutes
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| disallow_user_id | bool | disallowUserId Optional |
| disallow_old_password | bool | disallowOldPassword Optional |
| disallow_reversed_old_password | bool | disallowReversedOldPassword Optional |
| restrict_min_digits | bool | restrictMinDigits Optional |
| min_digits | int | minDigits Optional |
| restrict_min_upper_case_letters | bool | restrictMinUpperCaseLetters Optional |
| min_upper_case_letters | int | minUpperCaseLetters Optional |
| restrict_min_lower_case_letters | bool | restrictMinLowerCaseLetters Optional |
| min_lower_case_letters | int | minLowerCaseLetters Optional |
| restrict_min_non_alphanumeric_characters | bool | restrictMinNonAlphanumericCharacters Optional |
| min_non_alphanumeric_characters | int | minNonAlphanumericCharacters Optional |
| min_length | int | minLength Optional |
| max_failed_login_attempts | int | maxFailedLoginAttempts Optional |
| password_expires_days | int | passwordExpiresDays Optional |
| send_login_disabled_notify_email | bool | sendLoginDisabledNotifyEmail Optional |
| login_disabled_notify_email_address | str | loginDisabledNotifyEmailAddress Optional |
| disallow_previous_passwords | bool | disallowPreviousPasswords Optional |
| number_of_previous_passwords | int | numberOfPreviousPasswords Optional |
| force_password_change_after_reset | bool | forcePasswordChangeAfterReset Optional |
| use_password_validation_service | bool | usePasswordValidationService Optional |
| reenable_login | bool | reenableLogin Optional |
| lock_out_in_minutes | int | lockOutInMinutes Optional |
GroupPolicyGetRequest(OCIRequest)
Requests the Group's policy settings.
The response is either GroupPolicyGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupPolicyGetRequest14sp1(OCIRequest)
Requests the Group's policy settings.
The response is either GroupPolicyGetResponse14sp1() or ErrorResponse().
Replaced By : GroupPolicyGetRequest14sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupPolicyGetRequest14sp4(OCIRequest)
Requests the Group's policy settings.
The response is either GroupPolicyGetResponse14sp4() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupPolicyGetRequest17(OCIRequest)
Requests the Group's policy settings.
The response is either GroupPolicyGetResponse17() or ErrorResponse(). Replaced by:
GroupPolicyGetRequest20() in AS data mode Replaced by: GroupPolicyGetRequest22()
in XS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupPolicyGetRequest20(OCIRequest)
Requests the Group's policy settings.
The response is either GroupPolicyGetResponse20() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupPolicyGetRequest22(OCIRequest)
Requests the Group's policy settings.
The response is either GroupPolicyGetResponse22() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupPolicyModifyRequest(OCIRequest)
Request to modify the policies for a Group.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: userAutoAttendantNameDialingAccess Replaced
by: GroupPolicyModifyRequest22() in AS and XS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| calling_plan_access | str | callingPlanAccess Optional |
| extension_access | str | extensionAccess Optional |
| ldap_integration_access | str | ldapIntegrationAccess Optional |
| voice_messaging_access | str | voiceMessagingAccess Optional |
| department_admin_user_access | str | departmentAdminUserAccess Optional |
| department_admin_trunk_group_access | str | departmentAdminTrunkGroupAccess Optional |
| department_admin_phone_number_extension_access | str | departmentAdminPhoneNumberExtensionAccess Optional |
| department_admin_calling_line_id_number_access | str | departmentAdminCallingLineIdNumberAccess Optional |
| user_authentication_access | str | userAuthenticationAccess Optional |
| user_group_directory_access | str | userGroupDirectoryAccess Optional |
| user_profile_access | str | userProfileAccess Optional |
| user_enhanced_call_log_access | str | userEnhancedCallLogAccess Optional |
| user_auto_attendant_name_dialing_access | str | userAutoAttendantNameDialingAccess Optional |
GroupPolicyModifyRequest22(OCIRequest)
Request to modify the policies for a Group.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
userAutoAttendantNameDialingAccess
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| calling_plan_access | str | callingPlanAccess Optional |
| extension_access | str | extensionAccess Optional |
| voice_messaging_access | str | voiceMessagingAccess Optional |
| department_admin_user_access | str | departmentAdminUserAccess Optional |
| department_admin_trunk_group_access | str | departmentAdminTrunkGroupAccess Optional |
| department_admin_phone_number_extension_access | str | departmentAdminPhoneNumberExtensionAccess Optional |
| department_admin_calling_line_id_number_access | str | departmentAdminCallingLineIdNumberAccess Optional |
| user_authentication_access | str | userAuthenticationAccess Optional |
| user_group_directory_access | str | userGroupDirectoryAccess Optional |
| user_profile_access | str | userProfileAccess Optional |
| user_enhanced_call_log_access | str | userEnhancedCallLogAccess Optional |
| user_auto_attendant_name_dialing_access | str | userAutoAttendantNameDialingAccess Optional |
GroupPolycomPhoneServicesGetRequest(OCIRequest)
Request the group's Polycom Phone Services attributes.
The response is either a GroupPolycomPhoneServicesGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupPolycomPhoneServicesModifyRequest(OCIRequest)
Modify the group's Polycom Phone Services attributes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| include_group_common_phone_list_in_directory | bool | includeGroupCommonPhoneListInDirectory Optional |
| include_group_custom_contact_directory_in_directory | bool | includeGroupCustomContactDirectoryInDirectory Optional |
| group_custom_contact_directory | str | groupCustomContactDirectory Optional |
GroupPortalPasscodeRulesGetRequest(OCIRequest)
Requests the group's passcode rules setting.
The response is either GroupPortalPasscodeRulesGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupPortalPasscodeRulesGetRequest19(OCIRequest)
Requests the group's passcode rules setting.
The response is either GroupPortalPasscodeRulesGetResponse() or ErrorResponse().
Replaced by: GroupPortalPasscodeRulesGetRequestRI in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupPortalPasscodeRulesModifyRequest(OCIRequest)
Request to modify the group's passcode rules setting.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode: numberOfRepeatedDigits
disallowRepeatedPatterns disallowContiguousSequences numberOfAscendingDigits
numberOfDescendingDigits numberOfPreviousPasscodes reenableLogin lockOutInMinutes
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_rule_level | str | useRuleLevel Optional |
| disallow_repeated_digits | bool | disallowRepeatedDigits Optional |
| number_of_repeated_digits | int | numberOfRepeatedDigits Optional |
| disallow_repeated_patterns | bool | disallowRepeatedPatterns Optional |
| disallow_contiguous_sequences | bool | disallowContiguousSequences Optional |
| number_of_ascending_digits | int | numberOfAscendingDigits Optional |
| number_of_descending_digits | int | numberOfDescendingDigits Optional |
| disallow_user_number | bool | disallowUserNumber Optional |
| disallow_reversed_user_number | bool | disallowReversedUserNumber Optional |
| disallow_old_passcode | bool | disallowOldPasscode Optional |
| number_of_previous_passcodes | int | numberOfPreviousPasscodes Optional |
| disallow_reversed_old_passcode | bool | disallowReversedOldPasscode Optional |
| min_code_length | int | minCodeLength Optional |
| max_code_length | int | maxCodeLength Optional |
| disable_login_after_max_failed_login_attempts | bool | disableLoginAfterMaxFailedLoginAttempts Optional |
| max_failed_login_attempts | int | maxFailedLoginAttempts Optional |
| expire_password | bool | expirePassword Optional |
| passcode_expires_days | int | passcodeExpiresDays Optional |
| send_login_disabled_notify_email | bool | sendLoginDisabledNotifyEmail Optional |
| login_disabled_notify_email_address | str | loginDisabledNotifyEmailAddress Optional |
| reenable_login | bool | reenableLogin Optional |
| lock_out_in_minutes | int | lockOutInMinutes Optional |
GroupPreAlertingAnnouncementGetRequest(OCIRequest)
Get the group PreAlertingservice settings.
The response is either a GroupPreAlertingAnnouncementGetResponse() or an
ErrorResponse(). Replaced by: GroupPreAlertingAnnouncementGetRequest20() in AS
data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupPreAlertingAnnouncementGetRequest20(OCIRequest)
Get the group’s PreAlertingservice settings.
The response is either a GroupPreAlertingAnnouncementGetResponse20() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupPreferredCarrierGroupGetRequest(OCIRequest)
Requests the currently configured carriers for a group.
The response is either a GroupPreferredCarrierGroupGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupRouteListEnterpriseTrunkNumberPrefixAssignListRequest(OCIRequest)
Assign a list of service provider number prefixes to a group.
The number prefixes must have previously been added to the service provider.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| number_prefix | List[str] | numberPrefix Optional |
GroupRouteListEnterpriseTrunkNumberPrefixGetAvailableListRequest(OCIRequest)
Request a list of number prefixess that are assigned to a group and still available for assignment to users within the group.
The response is either
GroupRouteListEnterpriseTrunkNumberPrefixGetAvailableListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupRouteListEnterpriseTrunkNumberPrefixGetSummaryListRequest(OCIRequest)
Get the list of assigned and unassigned enterprise trunknumber prefixes in a group.
The response is either
GroupRouteListEnterpriseTrunkNumberPrefixGetSummaryListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupRouteListEnterpriseTrunkNumberPrefixUnassignListRequest(OCIRequest)
Unassign a list of service provider number prefixes from a group.
The number prefixes then become available for assignment to other groups.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| number_prefix | List[str] | numberPrefix Optional |
GroupRouteListEnterpriseTrunkNumberRangeAssignListRequest(OCIRequest)
Assign a list of service provider number ranges to a group.
The number ranges must have previously been added to the service provider.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| number_range_start | List[str] | numberRangeStart Optional |
GroupRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest(OCIRequest)
Request a list of number ranges that are assigned to a group and still available for assignment to users within the group.
The response is either
GroupRouteListEnterpriseTrunkNumberRangeGetAvailableListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest(OCIRequest)
Get the list of assigned and unassigned enterprise trunknumber ranges in a group.
The response is either
GroupRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupRouteListEnterpriseTrunkNumberRangeUnassignListRequest(OCIRequest)
Unassign a list of service provider number ranges from a group.
The number ranges then become available for assignment to other groups.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| number_range_start | List[str] | numberRangeStart Optional |
GroupRoutePointBouncedCallGetRequest(OCIRequest)
Get a route point's bounced call settings.
The response is either a GroupRoutePointBouncedCallGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointBouncedCallModifyRequest(OCIRequest)
Modify a route point's bounced call settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| is_active | bool | isActive Optional |
| number_of_rings_before_bouncing_call | int | numberOfRingsBeforeBouncingCall Optional |
| enable_transfer | bool | enableTransfer Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| bounce_call_when_agent_unavailable | bool | bounceCallWhenAgentUnavailable Optional |
GroupRoutePointDeleteInstanceRequest(OCIRequest)
Delete a Route Point instance from a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointDistinctiveRingingGetRequest(OCIRequest)
Get the distinctive ringing configuration values for route point.
The response is either a GroupRoutePointDistinctiveRingingGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointDistinctiveRingingModifyRequest(OCIRequest)
Modify the distinctive ringing configuration values for route point.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| enable_distinctive_ringing | bool | enableDistinctiveRinging Optional |
| distinctive_ringing_ring_pattern | str | distinctiveRingingRingPattern Optional |
| distinctive_ringing_force_delivery_ring_pattern | str | distinctiveRingingForceDeliveryRingPattern Optional |
GroupRoutePointExternalSystemAssignListRequest(OCIRequest)
Assign a list of route point external systems to a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| route_point_external_system | List[str] | routePointExternalSystem Optional |
GroupRoutePointExternalSystemGetAssignedListRequest(OCIRequest)
Requests the list of all Route Point External Systems assigned to a group.
The response is either GroupRoutePointExternalSystemGetAssignedListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupRoutePointExternalSystemUnassignListRequest(OCIRequest)
Unassign a list of route point external systems from a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| route_point_external_system | List[str] | routePointExternalSystem Optional |
GroupRoutePointForcedForwardingGetRequest(OCIRequest)
Get a route point's forced forwarding settings.
The response is either a GroupRoutePointForcedForwardingGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointForcedForwardingGetRequest20(OCIRequest)
Get a route point's forced forwarding settings.
The response is either a GroupRoutePointForcedForwardingGetResponse20() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointGetAnnouncementRequest(OCIRequest)
Get a route point's announcement settings.
The response is either a GroupRoutePointGetAnnouncementResponse() or an
ErrorResponse(). Replaced by: GroupRoutePointGetAnnouncementRequest19().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointGetAnnouncementRequest19(OCIRequest)
Get a route point's announcement settings.
The response is either a GroupRoutePointGetAnnouncementResponse19() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointGetAnnouncementRequest20(OCIRequest)
Get a route point's announcement settings.
The response is either a GroupRoutePointGetAnnouncementResponse20() or an
ErrorResponse(). Replaced by: GroupRoutePointGetAnnouncementRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointGetAnnouncementRequest22(OCIRequest)
Get a route point's announcement settings.
The response is either a GroupRoutePointGetAnnouncementResponse22() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointGetDNISListRequest(OCIRequest)
Get a list of DNIS that are configured for a Route Point.
The response is either GroupRoutePointGetDNISListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointGetFailoverPolicyRequest(OCIRequest)
Get the route point failover policy.
The response is either a GroupRoutePointGetFailoverPolicyResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointGetInstanceRequest(OCIRequest)
Request to get all the information of a Route Point instance.
The response is either GroupRoutePointGetInstanceResponse() or ErrorResponse().
Replaced by: GroupRoutePointGetInstanceRequest19sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointGetInstanceRequest19sp1(OCIRequest)
Request to get all the information of a Route Point instance.
The response is either GroupRoutePointGetInstanceResponse19sp1() or
ErrorResponse(). Replace by GroupRoutePointGetInstanceRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointGetInstanceRequest22(OCIRequest)
Request to get all the information of a Route Point instance.
The response is either GroupRoutePointGetInstanceResponse19sp1() or
ErrorResponse(). Replaced by GroupRoutePointGetInstanceRequest23().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointGetInstanceRequest23(OCIRequest)
Request to get all the information of a Route Point instance.
The response is either GroupRoutePointGetInstanceResponse19sp1() or
ErrorResponse(). The Following elements are only used in AS data mode and ignored in
XS data mode: - sendCallAdmissionNotification, use value ‘false’ in XS data mode. -
callAdmissionTimerSeconds, use value ‘3’ in XS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointHolidayServiceGetRequest(OCIRequest)
Get a route point's holiday service settings.
The response is either a GroupRoutePointHolidayServiceGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointHolidayServiceGetRequest17sp1(OCIRequest)
Get a route point's holiday service settings.
The response is either a GroupRoutePointHolidayServiceGetResponse17sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointHolidayServiceGetRequest20(OCIRequest)
Get a route point's holiday service settings.
The response is either a GroupRoutePointHolidayServiceGetResponse20() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointManualFailoverRequest(OCIRequest)
Initiate manual failover for the Route Point.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointModifyDNISParametersRequest(OCIRequest)
Modify the setting that are configured for all the DNIS in a Route Point.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| display_dnis_number | bool | displayDNISNumber Optional |
| display_dnis_name | bool | displayDNISName Optional |
GroupRoutePointModifyFailoverPolicyRequest(OCIRequest)
Modify the route point failover policy.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| enable_failover_support | bool | enableFailoverSupport Optional |
| external_system | str | externalSystem Optional |
| failover_phone_number | str | failoverPhoneNumber Optional |
| per_call_enable_failover_support | bool | perCallEnableFailoverSupport Optional |
| per_call_call_failure_timeout_seconds | int | perCallCallFailureTimeoutSeconds Optional |
| per_call_outbound_call_failure_timeout_seconds | int | perCallOutboundCallFailureTimeoutSeconds Optional |
| per_call_failover_phone_number | str | perCallFailoverPhoneNumber Optional |
GroupRoutePointNightServiceGetRequest(OCIRequest)
Get a route point's night service settings.
The response is either a GroupRoutePointNightServiceGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointNightServiceGetRequest17sp1(OCIRequest)
Get a route point's night service settings.
The response is either a GroupRoutePointNightServiceGetResponse17sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointNightServiceGetRequest20(OCIRequest)
Get a route point's night service settings.
The response is either a GroupRoutePointNightServiceGetResponse20() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointOverflowGetRequest(OCIRequest)
Get a route point's overflow settings.
The response is either a GroupRoutePointOverflowGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointOverflowGetRequest20(OCIRequest)
Get a route point's overflow settings.
The response is either a GroupRoutePointOverflowGetResponse20() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointQueueCallDispositionCodeAddRequest(OCIRequest)
Add a Route Point Call Disposition Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| code | str | code |
| is_active | bool | isActive |
| description | str | description Optional |
GroupRoutePointQueueCallDispositionCodeDeleteRequest(OCIRequest)
Delete a Route Point Call Disposition Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| code | str | code |
GroupRoutePointQueueCallDispositionCodeGetListRequest(OCIRequest)
Get the list of Route Point Level and Organization Level Call Disposition Codes.
The response is either GroupRoutePointQueueCallDispositionCodeGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutePointQueueCallDispositionCodeGetRequest(OCIRequest)
Get a Route Point Call Disposition Code.
The response is either GroupRoutePointQueueCallDispositionCodeGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| code | str | code |
GroupRoutePointQueueCallDispositionCodeModifyRequest(OCIRequest)
Modify a Route Point Call Disposition Code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| code | str | code |
| is_active | bool | isActive Optional |
| description | str | description Optional |
GroupRoutePointQueueCallDispositionCodeSettingsGetRequest(OCIRequest)
Request the queue level data associated with Route Point Call Disposition Code Settings.
The response is either an
GroupRoutePointQueueCallDispositionCodeSettingsGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupRoutingProfileGetRequest(OCIRequest)
Request the routing profile for the group.
The response is either a GroupRoutingProfileGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupRoutingProfileModifyRequest(OCIRequest)
Requests to modify the routing profile for a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| routing_profile | str | routingProfile Optional |
GroupScheduleAddRequest(OCIRequest)
Add a group schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| schedule_name | str | scheduleName |
| schedule_type | str | scheduleType |
GroupScheduleGetListRequest(OCIRequest)
Get the list of a group schedules.
The list can be filtered by schedule type.
The response is either a GroupScheduleGetListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| schedule_type | str | scheduleType Optional |
GroupScheduleGetListRequest17sp1(OCIRequest)
Get the list of schedules viewable by a group.
The list can be filtered by schedule type.
The response is either a GroupScheduleGetListResponse17sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| schedule_type | str | scheduleType Optional |
GroupSecurityClassificationCustomizationGetAvailableListRequest(OCIRequest)
Get the available group security classification list.
If it is not customized, it returns the system default list.
The response is either an
GroupSecurityClassificationCustomizationGetAvailableListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupSeriesCompletionAddInstanceRequest(OCIRequest)
Adds a Series Completion group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| user_id | List[str] | userId Optional |
GroupSeriesCompletionDeleteInstanceRequest(OCIRequest)
Deletes a Series Completion group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupSeriesCompletionGetInstanceListRequest(OCIRequest)
Request to get a list of Series Completion instances within a group.
The response is either GroupSeriesCompletionGetInstanceListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupSeriesCompletionGetInstanceRequest(OCIRequest)
Gets a Series Completion group.
The response is either GroupSeriesCompletionGetInstanceResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupServiceAssignListRequest(OCIRequest)
Assign one or more group services to the group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_name | List[str] | serviceName |
GroupServiceGetAuthorizationListRequest(OCIRequest)
Requests the group's service authorization status.
The response is either GroupServiceGetAuthorizationListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupServiceGetAuthorizationRequest(OCIRequest)
Requests the group's service authorization information for a specific service or service pack.
The response is either GroupServiceGetAuthorizationResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| user_service_name | str | userServiceName Optional |
| group_service_name | str | groupServiceName Optional |
| service_pack_name | str | servicePackName Optional |
GroupServiceGetAuthorizedListRequest(OCIRequest)
Requests the list of services and service packs authorized to a group.
The response is either GroupServiceGetAuthorizedListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupServiceInstancePrivacyGetRequest(OCIRequest)
Request the data associated with Privacy for a service instance.
The response is either a GroupServiceInstancePrivacyGetResponse(). Replaced by:
GroupServiceInstancePrivacyGetRequest17sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupServiceInstancePrivacyGetRequest17sp4(OCIRequest)
Request the data associated with Privacy for a service instance.
The response is either a GroupServiceInstancePrivacyGetResponse17sp4() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupServiceInstancePrivacyModifyRequest(OCIRequest)
Modify the data associated with Privacy for a service instance.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| enable_directory_privacy | bool | enableDirectoryPrivacy Optional |
| enable_auto_attendant_extension_dialing_privacy | bool | enableAutoAttendantExtensionDialingPrivacy Optional |
| enable_auto_attendant_name_dialing_privacy | bool | enableAutoAttendantNameDialingPrivacy Optional |
GroupServiceIsAssignedRequest(OCIRequest)
Request to determine if a GroupService is assigned to the group.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_name | str | serviceName |
GroupServicePhoneNumberLookupRequest(OCIRequest)
Lookup if the given number is defined in the specified service in the group.
The response is GroupServicePhoneNumberLookupResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_type | str | serviceType |
| phone_number | str | phoneNumber |
GroupServiceUnassignListRequest(OCIRequest)
Unassign one or more of the group's assigned services.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_name | List[str] | serviceName |
GroupSessionAdmissionControlGetRequest(OCIRequest)
Get the session admission control capacity for the group.
The response is either a GroupSessionAdmissionControlGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupSessionAdmissionControlGroupDeleteListRequest(OCIRequest)
Request to delete one or more session admission control groups for the group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | List[str] | name |
GroupSessionAdmissionControlGroupGetListRequest(OCIRequest)
Request to get the list of session admission control group for the group.
The response is either a GroupSessionAdmissionControlGroupGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupSessionAdmissionControlGroupGetRequest(OCIRequest)
Request to get a session admission control group for the group.
The response is either a GroupSessionAdmissionControlGroupGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupSessionAdmissionControlGroupGetRequest19sp1(OCIRequest)
Request to get a session admission control group for the group.
The response is either a GroupSessionAdmissionControlGroupGetResponse19sp1() or an
ErrorResponse(). Replaced by: GroupSessionAdmissionControlGroupGetRequest21sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupSessionAdmissionControlGroupGetRequest21sp1(OCIRequest)
Request to get a session admission control group for the group.
The response is either a GroupSessionAdmissionControlGroupGetResponse21sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
GroupSessionAdmissionControlModifyRequest(OCIRequest)
Request to modify session admission control capacity for the group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| restrict_aggregate_sessions | bool | restrictAggregateSessions Optional |
| max_sessions | int | maxSessions Optional |
| max_user_originating_sessions | int | maxUserOriginatingSessions Optional |
| max_user_terminating_sessions | int | maxUserTerminatingSessions Optional |
| count_intra_group_sessions | bool | countIntraGroupSessions Optional |
GroupShInterfaceGetUserListRequest(OCIRequest)
Returns a list of all Public User Identities and associated data in a group.
The response is either a GroupShInterfaceGetUserListResponse() or an
ErrorResponse(). Replaced by: GroupShInterfaceGetUserListRequest21sp1() in AS data
mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupShInterfaceGetUserListRequest21sp1(OCIRequest)
Returns a list of all Public User Identities and associated data in a group.
The response is either a GroupShInterfaceGetUserListResponse21sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupSpeedDial100GetRequest(OCIRequest)
Get the speed dial 100 service settings for a group.
The response is either a GroupSpeedDial100GetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupSpeedDial100GetRequest17sp1(OCIRequest)
Get the speed dial 100 service settings for a group.
The response is either a GroupSpeedDial100GetResponse17sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupSpeedDial100ModifyRequest(OCIRequest)
Modify the speed dial 100 prefix setting for a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| prefix | str | prefix Optional |
GroupStirShakenGetRequest(OCIRequest)
Get Group Stir Shaken service settings.
The response is either GroupStirShakenGetResponse() or ErrorResponse(). Replaced
by: GroupStirShakenGetRequest23().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupStirShakenGetRequest23(OCIRequest)
Get Group Stir Shaken service settings.
The response is either GroupStirShakenGetResponse23() or ErrorResponse(). Replaced
by GroupStirShakenGetRequest23V2().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupStirShakenGetRequest23V2(OCIRequest)
Get Group Stir Shaken service settings.
The response is either GroupStirShakenGetResponse23V2() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupStirShakenModifyRequest(OCIRequest)
Modify Group Stir Shaken service settings.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_parent_level_settings | bool | useParentLevelSettings Optional |
| signing_policy | str | signingPolicy Optional |
| tagging_policy | str | taggingPolicy Optional |
| signing_service_url | str | signingServiceURL Optional |
| tag_from_or_pai | str | tagFromOrPAI Optional |
| verstat_tag | str | verstatTag Optional |
| use_os_value_for_orig_id | bool | useOSValueForOrigId Optional |
| orig_uuid | str | origUUID Optional |
| attestation_level | str | attestationLevel Optional |
| enable_verification | bool | enableVerification Optional |
| verification_service_url | str | verificationServiceURL Optional |
| verification_error_handling | str | verificationErrorHandling Optional |
| proxy_verstat_to_cnam_subscribe | bool | proxyVerstatToCNAMSubscribe Optional |
| use_unknown_headers_from_cnam_notify | bool | useUnknownHeadersFromCNAMNotify Optional |
| enable_signing_for_unscreened_trunk_group_originations | bool | enableSigningForUnscreenedTrunkGroupOriginations Optional |
| enable_tagging_for_unscreened_trunk_group_originations | bool | enableTaggingForUnscreenedTrunkGroupOriginations Optional |
| unscreened_trunk_group_origination_attestation_level | str | unscreenedTrunkGroupOriginationAttestationLevel Optional |
| include_tagged_headers_to_access_side | bool | includeTaggedHeadersToAccessSide Optional |
| proxy_identity_header_to_access_side | bool | proxyIdentityHeaderToAccessSide Optional |
| check_directory_numbers_for_attestation | bool | checkDirectoryNumbersForAttestation Optional |
| match_unassigned_numbers_only | bool | matchUnassignedNumbersOnly Optional |
| enable_tagging_for_redirected_calls | bool | enableTaggingForRedirectedCalls Optional |
| prefer_ingress_tagging | bool | preferIngressTagging Optional |
GroupTemplateOnlyDeviceFileGetListRequest(OCIRequest)
Request to get the list of template files used to support a VDM device defined at group level.
The response is either GroupTemplateOnlyDeviceFileGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupThirdPartyEmergencyCallingGetRequest(OCIRequest)
Get the third-party emergency call service settings for the Group.
The response is either a GroupThirdPartyEmergencyCallingGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupThirdPartyEmergencyCallingGetRequest22(OCIRequest)
Get the third-party emergency call service settings for the Group.
The response is either a GroupThirdPartyEmergencyCallingGetResponse22() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupThirdPartyEmergencyCallingModifyRequest(OCIRequest)
Modify the third-party emergency call service settings for the Group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| enable_device_management | bool | enableDeviceManagement Optional |
| enable_routing | bool | enableRouting Optional |
| customer_id | str | customerId Optional |
| secret_key | str | secretKey Optional |
GroupThirdPartyVoiceMailSupportGetRequest(OCIRequest)
Request the group level data associated with Third-Party Voice Mail Support.
The response is either a GroupThirdPartyVoiceMailSupportGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupThirdPartyVoiceMailSupportModifyRequest(OCIRequest)
Modify the Third Party Voice Mail Support settings for a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| is_active | bool | isActive Optional |
| group_server | str | groupServer Optional |
GroupTimeScheduleDeleteRequest(OCIRequest)
Delete a time schedule from a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| time_schedule_name | str | timeScheduleName |
GroupTimeScheduleGetListRequest(OCIRequest)
Request a list of all time schedules in a group.
The response is either a GroupTimeScheduleGetListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupTimeScheduleGetRequest(OCIRequest)
Request to get a group time schedule.
The response is either a GroupTimeScheduleGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| time_schedule_name | str | timeScheduleName |
GroupTrunkGroupDeleteInstanceRequest(OCIRequest)
Delete a Trunk Group Instance from a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
GroupTrunkGroupGetAvailableDetailListRequest(OCIRequest)
Requests the list of available trunk groups within a group.
The response is either GroupTrunkGroupGetAvailableDetailListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupTrunkGroupGetInstanceListRequest14(OCIRequest)
Get a list of Trunk Groups for the group or enterprise.
It is possible to restrict the results to a particular department, or expand the list to the entire enterprise.
The response is either a GroupTrunkGroupGetInstanceListResponse14() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_department_name | str | groupDepartmentName Optional |
| include_enterprise_trunk_groups | bool | includeEnterpriseTrunkGroups Optional |
| only_trunk_groups_with_device | bool | onlyTrunkGroupsWithDevice Optional |
GroupTrunkGroupGetInstanceListRequest14sp4(OCIRequest)
Get a list of Trunk Groups for the group or enterprise.
It is possible to restrict the results to a particular department, or expand the list to the entire enterprise.
The response is either a GroupTrunkGroupGetInstanceListResponse14sp4() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_department_name | str | groupDepartmentName Optional |
| include_enterprise_trunk_groups | bool | includeEnterpriseTrunkGroups Optional |
| only_trunk_groups_with_device | bool | onlyTrunkGroupsWithDevice Optional |
GroupTrunkGroupGetInstanceRequest14(OCIRequest)
Get a Trunk Group Instance's profile.
The response is either a GroupTrunkGroupGetInstanceResponse14() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupTrunkGroupGetInstanceRequest14sp1(OCIRequest)
Get a Trunk Group Instance's profile.
The response is either a GroupTrunkGroupGetInstanceResponse14sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupTrunkGroupGetRequest(OCIRequest)
Get the maximum permissible active trunk group calls for the group.
The response is either a GroupTrunkGroupGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupTrunkGroupGetRequest14sp1(OCIRequest)
Get the maximum and bursting maximum permissible active trunk group calls for the group.
The response is either a GroupTrunkGroupGetResponse14sp1() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupTrunkGroupGetRequest14sp9(OCIRequest)
Get the maximum and bursting maximum permissible active trunk group calls for the group.
The response is either a GroupTrunkGroupGetResponse14sp9() or an ErrorResponse().
Deprecated by GroupTrunkGroupGetRequest23()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupTrunkGroupGetRequest23(OCIRequest)
Get the maximum and bursting maximum permissible active trunk group calls for the group.
The response is either a GroupTrunkGroupGetResponse23() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupTrunkGroupUserCreationTaskAddRequest(OCIRequest)
Add a user creation task for a trunk group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| task_name | str | taskName |
| user_id_format | str | userIdFormat |
| user_id_domain | str | userIdDomain |
| populate_extension | bool | populateExtension |
| line_port_format | str | linePortFormat |
| line_port_domain | str | linePortDomain |
| populate_contact | bool | populateContact |
| contact_format | str | contactFormat Optional |
| contact_domain | str | contactDomain Optional |
| user_phone_numbers | OCI.userPhoneNumbers | userPhoneNumbers Optional |
| user_extensions | OCI.userExtensions | userExtensions Optional |
| service_pack_name | List[str] | servicePackName Optional |
| user_service | List[str] | userService Optional |
GroupTrunkGroupUserCreationTaskDeleteRequest(OCIRequest)
Delete a user creation task for a trunk group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| task_name | str | taskName |
GroupTrunkGroupUserCreationTaskGetListRequest(OCIRequest)
Get the list of user creation tasks for a trunk group.
The response is either GroupTrunkGroupUserCreationTaskGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupTrunkGroupUserCreationTaskGetRequest(OCIRequest)
Request the details of a specified user creation task for a trunk group.
The response is either GroupTrunkGroupUserCreationTaskGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| task_name | str | taskName |
GroupUserLanguageModifyRequest(OCIRequest)
Request to modify language of the users within a group.
If neither applyToUsers nor applyToServiceInstances is specified in the request, language is not changed for any user in the group. If applyToUsers is specified, regular users within the group have the language modified. If applyToServiceInstances is specified, the service instance users within the group have the language modified.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| language | str | language |
| apply_to_users | bool | applyToUsers Optional |
| apply_to_service_instances | bool | applyToServiceInstances Optional |
GroupVirtualOnNetEnterpriseExtensionsDeleteUserRequest(OCIRequest)
Delete an existing Virtual On-Net user from a Group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| phone_number | str | phoneNumber |
GroupVirtualOnNetEnterpriseExtensionsGetUserRequest(OCIRequest)
Get an existing Virtual On-Net user from a Group.
The response is either a GroupVirtualOnNetEnterpriseExtensionsGetUserResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| phone_number | str | phoneNumber |
GroupVirtualOnNetEnterpriseExtensionsModifyUserRequest(OCIRequest)
Modify an existing Virtual On-Net user of a Group.
The serviceProviderId, groupId and phoneNumber combination uniquely identifies a Virtual On-Net User.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| phone_number | str | phoneNumber |
| extension | str | extension Optional |
| first_name | str | firstName Optional |
| last_name | str | lastName Optional |
| calling_line_id_first_name | str | callingLineIdFirstName Optional |
| calling_line_id_last_name | str | callingLineIdLastName Optional |
| virtual_on_net_call_type_name | str | virtualOnNetCallTypeName Optional |
GroupVisualDeviceManagementGetDeviceInfoRequest(OCIRequest)
Get the information for a specified device supporting visual device management.
The response is either a GroupVisualDeviceManagementGetDeviceInfoResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
GroupVoiceMessagingGroupGetPasscodeRulesRequest(OCIRequest)
Requests the group's voice portal passcode rules setting.
The response is either GroupVoiceMessagingGroupGetPasscodeRulesResponse() or
ErrorResponse().
Replaced By: GroupPortalPasscodeRulesGetRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupVoiceMessagingGroupGetRequest(OCIRequest)
Requests the group's Voice Messaging settings.
The response is either GroupVoiceMessagingGroupGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupVoiceMessagingGroupGetVoicePortalBrandingRequest(OCIRequest)
Get the group's voice portal branding settings.
The response is either a GroupVoiceMessagingGroupGetVoicePortalBrandingResponse() or
an ErrorResponse().
Replaced By: GroupVoiceMessagingGroupGetVoicePortalBrandingRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupVoiceMessagingGroupGetVoicePortalBrandingRequest16(OCIRequest)
Get the group's voice portal branding settings.
The response is either a GroupVoiceMessagingGroupGetVoicePortalBrandingResponse16()
or an ErrorResponse(). Replaced by:
GroupVoiceMessagingGroupGetVoicePortalBrandingRequest20() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupVoiceMessagingGroupGetVoicePortalBrandingRequest20(OCIRequest)
Get the group's voice portal branding settings.
The response is either a GroupVoiceMessagingGroupGetVoicePortalBrandingResponse20()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupVoiceMessagingGroupGetVoicePortalRequest14(OCIRequest)
Requests the group's voice messaging settings The response is either
GroupVoiceMessagingGroupGetVoicePortalResponse14() or ErrorResponse().
Replaced by GroupVoiceMessagingGroupGetVoicePortalRequest15()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupVoiceMessagingGroupGetVoicePortalRequest15(OCIRequest)
Request to get the group voice portal information for a voice messaging group.
The response is either GroupVoiceMessagingGroupGetVoicePortalResponse15() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupVoiceMessagingGroupGetVoicePortalRequest17(OCIRequest)
Request to get the group voice portal information for a voice messaging group.
The response is either GroupVoiceMessagingGroupGetVoicePortalResponse17() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupVoiceMessagingGroupGetVoicePortalRequest17sp4(OCIRequest)
Request to get the group voice portal information for a voice messaging group.
The response is either GroupVoiceMessagingGroupGetVoicePortalResponse17sp4() or
ErrorResponse(). Replaced by: GroupVoiceMessagingGroupGetVoicePortalRequest19sp1()
in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupVoiceMessagingGroupGetVoicePortalRequest19sp1(OCIRequest)
Request to get the group voice portal information for a voice messaging group.
The response is either GroupVoiceMessagingGroupGetVoicePortalResponse19sp1() or
ErrorResponse(). Replaced by: GroupVoiceMessagingGroupGetVoicePortalRequest21sp1()
in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupVoiceMessagingGroupGetVoicePortalRequest21sp1(OCIRequest)
Request to get the group voice portal information for a voice messaging group.
The response is either GroupVoiceMessagingGroupGetVoicePortalResponse21sp1() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
GroupVoiceMessagingGroupModifyPasscodeRulesRequest(OCIRequest)
Request to modify the group's voice portal passcode rules setting.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: GroupPortalPasscodeRulesModifyRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_rule_level | str | useRuleLevel Optional |
| disallow_repeated_digits | bool | disallowRepeatedDigits Optional |
| disallow_user_number | bool | disallowUserNumber Optional |
| disallow_reversed_user_number | bool | disallowReversedUserNumber Optional |
| disallow_old_passcode | bool | disallowOldPasscode Optional |
| disallow_reversed_old_passcode | bool | disallowReversedOldPasscode Optional |
| min_code_length | int | minCodeLength Optional |
| max_code_length | int | maxCodeLength Optional |
| disable_login_after_max_failed_login_attempts | bool | disableLoginAfterMaxFailedLoginAttempts Optional |
| max_failed_login_attempts | int | maxFailedLoginAttempts Optional |
| expire_password | bool | expirePassword Optional |
| passcode_expires_days | int | passcodeExpiresDays Optional |
| send_login_disabled_notify_email | bool | sendLoginDisabledNotifyEmail Optional |
| login_disabled_notify_email_address | str | loginDisabledNotifyEmailAddress Optional |
GroupVoiceMessagingGroupModifyRequest(OCIRequest)
Request to modify the group's voice messaging settings.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_mail_server_setting | str | useMailServerSetting Optional |
| warn_caller_before_recording_voice_message | bool | warnCallerBeforeRecordingVoiceMessage Optional |
| allow_users_configuring_advanced_settings | bool | allowUsersConfiguringAdvancedSettings Optional |
| allow_compose_or_forward_message_to_entire_group | bool | allowComposeOrForwardMessageToEntireGroup Optional |
| mail_server_net_address | str | mailServerNetAddress Optional |
| mail_server_protocol | str | mailServerProtocol Optional |
| real_delete_for_imap | bool | realDeleteForImap Optional |
| max_mailbox_length_minutes | int | maxMailboxLengthMinutes Optional |
| does_message_age | bool | doesMessageAge Optional |
| hold_period_days | int | holdPeriodDays Optional |
GroupVoiceXmlDeleteInstanceRequest(OCIRequest)
Delete a VoiceXML instance from a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupVoiceXmlGetInstanceListRequest(OCIRequest)
Get a list of VoiceXML instances within a group.
The response is either GroupVoiceXmlGetInstanceListResponse() or ErrorResponse().
It is possible to get the instances within a specified department.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_department_name | str | groupDepartmentName Optional |
GroupVoiceXmlGetInstanceRequest(OCIRequest)
Request to get all the information of a VoiceXML instance.
The response is either GroupVoiceXmlGetInstanceResponse() or ErrorResponse().
Replaced by: GroupVoiceXmlGetInstanceRequest19sp1() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupVoiceXmlGetInstanceRequest19sp1(OCIRequest)
Request to get all the information of a VoiceXML instance.
The response is either GroupVoiceXmlGetInstanceResponse19sp1() or ErrorResponse().
Replaced by: GroupVoiceXmlGetInstanceRequest22() in AS mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupVoiceXmlGetInstanceRequest22(OCIRequest)
Request to get all the information of a VoiceXML instance.
The response is either GroupVoiceXmlGetInstanceResponse22() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupVoiceXmlGetInstanceRequest23(OCIRequest)
Request to get all the information of a VoiceXML instance.
The response is either GroupVoiceXmlGetInstanceResponse23() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
GroupXsiPolicyProfileGetAssignedListRequest(OCIRequest)
Get a list of Xsi policy profile assigned.
The response is either a GroupXsiPolicyProfileGetAssignedListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| level | str | level Optional |
GroupXsiPolicyProfileModifyDefaultRequest(OCIRequest)
Modifies the default Xsi policy profile for a group.
It can only modify the user level default Xsi policy profile.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| user_default_xsi_policy_profile | str | userDefaultXsiPolicyProfile Optional |
LoginRequest13mp10(OCIRequest)
LoginRequest13mp10() is 2nd stage of the 2 stage OCI login process.
The signedPassword is not required for external authentication login from a trusted host (ACL).
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| signed_password | str | signedPassword Optional |
LoginRequest14sp4(OCIRequest)
LoginRequest14sp4() is 2nd stage of the 2 stage OCI login process.
The signedPassword is not required for external authentication login from a trusted host (ACL).
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| signed_password | str | signedPassword Optional |
| plain_text_password | str | plainTextPassword Optional |
LoginRequest21sp1(OCIRequest)
LoginRequest21sp1() is 2nd stage of the 2 stage OCI login process.
The signedPassword is not required for external authentication login from a trusted
host (ACL). Replaced by LoginRequest22V3() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| signed_password | str | signedPassword Optional |
| plain_text_password | str | plainTextPassword Optional |
LoginRequest22(OCIRequest)
Request to login to OCI.
password is not required for external authentication login from a trusted host (ACL).
Replaced by LoginRequest22V2() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| password | str | password Optional |
LoginRequest22V2(OCIRequest)
Request to login to OCI.
password is not required for external authentication login from a trusted host (ACL).
Replaced by LoginRequest22V3() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| password | str | password Optional |
LoginRequest22V3(OCIRequest)
Request to login to OCI.
password is not required for external authentication login from a trusted host (ACL).
Replaced by LoginRequest22V4() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| password | str | password Optional |
LoginRequest22V4(OCIRequest)
Request to login to OCI.
password is not required for external authentication login from a trusted host (ACL).
The following data element is only used in XS data mode and will be ignored in AS data
mode: signedPassword, ignored in AS data mode unless the password element is not
present then an error is returned. Replaced by: LoginRequest22V5().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| password | str | password Optional |
| signed_password | str | signedPassword Optional |
LoginRequest22V5(OCIRequest)
Request to login to OCI.
password is not required for external authentication login from a trusted host (ACL). The following data element is only used in XS data mode and will be ignored in AS data mode: signedPassword, ignored in AS data mode unless the password element is not present then an error is returned.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| password | str | password Optional |
| signed_password | str | signedPassword Optional |
LogoutRequest(OCIRequest)
LogoutRequest() is sent when an OCI user logs out or when connection is lost.
This command can be sent either to the server, or to the client from OCS. Response is
either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| reason | str | reason Optional |
LongLivedTokenRevokeRequest(OCIRequest)
Revoke all previously issued long lived tokens.
If the userId is not specified, revoke all tokens in the system. If the userId is specified, revoke all tokens issued to the user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId Optional |
PasswordModifyRequest(OCIRequest)
Modify the password for a user/administrator.
When oldPassword is specified, password rule applies. If oldPassword in not specified, any password rule related to old password does not apply.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| old_password | str | oldPassword Optional |
| new_password | str | newPassword |
PlaceModifyRequest(OCIRequest)
Request to configure a WebEx room/place to have the primary endpoint of WebEx Teams device.
placeUserId refers to a WebEx room/place. webExSIPAddress specifies the WebEx SIP address of the place. The format of this parameter is: user@domain. The user part specified in webExSIPAddress will be set to the lineport of the place’s primary endpoint. The endpoint will have a static address with URI set to "sip:user@domain". The domain specified in webExSIPAddress will be: - added to the system if it does not exist yet. - assigned to the service provider/enterprise which the place belongs to, if it has not been assigned yet. - assigned to the group which the place belongs to, if it has not been assigned yet.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| place_user_id | str | placeUserId |
| web_ex_sip_address | str | webExSIPAddress Optional |
PublicClusterGetFullyQualifiedDomainNameRequest(OCIRequest)
Get the public cluster fully qualified domain name (FQDN).
The response is either a PublicClusterGetFullyQualifiedDomainNameResponse() or an
ErrorResponse().
ResellerAddRequest(OCIRequest)
Add a reseller.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| reseller_name | str | resellerName Optional |
| reseller_external_id | str | resellerExternalId Optional |
ResellerAdminAddRequest(OCIRequest)
Add a reseller administrator.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| user_id | str | userId |
| first_name | str | firstName Optional |
| last_name | str | lastName Optional |
| password | str | password Optional |
| language | str | language Optional |
ResellerAdminAlternateIdAddRequest(OCIRequest)
Request to add an alternate Id to a reseller admin.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| alternate_user_id | str | alternateUserId |
| description | str | description Optional |
ResellerAdminAlternateIdDeleteRequest(OCIRequest)
Request to delete an alternate admin user id of a reseller admin.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| alternate_user_id | str | alternateUserId |
ResellerAdminAlternateIdGetListRequest(OCIRequest)
Request to get the admin id and the list of alternate admin ids of an admin.
The response is either ResellerAdminAlternateIdGetListResponse() or
ErrorResponse(). The "userId" can be either the admin user Id or an alternate admin
user Id.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ResellerAdminAlternateIdModifyRequest(OCIRequest)
Request to modify an alternate id of a reseller admin.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| alternate_user_id | str | alternateUserId |
| new_alternate_user_id | str | newAlternateUserId Optional |
| description | str | description Optional |
ResellerAdminDeleteRequest(OCIRequest)
Delete a reseller administrator.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ResellerAdminGetListRequest(OCIRequest)
Get a list of reseller administrators.
The response is either a ResellerAdminGetListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerAdminGetRequest(OCIRequest)
Get a reseller administrators profile.
The response is either a ResellerAdminGetResponse() or an ErrorResponse().
Replaced by ResellerAdminGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ResellerAdminGetRequest22(OCIRequest)
Get a reseller administrators profile.
The response is either a ResellerAdminGetResponse22() or an ErrorResponse().
Replaced by: ResellerAdminGetRequest22V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ResellerAdminGetRequest22V2(OCIRequest)
Get a reseller administrators profile.
The response is either a ResellerAdminGetResponse22V2() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ResellerAdminModifyRequest(OCIRequest)
Modify the profile for a reseller administrator.
Since old password is not specified here, any password rule related to old password does not apply.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| first_name | str | firstName Optional |
| last_name | str | lastName Optional |
| password | str | password Optional |
| language | str | language Optional |
| account_disabled | bool | accountDisabled Optional |
ResellerCallAdmissionControlPoliciesGetRequest(OCIRequest)
Get a reseller call admission control policies.
The response is either a ResellerCallAdmissionControlPoliciesGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerCallAdmissionControlPoliciesModifyRequest(OCIRequest)
Modify the reseller call admission control policies.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| enable_call_admission_control | bool | enableCallAdmissionControl Optional |
| max_concurrent_network_sessions | int | maxConcurrentNetworkSessions Optional |
| max_concurrent_network_sessions_threshold | int | maxConcurrentNetworkSessionsThreshold Optional |
| max_network_calls_per_second | int | maxNetworkCallsPerSecond Optional |
| max_network_calls_per_second_threshold | int | maxNetworkCallsPerSecondThreshold Optional |
| max_concurrent_external_siprec_sessions | int | maxConcurrentExternalSIPRECSessions Optional |
| max_concurrent_external_siprec_sessions_threshold | int | maxConcurrentExternalSIPRECSessionsThreshold Optional |
ResellerCallCenterGetRequest(OCIRequest)
Request the reseller level data associated with Call Center.
The response is either a ResellerCallCenterGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerCallCenterModifyRequest(OCIRequest)
Modify the reseller level data associated with Call Center.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| default_from_address | str | defaultFromAddress Optional |
ResellerCallNotifyGetRequest(OCIRequest)
Request the reseller level data associated with Call Notify.
The response is either a ResellerCallNotifyGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerCallNotifyModifyRequest(OCIRequest)
Modify the reseller level data associated with Call Notify.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| default_from_address | str | defaultFromAddress Optional |
ResellerCallPoliciesGetRequest(OCIRequest)
Request the reseller level data associated with Call Policies.
The response is either a ResellerCallPoliciesGetResponse() or an ErrorResponse().
Replaced by: ResellerCallPoliciesGetRequest22() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerCallPoliciesGetRequest22(OCIRequest)
Request the reseller level data associated with Call Policies.
The response is either a ResellerCallPoliciesGetResponse22() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerCallPoliciesModifyRequest(OCIRequest)
Modify the reseller level data associated with Call Policies.
The following elements are only used in AS data mode: forceRedirectingUserIdentityForRedirectedCalls applyRedirectingUserIdentityToNetworkLocations
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| force_redirecting_user_identity_for_redirected_calls | bool | forceRedirectingUserIdentityForRedirectedCalls Optional |
| apply_redirecting_user_identity_to_network_locations | bool | applyRedirectingUserIdentityToNetworkLocations Optional |
ResellerCallRecordingGetRequest(OCIRequest)
Get the Call Recording attribute for a reseller.
The response is either a ResellerCallRecordingGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerCallRecordingModifyRequest(OCIRequest)
Modify the Call Recording attribute for a reseller.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| fqdn | str | FQDN Optional |
ResellerCollaborateGetRequest(OCIRequest)
Request the reseller level data associated with Collaborate.
The response is either a ResellerCollaborateGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerCollaborateModifyRequest(OCIRequest)
Modify the reseller level data associated with Collaborate.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| collaborate_from_address | str | collaborateFromAddress Optional |
ResellerDeleteRequest(OCIRequest)
Delete a reseller.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId Optional |
| reseller_external_id | str | resellerExternalId Optional |
ResellerDeviceActivationPolicyGetRequest(OCIRequest)
Request the Device Activation policy of a reseller.
The response is either a ResellerDeviceActivationPolicyGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerDeviceActivationPolicyModifyRequest(OCIRequest)
Modify the Device Activation policy of a reseller.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| use_reseller_settings | bool | useResellerSettings Optional |
| allow_activation_code_request_by_user | bool | allowActivationCodeRequestByUser Optional |
| send_activation_code_in_email | bool | sendActivationCodeInEmail Optional |
ResellerEmergencyCallNotificationGetRequest(OCIRequest)
Request the reseller level data associated with Emergency Call Notification.
The response is either a ResellerEmergencyCallNotificationGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerEmergencyCallNotificationModifyRequest(OCIRequest)
Modify the reseller level data associated with Emergency Call Notification.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| default_from_address | str | defaultFromAddress Optional |
ResellerEmergencyZonesGetRequest(OCIRequest)
Request the reseller level data associated with Emergency Zones.
The response is either a ResellerEmergencyZonesGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerEmergencyZonesModifyRequest(OCIRequest)
Modify the reseller level data associated with Emergency Zones.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| default_from_address | str | defaultFromAddress Optional |
ResellerGetRequest(OCIRequest)
Get the profile for a reseller.
The response is either ResellerGetResponse() or ErrorResponse(). Replaced by:
ResellerGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerGetRequest22(OCIRequest)
Get the profile for a reseller.
The response is either ResellerGetResponse22() or ErrorResponse(). Replaced by:
ResellerGetRequest22V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerGetRequest22V2(OCIRequest)
Get the profile for a reseller.
The response is either ResellerGetResponse22V2() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId Optional |
| reseller_external_id | str | resellerExternalId Optional |
ResellerIntegratedIMPGetRequest(OCIRequest)
Get the Integrated IMP service attributes for the reseller.
The response is either ResellerIntegratedIMPGetResponse() or ErrorResponse().
Replaced by: ResellerIntegratedIMPGetRequest22() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerIntegratedIMPGetRequest22(OCIRequest)
Get the Integrated IMP service attributes for the reseller.
The response is either ResellerIntegratedIMPGetResponse22() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerIntegratedIMPModifyRequest(OCIRequest)
Modify the Integrated IMP service attributes for the reseller.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| use_system_service_domain | bool | useSystemServiceDomain Optional |
| service_domain | str | serviceDomain Optional |
| service_port | int | servicePort Optional |
| use_system_messaging_server | bool | useSystemMessagingServer Optional |
| provisioning_url | str | provisioningUrl Optional |
| provisioning_user_id | str | provisioningUserId Optional |
| provisioning_password | str | provisioningPassword Optional |
| bosh_url | str | boshURL Optional |
| default_imp_id_type | str | defaultImpIdType Optional |
ResellerMailParametersGetRequest(OCIRequest)
Request the reseller Mail parameters.
The response is either a ResellerMailParametersGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerMailParametersModifyRequest(OCIRequest)
Request to modify the reseller Mail parameters.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| default_from_address | str | defaultFromAddress Optional |
ResellerMeetMeConferencingGetRequest(OCIRequest)
Request the reseller level data associated with Meet-Me Conferencing functions.
The response is either a ResellerMeetMeConferencingGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerMeetMeConferencingGetRequest22(OCIRequest)
Request the reseller level data associated with Meet-Me Conferencing functions.
The response is either a ResellerMeetMeConferencingGetResponse22() or an
ErrorResponse(). The following data elements are only returned for System and
Provisioning Administrators: maxAllocatedPorts. The following data elements are only
returned for System and Provisioning Administrators and AS Mode Only:
disableUnlimitedMeetMePorts, enableMaxAllocatedPorts.
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerMeetMeConferencingModifyRequest(OCIRequest)
Modify the reseller level data associated with Meet-Me Conferencing functions.
The response is either a SuccessResponse() or an ErrorResponse(). The following
data elements are only modified for System and Provisioning Administrators:
maxAllocatedPorts. The following data elements are only modified for System and
Provisioning Administrators and AS Mode only: disableUnlimitedMeetMePorts,
enableMaxAllocatedPorts.
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| conference_from_address | str | conferenceFromAddress Optional |
| max_allocated_ports | int | maxAllocatedPorts Optional |
| disable_unlimited_meet_me_ports | bool | disableUnlimitedMeetMePorts Optional |
| enable_max_allocated_ports | bool | enableMaxAllocatedPorts Optional |
ResellerModifyRequest(OCIRequest)
Modify the reseller profile.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId Optional |
| reseller_external_id | str | resellerExternalId Optional |
| reseller_name | str | resellerName Optional |
ResellerNetworkClassOfServiceGetAssignedListRequest(OCIRequest)
Get a list of Network Classes of Service assigned to a reseller.
The response is either a ResellerNetworkClassOfServiceGetAssignedListResponse() or
an ErorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerNetworkClassOfServiceModifyDefaultRequest(OCIRequest)
Modifies the default Network Classes of Service of a reseller.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| network_class_of_service | str | networkClassOfService Optional |
ResellerResourcePriorityGetRequest(OCIRequest)
Get the Resource Priority service attributes for the reseller.
The response is either ResellerResourcePriorityGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerResourcePriorityModifyRequest(OCIRequest)
Modify the Resource Priority service attributes for the reseller.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| use_system_settings | bool | useSystemSettings Optional |
| send_resource_priority_to_network | bool | sendResourcePriorityToNetwork Optional |
| resource_priority | str | resourcePriority Optional |
ResellerServiceAuthorizationGetRequest(OCIRequest)
Get the reseller service authorization The response is either
ResellerServiceAuthorizationGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerStirShakenGetRequest(OCIRequest)
Get Reseller Stir Shaken service settings.
The response is either ResellerStirShakenGetResponse() or ErrorResponse().
Replaced by ResellerStirShakenGetRequest23()
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerStirShakenGetRequest23(OCIRequest)
Get Reseller Stir Shaken service settings.
The response is either ResellerStirShakenGetResponse23() or ErrorResponse().
Replaced by ResellerStirShakenGetRequest23V2().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerStirShakenGetRequest23V2(OCIRequest)
Get Reseller Stir Shaken service settings.
The response is either ResellerStirShakenGetResponse23V2() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerStirShakenModifyRequest(OCIRequest)
Modify reseller Stir Shaken service settings.
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| use_parent_level_settings | bool | useParentLevelSettings Optional |
| signing_policy | str | signingPolicy Optional |
| tagging_policy | str | taggingPolicy Optional |
| sign_emergency_calls | bool | signEmergencyCalls Optional |
| tag_emergency_calls | bool | tagEmergencyCalls Optional |
| signing_service_url | str | signingServiceURL Optional |
| tag_from_or_pai | str | tagFromOrPAI Optional |
| verstat_tag | str | verstatTag Optional |
| use_os_value_for_orig_id | bool | useOSValueForOrigId Optional |
| orig_uuid | str | origUUID Optional |
| attestation_level | str | attestationLevel Optional |
| enable_verification | bool | enableVerification Optional |
| verification_service_url | str | verificationServiceURL Optional |
| verification_error_handling | str | verificationErrorHandling Optional |
| proxy_verstat_to_cnam_subscribe | bool | proxyVerstatToCNAMSubscribe Optional |
| use_unknown_headers_from_cnam_notify | bool | useUnknownHeadersFromCNAMNotify Optional |
| enable_signing_for_unscreened_trunk_group_originations | bool | enableSigningForUnscreenedTrunkGroupOriginations Optional |
| enable_tagging_for_unscreened_trunk_group_originations | bool | enableTaggingForUnscreenedTrunkGroupOriginations Optional |
| unscreened_trunk_group_origination_attestation_level | str | unscreenedTrunkGroupOriginationAttestationLevel Optional |
| verify_gets_calls | bool | verifyGETSCalls Optional |
| include_tagged_headers_to_access_side | bool | includeTaggedHeadersToAccessSide Optional |
| proxy_identity_header_to_access_side | bool | proxyIdentityHeaderToAccessSide Optional |
| check_directory_numbers_for_attestation | bool | checkDirectoryNumbersForAttestation Optional |
| match_unassigned_numbers_only | bool | matchUnassignedNumbersOnly Optional |
| enable_tagging_for_redirected_calls | bool | enableTaggingForRedirectedCalls Optional |
| prefer_ingress_tagging | bool | preferIngressTagging Optional |
ResellerVoiceMessagingGroupGetRequest(OCIRequest)
Request the reseller level data associated with Voice Messaging.
The response is either a ResellerVoiceMessagingGroupGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
ResellerVoiceMessagingGroupModifyRequest(OCIRequest)
Modify the reseller level data associated with Voice Messaging.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| delivery_from_address | str | deliveryFromAddress Optional |
| notification_from_address | str | notificationFromAddress Optional |
| voice_portal_lockout_from_address | str | voicePortalLockoutFromAddress Optional |
ResellerXsiPolicyProfileGetAssignedListRequest(OCIRequest)
Get a list of Xsi policy profile assigned.
The response is either a XsiPolicyProfileGetAssignedListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| level | str | level Optional |
ResellerXsiPolicyProfileModifyDefaultRequest(OCIRequest)
Modifies the default Xsi policy profile for a reseller.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| sp_default_xsi_policy_profile | str | spDefaultXsiPolicyProfile Optional |
| group_default_xsi_policy_profile | str | groupDefaultXsiPolicyProfile Optional |
| user_default_xsi_policy_profile | str | userDefaultXsiPolicyProfile Optional |
ServiceProviderAccessDeviceCustomTagAddRequest(OCIRequest)
Request to add a static configuration tag for a service provider access device.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| tag_name | str | tagName |
| tag_value | str | tagValue Optional |
ServiceProviderAccessDeviceCustomTagDeleteListRequest(OCIRequest)
Request to delete static configuration tags for a service provider access device.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| tag_name | List[str] | tagName |
ServiceProviderAccessDeviceCustomTagGetListRequest(OCIRequest)
Request to get the list of custom configuration tags managed by the Device Management System, on a per-device profile basis.
The response is either ServiceProviderAccessDeviceCustomTagGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderAccessDeviceCustomTagModifyRequest(OCIRequest)
Request to modify a static configuration tag for a service provider access device.
The tagValueToEncrypt element can only be used by a system administrator. The following elements are only used in XS data mode and ignored in AS data mode: tagValueToEncrypt
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| tag_name | str | tagName |
| tag_value | str | tagValue Optional |
| tag_value_to_encrypt | str | tagValueToEncrypt Optional |
ServiceProviderAccessDeviceDeleteRequest(OCIRequest)
Request to delete a specified service provider access device.
The following elements are only used in AS data mode and ignored in XS data mode: deviceExternalId
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
ServiceProviderAccessDeviceDeviceActivationGetRequest(OCIRequest)
Requests the activation information for a device configured at the Service Provider level.
Returns a ServiceProviderAccessDeviceDeviceActivationGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderAccessDeviceDeviceActivationModifyRequest(OCIRequest)
Activates or deactivates a device configured at the Service Provider level.
It is only possible for this request to activate a device which is deactivated.
Trying to activate a device in the activating state will result in an error response
since only the DAS is allowed to execute this operation. Returns a
SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| activate_device | bool | activateDevice |
ServiceProviderAccessDeviceFileGetListRequest(OCIRequest)
Request to get the list of device files managed by the Device Management System, on a per-device profile basis.
The response is either ServiceProviderAccessDeviceFileGetListResponse() or
ErrorResponse().
Replaced By: ServiceProviderAccessDeviceFileGetListRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderAccessDeviceFileGetListRequest14sp8(OCIRequest)
Request to get the list of device files managed by the Device Management System, on a per-device profile basis.
The response is either ServiceProviderAccessDeviceFileGetListResponse14sp8() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderAccessDeviceFileGetRequest(OCIRequest)
Request to get a service provider device profile file.
The response is either ServiceProviderAccessDeviceFileGetResponse() or
ErrorResponse().
Replaced By: ServiceProviderAccessDeviceFileGetRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| file_type | str | fileType |
ServiceProviderAccessDeviceFileGetRequest14sp8(OCIRequest)
Request to get a service provider device profile file.
The response is either ServiceProviderAccessDeviceFileGetResponse14sp8() or
ErrorResponse(). Replaced by: ServiceProviderAccessDeviceFileGetRequest16sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| file_format | str | fileFormat |
ServiceProviderAccessDeviceFileGetRequest16sp1(OCIRequest)
Request to get a service provider device profile file.
The response is either ServiceProviderAccessDeviceFileGetResponse16sp1() or
ErrorResponse(). Replaced by: ServiceProviderAccessDeviceFileGetRequest20()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| file_format | str | fileFormat |
ServiceProviderAccessDeviceFileGetRequest20(OCIRequest)
Request to get a service provider device profile file.
The response is either ServiceProviderAccessDeviceFileGetResponse20() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| file_format | str | fileFormat |
ServiceProviderAccessDeviceGenerateActivationCodeRequest(OCIRequest)
Requests a new activation code for a device configured at the Service Provider level.
Returns a SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderAccessDeviceGetAvailableCustomTagListRequest(OCIRequest)
Get the list of all available custom tags managed by the Device Management System, on a per-device profile basis.
The response is either
ServiceProviderAccessDeviceGetAvailableCustomTagListResponse() or ErrorResponse().
The following elements are used in AS mode and ignored in XS data mode: tagSetName
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| tag_set_name | str | tagSetName Optional |
ServiceProviderAccessDeviceGetEnhancedConfigurationTypeListRequest(OCIRequest)
Requests the list of configurable device types of devices that have already been added to the service provider.
The response is either
ServiceProviderAccessDeviceGetEnhancedConfigurationTypeListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderAccessDeviceGetEnhancedConfigurationTypeRequest(OCIRequest)
Requests the details of a specified configurable device type for a service provider.
The response is either
ServiceProviderAccessDeviceGetEnhancedConfigurationTypeResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_type | str | deviceType |
ServiceProviderAccessDeviceGetLinkedLeafDeviceListRequest(OCIRequest)
Requests the list of linked leaf devices for the service provider level tree device passed in the request.
A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device". It can be linked to only one tree device. The list includes devices created at the system, service provider, and group levels.
The response is either ServiceProviderAccessDeviceGetLinkedLeafDeviceListResponse()
or ErrorResponse(). Replaced by:
ServiceProviderAccessDeviceGetLinkedLeafDeviceListRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderAccessDeviceGetLinkedLeafDeviceListRequest22(OCIRequest)
Requests the list of linked leaf devices for the service provider level tree device passed in the request.
A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device. The list includes devices created at the system, service provider, and group levels. If the leafDeviceCategory is not set in the request, then linked leaf devices of all categories are requested, otherwise only the linked leaf devices of the specified category are requested. The category values are: "Handset", "Base Station", "All".
The response is either
ServiceProviderAccessDeviceGetLinkedLeafDeviceListResponse22() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| leaf_device_category | str | leafDeviceCategory Optional |
ServiceProviderAccessDeviceGetLinkedTreeDeviceRequest(OCIRequest)
Requests the tree device linked with the service provider level leaf device passed in the request.
A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device.
The response is either ServiceProviderAccessDeviceGetLinkedTreeDeviceResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderAccessDeviceGetNativeTagsWithLogicListRequest(OCIRequest)
Get the list of all native tags with logic managed by the Device Management System, on a per-device profile basis.
The response is either
ServiceProviderAccessDeviceGetNativeTagsWithLogicListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderAccessDeviceGetRequest14(OCIRequest)
Requests the configuration of a specified service provider access device.
The response is either ServiceProviderAccessDeviceGetResponse14() or
ErrorResponse().
Replaced By: ServiceProviderAccessDeviceGetRequest14sp3()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderAccessDeviceGetRequest14sp3(OCIRequest)
Requests the configuration of a specified service provider access device.
The response is either ServiceProviderAccessDeviceGetResponse14sp3() or
ErrorResponse().
Replaced By: ServiceProviderAccessDeviceGetRequest14sp6()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderAccessDeviceGetRequest14sp6(OCIRequest)
Requests the configuration of a specified service provider access device.
The response is either ServiceProviderAccessDeviceGetResponse14sp6() or
ErrorResponse(). Replaced by: ServiceProviderAccessDeviceGetRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderAccessDeviceGetRequest16(OCIRequest)
Requests the configuration of a specified service provider access device.
The response is either ServiceProviderAccessDeviceGetResponse16() or
ErrorResponse(). Replaced by: ServiceProviderAccessDeviceGetRequest19()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderAccessDeviceGetRequest18sp1(OCIRequest)
Requests the configuration of a specified service provider access device.
The response is either ServiceProviderAccessDeviceGetResponse18sp1() or
ErrorResponse(). Replaced by: ServiceProviderAccessDeviceGetRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderAccessDeviceGetRequest22(OCIRequest)
Requests the configuration of a specified service provider access device.
The response is either ServiceProviderAccessDeviceGetResponse22() or
ErrorResponse(). Replaced by: ServiceProviderAccessDeviceGetRequest24()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderAccessDeviceGetRequest22V2(OCIRequest)
Requests the configuration of a specified service provider access device.
The following elements are only used in AS data mode and ignored in XS data mode: deviceExternalId
The response is either ServiceProviderAccessDeviceGetResponse22V2() or
ErrorResponse().
Replaced By: ServiceProviderAccessDeviceGetRequest24()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
ServiceProviderAccessDeviceGetRequest22V3(OCIRequest)
Requests the configuration of a specified service provider access device.
The response is either ServiceProviderAccessDeviceGetResponse22V3() or
ErrorResponse(). The following elements are only used in AS data mode and ignored in
XS data mode: deviceExternalId Replaced by:
ServiceProviderAccessDeviceGetRequest24()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
ServiceProviderAccessDeviceGetRequest22V4(OCIRequest)
Requests the configuration of a specified service provider access device.
The following elements are only used in AS data mode and ignored in XS data mode: deviceExternalId
The response is either ServiceProviderAccessDeviceGetResponse22V4() or
ErrorResponse().
Replaced By: ServiceProviderAccessDeviceGetRequest24V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
ServiceProviderAccessDeviceGetRequest22V5(OCIRequest)
Requests the configuration of a specified service provider access device.
The following elements are only used in AS data mode and ignored in XS data mode: deviceExternalId
The response is either ServiceProviderAccessDeviceGetResponse22V5() or
ErrorResponse().
Replaced By: ServiceProviderAccessDeviceGetRequest24V3()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
ServiceProviderAccessDeviceGetRequest24(OCIRequest)
Requests the configuration of a specified service provider access device.
The following elements are only used in AS data mode and ignored in XS data mode: deviceExternalId
The response is either ServiceProviderAccessDeviceGetResponse24() or
ErrorResponse(). Replaced by: ServiceProviderAccessDeviceGetRequest24V2() in AS
data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
ServiceProviderAccessDeviceGetRequest24V2(OCIRequest)
Requests the configuration of a specified service provider access device.
The following elements are only used in AS data mode and ignored in XS data mode: deviceExternalId
The response is either ServiceProviderAccessDeviceGetResponse24V2() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
ServiceProviderAccessDeviceGetRequest24V3(OCIRequest)
Requests the configuration of a specified service provider access device.
The following elements are only used in AS data mode and ignored in XS data mode: deviceExternalId
The response is either ServiceProviderAccessDeviceGetResponse24V3() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
ServiceProviderAccessDeviceModifyUserRequest(OCIRequest)
Request to modify attributes for line/ports assigned on the service provider device profile.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in XS data mode and ignored in AS data mode: privateIdentity
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| line_port | str | linePort |
| private_identity | str | privateIdentity Optional |
| is_primary_line_port | bool | isPrimaryLinePort Optional |
ServiceProviderAccessDeviceResetRequest(OCIRequest)
Reset a specific service provider SIP device that supports the reset operation.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderAccessDeviceTagSetGetRequest(OCIRequest)
Request to get the custom configuration tag set defined at the access device.
The response is either ServiceProviderAccessDeviceTagSetGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderAccessDeviceTagSetModifyRequest(OCIRequest)
Request to modify a static configuration tag set.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| tag_set_name | str | tagSetName Optional |
ServiceProviderAdminAddRequest14(OCIRequest)
Add a service provider administrator.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| user_id | str | userId |
| first_name | str | firstName Optional |
| last_name | str | lastName Optional |
| password | str | password Optional |
| language | str | language Optional |
| administrator_type | str | administratorType |
ServiceProviderAdminAlternateIdAddRequest(OCIRequest)
Request to add an alternate admin Id to a service provider administrator.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| alternate_user_id | str | alternateUserId |
| description | str | description Optional |
ServiceProviderAdminAlternateIdDeleteRequest(OCIRequest)
Request to delete an alternate admin user id of a user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| alternate_user_id | str | alternateUserId |
ServiceProviderAdminAlternateIdGetListRequest(OCIRequest)
Request to get the admin id and the list of alternate admin ids of an admin.
The response is either ServiceProviderAdminAlternateIdGetListResponse() or
ErrorResponse(). The "userId" can be either the admin user Id or an alternate admin
user Id.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ServiceProviderAdminAlternateIdModifyRequest(OCIRequest)
Request to modify an alternate id of a service provider admin.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| alternate_user_id | str | alternateUserId |
| new_alternate_user_id | str | newAlternateUserId Optional |
| description | str | description Optional |
ServiceProviderAdminDeleteRequest(OCIRequest)
Delete a service provider administrator.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ServiceProviderAdminGetListRequest14(OCIRequest)
Get a list of service provider administrators.
The response is either a ServiceProviderAdminGetListResponse14() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderAdminGetPolicyRequest14(OCIRequest)
Requests the service provider administrator's policy settings.
The response is either ServiceProviderAdminGetPolicyResponse14() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ServiceProviderAdminGetPolicyRequest16sp1(OCIRequest)
Requests the service provider administrator's policy settings.
The response is either ServiceProviderAdminGetPolicyResponse16sp1() or
ErrorResponse(). Replaced by: ServiceProviderAdminGetPolicyRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ServiceProviderAdminGetPolicyRequest16sp2(OCIRequest)
Requests the service provider administrator's policy settings.
The response is either ServiceProviderAdminGetPolicyResponse16sp2() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ServiceProviderAdminGetPolicyRequest17(OCIRequest)
Requests the service provider administrator's policy settings.
The response is either ServiceProviderAdminGetPolicyResponse17() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ServiceProviderAdminGetPolicyRequest17sp1(OCIRequest)
Requests the service provider administrator's policy settings.
The response is either ServiceProviderAdminGetPolicyResponse17sp1() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ServiceProviderAdminGetPolicyRequest17sp3(OCIRequest)
Requests the service provider administrator's policy settings.
The response is either ServiceProviderAdminGetPolicyResponse17sp3() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ServiceProviderAdminGetPolicyRequest18(OCIRequest)
Requests the service provider administrator's policy settings.
The response is either ServiceProviderAdminGetPolicyResponse18() or
ErrorResponse(). Replaced by: ServiceProviderAdminGetPolicyRequest20() in AS data
mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ServiceProviderAdminGetPolicyRequest20(OCIRequest)
Requests the service provider administrator's policy settings.
The response is either ServiceProviderAdminGetPolicyResponse20() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ServiceProviderAdminGetRequest14(OCIRequest)
Get a service provider administrators profile.
The response is either a ServiceProviderAdminGetResponse14() or an
ErrorResponse(). Replaced by ServiceProviderAdminGetRequest21sp1().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ServiceProviderAdminGetRequest21sp1(OCIRequest)
Get a service provider administrators profile.
The response is either a ServiceProviderAdminGetResponse21sp1() or an
ErrorResponse(). Replaced by: ServiceProviderAdminGetRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ServiceProviderAdminGetRequest22(OCIRequest)
Get a service provider administrators profile.
The response is either a ServiceProviderAdminGetResponse22() or an
ErrorResponse(). Replaced by: ServiceProviderAdminGetRequest22V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ServiceProviderAdminGetRequest22V2(OCIRequest)
Get a service provider administrators profile.
The response is either a ServiceProviderAdminGetResponse22V2() or an
ErrorResponse(). Replaced by: ServiceProviderAdminGetRequest22V3()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ServiceProviderAdminGetRequest22V3(OCIRequest)
Get a service provider administrators profile.
The response is either a ServiceProviderAdminGetResponse22V3() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
ServiceProviderAdminModifyPolicyRequest14(OCIRequest)
Request to modify the service provider administrator's policy settings.
The response is either SuccessResponse() or ErrorResponse(). The
networkPolicyAccess is only modified for the enterprise administrator. The following
elements are only used in AS data mode: dialableCallerIDAccess
verifyTranslationAndroutingAccess
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| profile_access | str | profileAccess Optional |
| group_access | str | groupAccess Optional |
| user_access | str | userAccess Optional |
| admin_access | str | adminAccess Optional |
| department_access | str | departmentAccess Optional |
| access_device_access | str | accessDeviceAccess Optional |
| phone_number_extension_access | str | phoneNumberExtensionAccess Optional |
| calling_line_id_number_access | str | callingLineIdNumberAccess Optional |
| service_access | str | serviceAccess Optional |
| service_pack_access | str | servicePackAccess Optional |
| session_admission_control_access | str | sessionAdmissionControlAccess Optional |
| web_branding_access | str | webBrandingAccess Optional |
| office_zone_access | str | officeZoneAccess Optional |
| communication_barring_access | str | communicationBarringAccess Optional |
| network_policy_access | str | networkPolicyAccess Optional |
| number_activation_access | str | numberActivationAccess Optional |
| dialable_caller_id_access | str | dialableCallerIDAccess Optional |
| verify_translation_and_routing_access | str | verifyTranslationAndRoutingAccess Optional |
ServiceProviderAdminModifyRequest(OCIRequest)
Modify a service provider administrator.
Since old password is not specified here, any password rule related to old password does not apply.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode. accountDisabled
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| first_name | str | firstName Optional |
| last_name | str | lastName Optional |
| password | str | password Optional |
| language | str | language Optional |
| account_disabled | bool | accountDisabled Optional |
ServiceProviderAdministratorPasswordRulesGetRequest(OCIRequest)
Requests the effective password rules setting for a service provider administrator The
response is either ServiceProviderAdministratorPasswordRulesGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderAdviceOfChargeGetRequest(OCIRequest)
Request to get the list of Advice of Charge service provider parameters.
The response is either ServiceProviderAdviceOfChargeGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderAdviceOfChargeModifyRequest(OCIRequest)
Modify the service provider level Advice Of Charge service provider settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| use_sp_level_ao_c_settings | bool | useSPLevelAoCSettings Optional |
| delay_between_notification_seconds | int | delayBetweenNotificationSeconds Optional |
ServiceProviderAnswerConfirmationGetRequest(OCIRequest)
Get a service provider or enterprise's answer confirmation settings.
The response is either a ServiceProviderAnswerConfirmationGetResponse() or an
ErrorResponse().
Replaced By: ServiceProviderAnswerConfirmationGetRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderAnswerConfirmationGetRequest16(OCIRequest)
Get a service provider or enterprise's answer confirmation settings.
The response is either a ServiceProviderAnswerConfirmationGetResponse16() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderApplicationServerSetGetRequest(OCIRequest)
Get the Application Server set for a service provider or enterprise.
The response is either a ServiceProviderApplicationServerSetGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderApplicationServerSetModifyRequest(OCIRequest)
Modify the Application Server set assigned to the service provider or enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| application_server_set_name | str | applicationServerSetName Optional |
ServiceProviderBroadWorksCommunicatorGetRequest(OCIRequest)
Request to get Configuration Server for a specified service provider.
The response is either a ServiceProviderBroadWorksCommunicatorGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderBroadWorksCommunicatorModifyRequest(OCIRequest)
Request to modify the Configuration URL.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| configuration_server_url | str | configurationServerURL Optional |
ServiceProviderBroadWorksMobilityGetRequest(OCIRequest)
Get the service provider BroadWorks Mobility service settings.
The response is either a ServiceProviderBroadWorksMobilityGetResponse() or an
ErrorResponse(). Replaced by: ServiceProviderBroadWorksMobilityGetRequest19sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderBroadWorksMobilityGetRequest19sp1(OCIRequest)
Get the service provider BroadWorks Mobility service settings.
The response is either a ServiceProviderBroadWorksMobilityGetResponse19sp1() or an
ErrorResponse(). Replaced by: ServiceProviderBroadWorksMobilityGetRequest22() in
AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderBroadWorksMobilityGetRequest21sp1(OCIRequest)
Get the service provider BroadWorks Mobility service settings.
The response is either a ServiceProviderBroadWorksMobilityGetResponse21sp1() or an
ErrorResponse(). Replaced by ServiceProviderBroadWorksMobilityGetRequest22V2().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderBroadWorksMobilityGetRequest22(OCIRequest)
Get the service provider BroadWorks Mobility service settings.
The response is either a ServiceProviderBroadWorksMobilityGetResponse22() or an
ErrorResponse(). Replaced by ServiceProviderBroadWorksMobilityGetRequest22V2().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderBroadWorksMobilityGetRequest22V2(OCIRequest)
Get the service provider BroadWorks Mobility service settings.
The response is either a ServiceProviderBroadWorksMobilityGetResponse22V2() or an
ErrorResponse(). Replaced by ServiceProviderBroadWorksMobilityGetRequest22V3().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderBroadWorksMobilityGetRequest22V3(OCIRequest)
Get the service provider BroadWorks Mobility service settings.
The response is either a ServiceProviderBroadWorksMobilityGetResponse22V3() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberAddListRequest(OCIRequest)
Adds Mobile Subscriber Directory Numbers to a service provider.
It is possible to add a single DN, or a list of DNs.
The response is either SuccessResponse() or ErrorResponse(). Replaced by
ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberAddListRequest21().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| mobile_subscriber_directory_number | List[str] | mobileSubscriberDirectoryNumber Optional |
ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberAddListRequest21(OCIRequest)
Adds Mobile Subscriber Directory Numbers to a service provider-mobile network combination.
It is possible to add a single DN, or a list of DNs.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| mobile_network_name | str | mobileNetworkName |
| mobile_subscriber_directory_number | List[str] | mobileSubscriberDirectoryNumber Optional |
ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberDeleteListRequest(OCIRequest)
Deletes Mobile Subscriber Directory Numbers from a service provider.
It is possible to delete either: a single number, or a list of numbers.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| mobile_subscriber_directory_number | List[str] | mobileSubscriberDirectoryNumber Optional |
ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailableListRequest(OCIRequest)
Request a list of available Mobile Subscriber Directory Numbers not yet assigned to any group.
This command is applicable only for service providers and will fail for enterprises.
The response is either
ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailableListResponse()
or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderBroadWorksMobilityModifyRequest(OCIRequest)
Modify the service provider level BroadWorks Mobility service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| use_setting_level | str | useSettingLevel Optional |
| enable_location_services | bool | enableLocationServices Optional |
| enable_msrn_lookup | bool | enableMSRNLookup Optional |
| enable_mobile_state_checking | bool | enableMobileStateChecking Optional |
| deny_call_originations | bool | denyCallOriginations Optional |
| deny_call_terminations | bool | denyCallTerminations Optional |
| enable_announcement_suppression | bool | enableAnnouncementSuppression Optional |
| enable_internal_clid_delivery | bool | enableInternalCLIDDelivery Optional |
| enable_internal_clid_delivery_access_locations | bool | enableInternalCLIDDeliveryAccessLocations Optional |
| enable_enhanced_unreachable_state_checking | bool | enableEnhancedUnreachableStateChecking Optional |
| enable_network_call_barring_status_check | bool | enableNetworkCallBarringStatusCheck Optional |
| network_translation_index | str | networkTranslationIndex Optional |
ServiceProviderCPEConfigRebuildConfigFileRequest(OCIRequest)
Rebuild the service provider default config file for the specified device type.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_type | str | deviceType |
| force | bool | force Optional |
ServiceProviderCPEConfigRebuildDeviceConfigFileRequest(OCIRequest)
Rebuild the config file for a specified device.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| force | bool | force Optional |
ServiceProviderCPEConfigReorderDeviceLinePortsRequest(OCIRequest)
Reorder the lines of a Service Provider device.
You can not add or delete line ports, only re-ordering the list is allowed. The
ordered list of line ports can be obtained with the
ServiceProviderAccessDeviceGetRequest() command.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| ordered_line_port_list | List[str] | orderedLinePortList |
ServiceProviderCPEConfigResetDeviceRequest(OCIRequest)
Reset a specific service provider or enterprise device.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| force | bool | force Optional |
ServiceProviderCPEConfigResetDeviceTypeRequest(OCIRequest)
Reset all the devices of the specified device type in a service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_type | str | deviceType |
ServiceProviderCallProcessingGetPolicyRequest14(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse14() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingGetPolicyRequest14sp1(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse14sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingGetPolicyRequest14sp4(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse14sp4() or an
ErrorResponse().
Replaced By : ServiceProviderCallProcessingGetPolicyRequest15()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingGetPolicyRequest14sp7(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse14sp7() or an
ErrorResponse().
Replaced By: ServiceProviderCallProcessingGetPolicyRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingGetPolicyRequest15(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse15() or an
ErrorResponse().
Replaced By: ServiceProviderCallProcessingGetPolicyRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingGetPolicyRequest15sp2(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse15sp2() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingGetPolicyRequest16(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse16() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingGetPolicyRequest16sp2(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse16sp2() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingGetPolicyRequest17(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse17() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingGetPolicyRequest17sp3(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse17sp3() or an
ErrorResponse(). Replaced by ServiceProviderCallProcessingGetPolicyResponse17sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingGetPolicyRequest17sp4(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse17sp4() or an
ErrorResponse().
Replaced By : ServiceProviderCallProcessingGetPolicyRequest18sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingGetPolicyRequest18sp1(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse18sp1() or an
ErrorResponse(). Replaced by: ServiceProviderCallProcessingGetPolicyRequest19sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingGetPolicyRequest19sp1(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse19sp1() or an
ErrorResponse(). Replaced by: ServiceProviderCallProcessingGetPolicyRequest21sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingGetPolicyRequest21sp1(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse21sp1() or an
ErrorResponse(). Replaced by: ServiceProviderCallProcessingGetPolicyRequest21sp2()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingGetPolicyRequest21sp2(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse21sp2() or an
ErrorResponse(). Replaced by: ServiceProviderCallProcessingGetPolicyRequest22() in
AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingGetPolicyRequest22(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse22() or an
ErrorResponse(). Replaced by: ServiceProviderCallProcessingGetPolicyRequest22V2()
in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingGetPolicyRequest22V2(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse22V2() or an
ErrorResponse(). Replaced by: ServiceProviderCallProcessingGetPolicyRequest22V3()
in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingGetPolicyRequest22V3(OCIRequest)
Request the service provider level data associated with Call Processing Policy.
The response is either a ServiceProviderCallProcessingGetPolicyResponse22V3() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCallProcessingModifyPolicyRequest14(OCIRequest)
Modify the service provider level data associated with Call Processing Policy.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| media_policy_selection | str | mediaPolicySelection Optional |
| supported_media_set_name | str | supportedMediaSetName Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_external_calls_via_private_dialing_plan | bool | overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| use_setting_level | str | useSettingLevel Optional |
| conference_uri | str | conferenceURI Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_max_concurrent_find_me_follow_me_invocations | bool | useMaxConcurrentFindMeFollowMeInvocations Optional |
| max_concurrent_find_me_follow_me_invocations | int | maxConcurrentFindMeFollowMeInvocations Optional |
| clid_policy | str | clidPolicy Optional |
| emergency_clid_policy | str | emergencyClidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
ServiceProviderCallProcessingModifyPolicyRequest15(OCIRequest)
Modify the service provider level data associated with Call Processing Policy.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: useServiceProviderDCLIDSetting
enableDialableCallerID allowConfigurableCLIDForRedirectingIdentity The following
elements are only used in AS data mode and ignored in XS data mode:
enablePhoneListLookup useMaxConcurrentTerminatingAlertingRequests
maxConcurrentTerminatingAlertingRequests
includeRedirectionsInMaximumNumberOfConcurrentCalls
useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable
useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable
allowMobileDNForRedirectingIdentity enableGatewayRoutePolicy
networkCallsGatewayRouteIdentity networkURLCallsGatewayRouteIdentity
emergencyCallsGatewayRouteIdentity repairCallsGatewayRouteIdentity
callTypingErrorsGatewayRouteIdentity The following elements are only used in XS data
mode and ignored in AS data mode: routeOverrideDomain routeOverridePrefix
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| use_service_provider_dclid_setting | bool | useServiceProviderDCLIDSetting Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| media_policy_selection | str | mediaPolicySelection Optional |
| supported_media_set_name | str | supportedMediaSetName Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_enterprise_clid_for_private_call_category | bool | useEnterpriseCLIDForPrivateCallCategory Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| use_setting_level | str | useSettingLevel Optional |
| conference_uri | str | conferenceURI Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_max_concurrent_find_me_follow_me_invocations | bool | useMaxConcurrentFindMeFollowMeInvocations Optional |
| max_concurrent_find_me_follow_me_invocations | int | maxConcurrentFindMeFollowMeInvocations Optional |
| clid_policy | str | clidPolicy Optional |
| emergency_clid_policy | str | emergencyClidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
| enable_dialable_caller_id | bool | enableDialableCallerID Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| group_calls_clid_policy | str | groupCallsCLIDPolicy Optional |
| enable_phone_list_lookup | bool | enablePhoneListLookup Optional |
| use_max_concurrent_terminating_alerting_requests | bool | useMaxConcurrentTerminatingAlertingRequests Optional |
| max_concurrent_terminating_alerting_requests | int | maxConcurrentTerminatingAlertingRequests Optional |
| include_redirections_in_maximum_number_of_concurrent_calls | bool | includeRedirectionsInMaximumNumberOfConcurrentCalls Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
| route_override_domain | str | routeOverrideDomain Optional |
| route_override_prefix | str | routeOverridePrefix Optional |
| allow_mobile_dn_for_redirecting_identity | bool | allowMobileDNForRedirectingIdentity Optional |
| enable_gateway_route_policy | bool | enableGatewayRoutePolicy Optional |
| network_calls_gateway_route_identity | str | networkCallsGatewayRouteIdentity Optional |
| network_url_calls_gateway_route_identity | str | networkURLCallsGatewayRouteIdentity Optional |
| emergency_calls_gateway_route_identity | str | emergencyCallsGatewayRouteIdentity Optional |
| repair_calls_gateway_route_identity | str | repairCallsGatewayRouteIdentity Optional |
| call_typing_errors_gateway_route_identity | str | callTypingErrorsGatewayRouteIdentity Optional |
ServiceProviderCommunicationBarringCriteriaAssignListRequest(OCIRequest)
Assign a list of Communication Barring Criteria to a service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| criteria_name | List[str] | criteriaName Optional |
ServiceProviderCommunicationBarringCriteriaGetAssignedListRequest(OCIRequest)
Get a list of Communication Barring Criteria assigned to a service provider.
The response is either a
ServiceProviderCommunicationBarringCriteriaGetAssignedListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCommunicationBarringCriteriaUnassignListRequest(OCIRequest)
Unassign a list of Communication Barring Criteria from a service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| criteria_name | List[str] | criteriaName Optional |
ServiceProviderCommunicationBarringDigitPatternCriteriaAddRequest(OCIRequest)
Add a new Communication Barring Digit Pattern Criteria.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| description | str | description Optional |
| match_digit_pattern | List[str] | matchDigitPattern Optional |
ServiceProviderCommunicationBarringDigitPatternCriteriaDeleteRequest(OCIRequest)
Delete an existing Communication Barring Digit Pattern Criteria.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
ServiceProviderCommunicationBarringDigitPatternCriteriaGetListRequest(OCIRequest)
Get the list of all Digit Pattern Criteria defined for the service provider.
The response is either a
ServiceProviderCommunicationBarringDigitPatternCriteriaGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCommunicationBarringDigitPatternCriteriaGetRequest(OCIRequest)
Get an existing Digit Pattern Criteria.
The response is either a
ServiceProviderCommunicationBarringDigitPatternCriteriaGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
ServiceProviderCommunicationBarringDigitPatternCriteriaModifyRequest(OCIRequest)
Modify an existing Communication Barring Digit Pattern Criteria.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| add_match_digit_pattern | List[str] | addMatchDigitPattern Optional |
| delete_match_digit_pattern | List[str] | deleteMatchDigitPattern Optional |
ServiceProviderCommunicationBarringIncomingCriteriaAssignListRequest(OCIRequest)
Assign a list of Communication Barring Incoming Criteria to a service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| criteria_name | List[str] | criteriaName |
ServiceProviderCommunicationBarringIncomingCriteriaGetAssignedListRequest(OCIRequest)
Get a list of Communication Barring Incoming Criteria assigned to a service provider.
The response is either a
ServiceProviderCommunicationBarringIncomingCriteriaGetAssignedListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCommunicationBarringIncomingCriteriaUnassignListRequest(OCIRequest)
Unassign a list of Communication Barring Incoming Criteria from a service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| criteria_name | List[str] | criteriaName |
ServiceProviderCommunicationBarringProfileDeleteRequest(OCIRequest)
Deletes an existing Communication Barring Profile.
Optionally, a new default profile can be chosen if the current default profile is being deleted.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| default_profile | str | defaultProfile Optional |
ServiceProviderCommunicationBarringProfileGetCriteriaUsageListRequest(OCIRequest)
Get a list of Communication Barring profiles within a service provider that have a given Communication Barring Criteria assigned.
The response is either a ServiceProviderCommunicationBarring
ProfileGetCriteriaUsageListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| criteria_name | str | criteriaName |
ServiceProviderCommunicationBarringProfileGetDigitPatternCriteriaUsageListRequest(OCIRequest)
Get the list of Profiles that use a specific Digit Pattern Criteria.
The response is either a
ServiceProviderCommunicationBarringProfileGetDigitPatternCriteriaUsageListResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
ServiceProviderCommunicationBarringProfileGetIncomingCriteriaUsageListRequest(OCIRequest)
Get a list of Communication Barring profiles within a service provider that have a given Communication Barring Incoming Criteria assigned.
The response is either a ServiceProviderCommunicationBarring
ProfileGetIncomingCriteriaUsageListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| criteria_name | str | criteriaName |
ServiceProviderCommunicationBarringProfileGetListRequest(OCIRequest)
Get the list of all Communication Barring Profiles.
The response is either a ServiceProviderCommunicationBarringProfileGetListResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderCommunicationBarringProfileGetRequest(OCIRequest)
Get an existing Communication Barring Profile.
The response is either a ServiceProviderCommunicationBarringProfileGetResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
ServiceProviderCommunicationBarringProfileGetRequest17sp3(OCIRequest)
Get an existing Communication Barring Profile.
The response is either a
ServiceProviderCommunicationBarringProfileGetResponse17sp3() or an
ErrorResponse().
Replaced By : ServiceProviderCommunicationBarringProfileGetRequest19sp1V2 in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
ServiceProviderCommunicationBarringProfileGetRequest19sp1(OCIRequest)
Get an existing Communication Barring Profile.
The response is either a
ServiceProviderCommunicationBarringProfileGetResponse19sp1() or an
ErrorResponse().
Replaced By : ServiceProviderCommunicationBarringProfileGetRequest19sp1V2 in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
ServiceProviderCommunicationBarringProfileModifyDefaultRequest(OCIRequest)
Modifies the default Communication Barring Profile of a Service Provider.
If a default has been previously selected, this command will swap the default profile with the profile provided. Selecting a nil profile will cause the service provider to not have a default Communicaton Barring Profile.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
ServiceProviderDeleteRequest(OCIRequest)
Delete a service provider or enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderDeviceActivationPolicyGetRequest(OCIRequest)
Request the Device Activation policy of a service provider or an enterprise.
The response is either a ServiceProviderDeviceActivationPolicyGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderDeviceActivationPolicyModifyRequest(OCIRequest)
Modify the Device Activation policy of a service provider or an enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| use_service_provider_settings | bool | useServiceProviderSettings Optional |
| allow_activation_code_request_by_user | bool | allowActivationCodeRequestByUser Optional |
| send_activation_code_in_email | bool | sendActivationCodeInEmail Optional |
ServiceProviderDeviceManagementGetAccessDeviceCountForDeviceTypeServiceProviderRequest(OCIRequest)
Request the number of access device of a particular device type and service provider.
If countOnlyResetSupportedDevice is true, count only access devices if the device type supports reset. By default unmanaged device types are not allowed and devices are counted only if their device type supports Device Management. An error is returned if deviceType is specified but does not support device management. When allowUnmanagedDeviceType is true, unmanaged device type will be counted and a successful response is returned.
The response is either
ServiceProviderDeviceManagementGetAccessDeviceCountForDeviceTypeServiceProviderResponse()
or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_type | str | deviceType |
| count_only_reset_supported_device | bool | countOnlyResetSupportedDevice Optional |
| allow_unmanaged_device_type | bool | allowUnmanagedDeviceType Optional |
ServiceProviderDeviceManagementInProgressAndPendingEventCancelRequest(OCIRequest)
Cancel pending and in progress events.
A list of individual events can be canceled.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| event_id | List[int] | eventId |
ServiceProviderDeviceProfileAuthenticationPasswordRulesGetRequest(OCIRequest)
Request to get the service provider level device profile authentication password rule settings.
The response is either a
ServiceProviderDeviceProfileAuthenticationPasswordRulesGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderDeviceProfileAuthenticationPasswordRulesModifyRequest(OCIRequest)
Request to modify the service provider level device profile authentication password rule settings.
The useServiceProviderSettings element can only be modified by a system administrator or a provisioning administrator.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| use_service_provider_settings | bool | useServiceProviderSettings Optional |
| disallow_authentication_name | bool | disallowAuthenticationName Optional |
| disallow_old_password | bool | disallowOldPassword Optional |
| disallow_reversed_old_password | bool | disallowReversedOldPassword Optional |
| restrict_min_digits | bool | restrictMinDigits Optional |
| min_digits | int | minDigits Optional |
| restrict_min_upper_case_letters | bool | restrictMinUpperCaseLetters Optional |
| min_upper_case_letters | int | minUpperCaseLetters Optional |
| restrict_min_lower_case_letters | bool | restrictMinLowerCaseLetters Optional |
| min_lower_case_letters | int | minLowerCaseLetters Optional |
| restrict_min_non_alphanumeric_characters | bool | restrictMinNonAlphanumericCharacters Optional |
| min_non_alphanumeric_characters | int | minNonAlphanumericCharacters Optional |
| min_length | int | minLength Optional |
| send_permanent_lockout_notification | bool | sendPermanentLockoutNotification Optional |
| permanent_lockout_notify_email_address | str | permanentLockoutNotifyEmailAddress Optional |
| device_profile_authentication_lockout_type | str | deviceProfileAuthenticationLockoutType Optional |
| device_profile_temporary_lockout_threshold | int | deviceProfileTemporaryLockoutThreshold Optional |
| device_profile_wait_algorithm | str | deviceProfileWaitAlgorithm Optional |
| device_profile_lockout_fixed_minutes | str | deviceProfileLockoutFixedMinutes Optional |
| device_profile_permanent_lockout_threshold | int | deviceProfilePermanentLockoutThreshold Optional |
| use_password_validation_service | bool | usePasswordValidationService Optional |
ServiceProviderDeviceTypeCustomTagAddRequest(OCIRequest)
Request to add a static configuration tag for an access device type used in a service provider.
The following elements are only used in XS data mode: isTagValueEncrypted, use value "false" in AS data mode The following elements are only used in XS data mode and ignored in AS data mode: tagValueToEncrypt The tagValueToEncrypt element can only be used by a system administrator.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_type | str | deviceType |
| tag_name | str | tagName |
| is_tag_value_encrypted | bool | isTagValueEncrypted |
| tag_value | str | tagValue Optional |
| tag_value_to_encrypt | str | tagValueToEncrypt Optional |
ServiceProviderDeviceTypeCustomTagDeleteListRequest(OCIRequest)
Request to delete static configuration tags for an access device type used in a service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_type | str | deviceType |
| tag_name | List[str] | tagName |
ServiceProviderDeviceTypeCustomTagGetListRequest(OCIRequest)
Request to get the list of custom configuration tags managed by the Device Management System, on a per-device type basis for a service provider.
The response is either ServiceProviderDeviceTypeCustomTagGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_type | str | deviceType |
ServiceProviderDeviceTypeCustomTagModifyRequest(OCIRequest)
Request to modify a static configuration tag for an access device type used in a service provider.
The tagValueToEncrypt element can only be used by a system administrator. The following elements are only used in XS data mode and ignored in AS data mode: tagValueToEncrypt
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_type | str | deviceType |
| tag_name | str | tagName |
| tag_value | str | tagValue Optional |
| tag_value_to_encrypt | str | tagValueToEncrypt Optional |
ServiceProviderDeviceTypeFileGetListRequest(OCIRequest)
Request to get the list of device type files managed by the Device Management System, on a per-service provider basis.
The response is either ServiceProviderDeviceTypeFileGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_type | str | deviceType |
ServiceProviderDeviceTypeFileGetRequest(OCIRequest)
Request to get a service provider device type file.
The response is either ServiceProviderDeviceTypeFileGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_type | str | deviceType |
| file_format | str | fileFormat |
ServiceProviderDeviceTypeTagSetGetRequest(OCIRequest)
Request to get the custom configuration tag set defined for the service provider and device type.
The response is either ServiceProviderDeviceTypeTagSetGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_type | str | deviceType |
ServiceProviderDeviceTypeTagSetModifyRequest(OCIRequest)
Request to modify a static configuration tag set.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_type | str | deviceType |
| tag_set_name | str | tagSetName Optional |
ServiceProviderDialPlanPolicyAddAccessCodeRequest(OCIRequest)
Request to add a Service Provider level Dial Plan Access Code and its all attribues.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| access_code | str | accessCode |
| include_code_for_network_translations_and_routing | bool | includeCodeForNetworkTranslationsAndRouting |
| include_code_for_screening_services | bool | includeCodeForScreeningServices |
| enable_secondary_dial_tone | bool | enableSecondaryDialTone |
| description | str | description Optional |
ServiceProviderDialPlanPolicyDeleteAccessCodeRequest(OCIRequest)
Request to delete a Service Provider level Dial Plan Access Code and its all attribues.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| access_code | str | accessCode |
ServiceProviderDialPlanPolicyGetAccessCodeListRequest(OCIRequest)
Request the Service Provider level data associated with Dial Plan Policy.
The response is either a ServiceProviderDialPlanPolicyGetAccessCodeListResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderDialPlanPolicyGetAccessCodeRequest(OCIRequest)
Request access code data associated with Service Provider level Dial Plan Policy access codes.
The response is either a ServiceProviderDialPlanPolicyGetAccessCodeResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| access_code | str | accessCode |
ServiceProviderDialPlanPolicyGetRequest(OCIRequest)
Request the Service Provider level data associated with Dial Plan Policy.
The response is either a ServiceProviderDialPlanPolicyGetResponse() or an
ErrorResponse(). Replaced by: ServiceProviderDialPlanPolicyGetRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderDialPlanPolicyGetRequest17(OCIRequest)
Request the Service Provider level data associated with Dial Plan Policy.
The response is either a ServiceProviderDialPlanPolicyGetResponse17() or an
ErrorResponse(). Replaced by: ServiceProviderDialPlanPolicyGetRequest22() in AS
data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderDialPlanPolicyGetRequest22(OCIRequest)
Request the Service Provider level data associated with Dial Plan Policy.
The response is either a ServiceProviderDialPlanPolicyGetResponse22() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderDialPlanPolicyModifyAccessCodeRequest(OCIRequest)
Request to modify a Service Provider level Dial Plan Access Code and its attribues.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| access_code | str | accessCode |
| include_code_for_network_translations_and_routing | bool | includeCodeForNetworkTranslationsAndRouting Optional |
| include_code_for_screening_services | bool | includeCodeForScreeningServices Optional |
| enable_secondary_dial_tone | bool | enableSecondaryDialTone Optional |
| description | str | description Optional |
ServiceProviderDialPlanPolicyModifyRequest(OCIRequest)
Modify the Service Provider level data associated with Dial Plan Policy.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
overrideResolvedDeviceDigitMap deviceDigitMap
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| requires_access_code_for_public_calls | bool | requiresAccessCodeForPublicCalls Optional |
| allow_e164_public_calls | bool | allowE164PublicCalls Optional |
| prefer_e164_number_format_for_callback_services | bool | preferE164NumberFormatForCallbackServices Optional |
| public_digit_map | str | publicDigitMap Optional |
| private_digit_map | str | privateDigitMap Optional |
| override_resolved_device_digit_map | bool | overrideResolvedDeviceDigitMap Optional |
| device_digit_map | str | deviceDigitMap Optional |
ServiceProviderDialableCallerIDCriteriaAddRequest(OCIRequest)
Add a new Dialable Caller ID Criteria.
Criteria are added at the bottom of the list with the lowest priority.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| description | str | description Optional |
| prefix_digits | str | prefixDigits Optional |
| match_call_type | List[str] | matchCallType Optional |
| match_alternate_call_indicator | List[str] | matchAlternateCallIndicator Optional |
| match_local_category | bool | matchLocalCategory |
| match_national_category | bool | matchNationalCategory |
| match_interlata_category | bool | matchInterlataCategory |
| match_intralata_category | bool | matchIntralataCategory |
| match_international_category | bool | matchInternationalCategory |
| match_private_category | bool | matchPrivateCategory |
| match_emergency_category | bool | matchEmergencyCategory |
| match_other_category | bool | matchOtherCategory |
ServiceProviderDialableCallerIDCriteriaDeleteRequest(OCIRequest)
Delete a Dialable Caller ID Criteria.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
ServiceProviderDialableCallerIDCriteriaGetRequest(OCIRequest)
Get an existing Dialable Caller ID Criteria.
The response is either a ServiceProviderDialableCallerIDCriteriaGetRequest() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
ServiceProviderDialableCallerIDGetRequest(OCIRequest)
Get the service provider?s Dialable Caller ID settings and criteria list.
The response is either a ServiceProviderDialableCallerIDGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderDigitCollectionGetRequest13mp4(OCIRequest)
Request the service provider's digit collection attributes.
The response is either a ServiceProviderDigitCollectionGetResponse13mp4() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderDigitCollectionModifyRequest(OCIRequest)
Modifies the service provider's digit collection attributes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| access_code | str | accessCode Optional |
| public_digit_map | str | publicDigitMap Optional |
| private_digit_map | str | privateDigitMap Optional |
ServiceProviderDnGetAvailableListRequest(OCIRequest)
Request a list of available DNs not yet assigned to any group.
Dns assigned to the IMRN pool are not listed in the response.
The response is either ServiceProviderDnGetAvailableListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderDnGetStatusListRequest(OCIRequest)
Validates DNs given in the request The response is
ServiceProviderDnGetStatusListResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| dn | List[str] | dn |
ServiceProviderDomainAssignListRequest(OCIRequest)
Assign a list of domains to a service provider.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| domain | List[str] | domain |
ServiceProviderDomainGetAssignedListRequest(OCIRequest)
Requests the list of all matching domains assigned to a service provider .
The response is either ServiceProviderDomainGetAssignedListResponse() or
ErrorResponse(). Replaced by ServiceProviderDomainGetAssignedListRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderDomainUnassignListRequest(OCIRequest)
Unassign a list of domains from a service provider.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| domain | List[str] | domain |
ServiceProviderEmergencyCallNotificationGetRequest(OCIRequest)
Request the service provider level data associated with Emergency Call Notification.
The response is either a ServiceProviderEmergencyCallNotificationGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderEmergencyCallNotificationModifyRequest(OCIRequest)
Modify the service provider or enterprise level data associated with Emergency Call Notification.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| send_emergency_call_notification_email | bool | sendEmergencyCallNotificationEmail Optional |
| emergency_call_notify_email_address | str | emergencyCallNotifyEmailAddress Optional |
| allow_group_override | bool | allowGroupOverride Optional |
ServiceProviderEnhancedCallLogsGetRequest(OCIRequest)
Get the service provider's enhanced call log settings.
The response is either a ServiceProviderEnhancedCallLogsGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderEnhancedCallLogsGetRequest17sp4(OCIRequest)
Get the service provider's enhanced call log settings.
The response is either a ServiceProviderEnhancedCallLogsGetResponse17sp4() or an
ErrorResponse(). This command will return an ErrorResponse() if DBS is used as the
call log server.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderEnhancedCallLogsModifyRequest(OCIRequest)
Modify the Service Provider level data associated with Enhanced Call Logs.
Configures the maximum number of logged calls and maximum age of your user's call logs. Log entries are deleted when either of the two limits is reached.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| max_logged_calls | int | maxLoggedCalls Optional |
| call_expiration_days | int | callExpirationDays Optional |
ServiceProviderEnhancedCallLogsSchemaInstanceGetRequest(OCIRequest)
Get the enhanced call log database schema instance associated with this service provider.
The response is either a ServiceProviderEnhancedCallLogsSchemaInstanceGetResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderEnhancedCallLogsSchemaInstanceModifyRequest(OCIRequest)
Modify the Enhanced Call Logs schema instance associated with this Service Provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name Optional |
ServiceProviderExtensionLengthGetRequest(OCIRequest)
Request the service provider's extension length.
The response is either a ServiceProviderExtensionLengthGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderExtensionLengthModifyRequest(OCIRequest)
Modify the service provider's extension length range.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| default_extension_length | int | defaultExtensionLength Optional |
| location_routing_prefix_digit | int | locationRoutingPrefixDigit Optional |
| location_code_length | int | locationCodeLength Optional |
ServiceProviderExternalCustomRingbackGetRequest(OCIRequest)
Request the service provider level data associated with External Custom Ringback.
The response is either a ServiceProviderExternalCustomRingbackGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderExternalCustomRingbackModifyRequest(OCIRequest)
Modify the service provider level data associated with External Custom Ringback.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| prefix_digits | str | prefixDigits Optional |
| server_net_address | str | serverNetAddress Optional |
| server_port | int | serverPort Optional |
| timeout_seconds | int | timeoutSeconds Optional |
ServiceProviderFeatureAccessCodeGetListRequest(OCIRequest)
Get the list of feature access codes for a service provider or enterprise.
The response is either a ServiceProviderFeatureAccessCodeGetListResponse() or an
ErrorResponse().
Replaced By : ServiceProviderFeatureAccessCodeGetListRequest20() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderFeatureAccessCodeGetListRequest20(OCIRequest)
Get the list of feature access codes for a service provider or enterprise.
The response is either a ServiceProviderFeatureAccessCodeGetListResponse20() or an
ErrorResponse(). In release 20 the "Call Recording" FAC name is changed to "Call
Recording - Start". Replaced by: ServiceProviderFeatureAccessCodeGetListRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderFeatureAccessCodeGetListRequest21(OCIRequest)
Get the list of feature access codes for a service provider or enterprise.
The response is either a ServiceProviderFeatureAccessCodeGetListResponse21() or an
ErrorResponse(). In release 20 the "Call Recording" FAC name is changed to "Call
Recording - Start".
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderFileRepositoryDeviceUserAddRequest(OCIRequest)
Add a new service provider file repository user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| file_repository_name | str | fileRepositoryName |
| user_name | str | userName |
| password | str | password |
| allow_put | bool | allowPut |
| allow_delete | bool | allowDelete |
| allow_get | bool | allowGet |
ServiceProviderFileRepositoryDeviceUserDeleteRequest(OCIRequest)
Delete a service provider file repository user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| file_repository_name | str | fileRepositoryName |
| user_name | str | userName |
ServiceProviderFileRepositoryDeviceUserGetListRequest(OCIRequest)
Request the list of service provider users for a file repository in the system.
The response is either a ServiceProviderFileRepositoryDeviceUserGetListResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| file_repository_name | str | fileRepositoryName |
ServiceProviderFileRepositoryDeviceUserModifyRequest(OCIRequest)
Modify a service provider file repository user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| file_repository_name | str | fileRepositoryName |
| user_name | str | userName |
| password | str | password Optional |
| allow_put | bool | allowPut Optional |
| allow_delete | bool | allowDelete Optional |
| allow_get | bool | allowGet Optional |
ServiceProviderGetAvailableLeafDeviceListRequest(OCIRequest)
Requests the list of available leaf devices that can be linked to a tree device within a specific service provider.
A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device". It can be linked to only one tree device. The list returned includes devices created at the system, service provider, and group levels.
The response is either ServiceProviderGetAvailableLeafDeviceListResponse() or
ErrorResponse(). Replaced by:
ServiceProviderGetAvailableLeafDeviceListRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderGetAvailableLeafDeviceListRequest22(OCIRequest)
Requests the list of available leaf devices that can be linked to a tree device within a specific service provider.
A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device. The list returned includes devices created at the system, service provider, and group levels. If the leafDeviceCategory is not set in the request, then linked leaf devices of all categories are requested, otherwise only the linked leaf devices of the specified category are requested. The category values are: "Handset", "Base Station", "All".
The response is either ServiceProviderGetAvailableLeafDeviceListResponse22() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| leaf_device_category | str | leafDeviceCategory Optional |
ServiceProviderGetAvailableTreeDeviceListRequest(OCIRequest)
Requests the list of available tree devices to which a leaf device can be linked to within a specific service provider.
A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. The list returned includes devices created at the system, service provider, and group levels.
The response is either ServiceProviderGetAvailableTreeDeviceListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderGetDefaultRequest(OCIRequest)
Request the default profile for a service provider or enterprise.
The response is either a ServiceProviderGetDefaultResponse() or an
ErrorResponse().
ServiceProviderGetRequest13mp2(OCIRequest)
Get the profile for a service provider or enterprise.
The response is either a ServiceProviderGetResponse13mp2() or an ErrorResponse().
Replaced by: ServiceProviderGetRequest17sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderGetRequest17sp1(OCIRequest)
Get the profile for a service provider or enterprise.
The response is either a ServiceProviderGetResponse17sp1() or an ErrorResponse().
Replaced by: ServiceProviderGetRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderGetRequest22(OCIRequest)
Get the profile for a service provider or enterprise.
The response is either a ServiceProviderGetResponse22() or an ErrorResponse().
Replaced by ServiceProviderGetRequest22V2().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderGetRequest22V2(OCIRequest)
Get the profile for a service provider or enterprise.
The response is either a ServiceProviderGetResponse22V2() or an ErrorResponse().
Replaced by ServiceProviderGetRequest22V3().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderGetRequest22V3(OCIRequest)
Get the profile for a service provider or enterprise.
The response is either a ServiceProviderGetResponse22V3() or an ErrorResponse().
Replaced by: ServiceProviderGetRequest22V4() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderGetRequest22V4(OCIRequest)
Get the profile for a service provider or enterprise.
The response is either a ServiceProviderGetResponse22V4() or an ErrorResponse().
The following elements are only used in AS data mode and ignored in XS data mode:
serviceProviderExtenalId
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| service_provider_external_id | str | serviceProviderExternalId Optional |
ServiceProviderGroupPagingTargetsCapacityGetRequest(OCIRequest)
Request the maximum number of target users per paging group configured for a service provider.
The response is either a ServiceProviderGroupPagingTargetsCapacityGetResponse() or
an ErrorResponse(). Replaced by:
ServiceProviderGroupPagingTargetsCapacityGetRequest22() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderGroupPagingTargetsCapacityGetRequest22(OCIRequest)
Request the maximum number of target users per paging group configured for a service provider.
The response is either a ServiceProviderGroupPagingTargetsCapacityGetResponse22() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderGroupPagingTargetsCapacityModifyRequest(OCIRequest)
Modify the maximum number of target users per paging group configured for a service provider.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
ServiceProviderGroupPagingTargetsCapacityModifyRequest22() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| maximum_target_users | int | maximumTargetUsers Optional |
ServiceProviderGroupPagingTargetsCapacityModifyRequest22(OCIRequest)
Modify the maximum number of target users per paging group configured for a service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| maximum_target_users | int | maximumTargetUsers Optional |
ServiceProviderHPBXAlternateCarrierSelectionGetRequest(OCIRequest)
Request to get the Alternate Carrier Selection parameters.
The response is either a ServiceProviderHPBXAlternateCarrierSelectionGetResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderHPBXAlternateCarrierSelectionModifyRequest(OCIRequest)
Request to modify the Alternate Carrier Selection parameters.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| process_cbc_carrier_selection | bool | processCbcCarrierSelection Optional |
| preselected_local_carrier | str | preselectedLocalCarrier Optional |
| preselected_distant_carrier | str | preselectedDistantCarrier Optional |
ServiceProviderIMRNGetListRequest(OCIRequest)
Returns a list of dns or dn ranges in a service provider IMRN pool.
The response is either ServiceProviderIMRNGetListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderInCallServiceActivationGetRequest(OCIRequest)
Request the service provider's DTMF based in-call service activation trigger attributes.
The response is either a ServiceProviderInCallServiceActivationGetResponse() or an
ErrorResponse(). Replaced by: ServiceProviderInCallServiceActivationGetRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderInCallServiceActivationGetRequest17(OCIRequest)
Request the service provider's DTMF based in-call service activation trigger attributes.
The response is either a ServiceProviderInCallServiceActivationGetResponse17() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderInCallServiceActivationModifyRequest(OCIRequest)
Modifies the service provider's DTMF based in-call service activation trigger attributes.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
ServiceProviderInCallServiceActivationModifyRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| activation_digits | str | activationDigits Optional |
ServiceProviderInCallServiceActivationModifyRequest17(OCIRequest)
Modifies the service provider's DTMF based in-call service activation trigger attributes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| flash_activation_digits | str | flashActivationDigits Optional |
| call_transfer_activation_digits | str | callTransferActivationDigits Optional |
ServiceProviderIntegratedIMPGetRequest(OCIRequest)
Get the Integrated IMP service attributes for the service provider.
The response is either ServiceProviderIntegratedIMPGetResponse() or
ErrorResponse(). Replaced by: ServiceProviderIntegratedIMPGetRequest21() in AS
data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderIntegratedIMPGetRequest21(OCIRequest)
Get the Integrated IMP service attributes for the service provider.
The response is either ServiceProviderIntegratedIMPGetResponse21() or
ErrorResponse(). Replaced by: ServiceProviderIntegratedIMPGetRequest21sp1() in AS
data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderIntegratedIMPGetRequest21sp1(OCIRequest)
Get the Integrated IMP service attributes for the service provider.
The response is either ServiceProviderIntegratedIMPGetResponse21sp1() or
ErrorResponse(). Replaced by: ServiceProviderIntegratedIMPGetRequest22() in AS
data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderIntegratedIMPGetRequest22(OCIRequest)
Get the Integrated IMP service attributes for the service provider.
The response is either ServiceProviderIntegratedIMPGetResponse22() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderIntegratedIMPModifyRequest(OCIRequest)
Modify the Integrated IMP service attributes for the service provider.
The response is either a SuccessResponse() or an ErrorResponse(). If the service
provider is within a reseller, useSystemServiceDomain means using reseller level
service domain setting. And useSystemMessagingServer means using the reseller level
messaging server setting. The following elements are only used in AS data mode:
servicePort useSystemMessagingServer provisioningUrl provisioningUserId
provisioningPassword boshURL defaultImpIdType useResellerIMPIdSetting The element
useResellerIMPIdSetting is only applicable for a service provider within a reseller.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| use_system_service_domain | bool | useSystemServiceDomain Optional |
| service_domain | str | serviceDomain Optional |
| service_port | int | servicePort Optional |
| use_system_messaging_server | bool | useSystemMessagingServer Optional |
| provisioning_url | str | provisioningUrl Optional |
| provisioning_user_id | str | provisioningUserId Optional |
| provisioning_password | str | provisioningPassword Optional |
| bosh_url | str | boshURL Optional |
| default_imp_id_type | str | defaultImpIdType Optional |
| use_reseller_imp_id_setting | bool | useResellerIMPIdSetting Optional |
ServiceProviderLanguageAddRequest(OCIRequest)
Request to add a language for a service provder.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| language | str | language |
ServiceProviderLanguageDeleteRequest(OCIRequest)
Request to delete a language from a service provider supported languages.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| language | str | language |
ServiceProviderLanguageGetAvailableListRequest(OCIRequest)
Request the list of languages that a user or admin in a service provider is allowed to use.
The list will either be the system or service provider languages list, depending on the useServiceProviderLanguages flag.
The response is either a ServiceProviderLanguageGetAvailableListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderLanguageGetListRequest(OCIRequest)
Request the defined languages for a service provider.
The response is either a ServiceProviderLanguageGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderLanguageModifyRequest(OCIRequest)
Request to modify a language properties for a service provider/enterprise.
If the becomeDefaultLanguage element is present, the language in this request Becomes the default language for the service provider/enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| language | str | language |
| become_default_language | bool | becomeDefaultLanguage Optional |
ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateDeleteRequest(OCIRequest)
Delete a MWI Delivery to Mobile Endpoint Custom Template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| language | str | language |
| type | str | type |
ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateDeleteRequest23(OCIRequest)
Delete a MWI Delivery to Mobile Endpoint Custom Template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| language | str | language |
| type | str | type |
ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateGetRequest(OCIRequest)
Request a MWI Delivery to Mobile Endpoint Custom Template.
The response is either a
ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| language | str | language |
| type | str | type |
ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateGetRequest23(OCIRequest)
Request a MWI Delivery to Mobile Endpoint Custom Template.
The response is either a
ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateGetResponse23() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| language | str | language |
| type | str | type |
ServiceProviderMWIDeliveryToMobileEndpointGetRequest(OCIRequest)
Request the service provider level data associated with MWI Delivery to Mobile Endpoint service.
The response is either a ServiceProviderMWIDeliveryToMobileEndpointGetResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderMaliciousCallTraceGetRequest(OCIRequest)
Get the service provider's Malicious Call Trace settings.
The response is either a ServiceProviderMaliciousCallTraceGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderMaliciousCallTraceModifyRequest(OCIRequest)
Modify the service provider's Malicious Call Trace settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| use_system_play_mct_warning_announcement | bool | useSystemPlayMCTWarningAnnouncement Optional |
| play_mct_warning_announcement | bool | playMCTWarningAnnouncement Optional |
ServiceProviderMeetMeConferencingGetRequest(OCIRequest)
Request the service provider/enterprise level data associated with Meet-Me Conferencing functions.
The response is either a ServiceProviderMeetMeConferencingGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderNetworkClassOfServiceAssignListRequest(OCIRequest)
Assign a list of Network Classes of Service to a service provider.
The Element defaultNetworkClassOfService is required only for the first assignment, for subsequent assignments it is optional.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By : ServiceProviderNetworkClassOfServiceAssignListRequest21() in AS data
mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| network_class_of_service | List[str] | networkClassOfService Optional |
| default_network_class_of_service | str | defaultNetworkClassOfService Optional |
ServiceProviderNetworkClassOfServiceAssignListToAllGroupsRequest(OCIRequest)
Assign a list of Network Classes of Service to all groups with in a service provider.
If it is the first assigned Network Class of Service in the group, it will be set as the default one. The Network Classes of Service must be currently assigned to the service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| network_class_of_service | List[str] | networkClassOfService |
ServiceProviderNetworkClassOfServiceAssignToAllUsersRequest(OCIRequest)
Assign a Network Classes of Service to all users with in a service provider.
This will also assign the Network Class of Service to all the groups in the service provider if it is not assigned yet. If it is the first assigned Network Class of Service in the group, it will be set as the default one. However, the Network Classes of Service must be currently assigned to the service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| network_class_of_service | str | networkClassOfService |
ServiceProviderNetworkClassOfServiceGetAssignedListRequest(OCIRequest)
Get a list of Network Classes of Service assigned to a service provider.
The response is either a
ServiceProviderNetworkClassOfServiceGetAssignedListResponse() or an
ErorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderNetworkClassOfServiceModifyDefaultRequest(OCIRequest)
Modifies the default Network Classes of Service of a Service Provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| network_class_of_service | str | networkClassOfService |
ServiceProviderNetworkClassOfServiceUnassignListRequest(OCIRequest)
Unassign a list of Network Classes of Service from a service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By : ServiceProviderNetworkClassOfServiceUnassignListRequest21() in AS data
mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| network_class_of_service | List[str] | networkClassOfService Optional |
| default_network_class_of_service | str | defaultNetworkClassOfService Optional |
ServiceProviderNumberPortabilityQueryAddListRequest(OCIRequest)
Add a list of the Service Provider Number Portability Query Digit Patterns.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| digit_pattern | List[str] | digitPattern |
ServiceProviderNumberPortabilityQueryModifyRequest(OCIRequest)
Modify the Service Provider Number Portability Query information.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| enable_number_portability_query_for_outgoing_calls | bool | enableNumberPortabilityQueryForOutgoingCalls Optional |
| enable_number_portability_query_for_incoming_calls | bool | enableNumberPortabilityQueryForIncomingCalls Optional |
| enable_number_portability_query_for_network_calls_only | bool | enableNumberPortabilityQueryForNetworkCallsOnly Optional |
| delete_digit_pattern | List[str] | deleteDigitPattern Optional |
ServiceProviderOfficeZoneAssignListRequest(OCIRequest)
Assign a list of Office Zones to a service provider.
The Element defaultOfficeZone is required only for the first assignment, for subsequent assignments it is optional. Office Zones can only be assigned if the Location-Based Calling Restrictions has been authorized to the service provider otherwise the request will fail.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| office_zone_name | List[str] | officeZoneName Optional |
| default_office_zone_name | str | defaultOfficeZoneName Optional |
ServiceProviderOfficeZoneGetAssignedListRequest(OCIRequest)
Get a list of Office Zones assigned to a service provider.
The response is either a ServiceProviderOfficeZoneGetAssignedListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderOfficeZoneUnassignListRequest(OCIRequest)
Unassign a list of OfficeZones from a service provider.
Note: a new default must be provided if unassigning the current default. Office Zones can only be unassigned if the Location-Based Calling Restrictions has been authorized to the service provider otherwise the request will fail.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| office_zone_name | List[str] | officeZoneName Optional |
| default_office_zone_name | str | defaultOfficeZoneName Optional |
ServiceProviderPasswordRulesGetRequest13mp2(OCIRequest)
Requests the service provider's password rules setting applicable to Administrators (Group and Department) and Users.
The response is either ServiceProviderPasswordRulesGetResponse13mp2() or
ErrorResponse().
Replaced By: ServiceProviderPasswordRulesGetRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderPasswordRulesGetRequest16(OCIRequest)
Requests the service provider's password rules setting applicable to Administrators (Group and Department) and Users.
The response is either ServiceProviderPasswordRulesGetResponse16() or
ErrorResponse(). Replaced by: ServiceProviderPasswordRulesGetRequest22() in AS
data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderPasswordRulesGetRequest22(OCIRequest)
Requests the service provider's password rules setting applicable to Administrators (Group and Department) and Users.
The response is either ServiceProviderPasswordRulesGetResponse22() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderPasswordRulesModifyRequest(OCIRequest)
Request to modify the service provider's password rules settings setting applicable to Administrators (Group and Department) and Users.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: ServiceProviderPasswordRulesModifyRequest14sp3()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| rules_apply_to | str | rulesApplyTo Optional |
| allow_web_add_external_authentication_users | bool | allowWebAddExternalAuthenticationUsers Optional |
| disallow_user_id | bool | disallowUserId Optional |
| disallow_old_password | bool | disallowOldPassword Optional |
| disallow_reversed_old_password | bool | disallowReversedOldPassword Optional |
| restrict_min_digits | bool | restrictMinDigits Optional |
| min_digits | int | minDigits Optional |
| restrict_min_upper_case_letters | bool | restrictMinUpperCaseLetters Optional |
| min_upper_case_letters | int | minUpperCaseLetters Optional |
| restrict_min_lower_case_letters | bool | restrictMinLowerCaseLetters Optional |
| min_lower_case_letters | int | minLowerCaseLetters Optional |
| restrict_min_non_alphanumeric_characters | bool | restrictMinNonAlphanumericCharacters Optional |
| min_non_alphanumeric_characters | int | minNonAlphanumericCharacters Optional |
| min_length | int | minLength Optional |
| max_failed_login_attempts | int | maxFailedLoginAttempts Optional |
| password_expires_days | int | passwordExpiresDays Optional |
| send_login_disabled_notify_email | bool | sendLoginDisabledNotifyEmail Optional |
| login_disabled_notify_email_address | str | loginDisabledNotifyEmailAddress Optional |
| disallow_rules_modification | bool | disallowRulesModification Optional |
ServiceProviderPasswordRulesModifyRequest14sp3(OCIRequest)
Request to modify the service provider's password rules settings setting applicable to Administrators (Group and Department) and Users.
The following elements are only used in AS data mode and ignored in XS data mode: forcePasswordChangeAfterReset reenableLogin lockOutInMinutes
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| rules_apply_to | str | rulesApplyTo Optional |
| allow_web_add_external_authentication_users | bool | allowWebAddExternalAuthenticationUsers Optional |
| disallow_user_id | bool | disallowUserId Optional |
| disallow_old_password | bool | disallowOldPassword Optional |
| disallow_reversed_old_password | bool | disallowReversedOldPassword Optional |
| restrict_min_digits | bool | restrictMinDigits Optional |
| min_digits | int | minDigits Optional |
| restrict_min_upper_case_letters | bool | restrictMinUpperCaseLetters Optional |
| min_upper_case_letters | int | minUpperCaseLetters Optional |
| restrict_min_lower_case_letters | bool | restrictMinLowerCaseLetters Optional |
| min_lower_case_letters | int | minLowerCaseLetters Optional |
| restrict_min_non_alphanumeric_characters | bool | restrictMinNonAlphanumericCharacters Optional |
| min_non_alphanumeric_characters | int | minNonAlphanumericCharacters Optional |
| min_length | int | minLength Optional |
| max_failed_login_attempts | int | maxFailedLoginAttempts Optional |
| password_expires_days | int | passwordExpiresDays Optional |
| send_login_disabled_notify_email | bool | sendLoginDisabledNotifyEmail Optional |
| login_disabled_notify_email_address | str | loginDisabledNotifyEmailAddress Optional |
| disallow_previous_passwords | bool | disallowPreviousPasswords Optional |
| number_of_previous_passwords | int | numberOfPreviousPasswords Optional |
| force_password_change_after_reset | bool | forcePasswordChangeAfterReset Optional |
| use_password_validation_service | bool | usePasswordValidationService Optional |
| reenable_login | bool | reenableLogin Optional |
| lock_out_in_minutes | int | lockOutInMinutes Optional |
ServiceProviderPortalPasscodeRulesGetRequest(OCIRequest)
Requests the service provider's passcode rules setting.
The response is either ServiceProviderPortalPasscodeRulesGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderPortalPasscodeRulesGetRequest19(OCIRequest)
Requests the service provider's passcode rules setting.
The response is either ServiceProviderPortalPasscodeRulesGetResponse19() or
ErrorResponse(). Replaced by: ServiceProviderPortalPasscodeRulesGetRequest22() in
AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderPortalPasscodeRulesGetRequest22(OCIRequest)
Requests the service provider's passcode rules setting.
The response is either ServiceProviderPortalPasscodeRulesGetResponse22() or
ErrorResponse(). Replaced by: ServiceProviderPortalPasscodeRulesGetRequestRI in AS
data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderPortalPasscodeRulesModifyRequest(OCIRequest)
Request to modify the service provider's passcode rules setting.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode: numberOfRepeatedDigits
disallowRepeatedPatterns disallowContiguousSequences numberOfAscendingDigits
numberOfDescendingDigits numberOfPreviousPasscodes reenableLogin lockOutInMinutes The
following elements are only used in AS data mode and ignored in XS data mode:
enableDefaultPasscode defaultPasscode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| disallow_repeated_digits | bool | disallowRepeatedDigits Optional |
| number_of_repeated_digits | int | numberOfRepeatedDigits Optional |
| disallow_repeated_patterns | bool | disallowRepeatedPatterns Optional |
| disallow_contiguous_sequences | bool | disallowContiguousSequences Optional |
| number_of_ascending_digits | int | numberOfAscendingDigits Optional |
| number_of_descending_digits | int | numberOfDescendingDigits Optional |
| disallow_user_number | bool | disallowUserNumber Optional |
| disallow_reversed_user_number | bool | disallowReversedUserNumber Optional |
| disallow_old_passcode | bool | disallowOldPasscode Optional |
| number_of_previous_passcodes | int | numberOfPreviousPasscodes Optional |
| disallow_reversed_old_passcode | bool | disallowReversedOldPasscode Optional |
| min_code_length | int | minCodeLength Optional |
| max_code_length | int | maxCodeLength Optional |
| disable_login_after_max_failed_login_attempts | bool | disableLoginAfterMaxFailedLoginAttempts Optional |
| max_failed_login_attempts | int | maxFailedLoginAttempts Optional |
| expire_password | bool | expirePassword Optional |
| passcode_expires_days | int | passcodeExpiresDays Optional |
| send_login_disabled_notify_email | bool | sendLoginDisabledNotifyEmail Optional |
| login_disabled_notify_email_address | str | loginDisabledNotifyEmailAddress Optional |
| enable_default_passcode | bool | enableDefaultPasscode Optional |
| default_passcode | str | defaultPasscode Optional |
| reenable_login | bool | reenableLogin Optional |
| lock_out_in_minutes | int | lockOutInMinutes Optional |
ServiceProviderPreferredCarrierAddRequest(OCIRequest)
Add the country code preferred carriers for a service provider or enterprise.
For each combination of service provider and country code, you can assign an intra- lata, inter-lata, and international carrier. Each of the three types of carriers is optional.
The response is either a SuccessResponse() or an ErrorResponse(). Note: At the
system level, more than one carrier may be assigned to each country code. At the
service provider level, you must choose from the carriers assigned at the system
level.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| country_code | str | countryCode |
| intra_lata_carrier | str | intraLataCarrier Optional |
| inter_lata_carrier | str | interLataCarrier Optional |
| international_carrier | str | internationalCarrier Optional |
ServiceProviderPreferredCarrierDeleteRequest(OCIRequest)
Delete the country code preferred carriers for a service provider or enterprise.
Note that this is different from unassigning all 3 types of carriers with the
ServiceProviderPreferredCarrierModifyRequest().
The response is either a SuccessResponse() or an ErrorResponse(). An
ErrorResponse() will be returned if the country code preferred carriers were never
added or were already deleted.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| country_code | str | countryCode |
ServiceProviderPreferredCarrierGetAvailableCountryCodeListRequest(OCIRequest)
Requests the default country code and the list of unused country codes for a service provider / enterprise.
The response is either a
ServiceProviderPreferredCarrierGetAvailableCountryCodeListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderPreferredCarrierGetCarrierListRequest(OCIRequest)
Requests the lists of carriers for a specified country code for a service provider / enterprise.
The response is either a ServiceProviderPreferredCarrierGetCarrierListResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| country_code | str | countryCode |
ServiceProviderPreferredCarrierGetListRequest(OCIRequest)
Requests a table of all the carriers defined in a specified service provider or enterprise.
The response is either a ServiceProviderPreferredCarrierGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderPreferredCarrierGetRequest(OCIRequest)
Requests the currently configured carriers for a specified country code for a service provider / enterprise.
The response is either a ServiceProviderPreferredCarrierGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| country_code | str | countryCode |
ServiceProviderPreferredCarrierModifyRequest(OCIRequest)
Modify the country code preferred carriers for a service provider or enterprise.
For each combination of service provider and country code, you can assign an intra- lata, inter-lata, and international carrier. Each of the 3 types of carriers is optional. If an optional carrier is not specified, the assignment will not change. To clear a preferred carrier, set the value to an empty string.
The response is either a SuccessResponse() or an ErrorResponse(). Note: At the
system level, more than one carrier may be assigned to each country code. At the
service provider level, you must choose from the carriers assigned at the system
level.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| country_code | str | countryCode |
| intra_lata_carrier | str | intraLataCarrier Optional |
| inter_lata_carrier | str | interLataCarrier Optional |
| international_carrier | str | internationalCarrier Optional |
ServiceProviderRouteListEnterpriseTrunkNumberPrefixActivateListRequest(OCIRequest)
Activate number prefixes in a service provider.
It is not an error to activate an already activated number prefix. The command fails if executed when system level enterprise trunk number prefix activation is disabled.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| number_prefix | List[str] | numberPrefix |
ServiceProviderRouteListEnterpriseTrunkNumberPrefixAddListRequest(OCIRequest)
Add number prefixes to a service provider.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| prefix | List[str] | prefix |
ServiceProviderRouteListEnterpriseTrunkNumberPrefixDeactivateListRequest(OCIRequest)
Deactivate number prefixes in a service provider.
It is not an error to deactivate an already deactivated number prefix. The command fails if executed when system level enterprise trunk number prefix activation is disabled.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| number_prefix | List[str] | numberPrefix |
ServiceProviderRouteListEnterpriseTrunkNumberPrefixDeleteListRequest(OCIRequest)
Delete number prefixes from a service provider.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| number_prefix | List[str] | numberPrefix |
ServiceProviderRouteListEnterpriseTrunkNumberPrefixGetAvailableListRequest(OCIRequest)
Request a list of available number prefixes not yet assigned to any group.
The response is either
ServiceProviderRouteListEnterpriseTrunkNumberPrefixGetAvailableListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderRouteListEnterpriseTrunkNumberPrefixGetSummaryListRequest(OCIRequest)
Request a summary table of all enterprise trunk number prefixes in the service provider.
The response is either
ServiceProviderRouteListEnterpriseTrunkPrefixGetSummaryListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderRouteListEnterpriseTrunkNumberRangeActivateListRequest(OCIRequest)
Activate number ranges in a service provider.
It is not an error to activate an already activated number range. The command fails if executed when system level enterprise trunk number range activation is disabled.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| number_range_start | List[str] | numberRangeStart Optional |
ServiceProviderRouteListEnterpriseTrunkNumberRangeDeactivateListRequest(OCIRequest)
Deactivate number ranges in a service provider.
It is not an error to deactivate an already deactivated number range. The command fails if executed when system level enterprise trunk number range activation is disabled.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| number_range_start | List[str] | numberRangeStart Optional |
ServiceProviderRouteListEnterpriseTrunkNumberRangeDeleteListRequest(OCIRequest)
Delete number ranges from a service provider.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| number_range_start | List[str] | numberRangeStart Optional |
ServiceProviderRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest(OCIRequest)
Request a list of available number ranges not yet assigned to any group.
The response is either
ServiceProviderRouteListEnterpriseTrunkNumberRangeGetAvailableListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest(OCIRequest)
Request a summary table of all enterprise trunk number ranges in the service provider.
The response is either
ServiceProviderRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderRoutePointExternalSystemAssignListRequest(OCIRequest)
Assign a list of route point external systems to a service provider.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| route_point_external_system | List[str] | routePointExternalSystem Optional |
ServiceProviderRoutePointExternalSystemGetAssignedListRequest(OCIRequest)
Requests the list of all Route Point External Systems assigned to a service provider.
The response is either
ServiceProviderRoutePointExternalSystemGetAssignedListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderRoutePointExternalSystemUnassignListRequest(OCIRequest)
Unassign a list of route point external systems from a service provider.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| route_point_external_system | List[str] | routePointExternalSystem Optional |
ServiceProviderRoutingProfileGetRequest(OCIRequest)
Request the routing profile for the service provider/enterprise.
The response is either a ServiceProviderRoutingProfileGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderRoutingProfileModifyRequest(OCIRequest)
Requests to modify the routing profile for a service provider.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| routing_profile | str | routingProfile Optional |
ServiceProviderSIPAuthenticationPasswordRulesGetRequest(OCIRequest)
Request to get the service provider level SIP authentication password rule settings.
The response is either a ServiceProviderSIPAuthenticationPasswordRulesGetResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderSIPAuthenticationPasswordRulesModifyRequest(OCIRequest)
Request to modify the service provider level SIP authentication password rule settings.
The useServiceProviderSettings element can only be modified by a system administrator or a provisioning administrator.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| use_service_provider_settings | bool | useServiceProviderSettings Optional |
| disallow_authentication_name | bool | disallowAuthenticationName Optional |
| disallow_old_password | bool | disallowOldPassword Optional |
| disallow_reversed_old_password | bool | disallowReversedOldPassword Optional |
| restrict_min_digits | bool | restrictMinDigits Optional |
| min_digits | int | minDigits Optional |
| restrict_min_upper_case_letters | bool | restrictMinUpperCaseLetters Optional |
| min_upper_case_letters | int | minUpperCaseLetters Optional |
| restrict_min_lower_case_letters | bool | restrictMinLowerCaseLetters Optional |
| min_lower_case_letters | int | minLowerCaseLetters Optional |
| restrict_min_non_alphanumeric_characters | bool | restrictMinNonAlphanumericCharacters Optional |
| min_non_alphanumeric_characters | int | minNonAlphanumericCharacters Optional |
| min_length | int | minLength Optional |
| send_permanent_lockout_notification | bool | sendPermanentLockoutNotification Optional |
| permanent_lockout_notify_email_address | str | permanentLockoutNotifyEmailAddress Optional |
| endpoint_authentication_lockout_type | str | endpointAuthenticationLockoutType Optional |
| endpoint_temporary_lockout_threshold | int | endpointTemporaryLockoutThreshold Optional |
| endpoint_wait_algorithm | str | endpointWaitAlgorithm Optional |
| endpoint_lockout_fixed_minutes | str | endpointLockoutFixedMinutes Optional |
| endpoint_permanent_lockout_threshold | int | endpointPermanentLockoutThreshold Optional |
| trunk_group_authentication_lockout_type | str | trunkGroupAuthenticationLockoutType Optional |
| trunk_group_temporary_lockout_threshold | int | trunkGroupTemporaryLockoutThreshold Optional |
| trunk_group_wait_algorithm | str | trunkGroupWaitAlgorithm Optional |
| trunk_group_lockout_fixed_minutes | str | trunkGroupLockoutFixedMinutes Optional |
| trunk_group_permanent_lockout_threshold | int | trunkGroupPermanentLockoutThreshold Optional |
| use_password_validation_service | bool | usePasswordValidationService Optional |
ServiceProviderScheduleAddRequest(OCIRequest)
Add a service provider schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| schedule_name | str | scheduleName |
| schedule_type | str | scheduleType |
ServiceProviderScheduleGetListRequest(OCIRequest)
Get the list of a service provider schedules.
The list can be filtered by schedule type.
The response is either a ServiceProviderScheduleGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| schedule_type | str | scheduleType Optional |
ServiceProviderServiceGetAuthorizationListRequest(OCIRequest)
Requests the service provider's service authorization status.
The response is either ServiceProviderServiceGetAuthorizationListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderServiceGetAuthorizationRequest(OCIRequest)
Requests the service provider's service authorization information for a specific service or service pack.
The response is either ServiceProviderServiceGetAuthorizationResponse() or
ErrorResponse(). The following element is used in AS mode and triggers an
ErrorResponse() in XS data mode: servicePackName
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| user_service_name | str | userServiceName Optional |
| group_service_name | str | groupServiceName Optional |
| service_pack_name | str | servicePackName Optional |
ServiceProviderServiceGetUserAssignableListRequest(OCIRequest)
Requests the list of all user services assignable to users in the specified service provider.
The response is either ServiceProviderServiceGetUserAssignableListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderServicePackAddServiceListRequest(OCIRequest)
Request to add services to a service pack if the pack has not been authorized to a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| service_pack_name | str | servicePackName |
| service_name | List[str] | serviceName |
ServiceProviderServicePackDeleteRequest(OCIRequest)
Request to delete a service pack from a service provider.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| service_pack_name | str | servicePackName |
ServiceProviderServicePackGetDetailListRequest(OCIRequest)
Request to get a service pack details.
The response is either ServiceProviderServicePackGetDetailListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| service_pack_name | str | servicePackName |
ServiceProviderServicePackGetListRequest(OCIRequest)
Request to get a list of defined service packs for a service provider.
The response is either ServiceProviderServicePackGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderServicePackGetServiceUsageListRequest(OCIRequest)
Request to get the list of service packs containing a specified service.
The response is either ServiceProviderServicePackGetServiceUsageListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| service_name | str | serviceName |
ServiceProviderServicePackGetUtilizationListRequest(OCIRequest)
Request to get the service pack utilization for a service provider.
For each service pack, a table of groups utilizing the pack is returned.
The response is either ServiceProviderServicePackGetUtilizationListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderServicePackMigrationTaskAddRequest(OCIRequest)
Create a service pack migration task.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: ServiceProviderServicePackMigrationTaskAddRequest21() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| task_name | str | taskName |
| start_timestamp | str | startTimestamp |
| max_duration_hours | int | maxDurationHours |
| send_report_email | bool | sendReportEmail |
| report_delivery_email_address | str | reportDeliveryEmailAddress Optional |
| abort_on_error | bool | abortOnError |
| abort_error_threshold | int | abortErrorThreshold Optional |
| report_all_users | bool | reportAllUsers |
| automatically_increment_service_quantity | bool | automaticallyIncrementServiceQuantity |
ServiceProviderServicePackMigrationTaskAddRequest21(OCIRequest)
Create a service pack migration task.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| task_name | str | taskName |
| start_timestamp | str | startTimestamp |
| expire_after_num_hours | int | expireAfterNumHours |
| max_duration_hours | int | maxDurationHours |
| send_report_email | bool | sendReportEmail |
| report_delivery_email_address | str | reportDeliveryEmailAddress Optional |
| abort_on_error | bool | abortOnError |
| abort_error_threshold | int | abortErrorThreshold Optional |
| report_all_users | bool | reportAllUsers |
| automatically_increment_service_quantity | bool | automaticallyIncrementServiceQuantity |
ServiceProviderServicePackMigrationTaskCopyRequest(OCIRequest)
Makes a copy of one or more existing service pack migration tasks.
A copied task can be edited with other commands and scheduled for future execution. The name of the new task is chosen automatically. The name will be "Copy (number) of taskName".
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| task_name | List[str] | taskName |
ServiceProviderServicePackMigrationTaskDeleteRequest(OCIRequest)
Deletes a service pack migration task.
It is not possible to delete a task while it is currently executing.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| task_name | str | taskName |
ServiceProviderServicePackMigrationTaskGetListRequest(OCIRequest)
Requests a list of all service pack migration task for a service provider.
The response is either ServiceProviderServicePackMigrationTaskGetListResponse() or
ErrorResponse().
Replaced By: ServiceProviderServicePackMigrationTaskGetListRequest21() in AS data
mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderServicePackMigrationTaskGetListRequest21(OCIRequest)
Requests a list of all service pack migration tasks for a service provider.
The response is either ServiceProviderServicePackMigrationTaskGetListResponse21() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderServicePackMigrationTaskGetRequest(OCIRequest)
Requests the details of a specified service pack migration task.
The response is either ServiceProviderServicePackMigrationTaskGetResponse() or
ErrorResponse().
Replaced By: ServiceProviderServicePackMigrationTaskGetRequest14sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| task_name | str | taskName |
ServiceProviderServicePackMigrationTaskGetRequest14sp4(OCIRequest)
Requests the details of a specified service pack migration task.
The response is either ServiceProviderServicePackMigrationTaskGetResponse14sp4() or
ErrorResponse().
Replaced By: ServiceProviderServicePackMigrationTaskGetRequest21() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| task_name | str | taskName |
ServiceProviderServicePackMigrationTaskGetRequest21(OCIRequest)
Requests the details of a specified service pack migration task.
The response is either ServiceProviderServicePackMigrationTaskGetResponse21() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| task_name | str | taskName |
ServiceProviderServicePackMigrationTaskModifyGroupListRequest(OCIRequest)
Replace the list of groups to be migrated for a specified service pack migration task.
Modification is only allowed prior to task execution.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| task_name | str | taskName |
| migrate_all_groups | bool | migrateAllGroups Optional |
| group_id_list | OCI.groupIdList | groupIdList Optional |
ServiceProviderServicePackMigrationTaskModifyRequest(OCIRequest)
Modify the properties of a specified service pack migration task.
Modification is only allowed prior to task execution.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| task_name | str | taskName |
| new_task_name | str | newTaskName Optional |
| start_timestamp | str | startTimestamp Optional |
| expire_after_num_hours | int | expireAfterNumHours Optional |
| max_duration_hours | int | maxDurationHours Optional |
| send_report_email | bool | sendReportEmail Optional |
| report_delivery_email_address | str | reportDeliveryEmailAddress Optional |
| abort_on_error | bool | abortOnError Optional |
| abort_error_threshold | int | abortErrorThreshold Optional |
| report_all_users | bool | reportAllUsers Optional |
| automatically_increment_service_quantity | bool | automaticallyIncrementServiceQuantity Optional |
ServiceProviderServicePackMigrationTaskTerminateRequest(OCIRequest)
Terminates a service pack migration task that is currently executing.
Modification is only allowed prior to task execution.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| task_name | str | taskName |
ServiceProviderServicePhoneNumberLookupRequest(OCIRequest)
Lookup if the given number is defined in the specified service in the service provider.
The response is ServiceProviderServicePhoneNumberLookupResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| service_type | str | serviceType |
| phone_number | str | phoneNumber |
ServiceProviderSessionAdmissionControlGetRequest(OCIRequest)
Get the session admission control capacity for the service provider.
The response is either a ServiceProviderSessionAdmissionControlGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderSessionAdmissionControlModifyRequest(OCIRequest)
Request to modify session admission control capacity for the service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| restrict_aggregate_sessions | bool | restrictAggregateSessions Optional |
| max_sessions | int | maxSessions Optional |
| max_user_originating_sessions | int | maxUserOriginatingSessions Optional |
| max_user_terminating_sessions | int | maxUserTerminatingSessions Optional |
| count_intra_service_provider_sessions | bool | countIntraServiceProviderSessions Optional |
ServiceProviderSessionAdmissionControlWhiteListGetRequest(OCIRequest)
Request to get the Service Provider Session Admission White List information.
The response is either a
ServiceProviderSessionAdmissionControlWhiteListGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderSessionAdmissionControlWhiteListModifyRequest(OCIRequest)
Modify the Service Provider Session Admission Control White List information.
The number of digit pattern entries is limited to 100.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| add_match_digit_pattern | List[str] | addMatchDigitPattern Optional |
| delete_match_digit_pattern | List[str] | deleteMatchDigitPattern Optional |
| enable_white_list | bool | enableWhiteList Optional |
ServiceProviderStirShakenGetRequest(OCIRequest)
Get service provider Stir Shaken service settings.
The response is either ServiceProviderStirShakenGetResponse() or ErrorResponse().
Replaced by the ServiceProviderStirShakenGetRequest23().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderStirShakenGetRequest23(OCIRequest)
Get service provider Stir Shaken service settings.
The response is either ServiceProviderStirShakenGetResponse23() or
ErrorResponse(). Replaced by ServiceProviderStirShakenGetRequest23V2().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderStirShakenGetRequest23V2(OCIRequest)
Get service provider Stir Shaken service settings.
The response is either ServiceProviderStirShakenGetResponse23V2() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderStirShakenModifyRequest(OCIRequest)
Modify service provider Stir Shaken service settings.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| use_parent_level_settings | bool | useParentLevelSettings Optional |
| signing_policy | str | signingPolicy Optional |
| tagging_policy | str | taggingPolicy Optional |
| signing_service_url | str | signingServiceURL Optional |
| tag_from_or_pai | str | tagFromOrPAI Optional |
| verstat_tag | str | verstatTag Optional |
| use_os_value_for_orig_id | bool | useOSValueForOrigId Optional |
| orig_uuid | str | origUUID Optional |
| attestation_level | str | attestationLevel Optional |
| enable_verification | bool | enableVerification Optional |
| verification_service_url | str | verificationServiceURL Optional |
| verification_error_handling | str | verificationErrorHandling Optional |
| proxy_verstat_to_cnam_subscribe | bool | proxyVerstatToCNAMSubscribe Optional |
| use_unknown_headers_from_cnam_notify | bool | useUnknownHeadersFromCNAMNotify Optional |
| enable_signing_for_unscreened_trunk_group_originations | bool | enableSigningForUnscreenedTrunkGroupOriginations Optional |
| enable_tagging_for_unscreened_trunk_group_originations | bool | enableTaggingForUnscreenedTrunkGroupOriginations Optional |
| unscreened_trunk_group_origination_attestation_level | str | unscreenedTrunkGroupOriginationAttestationLevel Optional |
| include_tagged_headers_to_access_side | bool | includeTaggedHeadersToAccessSide Optional |
| proxy_identity_header_to_access_side | bool | proxyIdentityHeaderToAccessSide Optional |
| check_directory_numbers_for_attestation | bool | checkDirectoryNumbersForAttestation Optional |
| match_unassigned_numbers_only | bool | matchUnassignedNumbersOnly Optional |
| enable_tagging_for_redirected_calls | bool | enableTaggingForRedirectedCalls Optional |
| prefer_ingress_tagging | bool | preferIngressTagging Optional |
ServiceProviderTemplateOnlyDeviceFileGetListRequest(OCIRequest)
Request to get the list of template files used to support a VDM device defined at service provider level.
The response is either ServiceProviderTemplateOnlyDeviceFileGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderThirdPartyEmergencyCallingGetRequest(OCIRequest)
Get the third-party emergency call service settings for the service provider.
The response is either a ServiceProviderThirdPartyEmergencyCallingGetResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderThirdPartyEmergencyCallingGetRequest22(OCIRequest)
Get the third-party emergency call service settings for the service provider.
The response is either a ServiceProviderThirdPartyEmergencyCallingGetResponse22() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderThirdPartyEmergencyCallingModifyRequest(OCIRequest)
Modify the third-party emergency call service settings for the service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| allow_activation | bool | allowActivation Optional |
| customer_id | str | customerId Optional |
| secret_key | str | secretKey Optional |
ServiceProviderTrunkGroupGetRequest(OCIRequest)
Get the maximum permissible active Trunk Group calls for the service provider.
The response is either a ServiceProviderTrunkGroupGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderTrunkGroupGetRequest14sp1(OCIRequest)
Get the maximum and bursting maximum permissible active Trunk Group calls for the service provider.
The response is either a ServiceProviderTrunkGroupGetResponse14sp1() or an
ErrorResponse(). Deprecated by ServiceProviderTrunkGroupGetRequest23()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderTrunkGroupGetRequest23(OCIRequest)
Get the maximum and bursting maximum permissible active Trunk Group calls for the service provider.
The response is either a ServiceProviderTrunkGroupGetResponse23() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderVisualDeviceManagementGetDeviceInfoRequest(OCIRequest)
Get the information for a specified device supporting visual device management.
The response is either a
ServiceProviderVisualDeviceManagementGetDeviceInfoResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
ServiceProviderVoiceMessagingGroupGetPasscodeRulesRequest(OCIRequest)
Requests the service provider's voice portal passcode rules setting.
The response is either ServiceProviderVoiceMessagingGroupGetPasscodeRulesResponse()
or ErrorResponse().
Replaced By: ServiceProviderPortalPasscodeRulesGetRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderVoiceMessagingGroupGetRequest(OCIRequest)
Requests the service provider's or enterprise's voice messaging settings.
The response is either ServiceProviderVoiceMessagingGroupGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderVoiceMessagingGroupGetVoicePortalBrandingRequest(OCIRequest)
Get the service provider's voice portal branding settings.
The response is either a
ServiceProviderVoiceMessagingGroupGetVoicePortalBrandingResponse() or an
ErrorResponse().
Replaced By: ServiceProviderVoiceMessagingGroupGetVoicePortalBrandingRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderVoiceMessagingGroupGetVoicePortalBrandingRequest16(OCIRequest)
Get the service provider's voice portal branding settings.
The response is either a
ServiceProviderVoiceMessagingGroupGetVoicePortalBrandingResponse16() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderVoiceMessagingGroupGetVoicePortalRequest(OCIRequest)
Requests the service provider's or enterprise's voice portal settings.
The response is either ServiceProviderVoiceMessagingGroupGetVoicePortalResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderVoiceMessagingGroupModifyPasscodeRulesRequest(OCIRequest)
Request to modify the service provider's voice portal passcode rules setting.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: ServiceProviderPortalPasscodeRulesModifyRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| disallow_repeated_digits | bool | disallowRepeatedDigits Optional |
| disallow_user_number | bool | disallowUserNumber Optional |
| disallow_reversed_user_number | bool | disallowReversedUserNumber Optional |
| disallow_old_passcode | bool | disallowOldPasscode Optional |
| disallow_reversed_old_passcode | bool | disallowReversedOldPasscode Optional |
| min_code_length | int | minCodeLength Optional |
| max_code_length | int | maxCodeLength Optional |
| disable_login_after_max_failed_login_attempts | bool | disableLoginAfterMaxFailedLoginAttempts Optional |
| max_failed_login_attempts | int | maxFailedLoginAttempts Optional |
| expire_password | bool | expirePassword Optional |
| passcode_expires_days | int | passcodeExpiresDays Optional |
| send_login_disabled_notify_email | bool | sendLoginDisabledNotifyEmail Optional |
| login_disabled_notify_email_address | str | loginDisabledNotifyEmailAddress Optional |
ServiceProviderVoiceMessagingGroupModifyRequest(OCIRequest)
Request to modify a service provider's or enterprise's voice messaging settings.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| delivery_from_address | str | deliveryFromAddress Optional |
| notification_from_address | str | notificationFromAddress Optional |
| voice_portal_lockout_from_address | str | voicePortalLockoutFromAddress Optional |
| use_system_default_delivery_from_address | bool | useSystemDefaultDeliveryFromAddress Optional |
| use_system_default_notification_from_address | bool | useSystemDefaultNotificationFromAddress Optional |
| use_system_default_voice_portal_lockout_from_address | bool | useSystemDefaultVoicePortalLockoutFromAddress Optional |
ServiceProviderVoiceMessagingGroupModifyVoicePortalRequest(OCIRequest)
Request to change the service provider's or enterprise's voice portal settings.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| voice_portal_scope | str | voicePortalScope Optional |
ServiceProviderXsiPolicyProfileGetAssignedListRequest(OCIRequest)
Get a list of Xsi policy profile assigned.
The response is either a ServiceProviderXsiPolicyProfileGetAssignedListResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| level | str | level Optional |
ServiceProviderXsiPolicyProfileModifyDefaultRequest(OCIRequest)
Modifies the default Xsi policy profile for a service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_default_xsi_policy_profile | str | groupDefaultXsiPolicyProfile Optional |
| user_default_xsi_policy_profile | str | userDefaultXsiPolicyProfile Optional |
ServiceProviderZoneCallingRestrictionsGetRequest(OCIRequest)
Gets the Service Provider/Enterprise level Zone Calling Restrictions Policies.
The response is ServiceProviderZoneCallingRestrictionsGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
ServiceProviderZoneCallingRestrictionsModifyRequest(OCIRequest)
Modifies the Service Provider/Enterprise level Zone Calling Restrictions Policies.
The response is SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| enable_zone_calling_restrictions | bool | enableZoneCallingRestrictions Optional |
| enable_origination_roaming_restrictions | bool | enableOriginationRoamingRestrictions Optional |
| enable_emergency_origination_roaming_restrictions | bool | enableEmergencyOriginationRoamingRestrictions Optional |
| enable_termination_roaming_restrictions | bool | enableTerminationRoamingRestrictions Optional |
SystemASRParametersGetRequest(OCIRequest)
Request to get the list of Application Server Registration system parameters.
The response is either SystemASRParametersGetResponse() or ErrorResponse().
Replaced By: SystemASRParametersGetRequest14sp5()
SystemASRParametersGetRequest14sp5(OCIRequest)
Request to get the list of Application Server Registration system parameters.
The response is either SystemASRParametersGetResponse14sp5() or ErrorResponse().
SystemASRParametersGetRequest14sp7(OCIRequest)
Request to get the list of Application Server Registration system parameters.
The response is either SystemASRParametersGetResponse14sp7() or ErrorResponse().
Replaced by: SystemASRParametersGetRequest23() in AS data mode.
SystemASRParametersGetRequest23(OCIRequest)
Request to get the list of Application Server Registration system parameters.
The response is either SystemASRParametersGetResponse23() or ErrorResponse().
SystemASRParametersModifyRequest(OCIRequest)
Request to modify Application Server Registration system parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| max_transmissions | int | maxTransmissions Optional |
| retransmission_delay_milli_seconds | int | retransmissionDelayMilliSeconds Optional |
| listening_port | int | listeningPort Optional |
| source_address | str | sourceAddress Optional |
SystemASRParametersModifyRequest14sp7(OCIRequest)
Request to modify Application Server Registration system parameters.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
enableCustomMessageControl customNumberOfUsersPerMessage
customMessageIntervalMilliseconds
Attributes:
| Name | Type | Description |
|---|---|---|
| max_transmissions | int | maxTransmissions Optional |
| retransmission_delay_milli_seconds | int | retransmissionDelayMilliSeconds Optional |
| listening_port | int | listeningPort Optional |
| enable_custom_message_control | bool | enableCustomMessageControl Optional |
| custom_number_of_users_per_message | int | customNumberOfUsersPerMessage Optional |
| custom_message_interval_milliseconds | int | customMessageIntervalMilliseconds Optional |
SystemAccessDeviceCustomTagAddRequest(OCIRequest)
Request to add a static configuration tag for a system access device.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| tag_name | str | tagName |
| tag_value | str | tagValue Optional |
SystemAccessDeviceCustomTagDeleteListRequest(OCIRequest)
Request to delete static configuration tags for a system access device.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| tag_name | List[str] | tagName |
SystemAccessDeviceCustomTagGetListRequest(OCIRequest)
Request to get the list of custom configuration tags managed by the Device Management System, on a per-device profile basis.
The response is either SystemAccessDeviceCustomTagGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemAccessDeviceCustomTagModifyRequest(OCIRequest)
Request to modify a static configuration tag for a system access device.
The following elements are only used in XS data mode and ignored in AS data mode: tagValueToEncrypt
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| tag_name | str | tagName |
| tag_value | str | tagValue Optional |
| tag_value_to_encrypt | str | tagValueToEncrypt Optional |
SystemAccessDeviceDeleteRequest(OCIRequest)
Request to delete a specified system access device.
The following elements are only used in AS data mode and ignored in XS data mode: deviceExternalId
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
SystemAccessDeviceDeviceActivationGetRequest(OCIRequest)
Requests the activation information for a device configured at System level.
Returns a SystemAccessDeviceDeviceActivationGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemAccessDeviceDeviceActivationModifyRequest(OCIRequest)
Activates or deactivates a device configured at the System level.
It is only possible for this request to activate a device which is deactivated.
Trying to activate a device in the activating state will result in an error response
since only the DAS is allowed to execute this operation. Returns a
SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| activate_device | bool | activateDevice |
SystemAccessDeviceFileGetListRequest(OCIRequest)
Request to get the list of device files managed by the Device Management System, on a per-device profile basis.
The response is either SystemAccessDeviceFileGetListResponse() or ErrorResponse().
Replaced By: SystemAccessDeviceFileGetListRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemAccessDeviceFileGetListRequest14sp8(OCIRequest)
Request to get the list of device files managed by the Device Management System, on a per-device profile basis.
The response is either SystemAccessDeviceFileGetListResponse14sp8() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemAccessDeviceFileGetRequest(OCIRequest)
Request to get a device profile file.
The response is either SystemAccessDeviceFileGetResponse() or ErrorResponse().
Replaced By: SystemAccessDeviceFileGetRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| file_type | str | fileType |
SystemAccessDeviceFileGetRequest14sp8(OCIRequest)
Request to get a device profile file.
The response is either SystemAccessDeviceFileGetResponse14sp8() or
ErrorResponse(). Replaced by: SystemAccessDeviceFileGetRequest16sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| file_format | str | fileFormat |
SystemAccessDeviceFileGetRequest16sp1(OCIRequest)
Request to get a device profile file.
The response is either SystemAccessDeviceFileGetResponse16sp1() or
ErrorResponse(). Replaced by: SystemAccessDeviceFileGetRequest20()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| file_format | str | fileFormat |
SystemAccessDeviceFileGetRequest20(OCIRequest)
Request to get a device profile file.
The response is either SystemAccessDeviceFileGetResponse20() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| file_format | str | fileFormat |
SystemAccessDeviceGenerateActivationCodeRequest(OCIRequest)
Requests a new activation code for a device configured at the System level.
Returns a SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemAccessDeviceGetAvailableCustomTagListRequest(OCIRequest)
Get the list of all available custom tags managed by the Device Management System, on a per-device profile basis.
The response is either SystemAccessDeviceGetAvailableCustomTagListResponse() or
ErrorResponse(). The following elements are used in AS mode and ignored in XS data
mode: tagSetName
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| tag_set_name | str | tagSetName Optional |
SystemAccessDeviceGetLinkedLeafDeviceListRequest(OCIRequest)
Requests the list of linked leaf devices for the system level tree device passed in the request.
A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device". It can be linked to only one tree device. The list includes devices created at the system, service provider, and group levels.
The response is either SystemAccessDeviceGetLinkedLeafDeviceListResponse() or
ErrorResponse(). Replaced by:
SystemAccessDeviceGetLinkedLeafDeviceListRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemAccessDeviceGetLinkedLeafDeviceListRequest22(OCIRequest)
Requests the list of linked leaf devices for the system level tree device passed in the request.
A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device. The list includes devices created at the system, service provider, and group levels. If the leafDeviceCategory is not set in the request, then linked leaf devices of all categories are requested, otherwise only the linked leaf devices of the specified category are requested. The category values are: "Handset", "Base Station", "All".
The response is either SystemAccessDeviceGetLinkedLeafDeviceListResponse22() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| leaf_device_category | str | leafDeviceCategory Optional |
SystemAccessDeviceGetLinkedTreeDeviceRequest(OCIRequest)
Requests the tree device linked with the system level leaf device passed in the request.
A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device.
The response is either SystemAccessDeviceGetLinkedTreeDeviceResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemAccessDeviceGetNativeTagsWithLogicListRequest(OCIRequest)
Get the list of all native tags with logic managed by the Device Management System, on a per-device profile basis.
The response is either SystemAccessDeviceGetNativeTagsWithLogicListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemAccessDeviceGetRequest(OCIRequest)
Requests the configuration of a specified system access device.
The response is either SystemAccessDeviceGetResponse() or ErrorResponse().
Replaced By: SystemAccessDeviceGetRequest14sp3()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemAccessDeviceGetRequest14sp3(OCIRequest)
Requests the configuration of a specified system access device.
The response is either SystemAccessDeviceGetResponse14sp3() or ErrorResponse().
Replaced By: SystemAccessDeviceGetRequest14sp6()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemAccessDeviceGetRequest14sp6(OCIRequest)
Requests the configuration of a specified system access device.
The response is either SystemAccessDeviceGetResponse14sp6() or ErrorResponse().
Replaced by: SystemAccessDeviceGetRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemAccessDeviceGetRequest16(OCIRequest)
Requests the configuration of a specified system access device.
The response is either SystemAccessDeviceGetResponse16() or ErrorResponse().
Replaced by: SystemAccessDeviceGetRequest19()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemAccessDeviceGetRequest18sp1(OCIRequest)
Requests the configuration of a specified system access device.
The response is either SystemAccessDeviceGetResponse18sp1() or ErrorResponse().
Replaced by: SystemAccessDeviceGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemAccessDeviceGetRequest22(OCIRequest)
Requests the configuration of a specified system access device.
The response is either SystemAccessDeviceGetResponse22() or ErrorResponse().
Replaced by: SystemAccessDeviceGetRequest24()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemAccessDeviceGetRequest22V2(OCIRequest)
Requests the configuration of a specified system access device.
The following elements are only used in AS data mode and ignored in XS data mode: deviceExternalId
The response is either SystemAccessDeviceGetResponse22V2() or ErrorResponse().
Replaced By: SystemAccessDeviceGetRequest24()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
SystemAccessDeviceGetRequest22V3(OCIRequest)
Requests the configuration of a specified system access device.
The following elements are only used in AS data mode and ignored in XS data mode: deviceExternalId
The response is either SystemAccessDeviceGetResponse22V3() or ErrorResponse().
Replaced By: SystemAccessDeviceGetRequest24()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
SystemAccessDeviceGetRequest22V4(OCIRequest)
Requests the configuration of a specified system access device.
The response is either SystemAccessDeviceGetResponse22V5() or ErrorResponse(). The
following elements are only used in AS data mode and ignored in XS data mode:
deviceExternalId Replaced by: SystemAccessDeviceGetRequest24()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
SystemAccessDeviceGetRequest22V5(OCIRequest)
Requests the configuration of a specified system access device.
The response is either SystemAccessDeviceGetResponse22V5() or ErrorResponse(). The
following elements are only used in AS data mode and ignored in XS data mode:
deviceExternalId Replaced by: SystemAccessDeviceGetRequest24V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
SystemAccessDeviceGetRequest22V6(OCIRequest)
Requests the configuration of a specified system access device.
The response is either SystemAccessDeviceGetResponse22V6() or ErrorResponse(). The
following elements are only used in AS data mode and ignored in XS data mode:
deviceExternalId Replaced by: SystemAccessDeviceGetRequest24V3()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
SystemAccessDeviceGetRequest24(OCIRequest)
Requests the configuration of a specified system access device.
The following elements are only used in AS data mode and ignored in XS data mode: deviceExternalId
The response is either SystemAccessDeviceGetResponse24() or ErrorResponse().
Replaced by: SystemAccessDeviceGetRequest24V2() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
SystemAccessDeviceGetRequest24V2(OCIRequest)
Requests the configuration of a specified system access device.
The following elements are only used in AS data mode and ignored in XS data mode: deviceExternalId
The response is either SystemAccessDeviceGetResponse24V3() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
SystemAccessDeviceGetRequest24V3(OCIRequest)
Requests the configuration of a specified system access device.
The following elements are only used in AS data mode and ignored in XS data mode: deviceExternalId
The response is either SystemAccessDeviceGetResponse24V3() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
SystemAccessDeviceModifyUserRequest(OCIRequest)
Request to modify attributes for line/ports assigned on the system device profile.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in XS data mode and ignored in AS data mode: privateIdentity
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| line_port | str | linePort |
| private_identity | str | privateIdentity Optional |
| is_primary_line_port | bool | isPrimaryLinePort Optional |
SystemAccessDeviceMonitorAddDeviceTypeRequest(OCIRequest)
Add a device type to be monitored.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| add_all_device_types | bool | addAllDeviceTypes Optional |
| device_type | str | deviceType Optional |
SystemAccessDeviceMonitorDeleteDeviceTypeRequest(OCIRequest)
Remove a device type to be monitored.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| delete_all_device_types | bool | deleteAllDeviceTypes Optional |
| device_type | str | deviceType Optional |
SystemAccessDeviceMonitorGetDeviceTypeListRequest(OCIRequest)
Get a list of monitored device types.
The response is either a SystemAccessDeviceMonitorGetDeviceTypeListResponse() or an
ErrorResponse().
SystemAccessDeviceMonitorParametersGetRequest(OCIRequest)
Request to get the list of Access Device Monitor system parameters.
The response is either SystemAccessDeviceMonitorParametersGetResponse() or
ErrorResponse().
SystemAccessDeviceMonitorParametersModifyRequest(OCIRequest)
Request to modify Access Device Monitor system parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| polling_interval_minutes | int | pollingIntervalMinutes Optional |
SystemAccessDeviceResetRequest(OCIRequest)
Reset a specific system SIP device that supports the reset operation.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemAccessDeviceTagSetGetRequest(OCIRequest)
Request to get the custom configuration tag set defined at the access device.
The response is either SystemAccessDeviceTagSetGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemAccessDeviceTagSetModifyRequest(OCIRequest)
Request to modify a static configuration tag set.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| tag_set_name | str | tagSetName Optional |
SystemAccessDeviceTypeGetEnhancedConfigurableListRequest(OCIRequest)
Requests the list of device types supporting enhanced configuration.
The response is either SystemAccessDeviceTypeGetEnhancedConfigurableListResponse()
or ErrorResponse().
SystemAccessDeviceTypeGetListRequest(OCIRequest)
Requests the list of access device types.
The response is either SystemAccessDeviceTypeGetListResponse() or ErrorResponse().
SystemAccountingAddChargingFunctionElementServerRequest(OCIRequest)
Request to add a ChargingFunctionElement Server to the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| address | str | address |
| is_net_address_extended | bool | isNetAddressExtended |
| type | str | type |
| description | str | description Optional |
SystemAccountingAddRadiusServerRequest(OCIRequest)
Request to add a Radius Server to the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| port | int | port |
| description | str | description Optional |
SystemAccountingDeleteChargingFunctionElementServerRequest(OCIRequest)
Request to delete a ChargingFunctionElementServer from the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| address | str | address |
SystemAccountingDeleteRadiusServerRequest(OCIRequest)
Request to delete a Radius Server from the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| port | int | port |
SystemAccountingGetChargingFunctionElementServerListRequest(OCIRequest)
Request to get a list of ChargingFunctionElementServers defined in the system.
The response is either a
SystemAccountingGetChargingFunctionElementServerListResponse() or an
ErrorResponse().
SystemAccountingGetRadiusServerListRequest(OCIRequest)
Request to get a list of Radius Servers defined in the system.
The response is either a SystemAccountingGetRadiusServerListResponse() or an
ErrorResponse().
SystemAccountingInhibitedAttributeValuePairCodeAddRequest(OCIRequest)
Add an Attribute Value Pair (AVP) combination to disable.
The AVP combination includes a diameter AVP and a vendor ID.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| attribute_value_pair_code | int | attributeValuePairCode |
| vendor_id | int | vendorId |
SystemAccountingInhibitedAttributeValuePairCodeDeleteRequest(OCIRequest)
Remove an Attribute Value Pair (AVP) combination from the list of disabled AVP codes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| attribute_value_pair_code | int | attributeValuePairCode |
| vendor_id | int | vendorId |
SystemAccountingInhibitedAttributeValuePairCodeGetListRequest(OCIRequest)
Get a list of Attribute Value Pair (AVP) combinations that are disabled.
The response is either a
SystemAccountingInhibitedAttributeValuePairCodeGetListResponse() or an
ErrorResponse().
SystemAccountingModifyChargingFunctionElementServerRequest(OCIRequest)
Request to modify a ChargingFunctionElementServer in the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| address | str | address |
| type | str | type Optional |
| description | str | description Optional |
SystemAccountingModifyRadiusServerRequest(OCIRequest)
Request to modify a Radius Server in the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| port | int | port |
| description | str | description Optional |
SystemAccountingReorderChargingFunctionElementServerRequest(OCIRequest)
Reorder the charging function element servers.
You can not add or delete addresses, only re-ordering the list is allowed. The
ordered list of addresses can be obtained with the
SystemAccountingGetChargingFunctionElementServerListRequest() command.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| ordered_address_list | List[str] | orderedAddressList |
SystemAdminAddRequest(OCIRequest)
Add a system or provisioning administrator.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| first_name | str | firstName Optional |
| last_name | str | lastName Optional |
| password | str | password |
| language | str | language Optional |
| admin_type | str | adminType |
| read_only | bool | readOnly |
SystemAdminDeleteRequest(OCIRequest)
Delete a system or provisioning administrator.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
SystemAdminGetListRequest(OCIRequest)
Get a list of system administrators.
The response is either a SystemAdminGetResponse() or an ErrorResponse().
SystemAdminGetRequest(OCIRequest)
Get a system or provisioning administrators profile.
The response is either a SystemAdminGetResponse() or an ErrorResponse(). Replaced
by: SystemAdminGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
SystemAdminGetRequest22(OCIRequest)
Get a system or provisioning administrators profile.
The response is either a SystemAdminGetResponse22() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
SystemAdminModifyRequest(OCIRequest)
Modify a system or provisioning administrator.
Since old password is not specified here, any password rule related to old password does not apply.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode. accountDisabled
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| first_name | str | firstName Optional |
| last_name | str | lastName Optional |
| password | str | password Optional |
| language | str | language Optional |
| account_disabled | bool | accountDisabled Optional |
SystemAdviceOfChargeCostInformationSourceAddRequest(OCIRequest)
Add a cost information source.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| peer_identity | str | peerIdentity |
| priority | int | priority |
SystemAdviceOfChargeCostInformationSourceDeleteRequest(OCIRequest)
Delete a cost information source.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| peer_identity | str | peerIdentity |
SystemAdviceOfChargeCostInformationSourceGetListRequest(OCIRequest)
Get a list of cost information sources.
The response is either SystemAdviceOfChargeCostInformationSourceGetListResponse() or
ErrorResponse().
SystemAdviceOfChargeCostInformationSourceModifyRequest(OCIRequest)
Modify a cost information source.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| peer_identity | str | peerIdentity |
| priority | int | priority |
SystemAdviceOfChargeGetRequest(OCIRequest)
Request to get the list of Advice of Charge system parameters.
The response is either SystemAdviceOfChargeGetResponse() or ErrorResponse().
Replaced by: SystemAdviceOfChargeGetRequest19sp1()
SystemAdviceOfChargeGetRequest19sp1(OCIRequest)
Request to get the list of Advice of Charge system parameters.
The response is either SystemAdviceOfChargeGetResponse19sp1() or ErrorResponse().
Replaced by: SystemAdviceOfChargeGetRequest25().
SystemAdviceOfChargeGetRequest25(OCIRequest)
Request to get the list of Advice of Charge system parameters.
The response is either SystemAdviceOfChargeGetResponse25() or ErrorResponse().
SystemAdviceOfChargeModifyRequest(OCIRequest)
Request to modify Advice of Charge system parameters.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
SystemAdviceOfChargeModifyRequest19sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| delay_between_notification_seconds | int | delayBetweenNotificationSeconds Optional |
| incoming_aoc_handling | str | incomingAocHandling Optional |
| cost_information_source | str | costInformationSource Optional |
SystemAdviceOfChargeModifyRequest19sp1(OCIRequest)
Request to modify Advice of Charge system parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| delay_between_notification_seconds | int | delayBetweenNotificationSeconds Optional |
| incoming_aoc_handling | str | incomingAocHandling Optional |
| use_ocs_enquiry | bool | useOCSEnquiry Optional |
| ocs_enquiry_type | str | OCSEnquiryType Optional |
| proxy_ao_c_body | bool | proxyAoCBody Optional |
SystemAliasAddRequest(OCIRequest)
Add a system-level Application Server alias to the system.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| alias_net_address | str | aliasNetAddress |
SystemAliasDeleteRequest(OCIRequest)
Delete a system-level Application Server alias from the system.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| alias_net_address | str | aliasNetAddress |
SystemAliasGetListRequest(OCIRequest)
Requests the list of all system-level Application Server aliases.
The response is either SystemAliasGetListResponse() or ErrorResponse().
SystemAnonymousCallRejectionGetRequest(OCIRequest)
Get Anonymous Call Rejection system parameters.
The response is either a SystemAnonymousCallRejectionGetResponse() or an
ErrorResponse().
SystemAnonymousCallRejectionModifyRequest(OCIRequest)
Modify a system Anonymous Call Rejection parameter.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| pai_required | bool | paiRequired Optional |
| screen_only_local_calls | bool | screenOnlyLocalCalls Optional |
SystemApplicationControllerAddRequest(OCIRequest)
Add an application controller, which is a server where remote application resides and controls the Route Point.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| subscriber_id | str | subscriberId |
| channel_set_id | str | channelSetId |
SystemApplicationControllerDeleteRequest(OCIRequest)
Delete an application controller.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemApplicationControllerGetListRequest(OCIRequest)
Get a list of application controllers that are configured for the system.
The response is either SystemApplicationControllerGetListResponse() or
ErrorResponse().
SystemAuthenticationLockoutExportDataGetRequest(OCIRequest)
Request to export system wide authentication lockout data to a file.
All locked out device profiles, sip endpoints, and sip trunk groups are returned.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| file_name | str | fileName |
SystemAuthenticationLockoutSettingsGetRequest(OCIRequest)
Request to get the authentication lockout settings in the system.
The response is either a SystemAuthenticationLockoutSettingsResponse() or an
ErrorResponse().
SystemAuthenticationLockoutSettingsModifyRequest(OCIRequest)
Request to modify the system level device password lockout settings The response is
either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| counter_reset_interval_days | int | counterResetIntervalDays Optional |
| counter_reset_hour | int | counterResetHour Optional |
| counter_reset_minute | int | counterResetMinute Optional |
| emergency_sip_bypass_allowed | bool | emergencySIPBypassAllowed Optional |
SystemAutoDisableAccountsGetRequest(OCIRequest)
Request to get Auto Disable Accounts system parameters.
The response is either SystemAutoDisableAccountsGetResponse() or ErrorResponse().
SystemAutoDisableAccountsModifyRequest(OCIRequest)
Modify the Auto Disable Accounts system parameters.
Attributes:
| Name | Type | Description |
|---|---|---|
| account_inactivity_timeout_days | int | accountInactivityTimeoutDays Optional |
| enable_auto_disable_accounts | bool | enableAutoDisableAccounts Optional |
| enable_auto_disable_accounts_system_admin_level | bool | enableAutoDisableAccountsSystemAdminLevel Optional |
| enable_auto_disable_accounts_provisioning_admin_level | bool | enableAutoDisableAccountsProvisioningAdminLevel Optional |
| enable_auto_disable_accounts_reseller_admin_level | bool | enableAutoDisableAccountsResellerAdminLevel Optional |
| enable_auto_disable_accounts_svc_provider_admin_level | bool | enableAutoDisableAccountsSvcProviderAdminLevel Optional |
| enable_auto_disable_accounts_group_admin_level | bool | enableAutoDisableAccountsGroupAdminLevel Optional |
| enable_auto_disable_accounts_department_admin_level | bool | enableAutoDisableAccountsDepartmentAdminLevel Optional |
SystemAutomaticCallbackAddReleaseCauseListRequest(OCIRequest)
Adds automatic callback release cause to the releaseCause attribute.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| release_cause | List[str] | releaseCause Optional |
SystemAutomaticCallbackDeleteReleaseCauseListRequest(OCIRequest)
Deletes automatic callback release causes from the release cause attribute.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| release_cause | List[str] | releaseCause Optional |
SystemAutomaticCallbackGetReleaseCauseListRequest(OCIRequest)
Request the system's automatic callback attributes.
The response is either a SystemAutomaticCallbackGetReleaseCauseListResponse() or an
ErrorResponse().
SystemAutomaticCallbackGetRequest(OCIRequest)
Request the system's automatic callback attributes.
The response is either a SystemAutomaticCallbackGetResponse() or an
ErrorResponse().
Replaced By: SystemAutomaticCallbackGetRequest15()
SystemAutomaticCallbackGetRequest15(OCIRequest)
Request the system's automatic callback attributes.
The response is either a SystemAutomaticCallbackGetResponse15() or an
ErrorResponse().
Replaced By: SystemAutomaticCallbackGetRequest15sp2()
SystemAutomaticCallbackGetRequest15sp2(OCIRequest)
Request the system's automatic callback attributes.
The response is either a SystemAutomaticCallbackGetResponse15sp2() or an
ErrorResponse(). Replaced by: SystemAutomaticCallbackGetRequest17()
SystemAutomaticCallbackGetRequest17(OCIRequest)
Request the system's automatic callback attributes.
The response is either a SystemAutomaticCallbackGetResponse17() or an
ErrorResponse().
SystemAutomaticCallbackModifyRequest(OCIRequest)
Modifies the system's automatic callback attributes.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: SystemAutomaticCallbackModifyRequest15()
Attributes:
| Name | Type | Description |
|---|---|---|
| monitor_minutes | int | monitorMinutes Optional |
| wait_between_retry_originator_minutes | int | waitBetweenRetryOriginatorMinutes Optional |
| max_monitors_per_originator | int | maxMonitorsPerOriginator Optional |
| max_callback_rings | int | maxCallbackRings Optional |
| max_retry_originator_minutes | int | maxRetryOriginatorMinutes Optional |
SystemAutomaticCallbackModifyRequest15(OCIRequest)
Modifies the system's automatic callback attributes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| monitor_minutes | int | monitorMinutes Optional |
| max_monitors_per_originator | int | maxMonitorsPerOriginator Optional |
| max_callback_rings | int | maxCallbackRings Optional |
| max_monitors_per_terminator | int | maxMonitorsPerTerminator Optional |
| terminator_idle_guard_seconds | int | terminatorIdleGuardSeconds Optional |
| callback_method | str | callbackMethod Optional |
| polling_interval_seconds | int | pollingIntervalSeconds Optional |
| activation_digit | int | activationDigit Optional |
SystemAutomaticCollectCallGetRequest(OCIRequest)
Get system Automatic Collect Call service settings.
The response is either SystemAutomaticCollectCallGetResponse() or ErrorResponse().
Replaced by SystemAutomaticCollectCallGetRequest() in AS mode.
SystemAutomaticCollectCallGetRequest22(OCIRequest)
Get system Automatic Collect Call service settings.
The response is either SystemAutomaticCollectCallGetResponse22() or
ErrorResponse().
SystemAutomaticCollectCallModifyRequest(OCIRequest)
Modify system Automatic Collect Call service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enable_automatic_collect_call | bool | enableAutomaticCollectCall Optional |
| enable_connect_tone | bool | enableConnectTone Optional |
| include_country_code_in_cic | bool | includeCountryCodeInCic Optional |
SystemAutomaticCollectCallPrefixDigitsGetListRequest(OCIRequest)
Get the system automatic collect call prefix digits lists.
The response is either SystemAutomaticCollectCallPrefixDigitsGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| country_code | str | countryCode Optional |
SystemBCCTAddOCIInterfaceAddressRequest(OCIRequest)
Add an OCI entry to the Broadworks Common Communication Transport (BCCT) protocol to interface mapping table.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| interface_net_address | str | interfaceNetAddress |
SystemBCCTDeleteOCIInterfaceAddressRequest(OCIRequest)
Delete an OCI entry in the Broadworks Common Communication Transport (BCCT) protocol to interface mapping table.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| interface_net_address | str | interfaceNetAddress |
SystemBCCTGetOCIInterfaceAddressListRequest(OCIRequest)
Get the OCI entries from the Broadworks Common Communication Transport (BCCT) protocol to interface mapping list.
The response is SystemBCCTGetOCIInterfaceAddressListResponse() or ErrorResponse().
SystemBroadCloudGetRequest(OCIRequest)
Get the system interface attributes for Messaging Server/BroadCloud.
The response is either SystemBroadCloudGetResponse() or ErrorResponse().
SystemBroadCloudGetRequest22(OCIRequest)
Get the system interface attributes for Messaging Server/BroadCloud.
The response is either SystemBroadCloudGetResponse22() or ErrorResponse().
SystemBroadCloudModifyRequest(OCIRequest)
Modify the system interface attributes for Messaging Server/BroadCloud.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| provisioning_url | str | provisioningUrl Optional |
| provisioning_user_id | str | provisioningUserId Optional |
| provisioning_password | str | provisioningPassword Optional |
| enable_synchronization | bool | enableSynchronization Optional |
| proxy_host | str | proxyHost Optional |
| proxy_port | int | proxyPort Optional |
SystemBroadWorksAnywhereGetRequest(OCIRequest)
Get the Broadworks Anywhere system parameters.
The response is either a SystemBroadWorksAnywhereGetResponse() or an
ErrorResponse().
SystemBroadWorksAnywhereModifyRequest(OCIRequest)
Modify the BroadWorks Anywhere system parameters.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: enableTransferNotification The following
elements are only used in XS data mode: blockProvisioningOfDNAsBALocationEnabled
Attributes:
| Name | Type | Description |
|---|---|---|
| enable_transfer_notification | bool | enableTransferNotification Optional |
| block_provisioning_of_dn_as_ba_location | bool | blockProvisioningOfDNAsBALocation Optional |
SystemBroadWorksMobilityDeleteIMRNListRequest(OCIRequest)
Removes a BroadWorks Mobility IMRN number from the system.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| imrn_number | List[str] | imrnNumber |
SystemBroadWorksMobilityDeleteMobileNetworkIMRNListRequest(OCIRequest)
Remove BroadWorks Mobility IMRN numbers from a Mobile Network.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| mobile_network_name | str | mobileNetworkName |
| imrn_number | List[str] | imrnNumber |
SystemBroadWorksMobilityGeographicalPoolAddRequest(OCIRequest)
Add a geographical pool to the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| country_code | str | countryCode |
| is_default | bool | isDefault |
| description | str | description Optional |
SystemBroadWorksMobilityGeographicalPoolDeleteRequest(OCIRequest)
Delete a geographical pool from the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemBroadWorksMobilityGeographicalPoolGetListRequest(OCIRequest)
Get a list of geographical pools defined in the system.
If countryCode is set, return the IMRN pools associated with the country code.
The response is either SystemBroadWorksMobilityGeographicalPoolGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| country_code | str | countryCode Optional |
SystemBroadWorksMobilityGeographicalPoolIMRNDeleteListRequest(OCIRequest)
Remove BroadWorks Mobility IMRN numbers from a geographical pool.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| geographical_pool_name | str | geographicalPoolName |
| imrn_number | List[str] | imrnNumber |
SystemBroadWorksMobilityGeographicalPoolModifyRequest(OCIRequest)
Modify the settings of a geographical pool.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| new_name | str | newName Optional |
| is_default | bool | isDefault Optional |
| description | str | description Optional |
SystemBroadWorksMobilityGeographicalPoolPrefixAddListRequest(OCIRequest)
Add a list of geographical prefixes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| geographical_pool_name | str | geographicalPoolName |
| prefix | List[str] | prefix |
SystemBroadWorksMobilityGeographicalPoolPrefixDeleteListRequest(OCIRequest)
Delete a list of geographical prefixes from a pool.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| geographical_pool_name | str | geographicalPoolName |
| prefix | List[str] | prefix |
SystemBroadWorksMobilityGeographicalPoolPrefixGetListRequest(OCIRequest)
Gets a list of geographical prefixes belonging to a geographical pool.
The response is either
SystemBroadWorksMobilityGeographicalPoolPrefixGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| geographical_pool_name | str | geographicalPoolName |
SystemBroadWorksMobilityGetRequest(OCIRequest)
Get the broadworks mobility system parameters.
The response is either a SystemBroadWorksMobilityGetResponse() or an
ErrorResponse(). Replaced by: SystemBroadWorksMobilityGetRequest17sp4().
SystemBroadWorksMobilityGetRequest17sp4(OCIRequest)
Get the broadworks mobility system parameters.
The response is either a SystemBroadWorksMobilityGetResponse17sp4() or an
ErrorResponse(). Replaced by: SystemBroadWorksMobilityGetRequest19sp1()
SystemBroadWorksMobilityGetRequest19sp1(OCIRequest)
Get the broadworks mobility system parameters.
The response is either a SystemBroadWorksMobilityGetResponse19sp1() or an
ErrorResponse(). Replaced by SystemBroadWorksMobilityGetRequest21()
SystemBroadWorksMobilityGetRequest21(OCIRequest)
Get the broadworks mobility system parameters.
The response is either a SystemBroadWorksMobilityGetResponse21() or an
ErrorResponse(). Replaced by: SystemBroadWorksMobilityGetRequest22() in AS data
mode
SystemBroadWorksMobilityGetRequest21sp1(OCIRequest)
Get the broadworks mobility system parameters.
The response is either a SystemBroadWorksMobilityGetResponse21sp1() or an
ErrorResponse(). Replaced by SystemBroadWorksMobilityGetRequest22V2().
SystemBroadWorksMobilityGetRequest22(OCIRequest)
Get the broadworks mobility system parameters.
The response is either a SystemBroadWorksMobilityGetResponse22() or an
ErrorResponse(). Replaced by SystemBroadWorksMobilityGetRequest22V2().
SystemBroadWorksMobilityGetRequest22V2(OCIRequest)
Get the broadworks mobility system parameters.
The response is either a SystemBroadWorksMobilityGetResponse22V2() or an
ErrorResponse(). Replaced by SystemBroadWorksMobilityGetRequest22V3().
SystemBroadWorksMobilityGetRequest22V3(OCIRequest)
Get the broadworks mobility system parameters.
The response is either a SystemBroadWorksMobilityGetResponse22V3() or an
ErrorResponse().
SystemBroadWorksMobilityMobileNetworkAddRequest(OCIRequest)
Add a Mobile Network.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| scf_signaling_net_address | str | scfSignalingNetAddress Optional |
| scf_signaling_port | int | scfSignalingPort Optional |
| refresh_period_seconds | int | refreshPeriodSeconds |
| max_consecutive_failures | int | maxConsecutiveFailures |
| max_response_wait_time_milliseconds | int | maxResponseWaitTimeMilliseconds |
| enable_announcement_suppression | bool | enableAnnouncementSuppression |
| service_access_code_list_name | str | serviceAccessCodeListName Optional |
SystemBroadWorksMobilityMobileNetworkDeleteRequest(OCIRequest)
Delete a Mobile Network.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemBroadWorksMobilityMobileNetworkGetListRequest(OCIRequest)
Get the list of Mobile Networks.
The response is either SystemBroadWorksMobilityMobileNetworkGetListResponse() or
ErrorResponse().
SystemBroadWorksMobilityMobileNetworkGetRequest(OCIRequest)
Get a Mobile Network.
The response is either SystemBroadWorksMobilityMobileNetworkGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemBroadWorksMobilityMobileNetworkModifyRequest(OCIRequest)
Modify a Mobile Network.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| new_name | str | newName Optional |
| scf_signaling_net_address | str | scfSignalingNetAddress Optional |
| scf_signaling_port | int | scfSignalingPort Optional |
| refresh_period_seconds | int | refreshPeriodSeconds Optional |
| max_consecutive_failures | int | maxConsecutiveFailures Optional |
| max_response_wait_time_milliseconds | int | maxResponseWaitTimeMilliseconds Optional |
| enable_announcement_suppression | bool | enableAnnouncementSuppression Optional |
| service_access_code_list_name | str | serviceAccessCodeListName Optional |
SystemBroadWorksMobilityModifyRequest(OCIRequest)
Modify the BroadWorks Mobility system parameters.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemBroadWorksMobilityModifyRequest17sp4().
Attributes:
| Name | Type | Description |
|---|---|---|
| enable_location_services | bool | enableLocationServices Optional |
| enable_msrn_lookup | bool | enableMSRNLookup Optional |
| enable_mobile_state_checking | bool | enableMobileStateChecking Optional |
| deny_call_originations | bool | denyCallOriginations Optional |
| deny_call_terminations | bool | denyCallTerminations Optional |
| imrn_timeout_milliseconds | int | imrnTimeoutMilliseconds Optional |
| scf_signaling_ip_address | str | scfSignalingIPAddress Optional |
| scf_signaling_port | int | scfSignalingPort Optional |
SystemBroadWorksMobilityModifyRequest17sp4(OCIRequest)
Modify the BroadWorks Mobility system parameters.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by
SystemBroadWorksMobilityModifyRequest21().
Attributes:
| Name | Type | Description |
|---|---|---|
| enable_location_services | bool | enableLocationServices Optional |
| enable_msrn_lookup | bool | enableMSRNLookup Optional |
| enable_mobile_state_checking | bool | enableMobileStateChecking Optional |
| deny_call_originations | bool | denyCallOriginations Optional |
| deny_call_terminations | bool | denyCallTerminations Optional |
| imrn_timeout_milliseconds | int | imrnTimeoutMilliseconds Optional |
| scf_signaling_net_address | str | scfSignalingNetAddress Optional |
| scf_signaling_port | int | scfSignalingPort Optional |
| refresh_period_seconds | int | refreshPeriodSeconds Optional |
| max_consecutive_failures | int | maxConsecutiveFailures Optional |
| max_response_wait_time_milliseconds | int | maxResponseWaitTimeMilliseconds Optional |
| enable_announcement_suppression | bool | enableAnnouncementSuppression Optional |
SystemBroadWorksMobilityModifyRequest21(OCIRequest)
Modify the BroadWorks Mobility system parameters.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enable_location_services | bool | enableLocationServices Optional |
| enable_msrn_lookup | bool | enableMSRNLookup Optional |
| enable_mobile_state_checking | bool | enableMobileStateChecking Optional |
| deny_call_originations | bool | denyCallOriginations Optional |
| deny_call_terminations | bool | denyCallTerminations Optional |
| imrn_timeout_milliseconds | int | imrnTimeoutMilliseconds Optional |
| enable_internal_clid_delivery | bool | enableInternalCLIDDelivery Optional |
| include_redirect_for_mobility_termination | bool | includeRedirectForMobilityTermination Optional |
| enable_internal_clid_delivery_access_locations | bool | enableInternalCLIDDeliveryAccessLocations Optional |
| enable_enhanced_unreachable_state_checking | bool | enableEnhancedUnreachableStateChecking Optional |
| enable_network_call_barring_status_check | bool | enableNetworkCallBarringStatusCheck Optional |
| network_translation_index | str | networkTranslationIndex Optional |
SystemBroadWorksMobilityServiceAccessCodeAddRequest(OCIRequest)
Add a system service access code.
The response is either SuccessResponse() or ErrorResponse(). Replaced by
SystemBroadWorksMobilityServiceAccessCodeAddRequest21().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_access_code | str | serviceAccessCode |
| country_code | str | countryCode |
| description | str | description Optional |
SystemBroadWorksMobilityServiceAccessCodeAddRequest21(OCIRequest)
Add a service access code to a list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_access_code_list_name | str | serviceAccessCodeListName |
| country_code | str | countryCode |
| service_access_code | str | serviceAccessCode |
| description | str | description Optional |
SystemBroadWorksMobilityServiceAccessCodeDeleteRequest(OCIRequest)
Delete a system service access code.
The response is either SuccessResponse() or ErrorResponse(). Replaced by
SystemBroadWorksMobilityServiceAccessCodeDeleteRequest21().
Attributes:
| Name | Type | Description |
|---|---|---|
| country_code | str | countryCode |
| service_access_code | str | serviceAccessCode |
SystemBroadWorksMobilityServiceAccessCodeDeleteRequest21(OCIRequest)
Delete a service access code from a list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_access_code_list_name | str | serviceAccessCodeListName |
| country_code | str | countryCode |
| service_access_code | str | serviceAccessCode |
SystemBroadWorksMobilityServiceAccessCodeGetListRequest(OCIRequest)
Get a list of system service access codes.
The response is either SystemBroadWorksMobilityServiceAccessCodeGetListResponse() or
ErrorResponse(). Replaced by
SystemBroadWorksMobilityServiceAccessCodeGetListRequest21().
SystemBroadWorksMobilityServiceAccessCodeGetListRequest21(OCIRequest)
Get a list of system service access codes.
The response is either SystemBroadWorksMobilityServiceAccessCodeGetListResponse21()
or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_access_code_list_name | str | serviceAccessCodeListName |
SystemBroadWorksMobilityServiceAccessCodeListAddRequest(OCIRequest)
Add a Service Access Code list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemBroadWorksMobilityServiceAccessCodeListDeleteRequest(OCIRequest)
Delete a Service Access Code list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemBroadWorksMobilityServiceAccessCodeListGetListRequest(OCIRequest)
Get the list of Service Access Code lists.
The response is either
SystemBroadWorksMobilityServiceAccessCodeListGetListResponse() or ErrorResponse().
SystemBroadWorksMobilityServiceAccessCodeListModifyRequest(OCIRequest)
Modify a Service Access Code list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| new_name | str | newName Optional |
SystemBroadWorksMobilityServiceAccessCodeListUsageGetRequest(OCIRequest)
Get all the Mobile Networks using a given Service Access Code list.
The response is either
SystemBroadWorksMobilityServiceAccessCodeListUsageGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_access_code_list_name | str | serviceAccessCodeListName |
SystemBroadWorksMobilityServiceAccessCodeModifyRequest(OCIRequest)
Modify a system service access code.
The response is either SuccessResponse() or ErrorResponse(). Replaced by
SystemBroadWorksMobilityServiceAccessCodeModifyRequest21().
Attributes:
| Name | Type | Description |
|---|---|---|
| country_code | str | countryCode |
| service_access_code | str | serviceAccessCode |
| description | str | description Optional |
SystemBroadWorksMobilityServiceAccessCodeModifyRequest21(OCIRequest)
Modify a service access code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_access_code_list_name | str | serviceAccessCodeListName |
| country_code | str | countryCode |
| service_access_code | str | serviceAccessCode |
| description | str | description Optional |
SystemBroadWorksReceptionistEnterpriseGetRequest(OCIRequest)
Request to get the list of BroadWorks Receptionist - Enterprise parameters.
The response is either SystemBroadWorksReceptionistEnterpriseGetResponse() or
ErrorResponse().
SystemBroadWorksReceptionistEnterpriseModifyRequest(OCIRequest)
Request to modify BroadWorks Receptionist - Enterprise settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| max_monitored_users | int | maxMonitoredUsers Optional |
SystemBusyLampFieldGetRequest(OCIRequest)
Request the system level data associated with the Busy Lamp Field service.
The response is either a SystemBusyLampFieldGetResponse() or an ErrorResponse().
SystemBusyLampFieldGetRequest18(OCIRequest)
Request the system level data associated with the Busy Lamp Field service.
The response is either a SystemBusyLampFieldGetResponse18() or an ErrorResponse().
Replaced by: SystemBusyLampFieldGetRequest23() in AS data mode.
SystemBusyLampFieldGetRequest22(OCIRequest)
Request the system level data associated with the Busy Lamp Field service.
The response is either a SystemBusyLampFieldGetResponse22() or an ErrorResponse().
Replaced by: SystemBusyLampFieldGetRequest23V2() in AS data mode.
SystemBusyLampFieldGetRequest23(OCIRequest)
Request the system level data associated with the Busy Lamp Field service.
The response is either a SystemBusyLampFieldGetResponse23() or an ErrorResponse().
Replaced by: SystemBusyLampFieldGetRequest23V2() in AS data mode.
SystemBusyLampFieldGetRequest23V2(OCIRequest)
Request the system level data associated with the Busy Lamp Field service.
The response is either a SystemBusyLampFieldGetResponse23V2() or an
ErrorResponse().
SystemBusyLampFieldModifyRequest(OCIRequest)
Modify the system level data associated with the Busy Lamp Field Service.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: forceUseOfTCP The following elements are only
used in AS data mode and ignored in XS data mode: enableRedundancy
redundancyTaskDelayMilliseconds redundancyTaskIntervalMilliseconds
maxNumberOfSubscriptionsPerRedundancyTaskInterval The following elements are only used
in AS data mode and ignored in XS data mode: ignoreUnansweredTerminatingCalls
Attributes:
| Name | Type | Description |
|---|---|---|
| display_local_user_identity_last_name_first | bool | displayLocalUserIdentityLastNameFirst Optional |
| force_use_of_tcp | bool | forceUseOfTCP Optional |
| enable_redundancy | bool | enableRedundancy Optional |
| redundancy_task_delay_milliseconds | int | redundancyTaskDelayMilliseconds Optional |
| redundancy_task_interval_milliseconds | int | redundancyTaskIntervalMilliseconds Optional |
| max_number_of_subscriptions_per_redundancy_task_interval | int | maxNumberOfSubscriptionsPerRedundancyTaskInterval Optional |
| ignore_unanswered_terminating_calls | bool | ignoreUnansweredTerminatingCalls Optional |
SystemBwDiameterBaseDataGetRequest(OCIRequest)
Requests the list of System Diameter base parameters.
The response is either SystemBwDiameterBaseDataGetResponse() or ErrorResponse().
SystemBwDiameterBaseDataGetRequest17sp3(OCIRequest)
Requests the list of System Diameter base parameters.
The response is either SystemBwDiameterBaseDataGetResponse17sp3() or
ErrorResponse().
SystemBwDiameterBaseDataGetRequest22(OCIRequest)
Requests the list of System Diameter base parameters.
The response is either SystemBwDiameterBaseDataGetResponse22() or ErrorResponse().
SystemBwDiameterBaseDataModifyRequest(OCIRequest)
Modifies the System Diameter base parameters.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| xs_realm | str | xsRealm Optional |
| xs_listening_port | int | xsListeningPort Optional |
| xs_listening_port_enabled | bool | xsListeningPortEnabled Optional |
| xs_listening_secure_port | int | xsListeningSecurePort Optional |
| xs_listening_secure_port_enabled | bool | xsListeningSecurePortEnabled Optional |
| ps_realm | str | psRealm Optional |
| ps_listening_port | int | psListeningPort Optional |
| ps_listening_port_enabled | bool | psListeningPortEnabled Optional |
| ps_listening_secure_port | int | psListeningSecurePort Optional |
| ps_listening_secure_port_enabled | bool | psListeningSecurePortEnabled Optional |
| ps_relay_through_xs | bool | psRelayThroughXs Optional |
| xs_relay_listening_port | int | xsRelayListeningPort Optional |
| tc_timer_seconds | int | tcTimerSeconds Optional |
| tw_timer_seconds | int | twTimerSeconds Optional |
| request_timer_seconds | int | requestTimerSeconds Optional |
| busy_peer_detection_outstanding_txn_count | int | busyPeerDetectionOutstandingTxnCount Optional |
| busy_peer_restore_outstanding_txn_count | int | busyPeerRestoreOutstandingTxnCount Optional |
| dynamic_entry_inactivity_timer_hours | int | dynamicEntryInactivityTimerHours Optional |
| advertised_offline_billing_application | str | advertisedOfflineBillingApplication Optional |
| advertised_online_billing_application | str | advertisedOnlineBillingApplication Optional |
| default_port | int | defaultPort Optional |
| default_secure_port | int | defaultSecurePort Optional |
| peer_discovery_mode | str | peerDiscoveryMode Optional |
SystemBwDiameterPeerAddRequest(OCIRequest)
Add a static entry in the Diameter Peer Table.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| instance | str | instance |
| identity | str | identity |
| ip_address | str | ipAddress Optional |
| port | int | port |
| enabled | bool | enabled |
SystemBwDiameterPeerAddRequest22(OCIRequest)
Add a static entry in the Diameter Peer Table.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| instance | str | instance |
| identity | str | identity |
| ip_address | str | ipAddress Optional |
| port | int | port |
| enabled | bool | enabled |
| secure | bool | secure |
SystemBwDiameterPeerDeleteRequest(OCIRequest)
Remove a Diameter peer.
A peer cannot be removed if is referenced by a Realm Routing Table entry.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| instance | str | instance |
| identity | str | identity |
SystemBwDiameterPeerGetListRequest(OCIRequest)
Requests the list of Diameter peers.
The response is either SystemBwDiameterPeerGetListResponse22() or ErrorResponse()
SystemBwDiameterPeerModifyRequest(OCIRequest)
Modifies the attributes of an entry in the Diameter Peer Table.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| instance | str | instance |
| identity | str | identity |
| ip_address | str | ipAddress Optional |
| port | int | port Optional |
| enabled | bool | enabled Optional |
| secure | bool | secure Optional |
SystemBwDiameterRoutingPeerAddRequest(OCIRequest)
Add a Diameter routing peer.
The realm must refer to a Diameter routing realm whose action is relay. The destinationPeerIdentity must refer to an existing Diameter peer whose mode is active.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| instance | str | instance |
| realm | str | realm |
| application_id | str | applicationId |
| identity | str | identity |
| priority | int | priority |
| weight | int | weight |
SystemBwDiameterRoutingPeerDeleteRequest(OCIRequest)
Remove a Diameter routing peer.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| instance | str | instance |
| realm | str | realm |
| application_id | str | applicationId |
| identity | str | identity |
SystemBwDiameterRoutingPeerGetListRequest(OCIRequest)
Requests the list of Diameter routing peers associated with the specified realm.
The response is either SystemBwDiameterRoutingPeerGetListResponse() or
ErrorResponse().
SystemBwDiameterRoutingPeerModifyRequest(OCIRequest)
Modify a Diameter routing peer.
The realm must refer to a Diameter routing realm whose action is relay. The destinationPeerIdentity must refer to an existing Diameter peer whose mode is active.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| instance | str | instance |
| realm | str | realm |
| application_id | str | applicationId |
| identity | str | identity |
| priority | int | priority Optional |
| weight | int | weight Optional |
SystemBwDiameterRoutingRealmAddRequest(OCIRequest)
Add a static entry in the Realm Routing Table.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| instance | str | instance |
| realm | str | realm |
| application_id | str | applicationId |
| default | bool | default |
SystemBwDiameterRoutingRealmDeleteRequest(OCIRequest)
Delete a static entry in the Realm Routing Table.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| instance | str | instance |
| realm | str | realm |
| application_id | str | applicationId |
SystemBwDiameterRoutingRealmGetListRequest(OCIRequest)
Requests the list of Diameter routing realms.
The response is either SystemBwDiameterRoutingRealmGetListResponse() or
ErrorResponse().
SystemBwDiameterRoutingRealmModifyRequest(OCIRequest)
Modify a static entry in the Realm Routing Table.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| instance | str | instance |
| realm | str | realm |
| application_id | str | applicationId |
| default | bool | default Optional |
SystemCLIDDeliveryPrefixAddListRequest(OCIRequest)
Request to add one or more prefixes to the list of prefixes to be matched.
Matched prefixes will result in CLID delivery for Korea. Prefix 00X must be sent using uppercase X.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| prefix | List[str] | prefix |
SystemCLIDDeliveryPrefixDeleteListRequest(OCIRequest)
Request to delete one or more prefixes from the system.
Prefix 00X must be sent using uppercase X.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| prefix | List[str] | prefix |
SystemCLIDDeliveryPrefixGetListRequest(OCIRequest)
Request to get the list of provisioned prefixes in the system.
The response is either a SystemCLIDDeliveryPrefixGetListResponse() or an
ErrorResponse().
SystemCPEConfigAddFileServerRequest(OCIRequest)
Add a device CPE config file server.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: SystemCPEConfigAddFileServerRequest14sp6()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| ftp_host_net_address | str | ftpHostNetAddress |
| ftp_user_id | str | ftpUserId |
| ftp_user_password | str | ftpUserPassword |
| cpe_file_directory | str | cpeFileDirectory Optional |
| passive_ftp | bool | passiveFTP Optional |
SystemCPEConfigAddFileServerRequest14sp6(OCIRequest)
Add a device CPE config file server.
The following elements are only used in AS data mode: extendedCaptureFileRepositoryName
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_repository_name | str | fileRepositoryName |
| cpe_file_directory | str | cpeFileDirectory Optional |
| extended_capture_file_repository_name | str | extendedCaptureFileRepositoryName Optional |
SystemCPEConfigDeleteFileServerRequest(OCIRequest)
Delete a device CPE config file server.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemCPEConfigGetFileServerListRequest(OCIRequest)
Requests the list of device CPE config file servers.
The response is either SystemCPEConfigGetFileServerListResponse() or
ErrorResponse().
Replaced By: SystemCPEConfigGetFileServerListRequest14sp6()
SystemCPEConfigGetFileServerListRequest14sp6(OCIRequest)
Requests the list of device CPE config file servers.
The response is either SystemCPEConfigGetFileServerListResponse14sp6() or
ErrorResponse().
SystemCPEConfigModifyFileServerRequest(OCIRequest)
Modify a device CPE config file server.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: SystemCPEConfigModifyFileServerRequest14sp6()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| ftp_host_net_address | str | ftpHostNetAddress Optional |
| ftp_user_id | str | ftpUserId Optional |
| ftp_user_password | str | ftpUserPassword Optional |
| cpe_file_directory | str | cpeFileDirectory Optional |
| passive_ftp | bool | passiveFTP Optional |
SystemCPEConfigModifyFileServerRequest14sp6(OCIRequest)
Modify a device CPE config file server.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_repository_name | str | fileRepositoryName Optional |
| cpe_file_directory | str | cpeFileDirectory Optional |
| extended_capture_file_repository_name | str | extendedCaptureFileRepositoryName Optional |
SystemCPEConfigParametersGetRequest(OCIRequest)
Request to get the list of CPE Config system parameters.
The response is either SystemCPEConfigParametersGetResponse() or ErrorResponse().
Replaced By: SystemCPEConfigParametersGetRequest14sp6()
SystemCPEConfigParametersGetRequest14sp6(OCIRequest)
Request to get the list of CPE Config system parameters.
The response is either SystemCPEConfigParametersGetResponse14sp6() or
ErrorResponse(). Replaced by: SystemCPEConfigParametersGetRequest20()
SystemCPEConfigParametersGetRequest20(OCIRequest)
Request to get the list of CPE Config system parameters.
The response is either SystemCPEConfigParametersGetResponse20() or
ErrorResponse(). Replaced by: SystemCPEConfigParametersGetRequest21()
SystemCPEConfigParametersGetRequest21(OCIRequest)
Request to get the list of CPE Config system parameters.
The response is either SystemCPEConfigParametersGetResponse21() or
ErrorResponse().
SystemCPEConfigParametersModifyRequest(OCIRequest)
Request to modify CPE Config system parameters.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
SystemCPEConfigParametersModifyRequest20().
Attributes:
| Name | Type | Description |
|---|---|---|
| enable_ip_device_management | bool | enableIPDeviceManagement Optional |
| ftp_connect_timeout_seconds | int | ftpConnectTimeoutSeconds Optional |
| ftp_file_transfer_timeout_seconds | int | ftpFileTransferTimeoutSeconds Optional |
| pause_between_file_rebuild_milliseconds | int | pauseBetweenFileRebuildMilliseconds Optional |
| max_busy_time_minutes | int | maxBusyTimeMinutes Optional |
| device_access_app_server_cluster_name | str | deviceAccessAppServerClusterName Optional |
| file_rebuild_immediate | OCI.fileRebuildImmediate | fileRebuildImmediate Optional |
| file_rebuild_daily | OCI.fileRebuildDaily | fileRebuildDaily Optional |
| file_rebuild_hourly | OCI.fileRebuildHourly | fileRebuildHourly Optional |
SystemCPEConfigParametersModifyRequest20(OCIRequest)
Request to modify CPE Config system parameters.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
SystemCPEConfigParametersModifyRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| enable_ip_device_management | bool | enableIPDeviceManagement Optional |
| ftp_connect_timeout_seconds | int | ftpConnectTimeoutSeconds Optional |
| ftp_file_transfer_timeout_seconds | int | ftpFileTransferTimeoutSeconds Optional |
| pause_between_file_rebuild_milliseconds | int | pauseBetweenFileRebuildMilliseconds Optional |
| max_busy_time_minutes | int | maxBusyTimeMinutes Optional |
| device_access_app_server_cluster_name | str | deviceAccessAppServerClusterName Optional |
SystemCPEConfigParametersModifyRequest21(OCIRequest)
Request to modify CPE Config system parameters.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in the AS data mode and ignored in the XS data mode:
allowDeviceCredentialsRetrieval
Attributes:
| Name | Type | Description |
|---|---|---|
| enable_ip_device_management | bool | enableIPDeviceManagement Optional |
| ftp_connect_timeout_seconds | int | ftpConnectTimeoutSeconds Optional |
| ftp_file_transfer_timeout_seconds | int | ftpFileTransferTimeoutSeconds Optional |
| pause_between_file_rebuild_milliseconds | int | pauseBetweenFileRebuildMilliseconds Optional |
| device_access_app_server_cluster_name | str | deviceAccessAppServerClusterName Optional |
| min_time_between_reset_milliseconds | int | minTimeBetweenResetMilliseconds Optional |
| always_push_files_on_rebuild | bool | alwaysPushFilesOnRebuild Optional |
| max_file_operation_retry_attempts | int | maxFileOperationRetryAttempts Optional |
| enable_auto_rebuild_config | bool | enableAutoRebuildConfig Optional |
| event_queue_size | int | eventQueueSize Optional |
| allow_device_credentials_retrieval | bool | allowDeviceCredentialsRetrieval Optional |
SystemCPEConfigRebuildConfigFileRequest(OCIRequest)
Rebuild the system default config file for the specified device type.
If the device type is not specified, all files for all device types in the system are rebuilt.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType Optional |
| rebuild_type | str | rebuildType Optional |
| force | bool | force Optional |
SystemCPEConfigRebuildDeviceConfigFileRequest(OCIRequest)
Rebuild the config file for a specified device.
The following elements are only used in AS data mode: force
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| force | bool | force Optional |
SystemCPEConfigReorderDeviceLinePortsRequest(OCIRequest)
Reorder the lines of a System device.
You can not add or delete line ports, only re-ordering the list is allowed. The
ordered list of line ports can be obtained with the SystemAccessDeviceGetRequest16()
command.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| ordered_line_port_list | List[str] | orderedLinePortList |
SystemCPEConfigResetDeviceRequest(OCIRequest)
Reset a specific system device.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemCPEConfigResetDeviceTypeRequest(OCIRequest)
Reset all the devices of the specified device type in the system.
If the device type is not specified, all device in the system are reset.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType Optional |
SystemCPEConfigSetConfigFileRequest(OCIRequest)
Request to set a new system default configuration file for a device type.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| config_file | str | configFile |
SystemCallCenterEnhancedReportingBrandingGetRequest(OCIRequest)
Request to get the system branding information.
The response is either SystemCallCenterEnhancedReportingBrandingGetResponse() or
ErrorResponse().
SystemCallCenterEnhancedReportingDataTemplateGetListRequest(OCIRequest)
Request to get the list of data template and the corresponding information in the system.
The response is either a
SystemCallCenterEnhancedReportingDataTemplateGetListResponse() or an
ErrorResponse().
SystemCallCenterEnhancedReportingGetRequest(OCIRequest)
Request to get the call center enhanced reporting system settings.
The response is either a SystemCallCenterEnhancedReportingGetResponse() or an
ErrorResponse().
SystemCallCenterEnhancedReportingModifyRequest(OCIRequest)
Modify the system settings for call center enhanced reporting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| archive_reports | bool | archiveReports Optional |
| report_application_url | str | reportApplicationURL Optional |
| repository_application_url | str | repositoryApplicationURL Optional |
SystemCallCenterEnhancedReportingReportTemplateDeleteRequest(OCIRequest)
Request to delete a system level call center report template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCallCenterEnhancedReportingReportTemplateGetListRequest(OCIRequest)
Request to get system level call center report template list.
The response is either a
SystemCallCenterEnhancedReportingReportTemplateGetListResponse() or an
ErrorResponse().
SystemCallCenterEnhancedReportingReportTemplateGetRequest(OCIRequest)
Request to get a system level call center report template.
The response is either a
SystemCallCenterEnhancedReportingReportTemplateGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCallCenterEnhancedReportingScheduledReportGetReportTemplateUsageListRequest(OCIRequest)
Request to get all the call center reporting scheduled report in the system that uses a given system level report template.
The response is either a
SystemCallCenterEnhancedReportingScheduledReportGetReportTemplateUsageListResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCallCenterEnhancedReportingScheduledTaskParametersGetRequest(OCIRequest)
Request to get the system settings for the call center enhanced reporting scheduling tasks.
The response is either a
SystemCallCenterEnhancedReportingScheduledTaskParametersGetResponse() or an
ErrorResponse(). Replaced by:
SystemCallCenterEnhancedReportingScheduledTaskParametersGetRequest22()
SystemCallCenterEnhancedReportingScheduledTaskParametersGetRequest22(OCIRequest)
Request to get the system settings for the call center enhanced reporting scheduling tasks.
The response is either a
SystemCallCenterEnhancedReportingScheduledTaskParametersGetResponse22() or an
ErrorResponse(). Replaced by:
SystemCallCenterEnhancedReportingScheduledTaskParametersGetRequest25().
SystemCallCenterEnhancedReportingScheduledTaskParametersGetRequest25(OCIRequest)
Request to get the system settings for the call center enhanced reporting scheduling tasks.
The response is either a
SystemCallCenterEnhancedReportingScheduledTaskParametersGetResponse25() or an
ErrorResponse().
SystemCallCenterEnhancedReportingScheduledTaskParametersModifyRequest(OCIRequest)
Modify the system settings for the call center enhanced reporting scheduling tasks.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| scheduled_report_search_interval_minutes | int | scheduledReportSearchIntervalMinutes Optional |
| maximum_scheduled_reports_per_interval | int | maximumScheduledReportsPerInterval Optional |
| delete_scheduled_report_days_after_completion | int | deleteScheduledReportDaysAfterCompletion Optional |
| call_center_event_mode | str | callCenterEventMode Optional |
| use_dialed_address_for_remote_number | bool | useDialedAddressForRemoteNumber Optional |
SystemCallCenterEventRecordingFileParametersGetRequest(OCIRequest)
Request to get the list of Call Center Event Recording File system parameters.
The response is either SystemCallCenterEventRecordingFileParametersGetResponse() or
ErrorResponse().
SystemCallCenterEventRecordingFileParametersModifyRequest(OCIRequest)
Request to modify Call Center Event Recording File system parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| file_retention_time_days | int | fileRetentionTimeDays Optional |
| file_rotation_period_minutes | str | fileRotationPeriodMinutes Optional |
| file_rotation_offset_minutes | int | fileRotationOffsetMinutes Optional |
| remote_url | str | remoteUrl Optional |
| remote_user_id | str | remoteUserId Optional |
| remote_password | str | remotePassword Optional |
SystemCallCenterGetRequest(OCIRequest)
Request the system level data associated with Call Center.
The response is either a SystemCallCenterGetResponse() or an ErrorResponse().
Replaced By: SystemCallCenterGetRequest14sp9()
SystemCallCenterGetRequest14sp9(OCIRequest)
Request the system level data associated with Call Center.
The response is either a SystemCallCenterGetResponse14sp9() or an ErrorResponse().
Replaced By: SystemCallCenterGetRequest16()
SystemCallCenterGetRequest16(OCIRequest)
Request the system level data associated with Call Center.
The response is either a SystemCallCenterGetResponse16() or an ErrorResponse().
Replaced by: SystemCallCenterGetRequest17()
SystemCallCenterGetRequest17(OCIRequest)
Request the system level data associated with Call Center.
The response is either a SystemCallCenterGetResponse17() or an ErrorResponse().
Replaced by SystemCallCenterGetRequest17sp4().
SystemCallCenterGetRequest17sp4(OCIRequest)
Request the system level data associated with Call Center.
The response is either a SystemCallCenterGetResponse17sp4() or an ErrorResponse().
Replaced by: SystemCallCenterGetRequest19()
SystemCallCenterGetRequest19(OCIRequest)
Request the system level data associated with Call Center.
The response is either a SystemCallCenterGetResponse19() or an ErrorResponse().
Replaced by SystemCallCenterGetRequest21().
SystemCallCenterGetRequest21(OCIRequest)
Request the system level data associated with Call Center.
The response is either a SystemCallCenterGetResponse21() or an ErrorResponse().
SystemCallCenterModifyRequest(OCIRequest)
Modify the system level data associated with Call Center.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| default_from_address | str | defaultFromAddress Optional |
| statistics_sampling_period_minutes | int | statisticsSamplingPeriodMinutes Optional |
| default_enable_guard_timer | bool | defaultEnableGuardTimer Optional |
| default_guard_timer_seconds | int | defaultGuardTimerSeconds Optional |
| force_agent_unavailable_on_dnd_activation | bool | forceAgentUnavailableOnDNDActivation Optional |
| force_agent_unavailable_on_personal_calls | bool | forceAgentUnavailableOnPersonalCalls Optional |
| force_agent_unavailable_on_bounced_call_limit | bool | forceAgentUnavailableOnBouncedCallLimit Optional |
| number_consecutive_bounced_calls_to_force_agent_unavailable | int | numberConsecutiveBouncedCallsToForceAgentUnavailable Optional |
| force_agent_unavailable_on_not_reachable | bool | forceAgentUnavailableOnNotReachable Optional |
| default_play_ring_when_offer_call | bool | defaultPlayRingWhenOfferCall Optional |
| uniform_call_distribution_policy_scope | str | uniformCallDistributionPolicyScope Optional |
| call_handling_sampling_period_minutes | int | callHandlingSamplingPeriodMinutes Optional |
| call_handling_minimum_sampling_size | int | callHandlingMinimumSamplingSize Optional |
| play_tone_to_agent_for_emergency_call | bool | playToneToAgentForEmergencyCall Optional |
| emergency_call_clid_prefix | str | emergencyCallCLIDPrefix Optional |
| threshold_crossing_notification_email_guard_timer_seconds | int | thresholdCrossingNotificationEmailGuardTimerSeconds Optional |
| allow_agent_device_initiated_forward | bool | allowAgentDeviceInitiatedForward Optional |
SystemCallCenterReportingServerGetListRequest(OCIRequest)
Request to get a list of Call Center Reporting Server.
The response is either SystemCallCenterReportingServerGetListResponse() or
ErrorResponse().
SystemCallMeNowGetRequest(OCIRequest)
Request the system level data associated with Call Me Now service.
The response is either a SystemCallMeNowGetResponse() or an ErrorResponse().
SystemCallMeNowModifyRequest(OCIRequest)
Modify the system level data associated with Call me now service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| passcode_length | int | passcodeLength Optional |
| passcode_timeout_seconds | int | passcodeTimeoutSeconds Optional |
SystemCallNotifyGetRequest(OCIRequest)
Request the system level data associated with Call Notify.
The response is either a SystemCallNotifyGetResponse() or an ErrorResponse().
SystemCallNotifyModifyRequest(OCIRequest)
Modify the system level data associated with Call Notify.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| default_from_address | str | defaultFromAddress Optional |
| use_short_subject_line | bool | useShortSubjectLine Optional |
| use_dn_in_mail_body | bool | useDnInMailBody Optional |
SystemCallProcessingGetPolicyRequest14(OCIRequest)
Request the system level data associated with Call Processing Policy.
The response is either a SystemCallProcessingGetPolicyResponse14() or an
ErrorResponse().
SystemCallProcessingGetPolicyRequest14sp1(OCIRequest)
Request the system level data associated with Call Processing Policy.
The response is either a SystemCallProcessingGetPolicyResponse14sp1() or an
ErrorResponse().
SystemCallProcessingGetPolicyRequest14sp4(OCIRequest)
Request the system level data associated with Call Processing Policy.
The response is either a SystemCallProcessingGetPolicyResponse14sp4() or an
ErrorResponse().
Replaced By : SystemCallProcessingGetPolicyRequest15()
SystemCallProcessingGetPolicyRequest14sp7(OCIRequest)
Request the system level data associated with Call Processing Policy.
The response is either a SystemCallProcessingGetPolicyResponse14sp7() or an
ErrorResponse().
Replaced By: SystemCallProcessingGetPolicyRequest16()
SystemCallProcessingGetPolicyRequest15(OCIRequest)
Request the system level data associated with Call Processing Policy.
The response is either a SystemCallProcessingGetPolicyResponse15() or an
ErrorResponse().
Replaced By: SystemCallProcessingGetPolicyRequest15sp2()
SystemCallProcessingGetPolicyRequest15sp2(OCIRequest)
Request the system level data associated with Call Processing Policy.
The response is either a SystemCallProcessingGetPolicyResponse15sp2() or an
ErrorResponse().
SystemCallProcessingGetPolicyRequest16(OCIRequest)
Request the system level data associated with Call Processing Policy.
The response is either a SystemCallProcessingGetPolicyResponse16() or an
ErrorResponse().
SystemCallProcessingGetPolicyRequest16sp2(OCIRequest)
Request the system level data associated with Call Processing Policy.
The response is either a SystemCallProcessingGetPolicyResponse16sp2() or an
ErrorResponse().
SystemCallProcessingGetPolicyRequest17(OCIRequest)
The response is either a SystemCallProcessingGetPolicyResponse17() or an
ErrorResponse().
SystemCallProcessingGetPolicyRequest17sp3(OCIRequest)
Request the system level data associated with Call Processing Policy.
The response is either a SystemCallProcessingGetPolicyResponse17sp3() or an
ErrorResponse(). Replaced by: SystemCallProcessingGetPolicyRequest17sp4()
SystemCallProcessingGetPolicyRequest17sp4(OCIRequest)
The response is either a SystemCallProcessingGetPolicyResponse17sp4() or an
ErrorResponse().
Replaced By : SystemCallProcessingGetPolicyRequest18sp1()
SystemCallProcessingGetPolicyRequest18sp1(OCIRequest)
The response is either a SystemCallProcessingGetPolicyResponse18sp1() or an
ErrorResponse().
Replaced by: SystemCallProcessingGetPolicyRequest19sp1()
SystemCallProcessingGetPolicyRequest19sp1(OCIRequest)
The response is either a SystemCallProcessingGetPolicyResponse19sp1() or an
ErrorResponse().
Replaced by: SystemCallProcessingGetPolicyRequest21sp1()
SystemCallProcessingGetPolicyRequest21sp1(OCIRequest)
The response is either a SystemCallProcessingGetPolicyResponse21sp1() or an
ErrorResponse().
Replaced by: SystemCallProcessingGetPolicyRequest1sp2().
SystemCallProcessingGetPolicyRequest21sp2(OCIRequest)
The response is either a SystemCallProcessingGetPolicyResponse21sp2() or an
ErrorResponse().
Replaced by: SystemCallProcessingGetPolicyRequest22() in AS data mode.
SystemCallProcessingGetPolicyRequest22(OCIRequest)
The response is either a SystemCallProcessingGetPolicyResponse22() or an
ErrorResponse().
Replaced by: SystemCallProcessingGetPolicyRequest22V2() in AS data mode.
SystemCallProcessingGetPolicyRequest22V2(OCIRequest)
The response is either a SystemCallProcessingGetPolicyResponse22V2() or an
ErrorResponse().
Replaced by: SystemCallProcessingGetPolicyRequest23() in AS data mode.
SystemCallProcessingGetPolicyRequest22V3(OCIRequest)
The response is either a SystemCallProcessingGetPolicyResponse22V3() or an
ErrorResponse().
Replaced by: SystemCallProcessingGetPolicyResponse23V2() in AS data mode.
SystemCallProcessingGetPolicyRequest23(OCIRequest)
The response is either a SystemCallProcessingGetPolicyResponse23() or an
ErrorResponse().
Replaced by: SystemCallProcessingGetPolicyRequest23V2() in AS data mode.
SystemCallProcessingGetPolicyRequest23V2(OCIRequest)
The response is either a SystemCallProcessingGetPolicyResponse22V3() or an
ErrorResponse().
Replaced By: SystemCallProcessingGetPolicyRequest24()
SystemCallProcessingGetPolicyRequest23V3(OCIRequest)
The response is either a SystemCallProcessingGetPolicyResponse23V3() or an
ErrorResponse().
Replaced By: SystemCallProcessingGetPolicyRequest24V2()
SystemCallProcessingGetPolicyRequest24(OCIRequest)
The response is either a SystemCallProcessingGetPolicyResponse24() or an
ErrorResponse().
Replaced By: SystemCallProcessingGetPolicyRequest24V2()
SystemCallProcessingGetPolicyRequest24V2(OCIRequest)
The response is either a SystemCallProcessingGetPolicyResponse24V2() or an
ErrorResponse().
SystemCallProcessingModifyPolicyRequest14(OCIRequest)
Modify the system level data associated with Call Processing Policy.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By : SystemCallProcessingModifyPolicyRequest15()
Attributes:
| Name | Type | Description |
|---|---|---|
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| media_policy_selection | str | mediaPolicySelection Optional |
| supported_media_set_name | str | supportedMediaSetName Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_external_calls_via_private_dialing_plan | bool | overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| conference_uri | str | conferenceURI Optional |
| max_conference_parties | int | maxConferenceParties Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_max_concurrent_find_me_follow_me_invocations | bool | useMaxConcurrentFindMeFollowMeInvocations Optional |
| max_concurrent_find_me_follow_me_invocations | int | maxConcurrentFindMeFollowMeInvocations Optional |
| clid_policy | str | clidPolicy Optional |
| emergency_clid_policy | str | emergencyClidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
SystemCallProcessingModifyPolicyRequest15(OCIRequest)
Modify the system level data associated with Call Processing Policy.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: enableDialableCallerID
allowConfigurableCLIDForRedirectingIdentity The following elements are only used in AS
data mode and ignored in XS data mode: maxConferenceParties enablePhoneListLookup
useMaxConcurrentTerminatingAlertingRequests maxConcurrentTerminatingAlertingRequests
delayTimerToRemoveCancelledCallsInSeconds
includeRedirectionsInMaximumNumberOfConcurrentCalls
useUserPhoneNumberForGroupCallsWhenInternalClidUnavailable
useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable
allowMobileDNForRedirectingIdentity conferenceDisableClampTones useMaxCallsPerSecond
maxCallsPerSecond forceTreatmentOnMaxRedirectionDepth
enableUserSelectionOfExternalCLIDPolicy enableUserConfigurableCLIDModification The
following elements are only used in XS data mode and ignored in AS data mode:
routeOverrideDomain routeOverridePrefix
Attributes:
| Name | Type | Description |
|---|---|---|
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| media_policy_selection | str | mediaPolicySelection Optional |
| supported_media_set_name | str | supportedMediaSetName Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_enterprise_clid_for_private_call_category | bool | useEnterpriseCLIDForPrivateCallCategory Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| conference_uri | str | conferenceURI Optional |
| max_conference_parties | int | maxConferenceParties Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_max_concurrent_find_me_follow_me_invocations | bool | useMaxConcurrentFindMeFollowMeInvocations Optional |
| max_concurrent_find_me_follow_me_invocations | int | maxConcurrentFindMeFollowMeInvocations Optional |
| clid_policy | str | clidPolicy Optional |
| emergency_clid_policy | str | emergencyClidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
| enable_dialable_caller_id | bool | enableDialableCallerID Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| enterprise_group_calls_clid_policy | str | enterpriseGroupCallsCLIDPolicy Optional |
| service_provider_group_calls_clid_policy | str | serviceProviderGroupCallsCLIDPolicy Optional |
| enable_phone_list_lookup | bool | enablePhoneListLookup Optional |
| use_max_concurrent_terminating_alerting_requests | bool | useMaxConcurrentTerminatingAlertingRequests Optional |
| max_concurrent_terminating_alerting_requests | int | maxConcurrentTerminatingAlertingRequests Optional |
| delay_timer_to_remove_cancelled_calls_in_seconds | int | delayTimerToRemoveCancelledCallsInSeconds Optional |
| include_redirections_in_maximum_number_of_concurrent_calls | bool | includeRedirectionsInMaximumNumberOfConcurrentCalls Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
| route_override_domain | str | routeOverrideDomain Optional |
| route_override_prefix | str | routeOverridePrefix Optional |
| allow_mobile_dn_for_redirecting_identity | bool | allowMobileDNForRedirectingIdentity Optional |
| conference_disable_clamp_tones | bool | conferenceDisableClampTones Optional |
| use_max_calls_per_second | bool | useMaxCallsPerSecond Optional |
| max_calls_per_second | int | maxCallsPerSecond Optional |
| force_treatment_on_max_redirection_depth | bool | forceTreatmentOnMaxRedirectionDepth Optional |
| enable_user_selection_of_external_clid_policy | bool | enableUserSelectionOfExternalCLIDPolicy Optional |
| enable_user_configurable_clid_modification | bool | enableUserConfigurableCLIDModification Optional |
SystemCallProcessingPolicyProfileAddRequest(OCIRequest)
Add a call processing policy profile to system.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by
SystemCallProcessingPolicyProfileAddRequest20().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| description | str | description Optional |
| assigned_subscriber_type | List[str] | assignedSubscriberType Optional |
SystemCallProcessingPolicyProfileAddRequest20(OCIRequest)
Add a call processing policy profile to system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| description | str | description Optional |
| assigned_subscriber_type | List[str] | assignedSubscriberType Optional |
SystemCallProcessingPolicyProfileAddRequest21(OCIRequest)
Add a call processing policy profile to system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| description | str | description Optional |
| assigned_subscriber_type | List[str] | assignedSubscriberType Optional |
SystemCallProcessingPolicyProfileAutoAttendantProfileGetRequest(OCIRequest)
Request to get the configuration for a call processing policy profile Auto Attendant subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileAutoAttendantProfileGetRequestResponse() or an
ErrorResponse(). The response contains the call processing policy profile setting
for Auto Attendant. Replaced by:
SystemCallProcessingPolicyProfileAutoAttendantProfileGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileAutoAttendantProfileGetRequest22(OCIRequest)
Request to get the configuration for a call processing policy profile Auto Attendant subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileAutoAttendantProfileGetRequestResponse22() or an
ErrorResponse(). The response contains the call processing policy profile setting
for Auto Attendant. Replaced by:
SystemCallProcessingPolicyProfileAutoAttendantProfileGetRequest22V2() in AS data
mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileAutoAttendantProfileGetRequest22V2(OCIRequest)
Request to get the configuration for a call processing policy profile Auto Attendant subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileAutoAttendantProfileGetRequestResponse22V2() or an
ErrorResponse(). The response contains the call processing policy profile setting
for Auto Attendant.
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileAutoAttendantProfileModifyRequest(OCIRequest)
Modify a call processing policy profile auto attendant subscriber type profile in system.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
useMaxCallsPerSecond maxCallsPerSecond
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
| use_clid_policy | bool | useCLIDPolicy Optional |
| clid_policy | str | clidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
| use_group_name | bool | useGroupName Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| allow_department_clid_name_override | bool | allowDepartmentCLIDNameOverride Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| enterprise_group_calls_clid_policy | str | enterpriseGroupCallsCLIDPolicy Optional |
| service_provider_group_calls_clid_policy | str | serviceProviderGroupCallsCLIDPolicy Optional |
| use_call_limits_policy | bool | useCallLimitsPolicy Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_translation_routing_policy | bool | useTranslationRoutingPolicy Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_enterprise_clid_for_private_call_category | bool | useEnterpriseCLIDForPrivateCallCategory Optional |
| use_incoming_clid_policy | bool | useIncomingCLIDPolicy Optional |
| enable_dialable_caller_id | bool | enableDialableCallerID Optional |
| include_redirections_in_maximum_number_of_concurrent_calls | bool | includeRedirectionsInMaximumNumberOfConcurrentCalls Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
| use_max_calls_per_second | bool | useMaxCallsPerSecond Optional |
| max_calls_per_second | int | maxCallsPerSecond Optional |
SystemCallProcessingPolicyProfileBroadWorksAnywhereProfileGetRequest(OCIRequest)
Request to get the configuration for a call processing policy profile BroadWorks Anywhere subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileBroadWorksAnywhereProfileGetRequestResponse() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileBroadWorksAnywhereProfileGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileBroadWorksAnywhereProfileGetRequest22(OCIRequest)
Request to get the configuration for a call processing policy profile BroadWorks Anywhere subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileBroadWorksAnywhereProfileGetRequestResponse22() or
an ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileBroadWorksAnywhereProfileGetRequest22() in AS data
mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileBroadWorksAnywhereProfileGetRequest22V2(OCIRequest)
Request to get the configuration for a call processing policy profile BroadWorks Anywhere subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileBroadWorksAnywhereProfileGetRequestResponse22V2()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileBroadWorksAnywhereProfileModifyRequest(OCIRequest)
Modify a call processing policy profile broadworks anywhare subscriber type profile in system.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
useMaxCallsPerSecond maxCallsPerSecond
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
| use_clid_policy | bool | useCLIDPolicy Optional |
| clid_policy | str | clidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
| use_group_name | bool | useGroupName Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| allow_department_clid_name_override | bool | allowDepartmentCLIDNameOverride Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| enterprise_group_calls_clid_policy | str | enterpriseGroupCallsCLIDPolicy Optional |
| service_provider_group_calls_clid_policy | str | serviceProviderGroupCallsCLIDPolicy Optional |
| use_call_limits_policy | bool | useCallLimitsPolicy Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_translation_routing_policy | bool | useTranslationRoutingPolicy Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_enterprise_clid_for_private_call_category | bool | useEnterpriseCLIDForPrivateCallCategory Optional |
| use_incoming_clid_policy | bool | useIncomingCLIDPolicy Optional |
| enable_dialable_caller_id | bool | enableDialableCallerID Optional |
| include_redirections_in_maximum_number_of_concurrent_calls | bool | includeRedirectionsInMaximumNumberOfConcurrentCalls Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
| use_max_calls_per_second | bool | useMaxCallsPerSecond Optional |
| max_calls_per_second | int | maxCallsPerSecond Optional |
SystemCallProcessingPolicyProfileCallCenterProfileGetRequest(OCIRequest)
Request to get the configuration for a call processing policy profile Call Center subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileCallCenterProfileGetRequestResponse() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileCallCenterProfileGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileCallCenterProfileGetRequest22(OCIRequest)
Request to get the configuration for a call processing policy profile Call Center subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileCallCenterProfileGetRequestResponse22() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileCallCenterProfileGetRequest22V2() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileCallCenterProfileGetRequest22V2(OCIRequest)
Request to get the configuration for a call processing policy profile Call Center subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileCallCenterProfileGetRequestResponse22V2() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileCallCenterProfileModifyRequest(OCIRequest)
Modify a call processing policy profile call center subscriber type profile in system.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
useMaxCallsPerSecond maxCallsPerSecond
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
| use_clid_policy | bool | useCLIDPolicy Optional |
| clid_policy | str | clidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
| use_group_name | bool | useGroupName Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| allow_department_clid_name_override | bool | allowDepartmentCLIDNameOverride Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| enterprise_group_calls_clid_policy | str | enterpriseGroupCallsCLIDPolicy Optional |
| service_provider_group_calls_clid_policy | str | serviceProviderGroupCallsCLIDPolicy Optional |
| use_call_limits_policy | bool | useCallLimitsPolicy Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| use_max_concurrent_find_me_follow_me_invocations | bool | useMaxConcurrentFindMeFollowMeInvocations Optional |
| max_concurrent_find_me_follow_me_invocations | int | maxConcurrentFindMeFollowMeInvocations Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_translation_routing_policy | bool | useTranslationRoutingPolicy Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_incoming_clid_policy | bool | useIncomingCLIDPolicy Optional |
| enable_dialable_caller_id | bool | enableDialableCallerID Optional |
| include_redirections_in_maximum_number_of_concurrent_calls | bool | includeRedirectionsInMaximumNumberOfConcurrentCalls Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
| use_max_calls_per_second | bool | useMaxCallsPerSecond Optional |
| max_calls_per_second | int | maxCallsPerSecond Optional |
SystemCallProcessingPolicyProfileCollaborateProfileGetRequest(OCIRequest)
Request to get the configuration for a call processing policy profile Collaborate subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileCollaborateProfileGetResponse() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileCollaborateProfileGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileCollaborateProfileGetRequest22(OCIRequest)
Request to get the configuration for a call processing policy profile Collaborate subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileCollaborateProfileGetResponse22() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileCollaborateProfileGetRequest22V2() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileCollaborateProfileGetRequest22V2(OCIRequest)
Request to get the configuration for a call processing policy profile Collaborate subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileCollaborateProfileGetResponse22V2() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileCollaborateProfileModifyRequest(OCIRequest)
Request to get to modify the call processing policy profile collaborate subscriber type profile.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
useMaxCallsPerSecond maxCallsPerSecond
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
| use_clid_policy | bool | useCLIDPolicy Optional |
| clid_policy | str | clidPolicy Optional |
| emergency_clid_policy | str | emergencyClidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
| use_group_name | bool | useGroupName Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| allow_department_clid_name_override | bool | allowDepartmentCLIDNameOverride Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| enterprise_group_calls_clid_policy | str | enterpriseGroupCallsCLIDPolicy Optional |
| service_provider_group_calls_clid_policy | str | serviceProviderGroupCallsCLIDPolicy Optional |
| use_call_limits_policy | bool | useCallLimitsPolicy Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_translation_routing_policy | bool | useTranslationRoutingPolicy Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_enterprise_clid_for_private_call_category | bool | useEnterpriseCLIDForPrivateCallCategory Optional |
| use_incoming_clid_policy | bool | useIncomingCLIDPolicy Optional |
| enable_dialable_caller_id | bool | enableDialableCallerID Optional |
| include_redirections_in_maximum_number_of_concurrent_calls | bool | includeRedirectionsInMaximumNumberOfConcurrentCalls Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
| use_max_calls_per_second | bool | useMaxCallsPerSecond Optional |
| max_calls_per_second | int | maxCallsPerSecond Optional |
SystemCallProcessingPolicyProfileDeleteRequest(OCIRequest)
Delete a call processing policy profile from system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCallProcessingPolicyProfileFindMeFollowMeProfileGetRequest(OCIRequest)
Request to get the configuration for a call processing policy profile Find-me/Follow- me subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileFindMeFollowMeProfileGetResponse() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileFindMeFollowMeProfileGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileFindMeFollowMeProfileGetRequest22(OCIRequest)
Request to get the configuration for a call processing policy profile Find-me/Follow- me subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileFindMeFollowMeProfileGetResponse22() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileFindMeFollowMeProfileGetRequest22V2() in AS data
mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileFindMeFollowMeProfileGetRequest22V2(OCIRequest)
Request to get the configuration for a call processing policy profile Find-me/Follow- me subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileFindMeFollowMeProfileGetResponse22V2() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileFindMeFollowMeProfileModifyRequest(OCIRequest)
Modify a call processing policy profile find-me/follow-me subscriber type profile in system.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
useMaxCallsPerSecond maxCallsPerSecond
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
| use_clid_policy | bool | useCLIDPolicy Optional |
| clid_policy | str | clidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
| use_group_name | bool | useGroupName Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| allow_department_clid_name_override | bool | allowDepartmentCLIDNameOverride Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| enterprise_group_calls_clid_policy | str | enterpriseGroupCallsCLIDPolicy Optional |
| service_provider_group_calls_clid_policy | str | serviceProviderGroupCallsCLIDPolicy Optional |
| use_call_limits_policy | bool | useCallLimitsPolicy Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_concurrent_find_me_follow_me_invocations | bool | useMaxConcurrentFindMeFollowMeInvocations Optional |
| max_concurrent_find_me_follow_me_invocations | int | maxConcurrentFindMeFollowMeInvocations Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_translation_routing_policy | bool | useTranslationRoutingPolicy Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_incoming_clid_policy | bool | useIncomingCLIDPolicy Optional |
| enable_dialable_caller_id | bool | enableDialableCallerID Optional |
| include_redirections_in_maximum_number_of_concurrent_calls | bool | includeRedirectionsInMaximumNumberOfConcurrentCalls Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
| use_max_calls_per_second | bool | useMaxCallsPerSecond Optional |
| max_calls_per_second | int | maxCallsPerSecond Optional |
SystemCallProcessingPolicyProfileFlexibleSeatingHostProfileGetRequest(OCIRequest)
Request to get the configuration for a call processing policy profile Flexible Seating Host subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileFlexibleSeatingHostProfileGetResponse() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileFlexibleSeatingHostProfileGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileFlexibleSeatingHostProfileGetRequest22(OCIRequest)
Request to get the configuration for a call processing policy profile Flexible Seating Host subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileFlexibleSeatingHostProfileGetResponse() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileFlexibleSeatingHostProfileGetRequest22V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileFlexibleSeatingHostProfileGetRequest22V2(OCIRequest)
Request to get the configuration for a call processing policy profile Flexible Seating Host subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileFlexibleSeatingHostProfileGetResponse22V2() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileFlexibleSeatingHostProfileModifyRequest(OCIRequest)
Modify a call processing policy profile flexible seating host subscriber type profile in system.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
useMaxCallsPerSecond maxCallsPerSecond
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
| use_clid_policy | bool | useCLIDPolicy Optional |
| clid_policy | str | clidPolicy Optional |
| emergency_clid_policy | str | emergencyClidPolicy Optional |
| use_group_name | bool | useGroupName Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| allow_department_clid_name_override | bool | allowDepartmentCLIDNameOverride Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| enterprise_group_calls_clid_policy | str | enterpriseGroupCallsCLIDPolicy Optional |
| service_provider_group_calls_clid_policy | str | serviceProviderGroupCallsCLIDPolicy Optional |
| use_call_limits_policy | bool | useCallLimitsPolicy Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| use_translation_routing_policy | bool | useTranslationRoutingPolicy Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_enterprise_clid_for_private_call_category | bool | useEnterpriseCLIDForPrivateCallCategory Optional |
| include_redirections_in_maximum_number_of_concurrent_calls | bool | includeRedirectionsInMaximumNumberOfConcurrentCalls Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
| use_max_calls_per_second | bool | useMaxCallsPerSecond Optional |
| max_calls_per_second | int | maxCallsPerSecond Optional |
SystemCallProcessingPolicyProfileGetAssignedNCOSListRequest(OCIRequest)
Request a list of NCOSs that have a given CallP Policy Profile assigned.
The response is either a
SystemCallProcessingPolicyProfileGetAssignedNCOSListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| profile_name | str | profileName |
SystemCallProcessingPolicyProfileGetListRequest(OCIRequest)
Get the list of all Call Processing Policy Profiles.
The response is either a SystemCallProcessingPolicyProfileGetListResponse() or an
ErrorResponse().
SystemCallProcessingPolicyProfileGetRequest(OCIRequest)
Request to get a call processing policy profile in system.
The response is either a SystemCallProcessingPolicyProfileGetResponse() or an
ErrorResponse(). Replaced by SystemCallProcessingPolicyProfileGetRequest20().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCallProcessingPolicyProfileGetRequest20(OCIRequest)
Request to get a call processing policy profile in system.
The response is either a SystemCallProcessingPolicyProfileGetResponse20() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCallProcessingPolicyProfileGetRequest21(OCIRequest)
Request to get a call processing policy profile in system.
The response is either a SystemCallProcessingPolicyProfileGetResponse21() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCallProcessingPolicyProfileGroupPagingProfileGetRequest(OCIRequest)
Request to get the configuration for a call processing policy profile Group Paging subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileGroupPagingProfileGetResponse() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileGroupPagingProfileGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileGroupPagingProfileGetRequest22(OCIRequest)
Request to get the configuration for a call processing policy profile Group Paging subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileGroupPagingProfileGetResponse22() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileGroupPagingProfileModifyRequest(OCIRequest)
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
| use_clid_policy | bool | useCLIDPolicy Optional |
| clid_policy | str | clidPolicy Optional |
| use_group_name | bool | useGroupName Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| allow_department_clid_name_override | bool | allowDepartmentCLIDNameOverride Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| enterprise_group_calls_clid_policy | str | enterpriseGroupCallsCLIDPolicy Optional |
| service_provider_group_calls_clid_policy | str | serviceProviderGroupCallsCLIDPolicy Optional |
| use_call_limits_policy | bool | useCallLimitsPolicy Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_translation_routing_policy | bool | useTranslationRoutingPolicy Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
SystemCallProcessingPolicyProfileHuntGroupProfileGetRequest(OCIRequest)
Request to get the configuration for a call processing policy profile Hunt Group subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileHuntGroupProfileGetResponse() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileHuntGroupProfileGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileHuntGroupProfileGetRequest22(OCIRequest)
Request to get the configuration for a call processing policy profile Hunt Group subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileHuntGroupProfileGetResponse22() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileHuntGroupProfileGetRequest22V2().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileHuntGroupProfileGetRequest22V2(OCIRequest)
Request to get the configuration for a call processing policy profile Hunt Group subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileHuntGroupProfileGetResponse22V2() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileHuntGroupProfileModifyRequest(OCIRequest)
Modify a call processing policy profile hunt group subscriber type profile in system.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
useMaxCallsPerSecond maxCallsPerSecond
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
| use_clid_policy | bool | useCLIDPolicy Optional |
| clid_policy | str | clidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
| use_group_name | bool | useGroupName Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| allow_department_clid_name_override | bool | allowDepartmentCLIDNameOverride Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| enterprise_group_calls_clid_policy | str | enterpriseGroupCallsCLIDPolicy Optional |
| service_provider_group_calls_clid_policy | str | serviceProviderGroupCallsCLIDPolicy Optional |
| use_call_limits_policy | bool | useCallLimitsPolicy Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_concurrent_find_me_follow_me_invocations | bool | useMaxConcurrentFindMeFollowMeInvocations Optional |
| max_concurrent_find_me_follow_me_invocations | int | maxConcurrentFindMeFollowMeInvocations Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_translation_routing_policy | bool | useTranslationRoutingPolicy Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_incoming_clid_policy | bool | useIncomingCLIDPolicy Optional |
| enable_dialable_caller_id | bool | enableDialableCallerID Optional |
| include_redirections_in_maximum_number_of_concurrent_calls | bool | includeRedirectionsInMaximumNumberOfConcurrentCalls Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
| use_max_calls_per_second | bool | useMaxCallsPerSecond Optional |
| max_calls_per_second | int | maxCallsPerSecond Optional |
SystemCallProcessingPolicyProfileInstantGroupCallProfileGetRequest(OCIRequest)
Request to get the configuration for a call processing policy profile Instant Group Call subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileInstantGroupCallProfileGetResponse22() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileInstantGroupCallProfileGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileInstantGroupCallProfileGetRequest22(OCIRequest)
Request to get the configuration for a call processing policy profile Instant Group Call subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileInstantGroupCallProfileGetResponse22() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileInstantGroupCallProfileModifyRequest(OCIRequest)
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
| use_clid_policy | bool | useCLIDPolicy Optional |
| clid_policy | str | clidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
| use_group_name | bool | useGroupName Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| allow_department_clid_name_override | bool | allowDepartmentCLIDNameOverride Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| enterprise_group_calls_clid_policy | str | enterpriseGroupCallsCLIDPolicy Optional |
| service_provider_group_calls_clid_policy | str | serviceProviderGroupCallsCLIDPolicy Optional |
| use_call_limits_policy | bool | useCallLimitsPolicy Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_translation_routing_policy | bool | useTranslationRoutingPolicy Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
SystemCallProcessingPolicyProfileMeetMeConferencingProfileGetRequest(OCIRequest)
Request to get the configuration for a call processing policy profile Meet-Me Conferencing subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileMeetMeConferencingProfileGetResponse() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileMeetMeConferencingProfileGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileMeetMeConferencingProfileGetRequest22(OCIRequest)
Request to get the configuration for a call processing policy profile Meet-Me Conferencing subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileMeetMeConferencingProfileGetResponse22() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileMeetMeConferencingProfileGetRequest22V2().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileMeetMeConferencingProfileGetRequest22V2(OCIRequest)
Request to get the configuration for a call processing policy profile Meet-Me Conferencing subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileMeetMeConferencingProfileGetResponse22V2() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileMeetMeConferencingProfileModifyRequest(OCIRequest)
Modify a call processing policy profile meet-me conferencing subscriber type profile in system.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
useMaxCallsPerSecond maxCallsPerSecond
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
| use_clid_policy | bool | useCLIDPolicy Optional |
| clid_policy | str | clidPolicy Optional |
| emergency_clid_policy | str | emergencyClidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
| use_group_name | bool | useGroupName Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| allow_department_clid_name_override | bool | allowDepartmentCLIDNameOverride Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| enterprise_group_calls_clid_policy | str | enterpriseGroupCallsCLIDPolicy Optional |
| service_provider_group_calls_clid_policy | str | serviceProviderGroupCallsCLIDPolicy Optional |
| use_call_limits_policy | bool | useCallLimitsPolicy Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_translation_routing_policy | bool | useTranslationRoutingPolicy Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_enterprise_clid_for_private_call_category | bool | useEnterpriseCLIDForPrivateCallCategory Optional |
| use_incoming_clid_policy | bool | useIncomingCLIDPolicy Optional |
| enable_dialable_caller_id | bool | enableDialableCallerID Optional |
| include_redirections_in_maximum_number_of_concurrent_calls | bool | includeRedirectionsInMaximumNumberOfConcurrentCalls Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
| use_max_calls_per_second | bool | useMaxCallsPerSecond Optional |
| max_calls_per_second | int | maxCallsPerSecond Optional |
SystemCallProcessingPolicyProfileRoutePointProfileGetRequest(OCIRequest)
Request to get the configuration for a call processing policy profile Route Point subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileRoutePointProfileGetResponse() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileRoutePointProfileGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileRoutePointProfileGetRequest22(OCIRequest)
Request to get the configuration for a call processing policy profile Route Point subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileRoutePointProfileGetResponse22() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileRoutePointProfileGetRequest22V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileRoutePointProfileGetRequest22V2(OCIRequest)
Request to get the configuration for a call processing policy profile Route Point subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileRoutePointProfileGetResponse22V2() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileRoutePointProfileModifyRequest(OCIRequest)
Modify a call processing policy profile route point subscriber type profile in system.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
useMaxCallsPerSecond maxCallsPerSecond
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
| use_clid_policy | bool | useCLIDPolicy Optional |
| clid_policy | str | clidPolicy Optional |
| emergency_clid_policy | str | emergencyClidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
| use_group_name | bool | useGroupName Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| allow_department_clid_name_override | bool | allowDepartmentCLIDNameOverride Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| enterprise_group_calls_clid_policy | str | enterpriseGroupCallsCLIDPolicy Optional |
| service_provider_group_calls_clid_policy | str | serviceProviderGroupCallsCLIDPolicy Optional |
| use_call_limits_policy | bool | useCallLimitsPolicy Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_concurrent_find_me_follow_me_invocations | bool | useMaxConcurrentFindMeFollowMeInvocations Optional |
| max_concurrent_find_me_follow_me_invocations | int | maxConcurrentFindMeFollowMeInvocations Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_translation_routing_policy | bool | useTranslationRoutingPolicy Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_enterprise_clid_for_private_call_category | bool | useEnterpriseCLIDForPrivateCallCategory Optional |
| use_incoming_clid_policy | bool | useIncomingCLIDPolicy Optional |
| enable_dialable_caller_id | bool | enableDialableCallerID Optional |
| include_redirections_in_maximum_number_of_concurrent_calls | bool | includeRedirectionsInMaximumNumberOfConcurrentCalls Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
| use_max_calls_per_second | bool | useMaxCallsPerSecond Optional |
| max_calls_per_second | int | maxCallsPerSecond Optional |
SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetRequest(OCIRequest)
Request to get the configuration for a call processing policy profile Trunk Group Pilot user subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetResponse() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetRequest22(OCIRequest)
Request to get the configuration for a call processing policy profile Trunk Group Pilot user subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetResponse22() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetRequest22V2() in AS data
mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetRequest22V2(OCIRequest)
Request to get the configuration for a call processing policy profile Trunk Group Pilot user subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetResponse22V2() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetRequest22V3() in AS data
mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetRequest22V3(OCIRequest)
Request to get the configuration for a call processing policy profile Trunk Group Pilot user subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetResponse22V3() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileTrunkGroupPilotProfileModifyRequest(OCIRequest)
Modify a call processing policy profile trunk group pilot subscriber type profile in system.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
useMaxCallsPerSecond maxCallsPerSecond
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
| use_clid_policy | bool | useCLIDPolicy Optional |
| clid_policy | str | clidPolicy Optional |
| emergency_clid_policy | str | emergencyClidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
| use_group_name | bool | useGroupName Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| allow_department_clid_name_override | bool | allowDepartmentCLIDNameOverride Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| enterprise_group_calls_clid_policy | str | enterpriseGroupCallsCLIDPolicy Optional |
| service_provider_group_calls_clid_policy | str | serviceProviderGroupCallsCLIDPolicy Optional |
| use_media_policy | bool | useMediaPolicy Optional |
| media_policy_selection | str | mediaPolicySelection Optional |
| supported_media_set_name | str | supportedMediaSetName Optional |
| use_call_limits_policy | bool | useCallLimitsPolicy Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| use_max_concurrent_find_me_follow_me_invocations | bool | useMaxConcurrentFindMeFollowMeInvocations Optional |
| max_concurrent_find_me_follow_me_invocations | int | maxConcurrentFindMeFollowMeInvocations Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_translation_routing_policy | bool | useTranslationRoutingPolicy Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_enterprise_clid_for_private_call_category | bool | useEnterpriseCLIDForPrivateCallCategory Optional |
| use_incoming_clid_policy | bool | useIncomingCLIDPolicy Optional |
| enable_dialable_caller_id | bool | enableDialableCallerID Optional |
| use_max_concurrent_terminating_alerting_requests | bool | useMaxConcurrentTerminatingAlertingRequests Optional |
| max_concurrent_terminating_alerting_requests | int | maxConcurrentTerminatingAlertingRequests Optional |
| include_redirections_in_maximum_number_of_concurrent_calls | bool | includeRedirectionsInMaximumNumberOfConcurrentCalls Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
| allow_mobile_dn_for_redirecting_identity | bool | allowMobileDNForRedirectingIdentity Optional |
| use_max_calls_per_second | bool | useMaxCallsPerSecond Optional |
| max_calls_per_second | int | maxCallsPerSecond Optional |
SystemCallProcessingPolicyProfileUserProfileGetRequest(OCIRequest)
Request to get the configuration for a call processing policy profile user subscriber type profile.
The response is either a SystemCallProcessingPolicyProfileUserProfileGetResponse()
or an ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileUserProfileGetRequest21sp1() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileUserProfileGetRequest21sp1(OCIRequest)
Request to get the configuration for a call processing policy profile user subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileUserProfileGetResponse21sp1() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileUserProfileGetRequest22() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileUserProfileGetRequest22(OCIRequest)
Request to get the configuration for a call processing policy profile user subscriber type profile.
The response is either a SystemCallProcessingPolicyProfileUserProfileGetResponse22()
or an ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileUserProfileGetRequest22V2() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileUserProfileGetRequest22V2(OCIRequest)
Request to get the configuration for a call processing policy profile user subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileUserProfileGetResponse22V2() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileUserProfileGetRequest22V2() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileUserProfileGetRequest22V3(OCIRequest)
Request to get the configuration for a call processing policy profile user subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileUserProfileGetResponse22V3() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileUserProfileModifyRequest(OCIRequest)
Modify a call processing policy profile user subscriber type profile in system.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
useMaxCallsPerSecond maxCallsPerSecond
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
| use_clid_policy | bool | useCLIDPolicy Optional |
| clid_policy | str | clidPolicy Optional |
| emergency_clid_policy | str | emergencyClidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
| use_group_name | bool | useGroupName Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| allow_department_clid_name_override | bool | allowDepartmentCLIDNameOverride Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| enterprise_group_calls_clid_policy | str | enterpriseGroupCallsCLIDPolicy Optional |
| service_provider_group_calls_clid_policy | str | serviceProviderGroupCallsCLIDPolicy Optional |
| use_media_policy | bool | useMediaPolicy Optional |
| media_policy_selection | str | mediaPolicySelection Optional |
| supported_media_set_name | str | supportedMediaSetName Optional |
| use_call_limits_policy | bool | useCallLimitsPolicy Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_concurrent_find_me_follow_me_invocations | bool | useMaxConcurrentFindMeFollowMeInvocations Optional |
| max_concurrent_find_me_follow_me_invocations | int | maxConcurrentFindMeFollowMeInvocations Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_translation_routing_policy | bool | useTranslationRoutingPolicy Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_enterprise_clid_for_private_call_category | bool | useEnterpriseCLIDForPrivateCallCategory Optional |
| use_incoming_clid_policy | bool | useIncomingCLIDPolicy Optional |
| enable_dialable_caller_id | bool | enableDialableCallerID Optional |
| use_phone_list_lookup_policy | bool | usePhoneListLookupPolicy Optional |
| enable_phone_list_lookup | bool | enablePhoneListLookup Optional |
| use_max_concurrent_terminating_alerting_requests | bool | useMaxConcurrentTerminatingAlertingRequests Optional |
| max_concurrent_terminating_alerting_requests | int | maxConcurrentTerminatingAlertingRequests Optional |
| include_redirections_in_maximum_number_of_concurrent_calls | bool | includeRedirectionsInMaximumNumberOfConcurrentCalls Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
| allow_mobile_dn_for_redirecting_identity | bool | allowMobileDNForRedirectingIdentity Optional |
| use_max_calls_per_second | bool | useMaxCallsPerSecond Optional |
| max_calls_per_second | int | maxCallsPerSecond Optional |
SystemCallProcessingPolicyProfileVoicePortalProfileGetRequest(OCIRequest)
Request to get the configuration for a call processing policy profile Voice Portal subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileVoicePortalProfileGetResponse() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileVoicePortalProfileGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileVoicePortalProfileGetRequest22(OCIRequest)
Request to get the configuration for a call processing policy profile Voice Portal subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileVoicePortalProfileGetResponse22() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileVoicePortalProfileGetRequest22V2().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileVoicePortalProfileGetRequest22V2(OCIRequest)
Request to get the configuration for a call processing policy profile Voice Portal subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileVoicePortalProfileGetResponse22V2() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileVoicePortalProfileModifyRequest(OCIRequest)
Modify a call processing policy profile voice portal type profile in system.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
useMaxCallsPerSecond maxCallsPerSecond
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
| use_clid_policy | bool | useCLIDPolicy Optional |
| clid_policy | str | clidPolicy Optional |
| use_group_name | bool | useGroupName Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| allow_department_clid_name_override | bool | allowDepartmentCLIDNameOverride Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| enterprise_group_calls_clid_policy | str | enterpriseGroupCallsCLIDPolicy Optional |
| service_provider_group_calls_clid_policy | str | serviceProviderGroupCallsCLIDPolicy Optional |
| use_call_limits_policy | bool | useCallLimitsPolicy Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_translation_routing_policy | bool | useTranslationRoutingPolicy Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| include_redirections_in_maximum_number_of_concurrent_calls | bool | includeRedirectionsInMaximumNumberOfConcurrentCalls Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
| use_max_calls_per_second | bool | useMaxCallsPerSecond Optional |
| max_calls_per_second | int | maxCallsPerSecond Optional |
SystemCallProcessingPolicyProfileVoiceXMLProfileGetRequest(OCIRequest)
Request to get the configuration for a call processing policy profile VoiceXML subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileVoiceXMLProfileGetResponse() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileVoiceXMLProfileGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileVoiceXMLProfileGetRequest22(OCIRequest)
Request to get the configuration for a call processing policy profile VoiceXML subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileVoiceXMLProfileGetResponse22() or an
ErrorResponse(). Replaced by:
SystemCallProcessingPolicyProfileVoiceXMLProfileGetRequest22V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileVoiceXMLProfileGetRequest22V2(OCIRequest)
Request to get the configuration for a call processing policy profile VoiceXML subscriber type profile.
The response is either a
SystemCallProcessingPolicyProfileVoiceXMLProfileGetResponse22V2() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
SystemCallProcessingPolicyProfileVoiceXMLProfileModifyRequest(OCIRequest)
Modify a call processing policy profile voice XML type profile in system.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
useMaxCallsPerSecond maxCallsPerSecond
Attributes:
| Name | Type | Description |
|---|---|---|
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName |
| use_clid_policy | bool | useCLIDPolicy Optional |
| clid_policy | str | clidPolicy Optional |
| emergency_clid_policy | str | emergencyClidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
| use_group_name | bool | useGroupName Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| allow_department_clid_name_override | bool | allowDepartmentCLIDNameOverride Optional |
| enterprise_calls_clid_policy | str | enterpriseCallsCLIDPolicy Optional |
| enterprise_group_calls_clid_policy | str | enterpriseGroupCallsCLIDPolicy Optional |
| service_provider_group_calls_clid_policy | str | serviceProviderGroupCallsCLIDPolicy Optional |
| use_call_limits_policy | bool | useCallLimitsPolicy Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_translation_routing_policy | bool | useTranslationRoutingPolicy Optional |
| network_usage_selection | str | networkUsageSelection Optional |
| enable_enterprise_extension_dialing | bool | enableEnterpriseExtensionDialing Optional |
| enforce_group_calling_line_identity_restriction | bool | enforceGroupCallingLineIdentityRestriction Optional |
| enforce_enterprise_calling_line_identity_restriction | bool | enforceEnterpriseCallingLineIdentityRestriction Optional |
| allow_enterprise_group_call_typing_for_private_dialing_plan | bool | allowEnterpriseGroupCallTypingForPrivateDialingPlan Optional |
| allow_enterprise_group_call_typing_for_public_dialing_plan | bool | allowEnterpriseGroupCallTypingForPublicDialingPlan Optional |
| override_clid_restriction_for_private_call_category | bool | overrideCLIDRestrictionForPrivateCallCategory Optional |
| use_enterprise_clid_for_private_call_category | bool | useEnterpriseCLIDForPrivateCallCategory Optional |
| use_incoming_clid_policy | bool | useIncomingCLIDPolicy Optional |
| enable_dialable_caller_id | bool | enableDialableCallerID Optional |
| include_redirections_in_maximum_number_of_concurrent_calls | bool | includeRedirectionsInMaximumNumberOfConcurrentCalls Optional |
| use_user_phone_number_for_group_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForGroupCallsWhenInternalCLIDUnavailable Optional |
| use_user_phone_number_for_enterprise_calls_when_internal_clid_unavailable | bool | useUserPhoneNumberForEnterpriseCallsWhenInternalCLIDUnavailable Optional |
| use_max_calls_per_second | bool | useMaxCallsPerSecond Optional |
| max_calls_per_second | int | maxCallsPerSecond Optional |
SystemCallRecordingAddPlatformRequest(OCIRequest)
Add a Call Recording platform.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemCallRecordingAddPlatformRequest19()
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| net_address | str | netAddress |
| port | int | port |
| media_stream | str | mediaStream |
| transport_type | str | transportType |
| description | str | description Optional |
SystemCallRecordingAddPlatformRequest19(OCIRequest)
Add a Call Recording platform.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemCallRecordingAddPlatformRequest20()
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| net_address | str | netAddress |
| port | int | port |
| media_stream | str | mediaStream |
| transport_type | str | transportType |
| description | str | description Optional |
| schema_version | str | schemaVersion |
SystemCallRecordingAddPlatformRequest20(OCIRequest)
Add a Call Recording platform.
The first system level call recording platform added is made the system default call recording platform. The first reseller level call recording platform added for a reseller is made the reseller default call recording platform.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemCallRecordingAddPlatformRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| net_address | str | netAddress |
| port | int | port Optional |
| media_stream | str | mediaStream |
| transport_type | str | transportType |
| description | str | description Optional |
| schema_version | str | schemaVersion |
| support_video_recording | bool | supportVideoRecording |
| reseller_id | str | resellerId Optional |
SystemCallRecordingAddPlatformRequest22(OCIRequest)
Add a Call Recording platform.
The first system level call recording platform added is made the system default call recording platform. In AS data mode, The first reseller level call recording platform added for a reseller is made the reseller default call recording platform.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| net_address | str | netAddress |
| port | int | port Optional |
| media_stream | str | mediaStream |
| transport_type | str | transportType |
| description | str | description Optional |
| schema_version | str | schemaVersion |
| support_video_recording | bool | supportVideoRecording |
| reseller_id | str | resellerId Optional |
| route | str | route Optional |
SystemCallRecordingDeletePlatformRequest(OCIRequest)
Delete a Call Recording platform.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCallRecordingGetPlatformListRequest(OCIRequest)
Get list of Call Recording platforms.
The response is either SystemCallRecordingGetPlatformListResponse() or
ErrorResponse(). The possible values for "Support Video Rec" can be either true or
false. Schema version values include: 1.0, 2.0, 3.0 Replaced by:
SystemCallRecordingGetPlatformListRequest20sp1() in AS data mode
SystemCallRecordingGetPlatformListRequest20sp1(OCIRequest)
Get list of Call Recording platforms.
The response is either SystemCallRecordingGetPlatformListResponse20sp1() or
ErrorResponse(). The possible values for "Support Video Rec" can be either true or
false. Schema version values include: 1.0, 2.0, 3.0 Replaced by
SystemCallRecordingGetPlatformListRequest22() in AS data mode.
SystemCallRecordingGetPlatformListRequest22(OCIRequest)
Requests the list of all system-level call recording platforms and all reseller level call recording platforms.
If an excludeReseller is specified, returns all the system-level call recording platforms only. If a resellerId is specified, returns all the system-level call recording platforms and the given reseller's call recording platforms. If a reseller administrator sends the request and resellerId is not specified, the administrator's resellerId is used.
The response is either SystemCallRecordingGetPlatformListResponse22() or
ErrorResponse(). Replaced by: SystemCallRecordingGetPlatformListRequest22V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| exclude_reseller | bool | excludeReseller Optional |
| reseller_id | str | resellerId Optional |
SystemCallRecordingGetPlatformListRequest22V2(OCIRequest)
Requests the list of all system-level call recording platforms and all reseller level call recording platforms.
If an excludeReseller is specified, returns all the system-level call recording platforms only. If a resellerId is specified, returns all the system-level call recording platforms and the given reseller's call recording platforms. If a reseller administrator sends the request and resellerId is not specified, the administrator's resellerId is used.
The response is either SystemCallRecordingGetPlatformListResponse22V2() or
ErrorResponse(). The following elements are only used in AS data mode and ignored in
XS data mode: excludeReseller resellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| exclude_reseller | bool | excludeReseller Optional |
| reseller_id | str | resellerId Optional |
SystemCallRecordingGetPlatformUsageRequest(OCIRequest)
Get the list of groups currently associated to the specified Call Recording platform.
The response is either SystemCallRecordingGetPlatformUsageResponse() or
ErrorResponse(). Replaced by SystemCallRecordingGetPlatformUsageRequest22() in AS
data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCallRecordingGetPlatformUsageRequest22(OCIRequest)
Get the list of groups currently associated to the specified Call Recording platform.
The response is either SystemCallRecordingGetPlatformUsageResponse22() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCallRecordingGetRequest(OCIRequest)
Request the system level data associated with Call Recording.
The response is either a SystemCallRecordingGetResponse() or an ErrorResponse().
Replaced by: SystemCallRecordingGetRequest22()
SystemCallRecordingGetRequest22(OCIRequest)
Request the system level data associated with Call Recording.
The response is either a SystemCallRecordingGetResponse22() or an ErrorResponse().
Replaced by: SystemCallRecordingGetRequest23()
SystemCallRecordingGetRequest23(OCIRequest)
Request the system level data associated with Call Recording.
The response is either a SystemCallRecordingGetResponse23() or an ErrorResponse().
SystemCallRecordingModifyPlatformRequest(OCIRequest)
Modify the specified Call Recording platform.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
becomeResellerDefault Replaced by: SystemCallRecordingModifyPlatformRequest22() in
AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| media_stream | str | mediaStream Optional |
| become_system_default | bool | becomeSystemDefault Optional |
| become_reseller_default | str | becomeResellerDefault Optional |
| transport_type | str | transportType Optional |
| description | str | description Optional |
| schema_version | str | schemaVersion Optional |
| support_video_recording | bool | supportVideoRecording Optional |
SystemCallRecordingModifyPlatformRequest22(OCIRequest)
Modify the specified Call Recording platform.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
becomeResellerDefault route
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| media_stream | str | mediaStream Optional |
| become_system_default | bool | becomeSystemDefault Optional |
| become_reseller_default | str | becomeResellerDefault Optional |
| transport_type | str | transportType Optional |
| description | str | description Optional |
| schema_version | str | schemaVersion Optional |
| support_video_recording | bool | supportVideoRecording Optional |
| route | str | route Optional |
SystemCallRecordingModifyRequest(OCIRequest)
Modify the system level data associated with Call Recording.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: SystemCallRecordingModifyRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| continue_call_after_recording_failure | bool | continueCallAfterRecordingFailure Optional |
| refresh_period_seconds | int | refreshPeriodSeconds Optional |
| max_consecutive_failures | int | maxConsecutiveFailures Optional |
| max_response_wait_time_milliseconds | int | maxResponseWaitTimeMilliseconds Optional |
| continue_call_after_video_recording_failure | bool | continueCallAfterVideoRecordingFailure Optional |
SystemCallRecordingModifyRequest22(OCIRequest)
Modify the system level data associated with Call Recording.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
continueCallAfterRecordingFailure maxResponseWaitTimeMilliseconds
continueCallAfterVideoRecordingFailure
useContinueCallAfterRecordingFailureForOnDemandMode
useContinueCallAfterRecordingFailureForOnDemandUserInitiatedStartMode
Attributes:
| Name | Type | Description |
|---|---|---|
| continue_call_after_recording_failure | bool | continueCallAfterRecordingFailure Optional |
| max_response_wait_time_milliseconds | int | maxResponseWaitTimeMilliseconds Optional |
| continue_call_after_video_recording_failure | bool | continueCallAfterVideoRecordingFailure Optional |
| use_continue_call_after_recording_failure_for_on_demand_mode | bool | useContinueCallAfterRecordingFailureForOnDemandMode Optional |
| use_continue_call_after_recording_failure_for_on_demand_user_initiated_start_mode | bool | useContinueCallAfterRecordingFailureForOnDemandUserInitiatedStartMode Optional |
| restrict_call_recording_provisioning_access | bool | restrictCallRecordingProvisioningAccess Optional |
SystemCallReturnGetRequest(OCIRequest)
Request the system level data associated with Call Return.
The response is either a SystemCallReturnGetResponse() or an ErrorResponse().
SystemCallReturnModifyRequest(OCIRequest)
Modify the system level data associated with Call Return.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| two_level_activation | bool | twoLevelActivation Optional |
| provide_date | bool | provideDate Optional |
| last_unanswered_call_only | bool | lastUnansweredCallOnly Optional |
| confirmation_key | str | confirmationKey Optional |
| allow_restricted_number | bool | allowRestrictedNumber Optional |
| delete_number_after_answered_call_return | bool | deleteNumberAfterAnsweredCallReturn Optional |
SystemCallTypeAddMappingRequest(OCIRequest)
Add a system call type mapping.
The response is either SuccessResponse() or ErrorResponse(). The following element
is used only in AS mode: ignoreASEmergencyRoute
Attributes:
| Name | Type | Description |
|---|---|---|
| country_code | str | countryCode |
| digit_map | str | digitMap |
| call_type | str | callType |
| ignore_as_emergency_route | bool | ignoreASEmergencyRoute Optional |
SystemCallTypeDeleteMappingRequest(OCIRequest)
Delete a system call type mapping.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| country_code | str | countryCode |
| digit_map | str | digitMap |
SystemCallTypeGetListRequest(OCIRequest)
Get a list of system call types.
The response is either SystemCallTypeGetListResponse() or ErrorResponse().
SystemCallTypeGetMappingListRequest(OCIRequest)
Get a list of system call type mappings.
The response is either SystemCallTypeGetMappingListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| country_code | str | countryCode Optional |
SystemCallTypeModifyMappingRequest(OCIRequest)
Modify the ignoreASEmergencyRoute entry of the specified country code, digitMap.
The response is either SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| country_code | str | countryCode |
| digit_map | str | digitMap |
| ignore_as_emergency_route | bool | ignoreASEmergencyRoute Optional |
SystemCallWaitingGetRequest(OCIRequest)
Request the system level data associated with Call Waiting.
The response is either a SystemCallWaitingGetResponse() or an ErrorResponse().
SystemCallWaitingModifyRequest(OCIRequest)
Modify the system level data associated with Call Waiting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| play_distinctive_ringback | bool | playDistinctiveRingback Optional |
SystemCallingNameRetrievalGetRequest14(OCIRequest)
Request the system's calling name retrieval attributes.
The response is either a SystemCallingNameRetrievalGetResponse14() or an
ErrorResponse().
SystemCallingNameRetrievalGetRequest16sp1(OCIRequest)
Request the system's calling name retrieval attributes.
The response is either a SystemCallingNameRetrievalGetResponse16sp1() or an
ErrorResponse(). Replaced by: SystemCallingNameRetrievalGetRequest17sp4()
SystemCallingNameRetrievalGetRequest17sp4(OCIRequest)
Request the system's calling name retrieval attributes.
The response is either a SystemCallingNameRetrievalGetResponse17sp4() or an
ErrorResponse(). Replaced by: SystemCallingNameRetrievalGetRequest24()
SystemCallingNameRetrievalGetRequest20(OCIRequest)
Request the system's calling name retrieval attributes.
The response is either a SystemCallingNameRetrievalGetResponse20() or an
ErrorResponse(). Replaced by: SystemCallingNameRetrievalGetRequest24()
SystemCallingNameRetrievalGetRequest24(OCIRequest)
Request the system's calling name retrieval attributes.
The response is either a SystemCallingNameRetrievalGetResponse24() or an
ErrorResponse().
SystemCallingNameRetrievalModifyRequest(OCIRequest)
Modifies the system's calling name retrieval attributes.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemCallingNameRetrievalModifyRequest16sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| query_timer_milli_seconds | int | queryTimerMilliSeconds Optional |
| server_net_address | str | serverNetAddress Optional |
| server_port | int | serverPort Optional |
| server_transport_protocol | str | serverTransportProtocol Optional |
SystemCallingNameRetrievalModifyRequest16sp1(OCIRequest)
Modifies the system's calling name retrieval attributes.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemCallingNameRetrievalModifyRequest20()
Attributes:
| Name | Type | Description |
|---|---|---|
| trigger_cnam_queries_for_all_network_calls | bool | triggerCNAMQueriesForAllNetworkCalls Optional |
| trigger_cnam_queries_for_group_and_enterprise_calls | bool | triggerCNAMQueriesForGroupAndEnterpriseCalls Optional |
| query_protocol | str | queryProtocol Optional |
| query_timeout_milliseconds | int | queryTimeoutMilliseconds Optional |
| sip_external_database_net_address | str | sipExternalDatabaseNetAddress Optional |
| sip_external_database_port | int | sipExternalDatabasePort Optional |
| sip_external_database_transport | str | sipExternalDatabaseTransport Optional |
| soap_external_database_net_address | str | soapExternalDatabaseNetAddress Optional |
| soap_supports_dnssrv | bool | soapSupportsDNSSRV Optional |
| calling_name_source | str | callingNameSource Optional |
SystemCallingNameRetrievalModifyRequest20(OCIRequest)
Modifies the system's calling name retrieval attributes.
The response is either a SuccessResponse() or an ErrorResponse(). The following
attributes are only used in AS data mode and ignored in XS data mode: -
triggerCNAMQueriesForAllNetworkCalls - triggerCNAMQueriesForGroupAndEnterpriseCalls -
queryProtocol - queryTimeoutMilliseconds - sipExternalDatabaseNetAddress -
sipExternalDatabasePort - sipExternalDatabaseTransport -
soapExternalDatabaseNetAddress - callingNameSource - routeAdvanceTimer -
retryFailedCNAMServerInterval - ignoreRestrictedPresentationIndicator - supportsDNSSRV
The following attributes are only used in XS data mode and ignored in AS data mode: -
callFilteringProvisioningEnabled
Attributes:
| Name | Type | Description |
|---|---|---|
| trigger_cnam_queries_for_all_network_calls | bool | triggerCNAMQueriesForAllNetworkCalls Optional |
| trigger_cnam_queries_for_group_and_enterprise_calls | bool | triggerCNAMQueriesForGroupAndEnterpriseCalls Optional |
| query_protocol | str | queryProtocol Optional |
| query_timeout_milliseconds | int | queryTimeoutMilliseconds Optional |
| sip_external_database_net_address | str | sipExternalDatabaseNetAddress Optional |
| sip_external_database_port | int | sipExternalDatabasePort Optional |
| sip_external_database_transport | str | sipExternalDatabaseTransport Optional |
| soap_external_database_net_address | str | soapExternalDatabaseNetAddress Optional |
| calling_name_source | str | callingNameSource Optional |
| route_advance_timer | int | routeAdvanceTimer Optional |
| retry_failed_cnam_server_interval | int | retryFailedCNAMServerInterval Optional |
| ignore_restricted_presentation_indicator | bool | ignoreRestrictedPresentationIndicator Optional |
| supports_dnssrv | bool | supportsDNSSRV Optional |
| call_filtering_provisioning_enabled | bool | callFilteringProvisioningEnabled Optional |
SystemCallingPartyCategoryAddRequest(OCIRequest)
Add a Calling Party Category to system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| category | str | category |
| cpc_value | str | cpcValue Optional |
| isup_oli_value | int | isupOliValue Optional |
| gtd_oli_value | str | gtdOliValue Optional |
| user_category | bool | userCategory |
| pay_phone | bool | payPhone |
| operator | bool | operator |
| default | bool | default |
| collect_call | bool | collectCall |
| web_display_key | str | webDisplayKey Optional |
SystemCallingPartyCategoryDeleteRequest(OCIRequest)
Delete a Calling Party Category from system.
The category cannot be deleted if it is the default or is in use by any users.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| category | str | category |
SystemCallingPartyCategoryGetListRequest(OCIRequest)
Get the list of all Calling Party Category in system.
The response is either a SystemCallingPartyCategoryGetListResponse() or an
ErrorResponse().
SystemCallingPartyCategoryGetRequest(OCIRequest)
Get an existing Calling Party Category in system.
The response is either a SystemCallingPartyCategoryGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| category | str | category |
SystemCallingPartyCategoryModifyRequest(OCIRequest)
Modify a Calling Party Category in system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| category | str | category |
| cpc_value | str | cpcValue Optional |
| isup_oli_value | int | isupOliValue Optional |
| gtd_oli_value | str | gtdOliValue Optional |
| user_category | bool | userCategory Optional |
| pay_phone | bool | payPhone Optional |
| operator | bool | operator Optional |
| become_default | bool | becomeDefault Optional |
| collect_call | bool | collectCall Optional |
| web_display_key | str | webDisplayKey Optional |
SystemClassmarkAddRequest(OCIRequest)
Add a Class Mark to system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| classmark | str | classmark |
| value | str | value |
| web_display_key | str | webDisplayKey Optional |
SystemClassmarkDeleteRequest(OCIRequest)
Delete a Class Mark from system.
It cannot be deleted if it is in use by any users.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| classmark | str | classmark |
SystemClassmarkGetListRequest(OCIRequest)
Get the list of all Class Mark in system.
The response is either a SystemClassmarkGetListResponse() or an ErrorResponse().
SystemClassmarkModifyRequest(OCIRequest)
Modify a Class Mark in system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| classmark | str | classmark |
| value | str | value Optional |
| web_display_key | str | webDisplayKey Optional |
SystemClientIdentityAddRequest(OCIRequest)
Request to add a client identity entry to the list of client identities in the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| client_identity | str | clientIdentity |
SystemClientIdentityDeleteRequest(OCIRequest)
Request to delete a client identity.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| client_identity | str | clientIdentity |
SystemClientIdentityGetListRequest(OCIRequest)
Request to get a list of client identities.
The response is either a SystemClientIdentityGetListResponse() or an
ErrorResponse().
SystemClientSessionParametersGetRequest(OCIRequest)
Request to get the list of Client Session (web and CLI) system parameters.
The response is either SystemClientSessionParametersGetResponse() or
ErrorResponse().
SystemClientSessionParametersModifyRequest(OCIRequest)
Request to modify Client Session (web and CLI) system parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enable_inactivity_timeout | bool | enableInactivityTimeout Optional |
| inactivity_timeout_minutes | int | inactivityTimeoutMinutes Optional |
SystemCodecAddRequest(OCIRequest)
Request to add a codec to the ordered list of codecs supported by the system.
The ordered list of codecs is sent to MGCP devices when creating connections.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| codec | str | codec |
SystemCodecDeleteRequest(OCIRequest)
Request to delete a supported codec from the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| codec | str | codec |
SystemCodecGetListRequest(OCIRequest)
Request to get the ordered list of supported codecs in the system.
The ordered list of codecs is sent to MGCP devices when creating connections.
The response is either a SystemCodecGetListResponse() or an ErrorResponse().
SystemCollaborateGetRequest(OCIRequest)
Request the system level data associated with collaborate services.
The response is either a SystemCollaborateGetResponse() or an ErrorResponse().
Replaced by: SystemCollaborateGetRequest20sp1()
SystemCollaborateGetRequest20sp1(OCIRequest)
Request the system level data associated with collaborate services.
The response is either a SystemCollaborateGetResponse20sp1() or an
ErrorResponse(). Replaced by: SystemCollaborateGetRequest20sp1V2
SystemCommunicationBarringAlternateCallIndicatorAddRequest(OCIRequest)
Add a Communication Barring Alternate Call Indicator.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| alternate_call_indicator | str | alternateCallIndicator |
| network_server_alternate_call_indicator | str | networkServerAlternateCallIndicator |
SystemCommunicationBarringAlternateCallIndicatorDeleteRequest(OCIRequest)
Delete a Communication Barring Alternate Call Indicator.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| alternate_call_indicator | str | alternateCallIndicator |
SystemCommunicationBarringAlternateCallIndicatorGetListRequest(OCIRequest)
Get all the Communication Barring Alternate Call Indicator defined in the system.
The response is either a
SystemCommunicationBarringAlternateCallIndicatorGetListResponse() or an
ErrorResponse().
SystemCommunicationBarringAlternateCallIndicatorModifyRequest(OCIRequest)
Modify a Communication Barring Alternate Call Indicator.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| alternate_call_indicator | str | alternateCallIndicator |
| network_server_alternate_call_indicator | str | networkServerAlternateCallIndicator Optional |
SystemCommunicationBarringCallTypeAddRequest(OCIRequest)
Add a Communication Barring Call Type.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_type | str | callType |
| network_server_call_type | str | networkServerCallType |
SystemCommunicationBarringCallTypeDeleteRequest(OCIRequest)
Delete a Communication Barring Call Type.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_type | str | callType |
SystemCommunicationBarringCallTypeGetListRequest(OCIRequest)
Get all the Communication Barring Call Types defined in the system.
The response is either a SystemCommunicationBarringCallTypeGetListResponse() or an
ErrorResponse().
SystemCommunicationBarringCallTypeModifyRequest(OCIRequest)
Modify a Communication Barring Call Type.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_type | str | callType |
| network_server_call_type | str | networkServerCallType Optional |
SystemCommunicationBarringCriteriaAddRequest(OCIRequest)
Add a new Communication Barring Criteria.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemCommunicationBarringCriteriaAddRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| description | str | description Optional |
| match_call_type | List[str] | matchCallType Optional |
| match_alternate_call_indicator | List[str] | matchAlternateCallIndicator Optional |
| match_virtual_on_net_call_type | List[str] | matchVirtualOnNetCallType Optional |
| match_public_network | bool | matchPublicNetwork |
| match_private_network | bool | matchPrivateNetwork |
| match_local_category | bool | matchLocalCategory |
| match_national_category | bool | matchNationalCategory |
| match_interlata_category | bool | matchInterlataCategory |
| match_intralata_category | bool | matchIntralataCategory |
| match_international_category | bool | matchInternationalCategory |
| match_private_category | bool | matchPrivateCategory |
| match_emergency_category | bool | matchEmergencyCategory |
| match_other_category | bool | matchOtherCategory |
| match_inter_network | bool | matchInterNetwork |
| match_inter_hosting_ne | bool | matchInterHostingNE |
| match_inter_as | bool | matchInterAS |
| match_intra_as | bool | matchIntraAS |
| match_charge_calls | bool | matchChargeCalls |
| match_no_charge_calls | bool | matchNoChargeCalls |
| match_group_calls | bool | matchGroupCalls |
| match_enterprise_calls | bool | matchEnterpriseCalls |
| match_network_calls | bool | matchNetworkCalls |
| match_network_url_calls | bool | matchNetworkURLCalls |
| match_repair_calls | bool | matchRepairCalls |
| match_emergency_calls | bool | matchEmergencyCalls |
| match_internal_calls | bool | matchInternalCalls |
| time_schedule | str | timeSchedule Optional |
| holiday_schedule | str | holidaySchedule Optional |
SystemCommunicationBarringCriteriaAddRequest17(OCIRequest)
Add a new Communication Barring Criteria.
The following elements are only used in AS data mode: matchNumberPortabilityStatus
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| description | str | description Optional |
| match_call_type | List[str] | matchCallType Optional |
| match_alternate_call_indicator | List[str] | matchAlternateCallIndicator Optional |
| match_virtual_on_net_call_type | List[str] | matchVirtualOnNetCallType Optional |
| match_public_network | bool | matchPublicNetwork |
| match_private_network | bool | matchPrivateNetwork |
| match_local_category | bool | matchLocalCategory |
| match_national_category | bool | matchNationalCategory |
| match_interlata_category | bool | matchInterlataCategory |
| match_intralata_category | bool | matchIntralataCategory |
| match_international_category | bool | matchInternationalCategory |
| match_private_category | bool | matchPrivateCategory |
| match_emergency_category | bool | matchEmergencyCategory |
| match_other_category | bool | matchOtherCategory |
| match_inter_network | bool | matchInterNetwork |
| match_inter_hosting_ne | bool | matchInterHostingNE |
| match_inter_as | bool | matchInterAS |
| match_intra_as | bool | matchIntraAS |
| match_charge_calls | bool | matchChargeCalls |
| match_no_charge_calls | bool | matchNoChargeCalls |
| match_group_calls | bool | matchGroupCalls |
| match_enterprise_calls | bool | matchEnterpriseCalls |
| match_network_calls | bool | matchNetworkCalls |
| match_network_url_calls | bool | matchNetworkURLCalls |
| match_repair_calls | bool | matchRepairCalls |
| match_emergency_calls | bool | matchEmergencyCalls |
| match_internal_calls | bool | matchInternalCalls |
| match_location | str | matchLocation |
| match_roaming | str | matchRoaming |
| time_schedule | str | timeSchedule Optional |
| holiday_schedule | str | holidaySchedule Optional |
| match_number_portability_status | List[str] | matchNumberPortabilityStatus Optional |
SystemCommunicationBarringCriteriaDeleteRequest(OCIRequest)
Delete an existing Communication Barring Criteria.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringCriteriaGetListRequest(OCIRequest)
Get the list of all Communication Barring Criteria.
The response is either a SystemCommunicationBarringCriteriaGetListResponse() or an
ErrorResponse().
SystemCommunicationBarringCriteriaGetRequest(OCIRequest)
Get an existing Communication Barring Criteria.
The response is either a SystemCommunicationBarringCriteriaGetResponse() or an
ErrorResponse(). Replaced by: SystemCommunicationBarringCriteriaGetRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringCriteriaGetRequest17(OCIRequest)
Get an existing Communication Barring Criteria.
The response is either a SystemCommunicationBarringCriteriaGetResponse17() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringCriteriaGetRequest19sp1(OCIRequest)
Get an existing Communication Barring Criteria.
The response is either a SystemCommunicationBarringCriteriaGetResponse19sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringDigitPatternCriteriaAddRequest(OCIRequest)
Add a new Communication Barring Digit Pattern Criteria.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| description | str | description Optional |
| match_digit_pattern | List[str] | matchDigitPattern Optional |
SystemCommunicationBarringDigitPatternCriteriaDeleteRequest(OCIRequest)
Delete an existing Communication Barring Digit Pattern Criteria.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringDigitPatternCriteriaGetListRequest(OCIRequest)
Get the list of all Digit Pattern Criteria defined at the system level.
The response is either a
SystemCommunicationBarringDigitPatternCriteriaGetListResponse() or an
ErrorResponse().
SystemCommunicationBarringDigitPatternCriteriaGetRequest(OCIRequest)
Get an existing Communication Barring Digit Pattern Criteria.
The response is either a SystemCommunicationBarringDigitPatternCriteriaGetResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringDigitPatternCriteriaModifyRequest(OCIRequest)
Modify an existing Communication Barring Digit Pattern Criteria.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| add_match_digit_pattern | List[str] | addMatchDigitPattern Optional |
| delete_match_digit_pattern | List[str] | deleteMatchDigitPattern Optional |
SystemCommunicationBarringGetRequest(OCIRequest)
Request the system level data associated with Communication Barring.
The response is either a SystemCommunicationBarringGetResponse() or an
ErrorResponse(). Replaced by: SystemCommunicationBarringGetRequest21sp1() in AS
data mode.
SystemCommunicationBarringGetRequest21sp1(OCIRequest)
Request the system level data associated with Communication Barring.
The response is either a SystemCommunicationBarringGetResponse21sp1() or an
ErrorResponse().
SystemCommunicationBarringIncomingCriteriaAddRequest(OCIRequest)
Add a new Communication Barring Incoming Criteria.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemCommunicationBarringIncomingCriteriaAddRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| description | str | description Optional |
| time_schedule | str | timeSchedule Optional |
| holiday_schedule | str | holidaySchedule Optional |
| match_number_portability_status | List[str] | matchNumberPortabilityStatus Optional |
SystemCommunicationBarringIncomingCriteriaAddRequest22(OCIRequest)
Add a new Communication Barring Incoming Criteria.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| description | str | description Optional |
| time_schedule | str | timeSchedule Optional |
| holiday_schedule | str | holidaySchedule Optional |
| match_number_portability_status | List[str] | matchNumberPortabilityStatus Optional |
| call_tagged_as_spam | bool | callTaggedAsSpam |
SystemCommunicationBarringIncomingCriteriaDeleteRequest(OCIRequest)
Delete an existing Communication Barring Incoming Criteria.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringIncomingCriteriaGetListRequest(OCIRequest)
Get the list of all Communication Barring Incoming Criteria.
The response is either a SystemCommunicationBarringIncomingCriteriaGetListResponse()
or an ErrorResponse().
SystemCommunicationBarringIncomingCriteriaGetRequest(OCIRequest)
Get an existing Communication Barring Incoming Criteria.
The response is either a SystemCommunicationBarringIncomingCriteriaGetResponse() or
an ErrorResponse(). Replaced by:
SystemCommunicationBarringIncomingCriteriaGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringIncomingCriteriaGetRequest22(OCIRequest)
Get an existing Communication Barring Incoming Criteria.
The response is either a SystemCommunicationBarringIncomingCriteriaGetResponse22()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringModifyRequest(OCIRequest)
Modify the system level data associated with Communication Barring.
The following elements are only used in AS data mode and ignored in XS data mode: vmCallbackScreening
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| direct_transfer_screening | bool | directTransferScreening Optional |
| vm_callback_screening | bool | vmCallbackScreening Optional |
SystemCommunicationBarringProfileDeleteRequest(OCIRequest)
Delete an existing Communication Barring Profile.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringProfileGetCriteriaUsageListRequest(OCIRequest)
Get the list of Communication Barring Proifles that uses a specific Communication Barring criteria.
The response is either a
SystemCommunicationBarringProfileGetCriteriaUsageListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringProfileGetDigitPatternCriteriaUsageListRequest(OCIRequest)
Get the list of Profiles that use a specific Digit Pattern Criteria.
The response is either a
SystemCommunicationBarringProfileGetDigitPatternCriteriaUsageListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringProfileGetIncomingCriteriaUsageListRequest(OCIRequest)
Get the list of Communication Barring Proifles that uses a specific Communication Barring Incoming criteria.
The response is either a
SystemCommunicationBarringProfileGetIncomingCriteriaUsageListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringProfileGetListRequest(OCIRequest)
Get the list of all Communication Barring Profiles.
The response is either a SystemCommunicationBarringProfileGetListResponse() or an
ErrorResponse().
SystemCommunicationBarringProfileGetRequest(OCIRequest)
Get an existing Communication Barring Profile.
The response is either a SystemCommunicationBarringProfileGetResponse() or an
ErrorResponse(). Replaced by: SystemCommunicationBarringProfileGetRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringProfileGetRequest16(OCIRequest)
Get an existing Communication Barring Profile.
The response is either a SystemCommunicationBarringProfileGetResponse16() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringProfileGetRequest17sp1(OCIRequest)
Get an existing Communication Barring Profile.
The response is either a SystemCommunicationBarringProfileGetResponse17sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringProfileGetRequest17sp3(OCIRequest)
Get an existing Communication Barring Profile.
The response is either a SystemCommunicationBarringProfileGetResponse17sp3() or an
ErrorResponse(). Replaced by: SystemCommunicationBarringProfileGetRequest19sp1()
in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringProfileGetRequest19sp1(OCIRequest)
Get an existing Communication Barring Profile.
The response is either a SystemCommunicationBarringProfileGetResponse19sp1() or an
ErrorResponse(). Replaced by: SystemCommunicationBarringProfileGetRequest19sp1V2 in
AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringServiceProviderGetCriteriaUsageListRequest(OCIRequest)
Get the list of Service Providers that use a specific Communication Barring Criteria.
The response is either a
SystemCommunicationBarringServiceProviderGetCriteriaUsageListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringServiceProviderGetIncomingCriteriaUsageListRequest(OCIRequest)
Get the list of Service Providers that use a specific Communication Barring Incoming Criteria.
The response is either a
SystemCommunicationBarringServiceProviderGetIncomingCriteriaUsageListResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemCommunicationBarringUserControlGetRequest(OCIRequest)
Gets the Communication Barring system level settings.
The response is either SystemCommunicationBarringUserControlGetResponse() or
ErrorResponse().
SystemCommunicationBarringUserControlModifyRequest(OCIRequest)
Modifies the system's Communication Barring User-Control settings.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enable_lockout | bool | enableLockout Optional |
| max_number_of_failed_attempts | int | maxNumberOfFailedAttempts Optional |
| lockout_minutes | int | lockoutMinutes Optional |
SystemConfigurableFileSystemGetRequest(OCIRequest)
Request to get the File System parameters.
The response is either SystemConfigurableFileSystemGetResponse() or
ErrorResponse(). Replaced by: SystemConfigurableFileSystemGetRequest23()
SystemConfigurableFileSystemGetRequest22(OCIRequest)
Request to get the File System parameters.
The response is either SystemConfigurableFileSystemGetResponse22() or
ErrorResponse().
SystemConfigurableFileSystemGetRequest23(OCIRequest)
Request to get the File System parameters.
change of behavior is that CLI System/MediaFileSystem/get will no longer show the password
The response is either SystemConfigurableFileSystemGetResponse23() or
ErrorResponse().
SystemConfigurableFileSystemGetRequest23V2(OCIRequest)
Request to get the File System parameters.
The response is either SystemConfigurableFileSystemGetResponse23V2() or
ErrorResponse().
SystemConfigurableFileSystemModifyRequest(OCIRequest)
Request to modify File System parameters.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: protocolFile-
secure
Attributes:
| Name | Type | Description |
|---|---|---|
| media_directory | str | mediaDirectory Optional |
| protocol_file | OCI.protocolFile | protocolFile Optional |
| protocol_web_dav | OCI.protocolWebDAV | protocolWebDAV Optional |
SystemConfigurableTreatmentAddRequest(OCIRequest)
Add a configurable treatment.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| treatment_id | str | treatmentId |
| charge_indicator | str | chargeIndicator |
| description | str | description Optional |
| access_sip_status_code | int | accessSIPStatusCode Optional |
| access_sip_status_message | str | accessSIPStatusMessage Optional |
| network_sip_status_code | int | networkSIPStatusCode Optional |
| network_sip_status_message | str | networkSIPStatusMessage Optional |
| q850_cause_value | int | q850CauseValue Optional |
| q850_text | str | q850Text Optional |
| access_treatment_audio_file | str | accessTreatmentAudioFile Optional |
| access_treatment_video_file | str | accessTreatmentVideoFile Optional |
| network_treatment_audio_file | str | networkTreatmentAudioFile Optional |
| network_treatment_video_file | str | networkTreatmentVideoFile Optional |
| cdr_termination_cause | str | cdrTerminationCause Optional |
| route_advance | bool | routeAdvance Optional |
| internal_release_cause | str | internalReleaseCause Optional |
| access_send_reason_header | bool | accessSendReasonHeader Optional |
| network_send_reason_header | bool | networkSendReasonHeader Optional |
| warn_code | int | warnCode Optional |
| warn_text | str | warnText Optional |
| access_send_warning_header | bool | accessSendWarningHeader Optional |
| network_send_warning_header | bool | networkSendWarningHeader Optional |
SystemConfigurableTreatmentDeleteRequest(OCIRequest)
Delete a configurable treatment.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| treatment_id | str | treatmentId |
SystemConfigurableTreatmentGetListRequest(OCIRequest)
Get a list of configurable treatments.
The response is either a SystemConfigurableTreatmentGetListResponse() or an
ErrorResponse().
SystemConfigurableTreatmentGetRequest(OCIRequest)
Get all the attributes of a configurable treatment.
The response is either a SystemConfigurableTreatmentGetResponse() or an
ErrorResponse().
Replaced By: SystemConfigurableTreatmentGetRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| treatment_id | str | treatmentId |
SystemConfigurableTreatmentGetRequest16(OCIRequest)
Get all the attributes of a configurable treatment.
The response is either a SystemConfigurableTreatmentGetResponse16() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| treatment_id | str | treatmentId |
SystemConfigurableTreatmentGetRequest24(OCIRequest)
Get all the attributes of a configurable treatment.
The response is either a SystemConfigurableTreatmentGetResponse24() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| treatment_id | str | treatmentId |
SystemConfigurableTreatmentModifyRequest(OCIRequest)
Modify the fields for a configurable treatment.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: warnCode warnText
accessSendWarningHeader networkSendWarningHeader
Attributes:
| Name | Type | Description |
|---|---|---|
| treatment_id | str | treatmentId |
| charge_indicator | str | chargeIndicator Optional |
| description | str | description Optional |
| access_sip_status_code | int | accessSIPStatusCode Optional |
| access_sip_status_message | str | accessSIPStatusMessage Optional |
| network_sip_status_code | int | networkSIPStatusCode Optional |
| network_sip_status_message | str | networkSIPStatusMessage Optional |
| q850_cause_value | int | q850CauseValue Optional |
| q850_text | str | q850Text Optional |
| access_treatment_audio_file | str | accessTreatmentAudioFile Optional |
| access_treatment_video_file | str | accessTreatmentVideoFile Optional |
| network_treatment_audio_file | str | networkTreatmentAudioFile Optional |
| network_treatment_video_file | str | networkTreatmentVideoFile Optional |
| cdr_termination_cause | str | cdrTerminationCause Optional |
| route_advance | bool | routeAdvance Optional |
| internal_release_cause | str | internalReleaseCause Optional |
| access_send_reason_header | bool | accessSendReasonHeader Optional |
| network_send_reason_header | bool | networkSendReasonHeader Optional |
| warn_code | int | warnCode Optional |
| warn_text | str | warnText Optional |
| access_send_warning_header | bool | accessSendWarningHeader Optional |
| network_send_warning_header | bool | networkSendWarningHeader Optional |
SystemConnectedLineIdentificationPresentationGetRequest(OCIRequest)
Request the system level data associated with the COLP service.
The response is either a SystemConnectedLineIdentificationPresentationGetResponse()
or an ErrorResponse().
SystemConnectedLineIdentificationPresentationModifyRequest(OCIRequest)
Modify the system level data associated with the COLP Service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enforce_user_service_assignment | bool | enforceUserServiceAssignment Optional |
SystemCountryCodeAddRequest(OCIRequest)
Add a country code to the system.
If ringPeriodMilliseconds is not specified, a default of 6000 milliseconds is assumed. If offHookWarningTimerSeconds is not specified, a default of 30 seconds is assumed. If enableNationalPrefix is not specified, a default of false is assumed. If nationalPrefix is not specified, a default of null string is assumed. If disableNationalPrefixForOffNetCalls is not specified, a default of false is assumed. The following elements are only used in AS data mode: disableNationalPrefixForOffNetCalls.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| country_code | str | countryCode |
| country_name | str | countryName |
| ring_period_milliseconds | int | ringPeriodMilliseconds Optional |
| off_hook_warning_timer_seconds | int | offHookWarningTimerSeconds Optional |
| enable_national_prefix | bool | enableNationalPrefix Optional |
| national_prefix | str | nationalPrefix Optional |
| max_call_waiting_tones | int | maxCallWaitingTones Optional |
| time_between_call_waiting_tones_milliseconds | int | timeBetweenCallWaitingTonesMilliseconds Optional |
| disable_national_prefix_for_off_net_calls | bool | disableNationalPrefixForOffNetCalls Optional |
SystemCountryCodeDeleteRequest(OCIRequest)
Delete a country code from the system.
A country code cannot be deleted if it is the default country code or if any carriers or call type mappings are defined against it.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| country_code | str | countryCode |
SystemCountryCodeGetListRequest(OCIRequest)
Request data for all country codes.
The response is either a SystemCountryCodeGetListResponse() or an ErrorResponse().
SystemCountryCodeModifyRequest(OCIRequest)
Modify the attributes of a country code.
If becomeDefaultCountryCode is true, the country code in this request becomes the default country code for the system. The following elements are only used in AS data mode: disableNationalPrefixForOffNetCalls
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| country_code | str | countryCode |
| ring_period_milliseconds | int | ringPeriodMilliseconds Optional |
| off_hook_warning_timer_seconds | int | offHookWarningTimerSeconds Optional |
| enable_national_prefix | bool | enableNationalPrefix Optional |
| national_prefix | str | nationalPrefix Optional |
| become_default_country_code | bool | becomeDefaultCountryCode Optional |
| max_call_waiting_tones | int | maxCallWaitingTones Optional |
| time_between_call_waiting_tones_milliseconds | int | timeBetweenCallWaitingTonesMilliseconds Optional |
| disable_national_prefix_for_off_net_calls | bool | disableNationalPrefixForOffNetCalls Optional |
SystemCrInterfaceGetRequest(OCIRequest)
Gets the system level attributes of the Cr Interface.
The response is either a SystemCrInterfaceGetResponse() or an ErrorResponse().
SystemCrInterfaceGetRequest22(OCIRequest)
Gets the system level attributes of the Cr Interface.
The response is either a SystemCrInterfaceGetResponse() or an ErrorResponse().
SystemCrInterfaceModifyRequest(OCIRequest)
Modify the system level data associated with Cr Interface.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| cr_audit_enabled | bool | crAuditEnabled Optional |
| cr_audit_interval_milliseconds | int | crAuditIntervalMilliseconds Optional |
| cr_audit_timeout_milliseconds | int | crAuditTimeoutMilliseconds Optional |
| cr_connection_enabled | bool | crConnectionEnabled Optional |
| cr_connection_timeout_milliseconds | int | crConnectionTimeoutMilliseconds Optional |
| cr_tcp_connection_timeout_seconds | int | crTcpConnectionTimeoutSeconds Optional |
| cr_number_of_reconnection_attempts | int | crNumberOfReconnectionAttempts Optional |
SystemCustomerOriginatedTraceGetRequest(OCIRequest)
Request the system level data associated with Customer Originated Trace.
The response is either a SystemCustomerOriginatedTraceGetResponse() or an
ErrorResponse().
SystemCustomerOriginatedTraceModifyRequest(OCIRequest)
Modify the system level data associated with Customer Originated Trace.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| screen_malicious_callers | bool | screenMaliciousCallers Optional |
SystemDTMFTransmissionGetRequest(OCIRequest)
Get the system DTMF transmission configurations.
The response is either SystemDTMFTransmissionGetResponse() or ErrorResponse().
SystemDTMFTransmissionModifyRequest(OCIRequest)
Modify the DTMF transmission settings.
The response is either SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| transmission_method | str | transmissionMethod Optional |
| signaling_content_type | str | signalingContentType Optional |
SystemDeviceActivationPolicyGetRequest(OCIRequest)
Request the Device Activation policy of the system.
The response is either a SystemDeviceActivationPolicyGetResponse() or an
ErrorResponse().
SystemDeviceActivationPolicyModifyRequest(OCIRequest)
Modify the Device Activation policy of the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| allow_activation_code_request_by_user | bool | allowActivationCodeRequestByUser Optional |
| send_activation_code_in_email | bool | sendActivationCodeInEmail Optional |
SystemDeviceFamilyAddRequest(OCIRequest)
Request to add a device family.
When the optional element resellerId is specified, the device family created is at reseller level. Device family name should be unique throughout the system including all the reseller level device families.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in the XS data mode: resellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| device_family_name | str | deviceFamilyName |
| reseller_id | str | resellerId Optional |
| assign_device_type | List[str] | assignDeviceType Optional |
| assign_tag_set | List[str] | assignTagSet Optional |
SystemDeviceFamilyAssignDeviceTypeListRequest(OCIRequest)
Request to assign a list of Device Types to a device family.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_family_name | str | deviceFamilyName |
| device_type_name | List[str] | deviceTypeName |
SystemDeviceFamilyAssignTagSetListRequest(OCIRequest)
Request to assign a list of Tag Sets to a device family.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_family_name | str | deviceFamilyName |
| tag_set_name | List[str] | tagSetName |
SystemDeviceFamilyDeleteListRequest(OCIRequest)
Request to delete a device family.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_family_name | List[str] | deviceFamilyName |
SystemDeviceFamilyExportRequest(OCIRequest)
Request to export a device family.
The response is either a SystemDeviceFamilyExportResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_family_name | str | deviceFamilyName |
SystemDeviceFamilyGetRequest(OCIRequest)
Request to get the associated device types and tagsets for a given device family.
The response is either SystemDeviceFamilyGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_family_name | str | deviceFamilyName |
SystemDeviceFamilyImportDryRunRequest(OCIRequest)
Request to perform a dry run import of a Device Family Set Archive File (DFAF) as a new Device Family.
The URL supports the HTTP and the FILE protocols. When the optional element resellerId is specified, the device type created is at reseller level. When the optional element deviceFamilyOverride is set to true, an existing device family with the same name on the destination system will be overridden. When the optional element tagSetOverride is set to true, any existing tag set on the destination system will be overridden. When the optional element deviceTypeFileUpdate is set, on import, for any existing device type associated with the device family, the files that are matched based on the file format are updated with the ones from the DTAF. The file format and the file category are the only attributes that can't be updated.
The response is either a SystemDeviceFamilyImportDryRunResponse() or an
ErrorResponse(). The following data elements are only used in AS data mode and
ignored in XS data mode: resellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| file | str | file |
| reseller_id | str | resellerId Optional |
| device_family_override | bool | deviceFamilyOverride Optional |
| tag_set_override | bool | tagSetOverride Optional |
| device_type_file_update | bool | deviceTypeFileUpdate Optional |
SystemDeviceFamilyImportRequest(OCIRequest)
Request to import a Device Family Set Archive File (DFAF) as a new Device Family.
The URL supports the HTTP and the FILE protocols. When the optional element resellerId is specified, the device type created is at reseller level. When the optional element deviceFamilyOverride is set to true, an existing device family with the same name on the destination system will be overridden. When the optional element tagSetOverride is set to true, any existing tag set on the destination system will be overridden. When the optional element deviceTypeFileUpdate is set, on import, for any existing device type associated with the device family, the files that are matched based on the file format are updated with the ones from the DTAF. The file format and the file category are the only attributes that can't be updated.
The response is either a SuccessResponse() or an ErrorResponse(). The following
data elements are only used in AS data mode and ignored in XS data mode: resellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| file | str | file |
| reseller_id | str | resellerId Optional |
| device_family_override | bool | deviceFamilyOverride Optional |
| tag_set_override | bool | tagSetOverride Optional |
| device_type_file_update | bool | deviceTypeFileUpdate Optional |
SystemDeviceFamilyUnassignDeviceTypeListRequest(OCIRequest)
Request to unassign a list of Device Types to a device family.
Device family name should be unique through out the system including all the reseller level device families.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in the XS data mode: resellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| device_family_name | str | deviceFamilyName |
| device_type_name | List[str] | deviceTypeName |
SystemDeviceFamilyUnassignTagSetListRequest(OCIRequest)
Request to unassign a list of Tag Sets to a device family.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_family_name | str | deviceFamilyName |
| tag_set_name | List[str] | tagSetName |
SystemDeviceManagementAutoRebuildConfigGetListRequest(OCIRequest)
Request the list of OCI request prefixes including if they trigger DM automatic rebuild event or not.
The response is either a SystemDeviceManagementAutoRebuildConfigGetListResponse() or
an ErrorResponse().
SystemDeviceManagementGetAccessDeviceCountForDeviceTypeRequest(OCIRequest)
Request the number of access device of a particular device type or all device types if deviceType is not specified.
If countOnlyResetSupportedDevice is true, count only access devices if the device type supports reset. By default unmanaged device types are not allowed and devices are counted only if their device type supports Device Management. An error is returned if deviceType is specified but does not support device management. When allowUnmanagedDeviceType is true, unmanaged device type will be counted and a successful response is returned.
The response is either
SystemDeviceManagementGetAccessDeviceCountForDeviceTypeResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType Optional |
| count_only_reset_supported_device | bool | countOnlyResetSupportedDevice Optional |
| allow_unmanaged_device_type | bool | allowUnmanagedDeviceType Optional |
SystemDeviceManagementGetEventStatusSummaryCountRequest(OCIRequest)
Request a summary table of the number of events in state 'Pending', 'Queued Internally', and 'Completed' in the system per action.
One row is returned per action. Actions are as per the DeviceManagementEventActionType (ex: Delete, Download, Rebuild, Reset, Upload). The state 'Queued Internally' includes total for events with status equal to 'Queued' and 'In Progress' as per DeviceManagementEventStatus.
The response is either SystemDeviceManagementGetEventStatusSummaryCountResponse() or
ErrorResponse().
SystemDeviceManagementInProgressAndPendingEventCancelRequest(OCIRequest)
Cancel pending and in progress events.
Either all events, multiple events, or a list of specified events can be canceled. When specifying multiple events, an event must meet all specified criteria to be canceled.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| cancel_all_events | OCI.cancelAllEvents | cancelAllEvents Optional |
| cancel_multiple_events | OCI.cancelMultipleEvents | cancelMultipleEvents Optional |
| event_id | List[int] | eventId Optional |
SystemDeviceManagementSwitchDeviceTypeDeviceRequest(OCIRequest)
Switch the device type for a specified device.
To switch a system level device profile, serviceProviderId and groupId should not be present. To switch a service provider level device profile, only serviceProviderId should be specified. To switch a group level device profile, serviceProviderId and groupId should specified.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| svc_provider_id | str | svcProviderId Optional |
| group_id | str | groupId Optional |
| device_name | str | deviceName |
| to_device_type | str | toDeviceType |
SystemDeviceManagementSwitchDeviceTypeRequest(OCIRequest)
Switch the device type for all devices at the specified scope for a device type.
To switch all the device type's device profiles for the system, neither the serviceProviderId and groupId should be present. To switch all the device type's device profiles for a service provider, only serviceProviderId should be specified. To switch all the device type's device profiles for a group, serviceProviderId and groupId should specified.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| svc_provider_id | str | svcProviderId Optional |
| group_id | str | groupId Optional |
| from_device_type | str | fromDeviceType |
| to_device_type | str | toDeviceType |
SystemDeviceManagementTagAddRequest(OCIRequest)
Request to add a static configuration tag.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemDeviceManagementTagAddRequest21sp2()
Attributes:
| Name | Type | Description |
|---|---|---|
| system_default_tag_set | bool | systemDefaultTagSet Optional |
| tag_set_name | str | tagSetName Optional |
| tag_name | str | tagName |
| tag_value | str | tagValue Optional |
SystemDeviceManagementTagAddRequest21sp2(OCIRequest)
Request to add a static configuration tag.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemDeviceManagementTagAddRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| system_default_tag_set | bool | systemDefaultTagSet Optional |
| tag_set_name | str | tagSetName Optional |
| tag_name | str | tagName |
| is_tag_value_encrypted | bool | isTagValueEncrypted |
| tag_value | str | tagValue Optional |
| tag_value_to_encrypt | str | tagValueToEncrypt Optional |
SystemDeviceManagementTagAddRequest22(OCIRequest)
Request to add a static configuration tag.
The following elements are only used in XS data mode and ignored in AS data mode: isTagValueEncrypted tagValueToEncrypt
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| system_default_tag_set | bool | systemDefaultTagSet Optional |
| tag_set_name | str | tagSetName Optional |
| tag_name | str | tagName |
| is_tag_value_encrypted | bool | isTagValueEncrypted |
| tag_value | str | tagValue Optional |
| tag_value_to_encrypt | str | tagValueToEncrypt Optional |
| is_tag_value_overridable | bool | isTagValueOverridable |
SystemDeviceManagementTagDeleteListRequest(OCIRequest)
Request to delete static configuration tags.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| system_default_tag_set | bool | systemDefaultTagSet Optional |
| tag_set_name | str | tagSetName Optional |
| tag_name | List[str] | tagName |
SystemDeviceManagementTagGetListRequest(OCIRequest)
Request to get the list of custom configuration tags managed by the Device Management System.
The response is either SystemDeviceManagementTagGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| system_default_tag_set | bool | systemDefaultTagSet Optional |
| tag_set_name | str | tagSetName Optional |
SystemDeviceManagementTagModifyRequest(OCIRequest)
Request to modify a static configuration tag.
The following elements are only used in XS data mode and ignored in AS data mode: tagValueToEncrypt
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| system_default_tag_set | bool | systemDefaultTagSet Optional |
| tag_set_name | str | tagSetName Optional |
| tag_name | str | tagName |
| tag_value | str | tagValue Optional |
| tag_value_to_encrypt | str | tagValueToEncrypt Optional |
| is_tag_value_overridable | bool | isTagValueOverridable Optional |
SystemDeviceManagementTagSetAddRequest(OCIRequest)
Request to add a static configuration tag set.
When the optional element resellerId is specified, the tag set created is at reseller level. Tag set name should be unique through out the system including all the reseller level tag sets.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in the XS data mode: resellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| tag_set_name | str | tagSetName |
| reseller_id | str | resellerId Optional |
SystemDeviceManagementTagSetCountryAddRequest(OCIRequest)
Request to add a country to a region within a static configuration tag set for per- region tags override.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| tag_set_name | str | tagSetName |
| region_name | str | regionName |
| country_name | str | countryName |
SystemDeviceManagementTagSetCountryDeleteListRequest(OCIRequest)
Request to delete a list of countries from a region within a static configuration tag set for per-region tags override.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| tag_set_name | str | tagSetName |
| region_name | str | regionName |
| country_name | List[str] | countryName |
SystemDeviceManagementTagSetCountryGetListRequest(OCIRequest)
Request to get the list of countries within the region of a static configuration tag set for per-region tags override.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| tag_set_name | str | tagSetName |
| region_name | str | regionName |
SystemDeviceManagementTagSetDeleteRequest(OCIRequest)
Request to delete a static configuration tag set.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| tag_set_name | str | tagSetName |
SystemDeviceManagementTagSetExportRequest(OCIRequest)
Request to export a custom tag set.
Tag set name should be unique through out the system including all the reseller level tag sets.
The response is either a SystemDeviceManagementTagSetExportResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| tag_set_name | str | tagSetName |
SystemDeviceManagementTagSetGetListRequest(OCIRequest)
Request to get the list of custom configuration tag sets managed by the Device Management System.
The response is either SystemDeviceManagementTagSetGetListResponse() or
ErrorResponse(). Replaced by SystemDeviceManagementTagSetGetListRequest22() in AS
data mode.
SystemDeviceManagementTagSetGetListRequest22(OCIRequest)
Request to get the list of custom configuration tag sets managed by the Device Management System.
If excludeReseller is set, only system level tag sets are returned. If resellerId is specified, all system level tag sets and the tag sets in the reseller are returned. If reseller administrator sends the request, resellerId is not specified, the administrator's resellerId is used. If neither excludeReseller nor resellerId is specified, all system level and reseller level tag sets are returned.
The response is either SystemDeviceManagementTagSetGetListResponse22() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| exclude_reseller | bool | excludeReseller Optional |
| reseller_id | str | resellerId Optional |
SystemDeviceManagementTagSetModifyRequest(OCIRequest)
Request to modify a static configuration tag set.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| tag_set_name | str | tagSetName |
| new_tag_set_name | str | newTagSetName Optional |
SystemDeviceManagementTagSetRegionAddRequest(OCIRequest)
Request to add a region within a static configuration tag set for per-region tags override.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| tag_set_name | str | tagSetName |
| region_name | str | regionName |
SystemDeviceManagementTagSetRegionDeleteListRequest(OCIRequest)
Request to delete a region within a static configuration tag set for per-region tags override.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| tag_set_name | str | tagSetName |
| region_name | List[str] | regionName |
SystemDeviceManagementTagSetRegionGetListRequest(OCIRequest)
Request to get the list of regions within a static configuration tag set for per- region tags override.
The response is either a SystemDeviceManagementTagSetRegionGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| tag_set_name | str | tagSetName |
SystemDeviceManagementTagSetRegionModifyRequest(OCIRequest)
Request to modify the name of a region within a static configuration tag set for per- region tags override.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| tag_set_name | str | tagSetName |
| region_name | str | regionName |
| new_region_name | str | newRegionName Optional |
SystemDeviceManagementTagSetRegionTagDeleteListRequest(OCIRequest)
Request to delete a tag override to a region of a static configuration tag set.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| tag_set_name | str | tagSetName |
| region_name | str | regionName |
| tag_name | List[str] | tagName |
SystemDeviceManagementTagSetRegionTagGetListRequest(OCIRequest)
Request to get the list of tag overrides for a region within a static configuration tag set for per-region tags override.
The response is either a SystemDeviceManagementTagSetRegionTagGetListResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| tag_set_name | str | tagSetName |
| region_name | str | regionName |
SystemDeviceManagementTagSetRegionTagModifyRequest(OCIRequest)
Request to modify the value of a tag override within a region of a static configuration tag set.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| tag_set_name | str | tagSetName |
| region_name | str | regionName |
| tag_name | str | tagName |
| tag_value | str | tagValue Optional |
SystemDeviceProfileAuthenticationLockoutClearAllRequest(OCIRequest)
Request to clear all device password authentication lockouts in the system.
The response is either a SuccessResponse() or an ErrorResponse().
SystemDeviceProfileAuthenticationPasswordRulesGetRequest(OCIRequest)
Request to get the system level device profile authentication password rule settings.
The response is either a SystemDeviceProfileAuthenticationPasswordRulesGetResponse()
or an ErrorResponse().
SystemDeviceProfileAuthenticationPasswordRulesModifyRequest(OCIRequest)
Request to modify the system level device profile authentication password rule settings.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| disallow_authentication_name | bool | disallowAuthenticationName Optional |
| disallow_old_password | bool | disallowOldPassword Optional |
| disallow_reversed_old_password | bool | disallowReversedOldPassword Optional |
| restrict_min_digits | bool | restrictMinDigits Optional |
| min_digits | int | minDigits Optional |
| restrict_min_upper_case_letters | bool | restrictMinUpperCaseLetters Optional |
| min_upper_case_letters | int | minUpperCaseLetters Optional |
| restrict_min_lower_case_letters | bool | restrictMinLowerCaseLetters Optional |
| min_lower_case_letters | int | minLowerCaseLetters Optional |
| restrict_min_non_alphanumeric_characters | bool | restrictMinNonAlphanumericCharacters Optional |
| min_non_alphanumeric_characters | int | minNonAlphanumericCharacters Optional |
| min_length | int | minLength Optional |
| send_permanent_lockout_notification | bool | sendPermanentLockoutNotification Optional |
| permanent_lockout_notify_email_address | str | permanentLockoutNotifyEmailAddress Optional |
| device_profile_authentication_lockout_type | str | deviceProfileAuthenticationLockoutType Optional |
| device_profile_temporary_lockout_threshold | int | deviceProfileTemporaryLockoutThreshold Optional |
| device_profile_wait_algorithm | str | deviceProfileWaitAlgorithm Optional |
| device_profile_lockout_fixed_minutes | str | deviceProfileLockoutFixedMinutes Optional |
| device_profile_permanent_lockout_threshold | int | deviceProfilePermanentLockoutThreshold Optional |
| use_password_validation_service | bool | usePasswordValidationService Optional |
SystemDeviceTypeExportRequest(OCIRequest)
Request to export an existing Device Type to a Device Type Archive File (DTAF).
The response is either a SystemDeviceTypeExportResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemDeviceTypeGetAvailableListRequest(OCIRequest)
Requests a list of non-obsolete Identity/device profile types defined in the system.
It is possible to get either all conference device types or all non-conferernce types.
This command is similar to the SystemSIPDeviceTypeGetListRequest() and
SystemMGCPDeviceTypeGetListRequest() but gets both SIP and MGCP types.
The response is either SystemDeviceTypeGetlAvailableListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| allow_conference | bool | allowConference |
| allow_music_on_hold | bool | allowMusicOnHold |
| only_conference | bool | onlyConference |
| only_video_capable | bool | onlyVideoCapable |
| only_optional_ip_address | bool | onlyOptionalIpAddress |
SystemDeviceTypeGetAvailableListRequest14sp1(OCIRequest)
Requests a list of non-obsolete Identity/device profile types defined in the system.
It is possible to get either all conference device types or all non-conferernce types.
This command is similar to the SystemSIPDeviceTypeGetListRequest() and
SystemMGCPDeviceTypeGetListRequest() but gets both SIP and MGCP types.
The response is either SystemDeviceTypeGetlAvailableListResponse14sp1() or
ErrorResponse().
Replaced By: SystemDeviceTypeGetAvailableListRequest14sp3()
Attributes:
| Name | Type | Description |
|---|---|---|
| allow_conference | bool | allowConference |
| allow_music_on_hold | bool | allowMusicOnHold |
| only_conference | bool | onlyConference |
| only_video_capable | bool | onlyVideoCapable |
| only_optional_ip_address | bool | onlyOptionalIpAddress |
SystemDeviceTypeGetAvailableListRequest14sp3(OCIRequest)
Requests a list of non-obsolete Identity/device profile types defined in the system.
It is possible to get either all conference device types or all non-conferernce types.
This command is similar to the SystemSIPDeviceTypeGetListRequest() and
SystemMGCPDeviceTypeGetListRequest() but gets both SIP and MGCP types.
The response is either SystemDeviceTypeGetlAvailableListResponse14sp1() or
ErrorResponse(). Replaced by: SystemDeviceTypeGetAvailableListRequest19().
Attributes:
| Name | Type | Description |
|---|---|---|
| allow_conference | bool | allowConference |
| allow_music_on_hold | bool | allowMusicOnHold |
| only_conference | bool | onlyConference |
| only_video_capable | bool | onlyVideoCapable |
| only_optional_ip_address | bool | onlyOptionalIpAddress |
SystemDeviceTypeGetAvailableListRequest19(OCIRequest)
Requests a list of non-obsolete Identity/device profile types defined in the system.
It is possible to get either all conference device types or all non-conferernce types.
This command is similar to the SystemSIPDeviceTypeGetListRequest() and
SystemMGCPDeviceTypeGetListRequest() but gets both SIP and MGCP types.
The response is either SystemDeviceTypeGetlAvailableListResponse19() or
ErrorResponse(). Replaced by SystemDeviceTypeGetAvailableListRequest22() in AS
data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| allow_conference | bool | allowConference |
| allow_music_on_hold | bool | allowMusicOnHold |
| only_conference | bool | onlyConference |
| only_video_capable | bool | onlyVideoCapable |
| only_optional_ip_address | bool | onlyOptionalIpAddress |
SystemDeviceTypeGetAvailableListRequest22(OCIRequest)
Requests a list of non-obsolete Identity/device profile types defined in the system and resellers.
It is possible to get either all conference device types or all non-conference types.
This command is similar to the SystemSIPDeviceTypeGetListRequest() and
SystemMGCPDeviceTypeGetListRequest() but gets both SIP and MGCP types. If
excludeReseller is specified, only system level available device types are returned.
If resellerId is specified, all the system level available device types and the device
types in the given reseller are returned. If reseller administrator sends the
request, resellerId is not specified, the administrator's resellerId is used. If
neither excludeReseller nor resellerId is specified, all the system level and reseller
level available device types are returned. If excludeLeafDeviceTypes is specified,
leaf device types are excluded in the response returned. Leaf device types are device
types that have the option supportLinks set to "Support Link to Device". If
onlyTreeDeviceTypes is specified, all available tree device types are returned. Tree
device types are device types that have the option supportLinks set to "Support Links
from Devices". The following elements are only used in AS data mode and ignored in the
XS data mode: resellerId excludeLeafDeviceTypes onlyTreeDeviceTypes
The response is either SystemDeviceTypeGetlAvailableListResponse22() or
ErrorResponse(). Replaced by: SystemDeviceTypeGetAvailableListRequest22V2() in AS
data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| allow_conference | bool | allowConference |
| allow_music_on_hold | bool | allowMusicOnHold |
| only_conference | bool | onlyConference |
| only_video_capable | bool | onlyVideoCapable |
| only_optional_ip_address | bool | onlyOptionalIpAddress |
| exclude_reseller | bool | excludeReseller Optional |
| reseller_id | str | resellerId Optional |
| exclude_leaf_device_types | bool | excludeLeafDeviceTypes Optional |
| only_tree_device_types | bool | onlyTreeDeviceTypes Optional |
SystemDeviceTypeGetAvailableListRequest22V2(OCIRequest)
Requests a list of non-obsolete Identity/device profile types defined in the system and resellers.
It is possible to get either all conference device types or all non-conference types.
This command is similar to the SystemSIPDeviceTypeGetListRequest() and
SystemMGCPDeviceTypeGetListRequest() but gets both SIP and MGCP types. If
excludeReseller is specified, only system level available device types are returned.
If resellerId is specified, all the system level available device types and the device
types in the given reseller are returned. If reseller administrator sends the
request, resellerId is not specified, the administrator's resellerId is used. If
neither excludeReseller nor resellerId is specified, all the system level and reseller
level available device types are returned. If excludeLeafDeviceTypes is specified,
leaf device types are excluded in the response returned. Leaf device types are device
types that have the option supportLinks set to "Support Link to Device" or "Support
Link to Device and User". If onlyTreeDeviceTypes is specified, all available tree
device types are returned. Tree device types are device types that have the option
supportLinks set to "Support Links from Devices". The following elements are only used
in AS data mode and ignored in the XS data mode: resellerId excludeLeafDeviceTypes
onlyTreeDeviceTypes
The response is either SystemDeviceTypeGetlAvailableListResponse22V2() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| allow_conference | bool | allowConference |
| allow_music_on_hold | bool | allowMusicOnHold |
| only_conference | bool | onlyConference |
| only_video_capable | bool | onlyVideoCapable |
| only_optional_ip_address | bool | onlyOptionalIpAddress |
| exclude_reseller | bool | excludeReseller Optional |
| reseller_id | str | resellerId Optional |
| exclude_leaf_device_types | bool | excludeLeafDeviceTypes Optional |
| only_tree_device_types | bool | onlyTreeDeviceTypes Optional |
SystemDeviceTypeGetRequest(OCIRequest)
Requests the information about the specified device type without regard to whether the type is SIP or MGCP.
The response is either SystemDeviceTypeGetResponse() or ErrorResponse().
Replaced By: SystemDeviceTypeGetRequest14sp3()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemDeviceTypeGetRequest14sp3(OCIRequest)
Requests the information about the specified device type without regard to whether the type is SIP or MGCP.
The response is either SystemDeviceTypeGetResponse14sp3() or ErrorResponse().
Replaced By: SystemDeviceTypeGetRequest14sp6()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemDeviceTypeGetRequest14sp6(OCIRequest)
Requests the information about the specified device type without regard to whether the type is SIP or MGCP.
The response is either SystemDeviceTypeGetResponse14sp6() or ErrorResponse().
Replaced by: SystemDeviceTypeGetRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemDeviceTypeGetRequest16(OCIRequest)
Requests the information about the specified device type without regard to whether the type is SIP or MGCP.
The response is either SystemDeviceTypeGetResponse16() or ErrorResponse().
Replaced by: SystemDeviceTypeGetRequest16sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemDeviceTypeGetRequest16sp1(OCIRequest)
Replaced By SystemDeviceTypeGetRequest18().
Requests the information about the specified device type without regard to whether the type is SIP or MGCP.
The response is either SystemDeviceTypeGetResponse16sp1() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemDeviceTypeGetRequest18(OCIRequest)
Requests the information about the specified device type without regard to whether the type is SIP or MGCP.
The response is either SystemDeviceTypeGetResponse18() or ErrorResponse(). Note:
The elements deviceTypeConfigurationOption applies to SIP device types only.
Therefore, only present in the response when the device type is SIP. Replaced by:
SystemSIPDeviceTypeGetRequest19().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemDeviceTypeGetRequest19(OCIRequest)
Requests the information about the specified device type without regard to whether the type is SIP or MGCP.
The response is either SystemDeviceTypeGetResponse19() or ErrorResponse(). Note:
The elements deviceTypeConfigurationOption and staticLineOrdering apply to SIP device
types only. Therefore, only present in the response when the device type is SIP.
Replaced by: SystemSIPDeviceTypeGetRequest21sp1().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemDeviceTypeGetRequest21sp1(OCIRequest)
Requests the information about the specified device type without regard to whether the type is SIP or MGCP.
The response is either SystemDeviceTypeGetResponse21sp1() or ErrorResponse().
Note: The elements deviceTypeConfigurationOption and staticLineOrdering apply to SIP
device types only. Therefore, only present in the response when the device type is
SIP.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemDeviceTypeGetRequest22(OCIRequest)
Requests the information about the specified device type without regard to whether the type is SIP or MGCP.
The response is either SystemDeviceTypeGetResponse22() or ErrorResponse(). Note:
The elements deviceTypeConfigurationOption and staticLineOrdering apply to SIP device
types only. Therefore, only present in the response when the device type is SIP.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemDeviceTypeGetRequest22V2(OCIRequest)
Requests the information about the specified device type without regard to whether the type is SIP or MGCP.
The response is either SystemDeviceTypeGetResponse22V2() or ErrorResponse(). Note:
The elements deviceTypeConfigurationOption and staticLineOrdering apply to SIP device
types only. Therefore, only present in the response when the device type is SIP.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemDeviceTypeGetRequest22V3(OCIRequest)
Requests the information about the specified device type without regard to whether the type is SIP or MGCP.
The response is either SystemDeviceTypeGetResponse22V3() or ErrorResponse(). Note:
The elements deviceTypeConfigurationOption and staticLineOrdering apply to SIP device
types only. Therefore, only present in the response when the device type is SIP.
Replaced by: SystemDeviceTypeGetRequest22V4()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemDeviceTypeGetRequest22V4(OCIRequest)
Requests the information about the specified device type without regard to whether the type is SIP or MGCP.
The response is either SystemDeviceTypeGetResponse22V4() or ErrorResponse(). Note:
The elements deviceTypeConfigurationOption and staticLineOrdering apply to SIP device
types only. Therefore, only present in the response when the device type is SIP.
Replaced by: SystemDeviceTypeGetRequest22V5().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemDeviceTypeGetRequest22V5(OCIRequest)
Requests the information about the specified device type without regard to whether the type is SIP or MGCP.
The response is either SystemDeviceTypeGetResponse22V5() or ErrorResponse(). Note:
The elements deviceTypeConfigurationOption and staticLineOrdering apply to SIP device
types only. Therefore, only present in the response when the device type is SIP.
Replaced by: SystemDeviceTypeGetRequest22V6() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemDeviceTypeGetRequest22V6(OCIRequest)
Requests the information about the specified device type without regard to whether the type is SIP or MGCP.
The response is either SystemDeviceTypeGetResponse22V6() or ErrorResponse(). Note:
The elements deviceTypeConfigurationOption and staticLineOrdering apply to SIP device
types only. Therefore, only present in the response when the device type is SIP.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemDeviceTypeGetRequest22V7(OCIRequest)
Requests the information about the specified device type without regard to whether the type is SIP or MGCP.
The response is either SystemDeviceTypeGetResponse22V7() or ErrorResponse(). Note:
The elements deviceTypeConfigurationOption and staticLineOrdering apply to SIP device
types only. Therefore, only present in the response when the device type is SIP.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemDialPlanPolicyAddAccessCodeRequest(OCIRequest)
Request to add a system-level Dial Plan Access Code and its all attribues.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| access_code | str | accessCode |
| include_code_for_network_translations_and_routing | bool | includeCodeForNetworkTranslationsAndRouting |
| include_code_for_screening_services | bool | includeCodeForScreeningServices |
| enable_secondary_dial_tone | bool | enableSecondaryDialTone |
| description | str | description Optional |
SystemDialPlanPolicyDeleteAccessCodeRequest(OCIRequest)
Request to delete a system-level Dial Plan Access Code and its all attribues.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| access_code | str | accessCode |
SystemDialPlanPolicyGetAccessCodeListRequest(OCIRequest)
Request the system level Access Codes data associated with Dial Plan Policy.
The response is either a SystemDialPlanPolicyGetAccessCodeListResponse() or an
ErrorResponse().
SystemDialPlanPolicyGetAccessCodeRequest(OCIRequest)
Request access code data associated with system level Dial Plan Policy access codes.
The response is either a SystemDialPlanPolicyGetAccessCodeResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| access_code | str | accessCode |
SystemDialPlanPolicyGetRequest(OCIRequest)
Request the system level data associated with Dial Plan Policy.
The response is either a SystemDialPlanPolicyGetResponse() or an ErrorResponse().
Replaced by: SystemDialPlanPolicyGetRequest17()
SystemDialPlanPolicyGetRequest17(OCIRequest)
Request the system level data associated with Dial Plan Policy.
The response is either a SystemDialPlanPolicyGetResponse17() or an
ErrorResponse(). Replaced by: SystemDialPlanPolicyGetRequest22() in AS data mode.
SystemDialPlanPolicyGetRequest22(OCIRequest)
Request the system level data associated with Dial Plan Policy.
The response is either a SystemDialPlanPolicyGetResponse22() or an
ErrorResponse(). Replaced by: SystemDialPlanPolicyGetRequest22V2() in AS data
mode.
SystemDialPlanPolicyGetRequest22V2(OCIRequest)
Request the system level data associated with Dial Plan Policy.
The response is either a SystemDialPlanPolicyGetResponse22V2() or an
ErrorResponse().
SystemDialPlanPolicyModifyAccessCodeRequest(OCIRequest)
Request to modify a system-level Dial Plan Access Code and its attribues.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| access_code | str | accessCode |
| include_code_for_network_translations_and_routing | bool | includeCodeForNetworkTranslationsAndRouting Optional |
| include_code_for_screening_services | bool | includeCodeForScreeningServices Optional |
| enable_secondary_dial_tone | bool | enableSecondaryDialTone Optional |
| description | str | description Optional |
SystemDialPlanPolicyModifyRequest(OCIRequest)
Modify the system level data associated with Dial Plan Policy.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
overrideResolvedDeviceDigitMap deviceDigitMap permissiveOACDialing
performInternalTranslationsWithOAC
Attributes:
| Name | Type | Description |
|---|---|---|
| requires_access_code_for_public_calls | bool | requiresAccessCodeForPublicCalls Optional |
| allow_e164_public_calls | bool | allowE164PublicCalls Optional |
| prefer_e164_number_format_for_callback_services | bool | preferE164NumberFormatForCallbackServices Optional |
| public_digit_map | str | publicDigitMap Optional |
| private_digit_map | str | privateDigitMap Optional |
| override_resolved_device_digit_map | bool | overrideResolvedDeviceDigitMap Optional |
| device_digit_map | str | deviceDigitMap Optional |
| perform_internal_translations_with_oac | bool | performInternalTranslationsWithOAC Optional |
| permissive_oac_dialing | bool | permissiveOACDialing Optional |
SystemDialableCallerIDCriteriaAddRequest(OCIRequest)
Add a new Dialable Caller ID Criteria.
Criteria are added at the bottom of the list with the lowest priority.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| description | str | description Optional |
| prefix_digits | str | prefixDigits Optional |
| match_call_type | List[str] | matchCallType Optional |
| match_alternate_call_indicator | List[str] | matchAlternateCallIndicator Optional |
| match_local_category | bool | matchLocalCategory |
| match_national_category | bool | matchNationalCategory |
| match_interlata_category | bool | matchInterlataCategory |
| match_intralata_category | bool | matchIntralataCategory |
| match_international_category | bool | matchInternationalCategory |
| match_private_category | bool | matchPrivateCategory |
| match_emergency_category | bool | matchEmergencyCategory |
| match_other_category | bool | matchOtherCategory |
SystemDialableCallerIDCriteriaDeleteRequest(OCIRequest)
Delete a Dialable Caller ID Criteria.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemDialableCallerIDCriteriaGetRequest(OCIRequest)
Get an existing Dialable Caller ID Criteria.
The response is either a SystemDialableCallerIDCriteriaGetRequest() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemDialableCallerIDGetRequest(OCIRequest)
Get the system level Dialable Caller ID criteria list.
The response is either a SystemDialableCallerIDGetResponse() or an
ErrorResponse().
SystemDigitCollectionGetRequest13mp4(OCIRequest)
Request the system's digit collection attributes.
The response is either a SystemDigitCollectionGetResponse13mp4() or an
ErrorResponse().
SystemDigitCollectionModifyRequest(OCIRequest)
Modifies the system's digit collection attributes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| access_code | str | accessCode Optional |
| public_digit_map | str | publicDigitMap Optional |
| private_digit_map | str | privateDigitMap Optional |
SystemDnGetUtilizationListRequest(OCIRequest)
Request a list of DN utilizations by service providers.
If resellerId is specified, the DNs assigned to the enterprises/service providers within the reseller are returned. If reseller administrator sends the request and resellerId is not specified, the administrator's resellerId is used.
The response is either SystemDnUtilizationGetListResponse() or ErrorResponse().
The following data elements are only used in AS data mode: resellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId Optional |
SystemDnGetUtilizationRequest(OCIRequest)
Get the utilization of a single DN.
The response is either SystemDnGetUtilizationResponse() or ErrorResponse().
Replaced By: SystemDnGetUtilizationRequest14sp3()
Attributes:
| Name | Type | Description |
|---|---|---|
| phone_number | str | phoneNumber |
SystemDnGetUtilizationRequest14sp3(OCIRequest)
Get the utilization of a single DN.
The response is either SystemDnGetUtilizationResponse14sp3() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| phone_number | str | phoneNumber |
SystemDomainAddRequest(OCIRequest)
Add a system or reseller domain to the system.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| domain | str | domain |
| reseller_id | str | resellerId Optional |
SystemDomainDeleteRequest(OCIRequest)
Delete a system domain from the system.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| domain | str | domain |
SystemDomainGetAssignedServiceProviderListRequest(OCIRequest)
Request a list of service providers that have a given domain assigned.
If resellerId is specified, only the service providers within the reseller should be returned. If reseller administrator sends the request and resellerId is not specified, the administrator's resellerId is used.
The response is either SystemDomainGetAssignedServiceProviderListResponse() or
ErrorResponse(). The following elements are only used in AS data mode: resellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| domain | str | domain |
| reseller_id | str | resellerId Optional |
SystemDomainGetListRequest(OCIRequest)
Requests the list of all system-level domain names.
The response is either SystemDomainGetListResponse() or ErrorResponse(). Replaced
by SystemDomainGetListRequest22() in AS data mode.
SystemDomainGetListRequest22(OCIRequest)
Requests the list of all matching system-level domains and all matching reseller level domains.
If excludeReseller is specified, returns all matching system-level domain names only. If resellerId is specified, returns all matching system-level domain names and the given reseller's domains. If reseller administrator sends the request and resellerId is not specified, the administrator's resellerId is used.
The response is either SystemDomainGetListResponse22() or ErrorResponse(). The
following elements are only used in AS data mode: includeReseller resellerId Replaced
by SystemDomainGetListRequest22V2() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| exclude_reseller | bool | excludeReseller Optional |
| reseller_id | str | resellerId Optional |
SystemDomainParametersGetRequest(OCIRequest)
Request to get the list of system Domain parameters.
The response is either SystemDomainParametersGetResponse() or ErrorResponse().
SystemDomainParametersModifyRequest(OCIRequest)
Request to modify system Domain parameters.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: useAliasForDomain
Attributes:
| Name | Type | Description |
|---|---|---|
| use_alias_for_domain | bool | useAliasForDomain Optional |
| default_domain | str | defaultDomain Optional |
SystemEmergencyCallDDoSProtectionGetRequest(OCIRequest)
Get the system Emergency Call DDos Protection configurations.
The response is either SystemEmergencyCallDDoSProtectionGetResponse() or
ErrorResponse().
SystemEmergencyCallDDoSProtectionModifyRequest(OCIRequest)
Modify the Emergency Call DDos Protection settings.
The response is either SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enabled | bool | enabled Optional |
| sample_interval_seconds | int | sampleIntervalSeconds Optional |
| protection_rate | int | protectionRate Optional |
| protection_action | str | protectionAction Optional |
SystemEmergencyCallNotificationGetRequest(OCIRequest)
Request the system level data associated with Emergency Call Notification.
The response is either a SystemEmergencyCallNotificationGetResponse() or an
ErrorResponse().
SystemEmergencyCallNotificationModifyRequest(OCIRequest)
Modify the system level data associated with Emergency Call Notification.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| default_from_address | str | defaultFromAddress Optional |
SystemEmergencyZonesGetRequest(OCIRequest)
Request the system level data associated with Emergency Zones.
The response is either a SystemEmergencyZonesGetResponse() or an ErrorResponse().
SystemEmergencyZonesModifyRequest(OCIRequest)
Modify the system level data associated with Emergency Zones.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| default_from_address | str | defaultFromAddress Optional |
SystemEnhancedCallLogsActiveSchemaInstanceGetListRequest(OCIRequest)
Request the system level database schema instances defined for Enhanced Call Logs.
For each instance, the number of actual users (users that have the Enhanced Call Logs service, are assigned to that schema instance and have recorded call logs on the NDS) are given.
The response is either a SystemEnhancedCallLogsActiveSchemaInstanceGetListResponse()
or an ErrorResponse().
SystemEnhancedCallLogsGetRequest(OCIRequest)
Request the system level data associated with Enhanced Call Logs.
The response is either a SystemEnhancedCallLogsGetResponse() or an
ErrorResponse().
SystemEnhancedCallLogsGetRequest17sp4(OCIRequest)
Request the system level data associated with Enhanced Call Logs.
The response is either a SystemEnhancedCallLogsGetResponse17sp4() or an
ErrorResponse(). Replaced by:SystemEnhancedCallLogsGetRequest20sp1() in AS data
mode
SystemEnhancedCallLogsGetRequest20sp1(OCIRequest)
Request the system level data associated with Enhanced Call Logs.
The response is either a SystemEnhancedCallLogsGetResponse20sp1() or an
ErrorResponse(). Replaced by:SystemEnhancedCallLogsGetRequest22() in AS data mode
SystemEnhancedCallLogsGetRequest22(OCIRequest)
Request the system level data associated with Enhanced Call Logs.
Replaced by: SystemEnhancedCallLogsGetRequest24(). Response to
SystemDeviceTypeGetRequest16sp1().
SystemEnhancedCallLogsGetRequest22V2(OCIRequest)
Request the system level data associated with Enhanced Call Logs.
The response is either a SystemEnhancedCallLogsGetResponse22V2() or an
ErrorResponse().
SystemEnhancedCallLogsModifyRequest(OCIRequest)
Modify the system level data associated with Enhanced Call Logs.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: isSendEnabled server1NetAddress
server1SendPort server1RetrievePort server2NetAddress server2SendPort
server2RetrievePort sharedSecret retransmissionDelayMilliSeconds maxTransmissions
soapTimeoutSeconds useDBS eclQueryApplicationURL eclQueryDataRepositoryURL
Attributes:
| Name | Type | Description |
|---|---|---|
| is_send_enabled | bool | isSendEnabled Optional |
| server1_net_address | str | server1NetAddress Optional |
| server1_send_port | int | server1SendPort Optional |
| server1_retrieve_port | int | server1RetrievePort Optional |
| server2_net_address | str | server2NetAddress Optional |
| server2_send_port | int | server2SendPort Optional |
| server2_retrieve_port | int | server2RetrievePort Optional |
| shared_secret | str | sharedSecret Optional |
| retransmission_delay_milli_seconds | int | retransmissionDelayMilliSeconds Optional |
| max_transmissions | int | maxTransmissions Optional |
| soap_timeout_seconds | int | soapTimeoutSeconds Optional |
| use_dbs | bool | useDBS Optional |
| max_non_paged_response_size | int | maxNonPagedResponseSize Optional |
| ecl_query_application_url | str | eclQueryApplicationURL Optional |
| ecl_query_data_repository_url | str | eclQueryDataRepositoryURL Optional |
SystemEnhancedCallLogsModifyRequest22(OCIRequest)
Modify the system level data associated with Enhanced Call Logs.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| max_non_paged_response_size | int | maxNonPagedResponseSize Optional |
| ecl_query_application_url | str | eclQueryApplicationURL Optional |
| ecl_query_data_repository_url | str | eclQueryDataRepositoryURL Optional |
| default_schema | str | defaultSchema Optional |
SystemEnhancedCallLogsSchemaInstanceGetListRequest(OCIRequest)
Request the system level database schema instances defined for Enhanced Call Logs.
For each instance, the number of actual users (users that have the Enhanced Call Logs service and are assigned to that schema instance) and the number of potential users are given (users part of a group or service provider using that schema instance).
The response is either a SystemEnhancedCallLogsSchemaInstanceGetListResponse() or an
ErrorResponse().
SystemEnterpriseTrunkGetRequest(OCIRequest)
Request the system level data associated with the Enterprise Trunk service.
The response is either SystemEnterpriseTrunkGetResponse() or ErrorResponse().
SystemEnterpriseTrunkModifyRequest(OCIRequest)
Modify the system level data associated with the Enterprise Trunk Service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enable_holdover_of_highwater_call_counts | bool | enableHoldoverOfHighwaterCallCounts Optional |
| holdover_period | str | holdoverPeriod Optional |
| time_zone_offset_minutes | str | timeZoneOffsetMinutes Optional |
SystemExecutiveGetRequest(OCIRequest)
Request to get the Executive system parameters.
The response is either SystemExecutiveGetResponse() or ErrorResponse().
SystemExecutiveGetRequest24(OCIRequest)
Request to get the Executive system parameters.
The response is either SystemExecutiveGetResponse24() or ErrorResponse().
SystemExecutiveModifyRequest(OCIRequest)
Request to modify the Executive system parameters.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| treat_virtual_on_net_calls_as_internal | bool | treatVirtualOnNetCallsAsInternal Optional |
| consider_executive_on_hook_for_assistant_calls | bool | considerExecutiveOnHookForAssistantCalls Optional |
SystemExpensiveCallNotificationGetRequest(OCIRequest)
Request to get the expensive call notification service parameters.
The response is either a SystemExpensiveCallNotificationGetResponse() or an
ErrorResponse().
SystemExpensiveCallNotificationModifyRequest(OCIRequest)
Modify the expensive call notification service parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enable_post_announcement_delay_timer | bool | enablePostAnnouncementDelayTimer Optional |
| post_announcement_delay_seconds | int | postAnnouncementDelaySeconds Optional |
SystemExpensiveCallTypeAddRequest(OCIRequest)
Add an alternate call indicator to the list of expensive alternate call indicators.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| alternate_call_indicator | str | alternateCallIndicator |
| treatment_audio_file | str | treatmentAudioFile Optional |
SystemExpensiveCallTypeDeleteRequest(OCIRequest)
Delete an alternate call indicator from the list of expensive alternate call indicators.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| alternate_call_indicator | str | alternateCallIndicator |
SystemExpensiveCallTypeGetListRequest(OCIRequest)
Request to get the list of expensive alternate call indicators in the system.
The response is either a SystemExpensiveCallTypeGetListResponse() or an
ErrorResponse(). Replaced by: SystemExpensiveCallTypeGetListRequest16sp1()
SystemExpensiveCallTypeGetListRequest16sp1(OCIRequest)
Request to get the list of expensive alternate call indicators in the system.
The response is either a SystemExpensiveCallTypeGetListResponse16sp1() or an
ErrorResponse().
SystemExpensiveCallTypeModifyRequest(OCIRequest)
Modify an existing call indicator in the list of expensive alternate call indicators.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| alternate_call_indicator | str | alternateCallIndicator |
| treatment_audio_file | str | treatmentAudioFile Optional |
SystemExportAddressingDataRequest(OCIRequest)
Request to export Application Server addressing data, such as DNs, extensions, alias and user ids to a file so they can be uploaded to a Network Server.
In XS data mode, response is sent without waiting for completion.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| file_name | str | fileName |
SystemExportBroadCloudDataRequest(OCIRequest)
Request to export all users that have BroadCloud services, such as user profile information and BroadCloud services related information for that user to a file so they can be uploaded to a Messaging Server/BroadCloud.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| file_name | str | fileName |
SystemExportSubscriberRequest(OCIRequest)
Request subscribers be exported to files on the AS filesystem.
The response is either a SuccessResponse() or an ErrorResponse(). * Warning
***: This activity should only be done during non-busy hours on the secondary
provisioning server because this may cause large amounts of data to be dumped to disk
and it may take some time to execute.
SystemExtensionLengthGetRequest(OCIRequest)
Request the system's extension range.
The response is either a SystemExtensionLengthGetResponse() or an ErrorResponse().
SystemExtensionLengthModifyRequest(OCIRequest)
Modify the group's extension length range.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| min_extension_length | int | minExtensionLength Optional |
| max_extension_length | int | maxExtensionLength Optional |
SystemExternalAuthenticationAddACLEntryRequest(OCIRequest)
Add an entry to the external authentication access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| description | str | description Optional |
SystemExternalAuthenticationAddACLEntryRequest14sp2(OCIRequest)
Add an entry to the external authentication access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| description | str | description Optional |
SystemExternalAuthenticationDeleteACLEntryRequest(OCIRequest)
Delete an entry from the external authentication access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
SystemExternalAuthenticationDeleteACLEntryRequest14sp2(OCIRequest)
Delete an entry from the external authentication access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
SystemExternalAuthenticationGetACLListRequest(OCIRequest)
Get the external authentication access control list.
The response is either SystemExternalAuthenticationGetACLListResponse() or
ErrorResponse().
SystemExternalAuthenticationModifyACLEntryRequest(OCIRequest)
Modify an entry from the external authentication access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| description | str | description Optional |
SystemExternalAuthenticationModifyACLEntryRequest14sp2(OCIRequest)
Modify an entry from the external authentication access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| description | str | description Optional |
SystemExternalEmergencyRoutingParametersGetRequest13mp13(OCIRequest)
Request to get the list of External Emergency Routing system parameters.
The response is either SystemExternalEmergencyRoutingParametersGetResponse13mp13()
or ErrorResponse().
SystemExternalEmergencyRoutingParametersModifyRequest13mp13(OCIRequest)
Request to modify Call External Emergency Routing system parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_uri | str | serviceURI Optional |
| default_emergency_number | str | defaultEmergencyNumber Optional |
| is_active | bool | isActive Optional |
| supports_dnssrv | bool | supportsDNSSRV Optional |
| connection_timeout_seconds | int | connectionTimeoutSeconds Optional |
SystemFaxMessagingGetRequest(OCIRequest)
Request the system level data associated with Fax Messaging.
The response is either a SystemFaxMessagingGetResponse() or an ErrorResponse().
SystemFaxMessagingModifyRequest(OCIRequest)
Modify the system level data associated with Fax Messaging.
The following elements are only used in AS data mode and ignored in XS data mode: statusDurationHours statusAuditIntervalHours
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| status_duration_hours | int | statusDurationHours Optional |
| status_audit_interval_hours | int | statusAuditIntervalHours Optional |
| maximum_concurrent_faxes_per_user | int | maximumConcurrentFaxesPerUser Optional |
SystemFeatureAccessCodeGetListRequest(OCIRequest)
Request to get list of default Feature Access Codes defined on system level.
The response is either SystemFeatureAccessCodeGetListResponse() or
ErrorResponse(). Replaced by: SystemFeatureAccessCodeGetListRequest21() in AS data
mode
SystemFeatureAccessCodeGetListRequest20(OCIRequest)
Request to get list of default Feature Access Codes defined on system level.
The response is either SystemFeatureAccessCodeGetListResponse20() or
ErrorResponse(). In release 20 the "Call Recording" FAC name is changed to "Call
Recording - Start". Replaced by: SystemFeatureAccessCodeGetListRequest21()
SystemFeatureAccessCodeGetListRequest21(OCIRequest)
Request to get list of default Feature Access Codes defined on system level.
The response is either SystemFeatureAccessCodeGetListResponse20() or
ErrorResponse(). In release 20 the "Call Recording" FAC name is changed to "Call
Recording - Start".
SystemFileGetContentRequest(OCIRequest)
Requests the contents of a file.
This transaction is only allowed to get content for files under /var/broadworks/userfiles/AuditLogs/ or /var/broadworks/IpDeviceConfig/.
The response is either a SystemFileGetContentResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| file_name | str | fileName |
SystemFileRepositoryDeviceDeleteRequest(OCIRequest)
Delete a file repository.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemFileRepositoryDeviceGetListRequest(OCIRequest)
Request the list of file repositories in the system.
The response is either a SystemFileRepositoryDeviceGetListResponse() or an
ErrorResponse().
SystemFileRepositoryDeviceGetRequest(OCIRequest)
Request to get the file repository information.
The response is either SystemFileRepositoryDeviceGetResponse() or ErrorResponse().
Replaced by: SystemFileRepositoryDeviceGetRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemFileRepositoryDeviceGetRequest16(OCIRequest)
Request to get the file repository information.
The response is either SystemFileRepositoryDeviceGetResponse16() or
ErrorResponse(). Replaced by: SystemFileRepositoryDeviceGetRequest20()
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemFileRepositoryDeviceGetRequest20(OCIRequest)
Request to get the file repository information.
The response is either SystemFileRepositoryDeviceGetResponse20() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemFileRepositoryDeviceGetRequest22(OCIRequest)
Request to get the file repository information.
The response is either SystemFileRepositoryDeviceGetResponse22() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemFileRepositoryDeviceModifyRequest(OCIRequest)
Modify a file repository.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| root_directory | str | rootDirectory Optional |
| secure | bool | secure Optional |
| net_address | str | netAddress Optional |
| ftp_passive | bool | ftpPassive Optional |
| protocol | str | protocol Optional |
| port | int | port Optional |
| ftp_remote_verification | bool | ftpRemoteVerification Optional |
SystemFileRepositoryDeviceModifyRequest22(OCIRequest)
Modify a file repository.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| root_directory | str | rootDirectory Optional |
| secure | bool | secure Optional |
| net_address | str | netAddress Optional |
| ftp_passive | bool | ftpPassive Optional |
| protocol | str | protocol Optional |
| port | int | port Optional |
| ftp_remote_verification | bool | ftpRemoteVerification Optional |
SystemFileRepositoryDeviceUserAddRequest(OCIRequest)
Add a new file repository user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| file_repository_name | str | fileRepositoryName |
| user_name | str | userName |
| password | str | password |
| allow_put | bool | allowPut |
| allow_delete | bool | allowDelete |
| allow_get | bool | allowGet |
SystemFileRepositoryDeviceUserDeleteRequest(OCIRequest)
Delete a file repository user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| file_repository_name | str | fileRepositoryName |
| user_name | str | userName |
SystemFileRepositoryDeviceUserGetListRequest(OCIRequest)
Request the list of users for a file repository in the system.
The response is either a SystemFileRepositoryDeviceUserGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| file_repository_name | str | fileRepositoryName |
SystemFileRepositoryDeviceUserGetRequest(OCIRequest)
Request a user of a file repository in the system.
The response is either a SystemFileRepositoryDeviceUserGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| file_repository_name | str | fileRepositoryName |
| user_name | str | userName |
SystemFileRepositoryDeviceUserModifyRequest(OCIRequest)
Modify a file repository user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| file_repository_name | str | fileRepositoryName |
| user_name | str | userName |
| password | str | password Optional |
| allow_put | bool | allowPut Optional |
| allow_delete | bool | allowDelete Optional |
| allow_get | bool | allowGet Optional |
SystemGETSAvpCodeMapAddRequest(OCIRequest)
Add a GETS AVP Code map at the system level.
It maps a Diameter AVP Code with a vendor ID for.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| avp_code | int | avpCode |
| vendor_id | int | vendorId |
SystemGETSAvpCodeMapDeleteRequest(OCIRequest)
Delete a system GETS AVP Code map.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| avp_code | int | avpCode |
| vendor_id | int | vendorId |
SystemGETSAvpCodeMapGetListRequest(OCIRequest)
Get a list of GETS AVP Code Maps at the system level.
The response is either SystemGETSAvpCodeMapGetListResponse() or ErrorResponse().
SystemGETSGetRequest(OCIRequest)
Get the GETS system settings.
The response is either SystemGETSGetResponse() or ErrorResponse().
Replaced By: SystemGETSGetRequest22()
SystemGETSGetRequest22(OCIRequest)
Get the GETS system settings.
The response is either SystemGETSGetResponse22() or ErrorResponse().
SystemGETSModifyRequest(OCIRequest)
Modify GETS system settings.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enabled | bool | enabled Optional |
| enable_require_resource_priority | bool | enableRequireResourcePriority Optional |
| send_access_resource_priority | bool | sendAccessResourcePriority Optional |
| call_identifier_mode | str | callIdentifierMode Optional |
| default_priority_avp | int | defaultPriorityAVP Optional |
| signaling_dscp | int | signalingDSCP Optional |
| default_r_value | str | defaultRValue Optional |
| bypass_ro_release | bool | bypassRoRelease Optional |
| ignore_resource_priorities_when_gets_disabled | bool | ignoreResourcePrioritiesWhenGETSDisabled Optional |
SystemGETSNumberAddRequest(OCIRequest)
Add a GETS reserved Number.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| number | str | number |
| type | str | type |
| description | str | description Optional |
SystemGETSNumberDeleteRequest(OCIRequest)
Delete a GETS reserved Number.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| number | str | number |
SystemGETSNumberGetListRequest(OCIRequest)
Get a list of GETS reserved Numbers.
The response is either SystemGETSNumberGetListResponse() or ErrorResponse().
SystemGETSNumberModifyRequest(OCIRequest)
Modify a GETS reserved Number.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| number | str | number |
| type | str | type Optional |
| description | str | description Optional |
SystemGETSReservedFeatureAccessCodeAddRequest(OCIRequest)
Add a GETS reserved FAC.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| code | str | code |
| description | str | description Optional |
SystemGETSReservedFeatureAccessCodeDeleteRequest(OCIRequest)
Delete a GETS reserved FAC.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| code | str | code |
SystemGETSReservedFeatureAccessCodeGetListRequest(OCIRequest)
Get a list of GETS reserved FAC.
The response is either SystemGETSReservedFeatureAccessCodeGetListResponse() or
ErrorResponse().
SystemGETSReservedFeatureAccessCodeModifyRequest(OCIRequest)
Modify a GETS reserved FAC.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| code | str | code |
| new_code | str | newCode Optional |
| description | str | description Optional |
SystemGETSResourcePriorityAddRequest(OCIRequest)
Add a GETS Resource Priority.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| priority_value | str | priorityValue |
| priority_level | int | priorityLevel |
| priority_class | str | priorityClass |
SystemGETSResourcePriorityDeleteRequest(OCIRequest)
Delete a GETS Resource Priority.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| priority_value | str | priorityValue |
SystemGETSResourcePriorityGetListRequest(OCIRequest)
Get a list of GETS Resource Priorities.
The response is either SystemGETSResourcePriorityGetListResponse() or
ErrorResponse().
SystemGETSResourcePriorityModifyRequest(OCIRequest)
Modify a GETS reserved Resource Priority.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| priority_value | str | priorityValue |
| new_priority_value | str | newPriorityValue Optional |
| priority_level | int | priorityLevel Optional |
| priority_class | str | priorityClass Optional |
SystemGETSSessionPriorityMapAddRequest(OCIRequest)
Add a GETS Session Priority map.
It maps a priority level with a session priority AVP value.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| priority_level | int | priorityLevel |
| session_priority | int | sessionPriority |
SystemGETSSessionPriorityMapDeleteRequest(OCIRequest)
Delete a GETS Session Priority map.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| priority_level | int | priorityLevel |
SystemGETSSessionPriorityMapGetListRequest(OCIRequest)
Get a list of GETS Session Priority maps.
The response is either SystemGETSSessionPriorityMapGetListResponse() or
ErrorResponse().
SystemGETSSessionPriorityMapModifyRequest(OCIRequest)
Modify a GETS Session Priority Map.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| priority_level | int | priorityLevel |
| session_priority | int | sessionPriority Optional |
SystemGeographicRedundancyPeerSipConnectionMonitoringGetRequest(OCIRequest)
Request to get the list of Peer SIP Connection system parameters The response is a
SystemGeographicRedundancyPeerSipConnectionMonitoringGetResponse().
SystemGeographicRedundancyPeerSipConnectionMonitoringModifyRequest(OCIRequest)
Modify the list of Peer SIP Connection Monitoring system parameters The response is
either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enabled | bool | enabled Optional |
| heartbeat_interval | int | heartbeatInterval Optional |
| heartbeat_timeout | int | heartbeatTimeout Optional |
SystemGeographicRedundancyProxyGetRequest(OCIRequest)
Request to get the list of Geographic Redundancy Proxy system parameters The response
is a SystemGeographicRedundancyProxyGetResponse().
SystemGeographicRedundancyProxyModifyRequest(OCIRequest)
Modify the list of Geographic Redundancy Proxysystem parameters The response is either
a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enabled | bool | enabled Optional |
SystemGeographicRedundancyUnreachableFromPrimaryGetUserListRequest(OCIRequest)
Get the list of users that are unreachable from the primary application server.
The response is a
SystemGeographicRedundancyUnreachableFromPrimaryGetUserListResponse() or an
ErrorResponse(). Replaced by:
SystemGeographicRedundancyUnreachableFromPrimaryGetUserListRequest22() in AS data
mode
SystemGeographicRedundancyUnreachableFromPrimaryGetUserListRequest22(OCIRequest)
Get the list of users that are unreachable from the primary application server.
The response is a
SystemGeographicRedundancyUnreachableFromPrimaryGetUserListResponse22() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_list_size_limit | int | userListSizeLimit Optional |
SystemGetAvailableLeafDeviceListRequest(OCIRequest)
Requests the list of available leaf devices that can be linked to a tree device for the entire system.
A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device". It can be linked to only one tree device. The list returned includes devices created at the system, service provider, and group levels.
The response is either SystemGetAvailableLeafDeviceListResponse() or
ErrorResponse(). Replaced by: SystemGetAvailableLeafDeviceListRequest22().
SystemGetAvailableLeafDeviceListRequest22(OCIRequest)
Requests the list of available leaf devices that can be linked to a tree device for the entire system.
A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device. The list returned includes devices created at the system, service provider, and group levels. If the leafDeviceCategory is not set in the request, then linked leaf devices of all categories are requested, otherwise only the linked leaf devices of the specified category are requested. The category values are: "Handset", "Base Station", "All".
The response is either SystemGetAvailableLeafDeviceListResponse22() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| leaf_device_category | str | leafDeviceCategory Optional |
SystemGetAvailableTreeDeviceListRequest(OCIRequest)
Requests the list of available tree devices to link to for the entire system.
Requests the list of available tree devices to which a leaf device can be linked for the entire system. A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. The list returned includes devices created at the system, service provider, and group levels.
The response is either SystemGetAvailableTreeDeviceListResponse() or
ErrorResponse().
SystemGroupNightForwardingGetRequest(OCIRequest)
Request to get the Group Night Forwarding system parameters.
The response is either SystemGroupNightForwardingGetResponse() or ErrorResponse().
SystemGroupNightForwardingModifyRequest(OCIRequest)
Request to modify the Group Night Forwarding system parameters.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| night_forward_group_calls_within_enterprise | bool | nightForwardGroupCallsWithinEnterprise Optional |
SystemHPBXAlternateCarrierSelectionAddCarrierRequest(OCIRequest)
Add a new alternate carrier for CbC and Preselection.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| prefix | str | prefix |
| domain | str | domain |
| type | str | type |
SystemHPBXAlternateCarrierSelectionDeleteCarrierRequest(OCIRequest)
Delete an alternate carrier for CbC and Preselection.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemHPBXAlternateCarrierSelectionGetCarrierListRequest(OCIRequest)
Request the list of alternate carriers available for CbC and Preselection.
The response is either a SystemHPBXAlternateCarrierSelectionGetCarrierListResponse()
or an ErrorResponse().
SystemHPBXAlternateCarrierSelectionModifyCarrierRequest(OCIRequest)
Modify an alternate carrier for CbC and Preselection.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| new_name | str | newName Optional |
| prefix | str | prefix Optional |
| domain | str | domain Optional |
| type | str | type Optional |
SystemHPBXMobileTerminationGetRequest(OCIRequest)
Request to get the hPBX mobile termination related configuration parameters.
The response is either a SystemHPBXMobileTerminationGetResponse() or an
ErrorResponse().
SystemHPBXMobileTerminationModifyRequest(OCIRequest)
Request to modify the hPBX mobile termination related configuration parameters.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| routing_prefix | str | routingPrefix Optional |
SystemHolidayScheduleDeleteRequest(OCIRequest)
Delete a system holiday schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| holiday_schedule_name | str | holidayScheduleName |
SystemHolidayScheduleGetListRequest(OCIRequest)
Request a list of all system holiday schedules.
The response is either a SystemHolidayScheduleGetListResponse() or an
ErrorResponse().
SystemHolidayScheduleGetRequest(OCIRequest)
Get a system holiday schedule.
The response is either a SystemHolidayScheduleGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| holiday_schedule_name | str | holidayScheduleName |
SystemHomeNetworkAddRequest(OCIRequest)
Add a Home Network.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| msc_address | str | mscAddress |
SystemHomeNetworkDeleteRequest(OCIRequest)
Delete a Home Network.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| msc_address | str | mscAddress |
SystemHuntGroupGetRequest(OCIRequest)
Request the system level data associated with Hunt Group.
The response is either a SystemHuntGroupGetResponse() or an ErrorResponse().
Replaced by: SystemHuntGroupGetRequest17()
SystemHuntGroupGetRequest17(OCIRequest)
Request the system level data associated with Hunt Group.
The response is either a SystemHuntGroupGetResponse() or an ErrorResponse().
Replaced by: SystemHuntGroupGetRequest21() in AS data mode
SystemHuntGroupGetRequest21(OCIRequest)
Request the system level data associated with Hunt Group.
The response is either a SystemHuntGroupGetResponse21() or an ErrorResponse().
SystemHuntGroupModifyRequest(OCIRequest)
Modify the system level data associated with Hunt Group.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemHuntGroupModifyRequest21() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| anonymous_instead_of_private_clid | bool | anonymousInsteadOfPrivateCLID Optional |
| remove_hunt_group_name_from_clid | bool | removeHuntGroupNameFromCLID Optional |
| uniform_call_distribution_policy_scope | str | uniformCallDistributionPolicyScope Optional |
SystemHuntGroupModifyRequest21(OCIRequest)
Modify the system level data associated with Hunt Group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| remove_hunt_group_name_from_clid | bool | removeHuntGroupNameFromCLID Optional |
| uniform_call_distribution_policy_scope | str | uniformCallDistributionPolicyScope Optional |
| allow_agent_device_initiated_forward | bool | allowAgentDeviceInitiatedForward Optional |
SystemInCallServiceActivationGetRequest(OCIRequest)
Request the system's DTMF based in-call service activation trigger attributes.
The response is either a SystemInCallServiceActivationGetResponse() or an
ErrorResponse(). Replaced by: SystemInCallServiceActivationGetRequest17()
SystemInCallServiceActivationGetRequest17(OCIRequest)
Request the system's DTMF based in-call service activation trigger attributes.
The response is either a SystemInCallServiceActivationGetResponse17() or an
ErrorResponse().
SystemInCallServiceActivationModifyRequest(OCIRequest)
Modifies the system's DTMF based in-call service activation trigger attributes.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemInCallServiceActivationModifyRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| default_activation_digits | str | defaultActivationDigits Optional |
SystemInCallServiceActivationModifyRequest17(OCIRequest)
Modifies the system's DTMF based in-call service activation trigger attributes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| default_flash_activation_digits | str | defaultFlashActivationDigits Optional |
| default_call_transfer_activation_digits | str | defaultCallTransferActivationDigits Optional |
SystemIntegratedIMPGetRequest(OCIRequest)
Get the system Integrated IMP service attributes.
The response is either SystemIntegratedIMPGetResponse() or ErrorResponse().
Replaced by SystemIntegratedIMPGetRequest19().
SystemIntegratedIMPGetRequest19(OCIRequest)
Get the system Integrated IMP service attributes.
The response is either SystemIntegratedIMPGetResponse19() or ErrorResponse().
Replaced by: SystemIntegratedIMPGetRequest21() in AS data mode
SystemIntegratedIMPGetRequest21(OCIRequest)
Get the system Integrated IMP service attributes.
The response is either SystemIntegratedIMPGetResponse21() or ErrorResponse().
Replaced by: SystemIntegratedIMPGetRequest25() in AS data mode.
SystemIntegratedIMPGetRequest25(OCIRequest)
Get the system Integrated IMP service attributes.
The response is either SystemIntegratedIMPGetResponse25() or ErrorResponse().
SystemIntegratedIMPModifyRequest(OCIRequest)
Modify the system Integrated IMP service attributes.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: boshURL allowImpPasswordRetrieval
propagateImpErrorDetails
Attributes:
| Name | Type | Description |
|---|---|---|
| service_domain | str | serviceDomain Optional |
| service_port | int | servicePort Optional |
| add_service_provider_in_imp_user_id | bool | addServiceProviderInIMPUserId Optional |
| bosh_url | str | boshURL Optional |
| allow_imp_password_retrieval | bool | allowImpPasswordRetrieval Optional |
| propagate_imp_error_details | bool | propagateImpErrorDetails Optional |
SystemInterceptUserDeleteDnListRequest(OCIRequest)
Request to delete an Intercept User number(s) from the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| phone_numbers | List[str] | phoneNumbers |
SystemInterceptUserGetDnListRequest(OCIRequest)
Request to get a list of Intercept User dns defined in the system.
The response is either a SystemInterceptUserGetDnListResponse() or an
ErrorResponse().
SystemInterceptUserGetRequest(OCIRequest)
Get the system-level intercept user service settings.
The response is either a SystemInterceptUserGetResponse() or an ErrorResponse().
SystemInterceptUserModifyDnRequest(OCIRequest)
Request to modify a Intercept User number's description in the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| phone_number | str | phoneNumber |
| description | str | description Optional |
SystemInterceptUserModifyRequest(OCIRequest)
Modify the system-level intercept user service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| emergency_and_repair_intercept | bool | emergencyAndRepairIntercept Optional |
SystemInventoryReportGetRequest(OCIRequest)
Request the system level data associated with Inventory Report.
The response is either a SystemInventoryReportGetResponse() or an ErrorResponse().
SystemInventoryReportModifyRequest(OCIRequest)
Modify the system level data associated with Inventory Report.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| default_from_address | str | defaultFromAddress Optional |
SystemLanguageAddRequest(OCIRequest)
Request to add a language to the system.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemLanguageAddRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| language | str | language |
| locale | str | locale |
| encoding | str | encoding |
SystemLanguageAddRequest22(OCIRequest)
Request to add a language to the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| language | str | language |
| locale | str | locale |
| encoding | str | encoding |
SystemLanguageDeleteRequest(OCIRequest)
Request to delete a language from the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| language | str | language |
SystemLanguageGetListRequest(OCIRequest)
Request the defined languages in the system.
The response is either a SystemLanguageGetListResponse() or an ErrorResponse().
SystemLanguageModifyRequest(OCIRequest)
Request to modify a language properties in the system.
If the becomeDefaultLanguage element is present, the language in this request becomes the default language for the system.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemLanguageModifyRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| language | str | language |
| become_default_language | bool | becomeDefaultLanguage Optional |
| locale | str | locale Optional |
| encoding | str | encoding Optional |
SystemLanguageModifyRequest22(OCIRequest)
Request to modify a language properties in the system.
If the becomeDefaultLanguage element is present, the language in this request becomes the default language for the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| language | str | language |
| become_default_language | bool | becomeDefaultLanguage Optional |
| locale | str | locale Optional |
| encoding | str | encoding Optional |
SystemLegacyAutomaticCallbackGetLineTypeListRequest(OCIRequest)
Request the system's legacy automatic callback line type settings.
The response is either a SystemLegacyAutomaticCallbackGetTypeLineListResponse() or
an ErrorResponse().
SystemLegacyAutomaticCallbackGetRequest(OCIRequest)
Request the system's legacy automatic callback attributes.
The response is either a SystemLegacyAutomaticCallbackGetResponse() or an
ErrorResponse().
SystemLegacyAutomaticCallbackModifyLineTypeRequest(OCIRequest)
Modifies the system's legacy automatic callback line type attributes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| line_type | str | lineType |
| match_action | str | matchAction Optional |
| no_match_action | str | noMatchAction Optional |
SystemLegacyAutomaticCallbackModifyRequest(OCIRequest)
Modifies the system's legacy automatic callback attributes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| max_monitors_per_originator | int | maxMonitorsPerOriginator Optional |
| max_monitors_per_terminator | int | maxMonitorsPerTerminator Optional |
| t2_minutes | int | t2Minutes Optional |
| t4_seconds | int | t4Seconds Optional |
| t5_seconds | int | t5Seconds Optional |
| t6_minutes | int | t6Minutes Optional |
| t7_minutes | int | t7Minutes Optional |
| t8_seconds | int | t8Seconds Optional |
| t_ring_seconds | int | tRingSeconds Optional |
| t10_o_minutes | int | t10OMinutes Optional |
| t10_t_minutes | int | t10TMinutes Optional |
SystemLicensingGetRequest(OCIRequest)
Get all the licensing information.
The response is either SystemLicensingGetResponse() or ErrorResponse().
Replaced By: SystemLicensingGetRequest14sp3()
SystemLicensingGetRequest14sp3(OCIRequest)
Get all the licensing information.
The response is either SystemLicensingGetResponse14sp3() or ErrorResponse().
SystemLicensingGetRequest21sp1(OCIRequest)
Get all the licensing information.
The response is either SystemLicensingGetResponse21sp1() or ErrorResponse().
SystemLicensingGetSystemLicenseListRequest(OCIRequest)
Request to get the list of system licenses in the system.
The response is either a SystemLicensingGetSystemLicenseListResponse() or an
ErrorResponse(). Replaced by: SystemLicensingGetSystemLicenseListRequest21() in AS
data mode
SystemLicensingGetSystemLicenseListRequest19sp1(OCIRequest)
Request to get the list of system licenses in the system.
The response is either a SystemLicensingGetSystemLicenseListResponse21() or an
ErrorResponse(). Replaced by: SystemLicensingGetSystemLicenseListRequest21sp1().
SystemLicensingGetSystemLicenseListRequest21(OCIRequest)
Request to get the list of system licenses in the system.
The response is either a SystemLicensingGetSystemLicenseListResponse21() or an
ErrorResponse(). Replaced by: SystemLicensingGetSystemLicenseListRequest21p1.
SystemLicensingGetSystemLicenseListRequest21sp1(OCIRequest)
Request to get the list of system licenses in the system.
The response is either a SystemLicensingGetSystemLicenseListResponse21sp1() or an
ErrorResponse(). Replaced by: SystemLicensingGetSystemLicenseListRequest22().
SystemLicensingGetSystemLicenseListRequest22(OCIRequest)
Request to get the list of system licenses in the system.
The response is either a SystemLicensingGetSystemLicenseListResponse22() or an
ErrorResponse(). Replaced by: SystemLicensingGetSystemLicenseListRequest22V2().
SystemLicensingGetSystemLicenseListRequest22V2(OCIRequest)
Request to get the list of system licenses in the system.
The response is either a SystemLicensingGetSystemLicenseListResponse22V2() or an
ErrorResponse().
SystemLicensingReloadRequest(OCIRequest)
Load a new license file.
The response is either SuccessResponse() or ErrorResponse().
SystemLocationBasedCallingRestrictionsGetRequest(OCIRequest)
Gets system level the Location Based Calling Restrictions attributes.
The response is either a SystemLocationBasedCallingRestrictionsGetResponse() or an
ErrorResponse(). Replaced by:
SystemLocationBasedCallingRestrictionsGetRequest17sp3()
SystemLocationBasedCallingRestrictionsGetRequest17sp3(OCIRequest)
Gets system level the Location Based Calling Restrictions attributes.
The response is either a SystemLocationBasedCallingRestrictionsGetResponse17sp3() or
an ErrorResponse(). Replaced by:
SystemLocationBasedCallingRestrictionsGetRequest24()
SystemLocationBasedCallingRestrictionsGetRequest24(OCIRequest)
Gets system level the Location Based Calling Restrictions attributes.
The response is either a SystemLocationBasedCallingRestrictionsGetResponse24() or an
ErrorResponse().
SystemLocationBasedCallingRestrictionsModifyRequest(OCIRequest)
Modifies the system level Location Based Calling Restriction attributes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| physical_location_indicator | str | physicalLocationIndicator Optional |
| enforce_msc_validation | bool | enforceMscValidation Optional |
| enable_office_zone_announcement | bool | enableOfficeZoneAnnouncement Optional |
| enhance_office_zone | bool | enhanceOfficeZone Optional |
| enable_mcc_mnc_based_location | bool | enableMccMncBasedLocation Optional |
| mcc_mnc_roaming_network_translation_index | str | mccMncRoamingNetworkTranslationIndex Optional |
| default_mcc_mnc_based_location | str | defaultMccMncBasedLocation Optional |
SystemMGCPDeviceTypeGetListRequest(OCIRequest)
Request to get the list of mgcp device types in the system.
See Also: SystemDeviceTypeGetAvailableListRequest14sp3().
The response is either SystemMGCPDeviceTypeGetListResponse() or ErrorResponse().
SystemMGCPDeviceTypeGetRequest(OCIRequest)
Request to get a mgcp device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemMGCPDeviceTypeGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemMGCPDeviceTypeModifyRequest(OCIRequest)
Request to modify a mgcp device type.
In release 14, this is limited to changing the obsolete flag.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| is_obsolete | bool | isObsolete Optional |
SystemMailParametersGetRequest(OCIRequest)
Request to get the list of Mail system parameters.
The response is either SystemMailParametersGetResponse() or ErrorResponse().
SystemMailParametersGetRequest22(OCIRequest)
Request to get the list of Mail system parameters.
The response is either SystemMailParametersGetResponse22() or ErrorResponse().
SystemMailParametersModifyRequest(OCIRequest)
Request to modify Mail system parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| primary_server_net_address | str | primaryServerNetAddress Optional |
| secondary_server_net_address | str | secondaryServerNetAddress Optional |
| default_from_address | str | defaultFromAddress Optional |
| default_subject | str | defaultSubject Optional |
| support_dnssrv_for_mail_server_access | bool | supportDNSSRVForMailServerAccess Optional |
| secure_mode | str | secureMode Optional |
| port | int | port Optional |
SystemMaliciousCallTraceGetRequest(OCIRequest)
Get Malicious Call Trace system parameters and the list of users that use the Malicious Call Trace feature.
The response is either a SystemMaliciousCallTraceGetResponse() or an
ErrorResponse().
SystemMaliciousCallTraceGetUserListRequest(OCIRequest)
Request the list of users that use the Malicious Call Trace feature.
The response is either a SystemMaliciousCallTraceGetUserListResponse() or an
ErrorResponse().
Replaced By: SystemMaliciousCallTraceGetRequest()
SystemMaliciousCallTraceModifyRequest(OCIRequest)
Modify a Malicious Call Trace system parameter.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| play_mct_warning_announcement | bool | playMCTWarningAnnouncement Optional |
SystemMccMncHomeNetworkAddRequest(OCIRequest)
Adds a Mcc/Mnc home network.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| home_network_mcc_mnc | str | homeNetworkMccMnc |
SystemMccMncHomeNetworkDeleteRequest(OCIRequest)
Deletes a Mcc/Mnc home network.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| home_network_mcc_mnc | str | homeNetworkMccMnc |
SystemMccMncHomeNetworkGetListRequest(OCIRequest)
Get a list of Mcc/Mnc home networks at the system level.
The response is either SystemMccMncHomeNetworkGetListResponse() or
ErrorResponse().
SystemMediaAddRequest(OCIRequest)
Request to add a Media to the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| media_name | str | mediaName |
| codec_name | str | codecName |
| media_type | str | mediaType |
| bandwidth_enforcement_type | str | bandwidthEnforcementType |
| media_bandwidth | int | mediaBandwidth Optional |
SystemMediaAddRequest16(OCIRequest)
Request to add a Media to the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| media_name | str | mediaName |
| codec_name | str | codecName |
| media_type | str | mediaType |
| bandwidth_enforcement_type | str | bandwidthEnforcementType |
| media_bandwidth | int | mediaBandwidth Optional |
SystemMediaDeleteRequest(OCIRequest)
Request to delete a Media from the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| media_name | str | mediaName |
SystemMediaGetListRequest(OCIRequest)
Request to get a list of media in the system.
The response is either a SystemMediaGetListResponse() or an ErrorResponse().
SystemMediaGroupAddRequest(OCIRequest)
Request to add a media group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemMediaGroupCodecAddRequest(OCIRequest)
Request to add a media to a media group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| codec_name | str | codecName |
| codec_weight | int | codecWeight |
SystemMediaGroupCodecDeleteRequest(OCIRequest)
Request to delete media from a media group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| codec_name | str | codecName |
SystemMediaGroupCodecGetListRequest(OCIRequest)
Request to get the list of media under a media group.
The response is either SystemMediaGroupCodecGetListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemMediaGroupCodecModifyRequest(OCIRequest)
Request to modify a media associated with a media group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| codec_name | str | codecName |
| codec_weight | int | codecWeight Optional |
SystemMediaGroupDeleteRequest(OCIRequest)
Request to delete a media group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemMediaGroupGetListRequest(OCIRequest)
Request to get the list of media groups.
The response is either SystemMediaGroupGetListResponse() or ErrorResponse().
SystemMediaGroupModifyRequest(OCIRequest)
Request to modify a media group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| new_name | str | newName Optional |
SystemMediaGroupUsageListRequest(OCIRequest)
Request to get the list of SAC groups associated with a media group.
The response is either SystemMediaGroupUsageResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemMediaModifyRequest(OCIRequest)
Request to modify a media.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| media_name | str | mediaName |
| codec_name | str | codecName Optional |
| bandwidth_enforcement_type | str | bandwidthEnforcementType Optional |
| media_bandwidth | int | mediaBandwidth Optional |
SystemMediaServerAddRequest14(OCIRequest)
Request to add a Media Server to the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| port | int | port Optional |
| transport_protocol | str | transportProtocol |
| description | str | description Optional |
SystemMediaServerDeleteRequest(OCIRequest)
Request to delete a Media Server from the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
SystemMediaServerGetListRequest(OCIRequest)
Request to get a list of Media Servers defined in the system.
The response is either a SystemMediaServerGetListResponse() or an ErrorResponse().
SystemMediaServerModifyRequest(OCIRequest)
Request to modify a Media Server in the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| port | int | port Optional |
| transport_protocol | str | transportProtocol Optional |
| description | str | description Optional |
SystemMediaServerParametersGetRequest(OCIRequest)
Request to get the list of Media Server system parameters.
The response is either SystemMediaServerParametersGetResponse() or
ErrorResponse().
SystemMediaServerParametersModifyRequest(OCIRequest)
Request to modify Media Server system parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| media_server_response_timer_milliseconds | int | mediaServerResponseTimerMilliseconds Optional |
| media_server_selection_route_timer_milliseconds | int | mediaServerSelectionRouteTimerMilliseconds Optional |
| use_static_media_server_device | bool | useStaticMediaServerDevice Optional |
SystemMediaSetAddRequest(OCIRequest)
Request to add a Media Set.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| set_name | str | setName |
| media_name | List[str] | mediaName |
SystemMediaSetDeleteRequest(OCIRequest)
Request to delete a Media Set.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| set_name | str | setName |
SystemMediaSetGetListRequest(OCIRequest)
Request to get the list of Media Sets in the system.
The response is either a SystemMediaSetGetListResponse() or an ErrorResponse().
SystemMediaSetGetRequest(OCIRequest)
Request to get a Media Set.
The response is either a SystemMediaSetGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| set_name | str | setName |
SystemMeetMeConferencingGetRequest(OCIRequest)
Request the system level data associated with Meet-Me Conferencing functions.
The response is either a SystemMeetMeConferencingGetResponse() or an
ErrorResponse(). Replaced by: SystemMeetMeConferencingGetRequest17sp3()
SystemMeetMeConferencingGetRequest17sp3(OCIRequest)
Request the system level data associated with Meet-Me Conferencing functions.
The response is either a SystemMeetMeConferencingGetResponse17sp3() or an
ErrorResponse(). Replaced by: SystemMeetMeConferencingGetRequest18()
SystemMeetMeConferencingGetRequest18(OCIRequest)
Request the system level data associated with Meet-Me Conferencing functions.
The response is either a SystemMeetMeConferencingGetResponse18() or an
ErrorResponse(). Replaced by SystemMeetMeConferencingGetRequest19()
SystemMeetMeConferencingGetRequest19(OCIRequest)
Request the system level data associated with Meet-Me Conferencing functions.
The response is either a SystemMeetMeConferencingGetResponse19() or an
ErrorResponse().
SystemMigratedUsersGetListRequest(OCIRequest)
Get a list of migrated users.
The response is either SystemMigratedUsersGetListResponse() or ErrorResponse().
Replaced by: SystemMigratedUsersGetListRequest22() in AS data mode
SystemMigratedUsersGetListRequest22(OCIRequest)
Get a list of migrated users.
If the optional parameter userListSizeLimit is set, then the list returned in the response will contain entries up to value of userListSizeLimit.
The response is either SystemMigratedUsersGetListResponse22() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_list_size_limit | int | userListSizeLimit Optional |
SystemMultimediaPolicyGetRequest(OCIRequest)
Request the system level data associated with Multimedia Policy.
The response is either a SystemMultimediaPolicyGetResponse() or an
ErrorResponse().
SystemMultimediaPolicyModifyRequest(OCIRequest)
Modify the system level data associated with Multimedia Policy.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| restrict_non_audio_video_media_types | bool | restrictNonAudioVideoMediaTypes Optional |
SystemMusicOnHoldGetRequest(OCIRequest)
Request the system level data associated with Music On Hold.
The response is either a SystemMusicOnHoldGetResponse() or an ErrorResponse().
SystemMusicOnHoldModifyRequest(OCIRequest)
Modify the system level data associated with Music On Hold.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| delay_milliseconds | int | delayMilliseconds Optional |
SystemNetworkAdministratorParametersGetRequest(OCIRequest)
Get the network administrator settings for the system.
The response is either a SystemNetworkAdministratorParametersGetResponse() or an
ErrorResponse().
SystemNetworkAdministratorParametersModifyRequest(OCIRequest)
Modify the network administrator settings for the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enabled | bool | enabled Optional |
| cache_refresh_interval_in_minutes | int | cacheRefreshIntervalInMinutes Optional |
SystemNetworkClassOfServiceDeleteRequest(OCIRequest)
Delete a Network Class of Service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemNetworkClassOfServiceGetAssignedServiceProviderListRequest(OCIRequest)
Request a list of service providers that have a given Network Class of Service assigned.
The response is either a
SystemNetworkClassOfServiceGetAssignedServiceProviderListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemNetworkClassOfServiceGetAssignedSystemVoicePortalListRequest(OCIRequest)
Request a list of system voice portals that have a given Network Class of Service assigned.
The response is either a
SystemNetworkClassOfServiceGetAssignedSystemVoicePortalListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemNetworkClassOfServiceGetCommunicationBarringProfileUsageListRequest(OCIRequest)
Get the list of Network Classes of Service that contain a specific Communication Barring Profile.
The response is either a
SystemNetworkClassOfServiceGetCommunicationBarringProfileUsageListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemNetworkClassOfServiceGetListRequest(OCIRequest)
Get the list of all Network Classes of Service.
The response is either a SystemNetworkClassOfServiceGetListResponse() or an
ErrorResponse().
SystemNetworkClassOfServiceGetRequest(OCIRequest)
Get an existing Network Class of Service.
The response is either a SystemNetworkClassOfServiceGetResponse() or an
ErrorResponse(). Replaced by: SystemNetworkClassOfServiceGetRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemNetworkClassOfServiceGetRequest17(OCIRequest)
Get an existing Network Class of Service.
The response is either a SystemNetworkClassOfServiceGetResponse17() or an
ErrorResponse(). Replaced by: SystemNetworkClassOfServiceGetRequest19sp1() in AS
data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemNetworkClassOfServiceGetRequest19sp1(OCIRequest)
Get an existing Network Class of Service.
The response is either a SystemNetworkClassOfServiceGetResponse19sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemNetworkDeviceMonitorParametersGetRequest(OCIRequest)
Request to get the list of Network Device Polling system parameters.
The response is either SystemNetworkDeviceMonitorParametersGetResponse() or
ErrorResponse().
SystemNetworkDeviceMonitorParametersModifyRequest(OCIRequest)
Request to modify Network Device Polling system parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| polling_interval_minutes | int | pollingIntervalMinutes Optional |
| failed_polling_interval_minutes | int | failedPollingIntervalMinutes Optional |
SystemNetworkProgressionGetRequest(OCIRequest)
Request the system level data associated with network progression.
The response is either a SystemNetworkProgressionGetResponse() or an
ErrorResponse().
SystemNetworkProgressionModifyRequest(OCIRequest)
Modify the system level data associated with network progression.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| is_active | bool | isActive Optional |
| wait_period_seconds | int | waitPeriodSeconds Optional |
SystemNetworkRoutingServerAddRequest(OCIRequest)
Request to add a routing Network Server to the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| port | int | port Optional |
| transport_protocol | str | transportProtocol |
| poll | bool | poll |
| description | str | description Optional |
SystemNetworkRoutingServerDeleteRequest(OCIRequest)
Request to delete a routing Network Server from the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
SystemNetworkRoutingServerGetListRequest(OCIRequest)
Request to get a list of routing Network Servers defined in the system.
The response is either a SystemNetworkRoutingServerGetListResponse() or an
ErrorResponse().
SystemNetworkRoutingServerModifyRequest(OCIRequest)
Request to modify a routing Network Server in the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| port | int | port Optional |
| transport_protocol | str | transportProtocol Optional |
| poll | bool | poll Optional |
| description | str | description Optional |
SystemNetworkServerSyncParametersGetRequest(OCIRequest)
Request to get the list of Network Server Sync system parameters.
The response is either SystemNetworkServerSyncParametersGetResponse() or
ErrorResponse().
SystemNetworkServerSyncParametersGetRequest14sp2(OCIRequest)
Request to get the list of Network Server Sync system parameters.
The response is either SystemNetworkServerSyncParametersGetResponse14sp2() or
ErrorResponse().
Replaced By: SystemNetworkServerSyncParametersGetRequest16()
SystemNetworkServerSyncParametersGetRequest16(OCIRequest)
Request to get the list of Network Server Sync system parameters.
The response is either SystemNetworkServerSyncParametersGetResponse16() or
ErrorResponse().
Replaced By: SystemNetworkServerSyncParametersGetRequest17sp4()
SystemNetworkServerSyncParametersGetRequest17sp4(OCIRequest)
Request to get the list of Network Server Sync system parameters.
The response is either SystemNetworkServerSyncParametersGetResponse17sp4() or
ErrorResponse(). Replaced by: SystemNetworkServerSyncParametersGetRequest24()
SystemNetworkServerSyncParametersGetRequest22(OCIRequest)
Request to get the list of Network Server Sync system parameters.
The response is either SystemNetworkServerSyncParametersGetResponse22() or
ErrorResponse(). Replaced by: SystemNetworkServerSyncParametersGetRequest24V2() in
AS data mode.
SystemNetworkServerSyncParametersGetRequest24(OCIRequest)
Request to get the list of Network Server Sync system parameters.
The response is either SystemNetworkServerSyncParametersGetResponse24() or
ErrorResponse(). Replaced by: SystemNetworkServerSyncParametersGetRequest24V2() in
AS data mode.
SystemNetworkServerSyncParametersGetRequest24V2(OCIRequest)
Request to get the list of Network Server Sync system parameters.
The response is either SystemNetworkServerSyncParametersGetResponse24V2() or
ErrorResponse().
SystemNetworkServerSyncParametersModifyRequest(OCIRequest)
Request to modify Network Server Sync system parameters.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode: syncTrunkGroups syncConnectionTimeoutSeconds
Attributes:
| Name | Type | Description |
|---|---|---|
| enable_sync | bool | enableSync Optional |
| sync_line_ports | bool | syncLinePorts Optional |
| sync_device_management_info | bool | syncDeviceManagementInfo Optional |
| sync_trunk_groups | bool | syncTrunkGroups Optional |
| sync_connection_timeout_seconds | int | syncConnectionTimeoutSeconds Optional |
| sync_enterprise_numbers | bool | syncEnterpriseNumbers Optional |
SystemNetworkSynchingServerAddRequest(OCIRequest)
Request to add a Network Server to the system.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by
SystemNetworkSynchingServerAddRequest22V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| port | int | port Optional |
| description | str | description Optional |
SystemNetworkSynchingServerAddRequest22(OCIRequest)
Request to add a Network Server to the system.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by
SystemNetworkSynchingServerAddRequest22V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| port | int | port |
| description | str | description Optional |
| order | int | order |
SystemNetworkSynchingServerAddRequest22V2(OCIRequest)
Request to add a Network Server to the system.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in XS data mode and ignored in AS data mode: order
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| port | int | port |
| description | str | description Optional |
| order | int | order Optional |
| secure | bool | secure |
SystemNetworkSynchingServerDeleteRequest(OCIRequest)
Request to delete a Network Server from the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
SystemNetworkSynchingServerGetListRequest(OCIRequest)
Request to get a list of Network Servers defined in the system.
The response is either a SystemNetworkSynchingServerGetListResponse() or an
ErrorResponse().
SystemNetworkSynchingServerModifyRequest(OCIRequest)
Request to modify a Network Server in the system.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: becomePreferred
The following elements are only used in XS data mode and ignored in AS data mode:
order Replaced by SystemNetworkSynchingServerModifyRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| port | int | port Optional |
| description | str | description Optional |
| become_preferred | bool | becomePreferred Optional |
| order | int | order Optional |
SystemNetworkSynchingServerModifyRequest22(OCIRequest)
Request to modify a Network Server in the system.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: becomePreferred
The following elements are only used in XS data mode and ignored in AS data mode:
order
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| port | int | port Optional |
| description | str | description Optional |
| become_preferred | bool | becomePreferred Optional |
| order | int | order Optional |
| secure | bool | secure Optional |
SystemNotificationOfReachabilityParametersGetRequest(OCIRequest)
Request to get the system Notification of Reachability parameters.
The response is either SystemNotificationOfReachabilityParametersGetResponse() or
ErrorResponse().
SystemNotificationOfReachabilityParametersModifyRequest(OCIRequest)
Request to modify the system Notification of Reachability parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enable_no_r | bool | enableNoR Optional |
| always_send_third_party_v_mfor_unreachable | bool | alwaysSendThirdPartyVMforUnreachable Optional |
| disable_fa_cfor_third_party_voice_mail | bool | disableFACforThirdPartyVoiceMail Optional |
SystemNumberActivationGetRequest(OCIRequest)
Request to get the Number Activation state.
The response is either SystemNumberActivationGetResponse() or ErrorResponse().
SystemNumberActivationGetRequest18sp1(OCIRequest)
Request to get the Number Activation state.
The response is either SystemNumberActivationGetResponse18sp1() or
ErrorResponse(). Replaced by: SystemNumberActivationGetRequest21()
SystemNumberActivationGetRequest21(OCIRequest)
Request to get the number activation state and enterprise trunk number range activation status.
The response is either SystemNumberActivationGetResponse21() or ErrorResponse().
SystemNumberActivationModifyRequest(OCIRequest)
Request to modify system number activation setting.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| use_number_activation | bool | useNumberActivation Optional |
SystemNumberActivationModifyRequest18sp1(OCIRequest)
Request to modify system number activation and enterprise trunk number range activation setting.
The response is either SuccessResponse() or ErrorResponse(). The following element
values are only applicable in AS data mode: enableEnterpriseTrunkNumberRangeActivation
numberActivationMode = Group And User Activation Enabled will raise an error in XS
data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| number_activation_mode | str | numberActivationMode Optional |
| enable_enterprise_trunk_number_range_activation | bool | enableEnterpriseTrunkNumberRangeActivation Optional |
SystemNumberFormattingParametersGetRequest(OCIRequest)
Request to get the system number formatting parameters.
The response is either SystemNumberFormattingParametersGetResponse() or
ErrorResponse().
SystemNumberFormattingParametersModifyRequest(OCIRequest)
Request to modify the system number formatting parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| apply_formatting_to_e164_numbers | bool | applyFormattingToE164Numbers Optional |
SystemNumberPortabilityQueryDigitPatternAddRequest(OCIRequest)
Request to add a System Number Portability Query Status Digit Pattern mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| digit_pattern | str | digitPattern |
| status | str | status |
SystemNumberPortabilityQueryDigitPatternDeleteListRequest(OCIRequest)
Request to delete a list of System Number Portability Status Digit Pattern mappings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| digit_pattern | List[str] | digitPattern |
SystemNumberPortabilityQueryDigitPatternGetRequest(OCIRequest)
Request to get a System Number Portability Status Digit Pattern mapping.
The response is either a SystemNumberPortabilityQueryDigitPatternGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| digit_pattern | str | digitPattern |
SystemNumberPortabilityQueryDigitPatternModifyRequest(OCIRequest)
Request to modify a System Number Portability Status Digit Pattern mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| digit_pattern | str | digitPattern |
| new_digit_pattern | str | newDigitPattern Optional |
| status | str | status Optional |
SystemNumberPortabilityQueryGetRequest(OCIRequest)
Get system Number Portability Query Parameters.
The response is either SystemNumberPortabilityQueryGetResponse() or
ErrorResponse().
SystemNumberPortabilityQueryModifyRequest(OCIRequest)
Modify system Number Portability Query Parameters.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| continue_call_as_dialed_on_timeout_or_error | bool | continueCallAsDialedOnTimeoutOrError Optional |
| number_portability_name_lookup_timeout_milliseconds | int | numberPortabilityNameLookupTimeoutMilliseconds Optional |
SystemNumberPortabilityQueryStatusAddRequest(OCIRequest)
Add a system number portability status information.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| status | str | status |
| treatment_file_name | str | treatmentFileName Optional |
SystemNumberPortabilityQueryStatusDeleteListRequest(OCIRequest)
Delete a list of system number portability query statuses.
The number of status entries is limited to 100.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| status | List[str] | status |
SystemNumberPortabilityQueryStatusGetListRequest(OCIRequest)
Get a list system Number Portability Query Statuses.
The response is either SystemNumberPortabilityQueryStatusGetListResponse() or
ErrorResponse().
SystemNumberPortabilityQueryStatusGetRequest(OCIRequest)
Get information for a system Number Portability Query Status.
The response is either SystemNumberPortabilityQueryStatusGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| status | str | status |
SystemNumberPortabilityQueryStatusModifyRequest(OCIRequest)
Modify the system number portability status information.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| status_name | str | statusName |
| new_status_name | str | newStatusName Optional |
| treatment_file_name | str | treatmentFileName Optional |
SystemOCIAddACLEntryRequest(OCIRequest)
Add an entry to the OCI access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| description | str | description Optional |
SystemOCICallControlAddACLEntryRequest(OCIRequest)
Add an entry to the OCI call control access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| description | str | description Optional |
SystemOCICallControlApplicationAddACLEntryRequest(OCIRequest)
Add an entry to the OCI call control application access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| application_id | str | applicationId |
| net_address | str | netAddress |
| description | str | description Optional |
SystemOCICallControlApplicationAddRequest(OCIRequest)
Add an application to the OCI call control application list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| application_id | str | applicationId |
| enable_system_wide | bool | enableSystemWide |
| description | str | description Optional |
SystemOCICallControlApplicationAddRequest14sp9(OCIRequest)
Add an application to the OCI call control application list.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
SystemOCICallControlApplicationAddRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| application_id | str | applicationId |
| enable_system_wide | bool | enableSystemWide |
| notification_timeout_seconds | int | notificationTimeoutSeconds |
| description | str | description Optional |
SystemOCICallControlApplicationAddRequest17(OCIRequest)
Add an application to the OCI call control application list.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
SystemOCICallControlApplicationAddRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| application_id | str | applicationId |
| enable_system_wide | bool | enableSystemWide |
| notification_timeout_seconds | int | notificationTimeoutSeconds |
| description | str | description Optional |
| max_event_channels_per_set | int | maxEventChannelsPerSet |
SystemOCICallControlApplicationAddRequest22(OCIRequest)
Add an application to the OCI call control application list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| application_id | str | applicationId |
| enable_system_wide | bool | enableSystemWide |
| notification_timeout_seconds | int | notificationTimeoutSeconds |
| description | str | description Optional |
| max_event_channels_per_set | int | maxEventChannelsPerSet |
| unresponsive_channel_set_grace_period_seconds | int | unresponsiveChannelSetGracePeriodSeconds |
SystemOCICallControlApplicationDeleteACLEntryRequest(OCIRequest)
Delete an entry from the OCI call control application access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| application_id | str | applicationId |
| net_address | str | netAddress |
SystemOCICallControlApplicationDeleteRequest(OCIRequest)
Delete an entry from the OCI call control application list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| application_id | str | applicationId |
SystemOCICallControlApplicationGetACLListRequest(OCIRequest)
Get the OCI call control access control list.
The response is either SystemOCICallControlApplicationGetACLListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| application_id | str | applicationId |
SystemOCICallControlApplicationGetListRequest(OCIRequest)
Get the OCI call control application list.
The response is either SystemOCICallControlApplicationGetListResponse() or
ErrorResponse().
SystemOCICallControlApplicationModifyACLEntryRequest(OCIRequest)
Modify an entry from the call control access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| application_id | str | applicationId |
| net_address | str | netAddress |
| description | str | description Optional |
SystemOCICallControlApplicationModifyRequest(OCIRequest)
Modify an application from the OCI call control application list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| application_id | str | applicationId |
| enable_system_wide | bool | enableSystemWide Optional |
| notification_timeout_seconds | int | notificationTimeoutSeconds Optional |
| description | str | description Optional |
| max_event_channels_per_set | int | maxEventChannelsPerSet Optional |
| unresponsive_channel_set_grace_period_seconds | int | unresponsiveChannelSetGracePeriodSeconds Optional |
SystemOCICallControlDeleteACLEntryRequest(OCIRequest)
Delete an entry from the OCI call control access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
SystemOCICallControlGetACLListRequest(OCIRequest)
Get the OCI call control access control list.
The response is either SystemOCICallControlGetACLListResponse() or
ErrorResponse().
SystemOCICallControlModifyACLEntryRequest(OCIRequest)
Modify an entry from the call control access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| description | str | description Optional |
SystemOCIDeleteACLEntryRequest(OCIRequest)
Delete an entry from the OCI access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
SystemOCIGetACLListRequest(OCIRequest)
Get the OCI access control list.
The response is either SystemOCIGetACLListResponse() or ErrorResponse().
SystemOCIModifyACLEntryRequest(OCIRequest)
Modify an entry in the OCI access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| description | str | description Optional |
SystemOCIReportingAddACLEntryRequest13mp9(OCIRequest)
Add an entry to the OCI Reporting Access Control List.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| description | str | description Optional |
| restrict_messages | bool | restrictMessages |
SystemOCIReportingAddMessageNameListRequest(OCIRequest)
Add a list of reported messages for a host in the OCI Reporting Access Control List.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| message_name_starts_with | List[str] | messageNameStartsWith |
SystemOCIReportingDeleteACLEntryRequest(OCIRequest)
Delete an entry from the OCI Reporting Access Control List.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
SystemOCIReportingDeleteMessageNameListRequest(OCIRequest)
Delete a list of reported messages from a host in the OCI Reporting Access Control List.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| delete_all_message_names | bool | deleteAllMessageNames Optional |
| message_name_starts_with | List[str] | messageNameStartsWith Optional |
SystemOCIReportingGetACLListRequest(OCIRequest)
Get the OCI Reporting Access Control List.
The response is either a SystemOCIReportingACLListGetResponse() or an
ErrorResponse().
SystemOCIReportingGetMessageNameListRequest(OCIRequest)
Get a list of restricted messages from a host in the OCI Reporting Access Control List.
The response is either a SystemOCIReportingGetMessageNameListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
SystemOCIReportingModifyACLEntryRequest(OCIRequest)
Modify the description on an entry in the OCI Reporting Access Control List.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| description | str | description Optional |
| restrict_messages | bool | restrictMessages Optional |
SystemOCIReportingParametersGetRequest(OCIRequest)
Request to get the list of OCIReporting system parameters.
The response is either SystemOCIReportingParametersGetResponse() or
ErrorResponse().
SystemOCIReportingParametersGetRequest14sp1(OCIRequest)
Request to get the list of OCIReporting system parameters.
The response is either SystemOCIReportingParametersGetResponse14sp1() or
ErrorResponse().
SystemOCIReportingParametersGetRequest22(OCIRequest)
Request to get the list of OCIReporting system parameters.
The response is either SystemOCIReportingParametersGetResponse22() or
ErrorResponse().
SystemOCIReportingParametersModifyRequest(OCIRequest)
Request to modify OCI Reporting system parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| server_port | int | serverPort Optional |
| enable_connection_ping | bool | enableConnectionPing Optional |
| connection_ping_interval_seconds | int | connectionPingIntervalSeconds Optional |
| alter_passwords | bool | alterPasswords Optional |
| enable_public_identity_reporting | bool | enablePublicIdentityReporting Optional |
| secure | bool | secure Optional |
SystemOfficeZoneAddRequest(OCIRequest)
Add a new Office Zone.
The zoneList is an ordered list with the first member being of the highest priority.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| office_zone_name | str | officeZoneName |
| description | str | description Optional |
| zone_name | List[str] | zoneName |
| primary_zone_name | str | primaryZoneName |
SystemOfficeZoneDeleteRequest(OCIRequest)
Delete an Office Zone.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| office_zone_name | str | officeZoneName |
SystemOfficeZoneGetAssignedServiceProviderListRequest(OCIRequest)
Request a list of service providers that have a given Office Zone assigned.
The response is either a SystemOfficeZoneGetAssignedServiceProviderListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| office_zone_name | str | officeZoneName |
SystemOfficeZoneGetListRequest(OCIRequest)
Get the list of all Office Zones.
The response is either a SystemOfficeZoneGetListResponse() or an ErrorResponse().
SystemOfficeZoneGetRequest(OCIRequest)
Get an existing Office Zone.
The response is either a SystemOfficeZoneGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| office_zone_name | str | officeZoneName |
SystemOfficeZoneGetZoneUsageListRequest(OCIRequest)
Get the list of Office Zones that contain a specific Zone.
The response is either a SystemOfficeZoneGetZoneUsageListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| zone_name | str | zoneName |
SystemOutboundProxyCacheParametersGetRequest(OCIRequest)
Request to get the list of Outbound Proxy Cache system parameters.
The response is either SystemOutboundProxyCacheParametersGetResponse() or
ErrorResponse(). Note that an error is returned if CloudPBX is not licensed.
SystemOutboundProxyCacheParametersModifyRequest(OCIRequest)
Request to modify Outbound Proxy Cache system parameters.
The response is either SuccessResponse() or ErrorResponse(). Note that an error is
returned if CloudPBX is not licensed.
Attributes:
| Name | Type | Description |
|---|---|---|
| eviction_timeout_minutes | int | evictionTimeoutMinutes Optional |
| refresh_timeout_minutes | int | refreshTimeoutMinutes Optional |
| audit_interval_minutes | int | auditIntervalMinutes Optional |
| maximum_cache_size | int | maximumCacheSize Optional |
| dns_type_default_value | str | dnsTypeDefaultValue Optional |
| use_dns_srv_default_value | str | useDnsSrvDefaultValue Optional |
| srv_prefix_default_value | str | srvPrefixDefaultValue Optional |
| outbound_proxy_default_value | str | outboundProxyDefaultValue Optional |
| transport_type_default_value | str | transportTypeDefaultValue Optional |
| secure_rtp_default_value | str | secureRtpDefaultValue Optional |
SystemOutboundProxyCacheStaleRequest(OCIRequest)
Request to stale the Outbound Proxy Cache.
The response is either SuccessResponse() or ErrorResponse(). Note that an error is
returned if CloudPBX is not licensed.
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId Optional |
| service_provider_id | str | serviceProviderId Optional |
SystemOutgoingCallingPlanCallTypeAddMappingRequest(OCIRequest)
Add a system outgoing calling plan call type mapping.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| country_code | str | countryCode |
| digit_map | str | digitMap |
| call_type | str | callType |
SystemOutgoingCallingPlanCallTypeDeleteMappingRequest(OCIRequest)
Delete a system outgoing calling plan call type mapping.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| country_code | str | countryCode |
| digit_map | str | digitMap |
SystemOutgoingCallingPlanCallTypeGetListRequest(OCIRequest)
Request to get the list of call types of outgoing calling plan Response is
SystemOutgoingCallingPlanCallTypeGetListRequest() or ErrorResponse().
SystemOutgoingCallingPlanCallTypeGetMappingListRequest(OCIRequest)
Get a list of system outgoing calling plan call type mappings.
The response is either SystemOutgoingCallingPlanCallTypeGetMappingListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| country_code | str | countryCode Optional |
SystemOutgoingCallingPlanGetRequest(OCIRequest)
Request the system level data associated with Outgoing Calling Plan.
The response is either a SystemOutgoingCallingPlanGetResponse() or an
ErrorResponse().
SystemOutgoingCallingPlanGetRequest17sp3(OCIRequest)
Request the system level data associated with Outgoing Calling Plan.
The response is either a SystemOutgoingCallingPlanGetResponse17sp3() or an
ErrorResponse().
SystemOutgoingCallingPlanModifyRequest(OCIRequest)
Modify the system level data associated with Outgoing Calling Plan.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| direct_transfer_screening | bool | directTransferScreening Optional |
| enable_enhanced_toll_call_typing | bool | enableEnhancedTollCallTyping Optional |
SystemPasswordRulesGetRequest13mp2(OCIRequest)
Requests the system's password rules setting applicable to System administrator, Provisioning Administrator, and/or Service Provider Administrator, Group Administrator, Department Administrator, user.
The response is either SystemPasswordRulesGetResponse13mp2() or ErrorResponse().
Replaced By : SystemPasswordRulesGetRequest16()
SystemPasswordRulesGetRequest16(OCIRequest)
Requests the system's password rules setting applicable to System administrator, Provisioning Administrator, and/or Service Provider Administrator, Group Administrator, Department Administrator, user.
The response is either SystemPasswordRulesGetResponse16() or ErrorResponse().
Replaced by: SystemPasswordRulesGetRequest22() in AS data mode.
SystemPasswordRulesGetRequest22(OCIRequest)
Requests the system's password rules setting applicable to System administrator, Provisioning Administrator, and/or Service Provider Administrator, Group Administrator, Department Administrator, user.
The response is either SystemPasswordRulesGetResponse22() or ErrorResponse().
Replaced by: SystemPasswordRulesGetRequest23() in AS data mode.
SystemPasswordRulesGetRequest23(OCIRequest)
Requests the system's password rules setting applicable to System administrator, Provisioning Administrator, and/or Service Provider Administrator, Group Administrator, Department Administrator, user.
The response is either SystemPasswordRulesGetResponse23() or ErrorResponse().
SystemPasswordRulesGetRequest24(OCIRequest)
Requests the system's password rules setting applicable to System administrator, Provisioning Administrator, and/or Service Provider Administrator, Group Administrator, Department Administrator, user.
The response is either SystemPasswordRulesGetResponse24() or ErrorResponse().
SystemPasswordRulesModifyRequest(OCIRequest)
Request to modify the system providers password rule setting applicable to System Adminstrator, Provisioning Administrator, and/or Service Provider Administrator, Group Administrator, Department Administrator, User.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: SystemPasswordRulesModifyRequest14sp3()
Attributes:
| Name | Type | Description |
|---|---|---|
| rules_apply_to | str | rulesApplyTo Optional |
| allow_web_add_external_authentication_users | bool | allowWebAddExternalAuthenticationUsers Optional |
| disallow_user_id | bool | disallowUserId Optional |
| disallow_old_password | bool | disallowOldPassword Optional |
| disallow_reversed_old_password | bool | disallowReversedOldPassword Optional |
| restrict_min_digits | bool | restrictMinDigits Optional |
| min_digits | int | minDigits Optional |
| restrict_min_upper_case_letters | bool | restrictMinUpperCaseLetters Optional |
| min_upper_case_letters | int | minUpperCaseLetters Optional |
| restrict_min_lower_case_letters | bool | restrictMinLowerCaseLetters Optional |
| min_lower_case_letters | int | minLowerCaseLetters Optional |
| restrict_min_non_alphanumeric_characters | bool | restrictMinNonAlphanumericCharacters Optional |
| min_non_alphanumeric_characters | int | minNonAlphanumericCharacters Optional |
| min_length | int | minLength Optional |
| max_failed_login_attempts | int | maxFailedLoginAttempts Optional |
| password_expires_days | int | passwordExpiresDays Optional |
| send_login_disabled_notify_email | bool | sendLoginDisabledNotifyEmail Optional |
| login_disabled_notify_email_address | str | loginDisabledNotifyEmailAddress Optional |
| disallow_rules_modification | bool | disallowRulesModification Optional |
SystemPasswordRulesModifyRequest14sp3(OCIRequest)
Request to modify the system providers password rule setting applicable to System Adminstrator, Provisioning Administrator, and/or Service Provider Administrator, Group Administrator, Department Administrator, User.
The following elements are only used in AS data mode and ignored in XS data mode: forcePasswordChangeAfterReset
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| rules_apply_to | str | rulesApplyTo Optional |
| allow_web_add_external_authentication_users | bool | allowWebAddExternalAuthenticationUsers Optional |
| disallow_user_id | bool | disallowUserId Optional |
| disallow_old_password | bool | disallowOldPassword Optional |
| disallow_reversed_old_password | bool | disallowReversedOldPassword Optional |
| restrict_min_digits | bool | restrictMinDigits Optional |
| min_digits | int | minDigits Optional |
| restrict_min_upper_case_letters | bool | restrictMinUpperCaseLetters Optional |
| min_upper_case_letters | int | minUpperCaseLetters Optional |
| restrict_min_lower_case_letters | bool | restrictMinLowerCaseLetters Optional |
| min_lower_case_letters | int | minLowerCaseLetters Optional |
| restrict_min_non_alphanumeric_characters | bool | restrictMinNonAlphanumericCharacters Optional |
| min_non_alphanumeric_characters | int | minNonAlphanumericCharacters Optional |
| min_length | int | minLength Optional |
| max_failed_login_attempts | int | maxFailedLoginAttempts Optional |
| password_expires_days | int | passwordExpiresDays Optional |
| send_login_disabled_notify_email | bool | sendLoginDisabledNotifyEmail Optional |
| login_disabled_notify_email_address | str | loginDisabledNotifyEmailAddress Optional |
| disallow_previous_passwords | bool | disallowPreviousPasswords Optional |
| number_of_previous_passwords | int | numberOfPreviousPasswords Optional |
| force_password_change_after_reset | bool | forcePasswordChangeAfterReset Optional |
| enforce_external_auth_for_route_point | bool | enforceExternalAuthForRoutePoint Optional |
| use_password_validation_service | bool | usePasswordValidationService Optional |
SystemPasswordRulesModifyRequest24(OCIRequest)
Request to modify the system providers password rule setting applicable to System Adminstrator, Provisioning Administrator, and/or Service Provider Administrator, Group Administrator, Department Administrator, User.
The following elements are only used in AS data mode and ignored in XS data mode: forcePasswordChangeAfterReset
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| rules_apply_to | str | rulesApplyTo Optional |
| allow_web_add_external_authentication_users | bool | allowWebAddExternalAuthenticationUsers Optional |
| disallow_user_id | bool | disallowUserId Optional |
| disallow_old_password | bool | disallowOldPassword Optional |
| disallow_reversed_old_password | bool | disallowReversedOldPassword Optional |
| restrict_min_digits | bool | restrictMinDigits Optional |
| min_digits | int | minDigits Optional |
| restrict_min_upper_case_letters | bool | restrictMinUpperCaseLetters Optional |
| min_upper_case_letters | int | minUpperCaseLetters Optional |
| restrict_min_lower_case_letters | bool | restrictMinLowerCaseLetters Optional |
| min_lower_case_letters | int | minLowerCaseLetters Optional |
| restrict_min_non_alphanumeric_characters | bool | restrictMinNonAlphanumericCharacters Optional |
| min_non_alphanumeric_characters | int | minNonAlphanumericCharacters Optional |
| min_length | int | minLength Optional |
| max_failed_login_attempts | int | maxFailedLoginAttempts Optional |
| password_expires_days | int | passwordExpiresDays Optional |
| send_login_disabled_notify_email | bool | sendLoginDisabledNotifyEmail Optional |
| login_disabled_notify_email_address | str | loginDisabledNotifyEmailAddress Optional |
| disallow_previous_passwords | bool | disallowPreviousPasswords Optional |
| number_of_previous_passwords | int | numberOfPreviousPasswords Optional |
| force_password_change_after_reset | bool | forcePasswordChangeAfterReset Optional |
| enforce_external_auth_for_route_point | bool | enforceExternalAuthForRoutePoint Optional |
SystemPasswordSecurityParametersGetRequest(OCIRequest)
Get the password security parameters for the system.
The response is either a SystemPasswordSecurityParametersGetResponse() or an
ErrorResponse().
SystemPasswordSecurityParametersModifyRequest(OCIRequest)
Modify the password security settings for the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| use_existing_hashing | bool | useExistingHashing Optional |
| enforce_password_change_on_expiry | bool | enforcePasswordChangeOnExpiry Optional |
SystemPerformanceMeasurementGenerateReportRequest(OCIRequest)
Generate a performance measurements report.
The response is either SuccessResponse() or ErrorResponse().
SystemPerformanceMeasurementReportingAddFileServerRequest(OCIRequest)
Add a performance measurements reporting ftp server.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| ftp_host_net_address | str | ftpHostNetAddress |
| ftp_user_id | str | ftpUserId |
| ftp_user_password | str | ftpUserPassword |
| passive_ftp | bool | passiveFTP Optional |
SystemPerformanceMeasurementReportingAddFileServerRequest22(OCIRequest)
Add a performance measurements reporting ftp server.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| repository_url | str | repositoryUrl |
| ftp_user_id | str | ftpUserId |
| ftp_user_password | str | ftpUserPassword |
| passive_ftp | bool | passiveFTP Optional |
SystemPerformanceMeasurementReportingDeleteFileServerRequest(OCIRequest)
Delete a performance measurements reporting ftp server.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| ftp_host_net_address | str | ftpHostNetAddress |
SystemPerformanceMeasurementReportingDeleteFileServerRequest22(OCIRequest)
Delete a performance measurements reporting ftp server.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| repository_url | str | repositoryUrl |
SystemPerformanceMeasurementReportingGetFileServerListRequest(OCIRequest)
Requests the list performance measurements reporting ftp servers.
The response is either
SystemPerformanceMeasurementReportingGetFileServerListResponse() or
ErrorResponse().
SystemPerformanceMeasurementReportingGetFileServerListRequest22(OCIRequest)
Requests the list performance measurements reporting ftp servers.
The response is either
SystemPerformanceMeasurementReportingGetFileServerListResponse22() or
ErrorResponse().
SystemPerformanceMeasurementReportingGetRequest(OCIRequest)
Requests the performance measurements reporting settings.
The response is either SystemPerformanceMeasurementReportingGetResponse() or
ErrorResponse(). Replaced by: SystemPerformanceMeasurementReportingGetRequest22()
SystemPerformanceMeasurementReportingGetRequest22(OCIRequest)
Requests the performance measurements reporting settings.
The response is either SystemPerformanceMeasurementReportingGetResponse22() or
ErrorResponse(). Replaced by: SystemPerformanceMeasurementReportingGetRequest24()
SystemPerformanceMeasurementReportingGetRequest24(OCIRequest)
Requests the performance measurements reporting settings.
The response is either SystemPerformanceMeasurementReportingGetResponse24() or
ErrorResponse().
SystemPerformanceMeasurementReportingModifyFileServerRequest(OCIRequest)
Modify a performance measurements reporting ftp server.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| ftp_host_net_address | str | ftpHostNetAddress |
| passive_ftp | bool | passiveFTP Optional |
SystemPerformanceMeasurementReportingModifyFileServerRequest22(OCIRequest)
Modify a performance measurements reporting ftp server.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| repository_url | str | repositoryUrl |
| passive_ftp | bool | passiveFTP Optional |
SystemPerformanceMeasurementReportingModifyRequest(OCIRequest)
Modify the performance measurements reporting settings.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| is_active | bool | isActive Optional |
| reporting_interval | int | reportingInterval Optional |
| reset_measurements_after_each_report | bool | resetMeasurementsAfterEachReport Optional |
| report_enterprise | bool | reportEnterprise Optional |
| report_service_provider | bool | reportServiceProvider Optional |
| report_device | bool | reportDevice Optional |
| report_table | bool | reportTable Optional |
| report_encoding | str | reportEncoding Optional |
SystemPersonalAssistantGetRequest(OCIRequest)
Get system Personal Assistant Parameters.
The response is either SystemPersonalAssistantGetResponse() or ErrorResponse().
SystemPersonalAssistantModifyRequest(OCIRequest)
Modify system Personal Assistant Parameters.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| transfer_to_attendant_key | str | transferToAttendantKey Optional |
| transfer_to_voice_messaging_key | str | transferToVoiceMessagingKey Optional |
SystemPhoneListsGetRequest(OCIRequest)
Get system phone list settings.
The response is either SystemPhoneListsGetResponse() or ErrorResponse().
SystemPhoneListsModifyRequest(OCIRequest)
Modify system phone list settings.
Attributes:
| Name | Type | Description |
|---|---|---|
| allow_special_numbers_in_phone_lists | bool | allowSpecialNumbersInPhoneLists Optional |
SystemPhysicalLocationGetRequest(OCIRequest)
Request to get the list of Physical Location system parameters.
The response is either SystemPhysicalLocationGetResponse() or ErrorResponse().
SystemPhysicalLocationModifyRequest(OCIRequest)
Request to modify Physical Location system parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| always_allow_emergency_calls | bool | alwaysAllowEmergencyCalls Optional |
SystemPolicyGetDefaultRequest14(OCIRequest)
Requests the system's default policy settings.
The response is either SystemPolicyGetDefaultResponse14() or ErrorResponse().
SystemPolicyGetDefaultRequest14sp1(OCIRequest)
Requests the system's default policy settings.
The response is either SystemPolicyGetDefaultResponse14sp1() or ErrorResponse().
Replaced By: SystemPolicyGetDefaultRequest14sp4()
SystemPolicyGetDefaultRequest14sp4(OCIRequest)
Requests the system's default policy settings.
The response is either SystemPolicyGetDefaultResponse14sp4() or ErrorResponse().
SystemPolicyGetDefaultRequest16sp1(OCIRequest)
Requests the system's default policy settings.
The response is either SystemPolicyGetDefaultResponse16sp1() or ErrorResponse().
SystemPolicyGetDefaultRequest16sp2(OCIRequest)
Requests the system's default policy settings.
The response is either SystemPolicyGetDefaultResponse16sp2() or ErrorResponse().
SystemPolicyGetDefaultRequest17(OCIRequest)
Requests the system's default policy settings.
The response is either SystemPolicyGetDefaultResponse17() or ErrorResponse().
SystemPolicyGetDefaultRequest17sp1(OCIRequest)
Requests the system's default policy settings.
The response is either SystemPolicyGetDefaultResponse17sp1() or ErrorResponse().
SystemPolicyGetDefaultRequest17sp3(OCIRequest)
Requests the system's default policy settings.
The response is either SystemPolicyGetDefaultResponse17sp3() or ErrorResponse().
SystemPolicyGetDefaultRequest18(OCIRequest)
Requests the system's default policy settings.
The response is either SystemPolicyGetDefaultResponse18() or ErrorResponse().
Replaced by: SystemPolicyGetDefaultRequest20() in AS data mode Replaced by:
SystemPolicyGetDefaultRequest22() in XS data mode
SystemPolicyGetDefaultRequest19sp1(OCIRequest)
Requests the system's default policy settings.
The response is either SystemPolicyGetDefaultResponse19sp1() or ErrorResponse().
Replaced by: SystemPolicyGetDefaultRequest20() in AS mode
SystemPolicyGetDefaultRequest20(OCIRequest)
Requests the system's default policy settings.
The response is either SystemPolicyGetDefaultResponse20() or ErrorResponse().
Replaced by: SystemPolicyGetDefaultRequest22() in AS mode
SystemPolicyGetDefaultRequest22(OCIRequest)
Requests the system's default policy settings.
The response is either SystemPolicyGetDefaultResponse22() or ErrorResponse().
SystemPolicyModifyDefaultRequest14(OCIRequest)
Request to modify the system's default policy settings.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode: GroupAdminDialableCallerIDAccess
ServiceProviderAdminDialableCallerIDAccess
GroupAdminCommunicationBarringUserProfileAccess (This element is only used for groups
in an Enterprise) GroupAdminVerifyTranslationAndRoutingAccess
ServiceProviderVerifyTranslationAndRoutingAccess
groupUserAutoAttendantNameDialingAccess The following elements are only used in XS
data mode: serviceProviderAdminCommunicationBarringAccess Replaced by:
SystemPolicyModifyDefaultRequest22() in AS and XS mode
Attributes:
| Name | Type | Description |
|---|---|---|
| group_calling_plan_access | str | groupCallingPlanAccess Optional |
| group_extension_access | str | groupExtensionAccess Optional |
| group_ldap_integration_access | str | groupLDAPIntegrationAccess Optional |
| group_voice_messaging_access | str | groupVoiceMessagingAccess Optional |
| group_department_admin_user_access | str | groupDepartmentAdminUserAccess Optional |
| group_department_admin_trunk_group_access | str | groupDepartmentAdminTrunkGroupAccess Optional |
| group_department_admin_phone_number_extension_access | str | groupDepartmentAdminPhoneNumberExtensionAccess Optional |
| group_department_admin_calling_line_id_number_access | str | groupDepartmentAdminCallingLineIdNumberAccess Optional |
| group_user_authentication_access | str | groupUserAuthenticationAccess Optional |
| group_user_group_directory_access | str | groupUserGroupDirectoryAccess Optional |
| group_user_profile_access | str | groupUserProfileAccess Optional |
| group_user_enhanced_call_logs_access | str | groupUserEnhancedCallLogsAccess Optional |
| group_user_auto_attendant_name_dialing_access | str | groupUserAutoAttendantNameDialingAccess Optional |
| group_admin_profile_access | str | groupAdminProfileAccess Optional |
| group_admin_user_access | str | groupAdminUserAccess Optional |
| group_admin_admin_access | str | groupAdminAdminAccess Optional |
| group_admin_department_access | str | groupAdminDepartmentAccess Optional |
| group_admin_access_device_access | str | groupAdminAccessDeviceAccess Optional |
| group_admin_enhanced_service_instance_access | str | groupAdminEnhancedServiceInstanceAccess Optional |
| group_admin_feature_access_code_access | str | groupAdminFeatureAccessCodeAccess Optional |
| group_admin_phone_number_extension_access | str | groupAdminPhoneNumberExtensionAccess Optional |
| group_admin_calling_line_id_number_access | str | groupAdminCallingLineIdNumberAccess Optional |
| group_admin_service_access | str | groupAdminServiceAccess Optional |
| group_admin_trunk_group_access | str | groupAdminTrunkGroupAccess Optional |
| group_admin_verify_translation_and_routing_access | str | groupAdminVerifyTranslationAndRoutingAccess Optional |
| group_admin_session_admission_control_access | str | groupAdminSessionAdmissionControlAccess Optional |
| group_admin_dialable_caller_id_access | str | groupAdminDialableCallerIDAccess Optional |
| group_admin_office_zone_access | str | groupAdminOfficeZoneAccess Optional |
| group_admin_number_activation_access | str | groupAdminNumberActivationAccess Optional |
| group_admin_communication_barring_user_profile_access | str | groupAdminCommunicationBarringUserProfileAccess Optional |
| service_provider_admin_profile_access | str | serviceProviderAdminProfileAccess Optional |
| service_provider_admin_group_access | str | serviceProviderAdminGroupAccess Optional |
| service_provider_admin_user_access | str | serviceProviderAdminUserAccess Optional |
| service_provider_admin_admin_access | str | serviceProviderAdminAdminAccess Optional |
| service_provider_admin_department_access | str | ServiceProviderAdminDepartmentAccess Optional |
| service_provider_admin_access_device_access | str | serviceProviderAdminAccessDeviceAccess Optional |
| service_provider_admin_phone_number_extension_access | str | serviceProviderAdminPhoneNumberExtensionAccess Optional |
| service_provider_admin_calling_line_id_number_access | str | serviceProviderAdminCallingLineIdNumberAccess Optional |
| service_provider_admin_service_access | str | serviceProviderAdminServiceAccess Optional |
| service_provider_admin_service_pack_access | str | serviceProviderAdminServicePackAccess Optional |
| service_provider_admin_session_admission_control_access | str | serviceProviderAdminSessionAdmissionControlAccess Optional |
| service_provider_admin_verify_translation_and_routing_access | str | serviceProviderAdminVerifyTranslationAndRoutingAccess Optional |
| service_provider_admin_web_branding_access | str | serviceProviderAdminWebBrandingAccess Optional |
| service_provider_admin_office_zone_access | str | serviceProviderAdminOfficeZoneAccess Optional |
| service_provider_admin_communication_barring_access | str | serviceProviderAdminCommunicationBarringAccess Optional |
| enterprise_admin_network_policy_access | str | enterpriseAdminNetworkPolicyAccess Optional |
| service_provider_admin_dialable_caller_id_access | str | serviceProviderAdminDialableCallerIDAccess Optional |
| enterprise_admin_number_activation_access | str | enterpriseAdminNumberActivationAccess Optional |
SystemPolicyModifyDefaultRequest22(OCIRequest)
Request to modify the system's default policy settings.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS mode:
GroupAdminCommunicationBarringUserProfileAccess (This element is only used for groups
in an Enterprise) GroupAdminVerifyTranslationAndRoutingAccess
ServiceProviderVerifyTranslationAndRoutingAccess
groupUserAutoAttendantNameDialingAccess The following elements are only used in XS
data mode and ignored in AS mode: serviceProviderAdminCommunicationBarringAccess
Attributes:
| Name | Type | Description |
|---|---|---|
| group_calling_plan_access | str | groupCallingPlanAccess Optional |
| group_extension_access | str | groupExtensionAccess Optional |
| group_voice_messaging_access | str | groupVoiceMessagingAccess Optional |
| group_department_admin_user_access | str | groupDepartmentAdminUserAccess Optional |
| group_department_admin_trunk_group_access | str | groupDepartmentAdminTrunkGroupAccess Optional |
| group_department_admin_phone_number_extension_access | str | groupDepartmentAdminPhoneNumberExtensionAccess Optional |
| group_department_admin_calling_line_id_number_access | str | groupDepartmentAdminCallingLineIdNumberAccess Optional |
| group_user_authentication_access | str | groupUserAuthenticationAccess Optional |
| group_user_group_directory_access | str | groupUserGroupDirectoryAccess Optional |
| group_user_profile_access | str | groupUserProfileAccess Optional |
| group_user_enhanced_call_logs_access | str | groupUserEnhancedCallLogsAccess Optional |
| group_user_auto_attendant_name_dialing_access | str | groupUserAutoAttendantNameDialingAccess Optional |
| group_admin_profile_access | str | groupAdminProfileAccess Optional |
| group_admin_user_access | str | groupAdminUserAccess Optional |
| group_admin_admin_access | str | groupAdminAdminAccess Optional |
| group_admin_department_access | str | groupAdminDepartmentAccess Optional |
| group_admin_access_device_access | str | groupAdminAccessDeviceAccess Optional |
| group_admin_enhanced_service_instance_access | str | groupAdminEnhancedServiceInstanceAccess Optional |
| group_admin_feature_access_code_access | str | groupAdminFeatureAccessCodeAccess Optional |
| group_admin_phone_number_extension_access | str | groupAdminPhoneNumberExtensionAccess Optional |
| group_admin_calling_line_id_number_access | str | groupAdminCallingLineIdNumberAccess Optional |
| group_admin_service_access | str | groupAdminServiceAccess Optional |
| group_admin_trunk_group_access | str | groupAdminTrunkGroupAccess Optional |
| group_admin_verify_translation_and_routing_access | str | groupAdminVerifyTranslationAndRoutingAccess Optional |
| group_admin_session_admission_control_access | str | groupAdminSessionAdmissionControlAccess Optional |
| group_admin_dialable_caller_id_access | str | groupAdminDialableCallerIDAccess Optional |
| group_admin_office_zone_access | str | groupAdminOfficeZoneAccess Optional |
| group_admin_number_activation_access | str | groupAdminNumberActivationAccess Optional |
| group_admin_communication_barring_user_profile_access | str | groupAdminCommunicationBarringUserProfileAccess Optional |
| service_provider_admin_profile_access | str | serviceProviderAdminProfileAccess Optional |
| service_provider_admin_group_access | str | serviceProviderAdminGroupAccess Optional |
| service_provider_admin_user_access | str | serviceProviderAdminUserAccess Optional |
| service_provider_admin_admin_access | str | serviceProviderAdminAdminAccess Optional |
| service_provider_admin_department_access | str | ServiceProviderAdminDepartmentAccess Optional |
| service_provider_admin_access_device_access | str | serviceProviderAdminAccessDeviceAccess Optional |
| service_provider_admin_phone_number_extension_access | str | serviceProviderAdminPhoneNumberExtensionAccess Optional |
| service_provider_admin_calling_line_id_number_access | str | serviceProviderAdminCallingLineIdNumberAccess Optional |
| service_provider_admin_service_access | str | serviceProviderAdminServiceAccess Optional |
| service_provider_admin_service_pack_access | str | serviceProviderAdminServicePackAccess Optional |
| service_provider_admin_session_admission_control_access | str | serviceProviderAdminSessionAdmissionControlAccess Optional |
| service_provider_admin_verify_translation_and_routing_access | str | serviceProviderAdminVerifyTranslationAndRoutingAccess Optional |
| service_provider_admin_web_branding_access | str | serviceProviderAdminWebBrandingAccess Optional |
| service_provider_admin_office_zone_access | str | serviceProviderAdminOfficeZoneAccess Optional |
| service_provider_admin_communication_barring_access | str | serviceProviderAdminCommunicationBarringAccess Optional |
| enterprise_admin_network_policy_access | str | enterpriseAdminNetworkPolicyAccess Optional |
| service_provider_admin_dialable_caller_id_access | str | serviceProviderAdminDialableCallerIDAccess Optional |
| enterprise_admin_number_activation_access | str | enterpriseAdminNumberActivationAccess Optional |
SystemPortalPasscodeRulesGetRequest(OCIRequest)
Requests the system passcode rules setting.
The response is either SystemPortalPasscodeRulesGetResponse() or ErrorResponse().
Replaced by: SystemPortalPasscodeRulesGetRequest19()
SystemPortalPasscodeRulesGetRequest19(OCIRequest)
Requests the system passcode rules setting.
The response is either SystemPortalPasscodeRulesGetResponse19() or
ErrorResponse(). Replaced by: SystemPortalPasscodeRulesGetRequestRI in AS data mode.
SystemPortalPasscodeRulesModifyRequest(OCIRequest)
Request to modify the system passcode rules setting.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode: numberOfRepeatedDigits
disallowRepeatedPatterns disallowContiguousSequences numberOfAscendingDigits
numberOfDescendingDigits numberOfPreviousPasscodes reenableLogin lockOutInMinutes
Attributes:
| Name | Type | Description |
|---|---|---|
| disallow_repeated_digits | bool | disallowRepeatedDigits Optional |
| number_of_repeated_digits | int | numberOfRepeatedDigits Optional |
| disallow_repeated_patterns | bool | disallowRepeatedPatterns Optional |
| disallow_contiguous_sequences | bool | disallowContiguousSequences Optional |
| number_of_ascending_digits | int | numberOfAscendingDigits Optional |
| number_of_descending_digits | int | numberOfDescendingDigits Optional |
| disallow_user_number | bool | disallowUserNumber Optional |
| disallow_reversed_user_number | bool | disallowReversedUserNumber Optional |
| disallow_old_passcode | bool | disallowOldPasscode Optional |
| number_of_previous_passcodes | int | numberOfPreviousPasscodes Optional |
| disallow_reversed_old_passcode | bool | disallowReversedOldPasscode Optional |
| min_code_length | int | minCodeLength Optional |
| max_code_length | int | maxCodeLength Optional |
| disable_login_after_max_failed_login_attempts | bool | disableLoginAfterMaxFailedLoginAttempts Optional |
| max_failed_login_attempts | int | maxFailedLoginAttempts Optional |
| expire_password | bool | expirePassword Optional |
| passcode_expires_days | int | passcodeExpiresDays Optional |
| send_login_disabled_notify_email | bool | sendLoginDisabledNotifyEmail Optional |
| login_disabled_notify_email_address | str | loginDisabledNotifyEmailAddress Optional |
| default_password | str | defaultPassword Optional |
| reenable_login | bool | reenableLogin Optional |
| lock_out_in_minutes | int | lockOutInMinutes Optional |
SystemPreferredCarrierAddRequest(OCIRequest)
Add a carrier to the system.
More than one carrier may be assigned to each country code.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| carrier | str | carrier |
| cic | str | cic |
| country_code | str | countryCode |
| is_intra_lata | bool | isIntraLata |
| is_inter_lata | bool | isInterLata |
| is_international | bool | isInternational |
SystemPreferredCarrierDeleteRequest(OCIRequest)
Delete a carrier from the system.
The response is either a SuccessResponse() or an ErrorResponse(). An
ErrorResponse() is returned if the carrier is in use, or if the carrier didn't exist
prior to deletion..
Attributes:
| Name | Type | Description |
|---|---|---|
| carrier | str | carrier |
SystemPreferredCarrierGetListRequest(OCIRequest)
Requests a table of all the carriers defined in the system.
The response is either a SystemPreferredCarrierGetListResponse() or an
ErrorResponse().
SystemPreferredCarrierGetRequest(OCIRequest)
Requests the attributes of carrier.
The response is either a SystemPreferreredCarrierGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| carrier | str | carrier |
SystemPreferredCarrierModifyRequest(OCIRequest)
Modify the attributes of a carrier.
The response is either a SuccessResponse() or an ErrorResponse(). An
ErrorResponse() is returned if countryCode modification is attempted while the
carrier is assigned to a service provider. An ErrorResponse() is returned if an
attempt to set isIntraLata to false is made while the carrier is used as an intra-LATA
carrier. An ErrorResponse() is returned if an attempt to set isInternational to
false is made while the carrier is used as an international carrier.
Attributes:
| Name | Type | Description |
|---|---|---|
| carrier | str | carrier |
| cic | str | cic Optional |
| country_code | str | countryCode Optional |
| is_intra_lata | bool | isIntraLata Optional |
| is_inter_lata | bool | isInterLata Optional |
| is_international | bool | isInternational Optional |
SystemProvisioningValidationGetRequest(OCIRequest)
Request to get the system's provisioning validation attributes.
The response is either a SystemProvisioningValidationGetResponse() or and
ErrorResponse().
SystemProvisioningValidationGetRequest14sp2(OCIRequest)
Request to get the system's provisioning validation attributes.
The response is either a SystemProvisioningValidationGetResponse14sp2() or
ErrorResponse().
SystemProvisioningValidationGetRequest22(OCIRequest)
Request to get the system's provisioning validation attributes.
The response is either a SystemProvisioningValidationGetResponse22() or
ErrorResponse(). Replaced by SystemProvisioningValidationGetRequest25().
SystemProvisioningValidationGetRequest25(OCIRequest)
Request to get the system's provisioning validation attributes.
The response is either a SystemProvisioningValidationGetResponse25() or
ErrorResponse().
SystemProvisioningValidationModifyRequest(OCIRequest)
Request to modify the system's provisioning validation attributes.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
denyMobilityNumberAsRedirectionDestination
denyEnterpriseNumberAsNetworkLocationDestination
denyAutoAttendantIdentityAsAutoAttendantTransferNumber
Attributes:
| Name | Type | Description |
|---|---|---|
| is_active | bool | isActive Optional |
| is_network_server_query_active | bool | isNetworkServerQueryActive Optional |
| timeout_seconds | int | timeoutSeconds Optional |
| deny_mobility_number_as_redirection_destination | bool | denyMobilityNumberAsRedirectionDestination Optional |
| deny_enterprise_number_as_network_location_destination | bool | denyEnterpriseNumberAsNetworkLocationDestination Optional |
| deny_auto_attendant_identity_as_auto_attendant_transfer_number | bool | denyAutoAttendantIdentityAsAutoAttendantTransferNumber Optional |
SystemPushNotificationAllowedApplicationAddRequest(OCIRequest)
Request to add an application to the list of allowed push notification applications.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| application_id | str | applicationId |
| description | str | description Optional |
SystemPushNotificationAllowedApplicationDeleteRequest(OCIRequest)
Request to remove an application from the list of allowed push notification applications.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| application_id | str | applicationId |
SystemPushNotificationAllowedApplicationGetListRequest(OCIRequest)
Request to get the list of allowed push notification applications.
The response is either SystemPushNotificationAllowedApplicationGetListResponse() or
ErrorResponse().
SystemPushNotificationAllowedApplicationModifyRequest(OCIRequest)
Request to modify an application in the list of allowed push notification applications.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| application_id | str | applicationId |
| description | str | description Optional |
SystemPushNotificationParametersGetRequest(OCIRequest)
Request to get the list of push notification system parameters.
The response is either SystemPushNotificationParametersGetResponse() or
ErrorResponse().
SystemPushNotificationParametersModifyRequest(OCIRequest)
Request to modify push notification system parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enforce_allowed_application_list | bool | enforceAllowedApplicationList Optional |
| maximum_registrations_per_user | int | maximumRegistrationsPerUser Optional |
| maximum_registration_age_days | int | maximumRegistrationAgeDays Optional |
| new_call_timeout | int | newCallTimeout Optional |
| subscription_events_per_second | int | subscriptionEventsPerSecond Optional |
SystemRedundancyParametersGetRequest(OCIRequest)
Replaced By SystemRedundancyParametersGetRequest16sp2() Request to get the list of
Redundancy system parameters.
The response is either SystemRedundancyParametersGetResponse() or ErrorResponse().
SystemRedundancyParametersGetRequest16sp2(OCIRequest)
Request to get the list of Redundancy system parameters.
The response is either SystemRedundancyParametersGetResponse16sp2() or
ErrorResponse().
SystemRedundancyParametersModifyRequest(OCIRequest)
Request to modify Redundancy system parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| roll_back_timer_minutes | int | rollBackTimerMinutes Optional |
| send_sip_option_message_upon_migration | bool | sendSipOptionMessageUponMigration Optional |
SystemResourcePriorityGetRequest(OCIRequest)
Get the system Resource Priority service attributes.
The response is either SystemResourcePriorityGetResponse() or ErrorResponse().
SystemResourcePriorityModifyRequest(OCIRequest)
Modify the system Resource Priority service attributes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| send_resource_priority_to_network | bool | sendResourcePriorityToNetwork Optional |
| resource_priority | str | resourcePriority Optional |
SystemRoamingNetworkAddRequest(OCIRequest)
Add a Roaming Network.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| msc_address | str | mscAddress |
| network_translation_index | str | networkTranslationIndex Optional |
SystemRoamingNetworkDeleteRequest(OCIRequest)
Delete a Roaming Network.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| msc_address | str | mscAddress |
SystemRoamingNetworkModifyRequest(OCIRequest)
Modify a Roaming Network.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| msc_address | str | mscAddress |
| network_translation_index | str | networkTranslationIndex Optional |
SystemRouteListEnterpriseTrunkNumberPrefixGetSummaryListRequest(OCIRequest)
Request a summary table of all enterprise trunk prefixes in the system.
If resellerId is specified, only the prefixes assigned to the enterprise/service provider within the given reseller are returned. If reseller administrator sends the request and resellerId is not specified, the administrator's resellerId is used.
The response is either
SystemRouteListEnterpriseTrunkNumberPrefixGetSummaryListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId Optional |
SystemRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest(OCIRequest)
Request a summary table of all enterprise trunk number ranges in the system.
If resellerId is specified, the number ranges assigned to the enterprises/service providers within the reseller are returned. If reseller administrator sends the request and resellerId is not specified, the administrator's resellerId is used.
The response is either
SystemRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId Optional |
SystemRoutePointExternalSystemAddRequest(OCIRequest)
Add an Route Point External System, which is a cluster of Application Controllers.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| description | str | description Optional |
SystemRoutePointExternalSystemApplicationControllerAddListRequest(OCIRequest)
Add an application controller to Route Point External System.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| application_controller | List[str] | applicationController Optional |
SystemRoutePointExternalSystemApplicationControllerDeleteListRequest(OCIRequest)
Delete an application controller for Route Point External System.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| application_controller | List[str] | applicationController Optional |
SystemRoutePointExternalSystemApplicationControllerGetRequest(OCIRequest)
Get a list of Application Controllers assigned to the Route Point External Systems specified.
The response is either
SystemRoutePointExternalSystemApplicationControllerGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| external_system | str | externalSystem |
SystemRoutePointExternalSystemDeleteRequest(OCIRequest)
Delete an Route Point External System.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemRoutePointExternalSystemGetListRequest(OCIRequest)
Get a list of Route Point External Systems that are configured for the system.
The response is either SystemRoutePointExternalSystemGetListResponse() or
ErrorResponse().
SystemRoutePointExternalSystemGetRoutePointListRequest(OCIRequest)
Get a list of Route Points that are using the specified Route Point External System.
The response is either a SystemRoutePointExternalSystemGetRoutePointListResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| route_point_external_system | str | routePointExternalSystem |
SystemRoutePointExternalSystemModifyRequest(OCIRequest)
Modify an Route Point External System.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
SystemRoutingAddRouteDeviceRequest14(OCIRequest)
Request to add a routing device to a route.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| route_name | str | routeName |
| net_address | str | netAddress |
| port | int | port Optional |
| transport_protocol | str | transportProtocol |
| description | str | description Optional |
SystemRoutingAddRouteRequest(OCIRequest)
Request to add a route to the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| route_name | str | routeName |
SystemRoutingAddTranslationRequest(OCIRequest)
Request to add a digit routing table entry to the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| digits | str | digits |
| route_name | str | routeName |
SystemRoutingDeleteRouteDeviceRequest(OCIRequest)
Request to delete a routing device from a route.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| route_name | str | routeName |
| net_address | str | netAddress |
| port | int | port Optional |
SystemRoutingDeleteRouteRequest(OCIRequest)
Request to delete a route from the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| route_name | str | routeName |
SystemRoutingDeleteTranslationRequest(OCIRequest)
Request to delete a digit routing table entry from the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| digits | str | digits |
SystemRoutingGetRequest(OCIRequest)
Request the system's general routing attributes.
The response is either a SystemRoutingGetResponse() or an ErrorResponse().
SystemRoutingGetRouteDeviceListRequest(OCIRequest)
Request to get a list of devices for a route.
The response is either a SystemRoutingGetRouteDeviceListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| route_name | str | routeName |
SystemRoutingGetRouteListRequest(OCIRequest)
Request to get a list of routes in the system.
The response is either a SystemRoutingGetRouteListResponse() or an
ErrorResponse().
SystemRoutingGetTranslationListRequest(OCIRequest)
Request to get the system digit routing table.
The response is either a SystemRoutingGetTranslationListResponse() or an
ErrorResponse().
SystemRoutingModifyRequest(OCIRequest)
Modifies the system's general routing attributes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| is_route_round_robin | bool | isRouteRoundRobin Optional |
| route_timer_seconds | int | routeTimerSeconds Optional |
| dns_resolved_address_selection_policy | str | dnsResolvedAddressSelectionPolicy Optional |
| stateful_expiration_minutes | int | statefulExpirationMinutes Optional |
| max_addresses_per_hostname | int | maxAddressesPerHostname Optional |
| max_addresses_during_setup | int | maxAddressesDuringSetup Optional |
SystemRoutingModifyRouteDeviceRequest(OCIRequest)
Request to modify a routing device.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| route_name | str | routeName |
| net_address | str | netAddress |
| port | int | port Optional |
| transport_protocol | str | transportProtocol Optional |
| description | str | description Optional |
SystemRoutingModifyTranslationRequest(OCIRequest)
Request to modify a digit routing table entry in the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| digits | str | digits |
| route_name | str | routeName Optional |
SystemRoutingProfileGetListRequest(OCIRequest)
Request to get the list of system routing profiles.
If resellerId is specified, the routing profiles assigned to the given reseller are returned. If reseller administrator sends the request, resellerId is not specified, the administrator’s resellerId is used. If system or provisioning administrator sends the request, resellerId is not specified, all system routing profiles are returned.
The response is either a SystemRoutingProfileGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId Optional |
SystemRoutingProfileParametersGetRequest(OCIRequest)
Request to get the list of Routing Profile related system parameters.
The response is either SystemRoutingProfileParametersGetResponse() or
ErrorResponse().
SystemRoutingProfileParametersModifyRequest(OCIRequest)
Request to modify Routing Profile system parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enable_permissive_routing | bool | enablePermissiveRouting |
SystemRuntimeDataPublicationGetRequest(OCIRequest)
Get the system call admission control parameters.
The response is either a SystemRuntimeDataPublicationGetResponse() or an
ErrorResponse().
SystemRuntimeDataPublicationModifyRequest(OCIRequest)
Modify the system call admission control parameters.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
enableRuntimeDataSync, runtimeIntervalInMilliSeconds
Attributes:
| Name | Type | Description |
|---|---|---|
| enable_runtime_data_sync | bool | enableRuntimeDataSync Optional |
| runtime_data_sync_interval_in_milli_seconds | int | runtimeDataSyncIntervalInMilliSeconds Optional |
SystemSIPAddACLEntryRequest14(OCIRequest)
Add an entry to the SIP access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| transport_protocol | str | transportProtocol |
| description | str | description Optional |
SystemSIPAddACLEntryRequest14sp2(OCIRequest)
Add an entry to the SIP access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| transport_protocol | str | transportProtocol |
| description | str | description Optional |
SystemSIPAddContentTypeRequest(OCIRequest)
Add a content type for the SIP interface.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| content_type | str | contentType |
| interface | str | interface |
SystemSIPAuthenticationLockoutClearAllRequest(OCIRequest)
Request to clear all sip authentication lockouts (both endpoint and trunk group) in the system.
The response is either a SuccessResponse() or an ErrorResponse().
SystemSIPAuthenticationPasswordRulesGetRequest(OCIRequest)
Request to get the system level SIP authentication password rule settings.
The response is either a SystemSIPAuthenticationPasswordRulesGetResponse() or an
ErrorResponse().
SystemSIPAuthenticationPasswordRulesModifyRequest(OCIRequest)
Request to modify the system level SIP authentication password rule settings The
response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| disallow_authentication_name | bool | disallowAuthenticationName Optional |
| disallow_old_password | bool | disallowOldPassword Optional |
| disallow_reversed_old_password | bool | disallowReversedOldPassword Optional |
| restrict_min_digits | bool | restrictMinDigits Optional |
| min_digits | int | minDigits Optional |
| restrict_min_upper_case_letters | bool | restrictMinUpperCaseLetters Optional |
| min_upper_case_letters | int | minUpperCaseLetters Optional |
| restrict_min_lower_case_letters | bool | restrictMinLowerCaseLetters Optional |
| min_lower_case_letters | int | minLowerCaseLetters Optional |
| restrict_min_non_alphanumeric_characters | bool | restrictMinNonAlphanumericCharacters Optional |
| min_non_alphanumeric_characters | int | minNonAlphanumericCharacters Optional |
| min_length | int | minLength Optional |
| send_permanent_lockout_notification | bool | sendPermanentLockoutNotification Optional |
| permanent_lockout_notify_email_address | str | permanentLockoutNotifyEmailAddress Optional |
| endpoint_authentication_lockout_type | str | endpointAuthenticationLockoutType Optional |
| endpoint_temporary_lockout_threshold | int | endpointTemporaryLockoutThreshold Optional |
| endpoint_wait_algorithm | str | endpointWaitAlgorithm Optional |
| endpoint_lockout_fixed_minutes | str | endpointLockoutFixedMinutes Optional |
| endpoint_permanent_lockout_threshold | int | endpointPermanentLockoutThreshold Optional |
| trunk_group_authentication_lockout_type | str | trunkGroupAuthenticationLockoutType Optional |
| trunk_group_temporary_lockout_threshold | int | trunkGroupTemporaryLockoutThreshold Optional |
| trunk_group_wait_algorithm | str | trunkGroupWaitAlgorithm Optional |
| trunk_group_lockout_fixed_minutes | str | trunkGroupLockoutFixedMinutes Optional |
| trunk_group_permanent_lockout_threshold | int | trunkGroupPermanentLockoutThreshold Optional |
| use_password_validation_service | bool | usePasswordValidationService Optional |
SystemSIPDeleteACLEntryRequest(OCIRequest)
Delete an entry from the SIP access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
SystemSIPDeleteACLEntryRequest14sp2(OCIRequest)
Delete an entry from the SIP access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
SystemSIPDeleteContentTypeRequest(OCIRequest)
Delete a content type for the SIP interface.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| content_type | str | contentType |
SystemSIPDeviceFileApplyExtendedCaptureToAllDeviceProfilesRequest(OCIRequest)
Request to apply an extended file capture value to all the profile instances associated to a sip device type file.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
| extended_capture_on_upload_from_device | bool | extendedCaptureOnUploadFromDevice |
SystemSIPDeviceTypeDeleteRequest(OCIRequest)
Request to delete a sip device type.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeFileDeleteRequest(OCIRequest)
Request to delete a sip device type file.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: SystemSIPDeviceTypeFileDeleteRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_type | str | fileType |
SystemSIPDeviceTypeFileDeleteRequest14sp8(OCIRequest)
Request to delete a sip device type file.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
SystemSIPDeviceTypeFileGetListRequest(OCIRequest)
Request to get the list of device files managed by the Device Management System, on a per-device type basis.
The response is either SystemSIPDeviceTypeFileGetListResponse() or
ErrorResponse().
Replaced By: SystemSIPDeviceTypeFileGetListRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeFileGetListRequest14sp8(OCIRequest)
Request to get the list of device files managed by the Device Management System, on a per-device type basis.
The response is either SystemSIPDeviceTypeFileGetListResponse14sp8() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeFileGetRequest(OCIRequest)
Request to get a sip device type file.
The response is either SystemSIPDeviceTypeFileGetResponse() or ErrorResponse().
Replaced By: SystemSIPDeviceTypeFileGetRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_type | str | fileType |
SystemSIPDeviceTypeFileGetRequest14sp8(OCIRequest)
Request to get a sip device type file.
The response is either SystemSIPDeviceTypeFileGetResponse14sp8() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
SystemSIPDeviceTypeFileGetRequest16sp1(OCIRequest)
Replaced By SystemSIPDeviceTypeFileGetRequest18().
Request to get a sip device type file.
The response is either SystemSIPDeviceTypeFileGetResponse16sp1() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
SystemSIPDeviceTypeFileGetRequest18(OCIRequest)
Request to get a sip device type file.
The response is either SystemSIPDeviceTypeFileGetResponse18() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
SystemSIPDeviceTypeFileGetRequest19(OCIRequest)
Request to get a sip device type file.
The response is either SystemSIPDeviceTypeFileGetResponse19() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeFileGetRequest20()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
SystemSIPDeviceTypeFileGetRequest20(OCIRequest)
Request to get a sip device type file.
The response is either SystemSIPDeviceTypeFileGetResponse20() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeFileGetRequest20Sp1
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
SystemSIPDeviceTypeFileGetRequest21sp1(OCIRequest)
Request to get a sip device type file.
The response is either SystemSIPDeviceTypeFileGetResponse21sp1() or
ErrorResponse(). Replaced by: SystemSIPDeviceTypeFileGetRequest22() in AS data
mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
SystemSIPDeviceTypeFileGetRequest22(OCIRequest)
Request to get a sip device type file.
The response is either SystemSIPDeviceTypeFileGetResponse22() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeFileGetRequest22V2() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
SystemSIPDeviceTypeFileGetRequest22V2(OCIRequest)
Request to get a sip device type file.
The response is either SystemSIPDeviceTypeFileGetResponse22V2() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
SystemSIPDeviceTypeGetRequest(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest14sp1(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse14sp1() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest14sp2(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse14sp2() or ErrorResponse().
Replaced By: SystemSIPDeviceTypeGetRequest14sp3()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest14sp3(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse14sp3() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest14sp6()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest14sp6(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse14sp6() or ErrorResponse().
Replaced By : SystemSIPDeviceTypeGetRequest15()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest15(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse15() or ErrorResponse().
Replaced By : SystemSIPDeviceTypeGetRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest16(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse16() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest16sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest16sp1(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse16sp1() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest17(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse17() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest17sp4(OCIRequest)
Replaced By SystemSIPDeviceTypeGetRequest18().
Request to get a sip device type. See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse17sp4() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest18()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest18(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse18() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest19()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest18sp1(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse18sp1() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest19(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse19() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest19sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest19sp1(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse19sp1() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest20()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest20(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse20() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest20sp1(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse20() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest21sp1V2.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest21(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse21() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest21Sp1
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest21sp1(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse21sp1() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest21sp1V2
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest22(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse22() or ErrorResponse().
Deprecated by: SystemSIPDeviceTypeGetRequest22V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest22V10(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse22V10() or ErrorResponse().
Replaced By: SystemSIPDeviceTypeGetRequest23V6()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest22V11(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse22V11() or ErrorResponse().
Replaced by SystemSIPDeviceTypeGetRequest23V7()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest22V12(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse22V12() or ErrorResponse().
Replaced by SystemSIPDeviceTypeGetRequest23V8()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest22V13(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse22V13() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest23V9()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest22V14(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse22V14() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest23V10()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest22V15(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse22V15() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest23V11()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest22V2(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse22V2() or ErrorResponse().
Deprecated by SystemSIPDeviceTypeGetRequest22V3()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest22V3(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse22V3() or ErrorResponse().
Deprecated by SystemSIPDeviceTypeGetRequest22V4().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest22V4(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse22V4() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest22V5(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse22V5() or ErrorResponse().
Replaced by: SystemDeviceTypeGetRequest22V13() in XS data mode. Replaced by:
SystemDeviceTypeGetRequest22V6() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest22V6(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse22V6() or ErrorResponse().
Replaced By: SystemSIPDeviceTypeGetRequest23V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest22V7(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse22V7() or ErrorResponse().
Replaced By: SystemSIPDeviceTypeGetRequest23V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest22V8(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse22V8() or ErrorResponse().
Replaced By: SystemSIPDeviceTypeGetRequest23V4()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest22V9(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse22V8() or ErrorResponse().
Replaced By: SystemSIPDeviceTypeGetRequest23V4()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest23(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse23() or ErrorResponse().
Replaced By: SystemSIPDeviceTypeGetRequest23V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest23V10(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse23V10() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest23V11(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse23V11() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest23V12().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest23V12(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse23V12() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest23V13().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest23V13(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse23V13() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest23V2(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse23V2() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest23V3() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest23V3(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse23V3() or ErrorResponse().
Replaced By: SystemSIPDeviceTypeGetRequest23V4().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest23V4(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse23V4() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest23V5() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest23V5(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse23V5() or ErrorResponse().
Replaced by SystemSIPDeviceTypeGetRequest23V6()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest23V6(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse23V6() or ErrorResponse().
Replaced by SystemSIPDeviceTypeGetRequest23V7()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest23V7(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse23V7() or ErrorResponse().
Replaced by SystemSIPDeviceTypeGetResquest23V8
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest23V8(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse23V8() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest23V9() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeGetRequest23V9(OCIRequest)
Request to get a sip device type.
See Also: SystemDeviceTypeGetRequest()
The response is either SystemSIPDeviceTypeGetResponse23V9() or ErrorResponse().
Replaced by: SystemSIPDeviceTypeGetRequest23V10().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeLanguageMappingGetListRequest(OCIRequest)
Request to get the list of device language names mapped to BroadWorks language names, per-device type.
The response is either SystemSIPDeviceTypeLanguageMappingGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeServiceGetRequest(OCIRequest)
Request to get the list of BroadWorks services that can be integrated to a device type and the level of integration for this device type.
The response is either SystemSIPDeviceTypeServiceGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
SystemSIPDeviceTypeServiceModifyRequest(OCIRequest)
Request to set the level of integration that a device type has in relation to BroadWorks services.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| supports_polycom_phone_services | bool | supportsPolycomPhoneServices Optional |
SystemSIPDiversionReasonGetRequest(OCIRequest)
Request to get the list of SIP Diversion Cause values.
The response is either a SystemSIPDiversionReasonGetResponse() or ErrorResponse().
SystemSIPDiversionReasonModifyRequest(OCIRequest)
Request to modify the SIP cause value for a given diversion reason.
The response is either a SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| diversion_reason | str | diversionReason |
| cause_value | str | causeValue |
SystemSIPGetACLListRequest(OCIRequest)
Get the SIP access control list.
The response is either SystemSIPGetACLListResponse() or ErrorResponse().
SystemSIPGetContentTypeListRequest(OCIRequest)
Get the content type list for the SIP interface.
The response is either SystemSIPGetContentTypeListResponse() or ErrorResponse().
SystemSIPModifyACLEntryRequest(OCIRequest)
Modify an entry from the SIP access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| transport_protocol | str | transportProtocol Optional |
| description | str | description Optional |
SystemSIPModifyACLEntryRequest14sp2(OCIRequest)
Modify an entry from the SIP access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| transport_protocol | str | transportProtocol Optional |
| description | str | description Optional |
SystemSIPModifyContentTypeRequest(OCIRequest)
Modify an content type for the SIP interface.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| content_type | str | contentType |
| interface | str | interface Optional |
SystemSMDIAddACLEntryRequest(OCIRequest)
Add an entry to the SMDI access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| description | str | description Optional |
SystemSMDIAddACLEntryRequest14sp2(OCIRequest)
Add an entry to the SMDI access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| description | str | description Optional |
SystemSMDIDeleteACLEntryRequest(OCIRequest)
Delete an entry from the SMDI access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
SystemSMDIDeleteACLEntryRequest14sp2(OCIRequest)
Delete an entry from the SMDI access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
SystemSMDIGetACLListRequest(OCIRequest)
Get the SMDI access control list.
The response is either SystemSMDIGetACLListResponse() or ErrorResponse().
SystemSMDIMessageDeskAddServerRequest(OCIRequest)
Request to add a SMDI Server to the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| net_address | str | netAddress |
| port | int | port |
| description | str | description Optional |
SystemSMDIMessageDeskAddServerRouteRequest(OCIRequest)
Request to add a SMDI Server route to the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| route_destination | str | routeDestination |
| device_name | List[str] | deviceName |
SystemSMDIMessageDeskDeleteServerRequest(OCIRequest)
Request to delete a SMDI Server from the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemSMDIMessageDeskDeleteServerRouteRequest(OCIRequest)
Request to delete a SMDI Server route from the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| route_destination | str | routeDestination |
SystemSMDIMessageDeskGetServerListRequest(OCIRequest)
Request to get a list of SMDI Servers defined in the system.
The response is either a SystemSMDIMessageDeskGetServerListResponse() or an
ErrorResponse().
SystemSMDIMessageDeskGetServerRouteListRequest(OCIRequest)
Request to get a list of SMDI Servers routes in the system.
The response is either a SystemSMDIMessageDeskGetServerRouteListResponse() or an
ErrorResponse().
SystemSMDIMessageDeskModifyServerRequest(OCIRequest)
Request to modify a SMDI Server in the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| description | str | description Optional |
SystemSMDIMessageDeskModifyServerRouteRequest(OCIRequest)
Replace the list of devices associated with a SMDI server route destination.
There must be at least one device in the list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| route_destination | str | routeDestination |
| device_name_list | OCI.deviceNameList | deviceNameList Optional |
SystemSMDIModifyACLEntryRequest(OCIRequest)
Modify an entry from the SMDI access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| description | str | description Optional |
SystemSMDIModifyACLEntryRequest14sp2(OCIRequest)
Modify an entry from the SMDI access control list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| description | str | description Optional |
SystemSMDIParametersGetRequest(OCIRequest)
Request to get the list of SMDI system parameters.
The response is either SystemSMDIParametersGetResponse() or ErrorResponse().
SystemSMDIParametersModifyRequest(OCIRequest)
Request to modify SMDI system parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enable_smdi | bool | enableSMDI Optional |
| listening_port | int | listeningPort Optional |
| max_connections | int | maxConnections Optional |
SystemSMPPGetRequest(OCIRequest)
Request the system level data associated with SMPP external interface.
The response is either a SystemSMPPGetResponse() or an ErrorResponse().
Replaced By: SystemSMPPGetRequest14sp5()
SystemSMPPGetRequest14sp5(OCIRequest)
Request the system level data associated with SMPP external interface.
The response is either a SystemSMPPGetResponse14sp5() or an ErrorResponse().
Replaced by: SystemSMPPGetRequest21() in AS data mode
SystemSMPPGetRequest21(OCIRequest)
Request the system level data associated with SMPP external interface.
The response is either a SystemSMPPGetResponse21() or an ErrorResponse().
SystemSMPPGetRequest22(OCIRequest)
Request the system level data associated with SMPP external interface.
The response is either a SystemSMPPGetResponse21() or an ErrorResponse().
SystemSMPPModifyRequest(OCIRequest)
Request to modify the system level data associated with the SMPP external interface.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| primary_smpp_server_net_address | str | primarySMPPServerNetAddress Optional |
| primary_smpp_port | int | primarySMPPPort Optional |
| secondary_smpp_server_net_address | str | secondarySMPPServerNetAddress Optional |
| secondary_smpp_port | int | secondarySMPPPort Optional |
| system_id | str | systemId Optional |
| password | str | password Optional |
| version | str | version Optional |
| system_type | str | systemType Optional |
| enable_mwi_customized_message | bool | enableMWICustomizedMessage Optional |
| support_message_payload | bool | supportMessagePayload Optional |
| max_short_message_length | int | maxShortMessageLength Optional |
| use_gsm_mwi_ucs2_encoding | bool | useGsmMwiUcs2Encoding Optional |
| include_only_new_message_count | bool | includeOnlyNewMessageCount Optional |
SystemScheduleAddRequest(OCIRequest)
Add a system schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| schedule_name | str | scheduleName |
| schedule_type | str | scheduleType |
SystemScheduleGetListRequest(OCIRequest)
Get the list of a system schedules.
The list can be filtered by schedule type.
The response is either a SystemScheduleGetListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| schedule_type | str | scheduleType Optional |
SystemSecurityClassificationDeleteClassificationRequest(OCIRequest)
Delete a System Security Classification The response is either a SuccessResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| security_classification_name | str | securityClassificationName |
SystemSecurityClassificationGetClassificationRequest(OCIRequest)
Get a system Security Classification.
The response is either SystemSecurityClassificationGetClassificationResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| security_classification_name | str | securityClassificationName |
SystemSecurityClassificationGetRequest(OCIRequest)
Get a system Security Classifications parameters.
The response is either SystemSecurityClassificationGetResponse() or
ErrorResponse().
SystemSecurityClassificationGetRequest21(OCIRequest)
Get system Security Classifications parameters.
The response is either SystemSecurityClassificationGetResponse21() or
ErrorResponse().
SystemSecurityClassificationModifyRequest(OCIRequest)
Modify security classification parameters.
The response is either a SuccessResponse() or an ErrorResponse(). NOTE: The
security classifications must be specified in order of priority. The command fails if
all the security classifications defined for the system are not provided.
Attributes:
| Name | Type | Description |
|---|---|---|
| meet_me_annc_threshold | int | meetMeAnncThreshold Optional |
| play_trunk_user_security_classification_announcement | bool | playTrunkUserSecurityClassificationAnnouncement Optional |
| security_classification_name | List[str] | securityClassificationName Optional |
SystemSelectiveServicesGetRequest(OCIRequest)
Request the system level data associated with Selective Services.
The response is either a SystemSelectiveServicesGetResponse() or an
ErrorResponse().
SystemSelectiveServicesGetRequest18sp1(OCIRequest)
Request the system level data associated with Selective Services.
The response is either a SystemSelectiveServicesGetResponse18sp1() or an
ErrorResponse().
SystemSelectiveServicesGetRequest22(OCIRequest)
Request the system level data associated with Selective Services.
The response is either a SystemSelectiveServicesGetResponse22() or an
ErrorResponse().
SystemSelectiveServicesModifyRequest(OCIRequest)
Modify the system level data associated with SystemSelectiveServicesRequest().
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| schedule_combination | str | scheduleCombination Optional |
| screen_private_number | bool | screenPrivateNumber Optional |
| empty_holiday_schedule_is_out_of_schedule | bool | emptyHolidayScheduleIsOutOfSchedule Optional |
SystemServerAddressesGetRequest(OCIRequest)
Request to get the list of Server Addresses.
The response is either SystemServerAddressesGetResponse() or ErrorResponse(). See
also: PrimaryInfoGetRequest() PublicClusterGetFullyQualifiedDomainNameRequest()
SystemServerAddressesModifyRequest(OCIRequest)
Request to modify Server Addresses.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| web_server_cluster_public_fqdn | str | webServerClusterPublicFQDN Optional |
| application_server_cluster_primary_public_fqdn | str | applicationServerClusterPrimaryPublicFQDN Optional |
| application_server_cluster_secondary_public_fqdn | str | applicationServerClusterSecondaryPublicFQDN Optional |
| application_server_cluster_primary_private_fqdn | str | applicationServerClusterPrimaryPrivateFQDN Optional |
| application_server_cluster_secondary_private_fqdn | str | applicationServerClusterSecondaryPrivateFQDN Optional |
SystemServiceActivationAccessCodeGetRequest(OCIRequest)
Get the Service Activation Access Code system parameters.
The response is either a SystemServiceActivationAccessCodeGetResponse() or an
ErrorResponse().
SystemServiceActivationAccessCodeModifyRequest(OCIRequest)
Request to modify Service Activation Access Code system parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| is_active | bool | isActive Optional |
| terminating_access_code | str | terminatingAccessCode Optional |
| redirecting_access_code | str | redirectingAccessCode Optional |
| click_to_dial_access_code | str | clickToDialAccessCode Optional |
SystemServiceAttributeDefaultGetListRequest(OCIRequest)
Request to get the default attributes for a service that are used when assigning the feature.
The response is either a SystemServiceAttributeDefaultGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_name | str | serviceName |
SystemServiceCodeAddRequest(OCIRequest)
Request to add a service code for the purpose of providing free format routable
strings for dialing The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_code | str | serviceCode |
| description | str | description |
SystemServiceCodeDeleteRequest(OCIRequest)
Request to delete a service code for the purpose of providing free format routable
strings for dialing The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_code | str | serviceCode |
SystemServiceCodeModifyRequest(OCIRequest)
Request to modify service code.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_code | str | serviceCode |
| description | str | description Optional |
SystemServicePackMigrationGetRequest(OCIRequest)
Get system level Service Pack Migration parameters.
The response is either a SystemServicePackMigrationGetResponse() or an
ErrorResponse().
SystemServicePackMigrationModifyRequest(OCIRequest)
Modify system level settings for Service Pack Migration.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| max_simultaneous_migration_tasks | int | maxSimultaneousMigrationTasks Optional |
SystemServicePhoneNumberLookupRequest(OCIRequest)
Lookup if the given number is defined in the specified service in the system.
The response is SystemServicePhoneNumberLookupResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_type | str | serviceType |
| phone_number | str | phoneNumber |
SystemSessionAdmissionControlGetRequest(OCIRequest)
Get the session admission control settings for the system.
The response is either a SystemSessionAdmissionControlGetResponse() or an
ErrorResponse(). Replaced by: SystemSessionAdmissionControlGetRequest21sp1().
SystemSessionAdmissionControlGetRequest21sp1(OCIRequest)
Get the session admission control settings for the system.
The response is either a SystemSessionAdmissionControlGetResponse21sp1() or an
ErrorResponse(). Replaced by: SystemSessionAdmissionControlGetRequest22().
SystemSessionAdmissionControlGetRequest22(OCIRequest)
Get the session admission control settings for the system.
The response is either a SystemSessionAdmissionControlGetResponse22() or an
ErrorResponse(). Replaced by: SystemSessionAdmissionControlGetRequest22V2().
SystemSessionAdmissionControlGetRequest22V2(OCIRequest)
Get the session admission control settings for the system.
The response is either a SystemSessionAdmissionControlGetResponse22V2() or an
ErrorResponse(). Replaced by: SystemSessionAdmissionControlGetRequest22V3()
SystemSessionAdmissionControlGetRequest22V3(OCIRequest)
Get the session admission control settings for the system.
The response is either a SystemSessionAdmissionControlGetResponse22V3() or an
ErrorResponse().
SystemSessionAdmissionControlGetRequest25(OCIRequest)
Get the session admission control settings for the system.
The response is either a SystemSessionAdmissionControlGetResponse25() or an
ErrorResponse().
SystemSessionAdmissionControlModifyRequest(OCIRequest)
Modify the session admission control settings for the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| count_long_connections_to_media_server | bool | countLongConnectionsToMediaServer Optional |
| sac_handling_for_mo_h | str | sacHandlingForMoH Optional |
| block_vm_deposit_due_to_sac_limits | bool | blockVMDepositDueToSACLimits Optional |
| sac_codec_selection_policy | str | sacCodecSelectionPolicy Optional |
| count_call_to_mobile_number_for_sac_subscriber | bool | countCallToMobileNumberForSACSubscriber Optional |
| count_bw_anywhere_for_sac_subscriber | bool | countBWAnywhereForSACSubscriber Optional |
| count_ro_for_sac_subscriber | bool | countROForSACSubscriber Optional |
| exclude_bw_mobility_for_sac_subscriber | bool | excludeBWMobilityForSACSubscriber Optional |
| enable_holdover_of_highwater_session_counts | bool | enableHoldoverOfHighwaterSessionCounts Optional |
| holdover_period_minutes | str | holdoverPeriodMinutes Optional |
| time_zone_offset_minutes | str | timeZoneOffsetMinutes Optional |
| count_calls_redirected_to_external_destination | bool | countCallsRedirectedToExternalDestination Optional |
| release_bw_anywhere_devices_only | bool | releaseBWAnywhereDevicesOnly Optional |
SystemSessionAuditGetRequest(OCIRequest)
Request the system level data associated with session audit.
The response is either a SystemSessionAuditGetResponse() or an ErrorResponse().
Replaced By: SystemSessionAuditGetRequest14sp3()
SystemSessionAuditGetRequest14sp3(OCIRequest)
Request the system level data associated with session audit.
The response is either a SystemSessionAuditGetResponse14sp3() or an
ErrorResponse().
SystemSessionAuditGetRequest17sp3(OCIRequest)
Request the system level data associated with session audit.
The response is either a SystemSessionAuditGetResponse17sp3() or an
ErrorResponse(). Replaced by: SystemSessionAuditGetRequest23() in AS data mode.
SystemSessionAuditGetRequest23(OCIRequest)
Request the system level data associated with session audit.
The response is either a SystemSessionAuditGetResponse23() or an ErrorResponse().
SystemSessionAuditModifyRequest(OCIRequest)
Modify the system level data associated with session sudit.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: SystemSessionAuditModifyRequest14sp3()
Attributes:
| Name | Type | Description |
|---|---|---|
| is_active | bool | isActive Optional |
| interval_seconds | int | intervalSeconds Optional |
| timeout_period_seconds | int | timeoutPeriodSeconds Optional |
SystemSessionAuditModifyRequest14sp3(OCIRequest)
Modify the system level data associated with session audit.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
alwaysAllowRefreshForMS msAuditIntervalSeconds
Attributes:
| Name | Type | Description |
|---|---|---|
| is_audit_active | bool | isAuditActive Optional |
| audit_interval_seconds | int | auditIntervalSeconds Optional |
| audit_timeout_seconds | int | auditTimeoutSeconds Optional |
| release_call_on_audit_failure | bool | releaseCallOnAuditFailure Optional |
| is_sip_refresh_allowed_on_audit | bool | isSIPRefreshAllowedOnAudit Optional |
| allow_update_for_sip_refresh | bool | allowUpdateForSIPRefresh Optional |
| is_sip_session_timer_active | bool | isSIPSessionTimerActive Optional |
| sip_session_expires_minimum_seconds | int | sipSessionExpiresMinimumSeconds Optional |
| enforce_sip_session_expires_maximum | bool | enforceSIPSessionExpiresMaximum Optional |
| sip_session_expires_maximum_seconds | int | sipSessionExpiresMaximumSeconds Optional |
| sip_session_expires_timer_seconds | int | sipSessionExpiresTimerSeconds Optional |
| always_use_session_timer_when_supported | bool | alwaysUseSessionTimerWhenSupported Optional |
| preferred_session_timer_refresher | str | preferredSessionTimerRefresher Optional |
| enable_emergency_call_alarm_timer | bool | enableEmergencyCallAlarmTimer Optional |
| emergency_call_alarm_minutes | int | emergencyCallAlarmMinutes Optional |
| enable_emergency_call_cleanup_timer | bool | enableEmergencyCallCleanupTimer Optional |
| emergency_call_cleanup_minutes | int | emergencyCallCleanupMinutes Optional |
| always_allow_refresh_for_ms | bool | alwaysAllowRefreshForMS Optional |
| ms_audit_interval_seconds | int | msAuditIntervalSeconds Optional |
SystemShInterfaceParametersGetRequest(OCIRequest)
Retrieves the Sh Interface system parameters.
The response is either a SystemShInterfaceParametersGetResponse() or an
ErrorResponse(). Replaced by: SystemShInterfaceParametersGetRequest17()
SystemShInterfaceParametersGetRequest17(OCIRequest)
Retrieves the Sh Interface system parameters.
The response is either a SystemShInterfaceParametersGetResponse() or an
ErrorResponse().
SystemShInterfaceParametersModifyRequest(OCIRequest)
Modifies the Sh Interface system parameters.
This request must be submitted on both nodes in the redundant Application Server cluster in order for the changes to take effect on each node without requiring a restart.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemShInterfaceParametersModifyRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| hss_realm | str | hssRealm Optional |
| request_timeout_seconds | int | requestTimeoutSeconds Optional |
| public_identity_refresh_delay_seconds | int | publicIdentityRefreshDelaySeconds Optional |
SystemShInterfaceParametersModifyRequest17(OCIRequest)
Modifies the Sh Interface system parameters.
This request must be submitted on both nodes in the redundant Application Server cluster in order for the changes to take effect on each node without requiring a restart.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| hss_realm | str | hssRealm Optional |
| public_identity_refresh_delay_seconds | int | publicIdentityRefreshDelaySeconds Optional |
SystemShInterfaceRefreshTaskGetRequest(OCIRequest)
Retrieves the status of the system refresh task on the local Application Server node.
The response is either a SystemShInterfaceRefreshTaskGetResponse() or an
ErrorResponse().
SystemShInterfaceRefreshTaskStartRequest(OCIRequest)
Dispatches the system refresh task on the local Application Server node.
At most one instance of the system refresh task may run on an Application Server node
at a given point in time. If the system refresh task is already running when this
request is made, an ErrorResponse() is returned.
The response is either a SuccessResponse() or an ErrorResponse().
SystemShInterfaceRefreshTaskTerminateRequest(OCIRequest)
Terminates the system refresh task in progress on the local Application Server node.
The response is either a SuccessResponse() or an ErrorResponse().
SystemSoftwareVersionGetRequest(OCIRequest)
Requests the software version of the Application Server.
The response is either SystemSoftwareVersionGetResponse() or ErrorResponse().
SystemSpeedDial100GetRequest(OCIRequest)
Get the speed dial 100 system-wide default setting.
The response is either a SystemSpeedDial100GetResponse() or an ErrorResponse().
Replaced by: SystemSpeedDial100GetRequest17sp1()
SystemSpeedDial100GetRequest17sp1(OCIRequest)
Get the speed dial 100 system-wide default setting.
The response is either a SystemSpeedDial100GetResponse17sp1() or an
ErrorResponse().
SystemSpeedDial100ModifyRequest(OCIRequest)
Modify the speed dial 100 system-wide default prefix setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| prefix | str | prefix Optional |
SystemStateOrProvinceGetListRequest(OCIRequest)
Requests the list of state and province names.
The response is either SystemStateOrProvinceGetListResponse() or ErrorResponse().
SystemStirShakenCallerIdDispositionMappingGetRequest(OCIRequest)
Request to get the Caller Id Disposition mapping.
The response is either SystemStirShakenCallerIdDispositionMappingGetResponse() or
ErrorResponse().
SystemStirShakenCallerIdDispositionMappingModifyRequest(OCIRequest)
Request to modify the Caller Id Disposition mapping.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| verstat | str | verstat |
| attestation_level | str | attestationLevel Optional |
| disposition | str | disposition Optional |
SystemStirShakenGetRequest(OCIRequest)
Get system Stir Shaken service settings.
The response is either SystemStirShakenGetResponse() or ErrorResponse(). Replaced
by SystemStirShakenGetRequest23().
SystemStirShakenGetRequest23(OCIRequest)
Get system Stir Shaken service settings.
The response is either SystemStirShakenGetResponse() or ErrorResponse(). Replaced
by SystemStirShakenGetRequest23V2().
SystemStirShakenGetRequest23V2(OCIRequest)
Get system Stir Shaken service settings.
The response is either SystemStirShakenGetResponse23V2() or ErrorResponse().
SystemStirShakenModifyRequest(OCIRequest)
Modify system Stir Shaken service settings.
Attributes:
| Name | Type | Description |
|---|---|---|
| signing_policy | str | signingPolicy Optional |
| tagging_policy | str | taggingPolicy Optional |
| sign_emergency_calls | bool | signEmergencyCalls Optional |
| tag_emergency_calls | bool | tagEmergencyCalls Optional |
| signing_service_url | str | signingServiceURL Optional |
| tag_from_or_pai | str | tagFromOrPAI Optional |
| verstat_tag | str | verstatTag Optional |
| use_os_value_for_orig_id | bool | useOSValueForOrigId Optional |
| orig_uuid | str | origUUID Optional |
| attestation_level | str | attestationLevel Optional |
| enable_verification | bool | enableVerification Optional |
| verification_service_url | str | verificationServiceURL Optional |
| verification_error_handling | str | verificationErrorHandling Optional |
| proxy_verstat_to_cnam_subscribe | bool | proxyVerstatToCNAMSubscribe Optional |
| use_unknown_headers_from_cnam_notify | bool | useUnknownHeadersFromCNAMNotify Optional |
| use_ts24229_headers | bool | useTS24229Headers Optional |
| enable_signing_for_unscreened_trunk_group_originations | bool | enableSigningForUnscreenedTrunkGroupOriginations Optional |
| enable_tagging_for_unscreened_trunk_group_originations | bool | enableTaggingForUnscreenedTrunkGroupOriginations Optional |
| unscreened_trunk_group_origination_attestation_level | str | unscreenedTrunkGroupOriginationAttestationLevel Optional |
| verify_gets_calls | bool | verifyGETSCalls Optional |
| allow_partial_ingress_tagging | bool | allowPartialIngressTagging Optional |
| include_verstat_to_mobile_network_locations | bool | includeVerstatToMobileNetworkLocations Optional |
| allow_verstat_in_sipuri_with_phone_correction | bool | allowVerstatInSIPURIWithPhoneCorrection Optional |
| include_tagged_headers_to_access_side | bool | includeTaggedHeadersToAccessSide Optional |
| proxy_identity_header_to_access_side | bool | proxyIdentityHeaderToAccessSide Optional |
| check_directory_numbers_for_attestation | bool | checkDirectoryNumbersForAttestation Optional |
| match_unassigned_numbers_only | bool | matchUnassignedNumbersOnly Optional |
| enable_tagging_for_redirected_calls | bool | enableTaggingForRedirectedCalls Optional |
| prefer_ingress_tagging | bool | preferIngressTagging Optional |
SystemSubscriberGetCallProcessingParametersRequest(OCIRequest)
Get the system call processing configuration for all subscribers The response is
either a SystemSubscriberGetCallProcessingParametersResponse() or an
ErrorResponse().
Replaced By: SystemSubscriberGetCallProcessingParametersRequest14sp3()
SystemSubscriberGetCallProcessingParametersRequest14sp3(OCIRequest)
Get the system call processing configuration for all subscribers The response is
either a SystemSubscriberGetCallProcessingParametersResponse14sp3() or an
ErrorResponse().
SystemSubscriberGetCallProcessingParametersRequest14sp7(OCIRequest)
Get the system call processing configuration for all subscribers The response is
either a SystemSubscriberGetCallProcessingParametersResponse14sp7() or an
ErrorResponse().
Replaced By : SystemSubscriberGetCallProcessingParametersRequest15sp2()
SystemSubscriberGetCallProcessingParametersRequest15(OCIRequest)
Get the system call processing configuration for all subscribers The response is
either a SystemSubscriberGetCallProcessingParametersResponse15() or an
ErrorResponse().
Replaced By: SystemSubscriberGetCallProcessingParametersRequest15sp2()
SystemSubscriberGetCallProcessingParametersRequest15sp2(OCIRequest)
Get the system call processing configuration for all subscribers The response is
either a SystemSubscriberGetCallProcessingParametersResponse15sp2() or an
ErrorResponse().
Replaced by: SystemSubscriberGetCallProcessingParametersRequest17()
SystemSubscriberGetCallProcessingParametersRequest17(OCIRequest)
Get the system call processing configuration for all subscribers The response is
either a SystemSubscriberGetCallProcessingParametersResponse17() or an
ErrorResponse().
SystemSubscriberGetCallProcessingParametersRequest17sp3(OCIRequest)
Get the system call processing configuration for all subscribers The response is
either a SystemSubscriberGetCallProcessingParametersResponse17sp3() or an
ErrorResponse().
SystemSubscriberGetCallProcessingParametersRequest17sp4(OCIRequest)
Get the system call processing configuration for all subscribers The response is
either a SystemSubscriberGetCallProcessingParametersResponse17sp4() or an
ErrorResponse().
Replaced by SystemSubscriberGetCallProcessingParametersRequest18sp1().
SystemSubscriberGetCallProcessingParametersRequest18sp1(OCIRequest)
Get the system call processing configuration for all subscribers The response is
either a SystemSubscriberGetCallProcessingParametersResponse18sp1() or an
ErrorResponse().
SystemSubscriberGetLoginParametersRequest(OCIRequest)
Get the system login configuration for all subscribers.
The response is either a SystemSubscriberGetLoginParametersResponse() or an
ErrorResponse().
SystemSubscriberGetProvisioningParametersRequest(OCIRequest)
Get the system provisioning configuration for all subscribers The response is either a
SystemSubscriberGetProvisioningParametersResponse() or an ErrorResponse().
Replaced by: SystemSubscriberGetProvisioningParametersRequest24()
SystemSubscriberGetProvisioningParametersRequest23(OCIRequest)
Get the system provisioning configuration for all subscribers The response is either a
SystemSubscriberGetProvisioningParametersResponse23() or an ErrorResponse().
Replaced by: SystemSubscriberGetProvisioningParametersRequest24V2().
SystemSubscriberGetProvisioningParametersRequest24(OCIRequest)
Get the system provisioning configuration for all subscribers The response is either a
SystemSubscriberGetProvisioningParametersResponse24() or an ErrorResponse().
Replaced by: SystemSubscriberGetProvisioningParametersRequest24V2().
SystemSubscriberGetProvisioningParametersRequest24V2(OCIRequest)
Get the system provisioning configuration for all subscribers The response is either a
SystemSubscriberGetProvisioningParametersResponse24V2() or an ErrorResponse().
SystemSubscriberModifyCallProcessingParametersRequest(OCIRequest)
Modify the system call processing configuration for all subscribers.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in the XS data mode:
userCallingLineIdSelection isExtendedCallingLineIdActive isRingTimeOutActive
ringTimeoutSeconds allowEmergencyRemoteOfficeOriginations
Replaced By: SystemSubscriberModifyCallProcessingParametersRequest14sp7()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_calling_line_id_selection | str | userCallingLineIdSelection Optional |
| is_extended_calling_line_id_active | bool | isExtendedCallingLineIdActive Optional |
| is_ring_time_out_active | bool | isRingTimeOutActive Optional |
| ring_timeout_seconds | int | ringTimeoutSeconds Optional |
| allow_emergency_remote_office_originations | bool | allowEmergencyRemoteOfficeOriginations Optional |
| max_no_answer_number_of_rings | int | maxNoAnswerNumberOfRings Optional |
SystemSubscriberModifyCallProcessingParametersRequest14sp7(OCIRequest)
Modify the system call processing configuration for all subscribers.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in XS data mode and ignored in the AS data mode:
minNoAnswerNumberOfRings The following elements are only used in AS data mode and
ignored in the XS data mode: isExtendedCallingLineIdActive isRingTimeOutActive
ringTimeoutSeconds allowEmergencyRemoteOfficeOriginations incomingCallToUserAliasMode
bypassTerminationLoopDetection honorCLIDBlockingForEmergencyCalls
useUnicodeIdentityName
Attributes:
| Name | Type | Description |
|---|---|---|
| is_extended_calling_line_id_active | bool | isExtendedCallingLineIdActive Optional |
| is_ring_time_out_active | bool | isRingTimeOutActive Optional |
| ring_timeout_seconds | int | ringTimeoutSeconds Optional |
| allow_emergency_remote_office_originations | bool | allowEmergencyRemoteOfficeOriginations Optional |
| max_no_answer_number_of_rings | int | maxNoAnswerNumberOfRings Optional |
| min_no_answer_number_of_rings | int | minNoAnswerNumberOfRings Optional |
| incoming_call_to_user_alias_mode | str | incomingCallToUserAliasMode Optional |
| bypass_termination_loop_detection | bool | bypassTerminationLoopDetection Optional |
| honor_clid_blocking_for_emergency_calls | bool | honorCLIDBlockingForEmergencyCalls Optional |
| use_unicode_identity_name | bool | useUnicodeIdentityName Optional |
SystemSubscriberModifyLoginParametersRequest(OCIRequest)
Modify the system login configuration for all subscribers The response is either a
SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| max_failed_login_attempts | int | maxFailedLoginAttempts Optional |
| min_login_id_length | int | minLoginIdLength Optional |
SystemSubscriberModifyProvisioningParametersRequest(OCIRequest)
Modify the system provisioning configuration for all subscribers.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| configurable_clid_normalization | bool | configurableCLIDNormalization Optional |
| include_default_domain | bool | includeDefaultDomain Optional |
| min_auth_level_to_provision_alt_user_id | str | minAuthLevelToProvisionAltUserID Optional |
SystemSubscriptionLicenseReportingGetRequest(OCIRequest)
Request to get the subscription license reporting system parameters.
The response is either SystemSubscriptionLicenseReportingGetResponse() or
ErrorResponse().
SystemSystemServiceCallProcessingPoliciesGetRequest(OCIRequest)
Request the data associated with Call Processing Policy for system service instances.
The response is either SystemSystemServiceCallProcessingPoliciesGetResponse() or
ErrorResponse().
SystemSystemServiceCallProcessingPoliciesModifyRequest(OCIRequest)
Request the data associated with Call Processing Policy for system service instances.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
SystemSystemServiceDnGetAvailableListRequest(OCIRequest)
Request a list of system service DNs not yet in use.
The response is either SystemSystemServiceDnGetAvailableListResponse() or
ErrorResponse().
SystemSystemServiceDnGetSummaryListRequest(OCIRequest)
Request a summary table of all System Service DNs.
The response is either SystemSystemServiceDnGetSummaryListResponse() or
ErrorResponse().
SystemSystemServiceDnGetUsageListRequest(OCIRequest)
Request a list of System Service DN utilization.
The response is either SystemSystemServiceDnGetUsageListResponse() or
ErrorResponse().
SystemSystemVoicePortalDeleteRequest(OCIRequest)
Request to delete a system voice portal instance.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| system_voice_portal_id | str | systemVoicePortalId |
SystemSystemVoicePortalGetListRequest(OCIRequest)
Request to get the list of the system voice portals.
The response is either SystemSystemVoicePortalGetListResponce or ErrorResponse().
SystemSystemVoicePortalGetRequest(OCIRequest)
Request to get a system voice portal instance.
The response is either SystemSystemVoicePortalGetResponse() or ErrorResponse().
Replaced by: SystemSystemVoicePortalGetRequest21sp1().
Attributes:
| Name | Type | Description |
|---|---|---|
| system_voice_portal_id | str | systemVoicePortalId |
SystemSystemVoicePortalGetRequest21sp1(OCIRequest)
Request to get a system voice portal instance.
The response is either SystemSystemVoicePortalGetResponse21sp1() or
ErrorResponse(). Replaced by: SystemSystemVoicePortalGetRequest23().
Attributes:
| Name | Type | Description |
|---|---|---|
| system_voice_portal_id | str | systemVoicePortalId |
SystemSystemVoicePortalGetRequest23(OCIRequest)
Request to get a system voice portal instance.
The response is either SystemSystemVoicePortalGetResponse23() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| system_voice_portal_id | str | systemVoicePortalId |
SystemTemplateOnlyDeviceFileGetListRequest(OCIRequest)
Request to get the list of template files used to support a VDM device defined at system level.
The response is either SystemTemplateOnlyDeviceFileGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemThirdPartyEmergencyCallingGetRequest(OCIRequest)
Get the third-party emergency call service settings for the system.
The response is either a SystemThirdPartyEmergencyCallingGetResponse() or an
ErrorResponse(). Replaced by: SystemThirdPartyEmergencyCallingGetRequest24()
SystemThirdPartyEmergencyCallingGetRequest24(OCIRequest)
Get the third-party emergency call service settings for the system.
The response is either a SystemThirdPartyEmergencyCallingGetResponse24() or an
ErrorResponse().
SystemThirdPartyEmergencyCallingModifyRequest(OCIRequest)
Modify the third-party emergency call service settings for the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| primary_held_server_url | str | primaryHELDServerURL Optional |
| secondary_held_server_url | str | secondaryHELDServerURL Optional |
| emergency_route_net_address | str | emergencyRouteNetAddress Optional |
| emergency_route_port | int | emergencyRoutePort Optional |
| emergency_route_transport | str | emergencyRouteTransport Optional |
SystemThirdPartyIMPGetRequest(OCIRequest)
Get the system Third-Party IMP service attributes.
The response is either SystemThirdPartyIMPGetResponse() or ErrorResponse().
Replaced by SystemThirdPartyIMPGetRequest19().
SystemThirdPartyIMPGetRequest19(OCIRequest)
Get the system Third-Party IMP service attributes.
The response is either SystemThirdPartyIMPGetResponse19() or ErrorResponse().
SystemThirdPartyIMPModifyRequest(OCIRequest)
Modify the system Third-Party IMP service attributes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_net_address | str | serviceNetAddress Optional |
| service_port | int | servicePort Optional |
| bosh_url | str | boshURL Optional |
SystemThirdPartyVoiceMailSupportAddDnRequest(OCIRequest)
Request to add a ThirdPartyVoiceMailSupport User DN to the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| phone_number | str | phoneNumber |
| description | str | description Optional |
SystemThirdPartyVoiceMailSupportDeleteDnRequest(OCIRequest)
Request to delete a ThirdPartyVoiceMailSupport User DN from the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| phone_number | str | phoneNumber |
SystemThirdPartyVoiceMailSupportGetRequest(OCIRequest)
Request the system level data associated with Third-party Voice Mail Support.
The response is either a SystemThirdPartyVoiceMailSupportGetResponse() or an
ErrorResponse(). Replaced by: SystemThirdPartyVoiceMailSupportGetRequest17sp4()
SystemThirdPartyVoiceMailSupportGetRequest17sp4(OCIRequest)
Request the system level data associated with Third-party Voice Mail Support.
The response is either a SystemThirdPartyVoiceMailSupportGetResponse17sp4() or an
ErrorResponse().
SystemThirdPartyVoiceMailSupportModifyDnRequest(OCIRequest)
Request to modify a ThirdPartyVoiceMailSupport User DN and description in the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| phone_number | str | phoneNumber |
| description | str | description Optional |
SystemThirdPartyVoiceMailSupportModifyRequest(OCIRequest)
Modify the system level data associated with Third-party Voice Mail Support.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: stripDiversionOnVMDestinationRetrieval
Attributes:
| Name | Type | Description |
|---|---|---|
| override_alt_caller_id_for_vm_retrieval | bool | overrideAltCallerIdForVMRetrieval Optional |
| strip_diversion_on_vm_destination_retrieval | bool | stripDiversionOnVMDestinationRetrieval Optional |
SystemTimeScheduleDeleteRequest(OCIRequest)
Delete a system time schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| time_schedule_name | str | timeScheduleName |
SystemTimeScheduleGetListRequest(OCIRequest)
Request a list of all system time schedules.
The response is either a SystemTimeScheduleGetListResponse() or an
ErrorResponse().
SystemTimeScheduleGetRequest(OCIRequest)
Request to get a system time schedule.
The response is either a SystemTimeScheduleGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| time_schedule_name | str | timeScheduleName |
SystemTimeZoneGetListRequest(OCIRequest)
Requests the list of time zone names.
The response is either SystemTimeZoneGetListResponse() or ErrorResponse().
Replaced by: SystemTimeZoneGetListRequest20() in AS data mode
SystemTimeZoneGetListRequest20(OCIRequest)
Requests the configured time zone of the server processing the request and the list of time zone names.
The response is either SystemTimeZoneGetListResponse20() or ErrorResponse().
SystemTreatmentMappingAccessSIPStatusAddRequest(OCIRequest)
Add an Access SIP Status Code Mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| sip_status_code | int | sipStatusCode |
| treatment_id | str | treatmentId |
SystemTreatmentMappingAccessSIPStatusDeleteRequest(OCIRequest)
Delete an Access SIP Status Code mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| sip_status_code | int | sipStatusCode |
SystemTreatmentMappingAccessSIPStatusGetListRequest(OCIRequest)
Requests a table of all the existing Access Side SIP Status Code Mappings in the system.
The response is either an SystemTreatmentMappingAccessSIPStatusGetListResponse() or
an ErrorResponse().
SystemTreatmentMappingAccessSIPStatusModifyRequest(OCIRequest)
Modify the fields for an Access SIP Status Code mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| sip_status_code | int | sipStatusCode |
| treatment_id | str | treatmentId Optional |
SystemTreatmentMappingCallBlockingServiceAddRequest(OCIRequest)
Add a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceAddRequest22() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId |
SystemTreatmentMappingCallBlockingServiceAddRequest22(OCIRequest)
Add a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceAddRequest22V2() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId |
SystemTreatmentMappingCallBlockingServiceAddRequest22V2(OCIRequest)
Add a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceAddRequest23() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId |
SystemTreatmentMappingCallBlockingServiceAddRequest22V3(OCIRequest)
Add a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId |
SystemTreatmentMappingCallBlockingServiceAddRequest22V5(OCIRequest)
Add a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId |
SystemTreatmentMappingCallBlockingServiceAddRequest23(OCIRequest)
Add a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceAddRequest23V2() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId |
SystemTreatmentMappingCallBlockingServiceAddRequest23V2(OCIRequest)
Add a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId |
SystemTreatmentMappingCallBlockingServiceAddRequest23V3(OCIRequest)
Add a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceAddRequest24() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId |
SystemTreatmentMappingCallBlockingServiceAddRequest23V5(OCIRequest)
Add a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId |
SystemTreatmentMappingCallBlockingServiceAddRequest24(OCIRequest)
Add a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId |
SystemTreatmentMappingCallBlockingServiceAddRequest24V2(OCIRequest)
Add a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId |
SystemTreatmentMappingCallBlockingServiceDeleteRequest(OCIRequest)
Delete a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceDeleteRequest22() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
SystemTreatmentMappingCallBlockingServiceDeleteRequest22(OCIRequest)
Delete a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceDeleteRequest22V2() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
SystemTreatmentMappingCallBlockingServiceDeleteRequest22V2(OCIRequest)
Delete a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceDeleteRequest23() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
SystemTreatmentMappingCallBlockingServiceDeleteRequest22V3(OCIRequest)
Delete a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
SystemTreatmentMappingCallBlockingServiceDeleteRequest22V5(OCIRequest)
Delete a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
SystemTreatmentMappingCallBlockingServiceDeleteRequest23(OCIRequest)
Delete a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceDeleteRequest23V2() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
SystemTreatmentMappingCallBlockingServiceDeleteRequest23V2(OCIRequest)
Delete a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
SystemTreatmentMappingCallBlockingServiceDeleteRequest23V3(OCIRequest)
Delete a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceDeleteRequest24() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
SystemTreatmentMappingCallBlockingServiceDeleteRequest23V5(OCIRequest)
Delete a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
SystemTreatmentMappingCallBlockingServiceDeleteRequest24(OCIRequest)
Delete a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
SystemTreatmentMappingCallBlockingServiceDeleteRequest24V2(OCIRequest)
Delete a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
SystemTreatmentMappingCallBlockingServiceGetListRequest(OCIRequest)
Requests a table of all the existing Call Blocking Service Mappings in the system.
The response is either a SystemTreatmentMappingCallBlockingServicesGetListResponse()
or an ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceGetListRequest19sp1() in AS data mode
SystemTreatmentMappingCallBlockingServiceGetListRequest19sp1(OCIRequest)
Requests a table of all the existing Call Blocking Service Mappings in the system.
The response is either a
SystemTreatmentMappingCallBlockingServicesGetListResponse19sp1() or an
ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceGetListRequest22()
SystemTreatmentMappingCallBlockingServiceGetListRequest22(OCIRequest)
Requests a table of all the existing Call Blocking Service Mappings in the system.
The response is either a
SystemTreatmentMappingCallBlockingServicesGetListResponse22() or an
ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceGetListRequest23()
SystemTreatmentMappingCallBlockingServiceGetListRequest22V2(OCIRequest)
Requests a table of all the existing Call Blocking Service Mappings in the system.
The response is either a
SystemTreatmentMappingCallBlockingServicesGetListResponse22V2() or an
ErrorResponse().
SystemTreatmentMappingCallBlockingServiceGetListRequest22V3(OCIRequest)
Requests a table of all the existing Call Blocking Service Mappings in the system.
The response is either a
SystemTreatmentMappingCallBlockingServicesGetListResponse22V3() or an
ErrorResponse().
SystemTreatmentMappingCallBlockingServiceGetListRequest23(OCIRequest)
Requests a table of all the existing Call Blocking Service Mappings in the system.
The response is either a
SystemTreatmentMappingCallBlockingServicesGetListResponse23() or an
ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceGetListRequest23V2() in AS data mode.
SystemTreatmentMappingCallBlockingServiceGetListRequest23V2(OCIRequest)
Requests a table of all the existing Call Blocking Service Mappings in the system.
The response is either a
SystemTreatmentMappingCallBlockingServicesGetListResponse23V2() or an
ErrorResponse().
SystemTreatmentMappingCallBlockingServiceGetListRequest23V3(OCIRequest)
Requests a table of all the existing Call Blocking Service Mappings in the system.
The response is either a
SystemTreatmentMappingCallBlockingServicesGetListResponse23V3() or an
ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceGetListRequest24() in AS data mode.
SystemTreatmentMappingCallBlockingServiceGetListRequest23V5(OCIRequest)
Requests a table of all the existing Call Blocking Service Mappings in the system.
The response is either a
SystemTreatmentMappingCallBlockingServicesGetListResponse23V5() or an
ErrorResponse().
SystemTreatmentMappingCallBlockingServiceGetListRequest24(OCIRequest)
Requests a table of all the existing Call Blocking Service Mappings in the system.
The response is either a
SystemTreatmentMappingCallBlockingServicesGetListResponse24() or an
ErrorResponse().
SystemTreatmentMappingCallBlockingServiceGetListRequest24V2(OCIRequest)
Requests a table of all the existing Call Blocking Service Mappings in the system.
The response is either a
SystemTreatmentMappingCallBlockingServicesGetListResponse24V2() or an
ErrorResponse().
SystemTreatmentMappingCallBlockingServiceModifyRequest(OCIRequest)
Modify the fields for a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceModifyRequest22() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId Optional |
SystemTreatmentMappingCallBlockingServiceModifyRequest22(OCIRequest)
Modify the fields for a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceModifyRequest22V2() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId Optional |
SystemTreatmentMappingCallBlockingServiceModifyRequest22V2(OCIRequest)
Modify the fields for a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceModifyRequest23() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId Optional |
SystemTreatmentMappingCallBlockingServiceModifyRequest22V3(OCIRequest)
Modify the fields for a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId Optional |
SystemTreatmentMappingCallBlockingServiceModifyRequest22V5(OCIRequest)
Modify the fields for a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId Optional |
SystemTreatmentMappingCallBlockingServiceModifyRequest23(OCIRequest)
Modify the fields for a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceModifyRequest23V2() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId Optional |
SystemTreatmentMappingCallBlockingServiceModifyRequest23V2(OCIRequest)
Modify the fields for a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId Optional |
SystemTreatmentMappingCallBlockingServiceModifyRequest23V3(OCIRequest)
Modify the fields for a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemTreatmentMappingCallBlockingServiceModifyRequest24() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId Optional |
SystemTreatmentMappingCallBlockingServiceModifyRequest23V5(OCIRequest)
Modify the fields for a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId Optional |
SystemTreatmentMappingCallBlockingServiceModifyRequest24(OCIRequest)
Modify the fields for a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId Optional |
SystemTreatmentMappingCallBlockingServiceModifyRequest24V2(OCIRequest)
Modify the fields for a Call Blocking Service mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| call_blocking_service | str | callBlockingService |
| treatment_id | str | treatmentId Optional |
SystemTreatmentMappingInternalReleaseCauseAddRequest(OCIRequest)
Add an Internal Release Cause mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| internal_release_cause | str | internalReleaseCause |
| treatment_id | str | treatmentId |
SystemTreatmentMappingInternalReleaseCauseDeleteRequest(OCIRequest)
Delete an Internal Release Cause mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| internal_release_cause | str | internalReleaseCause |
SystemTreatmentMappingInternalReleaseCauseGetListRequest(OCIRequest)
Requests a table of all the Internal Release Cause mappings in the system.
The response is either a SystemTreatmentMappingInternalReleaseCauseGetListResponse()
or an ErrorResponse().
SystemTreatmentMappingInternalReleaseCauseModifyRequest(OCIRequest)
Modify the fields for an Internal Release Cause mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| internal_release_cause | str | internalReleaseCause |
| treatment_id | str | treatmentId Optional |
SystemTreatmentMappingNetworkSIPStatusAddRequest(OCIRequest)
Add a Network SIP Status Code mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| sip_status_code | int | sipStatusCode |
| treatment_id | str | treatmentId |
SystemTreatmentMappingNetworkSIPStatusDeleteRequest(OCIRequest)
Delete a Network SIP Status Code mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| sip_status_code | int | sipStatusCode |
SystemTreatmentMappingNetworkSIPStatusGetListRequest(OCIRequest)
Requests a table of all the existing Network SIP Status Code Mappings in the system.
The response is either an
SystemTreatmentMappingNetworkSIPStatusCodeGetListResponse() or an ErrorResponse().
SystemTreatmentMappingNetworkSIPStatusModifyRequest(OCIRequest)
Modify the fields for a Network SIP Status Code mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| sip_status_code | int | sipStatusCode |
| treatment_id | str | treatmentId Optional |
SystemTreatmentMappingNetworkServerTreatmentAddRequest(OCIRequest)
Add a Network Server Treatment mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| ns_treatment | str | nsTreatment |
| treatment_id | str | treatmentId |
SystemTreatmentMappingNetworkServerTreatmentDeleteRequest(OCIRequest)
Delete a NS Treatment mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| ns_treatment | str | nsTreatment |
SystemTreatmentMappingNetworkServerTreatmentGetListRequest(OCIRequest)
Requests a table of all the existing NS Treatment Mappings in the system.
The response is either a
SystemTreatmentMappingNetworkServerTreatmentGetListResponse() or an
ErrorResponse().
SystemTreatmentMappingNetworkServerTreatmentModifyRequest(OCIRequest)
Modify the fields for a Network Server Treatment mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| ns_treatment | str | nsTreatment |
| treatment_id | str | treatmentId Optional |
SystemTreatmentMappingQ850CauseAddRequest(OCIRequest)
Add a Q850 Cause Value mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| q850_cause_value | int | q850CauseValue |
| treatment_id | str | treatmentId |
SystemTreatmentMappingQ850CauseDeleteRequest(OCIRequest)
Delete a Q850 Cause Value mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| q850_cause_value | int | q850CauseValue |
SystemTreatmentMappingQ850CauseGetListRequest(OCIRequest)
Requests a table of all the existing Q850 Cause Value Mappings in the system.
The response is either a SystemTreatmentMappingQ850CauseGetListResponse() or an
ErrorResponse().
SystemTreatmentMappingQ850CauseModifyRequest(OCIRequest)
Modify the fields for a Q850CauseValue mapping.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| q850_cause_value | int | q850CauseValue |
| treatment_id | str | treatmentId Optional |
SystemTrunkGroupGetRequest(OCIRequest)
Request the system level data associated with the Trunk Group service.
The response is either SystemTrunkGroupGetResponse() or ErrorResponse(). Replaced
by: SystemTrunkGroupGetRequest19sp1().
SystemTrunkGroupGetRequest19sp1(OCIRequest)
Request the system level data associated with the Trunk Group service.
The response is either SystemTrunkGroupGetResponse19sp1() or ErrorResponse().
Replaced by: SystemTrunkGroupGetRequest21()
SystemTrunkGroupGetRequest21(OCIRequest)
Request the system level data associated with the Trunk Group service.
The response is either SystemTrunkGroupGetResponse21() or ErrorResponse().
Replaced by: SystemTrunkGroupGetRequest22()
SystemTrunkGroupGetRequest22(OCIRequest)
Request the system level data associated with the Trunk Group service.
The response is either SystemTrunkGroupGetResponse22() or ErrorResponse().
Replaced by: SystemTrunkGroupGetRequest23()
SystemTrunkGroupGetRequest23(OCIRequest)
Request the system level data associated with the Trunk Group service.
The response is either SystemTrunkGroupGetResponse23() or ErrorResponse().
Replaced by: SystemTrunkGroupGetRequest24()
SystemTrunkGroupGetRequest24(OCIRequest)
Request the system level data associated with the Trunk Group service.
The response is either SystemTrunkGroupGetResponse24() or ErrorResponse().
SystemTrunkGroupModifyRequest(OCIRequest)
Modify the system level data associated with the Trunk Group Service.
Following attributes are only used in IMS mode. The values are saved if specified not in IMS mode: implicitRegistrationSetSupportPolicy sipIdentityForPilotAndProxyTrunkModesPolicy useMostRecentEntryOnDeflection
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enforce_clid_service_assignment_for_pilot_user | bool | enforceCLIDServiceAssignmentForPilotUser Optional |
| terminate_unreachable_trigger_detection_on_receipt_of18x | bool | terminateUnreachableTriggerDetectionOnReceiptOf18x Optional |
| pilot_user_calling_line_asserted_identity_policy | str | pilotUserCallingLineAssertedIdentityPolicy Optional |
| enforce_out_of_dialog_pbx_redirection_policies | bool | enforceOutOfDialogPBXRedirectionPolicies Optional |
| unscreened_redirection_handling | str | unscreenedRedirectionHandling Optional |
| enable_holdover_of_highwater_call_counts | bool | enableHoldoverOfHighwaterCallCounts Optional |
| holdover_period | int | holdoverPeriod Optional |
| time_zone_offset_minutes | int | timeZoneOffsetMinutes Optional |
| clid_source_for_screened_calls_policy | str | clidSourceForScreenedCallsPolicy Optional |
| user_lookup_policy | str | userLookupPolicy Optional |
| out_of_dialog_pbx_redirection_clid_mapping | str | outOfDialogPBXRedirectionCLIDMapping Optional |
| enforce_out_of_dialog_pbx_redirection_trunk_group_capacity | bool | enforceOutOfDialogPBXRedirectionTrunkGroupCapacity Optional |
| implicit_registration_set_support_policy | str | implicitRegistrationSetSupportPolicy Optional |
| sip_identity_for_pilot_and_proxy_trunk_modes_policy | str | sipIdentityForPilotAndProxyTrunkModesPolicy Optional |
| support_connected_identity_policy | str | supportConnectedIdentityPolicy Optional |
| use_unmapped_sessions_for_trunk_users | bool | useUnmappedSessionsForTrunkUsers Optional |
| allow_pai_lookup_for_out_of_dialog_pbx_redirection | bool | allowPAILookupForOutOfDialogPBXRedirection Optional |
| out_of_dialog_pbx_redirection_originator_lookup_policy | str | outOfDialogPBXRedirectionOriginatorLookupPolicy Optional |
| allow_trunk_identity_for_all_originations | bool | allowTrunkIdentityForAllOriginations Optional |
| use_most_recent_entry_on_deflection | bool | useMostRecentEntryOnDeflection Optional |
SystemTrunkGroupOptionsMessageResponseStatusCodeAddListRequest(OCIRequest)
Add a list of system level successful SIP OPTIONS message respoonse status codes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| status_code | List[str] | statusCode |
SystemTrunkGroupOptionsMessageResponseStatusCodeDeleteListRequest(OCIRequest)
Delete a list of system level successful SIP OPTIONS message respoonse status codes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| status_code | List[str] | statusCode |
SystemTrunkGroupOptionsMessageResponseStatusCodeGetListRequest(OCIRequest)
Get the list of system level successful SIP OPTIONS message respoonse status codes.
The response is either
SystemTrunkGroupOptionsMessageResponseStatusCodeGetListResponse() or
ErrorResponse().
SystemTrunkGroupUserCreationTaskGetListRequest(OCIRequest)
Get the list of user creation tasks in the system.
The response is either SystemTrunkGroupUserCreationTaskGetListResponse() or
ErrorResponse().
SystemTrunkGroupUserCreationTaskGetListRequest14sp4(OCIRequest)
Get the list of user creation tasks in the system.
The response is either SystemTrunkGroupUserCreationTaskGetListResponse14sp4() or
ErrorResponse().
SystemTwoStageDialingAddDnRequest(OCIRequest)
Request to add Two Stage Dialing number to the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| phone_number | str | phoneNumber |
| description | str | description Optional |
SystemTwoStageDialingDeleteDnRequest(OCIRequest)
Request to delete a Two Stage Dialing number from the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| phone_number | str | phoneNumber |
SystemTwoStageDialingModifyDnRequest(OCIRequest)
Request to modify a Two Stage Dialing number's description in the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| phone_number | str | phoneNumber |
| description | str | description Optional |
SystemVideoServerAddRequest(OCIRequest)
Request to add a video server to the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| port | int | port Optional |
| transport_protocol | str | transportProtocol |
| description | str | description Optional |
SystemVideoServerDeleteRequest(OCIRequest)
Request to delete a video server from the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
SystemVideoServerGetListRequest(OCIRequest)
Request to get a list of video servers defined in the system.
The response is either a SystemVideoServerGetListResponse() or an ErrorResponse().
SystemVideoServerModifyRequest(OCIRequest)
Request to modify a video server in the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| net_address | str | netAddress |
| port | int | port Optional |
| transport_protocol | str | transportProtocol Optional |
| description | str | description Optional |
SystemVideoServerParametersGetRequest(OCIRequest)
Request to get the list of video server system parameters.
The response is either SystemVideoServerParametersGetResponse() or
ErrorResponse().
SystemVideoServerParametersModifyRequest(OCIRequest)
Request to modify video server system parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| video_server_response_timer_milliseconds | int | videoServerResponseTimerMilliseconds Optional |
| video_server_selection_route_timer_milliseconds | int | videoServerSelectionRouteTimerMilliseconds Optional |
| use_static_video_server_device | bool | useStaticVideoServerDevice Optional |
SystemVirtualOnNetCallTypeAddRequest(OCIRequest)
Add a Virtual On-Net Call Type.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| virtual_on_net_call_type_name | str | virtualOnNetCallTypeName |
| virtual_on_net_call_type_cdr_value | str | virtualOnNetCallTypeCdrValue |
SystemVirtualOnNetCallTypeDeleteRequest(OCIRequest)
Delete a Virtual On-Net Call Type.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| virtual_on_net_call_type_name | str | virtualOnNetCallTypeName |
SystemVirtualOnNetCallTypeGetListRequest(OCIRequest)
Get the list Virtual On-Net Call Types in the system.
The response is either a SystemVirtualOnNetCallTypeGetListResponse() or an
ErrorResponse().
SystemVirtualOnNetCallTypeModifyRequest(OCIRequest)
Modify a Virtual On-Net Call Type.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| virtual_on_net_call_type_name | str | virtualOnNetCallTypeName |
| virtual_on_net_call_type_cdr_value | str | virtualOnNetCallTypeCdrValue Optional |
SystemVisualDeviceManagementGetDeviceInfoRequest(OCIRequest)
Get the information for a specified device supporting visual device management.
The response is either a SystemVisualDeviceManagementGetDeviceInfoResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
SystemVoiceMessageSummaryUpdateGetRequest(OCIRequest)
Requests system voice mail message summary update parameter settings.
The response is either SystemVoiceMessageSummaryUpdateGetResponse() or
ErrorResponse().
Replaced By: SystemVoiceMessageSummaryUpdateGetRequest25()
SystemVoiceMessageSummaryUpdateGetRequest25(OCIRequest)
Requests system voice mail message summary update parameter settings.
The response is either SystemVoiceMessageSummaryUpdateGetResponse25() or
ErrorResponse().
SystemVoiceMessageSummaryUpdateModifyRequest(OCIRequest)
Modify the system level data associated with Voice Messaging.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| send_saved_and_urgent_mwi_on_notification | bool | sendSavedAndUrgentMWIOnNotification Optional |
| send_message_summary_update_on_register | bool | sendMessageSummaryUpdateOnRegister Optional |
| min_time_between_mwi_on_register | int | minTimeBetweenMWIOnRegister Optional |
| allow_multiple_users_per_account | bool | allowMultipleUsersPerAccount Optional |
SystemVoiceMessagingGroupGetPasscodeRulesRequest14(OCIRequest)
Requests the system voice portal passcode rules setting.
The response is either SystemVoiceMessagingGroupGetPasscodeRulesResponse14() or
ErrorResponse().
Replaced By: SystemPortalPasscodeRulesGetRequest()
SystemVoiceMessagingGroupGetRequest14(OCIRequest)
Request the system level data associated with Voice Messaging.
The response is either a SystemVoiceMessagingGroupGetResponse14() or an
ErrorResponse(). Replaced by: SystemVoiceMessagingGroupGetRequest16()
SystemVoiceMessagingGroupGetRequest16(OCIRequest)
Request the system level data associated with Voice Messaging.
The response is either a SystemVoiceMessagingGroupGetResponse16() or an
ErrorResponse(). Replaced by: SystemVoiceMessagingGroupGetRequest16sp2()
SystemVoiceMessagingGroupGetRequest16sp2(OCIRequest)
Request the system level data associated with Voice Messaging.
The response is either a SystemVoiceMessagingGroupGetResponse16sp2() or an
ErrorResponse(). Replaced by: SystemVoiceMessagingGroupGetRequest20() in AS data
mode
SystemVoiceMessagingGroupGetRequest20(OCIRequest)
Request the system level data associated with Voice Messaging.
The response is either a SystemVoiceMessagingGroupGetResponse20() or an
ErrorResponse(). Replaced by: SystemVoiceMessagingGroupGetRequest21()
SystemVoiceMessagingGroupGetRequest21(OCIRequest)
Request the system level data associated with Voice Messaging.
The response is either a SystemVoiceMessagingGroupGetResponse21() or an
ErrorResponse(). Replaced by: SystemVoiceMessagingGroupGetRequest22() in AS data
mode
SystemVoiceMessagingGroupGetRequest22(OCIRequest)
Response to SystemVoiceMessagingGroupGetRequest22().
Replaced by: SystemVoiceMessagingGroupGetRequest22V2().
SystemVoiceMessagingGroupGetRequest22V2(OCIRequest)
Request the system level data associated with Voice Messaging.
The response is either a SystemVoiceMessagingGroupGetResponse22V2() or an
ErrorResponse(). Replaced by: SystemVoiceMessagingGroupGetRequest22V3().
SystemVoiceMessagingGroupGetRequest22V3(OCIRequest)
Request the system level data associated with Voice Messaging.
The response is either a SystemVoiceMessagingGroupGetResponse22V3() or an
ErrorResponse(). Replaced by: SystemVoiceMessagingGroupGetRequest23() in AS data
mode.
SystemVoiceMessagingGroupGetRequest23(OCIRequest)
Request the system level data associated with Voice Messaging.
The response is either a SystemVoiceMessagingGroupGetResponse23() or an
ErrorResponse(). Replaced by: SystemVoiceMessagingGroupGetRequestRI in AS data mode.
SystemVoiceMessagingGroupGetVoicePortalMenusRequest14(OCIRequest)
Requests the system voice portal Menus setting.
The response is either SystemVoiceMessagingGroupGetVoicePortalMenusResponse14() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| get_default_menu_keys | bool | getDefaultMenuKeys |
SystemVoiceMessagingGroupGetVoicePortalMenusRequest18(OCIRequest)
Requests the system voice portal Menus setting.
The response is either SystemVoiceMessagingGroupGetVoicePortalMenusResponse18() or
ErrorResponse(). Replaced by
SystemVoiceMessagingGroupGetVoicePortalMenusRequest19()
Attributes:
| Name | Type | Description |
|---|---|---|
| get_default_menu_keys | bool | getDefaultMenuKeys |
SystemVoiceMessagingGroupGetVoicePortalMenusRequest18sp1(OCIRequest)
Requests the system voice portal Menus setting.
The response is either SystemVoiceMessagingGroupGetVoicePortalMenusResponse18sp1()
or ErrorResponse(). Replaced by
SystemVoiceMessagingGroupGetVoicePortalMenusRequest19sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| get_default_menu_keys | bool | getDefaultMenuKeys |
SystemVoiceMessagingGroupGetVoicePortalMenusRequest19(OCIRequest)
Requests the system voice portal Menus setting.
The response is either SystemVoiceMessagingGroupGetVoicePortalMenusResponse19() or
ErrorResponse(). Replaced by:
SystemVoiceMessagingGroupGetVoicePortalMenusRequest19sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| get_default_menu_keys | bool | getDefaultMenuKeys |
SystemVoiceMessagingGroupGetVoicePortalMenusRequest19sp1(OCIRequest)
Requests the system voice portal Menus setting.
The response is either SystemVoiceMessagingGroupGetVoicePortalMenusResponse19sp1()
or ErrorResponse(). Replaced by
SystemVoiceMessagingGroupGetVoicePortalMenusRequest20()
Attributes:
| Name | Type | Description |
|---|---|---|
| get_default_menu_keys | bool | getDefaultMenuKeys |
SystemVoiceMessagingGroupGetVoicePortalMenusRequest20(OCIRequest)
Requests the system voice portal Menus setting.
The response is either SystemVoiceMessagingGroupGetVoicePortalMenusResponse20() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| get_default_menu_keys | bool | getDefaultMenuKeys |
SystemVoiceMessagingGroupGetVoicePortalMenusRequest21(OCIRequest)
Requests the system voice portal Menus setting.
The response is either SystemVoiceMessagingGroupGetVoicePortalMenusResponse21() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| get_default_menu_keys | bool | getDefaultMenuKeys |
SystemVoiceMessagingGroupModifyPasscodeRulesRequest(OCIRequest)
Request to modify the system voice portal passcode rules setting.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: SystemPortalPasscodeRulesModifyRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| disallow_repeated_digits | bool | disallowRepeatedDigits Optional |
| disallow_user_number | bool | disallowUserNumber Optional |
| disallow_reversed_user_number | bool | disallowReversedUserNumber Optional |
| disallow_old_passcode | bool | disallowOldPasscode Optional |
| disallow_reversed_old_passcode | bool | disallowReversedOldPasscode Optional |
| min_code_length | int | minCodeLength Optional |
| max_code_length | int | maxCodeLength Optional |
| disable_login_after_max_failed_login_attempts | bool | disableLoginAfterMaxFailedLoginAttempts Optional |
| max_failed_login_attempts | int | maxFailedLoginAttempts Optional |
| expire_password | bool | expirePassword Optional |
| passcode_expires_days | int | passcodeExpiresDays Optional |
| send_login_disabled_notify_email | bool | sendLoginDisabledNotifyEmail Optional |
| login_disabled_notify_email_address | str | loginDisabledNotifyEmailAddress Optional |
| default_password | str | defaultPassword Optional |
SystemVoiceMessagingGroupModifyRequest(OCIRequest)
Modify the system level data associated with Voice Messaging.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| real_delete_for_imap | bool | realDeleteForImap Optional |
| use_dn_in_mail_body | bool | useDnInMailBody Optional |
| use_short_subject_line | bool | useShortSubjectLine Optional |
| max_greeting_length_minutes | int | maxGreetingLengthMinutes Optional |
| max_message_length_minutes | int | maxMessageLengthMinutes Optional |
| max_mailbox_length_minutes | int | maxMailboxLengthMinutes Optional |
| does_message_age | bool | doesMessageAge Optional |
| hold_period_days | int | holdPeriodDays Optional |
| mail_server_net_address | str | mailServerNetAddress Optional |
| mail_server_protocol | str | mailServerProtocol Optional |
| default_delivery_from_address | str | defaultDeliveryFromAddress Optional |
| default_notification_from_address | str | defaultNotificationFromAddress Optional |
| default_voice_portal_lockout_from_address | str | defaultVoicePortalLockoutFromAddress Optional |
| use_outgoing_mwi_on_smdi | bool | useOutgoingMWIOnSMDI Optional |
| mwi_delay_in_seconds | int | mwiDelayInSeconds Optional |
| voice_portal_scope | str | voicePortalScope Optional |
| network_wide_messaging | bool | networkWideMessaging Optional |
| use_external_routing | bool | useExternalRouting Optional |
| default_external_routing_address | str | defaultExternalRoutingAddress Optional |
SystemVoiceMessagingGroupModifyRequest16(OCIRequest)
Modify the system level data associated with Voice Messaging.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: realDeleteForImap useDnInMailBody
useShortSubjectLine maxMessageLengthMinutes maxMailboxLengthMinutes doesMessageAge
holdPeriodDays mailServerNetAddress mailServerProtocol defaultDeliveryFromAddress
defaultNotificationFromAddress useOutgoingMWIOnSMDI mwiDelayInSeconds voicePortalScope
enterpriseVoicePortalLicensed networkWideMessaging useExternalRouting
defaultExternalRoutingAddress vmOnlySystem
clientInitiatedMailServerSessionTimeoutMinutes recordingAudioFileFormat
allowVoicePortalAccessFromVMDepositMenu allowVoicePortalAutoLoginForMobileDevicesOnly
selectMwiTemplatePerCaller The following elements are ignored in both AS and XS data
mode: storageSelection vmBucketName Replaced by:
SystemVoiceMessagingGroupModifyRequestRI in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| real_delete_for_imap | bool | realDeleteForImap Optional |
| use_dn_in_mail_body | bool | useDnInMailBody Optional |
| use_short_subject_line | bool | useShortSubjectLine Optional |
| max_message_length_minutes | int | maxMessageLengthMinutes Optional |
| max_mailbox_length_minutes | int | maxMailboxLengthMinutes Optional |
| does_message_age | bool | doesMessageAge Optional |
| hold_period_days | int | holdPeriodDays Optional |
| mail_server_net_address | str | mailServerNetAddress Optional |
| mail_server_protocol | str | mailServerProtocol Optional |
| default_delivery_from_address | str | defaultDeliveryFromAddress Optional |
| default_notification_from_address | str | defaultNotificationFromAddress Optional |
| default_voice_portal_lockout_from_address | str | defaultVoicePortalLockoutFromAddress Optional |
| use_outgoing_mwi_on_smdi | bool | useOutgoingMWIOnSMDI Optional |
| mwi_delay_in_seconds | int | mwiDelayInSeconds Optional |
| voice_portal_scope | str | voicePortalScope Optional |
| network_wide_messaging | bool | networkWideMessaging Optional |
| use_external_routing | bool | useExternalRouting Optional |
| default_external_routing_address | str | defaultExternalRoutingAddress Optional |
| vm_only_system | bool | vmOnlySystem Optional |
| client_initiated_mail_server_session_timeout_minutes | int | clientInitiatedMailServerSessionTimeoutMinutes Optional |
| recording_audio_file_format | str | recordingAudioFileFormat Optional |
| allow_voice_portal_access_from_vm_deposit_menu | bool | allowVoicePortalAccessFromVMDepositMenu Optional |
| storage_selection | str | storageSelection Optional |
| vm_bucket_name | str | vmBucketName Optional |
| allow_voice_portal_auto_login_for_mobile_devices_only | bool | allowVoicePortalAutoLoginForMobileDevicesOnly Optional |
| select_mwi_template_per_caller | bool | selectMwiTemplatePerCaller Optional |
SystemVoiceMessagingGroupModifyVoicePortalMenusRequest(OCIRequest)
Request to modify the system voice portal menus setting.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| use_voice_portal_customization | bool | useVoicePortalCustomization Optional |
| voice_portal_main_menu_keys | OCI.voicePortalMainMenuKeys | voicePortalMainMenuKeys Optional |
| voice_messaging_menu_keys | OCI.voiceMessagingMenuKeys | voiceMessagingMenuKeys Optional |
| play_greeting_menu_keys | OCI.playGreetingMenuKeys | playGreetingMenuKeys Optional |
| change_busy_or_no_answer_greeting_menu_keys | OCI.changeBusyOrNoAnswerGreetingMenuKeys | changeBusyOrNoAnswerGreetingMenuKeys Optional |
| change_extended_away_greeting_menu_keys | OCI.changeExtendedAwayGreetingMenuKeys | changeExtendedAwayGreetingMenuKeys Optional |
| record_new_greeting_or_personalized_name_menu_keys | OCI.recordNewGreetingOrPersonalizedNameMenuKeys | recordNewGreetingOrPersonalizedNameMenuKeys Optional |
| delete_all_messages_menu_keys | OCI.deleteAllMessagesMenuKeys | deleteAllMessagesMenuKeys Optional |
| comm_pilot_express_profile_menu_keys | OCI.commPilotExpressProfileMenuKeys | commPilotExpressProfileMenuKeys Optional |
| personalized_name_menu_keys | OCI.personalizedNameMenuKeys | personalizedNameMenuKeys Optional |
| call_forwarding_options_menu_keys | OCI.callForwardingOptionsMenuKeys | callForwardingOptionsMenuKeys Optional |
| change_call_forwarding_destination_menu_keys | OCI.changeCallForwardingDestinationMenuKeys | changeCallForwardingDestinationMenuKeys Optional |
| voice_portal_calling_menu_keys | OCI.voicePortalCallingMenuKeys | voicePortalCallingMenuKeys Optional |
| hoteling_menu_keys | OCI.hotelingMenuKeys | hotelingMenuKeys Optional |
| passcode_menu_keys | OCI.passcodeMenuKeys | passcodeMenuKeys Optional |
| play_messages_menu_keys | OCI.playMessagesMenuKeys | playMessagesMenuKeys Optional |
| play_message_menu_keys | OCI.playMessageMenuKeys | playMessageMenuKeys Optional |
| additional_message_options_menu_keys | OCI.additionalMessageOptionsMenuKeys | additionalMessageOptionsMenuKeys Optional |
| forward_or_compose_message_menu_keys | OCI.forwardOrComposeMessageMenuKeys | forwardOrComposeMessageMenuKeys Optional |
| reply_message_menu_keys | OCI.replyMessageMenuKeys | replyMessageMenuKeys Optional |
| send_to_distribution_list_menu_keys | OCI.sendToDistributionListMenuKeys | sendToDistributionListMenuKeys Optional |
| select_distribution_list_menu_keys | OCI.selectDistributionListMenuKeys | selectDistributionListMenuKeys Optional |
| review_selected_distribution_list_menu_keys | OCI.reviewSelectedDistributionListMenuKeys | reviewSelectedDistributionListMenuKeys Optional |
| send_message_to_selected_distribution_list_menu_keys | OCI.sendMessageToSelectedDistributionListMenuKeys | sendMessageToSelectedDistributionListMenuKeys Optional |
| send_to_all_group_members_menu_keys | OCI.sendToAllGroupMembersMenuKeys | sendToAllGroupMembersMenuKeys Optional |
| send_to_person_menu_keys | OCI.sendToPersonMenuKeys | sendToPersonMenuKeys Optional |
| change_current_introduction_or_message_or_reply_menu_keys | OCI.changeCurrentIntroductionOrMessageOrReplyMenuKeys | changeCurrentIntroductionOrMessageOrReplyMenuKeys Optional |
| voice_portal_login_menu_keys | OCI.voicePortalLoginMenuKeys | voicePortalLoginMenuKeys Optional |
| fax_messaging_menu_keys | OCI.faxMessagingMenuKeys | faxMessagingMenuKeys Optional |
| message_deposit_menu_keys | OCI.messageDepositMenuKeys | messageDepositMenuKeys Optional |
| disable_message_deposit_menu_keys | OCI.disableMessageDepositMenuKeys | disableMessageDepositMenuKeys Optional |
| greeting_only_forwarding_destination_menu_keys | OCI.greetingOnlyForwardingDestinationMenuKeys | greetingOnlyForwardingDestinationMenuKeys Optional |
SystemVoiceMessagingGroupModifyVoicePortalMenusRequest19(OCIRequest)
Request to modify the system voice portal menus setting.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| use_voice_portal_customization | bool | useVoicePortalCustomization Optional |
| voice_portal_main_menu_keys | OCI.voicePortalMainMenuKeys | voicePortalMainMenuKeys Optional |
| announcement_menu_keys | OCI.announcementMenuKeys | announcementMenuKeys Optional |
| announcement_recording_menu_keys | OCI.announcementRecordingMenuKeys | announcementRecordingMenuKeys Optional |
| greetings_menu_keys | OCI.greetingsMenuKeys | greetingsMenuKeys Optional |
| conference_greeting_menu_keys | OCI.conferenceGreetingMenuKeys | conferenceGreetingMenuKeys Optional |
| voice_messaging_menu_keys | OCI.voiceMessagingMenuKeys | voiceMessagingMenuKeys Optional |
| play_greeting_menu_keys | OCI.playGreetingMenuKeys | playGreetingMenuKeys Optional |
| change_busy_or_no_answer_greeting_menu_keys | OCI.changeBusyOrNoAnswerGreetingMenuKeys | changeBusyOrNoAnswerGreetingMenuKeys Optional |
| change_extended_away_greeting_menu_keys | OCI.changeExtendedAwayGreetingMenuKeys | changeExtendedAwayGreetingMenuKeys Optional |
| record_new_greeting_or_personalized_name_menu_keys | OCI.recordNewGreetingOrPersonalizedNameMenuKeys | recordNewGreetingOrPersonalizedNameMenuKeys Optional |
| delete_all_messages_menu_keys | OCI.deleteAllMessagesMenuKeys | deleteAllMessagesMenuKeys Optional |
| comm_pilot_express_profile_menu_keys | OCI.commPilotExpressProfileMenuKeys | commPilotExpressProfileMenuKeys Optional |
| personalized_name_menu_keys | OCI.personalizedNameMenuKeys | personalizedNameMenuKeys Optional |
| call_forwarding_options_menu_keys | OCI.callForwardingOptionsMenuKeys | callForwardingOptionsMenuKeys Optional |
| change_call_forwarding_destination_menu_keys | OCI.changeCallForwardingDestinationMenuKeys | changeCallForwardingDestinationMenuKeys Optional |
| voice_portal_calling_menu_keys | OCI.voicePortalCallingMenuKeys | voicePortalCallingMenuKeys Optional |
| hoteling_menu_keys | OCI.hotelingMenuKeys | hotelingMenuKeys Optional |
| passcode_menu_keys | OCI.passcodeMenuKeys | passcodeMenuKeys Optional |
| play_messages_menu_keys | OCI.playMessagesMenuKeys | playMessagesMenuKeys Optional |
| play_message_menu_keys | OCI.playMessageMenuKeys | playMessageMenuKeys Optional |
| additional_message_options_menu_keys | OCI.additionalMessageOptionsMenuKeys | additionalMessageOptionsMenuKeys Optional |
| forward_or_compose_message_menu_keys | OCI.forwardOrComposeMessageMenuKeys | forwardOrComposeMessageMenuKeys Optional |
| reply_message_menu_keys | OCI.replyMessageMenuKeys | replyMessageMenuKeys Optional |
| send_to_distribution_list_menu_keys | OCI.sendToDistributionListMenuKeys | sendToDistributionListMenuKeys Optional |
| select_distribution_list_menu_keys | OCI.selectDistributionListMenuKeys | selectDistributionListMenuKeys Optional |
| review_selected_distribution_list_menu_keys | OCI.reviewSelectedDistributionListMenuKeys | reviewSelectedDistributionListMenuKeys Optional |
| send_message_to_selected_distribution_list_menu_keys | OCI.sendMessageToSelectedDistributionListMenuKeys | sendMessageToSelectedDistributionListMenuKeys Optional |
| send_to_all_group_members_menu_keys | OCI.sendToAllGroupMembersMenuKeys | sendToAllGroupMembersMenuKeys Optional |
| send_to_person_menu_keys | OCI.sendToPersonMenuKeys | sendToPersonMenuKeys Optional |
| change_current_introduction_or_message_or_reply_menu_keys | OCI.changeCurrentIntroductionOrMessageOrReplyMenuKeys | changeCurrentIntroductionOrMessageOrReplyMenuKeys Optional |
| voice_portal_login_menu_keys | OCI.voicePortalLoginMenuKeys | voicePortalLoginMenuKeys Optional |
| fax_messaging_menu_keys | OCI.faxMessagingMenuKeys | faxMessagingMenuKeys Optional |
| message_deposit_menu_keys | OCI.messageDepositMenuKeys | messageDepositMenuKeys Optional |
| disable_message_deposit_menu_keys | OCI.disableMessageDepositMenuKeys | disableMessageDepositMenuKeys Optional |
| greeting_only_forwarding_destination_menu_keys | OCI.greetingOnlyForwardingDestinationMenuKeys | greetingOnlyForwardingDestinationMenuKeys Optional |
| personal_assistant_menu_keys | OCI.personalAssistantMenuKeys | personalAssistantMenuKeys Optional |
SystemWebexMeetingsCallTypeAddRequest(OCIRequest)
Add an entry that defines a Webex Meetings call processing behavior.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| network_server_call_type | str | networkServerCallType |
| enforce_ns_charge_field | bool | enforceNSChargeField |
| process_as_internal_for_sac_subscriber | bool | processAsInternalForSACSubscriber |
SystemWebexMeetingsCallTypeDeleteRequest(OCIRequest)
Delete a Webex Meetings entry.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
SystemWebexMeetingsCallTypeGetListRequest(OCIRequest)
Get all the Webex Meetings call processing entries defined in the system.
The response is either a SystemWebexMeetingsCallTypeGetListResponse() or an
ErrorResponse().
SystemWebexMeetingsCallTypeModifyRequest(OCIRequest)
Modify a Webex Meetings call processing entry.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| network_server_call_type | str | networkServerCallType Optional |
| enforce_ns_charge_field | bool | enforceNSChargeField Optional |
| process_as_internal_for_sac_subscriber | bool | processAsInternalForSACSubscriber Optional |
SystemXsiApplicationIdDeleteListRequest(OCIRequest)
Delete the entries from system Xsi application Id list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| xsi_application_id | List[str] | xsiApplicationId |
SystemXsiApplicationIdGetListRequest(OCIRequest)
Get the system Xsi application Id white lists.
The response is either SystemXsiApplicationIdGetListResponse() or ErrorResponse().
SystemXsiApplicationIdModifyRequest(OCIRequest)
Modify the system Xsi applicaiton Id description.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| xsi_application_id | str | xsiApplicationId |
| description | str | description Optional |
SystemXsiApplicationIdParameterGetRequest(OCIRequest)
Request to get the Xsi application Id system parameters.
The response is either SystemXsiApplictionIdParameterGetResponse() or
ErrorResponse().
SystemXsiApplicationIdParameterModifyRequest(OCIRequest)
Request to modify Xsi application system parameter.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| screen_xsi_application_id | bool | screenXsiApplicationId Optional |
SystemXsiPolicyProfileAddRequest(OCIRequest)
Add the system Xsi policy profile entry.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| level | str | level |
| description | str | description Optional |
| max_target_subscription | int | maxTargetSubscription |
SystemXsiPolicyProfileGetListRequest(OCIRequest)
Get the system Xsi policy profile list.
The response is either SystemXsiPolicyProfileGetListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| xsi_policy_profile_level | str | xsiPolicyProfileLevel Optional |
SystemZoneCallingRestrictionsZoneAddRequest(OCIRequest)
Add a zone.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemZoneAddRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| zone_name | str | zoneName |
| physical_location | str | physicalLocation Optional |
SystemZoneCallingRestrictionsZoneDeleteRequest(OCIRequest)
Deletes a zone from the system The response is either a SuccessResponse() or an
ErrorResponse().
Replaced by: SystemZoneDeleteRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| zone_name | str | zoneName |
SystemZoneCallingRestrictionsZoneGetListRequest(OCIRequest)
Gets a list of all zones defined in the system The response is
SystemZoneCallingRestrictionsZoneGetListResponse() or an ErrorResponse().
Replaced by: SystemZoneGetListRequest()
SystemZoneCallingRestrictionsZoneModifyRequest(OCIRequest)
Modifies attributes of a zone in the system.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemZonePhysicalLocationAddListRequest() and
SystemZonePhysicalLocationDeleteListRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| zone_name | str | zoneName |
| physical_location | str | physicalLocation Optional |
SystemZoneCallingZonePhysicalLocationGetRequest(OCIRequest)
Returns a zone calling physical location for a given zone.
Response is SystemZoneCallingZonePhysicalLocationGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| zone_name | str | zoneName |
SystemZoneCallingZonePhysicalLocationModifyRequest(OCIRequest)
Modifies a zone calling physical location for a given zone.
Response is a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| zone_name | str | zoneName |
| physical_location | str | physicalLocation Optional |
SystemZoneDeleteRequest(OCIRequest)
Delete a Zone.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| zone_name | str | zoneName |
SystemZoneGetListRequest(OCIRequest)
Get the list of all Zones.
The response is either a SystemZoneGetListResponse() or an ErrorResponse().
SystemZoneLocationBasedPhysicalLocationAddListRequest(OCIRequest)
Adds a list of physical locations to a zone The response is SuccessResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| zone_name | str | zoneName |
| physical_location | List[str] | physicalLocation Optional |
SystemZoneLocationBasedPhysicalLocationDeleteListRequest(OCIRequest)
Deletes a list of physical addresses from a zone The response is SuccessResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| zone_name | str | zoneName |
| physical_location | List[str] | physicalLocation Optional |
TutorialFlagGetRequest(OCIRequest)
Get the tutorial flag setting for a user or admin.
The response is either a TutorialFlagGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
TutorialFlagModifyRequest(OCIRequest)
Modify the tutorial flag setting for a user or admin.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| enable_tutorial | bool | enableTutorial Optional |
UserAccessDeviceDeviceActivationGetListRequest(OCIRequest)
Requests the list of access devices associated to a user and their device activation information.
The response is either UserAccessDeviceDeviceActivationGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserAdviceOfChargeGetRequest(OCIRequest)
Request the user level data associated with Advice Of Charge.
The response is either a UserAdviceOfChargeGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserAdviceOfChargeModifyRequest(OCIRequest)
Modify the user level data associated with Advice of Charge.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| aoc_type | str | aocType Optional |
UserAlternateNumbersGetRequest(OCIRequest)
Request the user level data associated with Alternate Numbers.
The response is either a UserAlternateNumbersGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserAlternateNumbersGetRequest17(OCIRequest)
Request the user level data associated with Alternate Numbers.
The response is either a UserAlternateNumbersGetResponse17() or an
ErrorResponse(). Replaced by: UserAlternateNumbersGetRequest21() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserAlternateNumbersGetRequest21(OCIRequest)
Request the user level data associated with alternate numbers.
The response is either a UserAlternateNumbersGetResponse21() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserAlternateUserIdAddRequest(OCIRequest)
Request to add an alternate user Id to an user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| alternate_user_id | str | alternateUserId |
| description | str | description Optional |
UserAlternateUserIdDeleteRequest(OCIRequest)
Request to delete an alternate user id of a user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| alternate_user_id | str | alternateUserId |
UserAlternateUserIdGetListRequest(OCIRequest)
Request to get the user id and the list of alternate user ids of an user.
The response is either UserAlternateUserIdGetListResponse() or ErrorResponse().
The "userId" can be either the user Id or an alternate user Id.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserAlternateUserIdModifyRequest(OCIRequest)
Request to modify an alternate user id of a user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| alternate_user_id | str | alternateUserId |
| new_alternate_user_id | str | newAlternateUserId Optional |
| description | str | description Optional |
UserAnnouncementFileGetAvailableListRequest(OCIRequest)
Get the list of available announcement files for a User from the Announcement Repository, for Virtual subscribers the list will also include the announcements for it's group.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| announcement_file_type | str | announcementFileType Optional |
UserAnnouncementRepositoryGetSettingsRequest(OCIRequest)
Return the disk space being used.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserAnonymousCallRejectionGetRequest(OCIRequest)
Request the user level data associated with Anonymous Call Rejection.
The response is either a UserAnonymousCallRejectionGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserAnonymousCallRejectionModifyRequest(OCIRequest)
Modify the user level data associated with Anonymous Call Rejection.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
UserAssignedServicesGetListRequest(OCIRequest)
Get the list of assigned User and Group Services for the specified user.
The response is either an UserAssignedServicesGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId Optional |
UserAuthenticationGetRequest(OCIRequest)
Get the user's authentication service information.
The response is either a UserAuthenticationGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserAuthenticationModifyRequest(OCIRequest)
Modify the user's authentication service information.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| user_name | str | userName Optional |
| new_password | str | newPassword Optional |
| password | OCI.password | password Optional |
UserAutomaticCallbackGetRequest(OCIRequest)
Request the user level data associated with Automatic Callback.
The response is either a UserAutomaticCallbackGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserAutomaticCallbackModifyRequest(OCIRequest)
Modify the user level data associated with Automatic Callback.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
UserAutomaticCollectCallGetRequest(OCIRequest)
Get user Automatic Collect Call service settings.
The response is either UserAutomaticCollectCallGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserAutomaticCollectCallModifyRequest(OCIRequest)
Modify user Automatic Collect Call service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| enable_automatic_collect_call | bool | enableAutomaticCollectCall Optional |
UserAutomaticHoldRetrieveGetRequest(OCIRequest)
Request the user level data associated with Automatic Hold/Retrieve.
The response is either a UserAutomaticHoldRetrieveGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserAutomaticHoldRetrieveModifyRequest(OCIRequest)
Modify the user level data associated with Automatic Hold/Retrieve.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| recall_timer_seconds | int | recallTimerSeconds Optional |
UserBargeInExemptGetRequest(OCIRequest)
Request the user level data associated with Barge In Exempt.
The response is either a UserBargeInExemptGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserBargeInExemptModifyRequest(OCIRequest)
Modify the user level data associated with Barge In Exempt.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
UserBasicCallLogsGetListRequest(OCIRequest)
Request user's call logs.
If the callLogType is not specified, all types of calls are returned.
The response is either a UserBasicCallLogsGetListResponse() or an ErrorResponse().
Replaced By: UserBasicCallLogsGetListRequest14sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| call_log_type | str | callLogType Optional |
UserBasicCallLogsGetListRequest14sp4(OCIRequest)
Request user's call logs.
If the callLogType is not specified, all types of calls are returned.
The response is either a UserBasicCallLogsGetListResponse14sp4() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| call_log_type | str | callLogType Optional |
| format_name_and_number | bool | formatNameAndNumber Optional |
UserBroadWorksAnywhereAddPhoneNumberRequest(OCIRequest)
Add a broadworks Anywhere phone number.
In XS data mode, the request will fail if the phoneNumber element represents the user's directory number or one of the user's alternate numbers.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
| description | str | description Optional |
| is_active | bool | isActive |
| outbound_alternate_number | str | outboundAlternateNumber Optional |
| broadworks_call_control | bool | broadworksCallControl |
| use_diversion_inhibitor | bool | useDiversionInhibitor |
| answer_confirmation_required | bool | answerConfirmationRequired |
UserBroadWorksAnywhereDeletePhoneNumberRequest(OCIRequest)
Delete a broadworks anywhere phone number.
Also deletes all the selective criteria for the phone number.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
UserBroadWorksAnywhereDeleteSelectiveCriteriaRequest(OCIRequest)
Delete a criteria from the user's BroadWorks Anywhere phone number.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
| criteria_name | str | criteriaName |
UserBroadWorksAnywhereGetAvailablePortalListRequest(OCIRequest)
Get a list of all the available BroadWorks Anywhere portal instances for a specific
user The response is either UserBroadWorksAnywhereGetAvailableListResponse() or
ErrorResponse().
Replaced by UserBroadWorksAnywhereGetAvailablePortalListRequest21sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserBroadWorksAnywhereGetAvailablePortalListRequest21sp1(OCIRequest)
Get a list of all the available BroadWorks Anywhere portal instances for a specific
user The response is either UserBroadWorksAnywhereGetAvailableListResponse21sp1() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserBroadWorksAnywhereGetPhoneNumberRequest(OCIRequest)
Get a broadworks anywhere phone number The response is
UserBroadWorksAnywhereGetPhoneNumberResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
UserBroadWorksAnywhereGetRequest(OCIRequest)
Get the list of all the BroadWorks Anywhere phone numbers for the user.
The response is either a UserBroadWorksAnywhereGetResponse() or an
ErrorResponse(). Replaced by: UserBroadWorksAnywhereGetRequest16sp2()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserBroadWorksAnywhereGetRequest16sp2(OCIRequest)
Get the list of all the BroadWorks Anywhere phone numbers for the user.
The response is either a UserBroadWorksAnywhereGetResponse16sp2() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserBroadWorksAnywhereGetSelectiveCriteriaRequest(OCIRequest)
Get a criteria for the user's BroadWorks Anywhere phone number.
The response is either a UserBroadWorksAnywhereGetSelectiveCriteriaResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
| criteria_name | str | criteriaName |
UserBroadWorksAnywhereGetSelectiveCriteriaRequest16(OCIRequest)
Get a criteria for the user's BroadWorks Anywhere phone number.
The response is either a UserBroadWorksAnywhereGetSelectiveCriteriaResponse16() or
an ErrorResponse(). Replaced by:
UserBroadWorksAnywhereGetSelectiveCriteriaRequest21() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
| criteria_name | str | criteriaName |
UserBroadWorksAnywhereGetSelectiveCriteriaRequest21(OCIRequest)
Get a criteria for the user's BroadWorks Anywhere phone number.
The response is either a UserBroadWorksAnywhereGetSelectiveCriteriaResponse21() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
| criteria_name | str | criteriaName |
UserBroadWorksAnywhereModifyRequest(OCIRequest)
Request to modify the user-level settings for the BroadWorks Anywhere service for a specified user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| alert_all_locations_for_click_to_dial_calls | bool | alertAllLocationsForClickToDialCalls Optional |
| alert_all_locations_for_group_paging_calls | bool | alertAllLocationsForGroupPagingCalls Optional |
UserBroadWorksCommunicatorGetRequest(OCIRequest)
Request to get the Configuration Server for a specified user.
The response is either a UserBroadWorksCommunicatorGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserBroadWorksMobilityGetRequest(OCIRequest)
Get the user's broadworks mobility service settings.
The response is either a UserBroadWorksMobilityGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserBroadWorksMobilityGetRequest21(OCIRequest)
Get the user's BroadWorks Mobility service settings.
The response is either a UserBroadWorksMobilityGetResponse21() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserBroadWorksMobilityGetRequest21sp1(OCIRequest)
Get the user's BroadWorks Mobility service settings with details for DNs.
The response is either a UserBroadWorksMobilityGetResponse21sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest(OCIRequest)
Delete a mobile identity from the user's list of mobile identities.
The response is either a SuccessResponse() or an ErrorResponse(). An
ErrorResponse() will be returned if any device cannot be deleted because of
insufficient privilege. When a delete request is attempted on the primary mobile
identity, the delete will fail unless it is the last mobile identity in the user's
list. If deleteExistingDevices is set to true, after the mobile identity is deleted,
any device that is only used by the deleted mobile identity prior to the deletion will
be deleted if the command is executed with the correct priviledge. Group
administrator or above running this command can delete any group level devices.
Service provider administrator or above can delete any service provider and group
devices. Provisioning administrator or above can delete any devices. An
ErrorResponse() with the type warning will be returned if any device cannot be
deleted because of insufficient privilege.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mobile_number | str | mobileNumber |
| delete_existing_devices | bool | deleteExistingDevices Optional |
UserBroadWorksMobilityMobileIdentityDeleteRequest(OCIRequest)
Delete a mobile identity from the user's list of mobile identities.
The response is either a SuccessResponse() or an ErrorResponse(). If another
Mobile Identity is set to ring mobile only and only has this mobile identity in the
alerting list, the identity is deleted and ErrorResponse() is returned. The
ErrorResponse() is info type and contains the affected mobile numbers in the
summary. When a delete request is attempted on the primary mobile identity, the
delete will fail unless it is the last mobile identity in the user's list.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mobile_number | str | mobileNumber |
UserBroadWorksMobilityMobileIdentityGetRequest(OCIRequest)
Get the settings for a user's specified mobile identity.
The response is either a UserBroadWorksMobilityMobileIdentityGetResponse() or an
ErrorResponse(). Replaced by:
UserBroadWorksMobilityMobileIdentityGetRequest21sp1().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mobile_number | str | mobileNumber |
UserBroadWorksMobilityMobileIdentityGetRequest21sp1(OCIRequest)
Get the settings for a user's specified mobile identity.
The response is either a UserBroadWorksMobilityMobileIdentityGetResponse21sp1() or
an ErrorResponse(). Replaced by:
UserBroadWorksMobilityMobileIdentityGetRequest21sp1V2.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mobile_number | str | mobileNumber |
UserBroadWorksMobilityMobileIdentityGetRequest22(OCIRequest)
Get the settings for a user's specified mobile identity.
The response is either a UserBroadWorksMobilityMobileIdentityGetResponse22() or an
ErrorResponse(). Replaced by UserBroadWorksMobilityMobileIdentityGetRequest22V2().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mobile_number | str | mobileNumber |
UserBroadWorksMobilityMobileIdentityGetRequest22V2(OCIRequest)
Get the settings for a user's specified mobile identity.
The response is either a UserBroadWorksMobilityMobileIdentityGetResponse22V2() or an
ErrorResponse().
Replaced By: UserBroadWorksMobilityMobileIdentityGetRequest22V3()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mobile_number | str | mobileNumber |
UserBroadWorksMobilityMobileIdentityGetRequest22V3(OCIRequest)
Get the settings for a user's specified mobile identity.
The response is either a UserBroadWorksMobilityMobileIdentityGetResponse22V3() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mobile_number | str | mobileNumber |
UserBroadWorksMobilityModifyRequest(OCIRequest)
Modify the user's broadworks mobility service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| phones_to_ring | str | phonesToRing Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| alert_click_to_dial_calls | bool | alertClickToDialCalls Optional |
| alert_group_paging_calls | bool | alertGroupPagingCalls Optional |
| enable_diversion_inhibitor | bool | enableDiversionInhibitor Optional |
| require_answer_confirmation | bool | requireAnswerConfirmation Optional |
| broadworks_call_control | bool | broadworksCallControl Optional |
| use_setting_level | str | useSettingLevel Optional |
| deny_call_originations | bool | denyCallOriginations Optional |
| deny_call_terminations | bool | denyCallTerminations Optional |
UserBroadWorksMobilityModifyRequest20(OCIRequest)
Modify the user's broadworks mobility service settings.
The response is either a SuccessResponse() or an ErrorResponse(). If the request
modifies the mobilePhoneNumber and the new number does not belong to the appropriate
Mobile Subscriber Directory Numbers pool, the request is rejected. For a service
provider the number must belong to the group Mobile Subscriber Directory Numbers pool.
For an enterprise user, the number must belong to the enterprise Mobile Subscriber
Directory Numbers pool. If the request is executed by a user and modifies the
mobilePhoneNumber, the request is rejected.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| phones_to_ring | str | phonesToRing Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| alert_click_to_dial_calls | bool | alertClickToDialCalls Optional |
| alert_group_paging_calls | bool | alertGroupPagingCalls Optional |
| enable_diversion_inhibitor | bool | enableDiversionInhibitor Optional |
| require_answer_confirmation | bool | requireAnswerConfirmation Optional |
| broadworks_call_control | bool | broadworksCallControl Optional |
| use_setting_level | str | useSettingLevel Optional |
| deny_call_originations | bool | denyCallOriginations Optional |
| deny_call_terminations | bool | denyCallTerminations Optional |
UserBroadWorksReceptionistEnterpriseAddUserListRequest(OCIRequest)
Add users to the BroadWorks Receptionist - Enterprise monitored user list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| monitored_user_id | List[str] | monitoredUserId |
UserBroadWorksReceptionistEnterpriseDeleteUserListRequest(OCIRequest)
Remove selected users from the BroadWorks Receptionist - Enterprise monitored user list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| monitored_user_id | List[str] | monitoredUserId |
UserBroadWorksReceptionistEnterpriseGetRequest(OCIRequest)
Request the monitored users list for the BroadWorks Receptionist - Enterprise service.
The response is either a UserBroadWorksReceptionistEnterpriseGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserBroadWorksReceptionistOfficeGetRequest(OCIRequest)
Request the Receptionist Office parameters.
The response is either a UserBroadWorksReceptionistOfficeGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserBroadWorksReceptionistSmallBusinessGetRequest(OCIRequest)
Request the Receptionist Small Business parameters.
The response is either a UserBroadWorksReceptionistSmallBusinessGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserBusyLampFieldGetRequest(OCIRequest)
Request the settings for the busy lamp field service.
The response is either a UserBusyLampFieldGetResponse() or an ErrorResponse().
Replaced by: UserBusyLampFieldGetRequest16sp2()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserBusyLampFieldGetRequest16sp2(OCIRequest)
Request the settings for the busy lamp field service.
The response is either a UserBusyLampFieldGetResponse16sp2() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallCenterAddSupervisedAgentListRequest(OCIRequest)
Assign agent(s) to a call center supervisor.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| supervisor_user_id | str | supervisorUserId |
| service_user_id | str | serviceUserId |
| agent_user_id | List[str] | agentUserId |
UserCallCenterAgentDetailsGetRequest(OCIRequest)
Request to get the detail information of a Call Center Agent.
Administrator, supervisor and agent itself can send this command.
The response is either UserCallCenterAgentDetailsGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| agent_user_id | str | agentUserId |
UserCallCenterAgentSignOutRequest(OCIRequest)
This request signs-out a call center agent.
Administrator, supervisor and agent itself can sign-out an agent. An empty OCI table
in OCI-P response indicates success and the agent has been signed out. This sign-out
command will fail if the agent is the last signed-in agent of any standard or premium
call center to which she is currently joined. If the sign-out fails, the OCI-P
response will contain a list of Call Centers for which the agent is the last signed-in
agent. If this special logic is not needed, UserCallCenterModifyRequest19() can
still be used to change the agents ACD state without checking if the agent is the last
signed-in agent.
The response is either a UserCallCenterAgentSignOutResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| agent_user_id | str | agentUserId |
UserCallCenterCallDispositionCodeGetAvailableListRequest(OCIRequest)
Get the list of available Call Center Call Disposition Codes to be used by a client.
The response is either UserCallCenterCallDispositionCodeGetAvailableListResponse()
or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
UserCallCenterDeleteSupervisedAgentListRequest(OCIRequest)
Delete agent(s) from a call center supervisor.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| supervisor_user_id | str | supervisorUserId |
| service_user_id | str | serviceUserId |
| agent_user_id | List[str] | agentUserId |
UserCallCenterEnhancedReportingScheduledReportDeleteRequest(OCIRequest)
Request to delete a call center reporting scheduled report created by a supervisor.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| supervisor_user_id | str | supervisorUserId |
| name | str | name |
UserCallCenterEnhancedReportingScheduledReportGetRequest(OCIRequest)
Request to get a call center reporting scheduled report created by supervisor.
The response is either a UserCallCenterEnhancedReportingScheduledReportGetResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| supervisor_user_id | str | supervisorUserId |
| name | str | name |
UserCallCenterGetAgentSupervisorListRequest(OCIRequest)
Get a list of supervisors for an agent on a given call center.
The response is either a UserCallCenterGetAgentSupervisorListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| agent_user_id | str | agentUserId |
| service_user_id | str | serviceUserId |
UserCallCenterGetAvailableCallCenterListRequest(OCIRequest)
This request gets a list of all call centers which the user can be assigned to as an agent.
Some of the call centers may already have the user as an agent. It is the clients responsibility to discard the call centers that the user is already an agent of.
The response is either a UserCallCenterGetAvailableCallCenterListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallCenterGetAvailableDNISListRequest(OCIRequest)
Request a list of available DNIS for agent to select.
The response is either UserCallCenterGetAvailableDNISListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| agent_user_id | str | agentUserId |
UserCallCenterGetListRequest(OCIRequest)
Get the list of call centers the specified user belongs to.
The response is either a UserCallCenterGetListResponse() or an ErrorResponse().
Replaced By: UserCallCenterGetRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallCenterGetRequest(OCIRequest)
Get the user's ACD state and the list of call centers the specified user belongs to.
The response is either a UserCallCenterGetResponse() or an ErrorResponse().
Replaced By: UserCallCenterGetRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallCenterGetRequest16(OCIRequest)
Get the user's call center settings and the list of call centers the specified user belongs to.
The response is either a UserCallCenterGetResponse16() or an ErrorResponse().
Replaced by: UserCallCenterGetRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallCenterGetRequest17(OCIRequest)
Get the user's call center settings and the list of call centers the specified user belongs to.
The response is either a UserCallCenterGetResponse17() or an ErrorResponse().
Replaced by UserCallCenterGetRequest17sp4().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallCenterGetRequest17sp4(OCIRequest)
Get the user's call center settings and the list of call centers the specified user belongs to.
The response is either a UserCallCenterGetResponse17sp4() or an ErrorResponse().
Replaced by UserCallCenterGetRequest19()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallCenterGetRequest19(OCIRequest)
Get the user's call center settings and the list of call centers the specified user belongs to.
The response is either a UserCallCenterGetResponse19() or an ErrorResponse().
Replaced by UserCallCenterGetRequest23().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallCenterGetRequest23(OCIRequest)
Get the user's call center settings and the list of call centers the specified user belongs to.
The response is either a UserCallCenterGetResponse23() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallCenterGetSupervisorCallCenterListRequest(OCIRequest)
Get a list of call centers the user is assigned to as a supervisor.
The response is either a UserCallCenterGetSupervisorCallCenterListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| supervisor_user_id | str | supervisorUserId |
UserCallCenterMonitoringGetRequest(OCIRequest)
Request the user's Call Center Monitoring settings.
The response is either a UserCallCenterMonitoringGetResponse() or an
ErrorResponse(). Replaced by UserCallCenterMonitoringGetRequest23()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallCenterMonitoringGetRequest23(OCIRequest)
Request the user's Call Center Monitoring settings.
The response is either a UserCallCenterMonitoringGetResponse23() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallCenterMonitoringModifyRequest(OCIRequest)
Modify the user's Call Center Monitoring settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| play_tone_to_agent_for_silent_monitoring | bool | playToneToAgentForSilentMonitoring Optional |
| play_tone_to_agent_for_supervisor_coaching | bool | playToneToAgentForSupervisorCoaching Optional |
UserCallForwardingAlwaysGetRequest(OCIRequest)
Request the user level data associated with Call Forwarding Always.
The response is either a UserCallForwardingAlwaysGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallForwardingAlwaysModifyRequest(OCIRequest)
Modify the user level data associated with Call Forwarding Always.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command is used internally by Call Processing.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| is_ring_splash_active | bool | isRingSplashActive Optional |
UserCallForwardingAlwaysSecondaryGetRequest(OCIRequest)
Request the user level data associated with Call Forwarding Always Secondary service.
The response is either a UserCallForwardingAlwaysSecondaryGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallForwardingAlwaysSecondaryModifyRequest(OCIRequest)
Modify the user level data associated with Call Forwarding Always Secondary service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| is_ring_splash_active | bool | isRingSplashActive Optional |
UserCallForwardingBusyGetRequest(OCIRequest)
Request the user level data associated with Call Forwarding Busy.
The response is either a UserCallForwardingBusyGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallForwardingBusyModifyRequest(OCIRequest)
Modify the user level data associated with Call Forwarding Busy.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command is used internally by Call Processing.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
UserCallForwardingNoAnswerGetRequest13mp16(OCIRequest)
Request the user level data associated with Call Forwarding No Answer.
The response is either a UserCallForwardingNoAnswerGetResponse13mp16() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallForwardingNoAnswerModifyRequest(OCIRequest)
Modify the user level data associated with Call Forwarding No Answer.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command is used internally by Call Processing.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| number_of_rings | int | numberOfRings Optional |
UserCallForwardingNotReachableGetRequest(OCIRequest)
Request the user level data associated with Call Forwarding Not Reachable.
The response is either a UserCallForwardingNotReachableGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallForwardingNotReachableModifyRequest(OCIRequest)
Modify the user level data associated with Call Forwarding Not Reachable.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command is used internally by Call Processing.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
UserCallForwardingSelectiveDeleteCriteriaRequest(OCIRequest)
Delete a criteria from the user's call forwarding selective service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserCallForwardingSelectiveGetCriteriaRequest(OCIRequest)
Get a criteria for the user's call forwarding selective service.
The response is either a UserCallForwardingSelectiveGetCriteriaResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserCallForwardingSelectiveGetCriteriaRequest16(OCIRequest)
Get a criteria for the user's call forwarding selective service.
The response is either a UserCallForwardingSelectiveGetCriteriaResponse16() or an
ErrorResponse(). Replaced by: UserCallForwardingSelectiveGetCriteriaRequest21() in
AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserCallForwardingSelectiveGetCriteriaRequest21(OCIRequest)
Get a criteria for the user's call forwarding selective service.
The response is either a UserCallForwardingSelectiveGetCriteriaResponse21() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserCallForwardingSelectiveGetRequest(OCIRequest)
Get the user's call forwarding selective service setting.
The response is either a UserCallForwardingSelectiveGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallForwardingSelectiveGetRequest16(OCIRequest)
Get the user's call forwarding selective service setting.
The response is either a UserCallForwardingSelectiveGetResponse16() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallLogsClearRequest(OCIRequest)
Clear a user's call logs associated with Basic Call Logs and Enhanced Call Logs features.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: UserCallLogsClearRequest14sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallLogsClearRequest14sp4(OCIRequest)
Clear a user's call logs associated with Basic Call Logs and Enhanced Call Logs features.
The calls logs are deleted from both Basic Call Logs and Enhanced Call Logs if both features are assigned.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| delete_all_call_logs | bool | deleteAllCallLogs Optional |
| delete_specified_call_logs | OCI.deleteSpecifiedCallLogs | deleteSpecifiedCallLogs Optional |
UserCallMeNowDeleteCriteriaRequest(OCIRequest)
Delete a criteria from the user's call me now service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserCallMeNowGetCriteriaRequest(OCIRequest)
Get a criteria for the user's call me now service.
The response is either a UserCallMeNowGetCriteriaResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserCallMeNowGetRequest(OCIRequest)
Get the user's call me now service setting.
The response is either a UserCallMeNowGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallNotifyDeleteCriteriaRequest(OCIRequest)
Delete a criteria from the user's call notify service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserCallNotifyGetCriteriaRequest(OCIRequest)
Get a criteria for the user's call notify service.
The response is either a UserCallNotifyGetCriteriaResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserCallNotifyGetCriteriaRequest16(OCIRequest)
Get a criteria for the user's call notify service.
The response is either a UserCallNotifyGetCriteriaResponse16() or an
ErrorResponse(). Replaced by: UserCallNotifyGetCriteriaRequest21() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserCallNotifyGetCriteriaRequest21(OCIRequest)
Get a criteria for the user's call notify service.
The response is either a UserCallNotifyGetCriteriaResponse21() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserCallNotifyGetRequest(OCIRequest)
Get the user's call notify service setting.
The response is either a UserCallNotifyGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallParkGetRequest(OCIRequest)
Identifies which Call Park group the user belongs to if any and the list of users in the group.
The response is either UserCallParkGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallPickupGetRequest(OCIRequest)
Gets the details of the Call Pickup group that a user belongs to (if any).
Any user can only belong to one Call Pickup group.
The response is either UserCallPickupGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallPoliciesGetRequest(OCIRequest)
Request the user level data associated with Call Policies.
The response is either a UserCallPoliciesGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallPoliciesGetRequest17(OCIRequest)
Request the user level data associated with Call Policies.
The response is either a UserCallPoliciesGetResponse17() or an ErrorResponse().
Replaced by: UserCallPoliciesGetRequest19sp1() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallPoliciesGetRequest19sp1(OCIRequest)
Request the user level data associated with Call Policies.
The response is either a UserCallPoliciesGetResponse19sp1() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallPoliciesModifyRequest(OCIRequest)
Modify the user level data associated with Call Policies.
The following elements are only used in AS data mode: callingLineIdentityForRedirectedCalls
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| redirected_calls_colp_privacy | str | redirectedCallsCOLPPrivacy Optional |
| call_being_forwarded_response_call_type | str | callBeingForwardedResponseCallType Optional |
| calling_line_identity_for_redirected_calls | str | callingLineIdentityForRedirectedCalls Optional |
UserCallProcessingGetPolicyRequest14(OCIRequest)
Request the user level data associated with Call Processing Policy.
The response is either a UserCallProcessingGetPolicyResponse14() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallProcessingGetPolicyRequest14sp1(OCIRequest)
Request the user level data associated with Call Processing Policy.
The response is either a UserCallProcessingGetPolicyResponse14sp1() or an
ErrorResponse().
Replaced By: UserCallProcessingGetPolicyRequest14sp7()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallProcessingGetPolicyRequest14sp7(OCIRequest)
Request the user level data associated with Call Processing Policy.
The response is either a UserCallProcessingGetPolicyResponse14sp7() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallProcessingGetPolicyRequest16(OCIRequest)
Request the user level data associated with Call Processing Policy.
The response is either a UserCallProcessingGetPolicyResponse16() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallProcessingGetPolicyRequest16sp2(OCIRequest)
Request the user level data associated with Call Processing Policy.
The response is either a UserCallProcessingGetPolicyResponse16() or an
ErrorResponse(). Replaced by: UserCallProcessingGetPolicyRequest17sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallProcessingGetPolicyRequest17(OCIRequest)
Request the user level data associated with Call Processing Policy.
The response is either a UserCallProcessingGetPolicyResponse17() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallProcessingGetPolicyRequest17sp3(OCIRequest)
Request the user level data associated with Call Processing Policy.
The response is either a UserCallProcessingGetPolicyResponse17sp3() or an
ErrorResponse(). Replaced by: UserCallProcessingGetPolicyRequest17Sp4
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallProcessingGetPolicyRequest17sp4(OCIRequest)
Request the user level data associated with Call Processing Policy.
The response is either a UserCallProcessingGetPolicyResponse17sp4() or an
ErrorResponse(). Replaced by: UserCallProcessingGetPolicyRequest18()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallProcessingGetPolicyRequest18(OCIRequest)
Request the user level data associated with Call Processing Policy.
The response is either a UserCallProcessingGetPolicyResponse18() or an
ErrorResponse(). Replaced by: UserCallProcessingGetPolicyRequest19sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallProcessingGetPolicyRequest19sp1(OCIRequest)
Request the user level data associated with Call Processing Policy.
The response is either a UserCallProcessingGetPolicyResponse19sp1() or an
ErrorResponse(). Replaced by: UserCallProcessingGetPolicyRequest21sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallProcessingGetPolicyRequest21sp1(OCIRequest)
Request the user level data associated with Call Processing Policy.
The response is either a UserCallProcessingGetPolicyResponse21sp1() or an
ErrorResponse(). Replaced by: UserCallProcessingGetPolicyRequest21sp2()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallProcessingGetPolicyRequest21sp2(OCIRequest)
Request the user level data associated with Call Processing Policy.
The response is either a UserCallProcessingGetPolicyResponse21sp2() or an
ErrorResponse(). Replaced by: UserCallProcessingGetPolicyRequest22() in AS data
mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallProcessingGetPolicyRequest22(OCIRequest)
Request the user level data associated with Call Processing Policy.
The response is either a UserCallProcessingGetPolicyResponse22() or an
ErrorResponse(). Replaced by: UserCallProcessingGetPolicyRequest22V2() in AS data
mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallProcessingGetPolicyRequest22V2(OCIRequest)
Request the user level data associated with Call Processing Policy.
The response is either a UserCallProcessingGetPolicyResponse22V2() or an
ErrorResponse(). Replaced by: UserCallProcessingGetPolicyRequest23() in AS data
mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallProcessingGetPolicyRequest23(OCIRequest)
Request the user level data associated with Call Processing Policy.
The response is either a UserCallProcessingGetPolicyResponse23() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallProcessingModifyPolicyRequest14(OCIRequest)
Modify the user level data associated with Call Processing Policy.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: UserCallProcessingModifyPolicyRequest14sp7()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_user_setting | bool | useUserSetting Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| media_policy_selection | str | mediaPolicySelection Optional |
| supported_media_set_name | str | supportedMediaSetName Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_max_concurrent_find_me_follow_me_invocations | bool | useMaxConcurrentFindMeFollowMeInvocations Optional |
| max_concurrent_find_me_follow_me_invocations | int | maxConcurrentFindMeFollowMeInvocations Optional |
UserCallProcessingModifyPolicyRequest14sp7(OCIRequest)
Modify the user level data associated with Call Processing Policy.
The response is either a SuccessResponse() or an ErrorResponse(). The
useUserCLIDSetting attribute controls the CLID settings (clidPolicy,
emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName,
allowConfigurableCLIDForRedirectingIdentity, allowDepartmentCLIDNameOverride) The
useUserMediaSetting attribute controls the Media settings (medisPolicySelection,
supportedMediaSetName) The useUserCallLimitsSetting attribute controls the Call Limits
setting (useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls,
maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls,
maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls,
maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls,
useMaxFindMeFollowMeDepth, maxRedirectionDepth,
useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations,
useMaxConcurrentTerminatingAlertingRequests, maxConcurrentTerminatingAlertingRequests,
includeRedirectionsInMaximumNumberOfConcurrentCalls) The useUserDCLIDSetting controls
the Dialable Caller ID settings (enableDialableCallerID) The
useUserPhoneListLookupSetting controls the Caller ID Lookup settings
(enablePhoneListLookup) The useUserTranslationRoutingSetting attribute controls the
routing and translation settings (routeOverrideDomain, routeOverridePrefix) The
following elements are only used in AS data mode: useUserDCLIDSetting
enableDialableCallerID allowConfigurableCLIDForRedirectingIdentity
allowDepartmentCLIDNameOverride The following elements are only used in AS data mode
and ignored in XS data mode: useUserPhoneListLookupSetting enablePhoneListLookup
useMaxConcurrentTerminatingAlertingRequests maxConcurrentTerminatingAlertingRequests
includeRedirectionsInMaximumNumberOfConcurrentCalls
allowMobileDNForRedirectingIdentity allowUserSelectionOfExternalCLIDPolicy
allowUserConfigurableCLIDModification The following elements are only used in XS data
mode and ignored in AS data mode: useUserTranslationRoutingSetting routeOverrideDomain
routeOverridePrefix
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_user_clid_setting | bool | useUserCLIDSetting Optional |
| use_user_media_setting | bool | useUserMediaSetting Optional |
| use_user_call_limits_setting | bool | useUserCallLimitsSetting Optional |
| use_user_dclid_setting | bool | useUserDCLIDSetting Optional |
| use_user_translation_routing_setting | bool | useUserTranslationRoutingSetting Optional |
| use_max_simultaneous_calls | bool | useMaxSimultaneousCalls Optional |
| max_simultaneous_calls | int | maxSimultaneousCalls Optional |
| use_max_simultaneous_video_calls | bool | useMaxSimultaneousVideoCalls Optional |
| max_simultaneous_video_calls | int | maxSimultaneousVideoCalls Optional |
| use_max_call_time_for_answered_calls | bool | useMaxCallTimeForAnsweredCalls Optional |
| max_call_time_for_answered_calls_minutes | int | maxCallTimeForAnsweredCallsMinutes Optional |
| use_max_call_time_for_unanswered_calls | bool | useMaxCallTimeForUnansweredCalls Optional |
| max_call_time_for_unanswered_calls_minutes | int | maxCallTimeForUnansweredCallsMinutes Optional |
| media_policy_selection | str | mediaPolicySelection Optional |
| supported_media_set_name | str | supportedMediaSetName Optional |
| use_max_concurrent_redirected_calls | bool | useMaxConcurrentRedirectedCalls Optional |
| max_concurrent_redirected_calls | int | maxConcurrentRedirectedCalls Optional |
| use_max_find_me_follow_me_depth | bool | useMaxFindMeFollowMeDepth Optional |
| max_find_me_follow_me_depth | int | maxFindMeFollowMeDepth Optional |
| max_redirection_depth | int | maxRedirectionDepth Optional |
| use_max_concurrent_find_me_follow_me_invocations | bool | useMaxConcurrentFindMeFollowMeInvocations Optional |
| max_concurrent_find_me_follow_me_invocations | int | maxConcurrentFindMeFollowMeInvocations Optional |
| clid_policy | str | clidPolicy Optional |
| emergency_clid_policy | str | emergencyClidPolicy Optional |
| allow_alternate_numbers_for_redirecting_identity | bool | allowAlternateNumbersForRedirectingIdentity Optional |
| use_group_name | bool | useGroupName Optional |
| enable_dialable_caller_id | bool | enableDialableCallerID Optional |
| block_calling_name_for_external_calls | bool | blockCallingNameForExternalCalls Optional |
| allow_configurable_clid_for_redirecting_identity | bool | allowConfigurableCLIDForRedirectingIdentity Optional |
| allow_department_clid_name_override | bool | allowDepartmentCLIDNameOverride Optional |
| use_user_phone_list_lookup_setting | bool | useUserPhoneListLookupSetting Optional |
| enable_phone_list_lookup | bool | enablePhoneListLookup Optional |
| use_max_concurrent_terminating_alerting_requests | bool | useMaxConcurrentTerminatingAlertingRequests Optional |
| max_concurrent_terminating_alerting_requests | int | maxConcurrentTerminatingAlertingRequests Optional |
| include_redirections_in_maximum_number_of_concurrent_calls | bool | includeRedirectionsInMaximumNumberOfConcurrentCalls Optional |
| route_override_domain | str | routeOverrideDomain Optional |
| route_override_prefix | str | routeOverridePrefix Optional |
| allow_mobile_dn_for_redirecting_identity | bool | allowMobileDNForRedirectingIdentity Optional |
| allow_user_selection_of_external_clid_policy | bool | allowUserSelectionOfExternalCLIDPolicy Optional |
| allow_user_configurable_clid_modification | bool | allowUserConfigurableCLIDModification Optional |
UserCallRecordingGetRequest(OCIRequest)
Get the Call Recording attributes for a user.
The response is either a UserCallRecordingGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallRecordingGetRequest20(OCIRequest)
Get the Call Recording attributes for a user.
The response is either a UserCallRecordingGetResponse20() or an ErrorResponse().
The following parameters are not returned for service instance: -
pauseResumeNotification - enableCallRecordingAnnouncement -
enableRecordCallRepeatWarningTone - recordCallRepeatWarningToneTimerSeconds Replaced
by: UserCallRecordingGetRequest23().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallRecordingGetRequest23(OCIRequest)
Get the Call Recording attributes for a user.
The response is either a UserCallRecordingGetResponse23() or an ErrorResponse().
The following parameters are not returned for service instance: -
pauseResumeNotification - enableCallRecordingAnnouncement -
enableRecordCallRepeatWarningTone - recordCallRepeatWarningToneTimerSeconds
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallRecordingModifyRequest(OCIRequest)
Modify the Call Recording attributes for a user.
The recording options "Always with Pause/Resume", "On Demand", and "On Demand with User Initiated Start" are not accepted for service instances.
The response is either a SuccessResponse() or an ErrorResponse(). The following
parameters are not accepted for service instance: - pauseResumeNotification -
enableCallRecordingAnnouncement - enableRecordCallRepeatWarningTone -
recordCallRepeatWarningToneTimerSeconds The enableVoiceMailRecording parameter is only
applicable if the Voice Messaging User service is assigned to the user. This applies
to both users and service instances. The following elements are only used in AS data
mode and ignored in XS data mode: mediaStream
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| recording_option | str | recordingOption Optional |
| pause_resume_notification | str | pauseResumeNotification Optional |
| enable_call_recording_announcement | bool | enableCallRecordingAnnouncement Optional |
| enable_record_call_repeat_warning_tone | bool | enableRecordCallRepeatWarningTone Optional |
| record_call_repeat_warning_tone_timer_seconds | int | recordCallRepeatWarningToneTimerSeconds Optional |
| enable_voice_mail_recording | bool | enableVoiceMailRecording Optional |
| media_stream | str | mediaStream Optional |
UserCallToNumberGetAvailableListRequest(OCIRequest)
Request to get the user available Call to Number List information.
The response is either a UserCallToNumberGetAvailableListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallTransferGetRequest(OCIRequest)
Request the user level data associated with Call Transfer.
The response is either a UserCallTransferGetResponse() or an ErrorResponse().
Replaced By: UserCallTransferGetRequest14Sp4
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallTransferGetRequest14sp4(OCIRequest)
Request the user level data associated with Call Transfer.
The response is either a UserCallTransferGetResponse14sp4() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallTransferModifyRequest(OCIRequest)
Modify the user level data associated with Call Transfer.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_recall_active | bool | isRecallActive Optional |
| recall_number_of_rings | int | recallNumberOfRings Optional |
| use_diversion_inhibitor_for_blind_transfer | bool | useDiversionInhibitorForBlindTransfer Optional |
| use_diversion_inhibitor_for_consultative_calls | bool | useDiversionInhibitorForConsultativeCalls Optional |
| enable_busy_camp_on | bool | enableBusyCampOn Optional |
| busy_camp_on_seconds | int | busyCampOnSeconds Optional |
UserCallWaitingGetRequest(OCIRequest)
Request the user level data associated with Call Waiting.
The response is either a UserCallWaitingGetResponse() or an ErrorResponse().
Replaced by: UserCallWaitingGetRequest17sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallWaitingGetRequest17sp4(OCIRequest)
Request the user level data associated with Call Waiting.
The response is either a UserCallWaitingGetResponse17sp4() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallWaitingModifyRequest(OCIRequest)
Modify the user level data associated with Call Waiting.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: disableCallingLineIdDelivery
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| disable_calling_line_id_delivery | bool | disableCallingLineIdDelivery Optional |
UserCallingLineIDBlockingOverrideGetRequest(OCIRequest)
Request the user level data associated with Calling Line ID Blocking Override.
The response is either a UserCallingLineIDBlockingOverrideGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallingLineIDBlockingOverrideModifyRequest(OCIRequest)
Modify the user level data associated with Calling Line ID Blocking Override.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
UserCallingLineIDDeliveryBlockingGetRequest(OCIRequest)
Request the user level data associated with Calling Line ID Delivery Blocking.
The response is either a UserCallingLineIDDeliveryBlockingGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallingLineIDDeliveryBlockingModifyRequest(OCIRequest)
Modify the user level data associated with Calling Line ID Delivery Blocking.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
UserCallingNameDeliveryGetRequest(OCIRequest)
Request the user level data associated with Calling Name Delivery.
The response is either a UserCallingNameDeliveryGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallingNameDeliveryModifyRequest(OCIRequest)
Modify the user level data associated with Calling Name Delivery.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active_for_external_calls | bool | isActiveForExternalCalls Optional |
| is_active_for_internal_calls | bool | isActiveForInternalCalls Optional |
UserCallingNameRetrievalGetRequest(OCIRequest)
Request the user level data associated with Calling Name Retrieval.
The response is either a UserCallingNameRetrievalGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallingNumberDeliveryGetRequest(OCIRequest)
Request the user level data associated with Calling Name Delivery.
The response is either a UserCallingNumberDeliveryGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallingNumberDeliveryModifyRequest(OCIRequest)
Modify the user level data associated with Calling Number Delivery.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active_for_external_calls | bool | isActiveForExternalCalls Optional |
| is_active_for_internal_calls | bool | isActiveForInternalCalls Optional |
UserCallingPartyCategoryGetRequest(OCIRequest)
Request the user level data associated with Calling Party Category.
The response is either a UserCallingPartyCategoryGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallingPartyCategoryGetRequest16(OCIRequest)
Request the user level data associated with Calling Party Category.
The response is either a UserCallingPartyCategoryGetResponse16() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCallingPartyCategoryModifyRequest(OCIRequest)
Modify the user level data associated with Calling Party Category.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| category | str | category Optional |
UserCallingPartyCategoryModifyRequest16(OCIRequest)
Modify the user level data associated with Calling Party Category.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| category | str | category Optional |
UserChargeNumberGetRequest(OCIRequest)
Request the user level data associated with Charge Number.
The response is either a UserChargeNumberGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserChargeNumberGetRequest14sp9(OCIRequest)
Request the user level data associated with Charge Number.
The response is either a UserChargeNumberGetResponse14sp9() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserChargeNumberModifyRequest(OCIRequest)
Modify the user level data associated with Charge Number.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber Optional |
| use_charge_number_for_enhanced_translations | bool | useChargeNumberForEnhancedTranslations Optional |
| send_charge_number_to_network | bool | sendChargeNumberToNetwork Optional |
UserClassmarkGetRequest(OCIRequest)
Request the Class Mark data associated with User.
The response is either a UserClassmarkGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserClassmarkModifyRequest(OCIRequest)
Modify the user level data associated with Class Mark.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| classmark | str | classmark Optional |
UserCollaborateBridgeGetRequest(OCIRequest)
Request the collaborate bridged assigned to the user.
The user can only be assigned to one collaborate bridge at any given time.
The response is either UserCollaborateBridgeGetResponse() or ErrorResponse().
Replaced by: UserCollaborateBridgeGetRequest20sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCollaborateBridgeGetRequest20sp1(OCIRequest)
Request the collaborate bridged assigned to the user.
The user can only be assigned to one collaborate bridge at any given time.
The response is either UserCollaborateBridgeGetResponse20sp1() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCollaborateDeleteRoomRequest(OCIRequest)
Request to delete a collaborate room.
The request only applies to project rooms and instant rooms. The request fails when deleting a collaborate My Room.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| room_id | str | roomId |
UserCollaborateInstantRoomAddRequest(OCIRequest)
Request to add collaborate instant room.
The response is either a UserCollaborateInstantRoomAddResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| room_name | str | roomName Optional |
| use_room_id_as_room_name | bool | useRoomIdAsRoomName Optional |
UserCollaborateInstantRoomGetRequest(OCIRequest)
Request the collaborate room settings for an instant room.
The request fails when requesting collaborate room settings for My Room or project rooms.
The response is either UserCollaboratInstantRoomGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| room_id | str | roomId |
UserCollaborateInstantRoomParametersGetRequest(OCIRequest)
Request collaborate instant room settings.
The response is either UserCollaborateInstantRoomParametersGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCollaborateInstantRoomParametersModifyRequest(OCIRequest)
Request to modify collaborate instant room settings.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| attendee_notification | str | attendeeNotification Optional |
| end_collaborate_room_session_on_owner_exit | bool | endCollaborateRoomSessionOnOwnerExit Optional |
| owner_required | bool | ownerRequired Optional |
UserCollaborateMyRoomGetRequest(OCIRequest)
Request collaborate room settings for MyRoom.
The response is either UserCollaboratMyRoomGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCollaborateMyRoomModifyRequest(OCIRequest)
Request to modify collaborate room settings for MyRoom.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| room_name | str | roomName Optional |
| attendee_notification | str | attendeeNotification Optional |
| end_collaborate_room_session_on_owner_exit | bool | endCollaborateRoomSessionOnOwnerExit Optional |
| owner_required | bool | ownerRequired Optional |
UserCollaborateProjectRoomGetRequest(OCIRequest)
Request collaborate room settings for a project room.
The request fails when requesting collaborate room settings for instant rooms or My Room.
The response is either UserCollaboratProjectRoomGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| room_id | str | roomId |
UserCollaborateRoomGetRequest(OCIRequest)
Request to get the settings for My Room, Instant Room or Project Room.
The roomType and roomName parameters are returned for all rooms. For My room and Project Room, the following parameters are returned: attendeeNotification, endRoomSessionOnOwnerExit and ownerRequired. In addition, the roomSchedule is returned for Project Room and the roomStartTime and roomEndTime are returned for Instant Room.
The response is either UserCollaboratetRoomGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| room_id | str | roomId |
UserCollaborateRoomIDRegenerateRequest(OCIRequest)
Request to regenerate collaborate room id for MyRoom and project room.
The request fails when requesting to regenerate room ID for an instant room.
The response is either a UserCollaborateRoomIDRegenerateResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| room_id | str | roomId |
UserCollaborateRoomListGetRequest(OCIRequest)
Request the list of collaborate room instances for this specific user.
The response is either a UserCollaborateRoomListGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCommPilotExpressGetRequest(OCIRequest)
Get the user's commPilot express service setting.
The response is either a UserCommPilotExpressGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCommunicationBarringAuthorizationCodeDeleteListRequest(OCIRequest)
Delete a list of Communication Barring Authorization codes from a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| code | List[str] | code |
UserCommunicationBarringAuthorizationCodeGetListRequest(OCIRequest)
Get a list of Communication Barring Authorization Code for a user.
The response is either a UserCommunicationBarringAuthorizationCodeGetListResponse()
or an ErorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCommunicationBarringGetRequest(OCIRequest)
Gets the Communication Barring settings for a user.
The response is either a UserCommunicationBarringGetResponse() or an
ErrorResponse(). This command only applies to groups in an Enterprise. This command
will fail for groups in a Service Provider.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCommunicationBarringModifyRequest(OCIRequest)
Modify the Communication Barring settings for a user.
If useDefaultServiceProviderProfile is set to false, a profile name must be present.
The response is either a SuccessResponse() or an ErrorResponse(). This command
only applies to groups in an Enterprise. This command will fail for groups in a
Service Provider.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_group_setting | bool | useGroupSetting Optional |
| profile_name | str | profileName Optional |
UserCommunicationBarringUserControlGetRequest(OCIRequest)
Lists the Communication Barring profiles available to a user and indicates which profile if any is currently active for the user.
.
The response is either UserCommunicationBarringUserControlGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCommunicationBarringUserControlModifyRequest(OCIRequest)
Enabling a profile automatically disables the currently active profile.
Also allows the passcode for the service to be modified and the lockout to be reset. Admins only need to populate the newPasscode field when changing the passcode. Users must populate both the oldPasscode and new Passcode fields when changing the passcode.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| enable_profile | int | enableProfile Optional |
| old_passcode | str | oldPasscode Optional |
| new_passcode | str | newPasscode Optional |
| reset_lockout | bool | resetLockout Optional |
UserConnectedLineIdentificationRestrictionGetRequest(OCIRequest)
Request the user level data associated with Connected Line ID Restriction.
The response is either a UserConnectedLineIdentificationRestrictionGetResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserConnectedLineIdentificationRestrictionModifyRequest(OCIRequest)
Modify the user level data associated with Connected Line ID Restriction.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
UserConsolidatedDeleteRequest(OCIRequest)
Request to delete a user.
If deleteExistingDevices is set to true, after the user is deleted, any device that is
only used by the deleted user prior to the deletion will be deleted if the command is
executed with the correct priviledge. Group administrator or above running this
command can delete any group level devices. Service provider administrator or above
can delete any service provider and group devices. Provisioning administrator or
above can delete any devices. An ErrorResponse() will be returned if any device
cannot be deleted because of insufficient privilege. If UnassignPhoneNumbersLevel is
set to 'Group', the user's primary phone number, fax number and any alternate numbers,
will be un-assigned from the group if the command is executed by a service provider
administrator or above. When set to 'Service Provider', they will be un-assigned from
the group and service provider if the command is executed by a provisioning
administrator or above. When omitted, the number(s) will be left assigned to the
group. An ErrorResponse() will be returned if any number cannot be unassigned
because of insufficient privilege.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| delete_existing_devices | bool | deleteExistingDevices Optional |
| unassign_phone_numbers | str | unassignPhoneNumbers Optional |
UserCustomRingbackUserDeleteCriteriaRequest(OCIRequest)
Delete a criteria from the user's custom ringback service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserCustomRingbackUserGetCriteriaListRequest(OCIRequest)
Get the user's custom ringback service criteria listing.
The response is either a UserCustomRingbackUserGetCriteriaListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserCustomRingbackUserGetCriteriaRequest(OCIRequest)
Get a criteria for the user's custom ringback service.
The response is either a UserCustomRingbackUserGetCriteriaResponse() or an
ErrorResponse().
Replaced By: UserCustomRingbackUserGetCriteriaRequest15Sp2
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserCustomRingbackUserGetCriteriaRequest15sp2(OCIRequest)
Get a criteria for the user's custom ringback service.
The response is either a UserCustomRingbackUserGetCriteriaResponse15sp2() or an
ErrorResponse().
Replaced By: UserCustomRingbackUserGetCriteriaRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserCustomRingbackUserGetCriteriaRequest16(OCIRequest)
Get a criteria for the user's custom ringback service.
The response is either a UserCustomRingbackUserGetCriteriaResponse16() or an
ErrorResponse(). Replaced by: UserCustomRingbackUserGetCriteriaRequest20() in AS
data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserCustomRingbackUserGetCriteriaRequest20(OCIRequest)
Get a criteria for the user's custom ringback service.
The response is either a UserCustomRingbackUserGetCriteriaResponse20() or an
ErrorResponse(). Replaced by: UserCustomRingbackUserGetCriteriaRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserCustomRingbackUserGetCriteriaRequest21(OCIRequest)
Get a criteria for the user's custom ringback service.
The response is either a UserCustomRingbackUserGetCriteriaResponse21() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserDeleteRequest(OCIRequest)
Request to delete a user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserDeviceActivationPolicyInEffectGetRequest(OCIRequest)
Request the Device Activation policies in effect for the user.
The response is either a UserDeviceActivationPolicyInEffectGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserDevicePoliciesGetRequest(OCIRequest)
Request the user level data associated with Device Policy.
The response is either a UserDevicePoliciesGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserDevicePoliciesGetRequest19sp1(OCIRequest)
Request the user level data associated with Device Policy.
The response is either a UserDevicePoliciesGetResponse19sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserDevicePoliciesGetRequest20(OCIRequest)
Request the user level data associated with Device Policy.
The response is either a UserDevicePoliciesGetResponse20() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserDevicePoliciesGetRequest21(OCIRequest)
Request the user level data associated with Device Policy.
The response is either a UserDevicePoliciesGetResponse21() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserDevicePoliciesModifyRequest(OCIRequest)
Modify the user level data associated with Device Policy.
enableDeviceFeatureSynchronization and enableCallDecline can be configured by the admin regardless of lineMode, but is ignored by the application server in Multiple User Shared mode. enableCallDecline can be modified by the user when the admin has set the mode to ‘Single User Private and Shared Lines mode’. This is the only element that the user can modify. In XS data mode, the lineMode is ignored and enabledCallDecline is the only element that can be configured. The following elements are only used in AS data mode and ignored in XS data mode: lineMode enableDeviceFeatureSynchronization enableDnd enableCallForwardingAlways enableCallForwardingBusy enableCallForwardingNoAnswer enableAcd enableExecutive enableExecutiveAssistant enableSecurityClassification enableCallRecording
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| line_mode | str | lineMode Optional |
| enable_device_feature_synchronization | bool | enableDeviceFeatureSynchronization Optional |
| enable_dnd | bool | enableDnd Optional |
| enable_call_forwarding_always | bool | enableCallForwardingAlways Optional |
| enable_call_forwarding_busy | bool | enableCallForwardingBusy Optional |
| enable_call_forwarding_no_answer | bool | enableCallForwardingNoAnswer Optional |
| enable_acd | bool | enableAcd Optional |
| enable_executive | bool | enableExecutive Optional |
| enable_executive_assistant | bool | enableExecutiveAssistant Optional |
| enable_security_classification | bool | enableSecurityClassification Optional |
| enable_call_recording | bool | enableCallRecording Optional |
| enable_call_decline | bool | enableCallDecline Optional |
UserDirectRouteGetRequest(OCIRequest)
Get the direct route setting and the list of DTGs/Trunk Identities assigned to a user.
The response is either UserDirectRouteGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserDirectedCallPickupWithBargeInGetRequest(OCIRequest)
Request the user level data associated with Directed Call Pickup With Barge In.
The response is either a UserDirectedCallPickupWithBargeInGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserDirectedCallPickupWithBargeInGetRequest14sp7(OCIRequest)
Request the user level data associated with Directed Call Pickup With Barge In.
The response is either a UserDirectedCallPickupWithBargeInGetResponse14sp7() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserDirectedCallPickupWithBargeInModifyRequest(OCIRequest)
Modify the user level data associated with Directed Call Pickup With Barge In.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| enable_barge_in_warning_tone | bool | enableBargeInWarningTone Optional |
| enable_automatic_target_selection | bool | enableAutomaticTargetSelection Optional |
UserDnGetActivationListRequest(OCIRequest)
Request to get a list of DNs associated with a user and their activation state.
The response is either UserDnGetActivationListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserDoNotDisturbGetRequest(OCIRequest)
Request the user level data associated with Do Not Disturb.
The response is either a UserDoNotDisturbGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserDoNotDisturbModifyRequest(OCIRequest)
Modify the user level data associated with Do Not Disturb.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command is used internally by Call Processing. The following element is
only used in AS data mode and ignored in XS data mode: isDoNotDisturbSync
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| ring_splash | bool | ringSplash Optional |
| is_do_not_disturb_sync | bool | isDoNotDisturbSync Optional |
UserEnhancedCallLogsGetListRequest(OCIRequest)
Request user's call logs.
It is possible to get a subset of the total list of calls by specifying a starting offset and the number of calls to get. If the callLogType is not specified, all types of calls are returned.
The response is either a UserEnhancedCallLogsGetListResponse() or an
ErrorResponse().
Replaced By: UserEnhancedCallLogsGetListRequest14sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| call_log_type | str | callLogType Optional |
| starting_offset | int | startingOffset |
| num_calls | int | numCalls |
UserEnhancedCallLogsGetListRequest14sp4(OCIRequest)
Request user's call logs.
It is possible to get a subset of the total list of calls by specifying a starting offset and the number of calls to get. If the callLogType is not specified, all types of calls are returned.
The response is either a UserEnhancedCallLogsGetListResponse14sp4() or an
ErrorResponse(). Replaced by: UserEnhancedCallLogsGetListRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| call_log_type | str | callLogType Optional |
| starting_offset | int | startingOffset |
| num_calls | int | numCalls |
UserExecutiveAssistantGetRequest(OCIRequest)
Get the setting of an executive assistant.
The response is either UserExecutiveAssistantGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserExecutiveDeleteFilteringSelectiveCriteriaRequest(OCIRequest)
Delete a filtering criteria from an executive user.
Both executive and the executive assistant can run this command.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserExecutiveGetAssistantRequest(OCIRequest)
Get the assistant setting and the list of assistants assigned to an executive.
The response is either UserExecutiveGetAssistantsResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserExecutiveGetFilteringRequest(OCIRequest)
Get the filtering setting and the list of filtering criteria defined for an executive user.
Both executive and the executive assistant can run this command.
The response is either UserExecutiveGetFilteringResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserExecutiveGetFilteringSelectiveCriteriaRequest(OCIRequest)
Get a filtering criteria for an executive user.
Both executive and the executive assistant can run this command.
The response is either UserExecutiveGetSelectiveCriteriaResponse() or
ErrorResponse(). Replaced by:
UserExecutiveGetFilteringSelectiveCriteriaRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserExecutiveGetFilteringSelectiveCriteriaRequest21(OCIRequest)
Get a filtering criteria for an executive user.
Both executive and the executive assistant can run this command.
The response is either UserExecutiveGetSelectiveCriteriaResponse21() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserExecutiveGetScreeningAlertingRequest(OCIRequest)
Get the screening and alerting setting of an executive.
Both executive and the executive assistant can run this command.
The response is either UserExecutiveGetScreeningAlertingResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserExecutiveModifyFilteringExecutionServerRequest(OCIRequest)
Modify the filtering setting for an executive user.
Both executive and the executive assistant can run this command. requestingUserId is either executive or executive assistant.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| requesting_user_id | str | requestingUserId Optional |
| enable_filtering | bool | enableFiltering Optional |
UserExecutiveModifyScreeningAlertingRequest(OCIRequest)
Modify the screening and alerting setting of an executive.
Both executive and the executive assistant can run this command.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| enable_screening | bool | enableScreening Optional |
| screening_alert_type | str | screeningAlertType Optional |
| alert_broad_works_mobility_location | bool | alertBroadWorksMobilityLocation Optional |
| alert_broad_works_anywhere_locations | bool | alertBroadWorksAnywhereLocations Optional |
| alert_shared_call_appearance_locations | bool | alertSharedCallAppearanceLocations Optional |
| alerting_mode | str | alertingMode Optional |
| alerting_calling_line_id_name_mode | str | alertingCallingLineIdNameMode Optional |
| alerting_custom_calling_line_id_name | str | alertingCustomCallingLineIdName Optional |
| unicode_alerting_custom_calling_line_id_name | str | unicodeAlertingCustomCallingLineIdName Optional |
| alerting_calling_line_id_phone_number_mode | str | alertingCallingLineIdPhoneNumberMode Optional |
| alerting_custom_calling_line_id_phone_number | str | alertingCustomCallingLineIdPhoneNumber Optional |
| call_push_recall_number_of_rings | int | callPushRecallNumberOfRings Optional |
| next_assistant_number_of_rings | int | nextAssistantNumberOfRings Optional |
| enable_rollover | bool | enableRollover Optional |
| rollover_wait_time_seconds | int | rolloverWaitTimeSeconds Optional |
| rollover_action | str | rolloverAction Optional |
| rollover_forward_to_phone_number | str | rolloverForwardToPhoneNumber Optional |
UserExternalCallingLineIDDeliveryGetRequest(OCIRequest)
Request the user level data associated with External Calling Line ID Delivery.
The response is either a UserExternalCallingLineIDDeliveryGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserExternalCallingLineIDDeliveryModifyRequest(OCIRequest)
Modify the user level data associated with External Calling Line ID Delivery.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
UserExternalCustomRingbackGetRequest(OCIRequest)
Request the user level data associated with External Custom Ringback.
The response is either a UserExternalCustomRingbackGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserExternalCustomRingbackModifyRequest(OCIRequest)
Modify the user level data associated with External Custom Ringback.
The user SIP URI, when selected, it replaces the SP address, port and prefix. The user SIP URI, if selected, is the Request URI of the SIP INVITE sent to the external server. When the service provider data is used instead, the Request URI is constructed using the prefix, address, port and the user DN. The timeout value is the only SP configuration used when the user SIP URI is selected.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| use_setting_level | str | useSettingLevel Optional |
| sip_request_uri | str | sipRequestURI Optional |
UserFaxMessagingGetRequest(OCIRequest)
Request the user level data associated with Fax Messaging.
The response is either a UserFaxMessagingGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserFaxMessagingGetRequest17(OCIRequest)
Request the user level data associated with Fax Messaging.
The response is either a UserFaxMessagingGetResponse17() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserFaxMessagingGetRequest17sp1(OCIRequest)
Request the user level data associated with Fax Messaging.
The response is either a UserFaxMessagingGetResponse17sp1() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserFeatureAccessCodeGetListRequest(OCIRequest)
Get the list of feature access codes for a user.
The response is either a UserFeatureAccessCodeGetListResponse() or an
ErrorResponse(). Replaced by: UserFeatureAccessCodeGetListRequest20() in AS data
mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserFeatureAccessCodeGetListRequest20(OCIRequest)
Get the list of feature access codes for a user.
The response is either a UserFeatureAccessCodeGetListResponse20() or an
ErrorResponse(). In release 20 the "Call Recording" FAC name is changed to "Call
Recording Start". Replaced by: UserFeatureAccessCodeGetListRequest21() in AS data
mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserFeatureAccessCodeGetListRequest21(OCIRequest)
Get the list of feature access codes for a user.
The response is either a UserFeatureAccessCodeGetListResponse20() or an
ErrorResponse(). In release 20 the "Call Recording" FAC name is changed to "Call
Recording Start".
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserFlexibleSeatingGuestGetRequest(OCIRequest)
Request the user level data associated with flexible seating guest.
The response is either a UserFlexibleSeatingGuestGetResponse() or an
ErrorResponse(). Replaced by: UserFlexibleSeatingGuestGetRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserFlexibleSeatingGuestGetRequest22(OCIRequest)
Request the user level data associated with flexible seating guest.
The response is either a UserFlexibleSeatingGuestGetResponse22() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetLoginInfoRequest(OCIRequest)
UserGetLoginInfoRequest() is used to access login information for a user either by a
userId or dn.
The phone number may be any DN associated with a user.
The response is a UserGetLoginInfoResponse() or an ErrorResponse() Replaced by
UserGetLoginInfoRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId Optional |
| phone_number | str | phoneNumber Optional |
UserGetLoginInfoRequest21sp1(OCIRequest)
UserGetLoginInfoRequest21sp1() is used to access login information for a user either
by a userId, dn or lineport.
The phone number may be any DN associated with a user. The lineport may be any lineport associated with a user.
The response is a UserGetLoginInfoResponse21sp1() or an ErrorResponse() Replaced
by UserGetLoginInfoRequest22V2().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId Optional |
| phone_number | str | phoneNumber Optional |
| line_port | str | linePort Optional |
UserGetLoginInfoRequest22(OCIRequest)
UserGetLoginInfoRequest22() is used to access login information for a user either by
a userId, dn or lineport.
The phone number may be any DN associated with a user. The lineport may be any lineport associated with a user.
The response is a UserGetLoginInfoResponse22() or an ErrorResponse() Replaced by
UserGetLoginInfoRequest22V2().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId Optional |
| phone_number | str | phoneNumber Optional |
| line_port | str | linePort Optional |
UserGetLoginInfoRequest22V2(OCIRequest)
UserGetLoginInfoRequest22V2() is used to access login information for a user either
by a userId, dn or lineport.
The phone number may be any DN associated with a user. The lineport may be any lineport associated with a user.
The response is a UserGetLoginInfoResponse22V2() or an ErrorResponse() Replaced by
UserGetLoginInfoRequest22V3().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId Optional |
| phone_number | str | phoneNumber Optional |
| line_port | str | linePort Optional |
UserGetLoginInfoRequest22V3(OCIRequest)
UserGetLoginInfoRequest22V3() is used to access login information for a user either
by a userId, dn or lineport.
The phone number may be any DN associated with a user. The lineport may be any lineport associated with a user.
The response is a UserGetLoginInfoResponse22V3() or an ErrorResponse(). The
following elements are only used in AS data mode and ignored in XS data mode.
loginRole
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId Optional |
| login_role | str | loginRole Optional |
| phone_number | str | phoneNumber Optional |
| line_port | str | linePort Optional |
UserGetLoginInfoRequest22V4(OCIRequest)
UserGetLoginInfoRequest22V4() is used to access login information for a user either
by a userId, dn or lineport.
The phone number may be any DN associated with a user. The lineport may be any lineport associated with a user.
The response is a UserGetLoginInfoResponse22V4() or an ErrorResponse(). The
following elements are only used in AS data mode and ignored in XS data mode.
loginRole Replaced by: UserGetLoginInfoRequestRI in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId Optional |
| login_role | str | loginRole Optional |
| phone_number | str | phoneNumber Optional |
| line_port | str | linePort Optional |
UserGetRegistrationListRequest(OCIRequest)
Request to get a list of registrations for a user.
The response is either a UserGetRegistrationListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest14(OCIRequest)
Request to get the user information.
The response is either UserGetResponse14() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest14sp4(OCIRequest)
Request to get the user information.
The response is either UserGetResponse14sp4() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest14sp9(OCIRequest)
Request to get the user information.
The response is either UserGetResponse14sp4() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest15sp2(OCIRequest)
Request to get the user information.
The response is either UserGetResponse15sp2() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest17(OCIRequest)
Replaced By UserGetRequest17sp4() Request to get the user information.
The response is either UserGetResponse17() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest17sp3(OCIRequest)
Replaced By UserGetRequest18() Request to get the user information.
The response is either UserGetResponse17sp3() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest17sp4(OCIRequest)
Replaced By UserGetRequest18() Request to get the user information.
The response is either UserGetResponse17sp4() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest18(OCIRequest)
Request to get the user information.
The response is either UserGetResponse18() or ErrorResponse(). Replaced by:
UserGetRequest19().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest19(OCIRequest)
Request to get the user information.
The response is either UserGetResponse19() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest20(OCIRequest)
Request to get the user information.
The response is either UserGetResponse20() or ErrorResponse(). Replaced by:
UserGetRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest21(OCIRequest)
Request to get the user information.
The response is either UserGetResponse21() or ErrorResponse(). Replaced by
UserGetRequest21sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest21sp1(OCIRequest)
Request to get the user information.
The response is either UserGetResponse21sp1() or ErrorResponse(). Replaced by
UserGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest22(OCIRequest)
Request to get the user information.
The response is either UserGetResponse22() or ErrorResponse(). Replaced by
UserGetRequest22V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest22V2(OCIRequest)
Request to get the user information.
The response is either UserGetResponse22V2() or ErrorResponse(). Replaced by
UserGetRequest22V3().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest22V3(OCIRequest)
Request to get the user information.
The response is either UserGetResponse22V3() or ErrorResponse(). Replaced by:
UserGetRequest22V4()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest22V4(OCIRequest)
Request to get the user information.
The response is either UserGetResponse22V4() or ErrorResponse(). Replaced by:
UserGetResponse22V5() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest22V5(OCIRequest)
Request to get the user information.
The response is either UserGetResponse22V5() or ErrorResponse(). Replaced by:
UserGetRequest22V6()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest22V6(OCIRequest)
Request to get the user information.
The response is either UserGetResponse22V6() or ErrorResponse(). Replaced by:
UserGetRequest22V7()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest22V7(OCIRequest)
Request to get the user information.
The response is either UserGetResponse22V7() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest22V8(OCIRequest)
Request to get the user information.
The response is either UserGetResponse22V8() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest22V9(OCIRequest)
Request to get the user information.
The response is either UserGetResponse22V9() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest23(OCIRequest)
Request to get the user information.
The response is either UserGetResponse23() or ErrorResponse(). Replaced by
UserGetRequest23v2.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGetRequest23V2(OCIRequest)
Request to get the user information.
The response is either UserGetResponse23V2() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGroupNightForwardingGetRequest(OCIRequest)
Request to get the Group Night Forwarding user parameters.
The response is either UserGroupNightForwardingGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserGroupNightForwardingModifyRequest(OCIRequest)
Request to modify the Group Night Forwarding user parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| night_forwarding | str | nightForwarding Optional |
UserGroupPagingGetListRequest(OCIRequest)
Get the list of all the Paging Groups a user was assigned as an originator.
The response is either a UserGroupPagingGetListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserHolidayScheduleDeleteRequest(OCIRequest)
Delete a holiday schedule from a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| holiday_schedule_name | str | holidayScheduleName |
UserHolidayScheduleGetListRequest(OCIRequest)
Get a holiday schedule list for a user.
The response is either a UserHolidayScheduleGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserHolidayScheduleGetRequest(OCIRequest)
Get a holiday schedule a user.
The response is either a UserHolidayScheduleGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| holiday_schedule_name | str | holidayScheduleName |
UserHotelingGuestGetRequest14(OCIRequest)
Request the user level data associated with Hoteling Guest.
The response is either a UserHotelingGuestGetResponse14() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserHotelingGuestGetRequest14sp2(OCIRequest)
Request the user level data associated with Hoteling Guest.
The response is either a UserHotelingGuestGetResponse14() or an ErrorResponse().
Replaced by: UserHotelingGuestGetRequest14sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserHotelingGuestGetRequest14sp4(OCIRequest)
Request the user level data associated with Hoteling Guest.
The response is either a UserHotelingGuestGetResponse14sp4() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserHotelingGuestModifyRequest(OCIRequest)
Modify the user level data associated with Hoteling Guest.
There is no provisioning error will be given when setting hostUserId to not nil value while Hoteling Guest feature is not active.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by
UserHotelingGuestModifyRequest21() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| enable_association_limit | bool | enableAssociationLimit Optional |
| association_limit_hours | int | associationLimitHours Optional |
| host_user_id | str | hostUserId Optional |
UserHotelingGuestModifyRequest21(OCIRequest)
Modify the user level data associated with Hoteling Guest.
Provisioning error will be given when setting hostUserId to not nil value while Hoteling Guest feature is not active.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| enable_association_limit | bool | enableAssociationLimit Optional |
| association_limit_hours | int | associationLimitHours Optional |
| host_user_id | str | hostUserId Optional |
UserHotelingHostGetRequest14(OCIRequest)
Request the user level data associated with Hoteling Host.
The response is either a UserHotelingHostGetResponse14() or an ErrorResponse().
Replaced by: UserHotelingHostGetRequest14sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserHotelingHostGetRequest14sp4(OCIRequest)
Request the user level data associated with Hoteling Host.
The response is either a UserHotelingHostGetResponse14sp4() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserHotelingHostGetRequest17(OCIRequest)
Request the user level data associated with Hoteling Host.
The response is either a UserHotelingHostGetResponse17() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserHotelingHostModifyRequest(OCIRequest)
Modify the user level data associated with Hoteling Host.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| enforce_association_limit | bool | enforceAssociationLimit Optional |
| association_limit_hours | int | associationLimitHours Optional |
| access_level | str | accessLevel Optional |
| remove_guest_association | bool | removeGuestAssociation Optional |
UserINIntegrationGetRequest(OCIRequest)
Request to get the user level IN Integration service attributes Response is either
UserINIntegrationGetResponse() or ErrorResponse()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserINIntegrationModifyRequest(OCIRequest)
Request to modify the user level IN Integration service attributes Response is either
SuccessResponse() or ErrorResponse()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| originating_service_key | int | originatingServiceKey Optional |
| terminating_service_key | int | terminatingServiceKey Optional |
UserInCallServiceActivationGetRequest(OCIRequest)
Request the user level data associated with In-Call Service Activation.
The response is either a UserInCallServiceActivationGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserInCallServiceActivationModifyRequest(OCIRequest)
Modify the user level data associated with In-Call Service Activation.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
UserIncomingCallingPlanGetRequest(OCIRequest)
Request the user's incoming calling plan settings.
The response is either a UserIncomingCallingPlanGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserIntegratedIMPGeneratePasswordRequest(OCIRequest)
Generate a new IMP password for the user.
The new generated password is synchronized to BroadCloud/service Messaging Server.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserIntegratedIMPGetRequest(OCIRequest)
Get the Integrated IMP specific service attribute for the user.
The response is either UserIMPGetResponse() or ErrorResponse(). Replaced by:
UserIntegratedIMPGetRequest21sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserIntegratedIMPGetRequest21sp1(OCIRequest)
Get the Integrated IMP specific service attribute for the user.
The response is either UserIMPGetResponse21sp1() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserIntegratedIMPModifyRequest(OCIRequest)
Modifies the Integrated IMP specific service attribute for the user.
The response is either a SuccessResponse() or an ErrorResponse(). If the impId
element is set in the request, the impId element does not take effect on the service
for the user unless the request also has the isActive element set to true to turn the
service from off to on. If impId is based on an alternate user ID and the impId and
userId are identical, isAlternateImpId should be set to true to determine that impId
is the user's alternate ID. The following elements are only used in AS data mode and
ignored in XS data mode: impId isAlternateImpId
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| imp_id | str | impId Optional |
| is_alternate_imp_id | bool | isAlternateImpId Optional |
UserInterceptUserGetRequest(OCIRequest)
Get the user's intercept user service settings.
The response is either a UserInterceptUserGetResponse() or an ErrorResponse().
Replaced By: UserInterceptUserGetRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserInterceptUserGetRequest16(OCIRequest)
Get the user's intercept user service settings.
The response is either a UserInterceptUserGetResponse16() or an ErrorResponse().
Replaced By: UserInterceptUserGetRequest16sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserInterceptUserGetRequest16sp1(OCIRequest)
Get the user's intercept user service settings.
The response is either a UserInterceptUserGetResponse16sp1() or an
ErrorResponse(). Replaced by: UserInterceptUserGetRequest21sp1() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserInterceptUserGetRequest21sp1(OCIRequest)
Get the user's intercept user service settings.
The response is either a UserInterceptUserGetResponse21sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserInternalCallingLineIDDeliveryGetRequest(OCIRequest)
Request the user level data associated with Internal Calling Line ID Delivery.
The response is either a UserInternalCallingLineIDDeliveryGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserInternalCallingLineIDDeliveryModifyRequest(OCIRequest)
Modify the user level data associated with Internal Calling Line ID Delivery.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
UserLegacyAutomaticCallbackGetRequest(OCIRequest)
Request the user level data associated with Legacy Automatic Callback.
The response is either a UserLegacyAutomaticCallbackGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserLegacyAutomaticCallbackModifyRequest(OCIRequest)
Modify the user level data associated with Legacy Automatic Callback.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
UserLinePortGetListRequest(OCIRequest)
Request to get all user's configured line ports.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserMWIDeliveryToMobileEndpointGetRequest(OCIRequest)
Request the user level data associated with MWI Delivery to Mobile Endpoint service.
The response is either a UserMWIDeliveryToMobileEndpointGetResponse() or an
ErrorResponse(). Replaced by: UserMWIDeliveryToMobileEndpointGetRequest23() in AS
data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserMWIDeliveryToMobileEndpointGetRequest23(OCIRequest)
Request the user level data associated with MWI Delivery to Mobile Endpoint service.
The response is either a UserMWIDeliveryToMobileEndpointGetResponse23() or an
ErrorResponse(). The following elements are only used in AS data mode:
sendMissedCallAlert
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserMWIDeliveryToMobileEndpointModifyRequest(OCIRequest)
Request to modify the user level data associated with MWI Delivery to Mobile Endpoint service.
The response is either a SuccessResponse() or an ErrorResponse(). The following
element is only used in AS data mode: sendMissedCallAlert
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| send_missed_call_alert | bool | sendMissedCallAlert Optional |
UserMaliciousCallTraceGetRequest(OCIRequest)
Request the user level data associated with Malicious Call Trace.
The response is either a UserMaliciousCallTraceGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserMeetMeConferencingGetBridgeListRequest(OCIRequest)
Get the list of Meet-Me Conferencing bridges for which the user is a host.
The response is either UserMeetMeConferencingGetBridgeListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserMeetMeConferencingGetConferenceListRequest(OCIRequest)
Get the list of all conferences for which user is a host or a delegate.
The response is either UserMeetMeConferencingGetConferenceListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| bridge_id | str | bridgeId Optional |
UserMeetMeConferencingGetConferenceRecordingListRequest(OCIRequest)
Get the list of recordings of the conferences owned by the host.
The response is either UserMeetMeConferencingGetConferenceRecordingListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserModifyGroupIdRequest(OCIRequest)
Move the user from one group to another group within the same enterprise.
If evaluateOnly is specified, no actual move will happen. The command only tests the move and reports the impacts or possible conditions preventing the move.
The response is either UserModifyGroupIdResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| new_group_id | str | newGroupId |
| evaluate_only | bool | evaluateOnly Optional |
UserModifyUserIdRequest(OCIRequest)
Modify the user id of a real or virtual user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| new_user_id | str | newUserId |
UserMusicOnHoldGetRequest(OCIRequest)
Request the user level data associated with Music On Hold.
The response is either a UserMusicOnHoldGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserMusicOnHoldModifyRequest(OCIRequest)
Modify the user level data associated with Music On Hold.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
UserMusicOnHoldUserGetRequest(OCIRequest)
Request the user level data associated with Music On Hold User.
The response is either a UserMusicOnHoldUserGetResponse() or an ErrorResponse().
Replaced By: UserMusicOnHoldUserGetRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserMusicOnHoldUserGetRequest16(OCIRequest)
Request the user level data associated with Music On Hold User.
The response is either a UserMusicOnHoldUserGetResponse16() or an ErrorResponse().
Replaced by: UserMusicOnHoldUserGetRequest20() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserMusicOnHoldUserGetRequest20(OCIRequest)
Request the user level data associated with Music On Hold User.
The response is either a UserMusicOnHoldUserGetResponse20() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserNetworkConferencingGetRequest(OCIRequest)
Request the Network-Based Conferencing data for a specified user.
The response is either a UserNetworkConferencingGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserNumberPortabilityAnnouncementGetRequest(OCIRequest)
Get the Number Portability Announcement attributes for the user.
The response is either UserNumberPortabilityAnnouncementGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserNumberPortabilityAnnouncementModifyRequest(OCIRequest)
Modify the Number Portability Announcement attributes for the user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| enable | bool | enable Optional |
UserOCICallControlApplicationGetListRequest(OCIRequest)
Get the OCI call control application list that can be used by the user.
The response is either UserOCICallControlApplicationGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserOutgoingCallingPlanAuthorizationCodeDeleteListRequest(OCIRequest)
Delete a list of authorization codes from a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| code | List[str] | code |
UserOutgoingCallingPlanAuthorizationCodeGetListRequest(OCIRequest)
Request the list of authorization codes for a user.
The response is either a UserOutgoingCallingPlanAuthorizationCodeGetListResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserOutgoingCallingPlanAuthorizationCodeGetRequest(OCIRequest)
Request the authorization code setting for a user.
The response is either a UserOutgoingCallingPlanAuthorizationCodeGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserOutgoingCallingPlanAuthorizationCodeModifyRequest(OCIRequest)
Modify the authorization setting for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_custom_settings | bool | useCustomSettings Optional |
UserOutgoingCallingPlanCallMeNowGetRequest(OCIRequest)
Request the Call Me Now call permissions for a user.
The response is either a UserOutgoingCallingPlanCallMeNowGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserOutgoingCallingPlanDigitPlanCallMeNowGetRequest(OCIRequest)
Request the Call Me Now call permissions for digit patterns for a user.
The response is either a UserOutgoingCallingPlanDigitPlanCallMeNowGetResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserOutgoingCallingPlanDigitPlanOriginatingGetRequest(OCIRequest)
Request the originating permissions for digit patterns for a user.
The response is either a UserOutgoingCallingPlanDigitPlanOriginatingGetResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserOutgoingCallingPlanDigitPlanRedirectingGetRequest(OCIRequest)
Request the redirecting permissions for digit patterns for a user.
The response is either a UserOutgoingCallingPlanDigitPlanRedirectingGetResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserOutgoingCallingPlanOriginatingGetRequest(OCIRequest)
Request the originating permissions for a user.
The response is either a UserOutgoingCallingPlanOriginatingGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserOutgoingCallingPlanPinholeDigitPlanCallMeNowGetRequest(OCIRequest)
Request the Call Me Now permissions for Pinhole digit patterns for a user.
The response is either a
UserOutgoingCallingPlanPinholeDigitPlanCallMeNowgGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserOutgoingCallingPlanPinholeDigitPlanOriginatingGetRequest(OCIRequest)
Request the originating permissions for Pinhole digit patterns for a user.
The response is either a
UserOutgoingCallingPlanPinholeDigitPlanOriginatingGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserOutgoingCallingPlanPinholeDigitPlanRedirectingGetRequest(OCIRequest)
Request the redirecting permissions for Pinhole digit patterns for a user.
The response is either a
UserOutgoingCallingPlanPinholeDigitPlanRedirectingGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserOutgoingCallingPlanRedirectedGetRequest(OCIRequest)
Request the call forwarded/transferred permissions for a user.
The response is either a UserOutgoingCallingPlanRedirectedGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserOutgoingCallingPlanRedirectingGetRequest(OCIRequest)
Request the initiating call forwards/transfer permissions for a user.
The response is either a UserOutgoingCallingPlanRedirectingGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserOutgoingCallingPlanSustainedAuthorizationCodeGetRequest(OCIRequest)
Request the sustained authorization code setting for a user.
The response is either a
UserOutgoingCallingPlanSustainedAuthorizationCodeGetResponse() or an
ErrorResponse(). Engineering Note: This command is used internally by Call
Processing.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest(OCIRequest)
Modify or clear the sustained authorization code for a user.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command is used internally by Call Processing.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| code | str | code Optional |
UserOutgoingCallingPlanTransferNumbersGetRequest(OCIRequest)
Request the transfer numbers for a user.
The response is either a UserOutgoingCallingPlanTransferNumbersGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPBXIntegrationGetRequest(OCIRequest)
Request the user level data associated with PBX Integration service.
The response is either a UserPBXIntegrationGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPBXIntegrationModifyRequest(OCIRequest)
Modify the user level data associated with PBX Integration service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| proxy_to_header_from_network | bool | proxyToHeaderFromNetwork Optional |
UserPasswordInfoGetRequest(OCIRequest)
Request the user's Web password information.
The response is either a UserPasswordInfoGetResponse() or an ErrorResponse().
Replaced by: UserPasswordInfoGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPasswordInfoGetRequest22(OCIRequest)
Request the user's Web password information.
The response is either a UserPasswordInfoGetResponse22() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPersonalAssistantCallToNumberGetListRequest(OCIRequest)
Request to get the user assigned Call to Number List information.
The response is either a UserPersonalAssistantCallToNumberGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPersonalAssistantDeleteCriteriaRequest(OCIRequest)
Deletes a User Personal Assistant Schedule Selective Criteria Entry.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserPersonalAssistantExclusionNumberAddRequest(OCIRequest)
Add a User Personal Assistant Exclusion Number.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| exclusion_number | str | exclusionNumber |
| description | str | description Optional |
UserPersonalAssistantExclusionNumberDeleteListRequest(OCIRequest)
Delete a list of User Personal Assistant Exclusion Number.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| exclusion_number | List[str] | exclusionNumber |
UserPersonalAssistantExclusionNumberGetRequest(OCIRequest)
Get a Personal Assistant Exclusion Number.
The response is either UserPersonalAssistantExclusionNumberGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| exclusion_number | str | exclusionNumber |
UserPersonalAssistantExclusionNumberModifyRequest(OCIRequest)
Modify an existing User Personal Assistant Exclusion Number description.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| exclusion_number | str | exclusionNumber |
| description | str | description Optional |
UserPersonalAssistantGetCriteriaRequest(OCIRequest)
Gets a User Personal Assistant Schedule Selective Criteria Entry.
The response is either UserPersonalAssistantGetCriteriaResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserPersonalAssistantGetRequest(OCIRequest)
Request to get the User Personal Assistant information.
The response is either a UserPersonalAssistantGetResponse() or an ErrorResponse().
Replaced by: UserPersonalAssistantGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPersonalAssistantGetRequest22(OCIRequest)
Request to get the User Personal Assistant information.
The response is either a UserPersonalAssistantGetResponse22() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPersonalAssistantGetRequest24(OCIRequest)
Request to get the User Personal Assistant information.
The response is either a UserPersonalAssistantGetResponse24() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPersonalPhoneListDeleteListRequest(OCIRequest)
Delete one or more entries from a user's personal phone list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| entry_name | List[str] | entryName |
UserPersonalPhoneListModifyRequest(OCIRequest)
Modify an entry in a user's personal phone list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| entry_name | str | entryName |
| new_entry_name | str | newEntryName Optional |
| phone_number | str | phoneNumber Optional |
UserPhoneDirectoryGetSearchedListRequest(OCIRequest)
Request a table containing the phone directory for a user.
If the specified user is part of an enterprise, the directory includes all users in the enterprise and all entries in the enterprise common phone list and the common phone list of the specified user's group. If the specified user is part of a service provider, the directory includes all users in the user's group and all entries in the common phone list of the specified user's group. It is possible to search the directory for names containing a specified search string. The search includes matches on first name or last name or common phone list names.
The response is either UserPhoneDirectoryGetSearchedListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| name_search_string | str | nameSearchString Optional |
UserPhysicalLocationGetRequest(OCIRequest)
Request the user level data associated with Physical Location.
The response is either a UserPhysicalLocationGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPhysicalLocationModifyRequest(OCIRequest)
Modify the user level data associated with Physical Location.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
UserPolycomPhoneServicesGetPrimaryEndpointListRequest(OCIRequest)
Request the user's list of device profiles on which the user is the primary user.
The response is either a UserPolycomPhoneServicesGetPrimaryEndpointListResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPortalPasscodeGetInfoRequest(OCIRequest)
Request the user's portal passcode information.
The response is either a UserPortalPasscodeGetInfoResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPortalPasscodeModifyRequest(OCIRequest)
Modify the user's Portal passcode The response is either a SuccessResponse() or an
ErrorResponse().
The following elements are only used in XS data mode and ignored in AS data mode: oldPasscode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| old_passcode | str | oldPasscode Optional |
| new_passcode | str | newPasscode |
UserPortalPasscodeRulesGetRequest(OCIRequest)
Requests the effective passcode rules setting for a user.
The response is either UserPortalPasscodeRulesGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId Optional |
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
UserPreAlertingAnnouncementDeleteCriteriaRequest(OCIRequest)
Delete a criteria from the user's pre-alerting service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserPreAlertingAnnouncementGetCriteriaRequest(OCIRequest)
Get a criteria for the user's pre-alerting service.
The response is either a UserPreAlertingAnnouncementGetCriteriaResponse() or an
ErrorResponse(). Replaced by: UserPreAlertingAnnouncementGetCriteriaRequest21() in
AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserPreAlertingAnnouncementGetCriteriaRequest21(OCIRequest)
Get a criteria for the user's pre-alerting service.
The response is either a UserPreAlertingAnnouncementGetCriteriaResponse21() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserPreAlertingAnnouncementGetRequest(OCIRequest)
Get the user's pre-alerting service setting.
The response is either a UserPreAlertingAnnouncementGetResponse() or an
ErrorResponse(). Replaced by: UserPreAlertingAnnouncementGetRequest20() in AS data
mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPreAlertingAnnouncementGetRequest20(OCIRequest)
Get the user's pre-alerting service setting.
The response is either a UserPreAlertingAnnouncementGetResponse20() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPreferredAnswerEndpointGetListRequest(OCIRequest)
Requests the list of device endpoints of a user that can be configured as Preferred Answer Endpoint for Auto-Answer and Forced Answer.
If onlyDisplayPreferredAnswerEndpoint is specified, only the Preferred Answer Endpoint of user is returned in the response.
The response is either UserPreferredAnswerEndpointGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| only_display_preferred_answer_endpoint | bool | onlyDisplayPreferredAnswerEndpoint Optional |
UserPreferredCarrierUserGetRequest(OCIRequest)
Requests the currently configured preferred carriers for a user.
The response is either a UserPreferredCarrierUserGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPrepaidGetRequest(OCIRequest)
Request the user level data associated with Prepaid.
The response is either a UserPrepaidGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPrepaidModifyRequest(OCIRequest)
Modify the user level data associated with Prepaid.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command is used internally by Call Processing.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
UserPrimaryEndpointAdvancedSettingGetRequest(OCIRequest)
Get the Users Primary Endpoint setting.
The response is either a UserPrimaryEndpointAdvancedSettingGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPrimaryEndpointAdvancedSettingModifyRequest(OCIRequest)
Modify the Users Primary Endpoint line control settings.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in XS data mode and ignored in AS data mode: allowVideo
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| allow_origination | bool | allowOrigination Optional |
| allow_termination | bool | allowTermination Optional |
| allow_video | bool | allowVideo Optional |
UserPriorityAlertDeleteCriteriaRequest(OCIRequest)
Delete a criteria from the user's priority alert service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserPriorityAlertGetCriteriaListRequest(OCIRequest)
Get the user's priority alert criteria listing.
The response is either a UserPriorityAlertGetCriteriaListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPriorityAlertGetCriteriaRequest(OCIRequest)
Get a criteria for the user's priority alert service.
The response is either a UserPriorityAlertGetCriteriaResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserPriorityAlertGetCriteriaRequest16(OCIRequest)
Get a criteria for the user's priority alert service.
The response is either a UserPriorityAlertGetCriteriaResponse16() or an
ErrorResponse(). Replaced by: UserPriorityAlertGetCriteriaRequest21() in AS data
mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserPriorityAlertGetCriteriaRequest21(OCIRequest)
Get a criteria for the user's priority alert service.
The response is either a UserPriorityAlertGetCriteriaResponse21() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserPrivacyGetRequest(OCIRequest)
Request the user level data associated with Privacy.
The response is either a UserPrivacyGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPrivacyGetRequest13mp17(OCIRequest)
Request the user level data associated with Privacy.
This command is supported for regular users only.
The response is either a UserPrivacyGetResponse13mp17() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPushNotificationGetRequest(OCIRequest)
Get the push notification settings for a user.
The response is either UserPushNotificationGetResponse() or ErrorResponse().
Replaced by: UserPushNotificationRequest24()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPushNotificationGetRequest24(OCIRequest)
Get the push notification settings for a user.
The response is either UserPushNotificationGetResponse24() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserPushNotificationModifyRequest(OCIRequest)
Modify the push notification settings for a user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| send_push_notification_for_click_to_dial | bool | sendPushNotificationForClickToDial Optional |
| send_push_notification_for_group_paging | bool | sendPushNotificationForGroupPaging Optional |
UserPushNotificationRegistrationDeleteRequest(OCIRequest)
Request to remove a push notification registration.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| registration_id | str | registrationId |
UserPushNotificationRegistrationGetListRequest(OCIRequest)
Request a table containing all of the push notification registrations for a user by either registration id or user id.
The response is either UserPushNotificationRegistrationGetListResponse() or
ErrorResponse(). Replaced by:
UserPushNotificationRegistrationGetListRequest21sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| registration_id | str | registrationId Optional |
| user_id | str | userId Optional |
UserPushNotificationRegistrationGetListRequest21sp1(OCIRequest)
Request a list of all of the push notification registrations for a user by either registration id or user id.
The response is either UserPushNotificationRegistrationGetListResponse21sp1() or
ErrorResponse(). Replaced by: UserPushNotificationRegistrationGetListRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| registration_id | str | registrationId Optional |
| user_id | str | userId Optional |
UserPushNotificationRegistrationGetListRequest22(OCIRequest)
Request a list of all of the push notification registrations for a user by either registration id or user id.
The response is either UserPushNotificationRegistrationGetListResponse22() or
ErrorResponse(). Replaced by: UserPushNotificationRegistrationGetListRequest23()
Attributes:
| Name | Type | Description |
|---|---|---|
| registration_id | str | registrationId Optional |
| user_id | str | userId Optional |
UserPushNotificationRegistrationGetListRequest23(OCIRequest)
Request a list of all of the push notification registrations for a user by either registration id or user id.
The response is either UserPushNotificationRegistrationGetListResponse23() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| registration_id | str | registrationId Optional |
| user_id | str | userId Optional |
UserPushToTalkGetRequest(OCIRequest)
Request the push to talk service setting.
The response is either a UserPushToTalkGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserRemoteOfficeGetRequest(OCIRequest)
Request the user level data associated with Remote Office.
The response is either a UserRemoteOfficeGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserRemoteOfficeModifyRequest(OCIRequest)
Modify the user level data associated with Remote Office.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| remote_office_phone_number | str | remoteOfficePhoneNumber Optional |
UserResourcePriorityGetRequest(OCIRequest)
Get the Resource Priority settings of a user.
The response is either UserResourcePriorityGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserResourcePriorityModifyRequest(OCIRequest)
Modify the Resource Priority settings of a user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_default_resource_priority | bool | useDefaultResourcePriority Optional |
| user_resource_priority | str | userResourcePriority Optional |
UserRouteListGetRequest(OCIRequest)
Get the route list setting and the list of number ranges assigned to a user.
The response is either UserRouteListGetResponse() or ErrorResponse(). Replaced by:
UserRouteListGetRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserRouteListGetRequest22(OCIRequest)
Get the route list setting and the list of number ranges assigned to a user.
The response is either UserRouteListGetResponse22() or ErrorResponse(). Replaced
by: UserRouteListGetRequest24()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserRouteListGetRequest24(OCIRequest)
Get the route list setting and the list of number ranges assigned to a user.
The response is either UserRouteListGetResponse24() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserRoutePointCallDispositionCodeGetAvailableListRequest(OCIRequest)
Get the list of available Route Point Call Disposition Codes to be used by a client.
The response is either UserRoutePointCallDispositionCodeGetAvailableListResponse()
or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
UserRoutePointSupervisorGetListRequest(OCIRequest)
Get a list of Route Point supervisors assigned to a user.
The response is either a UserRoutePointSupervisorGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSMDIMessageDeskAddServerRequest(OCIRequest)
Request to add a SMDI Server for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| device_name | str | deviceName |
| net_address | str | netAddress |
| port | int | port |
UserSMDIMessageDeskDeleteServerListRequest(OCIRequest)
Request to delete a list of SMDI Servers for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| device_name | List[str] | deviceName |
UserSMDIMessageDeskGetRequest(OCIRequest)
Get the user's SMDI Message Desk service personal setting.
The response is either a UserSMDIMessageDeskGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSMDIMessageDeskGetServerListRequest(OCIRequest)
Request to get a list of SMDI Servers defined for a user.
The response is either a UserSMDIMessageDeskGetServerListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSMDIMessageDeskModifyRequest(OCIRequest)
Modify the user's SMDI Message Desk service setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| message_desk_number | str | messageDeskNumber Optional |
UserScheduleAddRequest(OCIRequest)
Add a user schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| schedule_name | str | scheduleName |
| schedule_type | str | scheduleType |
UserScheduleGetListRequest(OCIRequest)
Get the list of a user schedules.
The list can be filtered by schedule type.
The response is either a UserScheduleGetListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| schedule_type | str | scheduleType Optional |
UserScheduleGetListRequest17sp1(OCIRequest)
Get the list of schedules viewable by a User.
The list can be filtered by schedule type.
The response is either a UserScheduleGetListResponse17sp1() or an ErrorResponse().
This command is authorized to user who is Executive-Assistant of the Executive.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| schedule_type | str | scheduleType Optional |
UserSecurityClassificationGetRequest(OCIRequest)
Get a user's Security Classifications configuration.
The response is either UserSecurityClassificationGetResponse() or ErrorResponse().
Replaced By: UserSecurityClassificationGetRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSecurityClassificationGetRequest22(OCIRequest)
Get a user's Security Classifications configuration.
The response is either UserSecurityClassificationGetResponse22() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSecurityClassificationModifyRequest(OCIRequest)
Modify a user's Security Classification configuration The response is either a
SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| security_classification | str | securityClassification |
UserSelectiveCallAcceptanceDeleteCriteriaRequest(OCIRequest)
Delete a criteria from the user's selective call acceptance service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserSelectiveCallAcceptanceGetCriteriaListRequest(OCIRequest)
Get the user's selective call acceptance criteria listing.
The response is either a UserSelectiveCallAcceptanceGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSelectiveCallAcceptanceGetCriteriaRequest(OCIRequest)
Get a criteria for the user's selective call acceptance service.
The response is either a UserSelectiveCallAcceptanceGetCriteriaResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserSelectiveCallAcceptanceGetCriteriaRequest16(OCIRequest)
Get a criteria for the user's selective call acceptance service.
The response is either a UserSelectiveCallAcceptanceGetCriteriaResponse16() or an
ErrorResponse(). Replaced by: UserSelectiveCallAcceptanceGetCriteriaRequest21() in
AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserSelectiveCallAcceptanceGetCriteriaRequest21(OCIRequest)
Get a criteria for the user's selective call acceptance service.
The response is either a UserSelectiveCallAcceptanceGetCriteriaResponse21() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserSelectiveCallRejectionDeleteCriteriaRequest(OCIRequest)
Delete a criteria from the user's selective call rejection service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserSelectiveCallRejectionGetCriteriaListRequest(OCIRequest)
Get the user's selective call rejection criteria listing.
The response is either a UserSelectiveCallRejectionGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSelectiveCallRejectionGetCriteriaRequest(OCIRequest)
Get a criteria for the user's selective call rejection service.
The response is either a UserSelectiveCallRejectionGetCriteriaResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserSelectiveCallRejectionGetCriteriaRequest16(OCIRequest)
Get a criteria for the user's selective call rejection service.
The response is either a UserSelectiveCallRejectionGetCriteriaResponse16() or an
ErrorResponse(). Replaced by: UserSelectiveCallRejectionGetCriteriaRequest16sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserSelectiveCallRejectionGetCriteriaRequest16sp1(OCIRequest)
Get a criteria for the user's selective call rejection service.
The response is either a UserSelectiveCallRejectionGetCriteriaResponse16sp1() or an
ErrorResponse(). Replaced by: UserSelectiveCallRejectionGetCriteriaRequest21() in
AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserSelectiveCallRejectionGetCriteriaRequest21(OCIRequest)
Get a criteria for the user's selective call rejection service.
The response is either a UserSelectiveCallRejectionGetCriteriaResponse21() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserSequentialRingDeleteCriteriaRequest(OCIRequest)
Delete a criteria from the user's sequential ring service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserSequentialRingGetCriteriaRequest(OCIRequest)
Get a criteria for the user's sequential ring service.
The response is either a UserSequentialRingGetCriteriaResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserSequentialRingGetCriteriaRequest16(OCIRequest)
Get a criteria for the user's sequential ring service.
The response is either a UserSequentialRingGetCriteriaResponse16() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserSequentialRingGetCriteriaRequest23(OCIRequest)
Get a criteria for the user's sequential ring service.
The response is either a UserSequentialRingGetCriteriaResponse23() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserSequentialRingGetRequest13mp16(OCIRequest)
Get the user's sequential ring service setting.
The response is either a UserSequentialRingGetResponse13mp16() or an
ErrorResponse().
Replaced By: UserSequentialRingGetRequest14sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSequentialRingGetRequest14sp4(OCIRequest)
Get the user's sequential ring service setting.
The response is either a UserSequentialRingGetResponse14sp4() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSeriesCompletionGetRequest(OCIRequest)
Gets the details of the Series Completion group that a user belongs to (if any).
Any user can only belong to one Series Completion group.
The response is either UserSeriesCompletionGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserServiceAssignListRequest(OCIRequest)
Request to assign the user services and service packs for a user.
The response is either a SuccessResponse() or an ErrorResponse(). In AS data mode,
a Warning ErrorResponse() is sent when the transaction is partially successful while
an Error ErrorResponse() is sent when the transaction fails for all the services.
In XS data mode, a Warning ErrorResponse() is always sent when there is at least one
error.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| service_name | List[str] | serviceName Optional |
| service_pack_name | List[str] | servicePackName Optional |
UserServiceGetAssignmentListRequest(OCIRequest)
Requests the user's service and service pack assignment list with status.
The response is either UserServiceGetAssignmentListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserServiceIsAssignedRequest(OCIRequest)
Request to determine if a UserService or service pack is assigned to the user.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| service_name | str | serviceName Optional |
| service_pack_name | str | servicePackName Optional |
UserServiceUnassignListRequest(OCIRequest)
Requests to unassign the user services and service packs for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| service_name | List[str] | serviceName Optional |
| service_pack_name | List[str] | servicePackName Optional |
UserShInterfaceGetUserIdDataRequest(OCIRequest)
Returns the Sh non-transparent data stored against a userId.
The response is either a UserShInterfaceGetUserIdDataResponse() or an
ErrorResponse(). Replaced by: UserShInterfaceGetUserIdDataRequest21sp1() in AS
data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserShInterfaceGetUserIdDataRequest21sp1(OCIRequest)
Returns the Sh non-transparent data stored against a userId.
The response is either a UserShInterfaceGetUserIdDataResponse21sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSharedCallAppearanceGetRequest14(OCIRequest)
Get the user's Shared Call Appearance service setting.
The response is either a UserSharedCallAppearanceGetResponse14() or an
ErrorResponse().
Replaced By: UserSharedCallAppearanceGetRequest14sp2()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSharedCallAppearanceGetRequest14sp2(OCIRequest)
Get the user's Shared Call Appearance service setting.
The response is either a UserSharedCallAppearanceGetResponse14sp2() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSharedCallAppearanceGetRequest16sp2(OCIRequest)
Get the user's Shared Call Appearance service setting.
The response is either a UserSharedCallAppearanceGetResponse16sp2() or an
ErrorResponse(). Replaced by: UserSharedCallAppearanceGetRequest21sp1().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSharedCallAppearanceGetRequest21sp1(OCIRequest)
Get the user's Shared Call Appearance service setting.
The response is either a UserSharedCallAppearanceGetResponse21sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSharedCallAppearanceModifyRequest(OCIRequest)
Modify the user's Shared Call Appearance service setting.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in XS data mode and ignored in AS data mode:
useUserPrimaryWithAlternateCallsSetting allowSimultaneousPrimaryAndAlternate
restrictCallRetrieveOfPrimary restrictCallBridgingOfPrimary
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| alert_all_appearances_for_click_to_dial_calls | bool | alertAllAppearancesForClickToDialCalls Optional |
| alert_all_appearances_for_group_paging_calls | bool | alertAllAppearancesForGroupPagingCalls Optional |
| allow_sca_call_retrieve | bool | allowSCACallRetrieve Optional |
| multiple_call_arrangement_is_active | bool | multipleCallArrangementIsActive Optional |
| allow_bridging_between_locations | bool | allowBridgingBetweenLocations Optional |
| bridge_warning_tone | str | bridgeWarningTone Optional |
| enable_call_park_notification | bool | enableCallParkNotification Optional |
| use_user_primary_with_alternate_calls_setting | bool | useUserPrimaryWithAlternateCallsSetting Optional |
| allow_simultaneous_primary_and_alternate_calls | bool | allowSimultaneousPrimaryAndAlternateCalls Optional |
| restrict_call_retrieve_of_primary_call | bool | restrictCallRetrieveOfPrimaryCall Optional |
| restrict_call_bridging_of_primary_call | bool | restrictCallBridgingOfPrimaryCall Optional |
UserSilentAlertingGetRequest(OCIRequest)
Request the user level data associated with Silent Alerting service.
The response is either a UserSilentAlertingGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSilentAlertingModifyRequest(OCIRequest)
Modify the user level data associated with Silent Alerting service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
UserSimultaneousRingFamilyAddPhoneNumberRequest(OCIRequest)
Add a new phone number and set the answer confirmation setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
| answer_confirmation_required | bool | answerConfirmationRequired |
UserSimultaneousRingFamilyDeleteCriteriaRequest(OCIRequest)
Delete a criteria from the user's simultaneous ring family service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserSimultaneousRingFamilyDeletePhoneNumberRequest(OCIRequest)
Delete the phone number specified.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
UserSimultaneousRingFamilyGetCriteriaRequest(OCIRequest)
Get a criteria for the user's simultaneous ring family service.
The response is either a UserSimultaneousRingFamilyGetCriteriaResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserSimultaneousRingFamilyGetPhoneNumberRequest(OCIRequest)
Get the answer confirmation setting for the phone number specified.
The response is either a UserSimultaneousRingFamilyGetPhoneNumberResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
UserSimultaneousRingFamilyGetRequest(OCIRequest)
Get the user's simultaneous ring service family setting.
The response is either a UserSimultaneousRingFamilyGetResponse() or an
ErrorResponse().
Replaced By: UserSimultaneousRingFamilyGetRequest14sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSimultaneousRingFamilyGetRequest14sp4(OCIRequest)
Get the user's simultaneous ring service Family setting.
The response is either a UserSimultaneousRingFamilyGetResponse14sp4() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSimultaneousRingFamilyGetRequest17(OCIRequest)
Get the user's simultaneous ring family service setting.
The response is either a UserSimultaneousRingFamilyGetResponse17() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSimultaneousRingFamilyModifyPhoneNumberRequest(OCIRequest)
Modify the require confirmation setting for the destination.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
| answer_confirmation_required | bool | answerConfirmationRequired Optional |
UserSimultaneousRingFamilyModifyRequest14sp4(OCIRequest)
Modify the user's simultaneous ring family service setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| incoming_calls | str | incomingCalls Optional |
UserSimultaneousRingPersonalAddPhoneNumberRequest(OCIRequest)
Add a new phone number and set the answer confirmation setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
| answer_confirmation_required | bool | answerConfirmationRequired |
UserSimultaneousRingPersonalDeleteCriteriaRequest(OCIRequest)
Delete a criteria from the user's simultaneous ring personal service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserSimultaneousRingPersonalDeletePhoneNumberRequest(OCIRequest)
Delete the phone number specified.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
UserSimultaneousRingPersonalGetCriteriaRequest(OCIRequest)
Get a criteria for the user's simultaneous ring personal service.
The response is either a UserSimultaneousRingPersonalGetCriteriaResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
UserSimultaneousRingPersonalGetPhoneNumberRequest(OCIRequest)
Get the answer confirmation setting for the phone number specified.
The response is either a UserSimultaneousRingPersonalGetPhoneNumberResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
UserSimultaneousRingPersonalGetRequest(OCIRequest)
Get the user's simultaneous ring service personal setting.
The response is either a UserSimultaneousRingPersonalGetResponse() or an
ErrorResponse().
Replaced By: UserSimultaneousRingPersonalGetRequest14sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSimultaneousRingPersonalGetRequest14sp4(OCIRequest)
Get the user's simultaneous ring service personal setting.
The response is either a UserSimultaneousRingPersonalGetResponse14sp4() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSimultaneousRingPersonalGetRequest17(OCIRequest)
Get the user's simultaneous ring personal service setting.
The response is either a UserSimultaneousRingPersonalGetResponse17() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSimultaneousRingPersonalModifyPhoneNumberRequest(OCIRequest)
Modify the require confirmation setting for the destination.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
| answer_confirmation_required | bool | answerConfirmationRequired Optional |
UserSimultaneousRingPersonalModifyRequest14sp4(OCIRequest)
Modify the user's simultaneous ring personal service setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| incoming_calls | str | incomingCalls Optional |
UserSingleSignOnCreateDeviceTokenRequest(OCIRequest)
This command allows a BroadWorks or Third-Party Client Application to create a Single Sign-On token for a device of a user.
The token is created only if: 1. the specified user is the owner of a lineport on the specified device (including a trunk user on a trunk device). 2. and, the specified device is not in locked state. 3. and, the device type of the device does support Device Management.
The response is either UserSingleSignOnCreateDeviceTokenResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| device_level | str | deviceLevel |
| device_name | str | deviceName |
UserSpeedDial100DeleteListRequest(OCIRequest)
Delete one or more speed dial 100 settings for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| speed_code | List[int] | speedCode Optional |
UserSpeedDial100GetListRequest(OCIRequest)
Get the speed dial 100 settings for a user.
The response is either a UserSpeedDial100GetListResponse() or an ErrorResponse().
Replaced by: UserSpeedDial100GetListRequest17Sp1
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSpeedDial100GetListRequest17sp1(OCIRequest)
Get the speed dial 100 settings for a user.
The response is either a UserSpeedDial100GetListResponse17sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserSpeedDial100GetRequest(OCIRequest)
Get speed dial 100 settings for a speed code.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| speed_code | int | speedCode |
UserSpeedDial8GetListRequest(OCIRequest)
Get the speed dial 8 settings for a user.
The response is either a UserSpeedDial8GetListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserTerminatingAlternateTrunkIdentityGetRequest(OCIRequest)
Request the user level data associated with Terminating Alternate Trunk Identity.
The response is either a UserTerminatingAlternateTrunkIdentityGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserTerminatingAlternateTrunkIdentityModifyRequest(OCIRequest)
Modify the user level data associated with Terminating Alternate Trunk Identity.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| terminating_trunk_identity | str | terminatingTrunkIdentity Optional |
UserTerminatingClosedUserGroupGetRequest(OCIRequest)
Get user Terminating CUG service settings.
The response is either UserTerminatingClosedUserGroupGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserTerminatingClosedUserGroupModifyRequest(OCIRequest)
Modify user Terminating CUG service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| user_interlock_code | str | userInterlockCode Optional |
UserThirdPartyVoiceMailSupportGetRequest13mp16(OCIRequest)
Request the user level data associated with Third-Party Voice Mail Support.
The response is either a UserThirdPartyVoiceMailSupportGetResponse13mp16() or an
ErrorResponse(). Replaced by: UserThirdPartyVoiceMailSupportGetRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserThirdPartyVoiceMailSupportGetRequest17(OCIRequest)
Request the user level data associated with Third-Party Voice Mail Support.
The response is either a UserThirdPartyVoiceMailSupportGetResponse17() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserThirdPartyVoiceMailSupportModifyRequest(OCIRequest)
Modify the Third Party Voice Mail Support settings for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| busy_redirect_to_voice_mail | bool | busyRedirectToVoiceMail Optional |
| no_answer_redirect_to_voice_mail | bool | noAnswerRedirectToVoiceMail Optional |
| server_selection | str | serverSelection Optional |
| user_server | str | userServer Optional |
| mailbox_id_type | str | mailboxIdType Optional |
| mailbox_url | str | mailboxURL Optional |
| no_answer_number_of_rings | int | noAnswerNumberOfRings Optional |
| always_redirect_to_voice_mail | bool | alwaysRedirectToVoiceMail Optional |
| out_of_primary_zone_redirect_to_voice_mail | bool | outOfPrimaryZoneRedirectToVoiceMail Optional |
UserTimeScheduleDeleteRequest(OCIRequest)
Delete a user time schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| time_schedule_name | str | timeScheduleName |
UserTimeScheduleGetListRequest(OCIRequest)
Get all time schedules for a user.
This includes the user's personal schedules and user's group's schedules.
The response is either a UserTimeScheduleGetListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserTimeScheduleGetRequest(OCIRequest)
Request to get a user time schedule.
The response is either a UserTimeScheduleGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| time_schedule_name | str | timeScheduleName |
UserTwoStageDialingModifyRequest(OCIRequest)
Modify the user level data associated with Two Stage Dialing.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| allow_activation_with_user_addresses | bool | allowActivationWithUserAddresses Optional |
UserVideoAddOnGetRequest14(OCIRequest)
Get the user's Video Add-On service setting.
The response is either a UserVideoAddOnGetResponse14() or an ErrorResponse().
Replaced by: UserVideoAddOnGetRequest19().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVideoAddOnGetRequest19(OCIRequest)
Get the user's Video Add-On service setting.
The response is either a UserVideoAddOnGetResponse19() or an ErrorResponse().
Replaced by: UserVideoAddOnGetRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVideoAddOnGetRequest22(OCIRequest)
Get the user's Video Add-On service setting.
The response is either a UserVideoAddOnGetResponse22() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoiceMessagingUserAddAliasListRequest(OCIRequest)
Add one or more voice mail aliases to a users voice message.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | List[str] | phoneNumber |
UserVoiceMessagingUserDeleteAliasListRequest(OCIRequest)
Delete one or more voice mail aliases from a users voice message.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | List[str] | phoneNumber |
UserVoiceMessagingUserGetAdvancedVoiceManagementRequest(OCIRequest)
Get the user's voice messaging advanced voice management service setting.
The response is either a UserVoiceMessagingUserGetAdvancedVoiceManagementResponse()
or an ErrorResponse().
Replaced By: UserVoiceMessagingUserGetAdvancedVoiceManagementRequest14sp3()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoiceMessagingUserGetAdvancedVoiceManagementRequest14sp3(OCIRequest)
Get the user's voice messaging advanced voice management service setting.
The response is either a
UserVoiceMessagingUserGetAdvancedVoiceManagementResponse14sp3() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoiceMessagingUserGetAliasListRequest(OCIRequest)
Get the voice mail aliases for a users voice message.
The response is either a UserVoiceMessagingUserGetAliasListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoiceMessagingUserGetDistributionListRequest(OCIRequest)
Get a voice mail distribution list for a users voice message.
The response is either UserVoiceMessagingUserGetDistributionListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| list_id | int | listId |
UserVoiceMessagingUserGetGreetingRequest13mp16(OCIRequest)
Get the user's voice messaging greeting information.
The response is either a UserVoiceMessagingUserGetGreetingResponse13mp16() or an
ErrorResponse().
Replaced By: UserVoiceMessagingUserGetGreetingRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoiceMessagingUserGetGreetingRequest16(OCIRequest)
Get the user's voice messaging greeting information.
The response is either a UserVoiceMessagingUserGetGreetingResponse16() or an
ErrorResponse(). Replaced by: UserVoiceMessagingUserGetGreetingRequest18()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoiceMessagingUserGetGreetingRequest18(OCIRequest)
Get the user's voice messaging greeting information.
The response is either a UserVoiceMessagingUserGetGreetingResponse18() or an
ErrorResponse(). Replaced by UserVoiceMessagingUserGetGreetingRequest18sp1() in AS
data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoiceMessagingUserGetGreetingRequest18sp1(OCIRequest)
Get the user's voice messaging greeting information.
The response is either a UserVoiceMessagingUserGetGreetingResponse18sp1() or an
ErrorResponse(). Replaced by: UserVoiceMessagingUserGetGreetingRequest20() in AS
data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoiceMessagingUserGetGreetingRequest20(OCIRequest)
Get the user's voice messaging greeting information.
The response is either a UserVoiceMessagingUserGetGreetingResponse20() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoiceMessagingUserGetOutgoingSMDIMWIRequest(OCIRequest)
Get the user's voice messaging outgoing SMDI message waiting indicator service setting.
The response is either a UserVoiceMessagingUserGetOutgoingSMDIMWIResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoiceMessagingUserGetVoiceManagementRequest13mp8(OCIRequest)
Get the user's voice messaging voice management service settings.
The response is either a UserVoiceMessagingUserGetVoiceManagementResponse13mp8() or
an ErrorResponse(). Replaced by:
UserVoiceMessagingUserGetVoiceManagementRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoiceMessagingUserGetVoiceManagementRequest17(OCIRequest)
Get the user's voice messaging voice management service settings.
The response is either a UserVoiceMessagingUserGetVoiceManagementResponse17() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoiceMessagingUserGetVoiceManagementRequest23(OCIRequest)
Get the user's voice messaging voice management service settings.
The response is either a UserVoiceMessagingUserGetVoiceManagementResponse23() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoiceMessagingUserGetVoicePortalPasswordInfoRequest(OCIRequest)
Request the user's voice portal password information.
The response is either a UserVoiceMessagingUserGetVoicePortalPasswordInfoResponse()
or an ErrorResponse().
Replaced By: UserPortalPasscodeGetInfoRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoiceMessagingUserGetVoicePortalRequest(OCIRequest)
Get the user's voice messaging voice portal settings.
The response is either a UserVoiceMessagingUserGetVoicePortalResponse() or an
ErrorResponse().
Replaced By: UserVoiceMessagingUserGetVoicePortalRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoiceMessagingUserGetVoicePortalRequest16(OCIRequest)
Get the user's voice messaging voice portal settings.
The response is either a UserVoiceMessagingUserGetVoicePortalResponse16() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoiceMessagingUserGetVoicePortalRequest20(OCIRequest)
Get the user's voice messaging voice portal settings.
The response is either a UserVoiceMessagingUserGetVoicePortalResponse20() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoiceMessagingUserModifyAdvancedVoiceManagementRequest(OCIRequest)
Modify the user's voice messaging advanced voice management service setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mail_server_selection | str | mailServerSelection Optional |
| group_mail_server_email_address | str | groupMailServerEmailAddress Optional |
| group_mail_server_user_id | str | groupMailServerUserId Optional |
| group_mail_server_password | str | groupMailServerPassword Optional |
| use_group_default_mail_server_full_mailbox_limit | bool | useGroupDefaultMailServerFullMailboxLimit Optional |
| group_mail_server_full_mailbox_limit | int | groupMailServerFullMailboxLimit Optional |
| personal_mail_server_net_address | str | personalMailServerNetAddress Optional |
| personal_mail_server_protocol | str | personalMailServerProtocol Optional |
| personal_mail_server_real_delete_for_imap | bool | personalMailServerRealDeleteForImap Optional |
| personal_mail_server_email_address | str | personalMailServerEmailAddress Optional |
| personal_mail_server_user_id | str | personalMailServerUserId Optional |
| personal_mail_server_password | str | personalMailServerPassword Optional |
UserVoiceMessagingUserModifyVoiceManagementRequest(OCIRequest)
Modify the user's voice messaging voice management service setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| processing | str | processing Optional |
| voice_message_delivery_email_address | str | voiceMessageDeliveryEmailAddress Optional |
| use_phone_message_waiting_indicator | bool | usePhoneMessageWaitingIndicator Optional |
| send_voice_message_notify_email | bool | sendVoiceMessageNotifyEmail Optional |
| voice_message_notify_email_address | str | voiceMessageNotifyEmailAddress Optional |
| send_carbon_copy_voice_message | bool | sendCarbonCopyVoiceMessage Optional |
| voice_message_carbon_copy_email_address | str | voiceMessageCarbonCopyEmailAddress Optional |
| transfer_on_zero_to_phone_number | bool | transferOnZeroToPhoneNumber Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| always_redirect_to_voice_mail | bool | alwaysRedirectToVoiceMail Optional |
| busy_redirect_to_voice_mail | bool | busyRedirectToVoiceMail Optional |
| no_answer_redirect_to_voice_mail | bool | noAnswerRedirectToVoiceMail Optional |
| out_of_primary_zone_redirect_to_voice_mail | bool | outOfPrimaryZoneRedirectToVoiceMail Optional |
UserVoiceMessagingUserModifyVoicePortalPasswordRequest(OCIRequest)
Modify the user's Voice Portal password The response is either a SuccessResponse()
or an ErrorResponse().
Engineering Note: This command is used internally by Call Processing.
Replaced By: UserPortalPasscodeModifyRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| old_password | str | oldPassword Optional |
| new_password | str | newPassword |
UserVoicePortalCallingGetRequest(OCIRequest)
Request the user level data associated with Voice Portal Calling.
The response is either a UserVoicePortalCallingGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserVoicePortalCallingModifyRequest(OCIRequest)
Modify the user level data associated with Voice Portal Calling.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
UserXsiPolicyProfileGetRequest(OCIRequest)
Get the user Xsi policy profile.
The response is either a UserXsiPolicyProfileGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserZoneCallingRestrictionsGetRequest(OCIRequest)
Gets the home zone for a user The response is either a
UserZoneCallingRestrictionsGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
UserZoneCallingRestrictionsModifyRequest(OCIRequest)
Modify the home zone for a user The response is either a SuccessResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| home_zone_name | str | homeZoneName Optional |
VerifySessionIsValidRequest(OCIRequest)
Query the provisioning server to verify the session is authorized.
Most applications should not need this command, because the provisioning server verifies the session is authorized for all commands.
The response is either a SuccessResponse() or an ErrorResponse().
EnterpriseCallCenterAgentThresholdProfileModifyRequest(OCIRequest)
Modifies an existing Call Center Agent Threshold Profile in the Enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| profile_name | str | profileName |
| new_profile_name | str | newProfileName Optional |
| profile_description | str | profileDescription Optional |
| threshold_current_call_state_idle_time_yellow | int | thresholdCurrentCallStateIdleTimeYellow Optional |
| threshold_current_call_state_idle_time_red | int | thresholdCurrentCallStateIdleTimeRed Optional |
| threshold_current_call_state_on_call_time_yellow | int | thresholdCurrentCallStateOnCallTimeYellow Optional |
| threshold_current_call_state_on_call_time_red | int | thresholdCurrentCallStateOnCallTimeRed Optional |
| threshold_current_agent_state_unavailable_time_yellow | int | thresholdCurrentAgentStateUnavailableTimeYellow Optional |
| threshold_current_agent_state_unavailable_time_red | int | thresholdCurrentAgentStateUnavailableTimeRed Optional |
| threshold_average_busy_in_time_yellow | int | thresholdAverageBusyInTimeYellow Optional |
| threshold_average_busy_in_time_red | int | thresholdAverageBusyInTimeRed Optional |
| threshold_average_busy_out_time_yellow | int | thresholdAverageBusyOutTimeYellow Optional |
| threshold_average_busy_out_time_red | int | thresholdAverageBusyOutTimeRed Optional |
| threshold_average_wrap_up_time_yellow | int | thresholdAverageWrapUpTimeYellow Optional |
| threshold_average_wrap_up_time_red | int | thresholdAverageWrapUpTimeRed Optional |
| enable_notification_email | bool | enableNotificationEmail Optional |
| notification_email_address_list | OCI.notificationEmailAddressList | notificationEmailAddressList Optional |
| agent_user_id_list | OCI.agentUserIdList | agentUserIdList Optional |
EnterpriseCallCenterAgentUnavailableCodeSettingsModifyRequest(OCIRequest)
Modify the enterprise level data associated with Call Center Agents Unavailable Code Settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| enable_agent_unavailable_codes | bool | enableAgentUnavailableCodes Optional |
| default_agent_unavailable_code_on_dnd | str | defaultAgentUnavailableCodeOnDND Optional |
| default_agent_unavailable_code_on_personal_calls | str | defaultAgentUnavailableCodeOnPersonalCalls Optional |
| default_agent_unavailable_code_on_consecutive_bounces | str | defaultAgentUnavailableCodeOnConsecutiveBounces Optional |
| default_agent_unavailable_code_on_not_reachable | str | defaultAgentUnavailableCodeOnNotReachable Optional |
| force_use_of_agent_unavailable_codes | bool | forceUseOfAgentUnavailableCodes Optional |
| default_agent_unavailable_code | str | defaultAgentUnavailableCode Optional |
| code_state_list | List[OCI.codeStateList] | codeStateList Optional |
EnterpriseCallCenterCallDispositionCodeModifyActiveListRequest(OCIRequest)
Request to set the active status of Call Center Call Disposition Codes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| call_disposition_code_activation | List[OCI.callDispositionCodeActivation] | callDispositionCodeActivation Optional |
EnterpriseCallCenterEnhancedReportingBrandingModifyRequest(OCIRequest)
Request to modify the enterprise branding configuration.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| branding_choice | str | brandingChoice Optional |
| branding_file | OCI.brandingFile | brandingFile Optional |
EnterpriseCallCenterEnhancedReportingReportTemplateAddRequest(OCIRequest)
Request to add an Enterprise level call center report template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| description | str | description Optional |
| data_template | str | dataTemplate |
| filter_number | int | filterNumber Optional |
| xslt_template | OCI.xsltTemplate | xsltTemplate |
| scope | str | scope |
| is_enabled | bool | isEnabled |
| is_realtime_report | bool | isRealtimeReport Optional |
| call_completion_threshold_param | str | callCompletionThresholdParam Optional |
| short_duration_threshold_param | str | shortDurationThresholdParam Optional |
| service_level_threshold_param | str | serviceLevelThresholdParam Optional |
| service_level_inclusions_param | str | serviceLevelInclusionsParam Optional |
| service_level_objective_threshold_param | str | serviceLevelObjectiveThresholdParam Optional |
| abandoned_call_threshold_param | str | abandonedCallThresholdParam Optional |
| service_level_threshold_param_number | int | serviceLevelThresholdParamNumber Optional |
| abandoned_call_threshold_param_number | int | abandonedCallThresholdParamNumber Optional |
| filter_value | List[str] | filterValue Optional |
EnterpriseCallCenterEnhancedReportingReportTemplateModifyRequest(OCIRequest)
Request to modify an enterprise level call center report template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| xslt_template | OCI.xsltTemplate | xsltTemplate Optional |
| scope | str | scope Optional |
| is_enabled | bool | isEnabled Optional |
| is_realtime_report | bool | isRealtimeReport Optional |
| filter_number | int | filterNumber Optional |
| filter_value | OCI.filterValue | filterValue Optional |
EnterpriseCallCenterModifyRoutingPolicyRequest(OCIRequest)
Modify the enterprise call center routing policy.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| routing_policy | str | routingPolicy Optional |
| routing_priority_order | List[OCI.routingPriorityOrder] | routingPriorityOrder Optional |
EnterpriseCommonPhoneListAddListRequest(OCIRequest)
Add one or more entries to an enterprise's common phone list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| entry | List[OCI.entry] | entry |
EnterpriseCommunicationBarringAuthorizationCodeAddListRequest(OCIRequest)
Add a list of Communication Barring Authorization codes to an enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| code | List[OCI.code] | code |
EnterpriseVoiceVPNAddPolicyRequest(OCIRequest)
Add the enterprise level data associated with a Voice VPN location code.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| location_dialing_code | str | locationDialingCode |
| min_extension_length | int | minExtensionLength |
| max_extension_length | int | maxExtensionLength |
| description | str | description Optional |
| route_group_id | str | routeGroupId Optional |
| policy_selection | str | policySelection |
| digit_manipulation | List[OCI.digitManipulation] | digitManipulation Optional |
| treatment_id | str | treatmentId Optional |
EnterpriseVoiceVPNModifyPolicyRequest(OCIRequest)
Modify the enterprise level data associated with a Voice VPN location code.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| location_dialing_code | str | locationDialingCode |
| min_extension_length | int | minExtensionLength Optional |
| max_extension_length | int | maxExtensionLength Optional |
| description | str | description Optional |
| route_group_id | str | routeGroupId Optional |
| policy_selection | str | policySelection Optional |
| digit_manipulation | List[OCI.digitManipulation] | digitManipulation Optional |
| treatment_id | str | treatmentId Optional |
GroupAccessDeviceAddRequest14(OCIRequest)
Request to add a group access device.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
GroupAccessDeviceAddRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| device_type | str | deviceType |
| protocol | str | protocol Optional |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| outbound_proxy_server_net_address | str | outboundProxyServerNetAddress Optional |
| stun_server_net_address | str | stunServerNetAddress Optional |
| mac_address | str | macAddress Optional |
| serial_number | str | serialNumber Optional |
| description | str | description Optional |
| physical_location | str | physicalLocation Optional |
| transport_protocol | str | transportProtocol Optional |
| mobility_manager_provisioning_url | str | mobilityManagerProvisioningURL Optional |
| mobility_manager_provisioning_user_name | str | mobilityManagerProvisioningUserName Optional |
| mobility_manager_provisioning_password | str | mobilityManagerProvisioningPassword Optional |
| mobility_manager_default_originating_service_key | int | mobilityManagerDefaultOriginatingServiceKey Optional |
| mobility_manager_default_terminating_service_key | int | mobilityManagerDefaultTerminatingServiceKey Optional |
| use_custom_user_name_password | bool | useCustomUserNamePassword Optional |
| access_device_credentials | OCI.accessDeviceCredentials | accessDeviceCredentials Optional |
GroupAccessDeviceAddRequest22(OCIRequest)
Request to add a group access device.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: hotlineContact
useHotline groupExternalId deviceExternalId Replaced by:
GroupAccessDeviceAddRequest22V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| device_name | str | deviceName Optional |
| group_external_id | str | groupExternalId Optional |
| device_external_id | str | deviceExternalId Optional |
| device_type | str | deviceType |
| protocol | str | protocol Optional |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| outbound_proxy_server_net_address | str | outboundProxyServerNetAddress Optional |
| stun_server_net_address | str | stunServerNetAddress Optional |
| mac_address | str | macAddress Optional |
| serial_number | str | serialNumber Optional |
| description | str | description Optional |
| physical_location | str | physicalLocation Optional |
| transport_protocol | str | transportProtocol Optional |
| mobility_manager_provisioning_url | str | mobilityManagerProvisioningURL Optional |
| mobility_manager_provisioning_user_name | str | mobilityManagerProvisioningUserName Optional |
| mobility_manager_provisioning_password | str | mobilityManagerProvisioningPassword Optional |
| mobility_manager_default_originating_service_key | int | mobilityManagerDefaultOriginatingServiceKey Optional |
| mobility_manager_default_terminating_service_key | int | mobilityManagerDefaultTerminatingServiceKey Optional |
| use_custom_user_name_password | bool | useCustomUserNamePassword Optional |
| access_device_credentials | OCI.accessDeviceCredentials | accessDeviceCredentials Optional |
| use_hotline | bool | useHotline |
| hotline_contact | str | hotlineContact Optional |
GroupAccessDeviceAddRequest22V2(OCIRequest)
Request to add a group access device.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: groupExternalId
deviceExternalId deviceIPEI
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| device_name | str | deviceName Optional |
| group_external_id | str | groupExternalId Optional |
| device_external_id | str | deviceExternalId Optional |
| device_type | str | deviceType |
| protocol | str | protocol Optional |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| outbound_proxy_server_net_address | str | outboundProxyServerNetAddress Optional |
| stun_server_net_address | str | stunServerNetAddress Optional |
| mac_address | str | macAddress Optional |
| serial_number | str | serialNumber Optional |
| description | str | description Optional |
| physical_location | str | physicalLocation Optional |
| transport_protocol | str | transportProtocol Optional |
| use_custom_user_name_password | bool | useCustomUserNamePassword Optional |
| access_device_credentials | OCI.accessDeviceCredentials | accessDeviceCredentials Optional |
| device_ipei | str | deviceIPEI Optional |
GroupAccessDeviceAvailablePortGetListRequest(OCIRequest)
Request to get the list of available ports in a device.
The response is either GroupAccessDeviceAvailablePortGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| access_device | OCI.accessDevice | accessDevice |
GroupAccessDeviceCustomTagAddOrModifyListRequest(OCIRequest)
Request to add or modify a list of static configuration tag for a group access device.
If the tag does not exist, it is added. If the tag exists, its value is updated.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| tag | List[OCI.tag] | tag |
GroupAccessDeviceFileModifyRequest(OCIRequest)
Request to modify a specified group access device file.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: GroupAccessDeviceFileModifyRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| file_type | str | fileType |
| file_source | str | fileSource Optional |
| upload_file | OCI.uploadFile | uploadFile Optional |
GroupAccessDeviceFileModifyRequest14sp8(OCIRequest)
Request to modify a specified group access device file.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| file_format | str | fileFormat |
| file_source | str | fileSource Optional |
| upload_file | OCI.uploadFile | uploadFile Optional |
| extended_capture_enabled | bool | extendedCaptureEnabled Optional |
GroupAccessDeviceLinkDeviceListRequest(OCIRequest)
Request to link one or more leaf devices to a group level tree device.
A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| leaf_device_key | List[OCI.leafDeviceKey] | leafDeviceKey |
GroupAccessDeviceModifyRequest14(OCIRequest)
Request to modify a specified group access device.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: hotlineContact
useHotline deviceExternalId Replaced by: GroupAccessDeviceModifyRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
| protocol | str | protocol Optional |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| outbound_proxy_server_net_address | str | outboundProxyServerNetAddress Optional |
| stun_server_net_address | str | stunServerNetAddress Optional |
| mac_address | str | macAddress Optional |
| serial_number | str | serialNumber Optional |
| description | str | description Optional |
| configuration_mode | str | configurationMode Optional |
| configuration_file | OCI.configurationFile | configurationFile Optional |
| physical_location | str | physicalLocation Optional |
| transport_protocol | str | transportProtocol Optional |
| mobility_manager_provisioning_url | str | mobilityManagerProvisioningURL Optional |
| mobility_manager_provisioning_user_name | str | mobilityManagerProvisioningUserName Optional |
| mobility_manager_provisioning_password | str | mobilityManagerProvisioningPassword Optional |
| mobility_manager_default_originating_service_key | int | mobilityManagerDefaultOriginatingServiceKey Optional |
| mobility_manager_default_terminating_service_key | int | mobilityManagerDefaultTerminatingServiceKey Optional |
| use_custom_user_name_password | bool | useCustomUserNamePassword Optional |
| access_device_credentials | OCI.accessDeviceCredentials | accessDeviceCredentials Optional |
| hotline_contact | str | hotlineContact Optional |
| use_hotline | bool | useHotline Optional |
GroupAccessDeviceModifyRequest22(OCIRequest)
Request to modify a specified group access device.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: deviceExternalId
deviceIPEI useDeviceCode deviceCode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
| protocol | str | protocol Optional |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| outbound_proxy_server_net_address | str | outboundProxyServerNetAddress Optional |
| stun_server_net_address | str | stunServerNetAddress Optional |
| mac_address | str | macAddress Optional |
| serial_number | str | serialNumber Optional |
| description | str | description Optional |
| configuration_mode | str | configurationMode Optional |
| configuration_file | OCI.configurationFile | configurationFile Optional |
| physical_location | str | physicalLocation Optional |
| transport_protocol | str | transportProtocol Optional |
| use_custom_user_name_password | bool | useCustomUserNamePassword Optional |
| access_device_credentials | OCI.accessDeviceCredentials | accessDeviceCredentials Optional |
| device_ipei | str | deviceIPEI Optional |
| use_device_code | bool | useDeviceCode Optional |
| device_code | str | deviceCode Optional |
GroupAccessDeviceUnlinkDeviceListRequest(OCIRequest)
Request to unlink one or more leaf access devices from a tree device.
A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| leaf_device_key | List[OCI.leafDeviceKey] | leafDeviceKey |
GroupAccountAuthorizationCodesAddListRequest(OCIRequest)
Add a list of account/authorization codes to a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| code_entry | List[OCI.codeEntry] | codeEntry |
GroupAccountAuthorizationCodesModifyRequest(OCIRequest)
Change the group's account/authorization codes setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| code_type | str | codeType Optional |
| number_of_digits | int | numberOfDigits Optional |
| allow_local_and_toll_free_calls | bool | allowLocalAndTollFreeCalls Optional |
| mandatory_usage_user_id_list | OCI.mandatoryUsageUserIdList | mandatoryUsageUserIdList Optional |
| optional_usage_user_id_list | OCI.optionalUsageUserIdList | optionalUsageUserIdList Optional |
GroupAddRequest(OCIRequest)
Add a group.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are ignored in AS and XS data mode: servicePolicy, callProcessingSliceId,
provisioningSliceId, subscriberPartition. The following elements are only used in XS
data mode and ignored in AS mode: preferredDataCenter. Only Provisioning admin and
above can change the preferredDataCenter. The following elements are only used in XS
data mode and ignored AS data mode: defaultUserCallingLineIdPhoneNumber. Replaced by:
GroupConsolidatedAddRequest() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| default_domain | str | defaultDomain |
| user_limit | int | userLimit |
| group_name | str | groupName Optional |
| calling_line_id_name | str | callingLineIdName Optional |
| time_zone | str | timeZone Optional |
| location_dialing_code | str | locationDialingCode Optional |
| contact | OCI.contact | contact Optional |
| address | OCI.address | address Optional |
| service_policy | str | servicePolicy Optional |
| call_processing_slice_id | str | callProcessingSliceId Optional |
| provisioning_slice_id | str | provisioningSliceId Optional |
| subscriber_partition | str | subscriberPartition Optional |
| preferred_data_center | str | preferredDataCenter Optional |
| default_user_calling_line_id_phone_number | str | defaultUserCallingLineIdPhoneNumber Optional |
GroupAnnouncementFileAddRequest(OCIRequest)
Add an announcement to the group announcement repository The following elements are
only used in AS data mode and ignored in XS data mode: groupExternalId
announcementFileExternalId The response is either a SuccessResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| announcement_file_name | str | announcementFileName Optional |
| group_external_id | str | groupExternalId Optional |
| announcement_file_external_id | str | announcementFileExternalId Optional |
| announcement_file | OCI.announcementFile | announcementFile |
GroupAnnouncementFileDeleteListRequest(OCIRequest)
Delete one or more announcements from the group announcement repository The following
elements are only used in AS data mode and ignored in XS data mode: groupExternalId
announcementFileExternalId The response is either a SuccessResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| announcement_file_key | List[OCI.announcementFileKey] | announcementFileKey Optional |
| group_external_id | str | groupExternalId Optional |
| announcement_file_external_id | List[str] | announcementFileExternalId Optional |
GroupAnnouncementFileGetRequest(OCIRequest)
Request to get the announcement repository file information.
The response is either GroupAnnouncementFileGetResponse() or ErrorResponse().
Replaced by: GroupAnnouncementFileGetRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| announcement_file_key | OCI.announcementFileKey | announcementFileKey |
GroupAnnouncementFileGetRequest22(OCIRequest)
Request to get the announcement repository file information.
The following elements are only used in AS data mode and ignored in XS data mode: announcementFileExternalId
The response is either GroupAnnouncementFileGetResponse22() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| announcement_file_key | OCI.announcementFileKey | announcementFileKey Optional |
| announcement_file_external_id | str | announcementFileExternalId Optional |
GroupAnnouncementFileModifyRequest(OCIRequest)
Modify an existing announcement in the group repository The following elements are
only used in AS data mode and ignored in XS data mode: announcementFileExternalId The
response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| announcement_file_key | OCI.announcementFileKey | announcementFileKey Optional |
| announcement_file_external_id | str | announcementFileExternalId Optional |
| new_announcement_file_name | str | newAnnouncementFileName Optional |
| announcement_file | OCI.announcementFile | announcementFile Optional |
GroupAutoAttendantModifyActiveInstanceListRequest(OCIRequest)
Request to set the active status of Auto Attendant instances.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_activation | List[OCI.serviceActivation] | serviceActivation Optional |
GroupBroadWorksAnywhereModifyActiveInstanceListRequest(OCIRequest)
Request to set the active status of BroadWorks Anywhere instances.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_activation | List[OCI.serviceActivation] | serviceActivation Optional |
GroupBroadWorksMobilityModifyRequest(OCIRequest)
Modify the group level broadworks mobility service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_setting_level | str | useSettingLevel Optional |
| enable_location_services | bool | enableLocationServices Optional |
| enable_msrn_lookup | bool | enableMSRNLookup Optional |
| enable_mobile_state_checking | bool | enableMobileStateChecking Optional |
| deny_call_originations | bool | denyCallOriginations Optional |
| deny_call_terminations | bool | denyCallTerminations Optional |
| enable_announcement_suppression | bool | enableAnnouncementSuppression Optional |
| enable_internal_clid_delivery | bool | enableInternalCLIDDelivery Optional |
| enable_internal_clid_delivery_access_locations | bool | enableInternalCLIDDeliveryAccessLocations Optional |
| enable_enhanced_unreachable_state_checking | bool | enableEnhancedUnreachableStateChecking Optional |
| enable_network_call_barring_status_check | bool | enableNetworkCallBarringStatusCheck Optional |
| network_translation_index | str | networkTranslationIndex Optional |
| enable_pbx_route_policy | bool | enablePBXRoutePolicy Optional |
| pbx_route_identity | OCI.pbxRouteIdentity | pbxRouteIdentity Optional |
GroupCPEConfigSetConfigFileRequest(OCIRequest)
Request to set a new group default configuration file for a device type.
The response is either a SuccessResponse() or an ErrorResponse(). When the element
configFile is set to nil, the configuration file defined at the parent level is used.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
| config_file | OCI.configFile | configFile |
GroupCallCapacityManagementModifyInstanceRequest(OCIRequest)
Modifies a Call Capacity Management group.
Replaces the entire list of users in the group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| new_name | str | newName Optional |
| max_active_calls_allowed | int | maxActiveCallsAllowed Optional |
| max_incoming_active_calls_allowed | int | maxIncomingActiveCallsAllowed Optional |
| max_outgoing_active_calls_allowed | int | maxOutgoingActiveCallsAllowed Optional |
| become_default_group_for_new_users | bool | becomeDefaultGroupForNewUsers Optional |
| user_id_list | OCI.userIdList | userIdList Optional |
GroupCallCenterAddAgentListRequest(OCIRequest)
Add agent(s) to a call center.
The response is either SuccessResponse() or ErrorResponse(). If the skill level is
not present for skill based premium call centers, the users will be set to skill level
1. The following element is only used in AS data mode and ignored in XS data mode:
agentSkillList
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| agent_user_id | List[str] | agentUserId Optional |
| agent_skill_list | List[OCI.agentSkillList] | agentSkillList Optional |
GroupCallCenterAddDNISRequest(OCIRequest)
Add a Call Center DNIS The response is either a SuccessResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
| dnis_phone_number | str | dnisPhoneNumber Optional |
| extension | str | extension Optional |
| use_custom_clid_settings | bool | useCustomCLIDSettings |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| calling_line_id_last_name | str | callingLineIdLastName Optional |
| calling_line_id_first_name | str | callingLineIdFirstName Optional |
| use_custom_dnis_announcement_settings | bool | useCustomDnisAnnouncementSettings |
| priority | str | priority |
| allow_outgoing_acd_call | bool | allowOutgoingACDCall |
GroupCallCenterAgentThresholdProfileModifyRequest(OCIRequest)
Modifies an existing Call Center Agent Threshold Profile in the Group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| profile_name | str | profileName |
| new_profile_name | str | newProfileName Optional |
| profile_description | str | profileDescription Optional |
| threshold_current_call_state_idle_time_yellow | int | thresholdCurrentCallStateIdleTimeYellow Optional |
| threshold_current_call_state_idle_time_red | int | thresholdCurrentCallStateIdleTimeRed Optional |
| threshold_current_call_state_on_call_time_yellow | int | thresholdCurrentCallStateOnCallTimeYellow Optional |
| threshold_current_call_state_on_call_time_red | int | thresholdCurrentCallStateOnCallTimeRed Optional |
| threshold_current_agent_state_unavailable_time_yellow | int | thresholdCurrentAgentStateUnavailableTimeYellow Optional |
| threshold_current_agent_state_unavailable_time_red | int | thresholdCurrentAgentStateUnavailableTimeRed Optional |
| threshold_average_busy_in_time_yellow | int | thresholdAverageBusyInTimeYellow Optional |
| threshold_average_busy_in_time_red | int | thresholdAverageBusyInTimeRed Optional |
| threshold_average_busy_out_time_yellow | int | thresholdAverageBusyOutTimeYellow Optional |
| threshold_average_busy_out_time_red | int | thresholdAverageBusyOutTimeRed Optional |
| threshold_average_wrap_up_time_yellow | int | thresholdAverageWrapUpTimeYellow Optional |
| threshold_average_wrap_up_time_red | int | thresholdAverageWrapUpTimeRed Optional |
| enable_notification_email | bool | enableNotificationEmail Optional |
| notification_email_address_list | OCI.notificationEmailAddressList | notificationEmailAddressList Optional |
| agent_user_id_list | OCI.agentUserIdList | agentUserIdList Optional |
GroupCallCenterAgentUnavailableCodeSettingsModifyRequest(OCIRequest)
Modify the group level data associated with Call Center Agents Unavailable Code Settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| enable_agent_unavailable_codes | bool | enableAgentUnavailableCodes Optional |
| default_agent_unavailable_code_on_dnd | str | defaultAgentUnavailableCodeOnDND Optional |
| default_agent_unavailable_code_on_personal_calls | str | defaultAgentUnavailableCodeOnPersonalCalls Optional |
| default_agent_unavailable_code_on_consecutive_bounces | str | defaultAgentUnavailableCodeOnConsecutiveBounces Optional |
| default_agent_unavailable_code_on_not_reachable | str | defaultAgentUnavailableCodeOnNotReachable Optional |
| force_use_of_agent_unavailable_codes | bool | forceUseOfAgentUnavailableCodes Optional |
| default_agent_unavailable_code | str | defaultAgentUnavailableCode Optional |
| code_state_list | List[OCI.codeStateList] | codeStateList Optional |
GroupCallCenterCallDispositionCodeModifyActiveListRequest(OCIRequest)
Request to set the active status of Call Center Call Disposition Codes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| call_disposition_code_activation | List[OCI.callDispositionCodeActivation] | callDispositionCodeActivation Optional |
GroupCallCenterDeleteDNISRequest(OCIRequest)
Delete a call center's DNIS.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
GroupCallCenterEnhancedReportingBrandingModifyRequest(OCIRequest)
Request to modify the group branding configuration.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| branding_choice | str | brandingChoice Optional |
| branding_file | OCI.brandingFile | brandingFile Optional |
GroupCallCenterEnhancedReportingReportTemplateAddRequest(OCIRequest)
Request to add a group level call center report template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| description | str | description Optional |
| data_template | str | dataTemplate |
| filter_number | int | filterNumber Optional |
| xslt_template | OCI.xsltTemplate | xsltTemplate |
| scope | str | scope |
| is_enabled | bool | isEnabled |
| is_realtime_report | bool | isRealtimeReport Optional |
| call_completion_threshold_param | str | callCompletionThresholdParam Optional |
| short_duration_threshold_param | str | shortDurationThresholdParam Optional |
| service_level_threshold_param | str | serviceLevelThresholdParam Optional |
| service_level_inclusions_param | str | serviceLevelInclusionsParam Optional |
| service_level_objective_threshold_param | str | serviceLevelObjectiveThresholdParam Optional |
| abandoned_call_threshold_param | str | abandonedCallThresholdParam Optional |
| service_level_threshold_param_number | int | serviceLevelThresholdParamNumber Optional |
| abandoned_call_threshold_param_number | int | abandonedCallThresholdParamNumber Optional |
| filter_value | List[str] | filterValue Optional |
GroupCallCenterEnhancedReportingReportTemplateModifyRequest(OCIRequest)
Request to modify a group level call center report template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| xslt_template | OCI.xsltTemplate | xsltTemplate Optional |
| scope | str | scope Optional |
| is_enabled | bool | isEnabled Optional |
| is_realtime_report | bool | isRealtimeReport Optional |
| filter_number | int | filterNumber Optional |
| filter_value | OCI.filterValue | filterValue Optional |
GroupCallCenterGetDNISAgentListRequest(OCIRequest)
Get a list of agent who selected the DNIS as the outgoing call.
The response is either GroupCallCenterGetDNISAgentListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
GroupCallCenterGetDNISAnnouncementRequest(OCIRequest)
Get a call center's DNIS Announcements The response is either a
GroupCallCenterGetDNISAnnouncementRequest() or an ErrorResponse().
Replaced by GroupCallCenterGetDNISAnnouncementRequest17sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
GroupCallCenterGetDNISAnnouncementRequest17sp4(OCIRequest)
Get a call center's DNIS Announcements The response is either a
GroupCallCenterGetDNISAnnouncementRequest17sp4() or an ErrorResponse().
Replaced by: GroupCallCenterGetDNISAnnouncementRequest19().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
GroupCallCenterGetDNISAnnouncementRequest19(OCIRequest)
Get a call center's DNIS Announcements The response is either a
GroupCallCenterGetDNISAnnouncementRequest19() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
GroupCallCenterGetDNISAnnouncementRequest20(OCIRequest)
Get a call center's DNIS Announcements The response is either a
GroupCallCenterGetDNISAnnouncementResponse20() or an ErrorResponse().
Replaced by: GroupCallCenterGetDNISAnnouncementRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
GroupCallCenterGetDNISAnnouncementRequest22(OCIRequest)
Get a call center's DNIS Announcements The response is either a
GroupCallCenterGetDNISAnnouncementRequest22() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
GroupCallCenterGetDNISRequest(OCIRequest)
Get a call center's DNIS.
The response is either a GroupCallCenterGetDNISRequest() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
GroupCallCenterGetInstanceStatisticsRequest14sp9(OCIRequest)
Get Call Center queue and agent statistics.
The response is either GroupCallCenterGetInstanceStatisticsResponse14sp9() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| statistics_range | OCI.statisticsRange | statisticsRange |
GroupCallCenterModifyActiveInstanceListRequest(OCIRequest)
Request to set the active status of Call Center instances.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_activation | List[OCI.serviceActivation] | serviceActivation Optional |
GroupCallCenterModifyAnnouncementRequest(OCIRequest)
Modify a call center's announcement settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| entrance_message_selection | str | entranceMessageSelection Optional |
| entrance_message_audio_file | OCI.entranceMessageAudioFile | entranceMessageAudioFile Optional |
| entrance_message_video_file | OCI.entranceMessageVideoFile | entranceMessageVideoFile Optional |
| periodic_comfort_message_selection | str | periodicComfortMessageSelection Optional |
| periodic_comfort_message_audio_file | OCI.periodicComfortMessageAudioFile | periodicComfortMessageAudioFile Optional |
| periodic_comfort_message_video_file | OCI.periodicComfortMessageVideoFile | periodicComfortMessageVideoFile Optional |
| on_hold_message_selection | str | onHoldMessageSelection Optional |
| on_hold_message_audio_file | OCI.onHoldMessageAudioFile | onHoldMessageAudioFile Optional |
| on_hold_message_video_file | OCI.onHoldMessageVideoFile | onHoldMessageVideoFile Optional |
GroupCallCenterModifyAnnouncementRequest14sp6(OCIRequest)
Modify a call center's announcement settings.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: GroupCallCenterModifyAnnouncementRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| entrance_message_selection | str | entranceMessageSelection Optional |
| entrance_message_audio_file | OCI.entranceMessageAudioFile | entranceMessageAudioFile Optional |
| entrance_message_video_file | OCI.entranceMessageVideoFile | entranceMessageVideoFile Optional |
| periodic_comfort_message_selection | str | periodicComfortMessageSelection Optional |
| periodic_comfort_message_audio_file | OCI.periodicComfortMessageAudioFile | periodicComfortMessageAudioFile Optional |
| periodic_comfort_message_video_file | OCI.periodicComfortMessageVideoFile | periodicComfortMessageVideoFile Optional |
| on_hold_source | OCI.onHoldSource | onHoldSource Optional |
| on_hold_use_alternate_source_for_internal_calls | bool | onHoldUseAlternateSourceForInternalCalls Optional |
| on_hold_internal_source | OCI.onHoldInternalSource | onHoldInternalSource Optional |
GroupCallCenterModifyDNISRequest(OCIRequest)
Modify a call center's DNIS settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
| new_dnis_name | str | newDNISName Optional |
| dnis_phone_number | str | dnisPhoneNumber Optional |
| extension | str | extension Optional |
| use_custom_clid_settings | bool | useCustomCLIDSettings Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| calling_line_id_last_name | str | callingLineIdLastName Optional |
| calling_line_id_first_name | str | callingLineIdFirstName Optional |
| use_custom_dnis_announcement_settings | bool | useCustomDnisAnnouncementSettings Optional |
| priority | str | priority Optional |
| allow_outgoing_acd_call | bool | allowOutgoingACDCall Optional |
GroupCallCenterModifyInstanceWeightedCallDistributionRequest(OCIRequest)
Request to modify the weighted call distribution of a Call Center instance.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| agent_weight | List[OCI.agentWeight] | agentWeight Optional |
GroupCallCenterModifyRoutingPolicyRequest(OCIRequest)
Modify the group call center routing policy.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| routing_policy | str | routingPolicy Optional |
| routing_priority_order | List[OCI.routingPriorityOrder] | routingPriorityOrder Optional |
GroupCallCenterModifySupervisorListRequest(OCIRequest)
Replaces a list of users as supervisors for a call center.
Also allows the modification of the reporting server URL address.
The response is either a SuccessResponse() or an ErrorResponse(). Element
"reportingServerURL"" will always be ignored.
Replaced By: GroupCallCenterSupervisorReportingModifyRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| reporting_server_url | str | reportingServerURL Optional |
| supervisor_user_id_list | OCI.supervisorUserIdList | supervisorUserIdList Optional |
GroupCallCenterModifySupervisorListRequest16(OCIRequest)
Request to modify the supervisor list for a call center.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| supervisor_user_id_list | OCI.supervisorUserIdList | supervisorUserIdList Optional |
GroupCallCenterQueueCallDispositionCodeSettingsModifyRequest(OCIRequest)
Modify the enterprise level data associated with Call Center Agents Unavailable Code Settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| enable_call_disposition_codes | bool | enableCallDispositionCodes Optional |
| include_organization_codes | bool | includeOrganizationCodes Optional |
| force_use_of_call_disposition_codes | bool | forceUseOfCallDispositionCodes Optional |
| default_call_disposition_code | OCI.defaultCallDispositionCode | defaultCallDispositionCode Optional |
| call_disposition_code_activation | List[OCI.callDispositionCodeActivation] | callDispositionCodeActivation Optional |
GroupCallCenterQueueThresholdsModifyRequest(OCIRequest)
Modify a call center's queue Thresholds settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| is_active | bool | isActive Optional |
| threshold_current_calls_in_queue_yellow | int | thresholdCurrentCallsInQueueYellow Optional |
| threshold_current_calls_in_queue_red | int | thresholdCurrentCallsInQueueRed Optional |
| threshold_current_longest_waiting_call_yellow | int | thresholdCurrentLongestWaitingCallYellow Optional |
| threshold_current_longest_waiting_call_red | int | thresholdCurrentLongestWaitingCallRed Optional |
| threshold_average_estimated_wait_time_yellow | int | thresholdAverageEstimatedWaitTimeYellow Optional |
| threshold_average_estimated_wait_time_red | int | thresholdAverageEstimatedWaitTimeRed Optional |
| threshold_average_handling_time_yellow | int | thresholdAverageHandlingTimeYellow Optional |
| threshold_average_handling_time_red | int | thresholdAverageHandlingTimeRed Optional |
| threshold_average_speed_of_answer_yellow | int | thresholdAverageSpeedOfAnswerYellow Optional |
| threshold_average_speed_of_answer_red | int | thresholdAverageSpeedOfAnswerRed Optional |
| enable_notification_email | bool | enableNotificationEmail Optional |
| notification_email_address_list | OCI.notificationEmailAddressList | notificationEmailAddressList Optional |
GroupCallCenterSupervisorReportingModifyRequest(OCIRequest)
Replaces a list of users as supervisors for a call center.
Also allows the modification of the reporting server URL address.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: GroupCallCenterModifySupervisorListRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| reporting_server_name | str | reportingServerName Optional |
| supervisor_user_id_list | OCI.supervisorUserIdList | supervisorUserIdList Optional |
GroupCallParkModifyInstanceRequest(OCIRequest)
Modifies a Call Park group.
Replaces the entire list of users in the group. The users are in the list are in the order they will try to be parked on.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| new_name | str | newName Optional |
| user_id_list | OCI.userIdList | userIdList Optional |
| recall_alternate_user_id | str | recallAlternateUserId Optional |
| recall_to | str | recallTo Optional |
GroupCallPickupModifyInstanceRequest(OCIRequest)
Modifies a Call Pickup group.
Replaces the entire list of users in the group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| new_name | str | newName Optional |
| user_id_list | OCI.userIdList | userIdList Optional |
GroupCommonPhoneListAddListRequest(OCIRequest)
Add one or more entries to a group's common phone list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| entry | List[OCI.entry] | entry |
GroupCommunicationBarringAuthorizationCodeAddListRequest(OCIRequest)
Add a list of Communication Barring Authorization codes to a group.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
GroupCommunicationBarringAuthorizationCodeAddListRequest21sp1() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| code | List[OCI.code] | code |
GroupCommunicationBarringAuthorizationCodeAddListRequest21sp1(OCIRequest)
Add a list of Communication Barring Authorization codes to a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| code | List[OCI.code] | code |
GroupCommunicationBarringProfileModifyListRequest(OCIRequest)
Assign a replacement list of Communication Barring Profiles to a group.
The response is either a SuccessResponse() or an ErrorResponse(). This command
only applies to groups in an Enterprise. This command will fail for groups in a
Service Provider.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| profile_name | OCI.profileName | profileName Optional |
GroupConsolidatedDnAssignListRequest(OCIRequest)
Adds DNs to enterprise and group and activates the DNs on assignment.
It is possible to add either: a single DN, or a list of DNs, or a range of DNs, or any combination thereof.
The response is either SuccessResponse() or
GroupConsolidatedDnAssignListResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| phone_number | List[OCI.phoneNumber] | phoneNumber Optional |
| dn_range | List[OCI.dnRange] | dnRange Optional |
GroupCustomContactDirectoryAddRequest17(OCIRequest)
Adds a Custom Contact Directory to a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| entry | List[OCI.entry] | entry Optional |
GroupCustomContactDirectoryModifyRequest(OCIRequest)
Adds a Custom Contact Directory to a group.
The response is either SuccessResponse() or ErrorResponse(). Replace by:
GroupCustomContactDirectoryModifyRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| new_name | str | newName Optional |
| user_id_list | OCI.userIdList | userIdList Optional |
GroupDepartmentAddRequest(OCIRequest)
Add a department to a group.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: callingLineIdName caliingLineIdPhoneNumber
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department_name | str | departmentName |
| parent_department_key | OCI.parentDepartmentKey | parentDepartmentKey Optional |
| calling_line_id_name | str | callingLineIdName Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
GroupDepartmentModifyRequest(OCIRequest)
Modify a department of a group.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: callingLineIdName caliingLineIdPhoneNumber
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department_name | str | departmentName |
| new_department_name | str | newDepartmentName Optional |
| new_parent_department_key | OCI.newParentDepartmentKey | newParentDepartmentKey Optional |
| calling_line_id_name | str | callingLineIdName Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
GroupDeviceTypeFileModifyRequest(OCIRequest)
Request to modify a specified device type file for a group.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: GroupDeviceTypeFileModifyRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
| file_type | str | fileType |
| file_source | str | fileSource Optional |
| upload_file | OCI.uploadFile | uploadFile Optional |
GroupDeviceTypeFileModifyRequest14sp8(OCIRequest)
Request to modify a specified device type file for a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_type | str | deviceType |
| file_format | str | fileFormat |
| file_source | str | fileSource Optional |
| upload_file | OCI.uploadFile | uploadFile Optional |
GroupDialableCallerIDCriteriaModifyRequest(OCIRequest)
Modify a Dialable Caller ID Criteria.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| prefix_digits | str | prefixDigits Optional |
| match_call_type | OCI.matchCallType | matchCallType Optional |
| match_alternate_call_indicator | OCI.matchAlternateCallIndicator | matchAlternateCallIndicator Optional |
| match_local_category | bool | matchLocalCategory Optional |
| match_national_category | bool | matchNationalCategory Optional |
| match_interlata_category | bool | matchInterlataCategory Optional |
| match_intralata_category | bool | matchIntralataCategory Optional |
| match_international_category | bool | matchInternationalCategory Optional |
| match_private_category | bool | matchPrivateCategory Optional |
| match_emergency_category | bool | matchEmergencyCategory Optional |
| match_other_category | bool | matchOtherCategory Optional |
GroupDialableCallerIDModifyRequest(OCIRequest)
Modify the group's Dialable Caller ID settings and criteria list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_group_criteria | bool | useGroupCriteria Optional |
| ns_screening_failure_policy | str | nsScreeningFailurePolicy Optional |
| criteria_priority_order | List[OCI.criteriaPriorityOrder] | criteriaPriorityOrder Optional |
GroupDirectoryNumberHuntingModifyRequest(OCIRequest)
Replaces a list of users as agents for a directory number hunting group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| agent_user_id_list | OCI.agentUserIdList | agentUserIdList Optional |
| use_terminate_call_to_agent_first | bool | useTerminateCallToAgentFirst Optional |
| use_original_agent_services_for_busy_and_no_answer_calls | bool | useOriginalAgentServicesForBusyAndNoAnswerCalls Optional |
GroupDnActivateListRequest(OCIRequest)
Activate a list of assigned DNs on a group.
It is possible to activate either: a single DN, or a list of DNs, or a range of DNs, or any combination thereof. It is not an error to activate an already activated DN
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| phone_number | List[str] | phoneNumber Optional |
| dn_range | List[OCI.dnRange] | dnRange Optional |
GroupDnAssignListRequest(OCIRequest)
Assign a list of service provider DNs to a group.
It is possible to assign either: a single DN, or a list of DNs, or a range of DNs, or any combination thereof. The DNs must have previously been added to the service provider or enterprise.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| phone_number | List[str] | phoneNumber Optional |
| dn_range | List[OCI.dnRange] | dnRange Optional |
GroupDnDeactivateListRequest(OCIRequest)
Deactivate a list of activated DNs on a group.
The DNs then become available for activation again. It is possible to deactivate either: a single DN, or a list of DNs, or a range of DNs, or any combination thereof. It is not an error to deactivate an already deactivated DN.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| phone_number | List[str] | phoneNumber Optional |
| dn_range | List[OCI.dnRange] | dnRange Optional |
GroupDnListAssignDepartmentRequest(OCIRequest)
Assign a list of group DNs to a department.
If the department is not specified, this will make the DNs become unassigned from any department.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department_key | OCI.departmentKey | departmentKey Optional |
| phone_number | List[str] | phoneNumber Optional |
| dn_range | List[OCI.dnRange] | dnRange Optional |
GroupDnUnassignListRequest(OCIRequest)
Unassign a list of service provider DNs from a group.
The DNs then become available for assignment to other groups. It is possible to unassign either: a single DN, or a list of DNs, or a range of DNs, or any combination thereof.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| phone_number | List[str] | phoneNumber Optional |
| dn_range | List[OCI.dnRange] | dnRange Optional |
GroupEmergencyZonesAddHomeZoneListRequest(OCIRequest)
Add a list of home zones and/or home zone ranges to the group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| home_zone_ip_address | List[str] | homeZoneIpAddress Optional |
| home_zone_ip_address_range | List[OCI.homeZoneIpAddressRange] | homeZoneIpAddressRange Optional |
GroupEmergencyZonesDeleteHomeZoneListRequest(OCIRequest)
Delete a list of home zones and/or home zone ranges to the group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| home_zone_ip_address | List[str] | homeZoneIpAddress Optional |
| home_zone_ip_address_range | List[OCI.homeZoneIpAddressRange] | homeZoneIpAddressRange Optional |
GroupExchangeIntegrationModifyRequest(OCIRequest)
Modify the group level configuration for Exchange Integration.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| enable_exchange_integration | bool | enableExchangeIntegration Optional |
| exchange_url | str | exchangeURL Optional |
| exchange_credentials | OCI.exchangeCredentials | exchangeCredentials Optional |
GroupFeatureAccessCodeModifyListRequest(OCIRequest)
Modify a list of feature access codes for a group.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
GroupFeatureAccessCodeModifyRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| feature_access_code | List[OCI.featureAccessCode] | featureAccessCode Optional |
| restore_default_codes | bool | restoreDefaultCodes Optional |
GroupFeatureAccessCodeModifyRequest(OCIRequest)
Modify group FAC code level and the list of feature access codes for a group.
The response is either a SuccessResponse() or an ErrorResponse(). Note: choice
element is only valid when useFeatureAccessCodeLevel is set to "Group", otherwise an
ErrorResponse() will be returned. Replaced by:
GroupFeatureAccessCodeModifyRequest21() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_feature_access_code_level | str | useFeatureAccessCodeLevel Optional |
| restore_default_codes | bool | restoreDefaultCodes Optional |
| feature_access_code | List[OCI.featureAccessCode] | featureAccessCode Optional |
GroupFeatureAccessCodeModifyRequest20(OCIRequest)
Modify group FAC code level and the list of feature access codes for a group.
The response is either a SuccessResponse() or an ErrorResponse(). Note: choice
element is only valid when useFeatureAccessCodeLevel is set to "Group", otherwise an
ErrorResponse() will be returned. In release 20 the "Call Recording" FAC name is
changed to "Call Recording - Start". Replaced by:
GroupFeatureAccessCodeModifyRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_feature_access_code_level | str | useFeatureAccessCodeLevel Optional |
| restore_default_codes | bool | restoreDefaultCodes Optional |
| feature_access_code | List[OCI.featureAccessCode] | featureAccessCode Optional |
GroupFeatureAccessCodeModifyRequest21(OCIRequest)
Modify group FAC code level and the list of feature access codes for a group.
The response is either a SuccessResponse() or an ErrorResponse(). Note: choice
element is only valid when useFeatureAccessCodeLevel is set to "Group", otherwise an
ErrorResponse() will be returned. In release 20 the "Call Recording" FAC name is
changed to "Call Recording - Start".
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_feature_access_code_level | str | useFeatureAccessCodeLevel Optional |
| restore_default_codes | bool | restoreDefaultCodes Optional |
| feature_access_code | List[OCI.featureAccessCode] | featureAccessCode Optional |
GroupFindMeFollowMeAddAlertingGroupSelectiveCriteriaRequest(OCIRequest)
Add a criteria to the Find-me/Follow-me alerting group.
For the callToNumber, the extension and number elements are not used and the only types accepted for each number are Primary and Alternates. If other type is specified the command fails.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| alerting_group_name | str | alertingGroupName |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
| call_to_number | List[OCI.callToNumber] | callToNumber Optional |
GroupFindMeFollowMeModifyActiveInstanceListRequest(OCIRequest)
Request to set the active status of Find-me/Follow-me instances.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_activation | List[OCI.serviceActivation] | serviceActivation Optional |
GroupFindMeFollowMeModifyAlertingGroupRequest(OCIRequest)
Modify a Find-me/Follow-me alerting group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| alerting_group_name | str | alertingGroupName |
| new_alerting_group_name | str | newAlertingGroupName Optional |
| alerting_group_description | str | alertingGroupDescription Optional |
| use_diversion_inhibitor | bool | useDiversionInhibitor Optional |
| answer_confirmation_required | bool | answerConfirmationRequired Optional |
| number_of_rings | int | numberOfRings Optional |
| phone_number_or_user_list | OCI.phoneNumberOrUserList | phoneNumberOrUserList Optional |
| criteria_activation | List[OCI.criteriaActivation] | criteriaActivation Optional |
GroupFlexibleSeatingHostModifyActiveInstanceListRequest(OCIRequest)
Request to set the active status of flexible seating host instances.
Host cannot be disabled when a flexible seating guest is associated.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_activation | List[OCI.serviceActivation] | serviceActivation Optional |
GroupGroupNightForwardingModifyRequest(OCIRequest)
Request to modify the Group Night Forwarding group parameters.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| night_forwarding | str | nightForwarding Optional |
| business_hours | OCI.businessHours | businessHours Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
GroupGroupPagingModifyActiveInstanceListRequest(OCIRequest)
Request to set the active status of Group Paging instances.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_activation | List[OCI.serviceActivation] | serviceActivation Optional |
GroupGroupPagingModifyOriginatorListRequest(OCIRequest)
Request to modify the originator list for a paging group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| originator_user_id_list | OCI.originatorUserIdList | originatorUserIdList Optional |
GroupGroupPagingModifyTargetListRequest(OCIRequest)
Request to modify the target list for a paging group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| target_user_id_list | OCI.targetUserIdList | targetUserIdList Optional |
GroupHolidayScheduleAddRequest(OCIRequest)
Add a holiday schedule to a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| holiday_schedule_name | str | holidayScheduleName |
| holiday01 | OCI.holiday01 | holiday01 Optional |
| holiday02 | OCI.holiday02 | holiday02 Optional |
| holiday03 | OCI.holiday03 | holiday03 Optional |
| holiday04 | OCI.holiday04 | holiday04 Optional |
| holiday05 | OCI.holiday05 | holiday05 Optional |
| holiday06 | OCI.holiday06 | holiday06 Optional |
| holiday07 | OCI.holiday07 | holiday07 Optional |
| holiday08 | OCI.holiday08 | holiday08 Optional |
| holiday09 | OCI.holiday09 | holiday09 Optional |
| holiday10 | OCI.holiday10 | holiday10 Optional |
| holiday11 | OCI.holiday11 | holiday11 Optional |
| holiday12 | OCI.holiday12 | holiday12 Optional |
| holiday13 | OCI.holiday13 | holiday13 Optional |
| holiday14 | OCI.holiday14 | holiday14 Optional |
| holiday15 | OCI.holiday15 | holiday15 Optional |
| holiday16 | OCI.holiday16 | holiday16 Optional |
| holiday17 | OCI.holiday17 | holiday17 Optional |
| holiday18 | OCI.holiday18 | holiday18 Optional |
| holiday19 | OCI.holiday19 | holiday19 Optional |
| holiday20 | OCI.holiday20 | holiday20 Optional |
GroupHolidayScheduleModifyRequest(OCIRequest)
Modify a holiday schedule in a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| holiday_schedule_name | str | holidayScheduleName |
| new_holiday_schedule_name | str | newHolidayScheduleName Optional |
| holiday01 | OCI.holiday01 | holiday01 Optional |
| holiday02 | OCI.holiday02 | holiday02 Optional |
| holiday03 | OCI.holiday03 | holiday03 Optional |
| holiday04 | OCI.holiday04 | holiday04 Optional |
| holiday05 | OCI.holiday05 | holiday05 Optional |
| holiday06 | OCI.holiday06 | holiday06 Optional |
| holiday07 | OCI.holiday07 | holiday07 Optional |
| holiday08 | OCI.holiday08 | holiday08 Optional |
| holiday09 | OCI.holiday09 | holiday09 Optional |
| holiday10 | OCI.holiday10 | holiday10 Optional |
| holiday11 | OCI.holiday11 | holiday11 Optional |
| holiday12 | OCI.holiday12 | holiday12 Optional |
| holiday13 | OCI.holiday13 | holiday13 Optional |
| holiday14 | OCI.holiday14 | holiday14 Optional |
| holiday15 | OCI.holiday15 | holiday15 Optional |
| holiday16 | OCI.holiday16 | holiday16 Optional |
| holiday17 | OCI.holiday17 | holiday17 Optional |
| holiday18 | OCI.holiday18 | holiday18 Optional |
| holiday19 | OCI.holiday19 | holiday19 Optional |
| holiday20 | OCI.holiday20 | holiday20 Optional |
GroupHuntGroupModifyActiveInstanceListRequest(OCIRequest)
Request to set the active status of Hunt Group instances.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_activation | List[OCI.serviceActivation] | serviceActivation Optional |
GroupHuntGroupModifyInstanceWeightedCallDistributionRequest(OCIRequest)
Request to modify the weighted call distribution of a Hunt Group instance.
The response is either SuccessResponse() or ErrorResponse(). NOTE: Prior to
release 14, any agents who were not in the list kept their existing weight setting.
In release 14, any agents who are not in the list will have their weight set to 0.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| agent_weight | List[OCI.agentWeight] | agentWeight Optional |
GroupIMRNAssignListRequest(OCIRequest)
Assign a list of group DNs to the IMRN pool.
It is possible to assign either: a single DN, or a list of DNs, or a range of DNs, or any combination thereof.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| imrn | List[str] | imrn Optional |
| imrn_range | List[OCI.imrnRange] | imrnRange Optional |
GroupIMRNUnassignListRequest(OCIRequest)
Unassign a list of group DNs from the group IMRN pool.
The DNs then become available for assignment to users. It is possible to delete either: a single DN, or a list of DNs, or a range of DNs, or any combination thereof.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| imrn | List[str] | imrn Optional |
| imrn_range | List[OCI.imrnRange] | imrnRange Optional |
GroupInstantGroupCallModifyActiveInstanceListRequest(OCIRequest)
Request to set the active status of Instant Group Call service instances.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_activation | List[OCI.serviceActivation] | serviceActivation Optional |
GroupInterceptGroupModifyRequest(OCIRequest)
Modify the group's intercept group service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: GroupInterceptGroupModifyRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| is_active | bool | isActive Optional |
| announcement_selection | str | announcementSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_file | OCI.videoFile | videoFile Optional |
| play_new_phone_number | bool | playNewPhoneNumber Optional |
| new_phone_number | str | newPhoneNumber Optional |
| transfer_on_zero_to_phone_number | bool | transferOnZeroToPhoneNumber Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
GroupInterceptGroupModifyRequest16(OCIRequest)
Modify the group's intercept group service settings.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
GroupInterceptGroupModifyResponse21sp1() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| is_active | bool | isActive Optional |
| announcement_selection | str | announcementSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_file | OCI.videoFile | videoFile Optional |
| play_new_phone_number | bool | playNewPhoneNumber Optional |
| new_phone_number | str | newPhoneNumber Optional |
| transfer_on_zero_to_phone_number | bool | transferOnZeroToPhoneNumber Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| reroute_outbound_calls | bool | rerouteOutboundCalls Optional |
| outbound_reroute_phone_number | str | outboundReroutePhoneNumber Optional |
| allow_outbound_local_calls | bool | allowOutboundLocalCalls Optional |
| inbound_call_mode | str | inboundCallMode Optional |
| alternate_blocking_announcement | bool | alternateBlockingAnnouncement Optional |
| route_to_voice_mail | bool | routeToVoiceMail Optional |
GroupInterceptGroupModifyRequest21sp1(OCIRequest)
Modify the group's intercept group service settings.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
exemptInboundMobilityCalls exemptOutboundMobilityCalls
disableParallelRingingToNetworkLocations
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| is_active | bool | isActive Optional |
| announcement_selection | str | announcementSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_file | OCI.videoFile | videoFile Optional |
| inbound_call_mode | str | inboundCallMode Optional |
| alternate_blocking_announcement | bool | alternateBlockingAnnouncement Optional |
| exempt_inbound_mobility_calls | bool | exemptInboundMobilityCalls Optional |
| disable_parallel_ringing_to_network_locations | bool | disableParallelRingingToNetworkLocations Optional |
| route_to_voice_mail | bool | routeToVoiceMail Optional |
| play_new_phone_number | bool | playNewPhoneNumber Optional |
| new_phone_number | str | newPhoneNumber Optional |
| transfer_on_zero_to_phone_number | bool | transferOnZeroToPhoneNumber Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| outbound_call_mode | str | outboundCallMode Optional |
| exempt_outbound_mobility_calls | bool | exemptOutboundMobilityCalls Optional |
| reroute_outbound_calls | bool | rerouteOutboundCalls Optional |
| outbound_reroute_phone_number | str | outboundReroutePhoneNumber Optional |
GroupMWIDeliveryToMobileEndpointModifyRequest(OCIRequest)
Modify the group level MWI custom notifications settings.
The response is either a SuccessResponse() or an ErrorResponse(). If the request
is executed by a group administrator and modifies the useSettingLevel, the request is
rejected.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_setting_level | str | useSettingLevel Optional |
| template_activation | List[OCI.templateActivation] | templateActivation Optional |
GroupMWIDeliveryToMobileEndpointModifyRequest23(OCIRequest)
Modify the group level MWI custom notifications settings.
The response is either a SuccessResponse() or an ErrorResponse(). If the request
is executed by a group administrator and modifies the useSettingLevel, the request is
rejected.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| use_setting_level | str | useSettingLevel Optional |
| template_activation | List[OCI.templateActivation] | templateActivation Optional |
GroupMeetMeConferencingModifyActiveInstanceListRequest(OCIRequest)
Request to set the active status of Meet-Me Conferencing instances.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_activation | List[OCI.serviceActivation] | serviceActivation Optional |
GroupMeetMeConferencingModifyRequest(OCIRequest)
Modify the group level data associated with Meet-Me Conferencing functions.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| allocated_ports | OCI.allocatedPorts | allocatedPorts Optional |
GroupModifyRequest(OCIRequest)
Modify the profile for a group.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are ignored in AS and XS data mode: servicePolicy, callProcessingSliceId,
provisioningSliceId, subscriberPartition. The following elements are only used in XS
data mode and ignored in AS data mode: preferredDataCenter. Only Provisioning admin
and above can change the preferredDataCenter. The following elements are only used in
XS data mode and ignored in AS data mode: defaultUserCallingLineIdPhoneNumber. The
following elements are only used in AS data mode and ignored in the XS data mode:
extensionLengthSettings dialPlanAccessCode dialPlanPolicy
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| default_domain | str | defaultDomain Optional |
| user_limit | int | userLimit Optional |
| group_name | str | groupName Optional |
| calling_line_id_name | str | callingLineIdName Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| time_zone | str | timeZone Optional |
| location_dialing_code | str | locationDialingCode Optional |
| contact | OCI.contact | contact Optional |
| address | OCI.address | address Optional |
| service_policy | str | servicePolicy Optional |
| call_processing_slice_id | str | callProcessingSliceId Optional |
| provisioning_slice_id | str | provisioningSliceId Optional |
| subscriber_partition | str | subscriberPartition Optional |
| preferred_data_center | str | preferredDataCenter Optional |
| default_user_calling_line_id_phone_number | str | defaultUserCallingLineIdPhoneNumber Optional |
| extension_length_settings | OCI.extensionLengthSettings | extensionLengthSettings Optional |
| dial_plan_access_code | OCI.dialPlanAccessCode | dialPlanAccessCode Optional |
| dial_plan_policy | OCI.dialPlanPolicy | dialPlanPolicy Optional |
GroupMusicOnHoldAddInstanceRequest14sp6(OCIRequest)
Add a Music on Hold Instance to a department.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: GroupMusicOnHoldAddInstanceRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department |
| is_active_during_call_hold | bool | isActiveDuringCallHold |
| is_active_during_call_park | bool | isActiveDuringCallPark |
| is_active_during_busy_camp_on | bool | isActiveDuringBusyCampOn |
| source | OCI.source | source |
| use_alternate_source_for_internal_calls | bool | useAlternateSourceForInternalCalls |
| internal_source | OCI.internalSource | internalSource Optional |
GroupMusicOnHoldAddInstanceRequest16(OCIRequest)
Add a Music on Hold Instance to a department.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department |
| is_active_during_call_hold | bool | isActiveDuringCallHold |
| is_active_during_call_park | bool | isActiveDuringCallPark |
| is_active_during_busy_camp_on | bool | isActiveDuringBusyCampOn |
| source | OCI.source | source |
| use_alternate_source_for_internal_calls | bool | useAlternateSourceForInternalCalls |
| internal_source | OCI.internalSource | internalSource Optional |
GroupMusicOnHoldAddInstanceRequest20(OCIRequest)
Add a Music on Hold Instance to a department.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
GroupMusicOnHoldAddInstanceRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department |
| is_active_during_call_hold | bool | isActiveDuringCallHold |
| is_active_during_call_park | bool | isActiveDuringCallPark |
| is_active_during_busy_camp_on | bool | isActiveDuringBusyCampOn |
| source | OCI.source | source |
| use_alternate_source_for_internal_calls | bool | useAlternateSourceForInternalCalls |
| internal_source | OCI.internalSource | internalSource Optional |
GroupMusicOnHoldAddInstanceRequest21(OCIRequest)
Add a Music on Hold Instance to a department.
The response is either SuccessResponse() or ErrorResponse(). Replaced by
GroupMusicOnHoldAddInstanceRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department |
| is_active_during_call_hold | bool | isActiveDuringCallHold |
| is_active_during_call_park | bool | isActiveDuringCallPark |
| is_active_during_busy_camp_on | bool | isActiveDuringBusyCampOn |
| source | OCI.source | source |
| use_alternate_source_for_internal_calls | bool | useAlternateSourceForInternalCalls |
| internal_source | OCI.internalSource | internalSource Optional |
GroupMusicOnHoldAddInstanceRequest22(OCIRequest)
Add a Music on Hold Instance to a department.
The response is either SuccessResponse() or ErrorResponse(). Replaced by
GroupMusicOnHoldAddInstanceRequest23().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department |
| is_active_during_call_hold | bool | isActiveDuringCallHold |
| is_active_during_call_park | bool | isActiveDuringCallPark |
| is_active_during_busy_camp_on | bool | isActiveDuringBusyCampOn |
| source | OCI.source | source |
| use_alternate_source_for_internal_calls | bool | useAlternateSourceForInternalCalls |
| internal_source | OCI.internalSource | internalSource Optional |
GroupMusicOnHoldAddInstanceRequest23(OCIRequest)
Add a Music on Hold Instance to a department.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: -
useDynamicMOHDuringCallHold
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department |
| is_active_during_call_hold | bool | isActiveDuringCallHold |
| is_active_during_call_park | bool | isActiveDuringCallPark |
| is_active_during_busy_camp_on | bool | isActiveDuringBusyCampOn |
| source | OCI.source | source |
| use_alternate_source_for_internal_calls | bool | useAlternateSourceForInternalCalls |
| internal_source | OCI.internalSource | internalSource Optional |
| use_dynamic_moh_during_call_hold | bool | useDynamicMOHDuringCallHold |
GroupMusicOnHoldDeleteInstanceRequest(OCIRequest)
Delete a Music On Hold department instance.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department |
GroupMusicOnHoldGetInstanceRequest14(OCIRequest)
Get a Music On Hold data for a group or department instance.
The response is either GroupMusicOnHoldGetInstanceResponse14() or ErrorResponse().
Replaced By: GroupMusicOnHoldGetInstanceRequest14Sp4
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
GroupMusicOnHoldGetInstanceRequest14sp4(OCIRequest)
Get a Music On Hold data for a group or department instance.
The response is either GroupMusicOnHoldGetInstanceResponse14sp4() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
GroupMusicOnHoldGetInstanceRequest14sp6(OCIRequest)
Get a Music On Hold data for a group or department instance.
The response is either GroupMusicOnHoldGetInstanceResponse14sp6() or
ErrorResponse().
Replaced By: GroupMusicOnHoldGetInstanceRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
GroupMusicOnHoldGetInstanceRequest16(OCIRequest)
Get a Music On Hold data for a group or department instance.
The response is either GroupMusicOnHoldGetInstanceResponse16() or ErrorResponse().
Replaced by: GroupMusicOnHoldGetInstanceRequest19().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
GroupMusicOnHoldGetInstanceRequest19(OCIRequest)
Get a Music On Hold data for a group or department instance.
The response is either GroupMusicOnHoldGetInstanceResponse19() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
GroupMusicOnHoldGetInstanceRequest20(OCIRequest)
Get a Music On Hold data for a group or department instance.
The response is either GroupMusicOnHoldGetInstanceResponse20() or ErrorResponse().
Replaced by: GroupMusicOnHoldGetInstanceRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
GroupMusicOnHoldGetInstanceRequest21(OCIRequest)
Get a Music On Hold data for a group or department instance.
The response is either GroupMusicOnHoldGetInstanceResponse21() or ErrorResponse().
Replaced by GroupMusicOnHoldGetInstanceRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
GroupMusicOnHoldGetInstanceRequest22(OCIRequest)
Get a Music On Hold data for a group or department instance.
The response is either GroupMusicOnHoldGetInstanceResponse22() or ErrorResponse().
Replaced by: GroupMusicOnHoldGetInstanceRequest22V2() in AS mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
GroupMusicOnHoldGetInstanceRequest22V2(OCIRequest)
Get a Music On Hold data for a group or department instance.
The response is either GroupMusicOnHoldGetInstanceResponse22V2() or
ErrorResponse(). Replaced by: GroupMusicOnHoldGetInstanceRequest23()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
GroupMusicOnHoldGetInstanceRequest22V3(OCIRequest)
Get a Music On Hold data for a group or department instance.
The response is either GroupMusicOnHoldGetInstanceResponse22V3() or
ErrorResponse(). Replaced by: GroupMusicOnHoldGetInstanceRequest23V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
GroupMusicOnHoldGetInstanceRequest23(OCIRequest)
Get a Music On Hold data for a group or department instance.
The response is either GroupMusicOnHoldGetInstanceResponse23() or ErrorResponse().
Replaced by: GroupMusicOnHoldGetInstanceRequest23V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
GroupMusicOnHoldGetInstanceRequest23V2(OCIRequest)
Get a Music On Hold data for a group or department instance.
The response is either GroupMusicOnHoldGetInstanceResponse23V2() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
GroupMusicOnHoldModifyInstanceRequest14sp6(OCIRequest)
Modify data for a group or department Music On Hold Instance.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: GroupMusicOnHoldModifyInstanceRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
| is_active_during_call_hold | bool | isActiveDuringCallHold Optional |
| is_active_during_call_park | bool | isActiveDuringCallPark Optional |
| is_active_during_busy_camp_on | bool | isActiveDuringBusyCampOn Optional |
| source | OCI.source | source Optional |
| use_alternate_source_for_internal_calls | bool | useAlternateSourceForInternalCalls Optional |
| internal_source | OCI.internalSource | internalSource Optional |
GroupMusicOnHoldModifyInstanceRequest16(OCIRequest)
Modify data for a group or department Music On Hold Instance.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
| is_active_during_call_hold | bool | isActiveDuringCallHold Optional |
| is_active_during_call_park | bool | isActiveDuringCallPark Optional |
| is_active_during_busy_camp_on | bool | isActiveDuringBusyCampOn Optional |
| source | OCI.source | source Optional |
| use_alternate_source_for_internal_calls | bool | useAlternateSourceForInternalCalls Optional |
| internal_source | OCI.internalSource | internalSource Optional |
GroupMusicOnHoldModifyInstanceRequest20(OCIRequest)
Modify data for a group or department Music On Hold Instance.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
GroupMusicOnHoldModifyInstanceRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
| is_active_during_call_hold | bool | isActiveDuringCallHold Optional |
| is_active_during_call_park | bool | isActiveDuringCallPark Optional |
| is_active_during_busy_camp_on | bool | isActiveDuringBusyCampOn Optional |
| source | OCI.source | source Optional |
| use_alternate_source_for_internal_calls | bool | useAlternateSourceForInternalCalls Optional |
| internal_source | OCI.internalSource | internalSource Optional |
GroupMusicOnHoldModifyInstanceRequest21(OCIRequest)
Modify data for a group or department Music On Hold Instance.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
| is_active_during_call_hold | bool | isActiveDuringCallHold Optional |
| is_active_during_call_park | bool | isActiveDuringCallPark Optional |
| is_active_during_busy_camp_on | bool | isActiveDuringBusyCampOn Optional |
| source | OCI.source | source Optional |
| use_alternate_source_for_internal_calls | bool | useAlternateSourceForInternalCalls Optional |
| internal_source | OCI.internalSource | internalSource Optional |
GroupMusicOnHoldModifyInstanceRequest22(OCIRequest)
Modify data for a group or department Music On Hold Instance.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
| is_active_during_call_hold | bool | isActiveDuringCallHold Optional |
| is_active_during_call_park | bool | isActiveDuringCallPark Optional |
| is_active_during_busy_camp_on | bool | isActiveDuringBusyCampOn Optional |
| source | OCI.source | source Optional |
| use_alternate_source_for_internal_calls | bool | useAlternateSourceForInternalCalls Optional |
| internal_source | OCI.internalSource | internalSource Optional |
| use_dynamic_moh_during_call_hold | bool | useDynamicMOHDuringCallHold Optional |
GroupNetworkClassOfServiceAssignListRequest21(OCIRequest)
Assign a list of Network Classes of Service to a group.
A default Network Class of Service must be specified unless there is already one assigned to the group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| network_class_of_service | List[str] | networkClassOfService Optional |
| default_network_class_of_service | OCI.defaultNetworkClassOfService | defaultNetworkClassOfService |
GroupNetworkClassOfServiceUnassignListRequest21(OCIRequest)
Unassign a list of Network Classes of Service from a group.
If the default Network Class of Service is being unassigned, a new one must be specified unless there are no more Network Classes of Service assigned to the group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| network_class_of_service | List[str] | networkClassOfService Optional |
| default_network_class_of_service | OCI.defaultNetworkClassOfService | defaultNetworkClassOfService |
GroupOutgoingCallingPlanDepartmentAuthorizationCodeAddListRequest(OCIRequest)
Add a list of authorization codes to the group's default or a department.
When department is not specified, it is for the group default.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department_key | OCI.departmentKey | departmentKey Optional |
| code_entry | List[OCI.codeEntry] | codeEntry |
GroupOutgoingCallingPlanDepartmentAuthorizationCodeDeleteListRequest(OCIRequest)
Delete a list of authorization codes from the group's default or a department.
When department is not specified, it is for the group default.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department_key | OCI.departmentKey | departmentKey Optional |
| code | List[str] | code |
GroupOutgoingCallingPlanDepartmentAuthorizationCodeGetListRequest(OCIRequest)
Request the list of authorization codes for a group default or a department.
When department is not specified, it is for the group default.
The response is either a
GroupOutgoingCallingPlanDepartmentAuthorizationCodeGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department_key | OCI.departmentKey | departmentKey Optional |
GroupPreferredCarrierGroupModifyRequest(OCIRequest)
Modifies the currently configured carriers for a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| intra_lata_carrier | OCI.intraLataCarrier | intraLataCarrier Optional |
| inter_lata_carrier | OCI.interLataCarrier | interLataCarrier Optional |
| international_carrier | OCI.internationalCarrier | internationalCarrier Optional |
GroupRoutePointAddDNISRequest(OCIRequest)
Add a Route Point DNIS.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
| dnis_phone_number | str | dnisPhoneNumber Optional |
| extension | str | extension Optional |
| use_custom_clid_settings | bool | useCustomCLIDSettings |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| calling_line_id_last_name | str | callingLineIdLastName Optional |
| calling_line_id_first_name | str | callingLineIdFirstName Optional |
| use_custom_dnis_announcement_settings | bool | useCustomDnisAnnouncementSettings |
| allow_outgoing_acd_call | bool | allowOutgoingACDCall |
GroupRoutePointDeleteDNISRequest(OCIRequest)
Delete a route point's DNIS.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
GroupRoutePointGetDNISAgentListRequest(OCIRequest)
Get a list of agent who selected the DNIS as the outgoing call.
The response is either GroupRoutePointGetDNISAgentListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
GroupRoutePointGetDNISAnnouncementRequest(OCIRequest)
Get a route point's DNIS Announcements The response is either a
GroupRoutePointGetDNISAnnouncementResponse() or an ErrorResponse().
Replaced by: GroupRoutePointGetDNISAnnouncementRequest19().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
GroupRoutePointGetDNISAnnouncementRequest19(OCIRequest)
Get a route point's DNIS Announcements The response is either a
GroupRoutePointGetDNISAnnouncementResponse19() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
GroupRoutePointGetDNISAnnouncementRequest20(OCIRequest)
Get a route point's DNIS Announcements The response is either a
GroupRoutePointGetDNISAnnouncementResponse20() or an ErrorResponse().
Replaced by: GroupRoutePointGetDNISAnnouncementRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
GroupRoutePointGetDNISAnnouncementRequest22(OCIRequest)
Get a route point's DNIS Announcements The response is either a
GroupRoutePointGetDNISAnnouncementResponse22() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
GroupRoutePointGetDNISRequest(OCIRequest)
Get a route point's DNIS.
The response is either a GroupRoutePointGetDNISResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
GroupRoutePointModifyActiveInstanceListRequest(OCIRequest)
Request to set the active status of Route Point instances.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_activation | List[OCI.serviceActivation] | serviceActivation Optional |
GroupRoutePointModifyDNISRequest(OCIRequest)
Modify a route point's DNIS settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
| new_dnis_name | str | newDNISName Optional |
| dnis_phone_number | str | dnisPhoneNumber Optional |
| extension | str | extension Optional |
| use_custom_clid_settings | bool | useCustomCLIDSettings Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| calling_line_id_last_name | str | callingLineIdLastName Optional |
| calling_line_id_first_name | str | callingLineIdFirstName Optional |
| use_custom_dnis_announcement_settings | bool | useCustomDnisAnnouncementSettings Optional |
| allow_outgoing_acd_call | bool | allowOutgoingACDCall Optional |
GroupRoutePointQueueCallDispositionCodeSettingsModifyRequest(OCIRequest)
Modify the queue level data associated with Route Point Agents Unavailable Code Settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| enable_call_disposition_codes | bool | enableCallDispositionCodes Optional |
| include_organization_codes | bool | includeOrganizationCodes Optional |
| force_use_of_call_disposition_codes | bool | forceUseOfCallDispositionCodes Optional |
| default_call_disposition_code | OCI.defaultCallDispositionCode | defaultCallDispositionCode Optional |
| call_disposition_code_activation | List[OCI.callDispositionCodeActivation] | callDispositionCodeActivation Optional |
GroupScheduleAddEventRequest(OCIRequest)
Add an event to group schedule.
The response is either a SuccessResponse() or an ErrorResponse(). The startDate
element is adjusted to the first occurrence of the recurrent schedule that comes at or
after the startDate. The endDate element is set to the sum of the adjusted starDate
element value and the event duration.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| schedule_key | OCI.scheduleKey | scheduleKey |
| event_name | str | eventName |
| start_date | str | startDate |
| all_day_event | bool | allDayEvent Optional |
| start_time | OCI.startTime | startTime Optional |
| end_time | OCI.endTime | endTime Optional |
| end_date | str | endDate |
| recurrence | OCI.recurrence | recurrence Optional |
GroupScheduleDeleteEventListRequest(OCIRequest)
Delete a list of events from a group schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| schedule_key | OCI.scheduleKey | scheduleKey |
| event_name | List[str] | eventName |
GroupScheduleDeleteListRequest(OCIRequest)
Delete a list of group schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| schedule_key | List[OCI.scheduleKey] | scheduleKey |
GroupScheduleGetEventDetailListRequest(OCIRequest)
Get the list of events of a group schedule.
The response is either a GroupScheduleGetEventDetailListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| schedule_key | OCI.scheduleKey | scheduleKey |
GroupScheduleGetEventListRequest(OCIRequest)
Get the list of events of a group schedule.
The response is either a GroupScheduleGetEventListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| schedule_key | OCI.scheduleKey | scheduleKey |
GroupScheduleGetEventRequest(OCIRequest)
Get an event from a group schedule.
The response is either a GroupScheduleGetEventResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| schedule_key | OCI.scheduleKey | scheduleKey |
| event_name | str | eventName |
GroupScheduleModifyEventRequest(OCIRequest)
Modify an event of a group schedule.
The response is either a SuccessResponse() or an ErrorResponse(). The startDate
element is adjusted to the first occurrence of the recurrent schedule that comes at or
after the startDate. The endDate element is set to the sum of the adjusted starDate
element value and the event duration.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| schedule_key | OCI.scheduleKey | scheduleKey |
| event_name | str | eventName |
| new_event_name | str | newEventName Optional |
| start_date | str | startDate Optional |
| all_day_event | bool | allDayEvent Optional |
| start_time | OCI.startTime | startTime Optional |
| end_time | OCI.endTime | endTime Optional |
| end_date | str | endDate Optional |
| recurrence | OCI.recurrence | recurrence Optional |
GroupScheduleModifyRequest(OCIRequest)
Modify a group schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| schedule_key | OCI.scheduleKey | scheduleKey |
| new_schedule_name | str | newScheduleName Optional |
GroupScheduleUsageRequest(OCIRequest)
Get the list of services using a group schedule.
The response is either a GroupScheduleUsageResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| schedule_key | OCI.scheduleKey | scheduleKey |
GroupSeriesCompletionModifyInstanceRequest(OCIRequest)
Modifies a Series Completion group.
Replaces the entire list of users in the group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| new_name | str | newName Optional |
| user_id_list | OCI.userIdList | userIdList Optional |
GroupSessionAdmissionControlGroupAddDeviceListRequest(OCIRequest)
Request to add one ore more devices to a group level session admission control group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| devices | List[OCI.devices] | devices |
GroupSessionAdmissionControlGroupAddRequest(OCIRequest)
Request to add a session admission control group for the group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| max_session | int | maxSession |
| max_user_originating_sessions | int | maxUserOriginatingSessions Optional |
| max_user_terminating_sessions | int | maxUserTerminatingSessions Optional |
| reserved_session | int | reservedSession |
| reserved_user_originating_sessions | int | reservedUserOriginatingSessions Optional |
| reserved_user_terminating_sessions | int | reservedUserTerminatingSessions Optional |
| become_default_group | bool | becomeDefaultGroup |
| count_intra_sac_group_sessions | bool | countIntraSACGroupSessions |
| devices | List[OCI.devices] | devices Optional |
GroupSessionAdmissionControlGroupAddRequest19sp1(OCIRequest)
Request to add a session admission control group for the group.
The response is either a SuccessResponse() or an ErrorResponse(). Note that to
provision the accessInfoPattern element, the captureAccessInfoInPaniHeader system
parameter needs to be set to "true".
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| max_session | int | maxSession |
| max_user_originating_sessions | int | maxUserOriginatingSessions Optional |
| max_user_terminating_sessions | int | maxUserTerminatingSessions Optional |
| reserved_session | int | reservedSession |
| reserved_user_originating_sessions | int | reservedUserOriginatingSessions Optional |
| reserved_user_terminating_sessions | int | reservedUserTerminatingSessions Optional |
| become_default_group | bool | becomeDefaultGroup |
| count_intra_sac_group_sessions | bool | countIntraSACGroupSessions |
| devices | List[OCI.devices] | devices Optional |
| block_emergency_and_repair_calls_due_to_sac_limits | bool | blockEmergencyAndRepairCallsDueToSACLimits |
| media_group_name | str | mediaGroupName Optional |
| access_info_pattern | str | accessInfoPattern Optional |
GroupSessionAdmissionControlGroupDeleteDeviceListRequest(OCIRequest)
Request to delete one or more devices from a group level session admission control group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| devices | List[OCI.devices] | devices |
GroupTimeScheduleAddRequest(OCIRequest)
Add a time schedule to a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| time_schedule_name | str | timeScheduleName |
| time_interval01 | OCI.timeInterval01 | timeInterval01 Optional |
| time_interval02 | OCI.timeInterval02 | timeInterval02 Optional |
| time_interval03 | OCI.timeInterval03 | timeInterval03 Optional |
| time_interval04 | OCI.timeInterval04 | timeInterval04 Optional |
| time_interval05 | OCI.timeInterval05 | timeInterval05 Optional |
| time_interval06 | OCI.timeInterval06 | timeInterval06 Optional |
| time_interval07 | OCI.timeInterval07 | timeInterval07 Optional |
| time_interval08 | OCI.timeInterval08 | timeInterval08 Optional |
| time_interval09 | OCI.timeInterval09 | timeInterval09 Optional |
| time_interval10 | OCI.timeInterval10 | timeInterval10 Optional |
| time_interval11 | OCI.timeInterval11 | timeInterval11 Optional |
| time_interval12 | OCI.timeInterval12 | timeInterval12 Optional |
| time_interval13 | OCI.timeInterval13 | timeInterval13 Optional |
| time_interval14 | OCI.timeInterval14 | timeInterval14 Optional |
| time_interval15 | OCI.timeInterval15 | timeInterval15 Optional |
| time_interval16 | OCI.timeInterval16 | timeInterval16 Optional |
| time_interval17 | OCI.timeInterval17 | timeInterval17 Optional |
| time_interval18 | OCI.timeInterval18 | timeInterval18 Optional |
| time_interval19 | OCI.timeInterval19 | timeInterval19 Optional |
| time_interval20 | OCI.timeInterval20 | timeInterval20 Optional |
GroupTimeScheduleModifyRequest(OCIRequest)
Modify a specified time schedule in a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| time_schedule_name | str | timeScheduleName |
| new_time_schedule_name | str | newTimeScheduleName Optional |
| time_interval01 | OCI.timeInterval01 | timeInterval01 Optional |
| time_interval02 | OCI.timeInterval02 | timeInterval02 Optional |
| time_interval03 | OCI.timeInterval03 | timeInterval03 Optional |
| time_interval04 | OCI.timeInterval04 | timeInterval04 Optional |
| time_interval05 | OCI.timeInterval05 | timeInterval05 Optional |
| time_interval06 | OCI.timeInterval06 | timeInterval06 Optional |
| time_interval07 | OCI.timeInterval07 | timeInterval07 Optional |
| time_interval08 | OCI.timeInterval08 | timeInterval08 Optional |
| time_interval09 | OCI.timeInterval09 | timeInterval09 Optional |
| time_interval10 | OCI.timeInterval10 | timeInterval10 Optional |
| time_interval11 | OCI.timeInterval11 | timeInterval11 Optional |
| time_interval12 | OCI.timeInterval12 | timeInterval12 Optional |
| time_interval13 | OCI.timeInterval13 | timeInterval13 Optional |
| time_interval14 | OCI.timeInterval14 | timeInterval14 Optional |
| time_interval15 | OCI.timeInterval15 | timeInterval15 Optional |
| time_interval16 | OCI.timeInterval16 | timeInterval16 Optional |
| time_interval17 | OCI.timeInterval17 | timeInterval17 Optional |
| time_interval18 | OCI.timeInterval18 | timeInterval18 Optional |
| time_interval19 | OCI.timeInterval19 | timeInterval19 Optional |
| time_interval20 | OCI.timeInterval20 | timeInterval20 Optional |
GroupTrunkGroupDeleteInstanceRequest14sp4(OCIRequest)
Delete a Trunk Group Instance from a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupGetInstanceRequest14sp4(OCIRequest)
Get a Trunk Group Instance's profile.
The response is either a GroupTrunkGroupGetInstanceResponse14sp4() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupGetInstanceRequest14sp5(OCIRequest)
Get a Trunk Group Instance's profile.
The response is either a GroupTrunkGroupGetInstanceResponse14sp5() or an
ErrorResponse(). The response contains a hosted user table with column headings:
"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name".
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupGetInstanceRequest14sp9(OCIRequest)
Get a Trunk Group Instance's profile.
The response is either a GroupTrunkGroupGetInstanceResponse14sp9() or an
ErrorResponse(). The response contains a hosted user table with column headings:
"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name".
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupGetInstanceRequest15(OCIRequest)
Get a Trunk Group Instance's profile.
The response is either a GroupTrunkGroupGetInstanceResponse15() or an
ErrorResponse(). The response contains a hosted user table with column headings:
"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name".
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupGetInstanceRequest15sp2(OCIRequest)
Get a Trunk Group Instance's profile.
The response is either a GroupTrunkGroupGetInstanceResponse15sp2() or an
ErrorResponse(). The response contains a hosted user table with column headings:
"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name".
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupGetInstanceRequest17(OCIRequest)
Get a Trunk Group Instance's profile.
The response is either a GroupTrunkGroupGetInstanceResponse17() or an
ErrorResponse(). The response contains a hosted user table with column headings:
"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name".
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupGetInstanceRequest17sp3(OCIRequest)
Get a Trunk Group Instance's profile.
The response is either a GroupTrunkGroupGetInstanceResponse17sp3() or an
ErrorResponse(). The response contains a hosted user table with column headings:
"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name".
Replaced by: GroupTrunkGroupGetInstanceRequest17sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupGetInstanceRequest17sp4(OCIRequest)
Get a Trunk Group Instance's profile.
The response is either a GroupTrunkGroupGetInstanceResponse17sp4() or an
ErrorResponse(). The response contains a hosted user table with column headings:
"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",
"Phone Number", "Extension", "Department", "Email Address".
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupGetInstanceRequest19(OCIRequest)
Get a Trunk Group Instance's profile.
The response is either a GroupTrunkGroupGetInstanceResponse19() or an
ErrorResponse(). The response contains a hosted user table with column headings:
"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",
"Phone Number", "Extension", "Department", "Email Address". Replaced by
GroupTrunkGroupGetInstanceRequest19sp1().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupGetInstanceRequest19V2(OCIRequest)
Get a Trunk Group Instance's profile.
The response is either a GroupTrunkGroupGetInstanceResponse19V2() or an
ErrorResponse(). The response contains a hosted user table with column headings:
"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",
"Phone Number", "Extension", "Department", "Email Address". Replaced by
GroupTrunkGroupGetInstanceRequest19sp1V2.
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupGetInstanceRequest19sp1(OCIRequest)
Get a Trunk Group Instance's profile.
The response is either a GroupTrunkGroupGetInstanceResponse19sp1() or an
ErrorResponse(). The response contains a hosted user table with column headings:
"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",
"Phone Number", "Extension", "Department", "Email Address". Replaced by
GroupTrunkGroupGetInstanceRequest19sp1V2.
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupGetInstanceRequest20sp1(OCIRequest)
Get a Trunk Group Instance's profile.
The response is either a GroupTrunkGroupGetInstanceResponse20sp1() or an
ErrorResponse(). The response contains a hosted user table with column headings:
"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",
"Phone Number", "Extension", "Department", "Email Address". Replaced by:
GroupTrunkGroupGetInstanceRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupGetInstanceRequest21(OCIRequest)
Get a Trunk Group Instance's profile.
The response is either a GroupTrunkGroupGetInstanceResponse21() or an
ErrorResponse(). The response contains a hosted user table with column headings:
"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",
"Phone Number", "Extension", "Department", "Email Address". Replaced by:
GroupTrunkGroupGetInstanceResponse23()
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupGetInstanceRequest23(OCIRequest)
Get a Trunk Group Instance's profile.
The response is either a GroupTrunkGroupGetInstanceResponse23() or an
ErrorResponse(). The response contains a hosted user table with column headings:
"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",
"Phone Number", "Extension", "Department", "Email Address".
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupModifyInstanceRequest14sp4(OCIRequest)
Modify a Trunk Group Instance in a group.
The access device cannot be modified or cleared if there are any users assigned to the Trunk Group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
| new_name | str | newName Optional |
| pilot_user_id | str | pilotUserId Optional |
| department | OCI.department | department Optional |
| access_device | OCI.accessDevice | accessDevice Optional |
| max_active_calls | int | maxActiveCalls Optional |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting Optional |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_key | OCI.capacityExceededRerouteTrunkGroupKey | capacityExceededRerouteTrunkGroupKey Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls Optional |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls Optional |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_key | OCI.unreachableDestinationRerouteTrunkGroupKey | unreachableDestinationRerouteTrunkGroupKey Optional |
| unreachable_destination_trap_initial_calls | int | unreachableDestinationTrapInitialCalls Optional |
| unreachable_destination_trap_offset_calls | int | unreachableDestinationTrapOffsetCalls Optional |
| invitation_timeout | int | invitationTimeout Optional |
| require_authentication | bool | requireAuthentication Optional |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
| hosted_user_id_list | OCI.hostedUserIdList | hostedUserIdList Optional |
| trunk_group_identity | str | trunkGroupIdentity Optional |
| otg_dtg_identity | str | otgDtgIdentity Optional |
| include_trunk_group_identity | bool | includeTrunkGroupIdentity Optional |
| include_dtg_identity | bool | includeDtgIdentity Optional |
| enable_network_address_identity | bool | enableNetworkAddressIdentity Optional |
| allow_unscreened_calls | bool | allowUnscreenedCalls Optional |
| allow_unscreened_emergency_calls | bool | allowUnscreenedEmergencyCalls Optional |
| use_pilot_user_calling_line_identity | bool | usePilotUserCallingLineIdentity Optional |
| use_pilot_user_charge_number | bool | usePilotUserChargeNumber Optional |
| call_forwarding_always_action | str | callForwardingAlwaysAction Optional |
| call_forwarding_always_forward_address | str | callForwardingAlwaysForwardAddress Optional |
| call_forwarding_always_reroute_trunk_group_key | OCI.callForwardingAlwaysRerouteTrunkGroupKey | callForwardingAlwaysRerouteTrunkGroupKey Optional |
GroupTrunkGroupModifyInstanceRequest15(OCIRequest)
Modify a Trunk Group Instance in a group.
The access device cannot be modified or cleared if there are any users assigned to the Trunk Group. The command will fail if enableNetworkAddressIdentity is set and administrator is not System/Provisioning level administrator.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by
GroupTrunkGroupModifyInstanceRequest19sp1().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
| new_name | str | newName Optional |
| pilot_user_id | str | pilotUserId Optional |
| department | OCI.department | department Optional |
| access_device | OCI.accessDevice | accessDevice Optional |
| max_active_calls | int | maxActiveCalls Optional |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting Optional |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_key | OCI.capacityExceededRerouteTrunkGroupKey | capacityExceededRerouteTrunkGroupKey Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls Optional |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls Optional |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_key | OCI.unreachableDestinationRerouteTrunkGroupKey | unreachableDestinationRerouteTrunkGroupKey Optional |
| invitation_timeout | int | invitationTimeout Optional |
| require_authentication | bool | requireAuthentication Optional |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
| hosted_user_id_list | OCI.hostedUserIdList | hostedUserIdList Optional |
| trunk_group_identity | str | trunkGroupIdentity Optional |
| otg_dtg_identity | str | otgDtgIdentity Optional |
| allow_termination_to_trunk_group_identity | bool | allowTerminationToTrunkGroupIdentity Optional |
| allow_termination_to_dtg_identity | bool | allowTerminationToDtgIdentity Optional |
| include_trunk_group_identity | bool | includeTrunkGroupIdentity Optional |
| include_dtg_identity | bool | includeDtgIdentity Optional |
| include_trunk_group_identity_for_network_calls | bool | includeTrunkGroupIdentityForNetworkCalls Optional |
| include_otg_identity_for_network_calls | bool | includeOtgIdentityForNetworkCalls Optional |
| enable_network_address_identity | bool | enableNetworkAddressIdentity Optional |
| allow_unscreened_calls | bool | allowUnscreenedCalls Optional |
| allow_unscreened_emergency_calls | bool | allowUnscreenedEmergencyCalls Optional |
| pilot_user_calling_line_identity_policy | str | pilotUserCallingLineIdentityPolicy Optional |
| pilot_user_charge_number_policy | str | pilotUserChargeNumberPolicy Optional |
| call_forwarding_always_action | str | callForwardingAlwaysAction Optional |
| call_forwarding_always_forward_address | str | callForwardingAlwaysForwardAddress Optional |
| call_forwarding_always_reroute_trunk_group_key | OCI.callForwardingAlwaysRerouteTrunkGroupKey | callForwardingAlwaysRerouteTrunkGroupKey Optional |
| peering_domain | str | peeringDomain Optional |
| route_to_peering_domain | bool | routeToPeeringDomain Optional |
| prefix_enabled | bool | prefixEnabled Optional |
| prefix | str | prefix Optional |
| stateful_rerouting_enabled | bool | statefulReroutingEnabled Optional |
| send_continuous_options_message | bool | sendContinuousOptionsMessage Optional |
| continuous_options_sending_interval_seconds | int | continuousOptionsSendingIntervalSeconds Optional |
| failure_options_sending_interval_seconds | int | failureOptionsSendingIntervalSeconds Optional |
| failure_threshold_counter | int | failureThresholdCounter Optional |
| success_threshold_counter | int | successThresholdCounter Optional |
| invite_failure_threshold_counter | int | inviteFailureThresholdCounter Optional |
| invite_failure_threshold_window_seconds | int | inviteFailureThresholdWindowSeconds Optional |
| pilot_user_calling_line_asserted_identity_policy | str | pilotUserCallingLineAssertedIdentityPolicy Optional |
| use_system_calling_line_asserted_identity_policy | bool | useSystemCallingLineAssertedIdentityPolicy Optional |
| pilot_user_call_optimization_policy | str | pilotUserCallOptimizationPolicy Optional |
GroupTrunkGroupModifyInstanceRequest19sp1(OCIRequest)
Modify a Trunk Group Instance in a group.
The access device cannot be modified or cleared if there are any users assigned to the Trunk Group. The command will fail if enableNetworkAddressIdentity is set and administrator is not System/Provisioning level administrator. Following attributes are only used in IMS mode: implicitRegistrationSetSupportPolicy useSystemImplicitRegistrationSetSupportPolicy sipIdentityForPilotAndProxyTrunkModesPolicy useSystemSIPIdentityForPilotAndProxyTrunkModesPolicy
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
GroupTrunkGroupModifyInstanceRequest20sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
| new_name | str | newName Optional |
| pilot_user_id | str | pilotUserId Optional |
| department | OCI.department | department Optional |
| access_device | OCI.accessDevice | accessDevice Optional |
| max_active_calls | int | maxActiveCalls Optional |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting Optional |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_key | OCI.capacityExceededRerouteTrunkGroupKey | capacityExceededRerouteTrunkGroupKey Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls Optional |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls Optional |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_key | OCI.unreachableDestinationRerouteTrunkGroupKey | unreachableDestinationRerouteTrunkGroupKey Optional |
| invitation_timeout | int | invitationTimeout Optional |
| require_authentication | bool | requireAuthentication Optional |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
| hosted_user_id_list | OCI.hostedUserIdList | hostedUserIdList Optional |
| trunk_group_identity | str | trunkGroupIdentity Optional |
| otg_dtg_identity | str | otgDtgIdentity Optional |
| allow_termination_to_trunk_group_identity | bool | allowTerminationToTrunkGroupIdentity Optional |
| allow_termination_to_dtg_identity | bool | allowTerminationToDtgIdentity Optional |
| include_trunk_group_identity | bool | includeTrunkGroupIdentity Optional |
| include_dtg_identity | bool | includeDtgIdentity Optional |
| include_trunk_group_identity_for_network_calls | bool | includeTrunkGroupIdentityForNetworkCalls Optional |
| include_otg_identity_for_network_calls | bool | includeOtgIdentityForNetworkCalls Optional |
| enable_network_address_identity | bool | enableNetworkAddressIdentity Optional |
| allow_unscreened_calls | bool | allowUnscreenedCalls Optional |
| allow_unscreened_emergency_calls | bool | allowUnscreenedEmergencyCalls Optional |
| pilot_user_calling_line_identity_for_external_calls_policy | str | pilotUserCallingLineIdentityForExternalCallsPolicy Optional |
| pilot_user_charge_number_policy | str | pilotUserChargeNumberPolicy Optional |
| call_forwarding_always_action | str | callForwardingAlwaysAction Optional |
| call_forwarding_always_forward_address | str | callForwardingAlwaysForwardAddress Optional |
| call_forwarding_always_reroute_trunk_group_key | OCI.callForwardingAlwaysRerouteTrunkGroupKey | callForwardingAlwaysRerouteTrunkGroupKey Optional |
| peering_domain | str | peeringDomain Optional |
| route_to_peering_domain | bool | routeToPeeringDomain Optional |
| prefix_enabled | bool | prefixEnabled Optional |
| prefix | str | prefix Optional |
| stateful_rerouting_enabled | bool | statefulReroutingEnabled Optional |
| send_continuous_options_message | bool | sendContinuousOptionsMessage Optional |
| continuous_options_sending_interval_seconds | int | continuousOptionsSendingIntervalSeconds Optional |
| failure_options_sending_interval_seconds | int | failureOptionsSendingIntervalSeconds Optional |
| failure_threshold_counter | int | failureThresholdCounter Optional |
| success_threshold_counter | int | successThresholdCounter Optional |
| invite_failure_threshold_counter | int | inviteFailureThresholdCounter Optional |
| invite_failure_threshold_window_seconds | int | inviteFailureThresholdWindowSeconds Optional |
| pilot_user_calling_line_asserted_identity_policy | str | pilotUserCallingLineAssertedIdentityPolicy Optional |
| use_system_calling_line_asserted_identity_policy | bool | useSystemCallingLineAssertedIdentityPolicy Optional |
| pilot_user_call_optimization_policy | str | pilotUserCallOptimizationPolicy Optional |
| clid_source_for_screened_calls_policy | str | clidSourceForScreenedCallsPolicy Optional |
| use_system_clid_source_for_screened_calls_policy | bool | useSystemCLIDSourceForScreenedCallsPolicy Optional |
| user_lookup_policy | str | userLookupPolicy Optional |
| use_system_user_lookup_policy | bool | useSystemUserLookupPolicy Optional |
| pilot_user_calling_line_identity_for_emergency_calls_policy | str | pilotUserCallingLineIdentityForEmergencyCallsPolicy Optional |
| implicit_registration_set_support_policy | str | implicitRegistrationSetSupportPolicy Optional |
| use_system_implicit_registration_set_support_policy | bool | useSystemImplicitRegistrationSetSupportPolicy Optional |
| sip_identity_for_pilot_and_proxy_trunk_modes_policy | str | sipIdentityForPilotAndProxyTrunkModesPolicy Optional |
| use_system_sip_identity_for_pilot_and_proxy_trunk_modes_policy | bool | useSystemSIPIdentityForPilotAndProxyTrunkModesPolicy Optional |
| use_system_support_connected_identity_policy | bool | useSystemSupportConnectedIdentityPolicy Optional |
| support_connected_identity_policy | str | supportConnectedIdentityPolicy Optional |
| use_system_options_message_response_status_codes | bool | useSystemOptionsMessageResponseStatusCodes Optional |
| delete_options_message_response_status_code | List[str] | deleteOptionsMessageResponseStatusCode Optional |
GroupTrunkGroupModifyInstanceRequest20sp1(OCIRequest)
Modify a Trunk Group Instance in a group.
The access device cannot be modified or cleared if there are any users assigned to the Trunk Group. The command will fail if enableNetworkAddressIdentity is set and administrator is not System/Provisioning level administrator. Following attributes are only used in IMS mode: implicitRegistrationSetSupportPolicy useSystemImplicitRegistrationSetSupportPolicy sipIdentityForPilotAndProxyTrunkModesPolicy useSystemSIPIdentityForPilotAndProxyTrunkModesPolicy
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
| new_name | str | newName Optional |
| pilot_user_id | str | pilotUserId Optional |
| department | OCI.department | department Optional |
| access_device | OCI.accessDevice | accessDevice Optional |
| max_active_calls | int | maxActiveCalls Optional |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting Optional |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_key | OCI.capacityExceededRerouteTrunkGroupKey | capacityExceededRerouteTrunkGroupKey Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls Optional |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls Optional |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_key | OCI.unreachableDestinationRerouteTrunkGroupKey | unreachableDestinationRerouteTrunkGroupKey Optional |
| invitation_timeout | int | invitationTimeout Optional |
| require_authentication | bool | requireAuthentication Optional |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
| hosted_user_id_list | OCI.hostedUserIdList | hostedUserIdList Optional |
| trunk_group_identity | str | trunkGroupIdentity Optional |
| otg_dtg_identity | str | otgDtgIdentity Optional |
| allow_termination_to_trunk_group_identity | bool | allowTerminationToTrunkGroupIdentity Optional |
| allow_termination_to_dtg_identity | bool | allowTerminationToDtgIdentity Optional |
| include_trunk_group_identity | bool | includeTrunkGroupIdentity Optional |
| include_dtg_identity | bool | includeDtgIdentity Optional |
| include_trunk_group_identity_for_network_calls | bool | includeTrunkGroupIdentityForNetworkCalls Optional |
| include_otg_identity_for_network_calls | bool | includeOtgIdentityForNetworkCalls Optional |
| enable_network_address_identity | bool | enableNetworkAddressIdentity Optional |
| allow_unscreened_calls | bool | allowUnscreenedCalls Optional |
| allow_unscreened_emergency_calls | bool | allowUnscreenedEmergencyCalls Optional |
| pilot_user_calling_line_identity_for_external_calls_policy | str | pilotUserCallingLineIdentityForExternalCallsPolicy Optional |
| pilot_user_charge_number_policy | str | pilotUserChargeNumberPolicy Optional |
| call_forwarding_always_action | str | callForwardingAlwaysAction Optional |
| call_forwarding_always_forward_address | str | callForwardingAlwaysForwardAddress Optional |
| call_forwarding_always_reroute_trunk_group_key | OCI.callForwardingAlwaysRerouteTrunkGroupKey | callForwardingAlwaysRerouteTrunkGroupKey Optional |
| peering_domain | str | peeringDomain Optional |
| route_to_peering_domain | bool | routeToPeeringDomain Optional |
| prefix_enabled | bool | prefixEnabled Optional |
| prefix | str | prefix Optional |
| stateful_rerouting_enabled | bool | statefulReroutingEnabled Optional |
| send_continuous_options_message | bool | sendContinuousOptionsMessage Optional |
| continuous_options_sending_interval_seconds | int | continuousOptionsSendingIntervalSeconds Optional |
| failure_options_sending_interval_seconds | int | failureOptionsSendingIntervalSeconds Optional |
| failure_threshold_counter | int | failureThresholdCounter Optional |
| success_threshold_counter | int | successThresholdCounter Optional |
| invite_failure_threshold_counter | int | inviteFailureThresholdCounter Optional |
| invite_failure_threshold_window_seconds | int | inviteFailureThresholdWindowSeconds Optional |
| pilot_user_calling_line_asserted_identity_policy | str | pilotUserCallingLineAssertedIdentityPolicy Optional |
| use_system_calling_line_asserted_identity_policy | bool | useSystemCallingLineAssertedIdentityPolicy Optional |
| pilot_user_call_optimization_policy | str | pilotUserCallOptimizationPolicy Optional |
| clid_source_for_screened_calls_policy | str | clidSourceForScreenedCallsPolicy Optional |
| use_system_clid_source_for_screened_calls_policy | bool | useSystemCLIDSourceForScreenedCallsPolicy Optional |
| user_lookup_policy | str | userLookupPolicy Optional |
| use_system_user_lookup_policy | bool | useSystemUserLookupPolicy Optional |
| pilot_user_calling_line_identity_for_emergency_calls_policy | str | pilotUserCallingLineIdentityForEmergencyCallsPolicy Optional |
| implicit_registration_set_support_policy | str | implicitRegistrationSetSupportPolicy Optional |
| use_system_implicit_registration_set_support_policy | bool | useSystemImplicitRegistrationSetSupportPolicy Optional |
| sip_identity_for_pilot_and_proxy_trunk_modes_policy | str | sipIdentityForPilotAndProxyTrunkModesPolicy Optional |
| use_system_sip_identity_for_pilot_and_proxy_trunk_modes_policy | bool | useSystemSIPIdentityForPilotAndProxyTrunkModesPolicy Optional |
| use_system_support_connected_identity_policy | bool | useSystemSupportConnectedIdentityPolicy Optional |
| support_connected_identity_policy | str | supportConnectedIdentityPolicy Optional |
| use_system_options_message_response_status_codes | bool | useSystemOptionsMessageResponseStatusCodes Optional |
| delete_options_message_response_status_code | List[str] | deleteOptionsMessageResponseStatusCode Optional |
GroupTrunkGroupModifyRequest(OCIRequest)
Modify the maximum and bursting maximum permissible active Trunk Group calls for the group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| max_active_calls | OCI.maxActiveCalls | maxActiveCalls Optional |
| bursting_max_active_calls | OCI.burstingMaxActiveCalls | burstingMaxActiveCalls Optional |
GroupTrunkGroupModifyRequest14sp9(OCIRequest)
Modify the maximum and bursting maximum permissible active Trunk Group calls for the group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| max_active_calls | int | maxActiveCalls Optional |
| bursting_max_active_calls | OCI.burstingMaxActiveCalls | burstingMaxActiveCalls Optional |
| number_of_bursting_btl_us | int | numberOfBurstingBTLUs Optional |
GroupTrunkGroupOptionsMessageResponseStatusCodeAddListRequest(OCIRequest)
Add a list of trunk group level successful SIP OPTIONS message respoonse status codes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
| status_code | List[str] | statusCode |
GroupTrunkGroupSecurityClassificationGetRequest(OCIRequest)
Get a trunk group's Security Classifications configuration.
The response is either GroupTrunkGroupSecurityClassificationGetResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupSecurityClassificationModifyRequest(OCIRequest)
Modify a trunk group's Security Classification configuration The response is either a
SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
| default_security_classification | str | defaultSecurityClassification |
GroupTrunkGroupStirShakenGetRequest(OCIRequest)
Get Group Trunk Group Stir Shaken service settings.
The response is either GroupTrunkGroupStirShakenGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupStirShakenGetRequest23(OCIRequest)
Get Group Trunk Group Stir Shaken service settings.
The response is either GroupTrunkGroupStirShakenGetResponse23() or
ErrorResponse(). Replaced by GroupTrunkGroupStirShakenGetRequest23V2().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupStirShakenGetRequest23V2(OCIRequest)
Get Group Trunk Group Stir Shaken service settings.
The response is either GroupTrunkGroupStirShakenGetResponse23V2() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupStirShakenModifyRequest(OCIRequest)
Modify group trunk group Stir Shaken service settings.
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
| use_parent_level_settings | bool | useParentLevelSettings Optional |
| signing_policy | str | signingPolicy Optional |
| tagging_policy | str | taggingPolicy Optional |
| signing_service_url | str | signingServiceURL Optional |
| tag_from_or_pai | str | tagFromOrPAI Optional |
| verstat_tag | str | verstatTag Optional |
| use_os_value_for_orig_id | bool | useOSValueForOrigId Optional |
| orig_uuid | str | origUUID Optional |
| attestation_level | str | attestationLevel Optional |
| enable_signing_for_unscreened_trunk_group_originations | bool | enableSigningForUnscreenedTrunkGroupOriginations Optional |
| enable_tagging_for_unscreened_trunk_group_originations | bool | enableTaggingForUnscreenedTrunkGroupOriginations Optional |
| unscreened_trunk_group_origination_attestation_level | str | unscreenedTrunkGroupOriginationAttestationLevel Optional |
| check_directory_numbers_for_attestation | bool | checkDirectoryNumbersForAttestation Optional |
| match_unassigned_numbers_only | bool | matchUnassignedNumbersOnly Optional |
| enable_tagging_for_redirected_calls | bool | enableTaggingForRedirectedCalls Optional |
GroupTrunkGroupUserCreationTaskAddRequest14sp4(OCIRequest)
Add a user creation task for a trunk group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
| task_name | str | taskName |
| user_id_format | str | userIdFormat |
| user_id_domain | str | userIdDomain |
| populate_extension | bool | populateExtension |
| line_port_format | str | linePortFormat |
| line_port_domain | str | linePortDomain |
| populate_contact | bool | populateContact |
| contact_format | str | contactFormat Optional |
| contact_domain | str | contactDomain Optional |
| user_phone_numbers | OCI.userPhoneNumbers | userPhoneNumbers Optional |
| user_extensions | OCI.userExtensions | userExtensions Optional |
| service_pack_name | List[str] | servicePackName Optional |
| user_service | List[str] | userService Optional |
GroupTrunkGroupUserCreationTaskDeleteRequest14sp4(OCIRequest)
Delete a user creation task for a trunk group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
| task_name | str | taskName |
GroupTrunkGroupUserCreationTaskGetListRequest14sp4(OCIRequest)
Get the list of user creation tasks for a trunk group.
The response is either GroupTrunkGroupUserCreationTaskGetListResponse14sp4() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
GroupTrunkGroupUserCreationTaskGetRequest14sp4(OCIRequest)
Request the details of a specified user creation task for a trunk group.
The response is either GroupTrunkGroupUserCreationTaskGetResponse14sp4() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
| task_name | str | taskName |
GroupVoiceMessagingGroupModifyVoicePortalBrandingExecutionServerRequest(OCIRequest)
Modify the group's voice portal branding settings.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command can only be executed from the Execution Server
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| voice_portal_greeting_selection | str | voicePortalGreetingSelection Optional |
| voice_portal_greeting_file | OCI.voicePortalGreetingFile | voicePortalGreetingFile Optional |
| voice_messaging_greeting_selection | str | voiceMessagingGreetingSelection Optional |
| voice_messaging_greeting_file | OCI.voiceMessagingGreetingFile | voiceMessagingGreetingFile Optional |
GroupVoiceMessagingGroupModifyVoicePortalBrandingRequest(OCIRequest)
Modify the group's voice portal branding settings.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: GroupVoiceMessagingGroupModifyVoicePortalBrandingRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| voice_portal_greeting_selection | str | voicePortalGreetingSelection Optional |
| voice_portal_greeting_file | OCI.voicePortalGreetingFile | voicePortalGreetingFile Optional |
| voice_messaging_greeting_selection | str | voiceMessagingGreetingSelection Optional |
| voice_messaging_greeting_file | OCI.voiceMessagingGreetingFile | voiceMessagingGreetingFile Optional |
GroupVoiceMessagingGroupModifyVoicePortalBrandingRequest16(OCIRequest)
Modify the group's voice portal branding settings.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
GroupVoiceMessagingGroupModifyVoicePortalBrandingRequest20() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| voice_portal_greeting_selection | str | voicePortalGreetingSelection Optional |
| voice_portal_greeting_file | OCI.voicePortalGreetingFile | voicePortalGreetingFile Optional |
| voice_messaging_greeting_selection | str | voiceMessagingGreetingSelection Optional |
| voice_messaging_greeting_file | OCI.voiceMessagingGreetingFile | voiceMessagingGreetingFile Optional |
GroupVoiceMessagingGroupModifyVoicePortalBrandingRequest20(OCIRequest)
Modify the group's voice portal branding settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| voice_portal_greeting_selection | str | voicePortalGreetingSelection Optional |
| voice_portal_greeting_file | OCI.voicePortalGreetingFile | voicePortalGreetingFile Optional |
| voice_messaging_greeting_selection | str | voiceMessagingGreetingSelection Optional |
| voice_messaging_greeting_file | OCI.voiceMessagingGreetingFile | voiceMessagingGreetingFile Optional |
GroupVoiceXmlModifyActiveInstanceListRequest(OCIRequest)
Request to set the active status of VoiceXML instances.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_activation | List[OCI.serviceActivation] | serviceActivation Optional |
GroupXsiPolicyProfileAssignListRequest(OCIRequest)
Assign a group level Xsi policy profile and a list of user Xsi policy profiles to a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_xsi_policy_profile | str | groupXsiPolicyProfile Optional |
| user_xsi_policy_profile | OCI.userXsiPolicyProfile | userXsiPolicyProfile Optional |
GroupXsiPolicyProfileUnassignListRequest(OCIRequest)
Unassign a list of Xsi policy profile.
Only user level Xsi policy profile can be unassigned.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| user_xsi_policy_profile | OCI.userXsiPolicyProfile | userXsiPolicyProfile Optional |
PasswordGenerateRequest(OCIRequest)
Generate passwords based on the corresponding password/passcode rules.
The response is either PasswordGenerateResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| system_administrator_password | OCI.systemAdministratorPassword | systemAdministratorPassword Optional |
| service_provider_administrator_password | OCI.serviceProviderAdministratorPassword | serviceProviderAdministratorPassword Optional |
| group_administrator_password | OCI.groupAdministratorPassword | groupAdministratorPassword Optional |
| user_password | OCI.userPassword | userPassword Optional |
| access_device_authentication_password | OCI.accessDeviceAuthenticationPassword | accessDeviceAuthenticationPassword Optional |
| trunk_group_authentication_password | OCI.trunkGroupAuthenticationPassword | trunkGroupAuthenticationPassword Optional |
ResellerNetworkClassOfServiceAssignListRequest(OCIRequest)
Assign a list of Network Classes of Service to a reseller.
A default Network Class of Service is optional.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| network_class_of_service | List[str] | networkClassOfService Optional |
| default_network_class_of_service | OCI.defaultNetworkClassOfService | defaultNetworkClassOfService Optional |
ResellerNetworkClassOfServiceUnassignListRequest(OCIRequest)
Unassign a list of Network Classes of Service from a reseller.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| network_class_of_service | List[str] | networkClassOfService Optional |
| default_network_class_of_service | OCI.defaultNetworkClassOfService | defaultNetworkClassOfService Optional |
ResellerServiceAuthorizationModifyRequest(OCIRequest)
Modify the reseller service authorization file.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| service_offering | OCI.serviceOffering | serviceOffering Optional |
ResellerXsiPolicyProfileAssignListRequest(OCIRequest)
Assign a list of Xsi policy profile to a reseller.
It contains the service provider, group, user level Xsi policy profile. Each level has one default Xsi policy profile assigned.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| sp_xsi_policy_profile | OCI.spXsiPolicyProfile | spXsiPolicyProfile Optional |
| group_xsi_policy_profile | OCI.groupXsiPolicyProfile | groupXsiPolicyProfile Optional |
| user_xsi_policy_profile | OCI.userXsiPolicyProfile | userXsiPolicyProfile Optional |
ResellerXsiPolicyProfileUnassignListRequest(OCIRequest)
Unassign a list of Xsi policy profile.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| sp_xsi_policy_profile | OCI.spXsiPolicyProfile | spXsiPolicyProfile Optional |
| group_xsi_policy_profile | OCI.groupXsiPolicyProfile | groupXsiPolicyProfile Optional |
| user_xsi_policy_profile | OCI.userXsiPolicyProfile | userXsiPolicyProfile Optional |
ServiceProviderAccessDeviceAddRequest14(OCIRequest)
Request to add a service provider access device.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: ServiceProviderAccessDeviceAddRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| device_type | str | deviceType |
| protocol | str | protocol Optional |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| outbound_proxy_server_net_address | str | outboundProxyServerNetAddress Optional |
| stun_server_net_address | str | stunServerNetAddress Optional |
| mac_address | str | macAddress Optional |
| serial_number | str | serialNumber Optional |
| description | str | description Optional |
| physical_location | str | physicalLocation Optional |
| transport_protocol | str | transportProtocol Optional |
| mobility_manager_provisioning_url | str | mobilityManagerProvisioningURL Optional |
| mobility_manager_provisioning_user_name | str | mobilityManagerProvisioningUserName Optional |
| mobility_manager_provisioning_password | str | mobilityManagerProvisioningPassword Optional |
| mobility_manager_default_originating_service_key | int | mobilityManagerDefaultOriginatingServiceKey Optional |
| mobility_manager_default_terminating_service_key | int | mobilityManagerDefaultTerminatingServiceKey Optional |
| use_custom_user_name_password | bool | useCustomUserNamePassword Optional |
| access_device_credentials | OCI.accessDeviceCredentials | accessDeviceCredentials Optional |
ServiceProviderAccessDeviceAddRequest22(OCIRequest)
Request to add a service provider access device.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: useHotline
hotlineContact serviceProviderExternalId deviceExternalId
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| device_name | str | deviceName Optional |
| service_provider_external_id | str | serviceProviderExternalId Optional |
| device_external_id | str | deviceExternalId Optional |
| device_type | str | deviceType |
| protocol | str | protocol Optional |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| outbound_proxy_server_net_address | str | outboundProxyServerNetAddress Optional |
| stun_server_net_address | str | stunServerNetAddress Optional |
| mac_address | str | macAddress Optional |
| serial_number | str | serialNumber Optional |
| description | str | description Optional |
| physical_location | str | physicalLocation Optional |
| transport_protocol | str | transportProtocol Optional |
| mobility_manager_provisioning_url | str | mobilityManagerProvisioningURL Optional |
| mobility_manager_provisioning_user_name | str | mobilityManagerProvisioningUserName Optional |
| mobility_manager_provisioning_password | str | mobilityManagerProvisioningPassword Optional |
| mobility_manager_default_originating_service_key | int | mobilityManagerDefaultOriginatingServiceKey Optional |
| mobility_manager_default_terminating_service_key | int | mobilityManagerDefaultTerminatingServiceKey Optional |
| use_custom_user_name_password | bool | useCustomUserNamePassword Optional |
| access_device_credentials | OCI.accessDeviceCredentials | accessDeviceCredentials Optional |
| use_hotline | bool | useHotline |
| hotline_contact | str | hotlineContact Optional |
ServiceProviderAccessDeviceAddRequest22V2(OCIRequest)
Request to add a service provider access device.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
serviceProviderExternalId deviceExternalId deviceIPEI
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| device_name | str | deviceName Optional |
| service_provider_external_id | str | serviceProviderExternalId Optional |
| device_external_id | str | deviceExternalId Optional |
| device_type | str | deviceType |
| protocol | str | protocol Optional |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| outbound_proxy_server_net_address | str | outboundProxyServerNetAddress Optional |
| stun_server_net_address | str | stunServerNetAddress Optional |
| mac_address | str | macAddress Optional |
| serial_number | str | serialNumber Optional |
| description | str | description Optional |
| physical_location | str | physicalLocation Optional |
| transport_protocol | str | transportProtocol Optional |
| use_custom_user_name_password | bool | useCustomUserNamePassword Optional |
| access_device_credentials | OCI.accessDeviceCredentials | accessDeviceCredentials Optional |
| device_ipei | str | deviceIPEI Optional |
ServiceProviderAccessDeviceCustomTagAddOrModifyListRequest(OCIRequest)
Request to add or modify a list of static configuration tag for a service provider access device.
If the tag does not exist, it is added. If the tag exists, its value is updated.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| tag | List[OCI.tag] | tag |
ServiceProviderAccessDeviceFileModifyRequest(OCIRequest)
Request to modify a specified service provider/enterprise access device file.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: ServiceProviderAccessDeviceFileModifyRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| file_type | str | fileType |
| file_source | str | fileSource Optional |
| upload_file | OCI.uploadFile | uploadFile Optional |
ServiceProviderAccessDeviceFileModifyRequest14sp8(OCIRequest)
Request to modify a specified service provider/enterprise access device file.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| file_format | str | fileFormat |
| file_source | str | fileSource Optional |
| upload_file | OCI.uploadFile | uploadFile Optional |
| extended_capture_enabled | bool | extendedCaptureEnabled Optional |
ServiceProviderAccessDeviceLinkDeviceListRequest(OCIRequest)
Request to link one or more leaf devices to a service provider level tree device.
A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| leaf_device_key | List[OCI.leafDeviceKey] | leafDeviceKey |
ServiceProviderAccessDeviceModifyRequest14(OCIRequest)
Request to modify a specified service provider access device.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: useHotline
hotlineContact deviceExternalId
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
| protocol | str | protocol Optional |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| outbound_proxy_server_net_address | str | outboundProxyServerNetAddress Optional |
| stun_server_net_address | str | stunServerNetAddress Optional |
| mac_address | str | macAddress Optional |
| serial_number | str | serialNumber Optional |
| description | str | description Optional |
| physical_location | str | physicalLocation Optional |
| transport_protocol | str | transportProtocol Optional |
| mobility_manager_provisioning_url | str | mobilityManagerProvisioningURL Optional |
| mobility_manager_provisioning_user_name | str | mobilityManagerProvisioningUserName Optional |
| mobility_manager_provisioning_password | str | mobilityManagerProvisioningPassword Optional |
| mobility_manager_default_originating_service_key | int | mobilityManagerDefaultOriginatingServiceKey Optional |
| mobility_manager_default_terminating_service_key | int | mobilityManagerDefaultTerminatingServiceKey Optional |
| use_custom_user_name_password | bool | useCustomUserNamePassword Optional |
| access_device_credentials | OCI.accessDeviceCredentials | accessDeviceCredentials Optional |
| use_hotline | bool | useHotline Optional |
| hotline_contact | str | hotlineContact Optional |
ServiceProviderAccessDeviceModifyRequest22(OCIRequest)
Request to modify a specified service provider access device.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: deviceExternalId
deviceIPEI useDeviceCode deviceCode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
| protocol | str | protocol Optional |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| outbound_proxy_server_net_address | str | outboundProxyServerNetAddress Optional |
| stun_server_net_address | str | stunServerNetAddress Optional |
| mac_address | str | macAddress Optional |
| serial_number | str | serialNumber Optional |
| description | str | description Optional |
| physical_location | str | physicalLocation Optional |
| transport_protocol | str | transportProtocol Optional |
| use_custom_user_name_password | bool | useCustomUserNamePassword Optional |
| access_device_credentials | OCI.accessDeviceCredentials | accessDeviceCredentials Optional |
| device_ipei | str | deviceIPEI Optional |
| use_device_code | bool | useDeviceCode Optional |
| device_code | str | deviceCode Optional |
ServiceProviderAccessDeviceUnlinkDeviceListRequest(OCIRequest)
Request to unlink one or more leaf access devices from a tree device.
A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| leaf_device_key | List[OCI.leafDeviceKey] | leafDeviceKey |
ServiceProviderAddRequest13mp2(OCIRequest)
Add a service provider or enterprise.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are ignored in AS and XS data mode: servicePolicy, callProcessingSliceId,
provisioningSliceId, subscriberPartition. The following elements are only used XS
data mode and ignored in AS data mode: preferredDataCenter. Only Provisioning admin
and above can change the preferredDataCenter. The following data elements are only
used in AS data mode: resellerId If reseller administrator sends the request,
resellerId is ignored. The reseller administrator's reseller id is used. Replaced
by: ServiceProviderConsolidatedAddRequest() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| is_enterprise | bool | isEnterprise Optional |
| use_custom_routing_profile | bool | useCustomRoutingProfile Optional |
| service_provider_id | str | serviceProviderId |
| default_domain | str | defaultDomain |
| service_provider_name | str | serviceProviderName Optional |
| support_email | str | supportEmail Optional |
| contact | OCI.contact | contact Optional |
| address | OCI.address | address Optional |
| service_policy | str | servicePolicy Optional |
| call_processing_slice_id | str | callProcessingSliceId Optional |
| provisioning_slice_id | str | provisioningSliceId Optional |
| subscriber_partition | str | subscriberPartition Optional |
| preferred_data_center | str | preferredDataCenter Optional |
| reseller_id | str | resellerId Optional |
ServiceProviderAnswerConfirmationModifyRequest(OCIRequest)
Modify a service provider or enterprise's answer confirmation settings.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: ServiceProviderAnswerConfirmationModifyRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| announcement_message_selection | str | announcementMessageSelection Optional |
| confirmation_message_audio_file | OCI.confirmationMessageAudioFile | confirmationMessageAudioFile Optional |
| confirmation_timout_seconds | int | confirmationTimoutSeconds Optional |
ServiceProviderAnswerConfirmationModifyRequest16(OCIRequest)
Modify a service provider or enterprise's answer confirmation settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| announcement_message_selection | str | announcementMessageSelection Optional |
| confirmation_message_audio_file | OCI.confirmationMessageAudioFile | confirmationMessageAudioFile Optional |
| confirmation_timout_seconds | int | confirmationTimoutSeconds Optional |
ServiceProviderCPEConfigSetConfigFileRequest(OCIRequest)
Request to set a new service provider default configuration file for a device type.
The response is either a SuccessResponse() or an ErrorResponse(). When the element
configFile is set to nil, the configuration file defined at the parent level is used.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_type | str | deviceType |
| config_file | OCI.configFile | configFile |
ServiceProviderCommunicationBarringProfileAddRequest(OCIRequest)
Add a new Communication Barring Profile.
The priorities for OriginatingRules, RedirectingRules and IncomingRules are requantized to consecutive integers as part of the add.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| description | str | description Optional |
| originating_default_action | str | originatingDefaultAction |
| originating_default_treatment_id | str | originatingDefaultTreatmentId Optional |
| originating_default_transfer_number | str | originatingDefaultTransferNumber Optional |
| originating_default_call_timeout | int | originatingDefaultCallTimeout Optional |
| originating_rule | List[OCI.originatingRule] | originatingRule Optional |
| redirecting_default_action | str | redirectingDefaultAction |
| redirecting_default_call_timeout | int | redirectingDefaultCallTimeout Optional |
| redirecting_rule | List[OCI.redirectingRule] | redirectingRule Optional |
| incoming_default_action | str | incomingDefaultAction |
| incoming_default_call_timeout | int | incomingDefaultCallTimeout Optional |
| incoming_rule | List[OCI.incomingRule] | incomingRule Optional |
| become_default | bool | becomeDefault |
ServiceProviderCommunicationBarringProfileAddRequest17sp3(OCIRequest)
Add a new Communication Barring Profile.
The priorities for OriginatingRules, RedirectingRules, CallMeNowRules and IncomingRules are requantized to consecutive integers as part of the add.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: callMeNowDefaultAction, use value "Block" in
XS data mode The following elements are only used in AS data mode and ignored in XS
data mode callMeNowDefaultCallTimeout callMeNowRule
Replaced By : ServiceProviderCommunicationBarringProfileAddRequest19sp1() in AS data
mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| description | str | description Optional |
| originating_default_action | str | originatingDefaultAction |
| originating_default_treatment_id | str | originatingDefaultTreatmentId Optional |
| originating_default_transfer_number | str | originatingDefaultTransferNumber Optional |
| originating_default_call_timeout | int | originatingDefaultCallTimeout Optional |
| originating_rule | List[OCI.originatingRule] | originatingRule Optional |
| redirecting_default_action | str | redirectingDefaultAction |
| redirecting_default_call_timeout | int | redirectingDefaultCallTimeout Optional |
| redirecting_rule | List[OCI.redirectingRule] | redirectingRule Optional |
| call_me_now_default_action | str | callMeNowDefaultAction |
| call_me_now_default_call_timeout | int | callMeNowDefaultCallTimeout Optional |
| call_me_now_rule | List[OCI.callMeNowRule] | callMeNowRule Optional |
| incoming_default_action | str | incomingDefaultAction |
| incoming_default_call_timeout | int | incomingDefaultCallTimeout Optional |
| incoming_rule | List[OCI.incomingRule] | incomingRule Optional |
| become_default | bool | becomeDefault |
ServiceProviderCommunicationBarringProfileAddRequest19sp1(OCIRequest)
Add a new Communication Barring Profile.
The priorities for OriginatingRules, RedirectingRules, CallMeNowRules and IncomingRules are requantized to consecutive integers as part of the add.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: callMeNowDefaultAction, use value "Block" in
XS data mode callMeNowDefaultCallTimeout callMeNowRule applyToAttendedCallTransfers,
use value "false" in XS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| description | str | description Optional |
| originating_default_action | str | originatingDefaultAction |
| originating_default_treatment_id | str | originatingDefaultTreatmentId Optional |
| originating_default_transfer_number | str | originatingDefaultTransferNumber Optional |
| originating_default_call_timeout | int | originatingDefaultCallTimeout Optional |
| originating_rule | List[OCI.originatingRule] | originatingRule Optional |
| redirecting_default_action | str | redirectingDefaultAction |
| redirecting_default_call_timeout | int | redirectingDefaultCallTimeout Optional |
| redirecting_rule | List[OCI.redirectingRule] | redirectingRule Optional |
| call_me_now_default_action | str | callMeNowDefaultAction |
| call_me_now_default_call_timeout | int | callMeNowDefaultCallTimeout Optional |
| call_me_now_rule | List[OCI.callMeNowRule] | callMeNowRule Optional |
| incoming_default_action | str | incomingDefaultAction |
| incoming_default_call_timeout | int | incomingDefaultCallTimeout Optional |
| incoming_rule | List[OCI.incomingRule] | incomingRule Optional |
| become_default | bool | becomeDefault |
| apply_to_attended_call_transfers | bool | applyToAttendedCallTransfers |
ServiceProviderDeviceTypeFileModifyRequest(OCIRequest)
Request to modify a specified device type file for a service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_type | str | deviceType |
| file_format | str | fileFormat |
| file_source | str | fileSource Optional |
| upload_file | OCI.uploadFile | uploadFile Optional |
ServiceProviderDialableCallerIDCriteriaModifyRequest(OCIRequest)
Modify a Dialable Caller ID Criteria.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| prefix_digits | str | prefixDigits Optional |
| match_call_type | OCI.matchCallType | matchCallType Optional |
| match_alternate_call_indicator | OCI.matchAlternateCallIndicator | matchAlternateCallIndicator Optional |
| match_local_category | bool | matchLocalCategory Optional |
| match_national_category | bool | matchNationalCategory Optional |
| match_interlata_category | bool | matchInterlataCategory Optional |
| match_intralata_category | bool | matchIntralataCategory Optional |
| match_international_category | bool | matchInternationalCategory Optional |
| match_private_category | bool | matchPrivateCategory Optional |
| match_emergency_category | bool | matchEmergencyCategory Optional |
| match_other_category | bool | matchOtherCategory Optional |
ServiceProviderDialableCallerIDModifyRequest(OCIRequest)
Modify the service provider?s Dialable Caller ID settings and criteria list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| use_service_provider_criteria | bool | useServiceProviderCriteria Optional |
| ns_screening_failure_policy | str | nsScreeningFailurePolicy Optional |
| criteria_priority_order | List[OCI.criteriaPriorityOrder] | criteriaPriorityOrder Optional |
ServiceProviderDnAddListRequest(OCIRequest)
Adds DNs to a service provider.
It is possible to add either: a single DN, or a list of DNs, or a range of DNs, or any combination thereof.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| phone_number | List[str] | phoneNumber Optional |
| dn_range | List[OCI.dnRange] | dnRange Optional |
ServiceProviderDnDeleteListRequest(OCIRequest)
Deletes DNs from a service provider.
It is possible to delete either: a single DN, or a list of DNs, or a range of DNs, or any combination thereof.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| phone_number | List[str] | phoneNumber Optional |
| dn_range | List[OCI.dnRange] | dnRange Optional |
ServiceProviderFeatureAccessCodeModifyListRequest(OCIRequest)
Modify a list of feature access codes for a service provider or enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By : ServiceProviderFeatureAccessCodeModifyListRequest20() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| feature_access_code | List[OCI.featureAccessCode] | featureAccessCode Optional |
ServiceProviderFeatureAccessCodeModifyListRequest20(OCIRequest)
Modify a list of feature access codes for a service provider or enterprise.
The response is either a SuccessResponse() or an ErrorResponse(). In release 20
the "Call Recording" FAC name is changed to "Call Recording - Start". Replaced by:
ServiceProviderFeatureAccessCodeModifyListRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| feature_access_code | List[OCI.featureAccessCode] | featureAccessCode Optional |
ServiceProviderFeatureAccessCodeModifyListRequest21(OCIRequest)
Modify a list of feature access codes for a service provider or enterprise.
The response is either a SuccessResponse() or an ErrorResponse(). In release 20
the "Call Recording" FAC name is changed to "Call Recording - Start".
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| feature_access_code | List[OCI.featureAccessCode] | featureAccessCode Optional |
ServiceProviderIMRNAssignListRequest(OCIRequest)
Assign a list of service provider DNs to the IMRN pool.
It is possible to assign either: a single DN, or a list of DNs, or a range of DNs, or any combination thereof.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| imrn | List[str] | imrn Optional |
| imrn_range | List[OCI.imrnRange] | imrnRange Optional |
ServiceProviderIMRNUnassignListRequest(OCIRequest)
Unassign a list of service provider DNs from the service provider IMRN pool.
The DNs then become available for assignment to groups. It is possible to delete either: a single DN, or a list of DNs, or a range of DNs, or any combination thereof.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| imrn | List[str] | imrn Optional |
| imrn_range | List[OCI.imrnRange] | imrnRange Optional |
ServiceProviderMWIDeliveryToMobileEndpointModifyRequest(OCIRequest)
Modify the service provider level MWI custom notifications settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| template_activation | List[OCI.templateActivation] | templateActivation Optional |
ServiceProviderMWIDeliveryToMobileEndpointModifyRequest23(OCIRequest)
Modify the service provider level MWI custom notifications settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| template_activation | List[OCI.templateActivation] | templateActivation Optional |
ServiceProviderMeetMeConferencingModifyRequest(OCIRequest)
Modify the service provider/enterprise level data associated with Meet-Me Conferencing functions.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| allocated_ports | OCI.allocatedPorts | allocatedPorts Optional |
ServiceProviderModifyRequest(OCIRequest)
Modify the profile for a service provider or enterprise.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are ignored in AS and XS data mode: servicePolicy, callProcessingSliceId,
subscriberPartition. The following element is only used in AS data mode and ignored
in XS data mode: resellerId resellerName provisioningSliceId The following element is
only used by Reseller Administrator or Above: resellerId resellerName Only
Provisioning admin and above can change the preferredDataCenter and
provisioningSliceId. The following elements are only used in AS data mode and ignored
in XS data mode: defaultExtensionLength locationRoutingPrefixDigit locationCodeLength
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| default_domain | str | defaultDomain Optional |
| service_provider_name | str | serviceProviderName Optional |
| support_email | str | supportEmail Optional |
| contact | OCI.contact | contact Optional |
| address | OCI.address | address Optional |
| use_service_provider_languages | bool | useServiceProviderLanguages Optional |
| service_policy | str | servicePolicy Optional |
| call_processing_slice_id | str | callProcessingSliceId Optional |
| provisioning_slice_id | str | provisioningSliceId Optional |
| subscriber_partition | str | subscriberPartition Optional |
| preferred_data_center | str | preferredDataCenter Optional |
| default_extension_length | int | defaultExtensionLength Optional |
| location_routing_prefix_digit | int | locationRoutingPrefixDigit Optional |
| location_code_length | int | locationCodeLength Optional |
| reseller_id | str | resellerId Optional |
| reseller_name | str | resellerName Optional |
ServiceProviderNetworkClassOfServiceAssignListRequest21(OCIRequest)
Assign a list of Network Classes of Service to a service provider.
A default Network Class of Service must be specified unless there is already one assigned to the service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| network_class_of_service | List[str] | networkClassOfService Optional |
| default_network_class_of_service | OCI.defaultNetworkClassOfService | defaultNetworkClassOfService |
ServiceProviderNetworkClassOfServiceUnassignListRequest21(OCIRequest)
Unassign a list of Network Classes of Service from a service provider.
If the default Network Class of Service is being unassigned, a new one must be specified unless there are no more Network Classes of Service assigned to the service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| network_class_of_service | List[str] | networkClassOfService Optional |
| default_network_class_of_service | OCI.defaultNetworkClassOfService | defaultNetworkClassOfService |
ServiceProviderRouteListEnterpriseTrunkNumberRangeAddListRequest(OCIRequest)
Add number ranges to a service provider.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| number_range | List[OCI.numberRange] | numberRange Optional |
ServiceProviderRouteListEnterpriseTrunkNumberRangeModifyListRequest(OCIRequest)
Modify a list of number ranges in a service provider The response is either
SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| number_range | List[OCI.numberRange] | numberRange Optional |
ServiceProviderScheduleAddEventRequest(OCIRequest)
Add an event to service provider schedule.
The response is either a SuccessResponse() or an ErrorResponse(). The startDate
element is adjusted to the first occurrence of the recurrent schedule that comes at or
after the startDate. The endDate element is set to the sum of the adjusted starDate
element value and the event duration.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| schedule_key | OCI.scheduleKey | scheduleKey |
| event_name | str | eventName |
| start_date | str | startDate |
| all_day_event | bool | allDayEvent Optional |
| start_time | OCI.startTime | startTime Optional |
| end_time | OCI.endTime | endTime Optional |
| end_date | str | endDate |
| recurrence | OCI.recurrence | recurrence Optional |
ServiceProviderScheduleDeleteEventListRequest(OCIRequest)
Delete a list of events from a service provider schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| schedule_key | OCI.scheduleKey | scheduleKey |
| event_name | List[str] | eventName |
ServiceProviderScheduleDeleteListRequest(OCIRequest)
Delete a list of service provider schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| schedule_key | List[OCI.scheduleKey] | scheduleKey |
ServiceProviderScheduleGetEventDetailListRequest(OCIRequest)
Get the list of events of a service provider schedule.
The response is either a ServiceProviderScheduleGetEventDetailListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| schedule_key | OCI.scheduleKey | scheduleKey |
ServiceProviderScheduleGetEventListRequest(OCIRequest)
Get the list of events of a service provider schedule.
The response is either a ServiceProviderScheduleGetEventListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| schedule_key | OCI.scheduleKey | scheduleKey |
ServiceProviderScheduleGetEventRequest(OCIRequest)
Get an event from a service provider schedule.
The response is either a ServiceProviderScheduleGetEventResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| schedule_key | OCI.scheduleKey | scheduleKey |
| event_name | str | eventName |
ServiceProviderScheduleModifyEventRequest(OCIRequest)
Modify an event of a service provider schedule.
The response is either a SuccessResponse() or an ErrorResponse(). The startDate
element is adjusted to the first occurrence of the recurrent schedule that comes at or
after the startDate. The endDate element is set to the sum of the adjusted starDate
element value and the event duration.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| schedule_key | OCI.scheduleKey | scheduleKey |
| event_name | str | eventName |
| new_event_name | str | newEventName Optional |
| start_date | str | startDate Optional |
| all_day_event | bool | allDayEvent Optional |
| start_time | OCI.startTime | startTime Optional |
| end_time | OCI.endTime | endTime Optional |
| end_date | str | endDate Optional |
| recurrence | OCI.recurrence | recurrence Optional |
ServiceProviderScheduleModifyRequest(OCIRequest)
Modify a service provider schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| schedule_key | OCI.scheduleKey | scheduleKey |
| new_schedule_name | str | newScheduleName Optional |
ServiceProviderServicePackAddRequest(OCIRequest)
Request to add a service pack to a service provider.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| service_pack_name | str | servicePackName |
| service_pack_description | str | servicePackDescription Optional |
| is_available_for_use | bool | isAvailableForUse |
| service_pack_quantity | OCI.servicePackQuantity | servicePackQuantity |
| service_name | List[str] | serviceName Optional |
ServiceProviderServicePackMigrationTaskModifyAssignmentListRequest(OCIRequest)
Replace the list of services and packs to be assigned to users during the service pack migration.
Modification is only allowed prior to task execution.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| task_name | str | taskName |
| user_service_name_list | OCI.userServiceNameList | userServiceNameList Optional |
| service_pack_name_list | OCI.servicePackNameList | servicePackNameList Optional |
ServiceProviderServicePackMigrationTaskModifyRemovalListRequest(OCIRequest)
Replace the list of services and packs to be removed from users during the service pack migration.
Modification is only allowed prior to task execution.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| task_name | str | taskName |
| user_service_name_list | OCI.userServiceNameList | userServiceNameList Optional |
| service_pack_name_list | OCI.servicePackNameList | servicePackNameList Optional |
ServiceProviderServicePackMigrationTaskModifyUserSelectionRequest(OCIRequest)
Replace the list of services and packs used to select which users will be migrated.
Modification is only allowed prior to task execution.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| task_name | str | taskName |
| user_selection_type | str | userSelectionType Optional |
| user_service_name_list | OCI.userServiceNameList | userServiceNameList Optional |
| service_pack_name_list | OCI.servicePackNameList | servicePackNameList Optional |
ServiceProviderServicePackModifyRequest(OCIRequest)
Requests to modify a service pack for a service provider.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| service_pack_name | str | servicePackName |
| new_service_pack_name | str | newServicePackName Optional |
| service_pack_description | str | servicePackDescription Optional |
| is_available_for_use | bool | isAvailableForUse Optional |
| service_pack_quantity | OCI.servicePackQuantity | servicePackQuantity Optional |
ServiceProviderTrunkGroupModifyRequest(OCIRequest)
Modify the maximum and bursting maximum permissible active Trunk Group calls for the service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| max_active_calls | OCI.maxActiveCalls | maxActiveCalls Optional |
| bursting_max_active_calls | OCI.burstingMaxActiveCalls | burstingMaxActiveCalls Optional |
| number_of_bursting_btl_us | OCI.numberOfBurstingBTLUs | numberOfBurstingBTLUs Optional |
ServiceProviderVoiceMessagingGroupModifyVoicePortalBrandingRequest(OCIRequest)
Modify the service provider's voice portal branding settings.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: ServiceProviderVoiceMessagingGroupModifyVoicePortalBrandingRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| voice_portal_greeting_selection | str | voicePortalGreetingSelection Optional |
| voice_portal_greeting_file | OCI.voicePortalGreetingFile | voicePortalGreetingFile Optional |
| voice_messaging_greeting_selection | str | voiceMessagingGreetingSelection Optional |
| voice_messaging_greeting_file | OCI.voiceMessagingGreetingFile | voiceMessagingGreetingFile Optional |
ServiceProviderVoiceMessagingGroupModifyVoicePortalBrandingRequest16(OCIRequest)
Modify the service provider's voice portal branding settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| voice_portal_greeting_selection | str | voicePortalGreetingSelection Optional |
| voice_portal_greeting_file | OCI.voicePortalGreetingFile | voicePortalGreetingFile Optional |
| voice_messaging_greeting_selection | str | voiceMessagingGreetingSelection Optional |
| voice_messaging_greeting_file | OCI.voiceMessagingGreetingFile | voiceMessagingGreetingFile Optional |
ServiceProviderXsiPolicyProfileAssignListRequest(OCIRequest)
Assign a list of group and user Xsi policy profile to a service provider.
At service provider level, only one service provider Xsi policy profile can be assigned to service provider.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| sp_xsi_policy_profile | str | spXsiPolicyProfile Optional |
| group_xsi_policy_profile | OCI.groupXsiPolicyProfile | groupXsiPolicyProfile Optional |
| user_xsi_policy_profile | OCI.userXsiPolicyProfile | userXsiPolicyProfile Optional |
ServiceProviderXsiPolicyProfileUnassignListRequest(OCIRequest)
Unassign a list of Xsi policy profile.
Unassign a list of Xsi policy profile. Only group and user level Xsi policy profile can be unassigned.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_xsi_policy_profile | OCI.groupXsiPolicyProfile | groupXsiPolicyProfile Optional |
| user_xsi_policy_profile | OCI.userXsiPolicyProfile | userXsiPolicyProfile Optional |
SystemAccessDeviceAddRequest(OCIRequest)
Request to add a system-level access device.
The response is either SuccessResponse() or ErrorResponse(). Repaced By:
SystemAccessDeviceAddRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| device_type | str | deviceType |
| protocol | str | protocol Optional |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| outbound_proxy_server_net_address | str | outboundProxyServerNetAddress Optional |
| stun_server_net_address | str | stunServerNetAddress Optional |
| mac_address | str | macAddress Optional |
| serial_number | str | serialNumber Optional |
| description | str | description Optional |
| physical_location | str | physicalLocation Optional |
| transport_protocol | str | transportProtocol Optional |
| mobility_manager_provisioning_url | str | mobilityManagerProvisioningURL Optional |
| mobility_manager_provisioning_user_name | str | mobilityManagerProvisioningUserName Optional |
| mobility_manager_provisioning_password | str | mobilityManagerProvisioningPassword Optional |
| mobility_manager_default_originating_service_key | int | mobilityManagerDefaultOriginatingServiceKey Optional |
| mobility_manager_default_terminating_service_key | int | mobilityManagerDefaultTerminatingServiceKey Optional |
| use_custom_user_name_password | bool | useCustomUserNamePassword Optional |
| access_device_credentials | OCI.accessDeviceCredentials | accessDeviceCredentials Optional |
SystemAccessDeviceAddRequest22(OCIRequest)
Request to add a system-level access device.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: useHotline
hotlineContact deviceExternalId Replaced by: SystemAccessDeviceAddRequest22V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
| device_type | str | deviceType |
| protocol | str | protocol Optional |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| outbound_proxy_server_net_address | str | outboundProxyServerNetAddress Optional |
| stun_server_net_address | str | stunServerNetAddress Optional |
| mac_address | str | macAddress Optional |
| serial_number | str | serialNumber Optional |
| description | str | description Optional |
| physical_location | str | physicalLocation Optional |
| transport_protocol | str | transportProtocol Optional |
| mobility_manager_provisioning_url | str | mobilityManagerProvisioningURL Optional |
| mobility_manager_provisioning_user_name | str | mobilityManagerProvisioningUserName Optional |
| mobility_manager_provisioning_password | str | mobilityManagerProvisioningPassword Optional |
| mobility_manager_default_originating_service_key | int | mobilityManagerDefaultOriginatingServiceKey Optional |
| mobility_manager_default_terminating_service_key | int | mobilityManagerDefaultTerminatingServiceKey Optional |
| use_custom_user_name_password | bool | useCustomUserNamePassword Optional |
| access_device_credentials | OCI.accessDeviceCredentials | accessDeviceCredentials Optional |
| use_hotline | bool | useHotline |
| hotline_contact | str | hotlineContact Optional |
SystemAccessDeviceAddRequest22V2(OCIRequest)
Request to add a system-level access device.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: useHotline
hotlineContact isWebexTeamsDevice defaultPathHeader deviceExternalId
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
| device_type | str | deviceType |
| protocol | str | protocol Optional |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| outbound_proxy_server_net_address | str | outboundProxyServerNetAddress Optional |
| stun_server_net_address | str | stunServerNetAddress Optional |
| mac_address | str | macAddress Optional |
| serial_number | str | serialNumber Optional |
| description | str | description Optional |
| physical_location | str | physicalLocation Optional |
| transport_protocol | str | transportProtocol Optional |
| mobility_manager_provisioning_url | str | mobilityManagerProvisioningURL Optional |
| mobility_manager_provisioning_user_name | str | mobilityManagerProvisioningUserName Optional |
| mobility_manager_provisioning_password | str | mobilityManagerProvisioningPassword Optional |
| mobility_manager_default_originating_service_key | int | mobilityManagerDefaultOriginatingServiceKey Optional |
| mobility_manager_default_terminating_service_key | int | mobilityManagerDefaultTerminatingServiceKey Optional |
| use_custom_user_name_password | bool | useCustomUserNamePassword Optional |
| access_device_credentials | OCI.accessDeviceCredentials | accessDeviceCredentials Optional |
| use_hotline | bool | useHotline |
| hotline_contact | str | hotlineContact Optional |
| is_webex_teams_device | bool | isWebexTeamsDevice Optional |
| default_path_header | str | defaultPathHeader Optional |
SystemAccessDeviceAddRequest22V3(OCIRequest)
Request to add a system-level access device.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: isWebexTeamsDevice
defaultPathHeader deviceExternalId deviceIPEI
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
| device_type | str | deviceType |
| protocol | str | protocol Optional |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| outbound_proxy_server_net_address | str | outboundProxyServerNetAddress Optional |
| stun_server_net_address | str | stunServerNetAddress Optional |
| mac_address | str | macAddress Optional |
| serial_number | str | serialNumber Optional |
| description | str | description Optional |
| physical_location | str | physicalLocation Optional |
| transport_protocol | str | transportProtocol Optional |
| use_custom_user_name_password | bool | useCustomUserNamePassword Optional |
| access_device_credentials | OCI.accessDeviceCredentials | accessDeviceCredentials Optional |
| is_webex_teams_device | bool | isWebexTeamsDevice Optional |
| default_path_header | str | defaultPathHeader Optional |
| device_ipei | str | deviceIPEI Optional |
SystemAccessDeviceCustomTagAddOrModifyListRequest(OCIRequest)
Request to add or modify a list of static configuration tag for a system access device.
If the tag does not exist, it is added. If the tag exists, its value is updated.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| tag | List[OCI.tag] | tag |
SystemAccessDeviceFileModifyRequest(OCIRequest)
Request to modify a specified system access device file.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: SystemAccessDeviceFileModifyRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| file_type | str | fileType |
| file_source | str | fileSource Optional |
| upload_file | OCI.uploadFile | uploadFile Optional |
SystemAccessDeviceFileModifyRequest14sp8(OCIRequest)
Request to modify a specified system access device file.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| file_format | str | fileFormat |
| file_source | str | fileSource Optional |
| upload_file | OCI.uploadFile | uploadFile Optional |
| extended_capture_enabled | bool | extendedCaptureEnabled Optional |
SystemAccessDeviceLinkDeviceListRequest(OCIRequest)
Request to link one or more leaf devices to a system level tree device.
A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| leaf_device_key | List[OCI.leafDeviceKey] | leafDeviceKey |
SystemAccessDeviceModifyRequest(OCIRequest)
Request to modify a specified system access device.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: useHotline
hotlineContact isWebexTeamsDevice defaultPathHeader deviceExternalId
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
| protocol | str | protocol Optional |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| outbound_proxy_server_net_address | str | outboundProxyServerNetAddress Optional |
| stun_server_net_address | str | stunServerNetAddress Optional |
| mac_address | str | macAddress Optional |
| serial_number | str | serialNumber Optional |
| description | str | description Optional |
| physical_location | str | physicalLocation Optional |
| transport_protocol | str | transportProtocol Optional |
| mobility_manager_provisioning_url | str | mobilityManagerProvisioningURL Optional |
| mobility_manager_provisioning_user_name | str | mobilityManagerProvisioningUserName Optional |
| mobility_manager_provisioning_password | str | mobilityManagerProvisioningPassword Optional |
| mobility_manager_default_originating_service_key | int | mobilityManagerDefaultOriginatingServiceKey Optional |
| mobility_manager_default_terminating_service_key | int | mobilityManagerDefaultTerminatingServiceKey Optional |
| use_custom_user_name_password | bool | useCustomUserNamePassword Optional |
| access_device_credentials | OCI.accessDeviceCredentials | accessDeviceCredentials Optional |
| use_hotline | bool | useHotline Optional |
| hotline_contact | str | hotlineContact Optional |
| is_webex_teams_device | bool | isWebexTeamsDevice Optional |
| default_path_header | str | defaultPathHeader Optional |
SystemAccessDeviceModifyRequest22(OCIRequest)
Request to modify a specified system access device.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: isWebexTeamsDevice
defaultPathHeader deviceExternalId deviceIPEI useDeviceCode deviceCode
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName Optional |
| device_external_id | str | deviceExternalId Optional |
| protocol | str | protocol Optional |
| net_address | str | netAddress Optional |
| port | int | port Optional |
| outbound_proxy_server_net_address | str | outboundProxyServerNetAddress Optional |
| stun_server_net_address | str | stunServerNetAddress Optional |
| mac_address | str | macAddress Optional |
| serial_number | str | serialNumber Optional |
| description | str | description Optional |
| physical_location | str | physicalLocation Optional |
| transport_protocol | str | transportProtocol Optional |
| use_custom_user_name_password | bool | useCustomUserNamePassword Optional |
| access_device_credentials | OCI.accessDeviceCredentials | accessDeviceCredentials Optional |
| is_webex_teams_device | bool | isWebexTeamsDevice Optional |
| default_path_header | str | defaultPathHeader Optional |
| device_ipei | str | deviceIPEI Optional |
| use_device_code | bool | useDeviceCode Optional |
| device_code | str | deviceCode Optional |
SystemAccessDeviceUnlinkDeviceListRequest(OCIRequest)
Request to unlink one or more leaf access devices from a tree device.
A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| leaf_device_key | List[OCI.leafDeviceKey] | leafDeviceKey |
SystemAutomaticCollectCallPrefixDigitsAddListRequest(OCIRequest)
Add a system automatic collect call prefix digits entry.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| prefix_digits_entry | List[OCI.prefixDigitsEntry] | prefixDigitsEntry |
SystemAutomaticCollectCallPrefixDigitsDeleteListRequest(OCIRequest)
Delete an entry in system automatic collect call prefix table.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| prefix_digits_entry | List[OCI.prefixDigitsEntry] | prefixDigitsEntry |
SystemBroadWorksMobilityAddIMRNListRequest(OCIRequest)
Adds BroadWorks Mobility IMRN numbers to the system.
It is possible to add either: a single number, a list of numbers, or a range of numbers, or any combination thereof.
The response is either a SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| imrn_number | List[str] | imrnNumber Optional |
| number_range | List[OCI.numberRange] | numberRange Optional |
SystemBroadWorksMobilityAddMobileNetworkIMRNListRequest(OCIRequest)
Adds BroadWorks Mobility IMRN numbers to a Mobile Network.
It is possible to add either: a single number, a list of numbers, or a range of numbers, or any combination thereof.
The response is either a SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| mobile_network_name | str | mobileNetworkName |
| imrn_number | List[str] | imrnNumber Optional |
| number_range | List[OCI.numberRange] | numberRange Optional |
SystemBroadWorksMobilityGeographicalPoolIMRNAddListRequest(OCIRequest)
Adds BroadWorks Mobility IMRN numbers to a geographical pool.
It is possible to add either: a single number, a list of numbers, or a range of numbers, or any combination thereof.
The response is either a SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| geographical_pool_name | str | geographicalPoolName |
| imrn_number | List[str] | imrnNumber Optional |
| number_range | List[OCI.numberRange] | numberRange Optional |
SystemCallCenterEnhancedReportingBrandingModifyRequest(OCIRequest)
Request to modify the system branding configuration.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| branding_choice | str | brandingChoice Optional |
| custom_branding_file | OCI.customBrandingFile | customBrandingFile Optional |
SystemCallCenterEnhancedReportingReportTemplateAddRequest(OCIRequest)
Request to add a system level call center report template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| description | str | description Optional |
| data_template | str | dataTemplate |
| filter_number | int | filterNumber Optional |
| xslt_template | OCI.xsltTemplate | xsltTemplate |
| scope | str | scope |
| is_enabled | bool | isEnabled |
| is_realtime_report | bool | isRealtimeReport Optional |
| call_completion_threshold_param | str | callCompletionThresholdParam Optional |
| short_duration_threshold_param | str | shortDurationThresholdParam Optional |
| service_level_threshold_param | str | serviceLevelThresholdParam Optional |
| service_level_inclusions_param | str | serviceLevelInclusionsParam Optional |
| service_level_objective_threshold_param | str | serviceLevelObjectiveThresholdParam Optional |
| abandoned_call_threshold_param | str | abandonedCallThresholdParam Optional |
| service_level_threshold_param_number | int | serviceLevelThresholdParamNumber Optional |
| abandoned_call_threshold_param_number | int | abandonedCallThresholdParamNumber Optional |
| filter_value | List[str] | filterValue Optional |
SystemCallCenterEnhancedReportingReportTemplateModifyRequest(OCIRequest)
Request to modify a system level call center report template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| xslt_template | OCI.xsltTemplate | xsltTemplate Optional |
| scope | str | scope Optional |
| is_enabled | bool | isEnabled Optional |
| is_realtime_report | bool | isRealtimeReport Optional |
| filter_number | int | filterNumber Optional |
| filter_value | OCI.filterValue | filterValue Optional |
SystemCallProcessingPolicyProfileModifyRequest(OCIRequest)
Modify a call processing policy profile in system.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by
SystemCallProcessingPolicyProfileModifyRequest20().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| assigned_subscriber_type_list | OCI.assignedSubscriberTypeList | assignedSubscriberTypeList Optional |
SystemCallProcessingPolicyProfileModifyRequest20(OCIRequest)
Modify a call processing policy profile in system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| assigned_subscriber_type_list | OCI.assignedSubscriberTypeList | assignedSubscriberTypeList Optional |
SystemCallProcessingPolicyProfileModifyRequest21(OCIRequest)
Modify a call processing policy profile in system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| assigned_subscriber_type_list | OCI.assignedSubscriberTypeList | assignedSubscriberTypeList Optional |
SystemCollaborateModifyRequest(OCIRequest)
Modify the system level data associated with collaborate services.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemCollaborateModifyRequest20sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| collaborate_room_id_length | int | collaborateRoomIdLength Optional |
| instant_room_idle_timeout_seconds | int | instantRoomIdleTimeoutSeconds Optional |
| collaborate_room_maximum_duration_minutes | int | collaborateRoomMaximumDurationMinutes Optional |
| support_outdial | bool | supportOutdial Optional |
| max_collaborate_room_participants | int | maxCollaborateRoomParticipants Optional |
| collaborate_active_talker_refresh_interval_seconds | int | collaborateActiveTalkerRefreshIntervalSeconds Optional |
| terminate_collaborate_after_grace_period | bool | terminateCollaborateAfterGracePeriod Optional |
| collaborate_grace_period | OCI.collaborateGracePeriod | collaborateGracePeriod Optional |
| enable_active_collaborate_notification | bool | enableActiveCollaborateNotification Optional |
| collaborate_from_address | str | collaborateFromAddress Optional |
SystemCollaborateModifyRequest20sp1(OCIRequest)
Modify the system level data associated with collaborate services.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by
SystemCollaborateModifyRequest20sp1V2
Attributes:
| Name | Type | Description |
|---|---|---|
| collaborate_room_id_length | int | collaborateRoomIdLength Optional |
| instant_room_idle_timeout_seconds | int | instantRoomIdleTimeoutSeconds Optional |
| collaborate_room_maximum_duration_minutes | int | collaborateRoomMaximumDurationMinutes Optional |
| support_outdial | bool | supportOutdial Optional |
| max_collaborate_room_participants | int | maxCollaborateRoomParticipants Optional |
| collaborate_active_talker_refresh_interval_seconds | int | collaborateActiveTalkerRefreshIntervalSeconds Optional |
| terminate_collaborate_after_grace_period | bool | terminateCollaborateAfterGracePeriod Optional |
| collaborate_grace_period | OCI.collaborateGracePeriod | collaborateGracePeriod Optional |
| enable_active_collaborate_notification | bool | enableActiveCollaborateNotification Optional |
| collaborate_from_address | str | collaborateFromAddress Optional |
SystemCommunicationBarringCriteriaModifyRequest(OCIRequest)
Modify an existing Communication Barring Criteria.
The following elements are only used in AS data mode: matchNumberPortabilityStatus The following elements are only used in XS data mode and ignored in AS data mode: matchOtherGETS matchNotGETS matchGETSAN matchGETSNT matchGETSFC matchGETSFCAN matchGETSFCNT
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| match_call_type | OCI.matchCallType | matchCallType Optional |
| match_alternate_call_indicator | OCI.matchAlternateCallIndicator | matchAlternateCallIndicator Optional |
| match_virtual_on_net_call_type | OCI.matchVirtualOnNetCallType | matchVirtualOnNetCallType Optional |
| match_public_network | bool | matchPublicNetwork Optional |
| match_private_network | bool | matchPrivateNetwork Optional |
| match_local_category | bool | matchLocalCategory Optional |
| match_national_category | bool | matchNationalCategory Optional |
| match_interlata_category | bool | matchInterlataCategory Optional |
| match_intralata_category | bool | matchIntralataCategory Optional |
| match_international_category | bool | matchInternationalCategory Optional |
| match_private_category | bool | matchPrivateCategory Optional |
| match_emergency_category | bool | matchEmergencyCategory Optional |
| match_other_category | bool | matchOtherCategory Optional |
| match_inter_network | bool | matchInterNetwork Optional |
| match_inter_hosting_ne | bool | matchInterHostingNE Optional |
| match_inter_as | bool | matchInterAS Optional |
| match_intra_as | bool | matchIntraAS Optional |
| match_charge_calls | bool | matchChargeCalls Optional |
| match_no_charge_calls | bool | matchNoChargeCalls Optional |
| match_group_calls | bool | matchGroupCalls Optional |
| match_enterprise_calls | bool | matchEnterpriseCalls Optional |
| match_network_calls | bool | matchNetworkCalls Optional |
| match_network_url_calls | bool | matchNetworkURLCalls Optional |
| match_repair_calls | bool | matchRepairCalls Optional |
| match_emergency_calls | bool | matchEmergencyCalls Optional |
| match_internal_calls | bool | matchInternalCalls Optional |
| match_other_gets_gets | bool | matchOtherGETSGets Optional |
| match_not_gets_gets | bool | matchNotGETSGets Optional |
| match_getsan_gets | bool | matchGETSANGets Optional |
| match_getsnt_gets | bool | matchGETSNTGets Optional |
| match_getsfc_gets | bool | matchGETSFCGets Optional |
| match_getsfcan_gets | bool | matchGETSFCANGets Optional |
| match_getsfcnt_gets | bool | matchGETSFCNTGets Optional |
| match_location | str | matchLocation Optional |
| match_roaming | str | matchRoaming Optional |
| time_schedule | str | timeSchedule Optional |
| holiday_schedule | str | holidaySchedule Optional |
| match_number_portability_status | OCI.matchNumberPortabilityStatus | matchNumberPortabilityStatus Optional |
SystemCommunicationBarringIncomingCriteriaModifyRequest(OCIRequest)
Modify an existing Communication Barring Incoming Criteria.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| time_schedule | str | timeSchedule Optional |
| holiday_schedule | str | holidaySchedule Optional |
| match_number_portability_status | OCI.matchNumberPortabilityStatus | matchNumberPortabilityStatus Optional |
| call_tagged_as_spam | bool | callTaggedAsSpam Optional |
SystemCommunicationBarringProfileAddRequest(OCIRequest)
Add a new Communication Barring Profile.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| description | str | description Optional |
| originating_default_action | str | originatingDefaultAction |
| originating_default_treatment_id | str | originatingDefaultTreatmentId Optional |
| originating_default_transfer_number | str | originatingDefaultTransferNumber Optional |
| originating_default_call_timeout | int | originatingDefaultCallTimeout Optional |
| originating_rule | List[OCI.originatingRule] | originatingRule Optional |
| redirecting_default_action | str | redirectingDefaultAction |
| redirecting_default_call_timeout | int | redirectingDefaultCallTimeout Optional |
| redirecting_rule | List[OCI.redirectingRule] | redirectingRule Optional |
SystemCommunicationBarringProfileAddRequest17sp1(OCIRequest)
Add a new Communication Barring Profile.
The priorities for IncomingRules are requantized to consecutive integers as part of the add.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in XS data mode: incomingDefaultAction
incomingDefaultCallTimeout incomingRule
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| description | str | description Optional |
| originating_default_action | str | originatingDefaultAction |
| originating_default_treatment_id | str | originatingDefaultTreatmentId Optional |
| originating_default_transfer_number | str | originatingDefaultTransferNumber Optional |
| originating_default_call_timeout | int | originatingDefaultCallTimeout Optional |
| originating_rule | List[OCI.originatingRule] | originatingRule Optional |
| redirecting_default_action | str | redirectingDefaultAction |
| redirecting_default_call_timeout | int | redirectingDefaultCallTimeout Optional |
| redirecting_rule | List[OCI.redirectingRule] | redirectingRule Optional |
| incoming_default_action | str | incomingDefaultAction |
| incoming_default_call_timeout | int | incomingDefaultCallTimeout Optional |
| incoming_rule | List[OCI.incomingRule] | incomingRule Optional |
SystemCommunicationBarringProfileAddRequest17sp3(OCIRequest)
Add a new Communication Barring Profile.
The priorities for IncomingRules are requantized to consecutive integers as part of the add.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: callMeNowDefaultAction, use value "Block" in
XS data mode The following elements are only used in AS data mode and ignored in XS
data mode: callMeNowDefaultCallTimeout callMeNowRule Replaced by:
SystemCommunicationBarringProfileAddRequest19sp1() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| description | str | description Optional |
| originating_default_action | str | originatingDefaultAction |
| originating_default_treatment_id | str | originatingDefaultTreatmentId Optional |
| originating_default_transfer_number | str | originatingDefaultTransferNumber Optional |
| originating_default_call_timeout | int | originatingDefaultCallTimeout Optional |
| originating_rule | List[OCI.originatingRule] | originatingRule Optional |
| redirecting_default_action | str | redirectingDefaultAction |
| redirecting_default_call_timeout | int | redirectingDefaultCallTimeout Optional |
| redirecting_rule | List[OCI.redirectingRule] | redirectingRule Optional |
| incoming_default_action | str | incomingDefaultAction |
| incoming_default_call_timeout | int | incomingDefaultCallTimeout Optional |
| incoming_rule | List[OCI.incomingRule] | incomingRule Optional |
| call_me_now_default_action | str | callMeNowDefaultAction |
| call_me_now_default_call_timeout | int | callMeNowDefaultCallTimeout Optional |
| call_me_now_rule | List[OCI.callMeNowRule] | callMeNowRule Optional |
SystemCommunicationBarringProfileAddRequest19sp1(OCIRequest)
Add a new Communication Barring Profile.
The priorities for IncomingRules are requantized to consecutive integers as part of the add.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: callMeNowDefaultAction, use value "Block" in
XS data mode callMeNowDefaultCallTimeout callMeNowRule applyToAttendedCallTransfers,
use value "false" in XS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| description | str | description Optional |
| originating_default_action | str | originatingDefaultAction |
| originating_default_treatment_id | str | originatingDefaultTreatmentId Optional |
| originating_default_transfer_number | str | originatingDefaultTransferNumber Optional |
| originating_default_call_timeout | int | originatingDefaultCallTimeout Optional |
| originating_rule | List[OCI.originatingRule] | originatingRule Optional |
| redirecting_default_action | str | redirectingDefaultAction |
| redirecting_default_call_timeout | int | redirectingDefaultCallTimeout Optional |
| redirecting_rule | List[OCI.redirectingRule] | redirectingRule Optional |
| incoming_default_action | str | incomingDefaultAction |
| incoming_default_call_timeout | int | incomingDefaultCallTimeout Optional |
| incoming_rule | List[OCI.incomingRule] | incomingRule Optional |
| call_me_now_default_action | str | callMeNowDefaultAction |
| call_me_now_default_call_timeout | int | callMeNowDefaultCallTimeout Optional |
| call_me_now_rule | List[OCI.callMeNowRule] | callMeNowRule Optional |
| apply_to_attended_call_transfers | bool | applyToAttendedCallTransfers |
SystemDeviceFamilyModifyRequest(OCIRequest)
Request to modify a device family.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_family_name | str | deviceFamilyName |
| new_device_family_name | str | newDeviceFamilyName Optional |
| device_type_list | OCI.deviceTypeList | deviceTypeList Optional |
| tag_set_list | OCI.tagSetList | tagSetList Optional |
SystemDeviceManagementAutoRebuildConfigModifyListRequest(OCIRequest)
Request to enable or disable automatic trigger of DM events for OCI request prefixes, regardless of the request's version.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| auto_rebuild_config_entry | List[OCI.autoRebuildConfigEntry] | autoRebuildConfigEntry |
SystemDeviceManagementTagSetImportDryRunRequest(OCIRequest)
Request to perform a dry run for the import of a Tag Set Archive File (TSAF) as a new Tag Set.
The URL supports the HTTP and the FILE protocols. When the optional element resellerId is specified, the device type created is at reseller level. When the optional element tagSetOverride is set to true, an existing tag set on the destination system will be overridden. When the optional element tagSetRename is set, on import the tag set name part of the TSAF will be changed to the desired name on the destination system.
The response is either a SystemDeviceManagementTagSetImportDryRunResponse() or an
ErrorResponse(). The following data elements are only used in AS data mode and
ignored in XS data mode: resellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| file | str | file |
| reseller_id | str | resellerId Optional |
| tag_set_override | bool | tagSetOverride Optional |
| tag_set_rename | OCI.tagSetRename | tagSetRename Optional |
SystemDeviceManagementTagSetImportRequest(OCIRequest)
Request to import a Tag Set Archive File (TSAF) as a new Tag Set.
The URL supports the HTTP and the FILE protocols. When the optional element resellerId is specified, the device type created is at reseller level. When the optional element tagSetOverride is set to true, an existing tag set on the destination system will be overridden. When the optional element tagSetRename is set, on import the tag set name part of the TSAF will be changed to the desired name on the destination system.
The response is either a SuccessResponse() or an ErrorResponse(). The following
data elements are only used in AS data mode and ignored in XS data mode: resellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| file | str | file |
| reseller_id | str | resellerId Optional |
| tag_set_override | bool | tagSetOverride Optional |
| tag_set_rename | OCI.tagSetRename | tagSetRename Optional |
SystemDeviceManagementTagSetRegionTagAddListRequest(OCIRequest)
Request to add a tag override to a region of a static configuration tag set.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| tag_set_name | str | tagSetName |
| region_name | str | regionName |
| tag | List[OCI.tag] | tag |
SystemDeviceProfileAuthenticationLockoutClearRequest(OCIRequest)
Request to clear device profile authentication lockouts in the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| access_device | List[OCI.accessDevice] | accessDevice |
SystemDeviceTypeImportDryRunRequest(OCIRequest)
Request to perform a dry run for the import of a Device Type Archive File (DTAF) as a new Device Type.
The URL supports the HTTP and the FILE protocols. When the optional element resellerId is specified, the device type created is at reseller level. When the optional element deviceTypeRename is set, on import, the device type name part of the DTAF will be changed to the desired name on the destination system. When the optional element deviceTypeFileUpdate is set, on import, the files that are matched based on the file format are updated with the ones from the DTAF. The file format and the file category are the only attributes that can't be updated.
The response is either a SystemDeviceTypeImportDryRunResponse() or an
ErrorResponse(). The following data elements are only used in AS data mode and
ignored in XS data mode: deviceTypeFileUpdate deviceTypeRename resellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| file | str | file |
| reseller_id | str | resellerId Optional |
| device_type_rename | OCI.deviceTypeRename | deviceTypeRename Optional |
| device_type_file_update | bool | deviceTypeFileUpdate Optional |
SystemDeviceTypeImportRequest(OCIRequest)
Request to import a Device Type Archive File (DTAF) as a new Device Type.
The URL supports the HTTP and the FILE protocols. When the optional element resellerId is specified, the device type created is at reseller level. When the optional element deviceTypeRename is set, on import, the device type name part of the DTAF will be changed to the desired name on the destination system. When the optional element deviceTypeFileUpdate is set, on import, the files that are matched based on the file format are updated with the ones from the DTAF. The file format and the file category are the only attributes that can't be updated.
The response is either a SuccessResponse() or an ErrorResponse(). The following
data elements are only used in AS data mode and ignored in XS data mode:
deviceTypeFileUpdate deviceTypeRename resellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| file | str | file |
| reseller_id | str | resellerId Optional |
| device_type_rename | OCI.deviceTypeRename | deviceTypeRename Optional |
| device_type_file_update | bool | deviceTypeFileUpdate Optional |
SystemDialableCallerIDCriteriaModifyRequest(OCIRequest)
Modify a Dialable Caller ID Criteria.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| prefix_digits | str | prefixDigits Optional |
| match_call_type | OCI.matchCallType | matchCallType Optional |
| match_alternate_call_indicator | OCI.matchAlternateCallIndicator | matchAlternateCallIndicator Optional |
| match_local_category | bool | matchLocalCategory Optional |
| match_national_category | bool | matchNationalCategory Optional |
| match_interlata_category | bool | matchInterlataCategory Optional |
| match_intralata_category | bool | matchIntralataCategory Optional |
| match_international_category | bool | matchInternationalCategory Optional |
| match_private_category | bool | matchPrivateCategory Optional |
| match_emergency_category | bool | matchEmergencyCategory Optional |
| match_other_category | bool | matchOtherCategory Optional |
SystemDialableCallerIDModifyRequest(OCIRequest)
Modify the system level Dialable Caller ID criteria list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| criteria_priority_order | List[OCI.criteriaPriorityOrder] | criteriaPriorityOrder Optional |
SystemFeatureAccessCodeModifyListRequest(OCIRequest)
Modify default Feature Access Codes.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
SystemFeatureAccessCodeModifyListRequest21() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| feature_access_code | List[OCI.featureAccessCode] | featureAccessCode Optional |
SystemFeatureAccessCodeModifyListRequest20(OCIRequest)
Modify default Feature Access Codes.
The response is either a SuccessResponse() or an ErrorResponse(). In release 20
the "Call Recording" FAC name is changed to "Call Recording - Start". Replaced by:
SystemFeatureAccessCodeModifyListRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| feature_access_code | List[OCI.featureAccessCode] | featureAccessCode Optional |
SystemFeatureAccessCodeModifyListRequest21(OCIRequest)
Modify default Feature Access Codes.
The response is either a SuccessResponse() or an ErrorResponse(). In release 20
the "Call Recording" FAC name is changed to "Call Recording - Start".
Attributes:
| Name | Type | Description |
|---|---|---|
| feature_access_code | List[OCI.featureAccessCode] | featureAccessCode Optional |
SystemFileRepositoryDeviceAddRequest(OCIRequest)
Add a new file repository.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
SystemFileRepositoryDeviceAddRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| root_directory | str | rootDirectory Optional |
| port | int | port Optional |
| protocol_web_dav | OCI.protocolWebDAV | protocolWebDAV Optional |
| protocol_ftp | OCI.protocolFTP | protocolFTP Optional |
SystemFileRepositoryDeviceAddRequest16(OCIRequest)
Add a new file repository.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
SystemFileRepositoryDeviceAddRequest20()
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| root_directory | str | rootDirectory Optional |
| port | int | port Optional |
| protocol_web_dav | OCI.protocolWebDAV | protocolWebDAV Optional |
| protocol_ftp | OCI.protocolFTP | protocolFTP Optional |
SystemFileRepositoryDeviceAddRequest20(OCIRequest)
Add a new file repository.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| root_directory | str | rootDirectory Optional |
| port | int | port Optional |
| protocol_web_dav | OCI.protocolWebDAV | protocolWebDAV Optional |
| protocol_ftp | OCI.protocolFTP | protocolFTP Optional |
| protocol_sftp | OCI.protocolSFTP | protocolSFTP Optional |
| protocol_ftps | OCI.protocolFTPS | protocolFTPS Optional |
SystemHolidayScheduleAddRequest(OCIRequest)
Add a system holiday schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| holiday_schedule_name | str | holidayScheduleName |
| holiday01 | OCI.holiday01 | holiday01 Optional |
| holiday02 | OCI.holiday02 | holiday02 Optional |
| holiday03 | OCI.holiday03 | holiday03 Optional |
| holiday04 | OCI.holiday04 | holiday04 Optional |
| holiday05 | OCI.holiday05 | holiday05 Optional |
| holiday06 | OCI.holiday06 | holiday06 Optional |
| holiday07 | OCI.holiday07 | holiday07 Optional |
| holiday08 | OCI.holiday08 | holiday08 Optional |
| holiday09 | OCI.holiday09 | holiday09 Optional |
| holiday10 | OCI.holiday10 | holiday10 Optional |
| holiday11 | OCI.holiday11 | holiday11 Optional |
| holiday12 | OCI.holiday12 | holiday12 Optional |
| holiday13 | OCI.holiday13 | holiday13 Optional |
| holiday14 | OCI.holiday14 | holiday14 Optional |
| holiday15 | OCI.holiday15 | holiday15 Optional |
| holiday16 | OCI.holiday16 | holiday16 Optional |
| holiday17 | OCI.holiday17 | holiday17 Optional |
| holiday18 | OCI.holiday18 | holiday18 Optional |
| holiday19 | OCI.holiday19 | holiday19 Optional |
| holiday20 | OCI.holiday20 | holiday20 Optional |
SystemHolidayScheduleModifyRequest(OCIRequest)
Modify a system holiday schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| holiday_schedule_name | str | holidayScheduleName |
| new_holiday_schedule_name | str | newHolidayScheduleName Optional |
| holiday01 | OCI.holiday01 | holiday01 Optional |
| holiday02 | OCI.holiday02 | holiday02 Optional |
| holiday03 | OCI.holiday03 | holiday03 Optional |
| holiday04 | OCI.holiday04 | holiday04 Optional |
| holiday05 | OCI.holiday05 | holiday05 Optional |
| holiday06 | OCI.holiday06 | holiday06 Optional |
| holiday07 | OCI.holiday07 | holiday07 Optional |
| holiday08 | OCI.holiday08 | holiday08 Optional |
| holiday09 | OCI.holiday09 | holiday09 Optional |
| holiday10 | OCI.holiday10 | holiday10 Optional |
| holiday11 | OCI.holiday11 | holiday11 Optional |
| holiday12 | OCI.holiday12 | holiday12 Optional |
| holiday13 | OCI.holiday13 | holiday13 Optional |
| holiday14 | OCI.holiday14 | holiday14 Optional |
| holiday15 | OCI.holiday15 | holiday15 Optional |
| holiday16 | OCI.holiday16 | holiday16 Optional |
| holiday17 | OCI.holiday17 | holiday17 Optional |
| holiday18 | OCI.holiday18 | holiday18 Optional |
| holiday19 | OCI.holiday19 | holiday19 Optional |
| holiday20 | OCI.holiday20 | holiday20 Optional |
SystemInterceptUserAddDnListRequest(OCIRequest)
Request to add an Intercept User number(s) to the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| intercept_dn_list | List[OCI.interceptDNList] | interceptDNList |
SystemMediaSetModifyRequest(OCIRequest)
Request to modify a Media Set.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| set_name | str | setName |
| media_name_list | OCI.mediaNameList | mediaNameList Optional |
SystemMeetMeConferencingModifyRequest(OCIRequest)
Modify the system level data associated with Meet-Me Conferencing.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| conference_id_length | int | conferenceIdLength Optional |
| moderator_pin_length | int | moderatorPinLength Optional |
| enable_conference_end_date_restriction | bool | enableConferenceEndDateRestriction Optional |
| conference_end_date_restriction_months | int | conferenceEndDateRestrictionMonths Optional |
| delete_expired_conferences_after_hold_period | bool | deleteExpiredConferencesAfterHoldPeriod Optional |
| expired_conference_hold_period_days | int | expiredConferenceHoldPeriodDays Optional |
| recording_web_app_url | str | recordingWebAppURL Optional |
| recording_file_format | str | recordingFileFormat Optional |
| terminate_after_grace_period | bool | terminateAfterGracePeriod Optional |
| conference_grace_period_minutes | OCI.conferenceGracePeriodMinutes | conferenceGracePeriodMinutes Optional |
| conference_participant_early_entry_minutes | int | conferenceParticipantEarlyEntryMinutes Optional |
| enable_conference_expiry_notification | bool | enableConferenceExpiryNotification Optional |
| enable_active_conference_notification | bool | enableActiveConferenceNotification Optional |
| conference_from_address | str | conferenceFromAddress Optional |
| conference_active_talker_refresh_interval_seconds | int | conferenceActiveTalkerRefreshIntervalSeconds Optional |
SystemNetworkClassOfServiceAddRequest(OCIRequest)
Add a new Network Class of Service.
The following elements are only used in AS data mode: callProcessingPolicyProfileName
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| description | str | description Optional |
| communication_barring_profile0 | OCI.communicationBarringProfile0 | communicationBarringProfile0 Optional |
| communication_barring_profile1 | OCI.communicationBarringProfile1 | communicationBarringProfile1 Optional |
| communication_barring_profile2 | OCI.communicationBarringProfile2 | communicationBarringProfile2 Optional |
| communication_barring_profile3 | OCI.communicationBarringProfile3 | communicationBarringProfile3 Optional |
| communication_barring_profile4 | OCI.communicationBarringProfile4 | communicationBarringProfile4 Optional |
| communication_barring_profile5 | OCI.communicationBarringProfile5 | communicationBarringProfile5 Optional |
| communication_barring_profile6 | OCI.communicationBarringProfile6 | communicationBarringProfile6 Optional |
| communication_barring_profile7 | OCI.communicationBarringProfile7 | communicationBarringProfile7 Optional |
| communication_barring_profile8 | OCI.communicationBarringProfile8 | communicationBarringProfile8 Optional |
| communication_barring_profile9 | OCI.communicationBarringProfile9 | communicationBarringProfile9 Optional |
| network_translation_index | str | networkTranslationIndex Optional |
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName Optional |
SystemNetworkClassOfServiceModifyRequest(OCIRequest)
Modify an existing Network Class of Service.
The following elements are only used in AS data mode: callProcessingPolicyProfileName
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| communication_barring_profile0 | OCI.communicationBarringProfile0 | communicationBarringProfile0 Optional |
| communication_barring_profile1 | OCI.communicationBarringProfile1 | communicationBarringProfile1 Optional |
| communication_barring_profile2 | OCI.communicationBarringProfile2 | communicationBarringProfile2 Optional |
| communication_barring_profile3 | OCI.communicationBarringProfile3 | communicationBarringProfile3 Optional |
| communication_barring_profile4 | OCI.communicationBarringProfile4 | communicationBarringProfile4 Optional |
| communication_barring_profile5 | OCI.communicationBarringProfile5 | communicationBarringProfile5 Optional |
| communication_barring_profile6 | OCI.communicationBarringProfile6 | communicationBarringProfile6 Optional |
| communication_barring_profile7 | OCI.communicationBarringProfile7 | communicationBarringProfile7 Optional |
| communication_barring_profile8 | OCI.communicationBarringProfile8 | communicationBarringProfile8 Optional |
| communication_barring_profile9 | OCI.communicationBarringProfile9 | communicationBarringProfile9 Optional |
| network_translation_index | str | networkTranslationIndex Optional |
| call_processing_policy_profile_name | str | callProcessingPolicyProfileName Optional |
SystemOfficeZoneModifyRequest(OCIRequest)
Modify an existing Office Zone.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| office_zone_name | str | officeZoneName |
| new_office_zone_name | str | newOfficeZoneName Optional |
| description | str | description Optional |
| replacement_zone_list | OCI.replacementZoneList | replacementZoneList Optional |
| primary_zone_name | str | primaryZoneName Optional |
SystemSIPAuthenticationEndpointLockoutClearRequest(OCIRequest)
Request to clear sip authentication endpoint lockouts in the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_endpoint_key | List[OCI.userEndpointKey] | userEndpointKey |
SystemSIPAuthenticationTrunkGroupLockoutClearRequest(OCIRequest)
Request to clear sip authentication trunk group lockouts in the system.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_groupkey | List[OCI.trunkGroupkey] | trunkGroupkey |
SystemSIPDeviceTypeAddRequest(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| authentication_override | bool | authenticationOverride |
| rfc3264_hold | bool | RFC3264Hold |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| use_business_trunking_contact | bool | useBusinessTrunkingContact |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
SystemSIPDeviceTypeAddRequest14sp1(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: SystemSIPDeviceTypeAddRequest14sp2()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| authentication_override | bool | authenticationOverride |
| rfc3264_hold | bool | RFC3264Hold |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| use_business_trunking_contact | bool | useBusinessTrunkingContact |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
SystemSIPDeviceTypeAddRequest14sp2(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: SystemSIPDeviceTypeAddRequest14sp3()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| rfc3264_hold | bool | RFC3264Hold |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| use_business_trunking_contact | bool | useBusinessTrunkingContact |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
SystemSIPDeviceTypeAddRequest14sp3(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
SystemSIPDeviceTypeAddRequest14sp6()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| rfc3264_hold | bool | RFC3264Hold |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| use_business_trunking_contact | bool | useBusinessTrunkingContact |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| tdm_overlay | bool | tdmOverlay |
| supports_broad_works_info_for_call_waiting | bool | supportsBroadWorksINFOForCallWaiting |
SystemSIPDeviceTypeFileAddRequest(OCIRequest)
Request to add a sip device type file.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: SystemSIPDeviceTypeFileAddRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_type | str | fileType |
| file_format | str | fileFormat |
| remote_file_format | str | remoteFileFormat |
| file_category | str | fileCategory |
| allow_file_customization | bool | allowFileCustomization |
| file_source | str | fileSource |
| upload_file | OCI.uploadFile | uploadFile Optional |
| use_http_digest_authentication | bool | useHttpDigestAuthentication |
| mac_based_file_authentication | bool | macBasedFileAuthentication |
| user_name_password_file_authentication | bool | userNamePasswordFileAuthentication |
| mac_in_non_request_uri | bool | macInNonRequestURI |
| mac_format_in_non_request_uri | str | macFormatInNonRequestURI Optional |
SystemSIPDeviceTypeFileAddRequest14sp8(OCIRequest)
Request to add a sip device type file.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
| remote_file_format | str | remoteFileFormat |
| file_category | str | fileCategory |
| allow_file_customization | bool | allowFileCustomization |
| file_source | str | fileSource |
| upload_file | OCI.uploadFile | uploadFile Optional |
| use_http_digest_authentication | bool | useHttpDigestAuthentication |
| mac_based_file_authentication | bool | macBasedFileAuthentication |
| user_name_password_file_authentication | bool | userNamePasswordFileAuthentication |
| mac_in_non_request_uri | bool | macInNonRequestURI |
| mac_format_in_non_request_uri | str | macFormatInNonRequestURI Optional |
SystemSIPDeviceTypeFileAddRequest16sp1(OCIRequest)
Replaced By SystemSIPDeviceTypeFileAddRequest18().
Request to add a sip device type file.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
| remote_file_format | str | remoteFileFormat |
| file_category | str | fileCategory |
| file_customization | str | fileCustomization |
| file_source | str | fileSource |
| upload_file | OCI.uploadFile | uploadFile Optional |
| use_http_digest_authentication | bool | useHttpDigestAuthentication |
| mac_based_file_authentication | bool | macBasedFileAuthentication |
| user_name_password_file_authentication | bool | userNamePasswordFileAuthentication |
| mac_in_non_request_uri | bool | macInNonRequestURI |
| mac_format_in_non_request_uri | str | macFormatInNonRequestURI Optional |
SystemSIPDeviceTypeFileAddRequest18(OCIRequest)
Request to add a sip device type file.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
| remote_file_format | str | remoteFileFormat |
| file_category | str | fileCategory |
| file_customization | str | fileCustomization |
| file_source | str | fileSource |
| upload_file | OCI.uploadFile | uploadFile Optional |
| use_http_digest_authentication | bool | useHttpDigestAuthentication |
| mac_based_file_authentication | bool | macBasedFileAuthentication |
| user_name_password_file_authentication | bool | userNamePasswordFileAuthentication |
| mac_in_non_request_uri | bool | macInNonRequestURI |
| mac_format_in_non_request_uri | str | macFormatInNonRequestURI Optional |
| allow_http | bool | allowHttp |
| allow_https | bool | allowHttps |
| allow_tftp | bool | allowTftp |
| enable_caching | bool | enableCaching |
SystemSIPDeviceTypeFileAddRequest19(OCIRequest)
Request to add a sip device type file.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
SystemSIPDeviceTypeFileAddRequest20()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
| remote_file_format | str | remoteFileFormat |
| file_category | str | fileCategory |
| file_customization | str | fileCustomization |
| file_source | str | fileSource |
| upload_file | OCI.uploadFile | uploadFile Optional |
| use_http_digest_authentication | bool | useHttpDigestAuthentication |
| mac_based_file_authentication | bool | macBasedFileAuthentication |
| user_name_password_file_authentication | bool | userNamePasswordFileAuthentication |
| mac_in_non_request_uri | bool | macInNonRequestURI |
| mac_format_in_non_request_uri | str | macFormatInNonRequestURI Optional |
| allow_http | bool | allowHttp |
| allow_https | bool | allowHttps |
| allow_tftp | bool | allowTftp |
| enable_caching | bool | enableCaching |
| allow_upload_from_device | bool | allowUploadFromDevice |
SystemSIPDeviceTypeFileAddRequest20(OCIRequest)
Request to add a sip device type file.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
SystemSIPDeviceTypeFileAddRequest20Sp1
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
| remote_file_format | str | remoteFileFormat |
| file_category | str | fileCategory |
| file_customization | str | fileCustomization |
| file_source | str | fileSource |
| upload_file | OCI.uploadFile | uploadFile Optional |
| use_http_digest_authentication | bool | useHttpDigestAuthentication |
| mac_based_file_authentication | bool | macBasedFileAuthentication |
| user_name_password_file_authentication | bool | userNamePasswordFileAuthentication |
| mac_in_non_request_uri | bool | macInNonRequestURI |
| mac_format_in_non_request_uri | str | macFormatInNonRequestURI Optional |
| allow_http | bool | allowHttp |
| allow_https | bool | allowHttps |
| allow_tftp | bool | allowTftp |
| enable_caching | bool | enableCaching |
| allow_upload_from_device | bool | allowUploadFromDevice |
| default_extended_file_capture_mode | bool | defaultExtendedFileCaptureMode Optional |
SystemSIPDeviceTypeFileAddRequest21sp1(OCIRequest)
Request to add a sip device type file.
The response is either SuccessResponse() or ErrorResponse(). The following logic
applies to these elements: macInCert macInNonRequestURI The two elements are mutually
exclusive. When both are set to true, the command fails. Replaced by:
SystemSIPDeviceTypeFileAddRequest22() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
| remote_file_format | str | remoteFileFormat |
| file_category | str | fileCategory |
| file_customization | str | fileCustomization |
| file_source | str | fileSource |
| upload_file | OCI.uploadFile | uploadFile Optional |
| use_http_digest_authentication | bool | useHttpDigestAuthentication |
| mac_based_file_authentication | bool | macBasedFileAuthentication |
| user_name_password_file_authentication | bool | userNamePasswordFileAuthentication |
| mac_in_non_request_uri | bool | macInNonRequestURI |
| mac_in_cert | bool | macInCert |
| mac_format_in_non_request_uri | str | macFormatInNonRequestURI Optional |
| allow_http | bool | allowHttp |
| allow_https | bool | allowHttps |
| allow_tftp | bool | allowTftp |
| enable_caching | bool | enableCaching |
| allow_upload_from_device | bool | allowUploadFromDevice |
| default_extended_file_capture_mode | bool | defaultExtendedFileCaptureMode Optional |
SystemSIPDeviceTypeFileAddRequest22(OCIRequest)
Request to add a sip device type file.
The response is either SuccessResponse() or ErrorResponse(). The following logic
applies to these elements: macInCert macInNonRequestURI The two elements are mutually
exclusive. When both are set to true, the command fails. Replaced by:
SystemSIPDeviceTypeFileAddRequest22V2() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
| remote_file_format | str | remoteFileFormat |
| file_category | str | fileCategory |
| file_customization | str | fileCustomization |
| file_source | str | fileSource |
| upload_file | OCI.uploadFile | uploadFile Optional |
| use_http_digest_authentication | bool | useHttpDigestAuthentication |
| mac_based_file_authentication | bool | macBasedFileAuthentication |
| user_name_password_file_authentication | bool | userNamePasswordFileAuthentication |
| mac_in_non_request_uri | bool | macInNonRequestURI |
| mac_in_cert | bool | macInCert |
| mac_format_in_non_request_uri | str | macFormatInNonRequestURI Optional |
| allow_http | bool | allowHttp |
| allow_https | bool | allowHttps |
| allow_tftp | bool | allowTftp |
| enable_caching | bool | enableCaching |
| allow_upload_from_device | bool | allowUploadFromDevice |
| default_extended_file_capture_mode | bool | defaultExtendedFileCaptureMode Optional |
SystemSIPDeviceTypeFileAddRequest22V2(OCIRequest)
Request to add a sip device type file.
The response is either SuccessResponse() or ErrorResponse(). The following logic
applies to these elements: macInCert macInNonRequestURI The two elements are mutually
exclusive. When both are set to true, the command fails.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
| remote_file_format | str | remoteFileFormat |
| file_category | str | fileCategory |
| file_customization | str | fileCustomization |
| file_source | str | fileSource |
| upload_file | OCI.uploadFile | uploadFile Optional |
| use_http_digest_authentication | bool | useHttpDigestAuthentication |
| mac_based_file_authentication | bool | macBasedFileAuthentication |
| user_name_password_file_authentication | bool | userNamePasswordFileAuthentication |
| bearer_file_authentication | bool | bearerFileAuthentication |
| mac_in_non_request_uri | bool | macInNonRequestURI |
| mac_in_cert | bool | macInCert |
| mac_format_in_non_request_uri | str | macFormatInNonRequestURI Optional |
| allow_http | bool | allowHttp |
| allow_https | bool | allowHttps |
| allow_tftp | bool | allowTftp |
| enable_caching | bool | enableCaching |
| allow_upload_from_device | bool | allowUploadFromDevice |
| default_extended_file_capture_mode | bool | defaultExtendedFileCaptureMode Optional |
SystemSIPDeviceTypeFileModifyRequest(OCIRequest)
Request to modify a sip device type file.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: SystemSIPDeviceTypeFileModifyRequest14sp8()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_type | str | fileType |
| allow_file_customization | bool | allowFileCustomization Optional |
| file_source | str | fileSource Optional |
| upload_file | OCI.uploadFile | uploadFile Optional |
| use_http_digest_authentication | bool | useHttpDigestAuthentication Optional |
| mac_based_file_authentication | bool | macBasedFileAuthentication Optional |
| user_name_password_file_authentication | bool | userNamePasswordFileAuthentication Optional |
| mac_in_non_request_uri | bool | macInNonRequestURI Optional |
| mac_format_in_non_request_uri | str | macFormatInNonRequestURI Optional |
SystemSIPDeviceTypeFileModifyRequest14sp8(OCIRequest)
Request to modify a sip device type file.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
| allow_file_customization | bool | allowFileCustomization Optional |
| file_source | str | fileSource Optional |
| upload_file | OCI.uploadFile | uploadFile Optional |
| use_http_digest_authentication | bool | useHttpDigestAuthentication Optional |
| mac_based_file_authentication | bool | macBasedFileAuthentication Optional |
| user_name_password_file_authentication | bool | userNamePasswordFileAuthentication Optional |
| mac_in_non_request_uri | bool | macInNonRequestURI Optional |
| mac_format_in_non_request_uri | str | macFormatInNonRequestURI Optional |
SystemSIPDeviceTypeFileModifyRequest16sp1(OCIRequest)
Request to modify a sip device type file.
The response is either SuccessResponse() or ErrorResponse(). The following logic
applies to these elements: macInCert macInNonRequestURI The two elements are mutually
exclusive. When both are set to true, the command fails. When macInCert is set to
true, macInNonRequestURI will be reset to false. When macInNonRequestURI is set to
true, macInCert will be reset to false. The following elements are ignored in XS data
mode: bearerFileAuthentication
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| file_format | str | fileFormat |
| file_customization | str | fileCustomization Optional |
| file_source | str | fileSource Optional |
| upload_file | OCI.uploadFile | uploadFile Optional |
| use_http_digest_authentication | bool | useHttpDigestAuthentication Optional |
| mac_based_file_authentication | bool | macBasedFileAuthentication Optional |
| user_name_password_file_authentication | bool | userNamePasswordFileAuthentication Optional |
| mac_in_non_request_uri | bool | macInNonRequestURI Optional |
| mac_in_cert | bool | macInCert Optional |
| mac_format_in_non_request_uri | str | macFormatInNonRequestURI Optional |
| allow_http | bool | allowHttp Optional |
| allow_https | bool | allowHttps Optional |
| allow_tftp | bool | allowTftp Optional |
| enable_caching | bool | enableCaching Optional |
| allow_upload_from_device | bool | allowUploadFromDevice Optional |
| default_extended_file_capture_mode | bool | defaultExtendedFileCaptureMode Optional |
| bearer_file_authentication | bool | bearerFileAuthentication Optional |
SystemSIPDeviceTypeLanguageMappingModifyRequest(OCIRequest)
Request to modify the device language name that is mapped to a BroadWorks language name.
The request can be used to map many languages.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| language_mapping | List[OCI.languageMapping] | languageMapping Optional |
SystemScheduleAddEventRequest(OCIRequest)
Add an event to system schedule.
The response is either a SuccessResponse() or an ErrorResponse(). The startDate
element is adjusted to the first occurrence of the recurrent schedule that comes at or
after the startDate. The endDate element is set to the sum of the adjusted starDate
element value and the event duration.
Attributes:
| Name | Type | Description |
|---|---|---|
| schedule_key | OCI.scheduleKey | scheduleKey |
| event_name | str | eventName |
| start_date | str | startDate |
| all_day_event | bool | allDayEvent Optional |
| start_time | OCI.startTime | startTime Optional |
| end_time | OCI.endTime | endTime Optional |
| end_date | str | endDate |
| recurrence | OCI.recurrence | recurrence Optional |
SystemScheduleDeleteEventListRequest(OCIRequest)
Delete a list of events from a system schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| schedule_key | OCI.scheduleKey | scheduleKey |
| event_name | List[str] | eventName |
SystemScheduleDeleteListRequest(OCIRequest)
Delete a list of system schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| schedule_key | List[OCI.scheduleKey] | scheduleKey |
SystemScheduleGetEventListRequest(OCIRequest)
Get the list of events of a system schedule.
The response is either a SystemScheduleGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| schedule_key | OCI.scheduleKey | scheduleKey |
SystemScheduleGetEventRequest(OCIRequest)
Get an event from a system schedule.
The response is either a SystemScheduleGetEventResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| schedule_key | OCI.scheduleKey | scheduleKey |
| event_name | str | eventName |
SystemScheduleModifyEventRequest(OCIRequest)
Modify an event of a system schedule.
The response is either a SuccessResponse() or an ErrorResponse(). The startDate
element is adjusted to the first occurrence of the recurrent schedule that comes at or
after the startDate. The endDate element is set to the sum of the adjusted starDate
element value and the event duration.
Attributes:
| Name | Type | Description |
|---|---|---|
| schedule_key | OCI.scheduleKey | scheduleKey |
| event_name | str | eventName |
| new_event_name | str | newEventName Optional |
| start_date | str | startDate Optional |
| all_day_event | bool | allDayEvent Optional |
| start_time | OCI.startTime | startTime Optional |
| end_time | OCI.endTime | endTime Optional |
| end_date | str | endDate Optional |
| recurrence | OCI.recurrence | recurrence Optional |
SystemScheduleModifyRequest(OCIRequest)
Modify a system schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| schedule_key | OCI.scheduleKey | scheduleKey |
| new_schedule_name | str | newScheduleName Optional |
SystemSecurityClassificationAddClassificationRequest(OCIRequest)
Add a new Security Classification The response is either a SuccessResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| security_classification_name | str | securityClassificationName |
| audio_file | OCI.audioFile | audioFile |
SystemSecurityClassificationModifyClassificationRequest(OCIRequest)
Modify a Security Classification The response is either a SuccessResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| security_classification_name | str | securityClassificationName |
| new_security_classification_name | str | newSecurityClassificationName Optional |
| audio_file | OCI.audioFile | audioFile Optional |
SystemServiceAttributeDefaultModifyListRequest(OCIRequest)
Request to modify a list of default attributes that are used when assigning the feature.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_name | str | serviceName |
| service_attribute_entry | List[OCI.serviceAttributeEntry] | serviceAttributeEntry |
SystemSubscriptionLicenseReportingModifyRequest(OCIRequest)
Modify the subscription license reporting system parameters.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| daily_report_scheduled_time | OCI.dailyReportScheduledTime | dailyReportScheduledTime |
SystemSystemServiceDnAddListRequest(OCIRequest)
Adds system service Dns.
It is possible to add either: a single DN, a list of DNs a range of DNs, or any combination thereof.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| phone_number | List[str] | phoneNumber Optional |
| dn_range | List[OCI.dnRange] | dnRange Optional |
SystemSystemServiceDnDeleteListRequest(OCIRequest)
Deletes system service DNs.
It is possible to delete either: a single DN, a list of DNs, a range of DNs, or any combination thereof.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| phone_number | List[str] | phoneNumber Optional |
| dn_range | List[OCI.dnRange] | dnRange Optional |
SystemSystemVoicePortalAddRequest(OCIRequest)
Request to add a system voice portal instance.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in IMS mode: publicUserIdentity, ignored in standalone mode if
provided. Replaced by: SystemSystemVoicePortalAddRequest21sp1().
Attributes:
| Name | Type | Description |
|---|---|---|
| system_voice_portal_id | str | systemVoicePortalId |
| name | str | name |
| calling_line_id_name | str | callingLineIdName |
| language | str | language |
| time_zone | str | timeZone |
| phone_number | str | phoneNumber Optional |
| public_user_identity | str | publicUserIdentity Optional |
| network_voice_portal_number | str | networkVoicePortalNumber Optional |
| allow_identification_by_phone_number_or_voice_mail_aliases_on_login | bool | allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin |
| use_voice_portal_wizard | bool | useVoicePortalWizard |
| use_voice_portal_default_greeting | bool | useVoicePortalDefaultGreeting |
| voice_portal_greeting_file | OCI.voicePortalGreetingFile | voicePortalGreetingFile Optional |
| use_voice_messaging_default_greeting | bool | useVoiceMessagingDefaultGreeting |
| voice_messaging_greeting_file | OCI.voiceMessagingGreetingFile | voiceMessagingGreetingFile Optional |
SystemSystemVoicePortalAddRequest21sp1(OCIRequest)
Request to add a system voice portal instance.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in IMS mode: publicUserIdentity, ignored in standalone mode if
provided. The following elements are only used in AS mode and ignored in XS data
mode: networkClassOfService
Attributes:
| Name | Type | Description |
|---|---|---|
| system_voice_portal_id | str | systemVoicePortalId |
| name | str | name |
| calling_line_id_name | str | callingLineIdName |
| language | str | language |
| time_zone | str | timeZone |
| phone_number | str | phoneNumber Optional |
| public_user_identity | str | publicUserIdentity Optional |
| network_voice_portal_number | str | networkVoicePortalNumber Optional |
| allow_identification_by_phone_number_or_voice_mail_aliases_on_login | bool | allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin |
| use_voice_portal_wizard | bool | useVoicePortalWizard |
| use_voice_portal_default_greeting | bool | useVoicePortalDefaultGreeting |
| voice_portal_greeting_file | OCI.voicePortalGreetingFile | voicePortalGreetingFile Optional |
| use_voice_messaging_default_greeting | bool | useVoiceMessagingDefaultGreeting |
| voice_messaging_greeting_file | OCI.voiceMessagingGreetingFile | voiceMessagingGreetingFile Optional |
| express_mode | bool | expressMode |
| network_class_of_service | str | networkClassOfService Optional |
SystemSystemVoicePortalModifyRequest(OCIRequest)
Request to update a System Voice portal instance.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
networkClassOfService
Attributes:
| Name | Type | Description |
|---|---|---|
| system_voice_portal_id | str | systemVoicePortalId |
| new_system_voice_portal_id | str | newSystemVoicePortalId Optional |
| name | str | name Optional |
| calling_line_id_name | str | callingLineIdName Optional |
| language | str | language Optional |
| time_zone | str | timeZone Optional |
| phone_number | str | phoneNumber Optional |
| public_user_identity | str | publicUserIdentity Optional |
| network_voice_portal_number | str | networkVoicePortalNumber Optional |
| allow_identification_by_phone_number_or_voice_mail_aliases_on_login | bool | allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin Optional |
| use_voice_portal_wizard | bool | useVoicePortalWizard Optional |
| become_default_system_voice_portal | bool | becomeDefaultSystemVoicePortal Optional |
| use_voice_portal_default_greeting | bool | useVoicePortalDefaultGreeting Optional |
| voice_portal_greeting_file | OCI.voicePortalGreetingFile | voicePortalGreetingFile Optional |
| use_voice_messaging_default_greeting | bool | useVoiceMessagingDefaultGreeting Optional |
| voice_messaging_greeting_file | OCI.voiceMessagingGreetingFile | voiceMessagingGreetingFile Optional |
| express_mode | bool | expressMode Optional |
| network_class_of_service | str | networkClassOfService Optional |
SystemTimeScheduleAddRequest(OCIRequest)
Add a system time schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| time_schedule_name | str | timeScheduleName |
| time_interval01 | OCI.timeInterval01 | timeInterval01 Optional |
| time_interval02 | OCI.timeInterval02 | timeInterval02 Optional |
| time_interval03 | OCI.timeInterval03 | timeInterval03 Optional |
| time_interval04 | OCI.timeInterval04 | timeInterval04 Optional |
| time_interval05 | OCI.timeInterval05 | timeInterval05 Optional |
| time_interval06 | OCI.timeInterval06 | timeInterval06 Optional |
| time_interval07 | OCI.timeInterval07 | timeInterval07 Optional |
| time_interval08 | OCI.timeInterval08 | timeInterval08 Optional |
| time_interval09 | OCI.timeInterval09 | timeInterval09 Optional |
| time_interval10 | OCI.timeInterval10 | timeInterval10 Optional |
| time_interval11 | OCI.timeInterval11 | timeInterval11 Optional |
| time_interval12 | OCI.timeInterval12 | timeInterval12 Optional |
| time_interval13 | OCI.timeInterval13 | timeInterval13 Optional |
| time_interval14 | OCI.timeInterval14 | timeInterval14 Optional |
| time_interval15 | OCI.timeInterval15 | timeInterval15 Optional |
| time_interval16 | OCI.timeInterval16 | timeInterval16 Optional |
| time_interval17 | OCI.timeInterval17 | timeInterval17 Optional |
| time_interval18 | OCI.timeInterval18 | timeInterval18 Optional |
| time_interval19 | OCI.timeInterval19 | timeInterval19 Optional |
| time_interval20 | OCI.timeInterval20 | timeInterval20 Optional |
SystemTimeScheduleModifyRequest(OCIRequest)
Modify a specified system time schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| time_schedule_name | str | timeScheduleName |
| new_time_schedule_name | str | newTimeScheduleName Optional |
| time_interval01 | OCI.timeInterval01 | timeInterval01 Optional |
| time_interval02 | OCI.timeInterval02 | timeInterval02 Optional |
| time_interval03 | OCI.timeInterval03 | timeInterval03 Optional |
| time_interval04 | OCI.timeInterval04 | timeInterval04 Optional |
| time_interval05 | OCI.timeInterval05 | timeInterval05 Optional |
| time_interval06 | OCI.timeInterval06 | timeInterval06 Optional |
| time_interval07 | OCI.timeInterval07 | timeInterval07 Optional |
| time_interval08 | OCI.timeInterval08 | timeInterval08 Optional |
| time_interval09 | OCI.timeInterval09 | timeInterval09 Optional |
| time_interval10 | OCI.timeInterval10 | timeInterval10 Optional |
| time_interval11 | OCI.timeInterval11 | timeInterval11 Optional |
| time_interval12 | OCI.timeInterval12 | timeInterval12 Optional |
| time_interval13 | OCI.timeInterval13 | timeInterval13 Optional |
| time_interval14 | OCI.timeInterval14 | timeInterval14 Optional |
| time_interval15 | OCI.timeInterval15 | timeInterval15 Optional |
| time_interval16 | OCI.timeInterval16 | timeInterval16 Optional |
| time_interval17 | OCI.timeInterval17 | timeInterval17 Optional |
| time_interval18 | OCI.timeInterval18 | timeInterval18 Optional |
| time_interval19 | OCI.timeInterval19 | timeInterval19 Optional |
| time_interval20 | OCI.timeInterval20 | timeInterval20 Optional |
SystemXsiApplicationIdAddListRequest(OCIRequest)
Add the system Xsi application Id entries.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| xsi_application_id_entry | List[OCI.xsiApplicationIdEntry] | xsiApplicationIdEntry |
SystemXsiPolicyProfileDeleteRequest(OCIRequest)
Delete an entry from system Xsi application Id list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| xsi_policy_profile | OCI.xsiPolicyProfile | xsiPolicyProfile |
SystemXsiPolicyProfileGetRequest(OCIRequest)
Get an existing Xsi policy profile.
The response is either a SystemXsiPolicyProfileGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| xsi_policy_profile | OCI.xsiPolicyProfile | xsiPolicyProfile |
SystemXsiPolicyProfileModifyRequest(OCIRequest)
Modify the system Xsi policy profile entry.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| xsi_policy_profile | OCI.xsiPolicyProfile | xsiPolicyProfile |
| new_xsi_policy_profile_name | str | newXsiPolicyProfileName Optional |
| description | str | description Optional |
| max_target_subscription | int | maxTargetSubscription Optional |
SystemZoneAddRequest(OCIRequest)
Add a Zone and optional Net Addresses and Physical Locations.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| zone_name | str | zoneName |
| net_address | List[str] | netAddress Optional |
| net_address_range | List[OCI.netAddressRange] | netAddressRange Optional |
| location_based_physical_location | List[str] | locationBasedPhysicalLocation Optional |
| calling_zone_physical_location | str | callingZonePhysicalLocation Optional |
SystemZoneCallingRestrictionsNetAddressAddListRequest(OCIRequest)
Adds a list of IP addresses to a zone The response is SuccessResponse() or an
ErrorResponse().
Replaced by: SystemZoneNetAddressAddListRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| zone_name | str | zoneName |
| net_address | List[str] | netAddress Optional |
| net_address_range | List[OCI.netAddressRange] | netAddressRange Optional |
SystemZoneCallingRestrictionsNetAddressDeleteListRequest(OCIRequest)
Deletes a list of IP addresses from a zone The response is SuccessResponse() or an
ErrorResponse().
Replaced by: SystemZoneNetAddressDeleteListRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| zone_name | str | zoneName |
| net_address | List[str] | netAddress Optional |
| net_address_range | List[OCI.netAddressRange] | netAddressRange Optional |
SystemZoneNetAddressAddListRequest(OCIRequest)
Adds a list of IP addresses to a zone The response is SuccessResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| zone_name | str | zoneName |
| net_address | List[str] | netAddress Optional |
| net_address_range | List[OCI.netAddressRange] | netAddressRange Optional |
SystemZoneNetAddressDeleteListRequest(OCIRequest)
Deletes a list of IP addresses from a zone The response is SuccessResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| zone_name | str | zoneName |
| net_address | List[str] | netAddress Optional |
| net_address_range | List[OCI.netAddressRange] | netAddressRange Optional |
UserAccessDeviceFileGetListRequest(OCIRequest)
Request to get the list of Device Management user modifiable files.
The response is either UserAccessDeviceFileGetListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| access_device | OCI.accessDevice | accessDevice |
UserAccessDeviceFileGetRequest(OCIRequest)
Request to get a user modifiable file.
The response is either UserAccessDeviceFileGetResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| access_device | OCI.accessDevice | accessDevice |
| file_format | str | fileFormat |
UserAccessDeviceFileModifyRequest(OCIRequest)
Request to modify a user modifiable access device file.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| access_device | OCI.accessDevice | accessDevice |
| file_format | str | fileFormat |
| upload_file | OCI.uploadFile | uploadFile |
UserAccessDeviceResetRequest(OCIRequest)
Reset a specific user SIP device that supports the reset operation.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| access_device | OCI.accessDevice | accessDevice |
UserAccessDeviceTagsGetRequest(OCIRequest)
Request to get all the device tag names and values for a specific device.
The resolved tags are returned only if the device is the main device for this user.
The response is either a UserAccessDeviceTagsGetResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| access_device | OCI.accessDevice | accessDevice |
UserAlternateNumbersModifyRequest(OCIRequest)
Modify the user level data associated with Alternate Numbers.
The following element in AlternateNumberEntry21 datatype is only used in AS mode: description In XS data mode, the request will fail if one of the alternate entry's phone number element represents a currently configured BroadWorks Anywhere location for the user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| distinctive_ring | bool | distinctiveRing Optional |
| alternate_entry01 | OCI.alternateEntry01 | alternateEntry01 Optional |
| alternate_entry02 | OCI.alternateEntry02 | alternateEntry02 Optional |
| alternate_entry03 | OCI.alternateEntry03 | alternateEntry03 Optional |
| alternate_entry04 | OCI.alternateEntry04 | alternateEntry04 Optional |
| alternate_entry05 | OCI.alternateEntry05 | alternateEntry05 Optional |
| alternate_entry06 | OCI.alternateEntry06 | alternateEntry06 Optional |
| alternate_entry07 | OCI.alternateEntry07 | alternateEntry07 Optional |
| alternate_entry08 | OCI.alternateEntry08 | alternateEntry08 Optional |
| alternate_entry09 | OCI.alternateEntry09 | alternateEntry09 Optional |
| alternate_entry10 | OCI.alternateEntry10 | alternateEntry10 Optional |
UserAnnouncementFileAddRequest(OCIRequest)
Add an announcement to the user announcement repository The following elements are
only used in AS data mode and ignored in XS data mode: announcementFileExternalId The
response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| announcement_file_name | str | announcementFileName Optional |
| announcement_file_external_id | str | announcementFileExternalId Optional |
| announcement_file | OCI.announcementFile | announcementFile |
UserAnnouncementFileDeleteListRequest(OCIRequest)
Delete one or more announcements from the user announcement repository The following
elements are only used in AS data mode and ignored in XS data mode:
announcementFileExternalId The response is either a SuccessResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| announcement_file_key | List[OCI.announcementFileKey] | announcementFileKey Optional |
| announcement_file_external_id | List[str] | announcementFileExternalId Optional |
UserAnnouncementFileGetRequest(OCIRequest)
Request to get the announcement repository file information.
The response is either UserAnnouncementFileGetResponse() or ErrorResponse().
Replaced by: UserAnnouncementFileGetRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| announcement_file_key | OCI.announcementFileKey | announcementFileKey |
UserAnnouncementFileGetRequest22(OCIRequest)
Request to get the announcement repository file information.
The following elements are only used in AS data mode and ignored in XS data mode: announcementFileExternalId
The response is either UserAnnouncementFileGetResponse22() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId Optional |
| announcement_file_key | OCI.announcementFileKey | announcementFileKey Optional |
| announcement_file_external_id | str | announcementFileExternalId Optional |
UserAnnouncementFileModifyRequest(OCIRequest)
This command is used to change the name of the file or upload a new announcement file for an existing announcement in the user repository.
When modifying the file type the command will fail if the media type of the new file changes the announcement from audio to video (or vice versa). The following elements are only used in AS data mode and ignored in XS data mode: announcementFileExternalId
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId Optional |
| announcement_file_key | OCI.announcementFileKey | announcementFileKey Optional |
| announcement_file_external_id | str | announcementFileExternalId Optional |
| new_announcement_file_name | str | newAnnouncementFileName Optional |
| announcement_file | OCI.announcementFile | announcementFile Optional |
UserBroadWorksAnywhereAddSelectiveCriteriaRequest(OCIRequest)
Add a criteria to the user's BroadWorks Anywhere phone number.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
UserBroadWorksAnywhereAddSelectiveCriteriaRequest16(OCIRequest)
Add a criteria to the user's BroadWorks Anywhere phone number.
The following elements are only used in AS data mode: callToNumber For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
| call_to_number | List[OCI.callToNumber] | callToNumber Optional |
UserBroadWorksAnywhereModifyPhoneNumberRequest(OCIRequest)
Modify a BroadWorks Anywhere phone number In XS data mode, the request will fail if the phoneNumber element represents the user's directory number or one of the user's alternate numbers.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
| new_phone_number | str | newPhoneNumber Optional |
| description | str | description Optional |
| is_active | bool | isActive Optional |
| outbound_alternate_number | str | outboundAlternateNumber Optional |
| broadworks_call_control | bool | broadworksCallControl Optional |
| use_diversion_inhibitor | bool | useDiversionInhibitor Optional |
| answer_confirmation_required | bool | answerConfirmationRequired Optional |
| criteria_activation | List[OCI.criteriaActivation] | criteriaActivation Optional |
UserBroadWorksMobilityModifyRequest21(OCIRequest)
Modify the user's BroadWorks Mobility service settings.
The response is either a SuccessResponse() or an ErrorResponse(). The isActive,
useMobileIdentityCallAnchoring, and preventCallsToOwnMobiles parameters can be
modified by users with Group Authorization Level and above. The mobileIdentity,
profileIdentityDevicesToRing, rofileIdentityIncludeSharedCallAppearance,
profileIdentityIncludeBroadworksAnywhere mobileIdentity and
profileIdentityMobilityNumbersAlerted parameters can be modified by users with User
Authorization Level and above when the BroadWorks Mobility service is turned on.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| use_mobile_identity_call_anchoring | bool | useMobileIdentityCallAnchoring Optional |
| prevent_calls_to_own_mobiles | bool | preventCallsToOwnMobiles Optional |
| mobile_identity | List[OCI.mobileIdentity] | mobileIdentity Optional |
| profile_identity_devices_to_ring | str | profileIdentityDevicesToRing Optional |
| profile_identity_include_shared_call_appearance | bool | profileIdentityIncludeSharedCallAppearance Optional |
| profile_identity_include_broadworks_anywhere | bool | profileIdentityIncludeBroadworksAnywhere Optional |
| profile_identity_include_executive_assistant | bool | profileIdentityIncludeExecutiveAssistant Optional |
| profile_identity_mobility_numbers_alerted | OCI.profileIdentityMobilityNumbersAlerted | profileIdentityMobilityNumbersAlerted Optional |
UserBroadWorksReceptionistEnterpriseModifyRequest(OCIRequest)
Replace the BroadWorks Receptionist - Enterprise monitored user list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| monitored_user_id_list | OCI.monitoredUserIdList | monitoredUserIdList Optional |
UserBroadWorksReceptionistEnterpriseNoteGetRequest(OCIRequest)
Request the Receptionist notes for the specified Receptionist and Contact User IDs.
The response is either a UserBroadWorksReceptionistEnterpriseNoteGetResponse() or an
ErrorResponse(). If the user sending the request is the not the owner of the
Receptionist Note, then an ErrorResponse() will be returned.
Attributes:
| Name | Type | Description |
|---|---|---|
| receptionist_user_id | str | receptionistUserId |
| contact_user_id | str | contactUserId Optional |
| von_user | OCI.vonUser | vonUser Optional |
UserBroadWorksReceptionistOfficeModifyRequest(OCIRequest)
Replace the Receptionist Office monitored user list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| monitored_user_id_list | OCI.monitoredUserIdList | monitoredUserIdList Optional |
UserBroadWorksReceptionistSmallBusinessModifyRequest(OCIRequest)
Replace the Receptionist Small Business monitored user list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| monitored_user_id_list | OCI.monitoredUserIdList | monitoredUserIdList Optional |
UserBusyLampFieldModifyRequest(OCIRequest)
Modify the settings for the busy lamp field service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| list_uri | str | listURI Optional |
| monitored_user_id_list | OCI.monitoredUserIdList | monitoredUserIdList Optional |
| enable_call_park_notification | bool | enableCallParkNotification Optional |
UserCallCenterEnhancedReportingReportTemplateParamInfoGetRequest(OCIRequest)
Request to get the input parameter info for a call center report template.
The response is either a
UserCallCenterEnhancedReportingReportTemplateParamInfoGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| report_template | OCI.reportTemplate | reportTemplate |
UserCallCenterModifyAvailabilityListRequest(OCIRequest)
Request for an agent to login or logout of one or more Call Centers.
Contains a list specifing the desired login status of one or more call centers.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: UserCallCenterModifyRequest17sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| call_center_availability | List[OCI.callCenterAvailability] | callCenterAvailability Optional |
UserCallCenterModifyCallCenterListRequest(OCIRequest)
Request to modify the call center list for an agent.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| agent_user_id | str | agentUserId |
| service_user_id_list | OCI.serviceUserIdList | serviceUserIdList Optional |
UserCallCenterModifyRequest(OCIRequest)
Modifies the agents call center settings and the availability for an agent in one or more Call Centers.
Contains a list specifying the desired availability status of one or more call centers. A default unavailable code will be used if the parameter agentUnavailableCode is not active, included or is invalid. Changing the agentACDState from unavailable to any other state will automatically clear the unavailable code.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by
UserCallCenterModifyRequest17sp4().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| agent_acd_state | str | agentACDState Optional |
| agent_unavailable_code | str | agentUnavailableCode Optional |
| use_default_guard_timer | bool | useDefaultGuardTimer Optional |
| enable_guard_timer | bool | enableGuardTimer Optional |
| guard_timer_seconds | int | guardTimerSeconds Optional |
| use_system_default_unavailable_settings | bool | useSystemDefaultUnavailableSettings Optional |
| force_agent_unavailable_on_dnd_activation | bool | forceAgentUnavailableOnDNDActivation Optional |
| force_unavailable_on_personal_calls | bool | forceUnavailableOnPersonalCalls Optional |
| force_agent_unavailable_on_bounced_call_limit | bool | forceAgentUnavailableOnBouncedCallLimit Optional |
| number_consecutive_bounced_calls_to_force_agent_unavailable | int | numberConsecutiveBouncedCallsToForceAgentUnavailable Optional |
| make_outgoing_calls_as_call_center | bool | makeOutgoingCallsAsCallCenter Optional |
| outgoing_call_dnis | OCI.outgoingCallDNIS | outgoingCallDNIS Optional |
| call_center_availability | List[OCI.callCenterAvailability] | callCenterAvailability Optional |
UserCallCenterModifyRequest17sp4(OCIRequest)
Modifies the agents call center settings and the availability for an agent in one or more Call Centers.
Contains a list specifying the desired availability status of one or more call centers. A default unavailable code will be used if the parameter agentUnavailableCode is not active, included or is invalid. Changing the agentACDState from unavailable to any other state will automatically clear the unavailable code.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by
UserCallCenterModifyRequest19().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| agent_acd_state | str | agentACDState Optional |
| agent_threshold_profile_name | str | agentThresholdProfileName Optional |
| agent_unavailable_code | str | agentUnavailableCode Optional |
| use_default_guard_timer | bool | useDefaultGuardTimer Optional |
| enable_guard_timer | bool | enableGuardTimer Optional |
| guard_timer_seconds | int | guardTimerSeconds Optional |
| use_system_default_unavailable_settings | bool | useSystemDefaultUnavailableSettings Optional |
| force_agent_unavailable_on_dnd_activation | bool | forceAgentUnavailableOnDNDActivation Optional |
| force_agent_unavailable_on_personal_calls | bool | forceAgentUnavailableOnPersonalCalls Optional |
| force_agent_unavailable_on_bounced_call_limit | bool | forceAgentUnavailableOnBouncedCallLimit Optional |
| number_consecutive_bounced_calls_to_force_agent_unavailable | int | numberConsecutiveBouncedCallsToForceAgentUnavailable Optional |
| force_agent_unavailable_on_not_reachable | bool | forceAgentUnavailableOnNotReachable Optional |
| make_outgoing_calls_as_call_center | bool | makeOutgoingCallsAsCallCenter Optional |
| outgoing_call_dnis | OCI.outgoingCallDNIS | outgoingCallDNIS Optional |
| call_center_availability | List[OCI.callCenterAvailability] | callCenterAvailability Optional |
UserCallCenterModifyRequest19(OCIRequest)
Modifies the agents call center settings and the availability for an agent in one or more Call Centers.
Contains a list specifying the desired availability status of one or more call centers. A default unavailable code will be used if the parameter agentUnavailableCode is not active, included or is invalid. Changing the agentACDState from unavailable to any other state will automatically clear the unavailable code.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: agentACDState
agentThresholdProfileName agentUnavailableCode useSystemDefaultUnavailableSettings
forceAgentUnavailableOnDNDActivation forceAgentUnavailableOnPersonalCalls
forceAgentUnavailableOnBouncedCallLimit
numberConsecutiveBouncedCallsToForceAgentUnavailable
forceAgentUnavailableOnNotReachable makeOutgoingCallsAsCallCenter outgoingCallDNIS
useSystemDefaultWrapUpDestination wrapUpDestination
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| agent_acd_state | str | agentACDState Optional |
| agent_threshold_profile_name | str | agentThresholdProfileName Optional |
| agent_unavailable_code | str | agentUnavailableCode Optional |
| use_default_guard_timer | bool | useDefaultGuardTimer Optional |
| enable_guard_timer | bool | enableGuardTimer Optional |
| guard_timer_seconds | int | guardTimerSeconds Optional |
| use_system_default_unavailable_settings | bool | useSystemDefaultUnavailableSettings Optional |
| force_agent_unavailable_on_dnd_activation | bool | forceAgentUnavailableOnDNDActivation Optional |
| force_agent_unavailable_on_personal_calls | bool | forceAgentUnavailableOnPersonalCalls Optional |
| force_agent_unavailable_on_bounced_call_limit | bool | forceAgentUnavailableOnBouncedCallLimit Optional |
| number_consecutive_bounced_calls_to_force_agent_unavailable | int | numberConsecutiveBouncedCallsToForceAgentUnavailable Optional |
| force_agent_unavailable_on_not_reachable | bool | forceAgentUnavailableOnNotReachable Optional |
| make_outgoing_calls_as_call_center | bool | makeOutgoingCallsAsCallCenter Optional |
| outgoing_call_dnis | OCI.outgoingCallDNIS | outgoingCallDNIS Optional |
| call_center_agent_settings | List[OCI.callCenterAgentSettings] | callCenterAgentSettings Optional |
| use_system_default_wrap_up_destination | bool | useSystemDefaultWrapUpDestination Optional |
| wrap_up_destination | str | wrapUpDestination Optional |
UserCallCenterModifySupervisedAgentListRequest(OCIRequest)
Modifies a list of users to be supervised by a supervisor on a call center.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| supervisor_user_id | str | supervisorUserId |
| service_user_id | str | serviceUserId |
| agent_user_id_list | OCI.agentUserIdList | agentUserIdList Optional |
UserCallForwardingSelectiveAddCriteriaRequest(OCIRequest)
Add a criteria to the user's call forwarding selective service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| forward_to_number_selection | str | forwardToNumberSelection |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
UserCallForwardingSelectiveAddCriteriaRequest16(OCIRequest)
Add a criteria to the user's call forwarding selective service.
The following elements are only used in AS data mode: callToNumber For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| forward_to_number_selection | str | forwardToNumberSelection Optional |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
| call_to_number | List[OCI.callToNumber] | callToNumber Optional |
UserCallForwardingSelectiveModifyRequest(OCIRequest)
Modify the user's call forwarding selective service setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| default_forward_to_phone_number | str | defaultForwardToPhoneNumber Optional |
| play_ring_reminder | bool | playRingReminder Optional |
| criteria_activation | List[OCI.criteriaActivation] | criteriaActivation Optional |
UserCallMeNowAddCriteriaRequest(OCIRequest)
Add a criterion to the user's call me now service.
The criterion added is automatically active.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| reject_call | bool | rejectCall |
| to_dn_criteria | OCI.toDnCriteria | toDnCriteria |
UserCallMeNowModifyRequest(OCIRequest)
Modify the user's call me now service setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| answer_confirmation | str | answerConfirmation Optional |
| criteria_activation | List[OCI.criteriaActivation] | criteriaActivation Optional |
UserCallNotifyAddCriteriaRequest(OCIRequest)
Add a criteria to the user's call notify service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
UserCallNotifyAddCriteriaRequest16(OCIRequest)
Add a criteria to the user's call notify service.
The following elements are only used in AS data mode: callToNumber For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
| call_to_number | List[OCI.callToNumber] | callToNumber Optional |
UserCallNotifyModifyRequest(OCIRequest)
Modify the user's call notify service setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| call_notify_email_address | str | callNotifyEmailAddress Optional |
| criteria_activation | List[OCI.criteriaActivation] | criteriaActivation Optional |
UserCallingNameRetrievalModifyRequest(OCIRequest)
Modify the user level data associated with Calling Name Retrieval.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| bypass_filtering | bool | bypassFiltering Optional |
| dn_white_list | OCI.dnWhiteList | dnWhiteList Optional |
UserCollaborateProjectRoomAddRequest(OCIRequest)
Request to add collaborate project room.
The response is either a UserCollaborateProjectRoomAddResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| room_name | str | roomName |
| attendee_notification | str | attendeeNotification |
| end_collaborate_room_session_on_owner_exit | bool | endCollaborateRoomSessionOnOwnerExit |
| owner_required | bool | ownerRequired |
| room_schedule | OCI.roomSchedule | roomSchedule |
UserCollaborateProjectRoomModifyRequest(OCIRequest)
Request to modify collaborate room settings for a project room.
The request fails when modifying collaborate room settings for instant rooms or My Room.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| room_id | str | roomId |
| room_name | str | roomName Optional |
| attendee_notification | str | attendeeNotification Optional |
| end_collaborate_room_session_on_owner_exit | bool | endCollaborateRoomSessionOnOwnerExit Optional |
| owner_required | bool | ownerRequired Optional |
| room_schedule | OCI.roomSchedule | roomSchedule Optional |
UserCollaborateRoomModifyRequest(OCIRequest)
Request to modify room settings for a specific Project Room or My Room.
Request to modify room settings for a specific Instant Room is responded with an
ErrorResponse(). The roomSchedule parameter is applicable for Project Room only. If
the roomSchedule parameter is specified in the request to modify My Room, the request
will be failed.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| room_id | str | roomId |
| room_name | str | roomName Optional |
| attendee_notification | str | attendeeNotification Optional |
| end_collaborate_room_session_on_owner_exit | bool | endCollaborateRoomSessionOnOwnerExit Optional |
| owner_required | bool | ownerRequired Optional |
| room_schedule | OCI.roomSchedule | roomSchedule Optional |
UserCommunicationBarringAuthorizationCodeAddListRequest(OCIRequest)
Add a list of Communication Barring Authorization codes to a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| code | List[OCI.code] | code |
UserCustomRingbackUserModifyActiveCriteriaListRequest(OCIRequest)
Modify the user's custom ringback service criteria's active setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_activation | List[OCI.criteriaActivation] | criteriaActivation Optional |
UserDirectRouteModifyRequest(OCIRequest)
Modify the direct route setting and the list of DTGs/Trunk Identities assigned to a user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| outgoing_dtg_policy | str | outgoingDTGPolicy Optional |
| outgoing_trunk_identity_policy | str | outgoingTrunkIdentityPolicy Optional |
| direct_route_identity_list | OCI.directRouteIdentityList | directRouteIdentityList Optional |
UserEnhancedCallLogsGetListRequest16(OCIRequest)
Request user's call logs.
If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. It is possible to restrict the number of rows returned using responsePagingControl.
The response is either a UserEnhancedCallLogsGetListResponse16() or an
ErrorResponse(). Replaced by UserEnhancedCallLogsGetListRequest17sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| call_log_type | str | callLogType Optional |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
UserExecutiveAddFilteringSelectiveCriteriaRequest(OCIRequest)
Add a filtering criteria to an executive user.
Both executive and the executive assistant can run this command. For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| filter | bool | filter |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
| call_to_number | List[OCI.callToNumber] | callToNumber Optional |
UserExecutiveAssistantModifyRequest(OCIRequest)
Modify the setting for executive assistant.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| enable_divert | bool | enableDivert Optional |
| divert_to_phone_number | str | divertToPhoneNumber Optional |
| opt_in_status | List[OCI.optInStatus] | optInStatus Optional |
UserExecutiveModifyAssistantRequest(OCIRequest)
Request to modify the assistant setting and the list of assistants assigned to an executive user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| allow_opt_in_out | bool | allowOptInOut Optional |
| assistant_user_id_list | OCI.assistantUserIdList | assistantUserIdList Optional |
UserExecutiveModifyFilteringRequest(OCIRequest)
Modify the filtering setting for an executive user.
Both executive and the executive assistant can run this command.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| enable_filtering | bool | enableFiltering Optional |
| filtering_mode | str | filteringMode Optional |
| simple_filter_type | str | simpleFilterType Optional |
| criteria_activation | List[OCI.criteriaActivation] | criteriaActivation Optional |
UserFaxMessagingModifyRequest(OCIRequest)
Modify the user level data associated with Fax Messaging.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| phone_number | str | phoneNumber Optional |
| extension | str | extension Optional |
| sip_alias_list | OCI.sipAliasList | sipAliasList Optional |
UserFeatureAccessCodeModifyListRequest(OCIRequest)
Enable or disable a list of feature access codes for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| feature_access_code | List[OCI.featureAccessCode] | featureAccessCode Optional |
UserHolidayScheduleAddRequest(OCIRequest)
Add a holiday schedule to a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| holiday_schedule_name | str | holidayScheduleName |
| holiday01 | OCI.holiday01 | holiday01 Optional |
| holiday02 | OCI.holiday02 | holiday02 Optional |
| holiday03 | OCI.holiday03 | holiday03 Optional |
| holiday04 | OCI.holiday04 | holiday04 Optional |
| holiday05 | OCI.holiday05 | holiday05 Optional |
| holiday06 | OCI.holiday06 | holiday06 Optional |
| holiday07 | OCI.holiday07 | holiday07 Optional |
| holiday08 | OCI.holiday08 | holiday08 Optional |
| holiday09 | OCI.holiday09 | holiday09 Optional |
| holiday10 | OCI.holiday10 | holiday10 Optional |
| holiday11 | OCI.holiday11 | holiday11 Optional |
| holiday12 | OCI.holiday12 | holiday12 Optional |
| holiday13 | OCI.holiday13 | holiday13 Optional |
| holiday14 | OCI.holiday14 | holiday14 Optional |
| holiday15 | OCI.holiday15 | holiday15 Optional |
| holiday16 | OCI.holiday16 | holiday16 Optional |
| holiday17 | OCI.holiday17 | holiday17 Optional |
| holiday18 | OCI.holiday18 | holiday18 Optional |
| holiday19 | OCI.holiday19 | holiday19 Optional |
| holiday20 | OCI.holiday20 | holiday20 Optional |
UserHolidayScheduleModifyRequest(OCIRequest)
Modify a holiday schedule for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| holiday_schedule_name | str | holidayScheduleName |
| new_holiday_schedule_name | str | newHolidayScheduleName Optional |
| holiday01 | OCI.holiday01 | holiday01 Optional |
| holiday02 | OCI.holiday02 | holiday02 Optional |
| holiday03 | OCI.holiday03 | holiday03 Optional |
| holiday04 | OCI.holiday04 | holiday04 Optional |
| holiday05 | OCI.holiday05 | holiday05 Optional |
| holiday06 | OCI.holiday06 | holiday06 Optional |
| holiday07 | OCI.holiday07 | holiday07 Optional |
| holiday08 | OCI.holiday08 | holiday08 Optional |
| holiday09 | OCI.holiday09 | holiday09 Optional |
| holiday10 | OCI.holiday10 | holiday10 Optional |
| holiday11 | OCI.holiday11 | holiday11 Optional |
| holiday12 | OCI.holiday12 | holiday12 Optional |
| holiday13 | OCI.holiday13 | holiday13 Optional |
| holiday14 | OCI.holiday14 | holiday14 Optional |
| holiday15 | OCI.holiday15 | holiday15 Optional |
| holiday16 | OCI.holiday16 | holiday16 Optional |
| holiday17 | OCI.holiday17 | holiday17 Optional |
| holiday18 | OCI.holiday18 | holiday18 Optional |
| holiday19 | OCI.holiday19 | holiday19 Optional |
| holiday20 | OCI.holiday20 | holiday20 Optional |
UserInterceptUserModifyRequest(OCIRequest)
Modify the user's intercept user service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: UserInterceptUserModifyRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| announcement_selection | str | announcementSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_file | OCI.videoFile | videoFile Optional |
| play_new_phone_number | bool | playNewPhoneNumber Optional |
| new_phone_number | str | newPhoneNumber Optional |
| transfer_on_zero_to_phone_number | bool | transferOnZeroToPhoneNumber Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
UserInterceptUserModifyRequest16(OCIRequest)
Modify the user's intercept user service settings.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
UserInterceptUserModifyResponse21sp1() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| announcement_selection | str | announcementSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_file | OCI.videoFile | videoFile Optional |
| play_new_phone_number | bool | playNewPhoneNumber Optional |
| new_phone_number | str | newPhoneNumber Optional |
| transfer_on_zero_to_phone_number | bool | transferOnZeroToPhoneNumber Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| reroute_outbound_calls | bool | rerouteOutboundCalls Optional |
| outbound_reroute_phone_number | str | outboundReroutePhoneNumber Optional |
| allow_outbound_local_calls | bool | allowOutboundLocalCalls Optional |
| inbound_call_mode | str | inboundCallMode Optional |
| alternate_blocking_announcement | bool | alternateBlockingAnnouncement Optional |
| route_to_voice_mail | bool | routeToVoiceMail Optional |
UserInterceptUserModifyRequest21sp1(OCIRequest)
Modify the user's intercept user service settings.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
exemptInboundMobilityCalls exemptOutboundMobilityCalls
disableParallelRingingToNetworkLocations
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| announcement_selection | str | announcementSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_file | OCI.videoFile | videoFile Optional |
| inbound_call_mode | str | inboundCallMode Optional |
| alternate_blocking_announcement | bool | alternateBlockingAnnouncement Optional |
| exempt_inbound_mobility_calls | bool | exemptInboundMobilityCalls Optional |
| disable_parallel_ringing_to_network_locations | bool | disableParallelRingingToNetworkLocations Optional |
| route_to_voice_mail | bool | routeToVoiceMail Optional |
| play_new_phone_number | bool | playNewPhoneNumber Optional |
| new_phone_number | str | newPhoneNumber Optional |
| transfer_on_zero_to_phone_number | bool | transferOnZeroToPhoneNumber Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| outbound_call_mode | str | outboundCallMode Optional |
| exempt_outbound_mobility_calls | bool | exemptOutboundMobilityCalls Optional |
| reroute_outbound_calls | bool | rerouteOutboundCalls Optional |
| outbound_reroute_phone_number | str | outboundReroutePhoneNumber Optional |
UserMaliciousCallTraceModifyRequest(OCIRequest)
Modify the user level data associated with Malicious Call Trace.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| trace_type_selection | str | traceTypeSelection Optional |
| trace_for_time_period | bool | traceForTimePeriod Optional |
| trace_time_period | OCI.traceTimePeriod | traceTimePeriod Optional |
UserMeetMeConferencingAddConferenceRequest(OCIRequest)
Add a Meet-Me conference.
The response is either UserMeetMeConferencingAddConferenceResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| bridge_id | str | bridgeId |
| title | str | title |
| estimated_participants | int | estimatedParticipants Optional |
| restrict_participants | bool | restrictParticipants Optional |
| max_participants | int | maxParticipants Optional |
| account_code | str | accountCode Optional |
| mute_all_attendees_on_entry | bool | muteAllAttendeesOnEntry |
| end_conference_on_moderator_exit | bool | endConferenceOnModeratorExit |
| moderator_required | bool | moderatorRequired |
| attendee_notification | str | attendeeNotification |
| conference_schedule | OCI.conferenceSchedule | conferenceSchedule |
UserMeetMeConferencingAddConferenceRequest19(OCIRequest)
Add a Meet-Me conference.
The response is either UserMeetMeConferencingAddConferenceResponse19() or
ErrorResponse(). The startTime element is adjusted to the first occurrence of the
recurrent schedule that comes at or after the startTime. The startTime, endTime and
recurrence information for a conferenceSchedule element will be adjusted to the user
Host time zone. Replaced by: UserMeetMeConferencingAddConferenceRequest23()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| bridge_id | str | bridgeId |
| title | str | title |
| estimated_participants | int | estimatedParticipants Optional |
| restrict_participants | bool | restrictParticipants Optional |
| max_participants | int | maxParticipants Optional |
| account_code | str | accountCode Optional |
| mute_all_attendees_on_entry | bool | muteAllAttendeesOnEntry |
| end_conference_on_moderator_exit | bool | endConferenceOnModeratorExit |
| moderator_required | bool | moderatorRequired |
| require_security_pin | bool | requireSecurityPin |
| allow_unique_identifier | bool | allowUniqueIdentifier |
| attendee_notification | str | attendeeNotification |
| conference_schedule | OCI.conferenceSchedule | conferenceSchedule |
UserMeetMeConferencingAddConferenceRequest23(OCIRequest)
Add a Meet-Me conference.
The response is either UserMeetMeConferencingAddConferenceResponse23() or
ErrorResponse(). The startTime element is adjusted to the first occurrence of the
recurrent schedule that comes at or after the startTime. The startTime, endTime and
recurrence information for a conferenceSchedule element will be adjusted to the user
Host time zone.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| bridge_id | str | bridgeId |
| title | str | title |
| estimated_participants | int | estimatedParticipants Optional |
| restrict_participants | bool | restrictParticipants Optional |
| max_participants | int | maxParticipants Optional |
| account_code | str | accountCode Optional |
| mute_all_attendees_on_entry | bool | muteAllAttendeesOnEntry |
| end_conference_on_moderator_exit | bool | endConferenceOnModeratorExit |
| moderator_required | bool | moderatorRequired |
| require_security_pin | bool | requireSecurityPin |
| allow_unique_identifier | bool | allowUniqueIdentifier |
| attendee_notification | str | attendeeNotification |
| conference_schedule | OCI.conferenceSchedule | conferenceSchedule |
| allow_participant_unmute_in_auto_lecture_mode | bool | allowParticipantUnmuteInAutoLectureMode |
UserMeetMeConferencingDeleteConferenceListRequest(OCIRequest)
Request to delete one or more conferences which are owned by the user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| conference_key | List[OCI.conferenceKey] | conferenceKey |
UserMeetMeConferencingDeleteConferenceRecordingListRequest(OCIRequest)
Request to delete one or more conference recordings owned by the user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| recording_key | List[OCI.recordingKey] | recordingKey |
UserMeetMeConferencingGetConferenceDelegateListRequest(OCIRequest)
Get the conference delegates for this conference.
The response is either UserMeetMeConferencingGetConferenceDelegateListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| conference_key | OCI.conferenceKey | conferenceKey |
UserMeetMeConferencingGetConferenceGreetingRequest(OCIRequest)
Get the information of a conference custom greeting.
The response is either UserMeetMeConferencingGetConferenceGreetingResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| conference_key | OCI.conferenceKey | conferenceKey |
UserMeetMeConferencingGetConferenceGreetingRequest20(OCIRequest)
Get the information of a conference custom greeting.
The response is either UserMeetMeConferencingGetConferenceGreetingResponse20() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| conference_key | OCI.conferenceKey | conferenceKey |
UserMeetMeConferencingGetConferenceRequest(OCIRequest)
Get the information of a conference owned by the user.
The response is either UserMeetMeConferencingGetConferenceResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| conference_key | OCI.conferenceKey | conferenceKey |
UserMeetMeConferencingGetConferenceRequest19(OCIRequest)
Get the information of a conference owned by the user.
The response is either UserMeetMeConferencingGetConferenceResponse19() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| conference_key | OCI.conferenceKey | conferenceKey |
UserMeetMeConferencingGetConferenceRequest20(OCIRequest)
Get the information of a conference owned by the user.
The response is either UserMeetMeConferencingGetConferenceResponse20() or
ErrorResponse(). Replaced by: UserMeetMeConferencingGetConferenceRequest23()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| conference_key | OCI.conferenceKey | conferenceKey |
UserMeetMeConferencingGetConferenceRequest23(OCIRequest)
Get the information of a conference owned by the user.
The response is either UserMeetMeConferencingGetConferenceResponse23() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| conference_key | OCI.conferenceKey | conferenceKey |
UserMeetMeConferencingModifyConferenceDelegateListRequest(OCIRequest)
Modify the existing conference delegates list.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| conference_key | OCI.conferenceKey | conferenceKey |
| conference_delegate_user_list | OCI.conferenceDelegateUserList | conferenceDelegateUserList Optional |
UserMeetMeConferencingModifyConferenceGreetingExecutionServerRequest(OCIRequest)
Modify an existing custom greeting audio file.
The response is either SuccessResponse() or ErrorResponse(). Engineering Note:
This command can only be executed from the Execution Server
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| conference_key | OCI.conferenceKey | conferenceKey |
| play_entrance_greeting | bool | playEntranceGreeting Optional |
| entrance_greeting_file | OCI.entranceGreetingFile | entranceGreetingFile Optional |
UserMeetMeConferencingModifyConferenceGreetingRequest(OCIRequest)
Modify an existing custom greeting audio file.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| conference_key | OCI.conferenceKey | conferenceKey |
| play_entrance_greeting | bool | playEntranceGreeting Optional |
| entrance_greeting_file | OCI.entranceGreetingFile | entranceGreetingFile Optional |
UserMeetMeConferencingModifyConferenceGreetingRequest20(OCIRequest)
Modify an existing custom greeting audio file.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| conference_key | OCI.conferenceKey | conferenceKey |
| play_entrance_greeting | bool | playEntranceGreeting Optional |
| entrance_greeting_file | OCI.entranceGreetingFile | entranceGreetingFile Optional |
UserMeetMeConferencingModifyConferenceRequest(OCIRequest)
Modify an existing conference.
The response is either SuccessResponse() or ErrorResponse(). The startTime element
is adjusted to the first occurrence of the recurrent schedule that comes at or after
the startTime. The startTime, endTime and recurrence information for a
conferenceSchedule element will be adjusted to the user Host time zone.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| conference_key | OCI.conferenceKey | conferenceKey |
| title | str | title Optional |
| estimated_participants | int | estimatedParticipants Optional |
| restrict_participants | bool | restrictParticipants Optional |
| max_participants | int | maxParticipants Optional |
| account_code | str | accountCode Optional |
| mute_all_attendees_on_entry | bool | muteAllAttendeesOnEntry Optional |
| end_conference_on_moderator_exit | bool | endConferenceOnModeratorExit Optional |
| moderator_required | bool | moderatorRequired Optional |
| require_security_pin | bool | requireSecurityPin Optional |
| allow_unique_identifier | bool | allowUniqueIdentifier Optional |
| attendee_notification | str | attendeeNotification Optional |
| conference_schedule | OCI.conferenceSchedule | conferenceSchedule Optional |
| allow_participant_unmute_in_auto_lecture_mode | bool | allowParticipantUnmuteInAutoLectureMode Optional |
UserModifyRequest14(OCIRequest)
Request to modify a user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| last_name | str | lastName Optional |
| first_name | str | firstName Optional |
| calling_line_id_last_name | str | callingLineIdLastName Optional |
| calling_line_id_first_name | str | callingLineIdFirstName Optional |
| hiragana_last_name | str | hiraganaLastName Optional |
| hiragana_first_name | str | hiraganaFirstName Optional |
| phone_number | str | phoneNumber Optional |
| extension | str | extension Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| old_password | str | oldPassword Optional |
| new_password | str | newPassword Optional |
| department | OCI.department | department Optional |
| language | str | language Optional |
| time_zone | str | timeZone Optional |
| sip_alias_list | OCI.sipAliasList | sipAliasList Optional |
| endpoint | OCI.endpoint | endpoint Optional |
| title | str | title Optional |
| pager_phone_number | str | pagerPhoneNumber Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| email_address | str | emailAddress Optional |
| yahoo_id | str | yahooId Optional |
| address_location | str | addressLocation Optional |
| address | OCI.address | address Optional |
UserModifyRequest14sp9(OCIRequest)
Request to modify a user.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
UserModifyRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| last_name | str | lastName Optional |
| first_name | str | firstName Optional |
| calling_line_id_last_name | str | callingLineIdLastName Optional |
| calling_line_id_first_name | str | callingLineIdFirstName Optional |
| hiragana_last_name | str | hiraganaLastName Optional |
| hiragana_first_name | str | hiraganaFirstName Optional |
| phone_number | str | phoneNumber Optional |
| extension | str | extension Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| old_password | str | oldPassword Optional |
| new_password | str | newPassword Optional |
| department | OCI.department | department Optional |
| language | str | language Optional |
| time_zone | str | timeZone Optional |
| sip_alias_list | OCI.sipAliasList | sipAliasList Optional |
| endpoint | OCI.endpoint | endpoint Optional |
| title | str | title Optional |
| pager_phone_number | str | pagerPhoneNumber Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| email_address | str | emailAddress Optional |
| yahoo_id | str | yahooId Optional |
| address_location | str | addressLocation Optional |
| address | OCI.address | address Optional |
| network_class_of_service | str | networkClassOfService Optional |
UserModifyRequest16(OCIRequest)
Replaced By UserModifyRequest17sp4() Request to modify a user.
When oldPassword is specified, all password rule applies. If oldPassword in not specified, any password rule related to old password does not apply. The request will fail if officeZoneName or primaryZoneName is present but the Location-Based Calling Restrictions service is not assigned to the user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| last_name | str | lastName Optional |
| first_name | str | firstName Optional |
| calling_line_id_last_name | str | callingLineIdLastName Optional |
| calling_line_id_first_name | str | callingLineIdFirstName Optional |
| hiragana_last_name | str | hiraganaLastName Optional |
| hiragana_first_name | str | hiraganaFirstName Optional |
| phone_number | str | phoneNumber Optional |
| extension | str | extension Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| old_password | str | oldPassword Optional |
| new_password | str | newPassword Optional |
| department | OCI.department | department Optional |
| language | str | language Optional |
| time_zone | str | timeZone Optional |
| sip_alias_list | OCI.sipAliasList | sipAliasList Optional |
| endpoint | OCI.endpoint | endpoint Optional |
| title | str | title Optional |
| pager_phone_number | str | pagerPhoneNumber Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| email_address | str | emailAddress Optional |
| yahoo_id | str | yahooId Optional |
| address_location | str | addressLocation Optional |
| address | OCI.address | address Optional |
| network_class_of_service | str | networkClassOfService Optional |
| office_zone_name | str | officeZoneName Optional |
| primary_zone_name | str | primaryZoneName Optional |
UserMusicOnHoldUserModifyRequest(OCIRequest)
Modify data for Music On Hold User.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: UserMusicOnHoldUserModifyRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| source | OCI.source | source Optional |
| use_alternate_source_for_internal_calls | bool | useAlternateSourceForInternalCalls Optional |
| internal_source | OCI.internalSource | internalSource Optional |
UserMusicOnHoldUserModifyRequest16(OCIRequest)
Modify data for Music On Hold User.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
UserMusicOnHoldUserModifyRequest20() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| source | OCI.source | source Optional |
| use_alternate_source_for_internal_calls | bool | useAlternateSourceForInternalCalls Optional |
| internal_source | OCI.internalSource | internalSource Optional |
UserMusicOnHoldUserModifyRequest20(OCIRequest)
Modify data for Music On Hold User.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| source | OCI.source | source Optional |
| use_alternate_source_for_internal_calls | bool | useAlternateSourceForInternalCalls Optional |
| internal_source | OCI.internalSource | internalSource Optional |
UserOCICallControlApplicationModifyRequest(OCIRequest)
Modify which OCI Call Control Applications are enabled on a user The response is
either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| application_id_list | OCI.applicationIdList | applicationIdList Optional |
UserOutgoingCallingPlanAuthorizationCodeAddListRequest(OCIRequest)
Add a list of authorization codes to a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| code_entry | List[OCI.codeEntry] | codeEntry |
UserOutgoingCallingPlanCallMeNowModifyRequest(OCIRequest)
Modify the Call Me Now call permissions for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_custom_settings | bool | useCustomSettings Optional |
| user_permissions | OCI.userPermissions | userPermissions Optional |
UserOutgoingCallingPlanOriginatingModifyRequest(OCIRequest)
Modify the originating permissions for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_custom_settings | bool | useCustomSettings Optional |
| user_permissions | OCI.userPermissions | userPermissions Optional |
UserOutgoingCallingPlanRedirectedModifyRequest(OCIRequest)
Modify the call forwarded/transferred permissions for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_custom_settings | bool | useCustomSettings Optional |
| user_permissions | OCI.userPermissions | userPermissions Optional |
UserOutgoingCallingPlanRedirectingModifyRequest(OCIRequest)
Modify the initiating call forwards/transfer permissions for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_custom_settings | bool | useCustomSettings Optional |
| user_permissions | OCI.userPermissions | userPermissions Optional |
UserOutgoingCallingPlanTransferNumbersModifyRequest(OCIRequest)
Modify the transfer numbers for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_custom_settings | bool | useCustomSettings Optional |
| user_numbers | OCI.userNumbers | userNumbers Optional |
UserPersonalAssistantAddCriteriaRequest(OCIRequest)
Adds a User Personal Assistant Schedule Selective Criteria Entry.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements will take the defined default value if they are not set:
enableTransferToAttendant will be set to false. enableRingSplash will be set to
false. alertMeFirst will be set to false. alertMeFirstNumberOfRings will be set to
the user Personal Assistant Number of rings setting.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| presence | str | presence Optional |
| enable_transfer_to_attendant | bool | enableTransferToAttendant Optional |
| attendant_number | str | attendantNumber Optional |
| enable_ring_splash | bool | enableRingSplash Optional |
| alert_me_first | bool | alertMeFirst Optional |
| alert_me_first_number_of_rings | int | alertMeFirstNumberOfRings Optional |
UserPersonalAssistantModifyCriteriaRequest(OCIRequest)
Modifies a User Personal Assistant Schedule Selective Criteria Entry.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| presence | str | presence Optional |
| enable_transfer_to_attendant | bool | enableTransferToAttendant Optional |
| attendant_number | str | attendantNumber Optional |
| enable_ring_splash | bool | enableRingSplash Optional |
| alert_me_first | bool | alertMeFirst Optional |
| alert_me_first_number_of_rings | int | alertMeFirstNumberOfRings Optional |
UserPersonalAssistantModifyRequest(OCIRequest)
Modify the User Personal Assistant information.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| presence | str | presence Optional |
| enable_transfer_to_attendant | bool | enableTransferToAttendant Optional |
| attendant_number | str | attendantNumber Optional |
| enable_ring_splash | bool | enableRingSplash Optional |
| enable_expiration_time | bool | enableExpirationTime Optional |
| expiration_time | str | expirationTime Optional |
| alert_me_first | bool | alertMeFirst Optional |
| alert_me_first_number_of_rings | int | alertMeFirstNumberOfRings Optional |
| criteria_activation | List[OCI.criteriaActivation] | criteriaActivation Optional |
UserPersonalAssistantReorderCriteriaRequest(OCIRequest)
Reorders only the Schedule Selective Criteria entries.
Criteria entries received in the orderedCriteriaList element are set at the top of the ordered criteria list. Existing criteria not received in orderedCriteriaList are moved down to a lower priority.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| ordered_criteria_list | OCI.orderedCriteriaList | orderedCriteriaList |
UserPersonalPhoneListAddListRequest(OCIRequest)
Add one or more entries to a user's personal phone list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| entry | List[OCI.entry] | entry |
UserPolycomPhoneServicesGetRequest(OCIRequest)
Request the user's Polycom Phone Services attributes.
The response is either a UserPolycomPhoneServicesGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| access_device | OCI.accessDevice | accessDevice |
UserPolycomPhoneServicesModifyRequest(OCIRequest)
Modify the user's Polycom Phone Services attributes.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| access_device | OCI.accessDevice | accessDevice |
| integrate_phone_directory_with_broad_works | bool | integratePhoneDirectoryWithBroadWorks Optional |
| include_user_personal_phone_list_in_directory | bool | includeUserPersonalPhoneListInDirectory Optional |
| include_group_custom_contact_directory_in_directory | bool | includeGroupCustomContactDirectoryInDirectory Optional |
| group_custom_contact_directory | str | groupCustomContactDirectory Optional |
UserPreAlertingAnnouncementAddCriteriaRequest(OCIRequest)
Add a criteria to the user's pre-alerting service.
The following elements are only used in AS data mode: callToNumber For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
| call_to_number | List[OCI.callToNumber] | callToNumber Optional |
UserPreferredCarrierUserModifyRequest(OCIRequest)
Modifies the currently configured preferred carriers for a user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| intra_lata_carrier | OCI.intraLataCarrier | intraLataCarrier Optional |
| inter_lata_carrier | OCI.interLataCarrier | interLataCarrier Optional |
| international_carrier | OCI.internationalCarrier | internationalCarrier Optional |
UserPriorityAlertAddCriteriaRequest(OCIRequest)
Add a criteria to the user's priority alert service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
UserPriorityAlertAddCriteriaRequest16(OCIRequest)
Add a criteria to the user's priority alert service.
The following elements are only used in AS data mode: callToNumber For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
| call_to_number | List[OCI.callToNumber] | callToNumber Optional |
UserPriorityAlertModifyActiveCriteriaListRequest(OCIRequest)
Activate the user's priority alert criteria list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_activation | List[OCI.criteriaActivation] | criteriaActivation Optional |
UserPrivacyModifyRequest(OCIRequest)
Modify the user level data associated with Privacy.
This command is supported for regular users only.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| enable_directory_privacy | bool | enableDirectoryPrivacy Optional |
| enable_auto_attendant_extension_dialing_privacy | bool | enableAutoAttendantExtensionDialingPrivacy Optional |
| enable_auto_attendant_name_dialing_privacy | bool | enableAutoAttendantNameDialingPrivacy Optional |
| enable_phone_status_privacy | bool | enablePhoneStatusPrivacy Optional |
| permitted_monitor_user_id_list | OCI.permittedMonitorUserIdList | permittedMonitorUserIdList Optional |
UserPushToTalkModifyRequest(OCIRequest)
Change the push to talk service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| allow_auto_answer | bool | allowAutoAnswer Optional |
| outgoing_connection_selection | str | outgoingConnectionSelection Optional |
| access_list_selection | str | accessListSelection Optional |
| selected_user_id_list | OCI.selectedUserIdList | selectedUserIdList Optional |
UserRouteListModifyRequest(OCIRequest)
Modify the route list setting and the list of number ranges and number prefixes assigned to a user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| treat_originations_and_pbx_redirections_as_screened | bool | treatOriginationsAndPBXRedirectionsAsScreened Optional |
| use_route_list_identity_for_non_emergency_calls | bool | useRouteListIdentityForNonEmergencyCalls Optional |
| use_route_list_identity_for_emergency_calls | bool | useRouteListIdentityForEmergencyCalls Optional |
| ignore_calling_name_for_call_processing | bool | ignoreCallingNameForCallProcessing Optional |
| assigned_number_range_start_list | OCI.assignedNumberRangeStartList | assignedNumberRangeStartList Optional |
| assigned_number_prefix_list | OCI.assignedNumberPrefixList | assignedNumberPrefixList Optional |
UserRoutePointSupervisorModifyListRequest(OCIRequest)
Request to modify the Route Point supervisor list for a user.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| supervisor_user_id_list | OCI.supervisorUserIdList | supervisorUserIdList Optional |
UserScheduleAddEventRequest(OCIRequest)
Add an event to user schedule.
The response is either a SuccessResponse() or an ErrorResponse(). The startDate
element is adjusted to the first occurrence of the recurrent schedule that comes at or
after the startDate. The endDate element is set to the sum of the adjusted starDate
element value and the event duration.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| schedule_key | OCI.scheduleKey | scheduleKey |
| event_name | str | eventName |
| start_date | str | startDate |
| all_day_event | bool | allDayEvent Optional |
| start_time | OCI.startTime | startTime Optional |
| end_time | OCI.endTime | endTime Optional |
| end_date | str | endDate |
| recurrence | OCI.recurrence | recurrence Optional |
UserScheduleDeleteEventListRequest(OCIRequest)
Delete a list of events from a user schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| schedule_key | OCI.scheduleKey | scheduleKey |
| event_name | List[str] | eventName |
UserScheduleDeleteListRequest(OCIRequest)
Delete a list of user schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| schedule_key | List[OCI.scheduleKey] | scheduleKey |
UserScheduleGetEventListRequest(OCIRequest)
Get the list of events of a user schedule.
The response is either a UserScheduleGetEventListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| schedule_key | OCI.scheduleKey | scheduleKey |
UserScheduleGetEventRequest(OCIRequest)
Get an event from a user schedule.
The response is either a UserScheduleGetEventResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| schedule_key | OCI.scheduleKey | scheduleKey |
| event_name | str | eventName |
UserScheduleModifyEventRequest(OCIRequest)
Modify an event of a user schedule.
The response is either a SuccessResponse() or an ErrorResponse(). The startDate
element is adjusted to the first occurrence of the recurrent schedule that comes at or
after the startDate. The endDate element is set to the sum of the adjusted starDate
element value and the event duration.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| schedule_key | OCI.scheduleKey | scheduleKey |
| event_name | str | eventName |
| new_event_name | str | newEventName Optional |
| start_date | str | startDate Optional |
| all_day_event | bool | allDayEvent Optional |
| start_time | OCI.startTime | startTime Optional |
| end_time | OCI.endTime | endTime Optional |
| end_date | str | endDate Optional |
| recurrence | OCI.recurrence | recurrence Optional |
UserScheduleModifyRequest(OCIRequest)
Modify a user schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| schedule_key | OCI.scheduleKey | scheduleKey |
| new_schedule_name | str | newScheduleName Optional |
UserSelectiveCallAcceptanceAddCriteriaRequest(OCIRequest)
Add a criteria to the user's selective call acceptance service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
UserSelectiveCallAcceptanceAddCriteriaRequest16(OCIRequest)
Add a criteria to the user's selective call acceptance service.
The following elements are only used in AS data mode: callToNumber For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
| call_to_number | List[OCI.callToNumber] | callToNumber Optional |
UserSelectiveCallAcceptanceModifyActiveCriteriaListRequest(OCIRequest)
Activate the user's selective call acceptance criteria list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_activation | List[OCI.criteriaActivation] | criteriaActivation Optional |
UserSelectiveCallRejectionAddCriteriaRequest(OCIRequest)
Add a criteria to the user's selective call rejection service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
UserSelectiveCallRejectionAddCriteriaRequest16(OCIRequest)
Add a criteria to the user's selective call rejection service.
The following elements are only used in AS data mode: callToNumber For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted |
| call_to_number | List[OCI.callToNumber] | callToNumber Optional |
UserSelectiveCallRejectionModifyActiveCriteriaListRequest(OCIRequest)
Activate the user's selective call rejection criteria list.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_activation | List[OCI.criteriaActivation] | criteriaActivation Optional |
UserSequentialRingAddCriteriaRequest(OCIRequest)
Add a criteria to the user's sequential ring service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
UserSequentialRingAddCriteriaRequest16(OCIRequest)
Add a criteria to the user's sequential ring service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
UserSequentialRingAddCriteriaRequest23(OCIRequest)
Add a criteria to the user's sequential ring service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted |
| from_dn_criteria23 | OCI.fromDnCriteria23 | fromDnCriteria23 |
UserSequentialRingModifyRequest(OCIRequest)
Modify the user's sequential ring service setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| ring_base_location_first | bool | ringBaseLocationFirst Optional |
| base_location_number_of_rings | int | baseLocationNumberOfRings Optional |
| continue_if_base_location_is_busy | bool | continueIfBaseLocationIsBusy Optional |
| caller_may_stop_search | bool | callerMayStopSearch Optional |
| location01 | OCI.Location01 | Location01 Optional |
| location02 | OCI.Location02 | Location02 Optional |
| location03 | OCI.Location03 | Location03 Optional |
| location04 | OCI.Location04 | Location04 Optional |
| location05 | OCI.Location05 | Location05 Optional |
| criteria_activation | List[OCI.criteriaActivation] | criteriaActivation Optional |
UserShInterfaceGetPublicIdDataRequest(OCIRequest)
Returns the Sh non-transparent data stored against a Public User Identity (a SIP URI or TEL URI).
The response is either a UserShInterfaceGetPublicIdDataResponse() or an
ErrorResponse(). Replaced by: UserShInterfaceGetPublicIdDataRequest21sp1().
Attributes:
| Name | Type | Description |
|---|---|---|
| public_user_identity | OCI.publicUserIdentity | publicUserIdentity |
UserShInterfaceGetPublicIdDataRequest21sp1(OCIRequest)
Returns the Sh non-transparent data stored against a Public User Identity (a SIP URI or TEL URI).
The response is either a UserShInterfaceGetPublicIdDataResponse21sp1() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| public_user_identity | OCI.publicUserIdentity | publicUserIdentity |
UserShInterfaceModifyRequest(OCIRequest)
Modifies the Sh Interface non-transparent data associated with a Public User Identity.
The response is a SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| public_user_identity | OCI.publicUserIdentity | publicUserIdentity |
| scscf_name | str | SCSCFName Optional |
| ims_user_state | str | IMSUserState Optional |
UserShInterfacePublicIdentityRefreshTaskStartRequest(OCIRequest)
Dispatches a Public Identity refresh task on the local Application Server node for the specified public identity.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| public_user_identity | OCI.publicUserIdentity | publicUserIdentity |
UserSimultaneousRingFamilyAddCriteriaRequest(OCIRequest)
Add a criteria to the user's simultaneous ring family service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
UserSimultaneousRingFamilyModifyRequest(OCIRequest)
Modify the user's simultaneous ring family service setting.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: UserSimultaneousRingFamilyModifyRequest14sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| incoming_calls | str | incomingCalls Optional |
| sim_ring_phone_number_list | OCI.simRingPhoneNumberList | simRingPhoneNumberList Optional |
UserSimultaneousRingPersonalAddCriteriaRequest(OCIRequest)
Add a criteria to the user's simultaneous ring personal service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
UserSimultaneousRingPersonalModifyRequest(OCIRequest)
Modify the user's simultaneous ring personal service setting.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: UserSimultaneousRingPersonalModifyRequest14sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| incoming_calls | str | incomingCalls Optional |
| sim_ring_phone_number_list | OCI.simRingPhoneNumberList | simRingPhoneNumberList Optional |
UserSpeedDial100AddListRequest(OCIRequest)
Add one or more speed dial 100 settings for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| speed_dial_entry | List[OCI.speedDialEntry] | speedDialEntry |
UserSpeedDial100ModifyListRequest(OCIRequest)
Modify the speed dial 100 settings for a user.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command is used internally by Call Processing.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| speed_dial_entry | List[OCI.speedDialEntry] | speedDialEntry Optional |
UserSpeedDial8ModifyListRequest(OCIRequest)
Modify the speed dial 8 settings for a user.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command is used internally by Call Processing.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| speed_dial_entry | List[OCI.speedDialEntry] | speedDialEntry Optional |
UserTimeScheduleAddRequest(OCIRequest)
Add a time schedule for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| time_schedule_name | str | timeScheduleName |
| time_interval01 | OCI.timeInterval01 | timeInterval01 Optional |
| time_interval02 | OCI.timeInterval02 | timeInterval02 Optional |
| time_interval03 | OCI.timeInterval03 | timeInterval03 Optional |
| time_interval04 | OCI.timeInterval04 | timeInterval04 Optional |
| time_interval05 | OCI.timeInterval05 | timeInterval05 Optional |
| time_interval06 | OCI.timeInterval06 | timeInterval06 Optional |
| time_interval07 | OCI.timeInterval07 | timeInterval07 Optional |
| time_interval08 | OCI.timeInterval08 | timeInterval08 Optional |
| time_interval09 | OCI.timeInterval09 | timeInterval09 Optional |
| time_interval10 | OCI.timeInterval10 | timeInterval10 Optional |
| time_interval11 | OCI.timeInterval11 | timeInterval11 Optional |
| time_interval12 | OCI.timeInterval12 | timeInterval12 Optional |
| time_interval13 | OCI.timeInterval13 | timeInterval13 Optional |
| time_interval14 | OCI.timeInterval14 | timeInterval14 Optional |
| time_interval15 | OCI.timeInterval15 | timeInterval15 Optional |
| time_interval16 | OCI.timeInterval16 | timeInterval16 Optional |
| time_interval17 | OCI.timeInterval17 | timeInterval17 Optional |
| time_interval18 | OCI.timeInterval18 | timeInterval18 Optional |
| time_interval19 | OCI.timeInterval19 | timeInterval19 Optional |
| time_interval20 | OCI.timeInterval20 | timeInterval20 Optional |
UserTimeScheduleModifyRequest(OCIRequest)
Modify a user time schedule.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| time_schedule_name | str | timeScheduleName |
| new_time_schedule_name | str | newTimeScheduleName Optional |
| time_interval01 | OCI.timeInterval01 | timeInterval01 Optional |
| time_interval02 | OCI.timeInterval02 | timeInterval02 Optional |
| time_interval03 | OCI.timeInterval03 | timeInterval03 Optional |
| time_interval04 | OCI.timeInterval04 | timeInterval04 Optional |
| time_interval05 | OCI.timeInterval05 | timeInterval05 Optional |
| time_interval06 | OCI.timeInterval06 | timeInterval06 Optional |
| time_interval07 | OCI.timeInterval07 | timeInterval07 Optional |
| time_interval08 | OCI.timeInterval08 | timeInterval08 Optional |
| time_interval09 | OCI.timeInterval09 | timeInterval09 Optional |
| time_interval10 | OCI.timeInterval10 | timeInterval10 Optional |
| time_interval11 | OCI.timeInterval11 | timeInterval11 Optional |
| time_interval12 | OCI.timeInterval12 | timeInterval12 Optional |
| time_interval13 | OCI.timeInterval13 | timeInterval13 Optional |
| time_interval14 | OCI.timeInterval14 | timeInterval14 Optional |
| time_interval15 | OCI.timeInterval15 | timeInterval15 Optional |
| time_interval16 | OCI.timeInterval16 | timeInterval16 Optional |
| time_interval17 | OCI.timeInterval17 | timeInterval17 Optional |
| time_interval18 | OCI.timeInterval18 | timeInterval18 Optional |
| time_interval19 | OCI.timeInterval19 | timeInterval19 Optional |
| time_interval20 | OCI.timeInterval20 | timeInterval20 Optional |
UserVoiceMessagingUserModifyDistributionListRequest(OCIRequest)
Modify a voice mail distribution list for a users voice message.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| list_id | int | listId |
| description | str | description Optional |
| phone_number_list | OCI.phoneNumberList | phoneNumberList Optional |
UserVoiceMessagingUserModifyGreetingExecutionServerRequest(OCIRequest)
Modify the user's voice messaging greeting.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command can only be executed from the Execution Server
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| busy_announcement_selection | str | busyAnnouncementSelection Optional |
| busy_personal_audio_file | OCI.busyPersonalAudioFile | busyPersonalAudioFile Optional |
| busy_personal_video_file | OCI.busyPersonalVideoFile | busyPersonalVideoFile Optional |
| no_answer_announcement_selection | str | noAnswerAnnouncementSelection Optional |
| no_answer_personal_audio_file | OCI.noAnswerPersonalAudioFile | noAnswerPersonalAudioFile Optional |
| no_answer_personal_video_file | OCI.noAnswerPersonalVideoFile | noAnswerPersonalVideoFile Optional |
| no_answer_number_of_rings | int | noAnswerNumberOfRings Optional |
| extended_away_enabled | bool | extendedAwayEnabled Optional |
| extended_away_disable_message_deposit | bool | extendedAwayDisableMessageDeposit Optional |
| extended_away_audio_file | OCI.extendedAwayAudioFile | extendedAwayAudioFile Optional |
| extended_away_video_file | OCI.extendedAwayVideoFile | extendedAwayVideoFile Optional |
| disable_message_deposit | bool | disableMessageDeposit Optional |
| disable_message_deposit_action | str | disableMessageDepositAction Optional |
| greeting_only_forward_destination | str | greetingOnlyForwardDestination Optional |
UserVoiceMessagingUserModifyOutgoingSMDIMWIRequest(OCIRequest)
Modify the user's voice messaging outgoing message waiting indicator service setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| outgoing_smdimwi_phone_number_list | OCI.outgoingSMDIMWIPhoneNumberList | outgoingSMDIMWIPhoneNumberList Optional |
UserVoiceMessagingUserModifyVoiceManagementRequest23(OCIRequest)
Modify the user's voice messaging voice management service setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| processing | str | processing Optional |
| voice_message_delivery_email_address | OCI.voiceMessageDeliveryEmailAddress | voiceMessageDeliveryEmailAddress Optional |
| use_phone_message_waiting_indicator | bool | usePhoneMessageWaitingIndicator Optional |
| send_voice_message_notify_email | bool | sendVoiceMessageNotifyEmail Optional |
| voice_message_notify_email_address | str | voiceMessageNotifyEmailAddress Optional |
| send_carbon_copy_voice_message | bool | sendCarbonCopyVoiceMessage Optional |
| voice_message_carbon_copy_email_address | str | voiceMessageCarbonCopyEmailAddress Optional |
| transfer_on_zero_to_phone_number | bool | transferOnZeroToPhoneNumber Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| always_redirect_to_voice_mail | bool | alwaysRedirectToVoiceMail Optional |
| busy_redirect_to_voice_mail | bool | busyRedirectToVoiceMail Optional |
| no_answer_redirect_to_voice_mail | bool | noAnswerRedirectToVoiceMail Optional |
| out_of_primary_zone_redirect_to_voice_mail | bool | outOfPrimaryZoneRedirectToVoiceMail Optional |
UserVoiceMessagingUserModifyVoicePortalExecutionServerRequest(OCIRequest)
Modify the user's voice messaging voice portal settings.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command can only be executed from the Execution Server
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_personalized_name | bool | usePersonalizedName Optional |
| personalized_name_audio_file | OCI.personalizedNameAudioFile | personalizedNameAudioFile Optional |
UserVoiceMessagingUserModifyVoicePortalRequest(OCIRequest)
Modify the user's voice messaging voice portal settings.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command is used internally by Call Processing.
Replaced By: UserVoiceMessagingUserModifyVoicePortalRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_personalized_name | bool | usePersonalizedName Optional |
| voice_portal_auto_login | bool | voicePortalAutoLogin Optional |
| personalized_name_audio_file | OCI.personalizedNameAudioFile | personalizedNameAudioFile Optional |
UserVoiceMessagingUserModifyVoicePortalRequest16(OCIRequest)
Modify the user's voice messaging voice portal settings.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command is used internally by Call Processing.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_personalized_name | bool | usePersonalizedName Optional |
| voice_portal_auto_login | bool | voicePortalAutoLogin Optional |
| personalized_name_audio_file | OCI.personalizedNameAudioFile | personalizedNameAudioFile Optional |
UserVoiceMessagingUserModifyVoicePortalRequest20(OCIRequest)
Modify the user's voice messaging voice portal settings.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command is used internally by Call Processing.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_personalized_name | bool | usePersonalizedName Optional |
| voice_portal_auto_login | bool | voicePortalAutoLogin Optional |
| personalized_name_audio_file | OCI.personalizedNameAudioFile | personalizedNameAudioFile Optional |
UserXsiPolicyProfileModifyRequest(OCIRequest)
Modifies the default Xsi policy profile for a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| xsi_policy_profile | OCI.xsiPolicyProfile | xsiPolicyProfile Optional |
EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentListRequest(OCIRequest)
Request a summary table of all Mobile Subscriber Directory Numbers in an enterprise.
The response is either
EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentListResponse()
or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_mobile_subscriber_directory_number | List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] | searchCriteriaMobileSubscriberDirectoryNumber Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_mobile_network | OCI.searchCriteriaExactMobileNetwork | searchCriteriaExactMobileNetwork Optional |
EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest(OCIRequest)
Request a list of available Mobile Subscriber Directory Numbers not yet assigned to any user.
If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. If no sortOrder is included the response is sorted by Mobile Number ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.
The response is either
EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListResponse()
or ErrorResponse(). Replaced by:
EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_by_mobile_directory_number | OCI.sortByMobileDirectoryNumber | sortByMobileDirectoryNumber Optional |
| search_criteria_mobile_subscriber_directory_number | List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] | searchCriteriaMobileSubscriberDirectoryNumber Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest22(OCIRequest)
Request a list of available Mobile Subscriber Directory Numbers not yet assigned to any user.
If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. If no sortOrder is included the response is sorted by Mobile Number ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.
The response is either
EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListResponse22()
or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| include_total_number_of_rows | bool | includeTotalNumberOfRows Optional |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_by_mobile_directory_number | OCI.sortByMobileDirectoryNumber | sortByMobileDirectoryNumber Optional |
| search_criteria_mobile_subscriber_directory_number | List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] | searchCriteriaMobileSubscriberDirectoryNumber Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
EnterpriseCallCenterAgentThresholdDefaultProfileGetRequest(OCIRequest)
Gets an existing default Call Center Agent Threshold Profile in an Enterprise.
If includeAgentsTable is set to true, a table with the list of agents assigned to the profile is included in the response. The search criteria is used to filter the list of agents to be included in the table.
The response is either a
EnterpriseCallCenterAgentThresholdDefaultProfileGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| include_agents_table | bool | includeAgentsTable |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest(OCIRequest)
Get the list of all Agents in the Enterprise that can be assigned to a given Call Center Agent Threshold Profile in an Enterprise.
An agent is available to be assigned to a given Agent Threshold Profile if it is a Call Center Standard or Call Center Premium agent and the agent is not yet assigned to the profile. The available agent list for a new Call Center Agent Threshold profile can be obtained by not setting the excludeAgentsAssignedToProfileName. When the excludeAgentsAssignedToProfileName is specified, all agents already assigned to the specified profile are not included in the response, even if the search criterion element searchCriteriaAgentThresholdProfile is specified using the same profile name.
The response is either a
EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| exclude_agents_assigned_to_profile_name | str | excludeAgentsAssignedToProfileName Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_agent_threshold_profile | List[OCI.searchCriteriaAgentThresholdProfile] | searchCriteriaAgentThresholdProfile Optional |
EnterpriseCallCenterCurrentAndPastAgentGetListRequest(OCIRequest)
Request to all the current and past agents in the enterprise.
The searchCriteriaExactUserGroup does not apply to past agents.
The response is either EnterpriseCallCenterCurrentAndPastAgentGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
EnterpriseCallCenterCurrentAndPastCallCenterGetListRequest(OCIRequest)
Request to get all the current and past call centers for the enterprise.
The searchCriteriaExactUserGroup does not apply to past call centers.
The response is either EnterpriseCallCenterCurrentAndPastCallCenterGetListResponse()
or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| is_premium_only | bool | isPremiumOnly Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_call_center_name | OCI.searchCriteriaCallCenterName | searchCriteriaCallCenterName Optional |
EnterpriseCallCenterEnhancedReportingScheduledReportGetActiveListRequest(OCIRequest)
Request to get a list of active enterprise level call center reporting scheduled reports.
The response is either an
EnterpriseCallCenterEnhancedReportingScheduledReportGetActiveListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_call_center_scheduled_report_name | List[OCI.searchCriteriaCallCenterScheduledReportName] | searchCriteriaCallCenterScheduledReportName Optional |
| search_criteria_exact_call_center_scheduled_report_created_by_supervisor | OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor | searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor Optional |
| search_criteria_exact_call_center_report_template_key | OCI.searchCriteriaExactCallCenterReportTemplateKey | searchCriteriaExactCallCenterReportTemplateKey Optional |
EnterpriseCallCenterEnhancedReportingScheduledReportGetCompletedListRequest(OCIRequest)
Request to get a list of completed enterprise level call center reporting scheduled reports.
The response is either an
EnterpriseCallCenterEnhancedReportingScheduledReportGetCompletedListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_call_center_scheduled_report_name | List[OCI.searchCriteriaCallCenterScheduledReportName] | searchCriteriaCallCenterScheduledReportName Optional |
| search_criteria_exact_call_center_scheduled_report_created_by_supervisor | OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor | searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor Optional |
| search_criteria_exact_call_center_report_template_key | OCI.searchCriteriaExactCallCenterReportTemplateKey | searchCriteriaExactCallCenterReportTemplateKey Optional |
EnterpriseCallCenterEnhancedReportingScheduledReportGetListRequest(OCIRequest)
Request to get a list of enterprise level call center reporting scheduled reports.
The response is either an
EnterpriseCallCenterEnhancedReportingScheduledReportGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_call_center_scheduled_report_name | List[OCI.searchCriteriaCallCenterScheduledReportName] | searchCriteriaCallCenterScheduledReportName Optional |
| search_criteria_exact_call_center_scheduled_report_created_by_supervisor | OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor | searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor Optional |
| search_criteria_exact_call_center_report_template_key | OCI.searchCriteriaExactCallCenterReportTemplateKey | searchCriteriaExactCallCenterReportTemplateKey Optional |
EnterpriseCommonPhoneListGetListRequest(OCIRequest)
Get an enterprise's common phone list.
The response is either a EnterpriseCommonPhoneListGetListResponse() or an
ErrorResponse(). The search can be done using multiple criterion. If the
searchCriteriaModeOr is present, any result matching any one criteria is included in
the results. Otherwise, only results matching all the search criterion are included
in the results. If no search criteria is specified, all results are returned.
Specifying searchCriteriaModeOr without any search criteria results in an
ErrorResponse(). In all cases, if a responseSizeLimit is specified and the number of
matching results is more than this limit, then an ErrorResponse() is returned.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
| search_criteria_enterprise_common_phone_list_name | List[OCI.searchCriteriaEnterpriseCommonPhoneListName] | searchCriteriaEnterpriseCommonPhoneListName Optional |
| search_criteria_enterprise_common_phone_list_number | List[OCI.searchCriteriaEnterpriseCommonPhoneListNumber] | searchCriteriaEnterpriseCommonPhoneListNumber Optional |
EnterpriseCommunicationBarringAuthorizationCodeGetListRequest(OCIRequest)
Get a list of Communication Barring Authorization Codes in an enterprise.
The response is either
EnterpriseCommunicationBarringAuthorizationCodeGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_communication_barring_authorization_code | List[OCI.searchCriteriaCommunicationBarringAuthorizationCode] | searchCriteriaCommunicationBarringAuthorizationCode Optional |
| search_criteria_communication_barring_authorization_code_description | List[OCI.searchCriteriaCommunicationBarringAuthorizationCodeDescription] | searchCriteriaCommunicationBarringAuthorizationCodeDescription Optional |
| search_criteria_network_class_of_service_name | List[OCI.searchCriteriaNetworkClassOfServiceName] | searchCriteriaNetworkClassOfServiceName Optional |
EnterpriseDepartmentAddRequest(OCIRequest)
Add a department to enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enterprise_id | str | enterpriseId |
| department_name | str | departmentName |
| parent_department_key | OCI.parentDepartmentKey | parentDepartmentKey Optional |
EnterpriseDepartmentModifyRequest(OCIRequest)
Modify a department of an enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enterprise_id | str | enterpriseId |
| department_name | str | departmentName |
| new_department_name | str | newDepartmentName Optional |
| new_parent_department_key | OCI.newParentDepartmentKey | newParentDepartmentKey Optional |
EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListRequest(OCIRequest)
Request to get the list of all available trunk groups defined in an enterprise.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either a
EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_trunk_group_name | List[OCI.searchCriteriaTrunkGroupName] | searchCriteriaTrunkGroupName Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
EnterpriseEnterpriseTrunkGetAvailableUserListRequest(OCIRequest)
Request the list of users that are available to be added to an enterprise trunk.
This list contains users in the enterprise that are trunk users and not already assigned to an enterprise trunk. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either an EnterpriseEnterpriseTrunkGetAvailableUserListResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_alternate_trunk_identity | List[OCI.searchCriteriaAlternateTrunkIdentity] | searchCriteriaAlternateTrunkIdentity Optional |
| search_criteria_alternate_trunk_identity_domain | List[OCI.searchCriteriaAlternateTrunkIdentityDomain] | searchCriteriaAlternateTrunkIdentityDomain Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
EnterpriseEnterpriseTrunkGetUserListRequest(OCIRequest)
Request the list of users in an enterprise trunk.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either a EnterpriseEnterpriseTrunkGetUserListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| enterprise_trunk_name | str | enterpriseTrunkName |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_alternate_trunk_identity | List[OCI.searchCriteriaAlternateTrunkIdentity] | searchCriteriaAlternateTrunkIdentity Optional |
| search_criteria_alternate_trunk_identity_domain | List[OCI.searchCriteriaAlternateTrunkIdentityDomain] | searchCriteriaAlternateTrunkIdentityDomain Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_route_list_assigned | OCI.searchCriteriaExactUserRouteListAssigned | searchCriteriaExactUserRouteListAssigned Optional |
EnterpriseLocalGatewayGetPagedSortedListRequest(OCIRequest)
Get a list of local gateways defined within an enterprise.
Only the local gateways having device associated are returned. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. If no sortOrder is included the response is sorted by Trunk group name ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.
The response is either a EnterpriseLocalGatewayGetPagedSortedListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_by_trunk_group_name | OCI.sortByTrunkGroupName | sortByTrunkGroupName Optional |
| search_criteria_trunk_group_name | List[OCI.searchCriteriaTrunkGroupName] | searchCriteriaTrunkGroupName Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
EnterprisePhoneDirectoryGetListRequest(OCIRequest)
Request a table containing the phone directory for an enterprise.
The directory includes all users in the enterprise and all entries in the enterprise common phone list. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either EnterprisePhoneDirectoryGetListResponse() or
ErrorResponse(). Replace by: EnterprisePhoneDirectoryGetListRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| enterprise_id | str | enterpriseId |
| is_extended_info_requested | bool | isExtendedInfoRequested |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_group_location_code | List[OCI.searchCriteriaGroupLocationCode] | searchCriteriaGroupLocationCode Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_mobile_phone_number | List[OCI.searchCriteriaMobilePhoneNumber] | searchCriteriaMobilePhoneNumber Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_yahoo_id | List[OCI.searchCriteriaYahooId] | searchCriteriaYahooId Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
EnterprisePhoneDirectoryGetListRequest17(OCIRequest)
Request a table containing the phone directory for an enterprise.
The directory includes all users in the enterprise and all entries in the enterprise common phone list. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either EnterprisePhoneDirectoryGetListResponse17() or
ErrorResponse(). Replaced by: EnterprisePhoneDirectoryGetListRequest18()
Attributes:
| Name | Type | Description |
|---|---|---|
| enterprise_id | str | enterpriseId |
| is_extended_info_requested | bool | isExtendedInfoRequested |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_group_location_code | List[OCI.searchCriteriaGroupLocationCode] | searchCriteriaGroupLocationCode Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_mobile_phone_number | List[OCI.searchCriteriaMobilePhoneNumber] | searchCriteriaMobilePhoneNumber Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_yahoo_id | List[OCI.searchCriteriaYahooId] | searchCriteriaYahooId Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
EnterprisePhoneDirectoryGetListRequest17sp3(OCIRequest)
Request a table containing the phone directory for an enterprise.
The directory includes all users in the enterprise and all entries in the enterprise common phone list. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either EnterprisePhoneDirectoryGetListResponse17sp3() or
ErrorResponse(). Replaced by: EnterprisePhoneDirectoryGetListRequest18()
Attributes:
| Name | Type | Description |
|---|---|---|
| enterprise_id | str | enterpriseId |
| is_extended_info_requested | bool | isExtendedInfoRequested |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_group_location_code | List[OCI.searchCriteriaGroupLocationCode] | searchCriteriaGroupLocationCode Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_mobile_phone_number | List[OCI.searchCriteriaMobilePhoneNumber] | searchCriteriaMobilePhoneNumber Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_yahoo_id | List[OCI.searchCriteriaYahooId] | searchCriteriaYahooId Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
EnterprisePhoneDirectoryGetListRequest18(OCIRequest)
Request a table containing the phone directory for an enterprise.
The directory includes all users in the enterprise and all entries in the enterprise common phone list. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either EnterprisePhoneDirectoryGetListResponse18() or
ErrorResponse().
Replaced By: EnterprisePhoneDirectoryGetPagedSortedListRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| enterprise_id | str | enterpriseId |
| is_extended_info_requested | bool | isExtendedInfoRequested |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_group_location_code | List[OCI.searchCriteriaGroupLocationCode] | searchCriteriaGroupLocationCode Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_mobile_phone_number | List[OCI.searchCriteriaMobilePhoneNumber] | searchCriteriaMobilePhoneNumber Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_yahoo_id | List[OCI.searchCriteriaYahooId] | searchCriteriaYahooId Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
EnterprisePhoneDirectoryGetPagedListRequest(OCIRequest)
Request a table containing the phone directory for an enterprise.
The directory includes all users in the enterprise and all entries in the enterprise common phone list. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either EnterprisePhoneDirectoryGetPagedListResponse() or
ErrorResponse().
Replaced By: EnterprisePhoneDirectoryGetPagedSortedListRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| enterprise_id | str | enterpriseId |
| is_extended_info_requested | bool | isExtendedInfoRequested |
| response_paging_control | OCI.responsePagingControl | responsePagingControl |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_group_location_code | List[OCI.searchCriteriaGroupLocationCode] | searchCriteriaGroupLocationCode Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_mobile_phone_number | List[OCI.searchCriteriaMobilePhoneNumber] | searchCriteriaMobilePhoneNumber Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_yahoo_id | List[OCI.searchCriteriaYahooId] | searchCriteriaYahooId Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
EnterprisePreAlertingAnnouncementModifyRequest(OCIRequest)
Modify the enterprise level pre-alerting service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| announcement_interruption | str | announcementInterruption Optional |
| interruption_digit_sequence | str | interruptionDigitSequence Optional |
| audio_selection | str | audioSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_selection | str | videoSelection Optional |
| video_file | OCI.videoFile | videoFile Optional |
EnterpriseSessionAdmissionControlGetAvailableDeviceListRequest(OCIRequest)
Request to get the list of devices can be assigned to session admission control group for the enterprise.
The response is either an
EnterpriseSessionAdmissionControlGetAvailableDeviceListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_device_name | List[OCI.searchCriteriaDeviceName] | searchCriteriaDeviceName Optional |
| search_criteria_device_mac_address | List[OCI.searchCriteriaDeviceMACAddress] | searchCriteriaDeviceMACAddress Optional |
| search_criteria_device_net_address | List[OCI.searchCriteriaDeviceNetAddress] | searchCriteriaDeviceNetAddress Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_exact_device_type | OCI.searchCriteriaExactDeviceType | searchCriteriaExactDeviceType Optional |
| search_criteria_exact_device_level | OCI.searchCriteriaExactDeviceLevel | searchCriteriaExactDeviceLevel Optional |
EnterpriseSessionAdmissionControlGroupAddDeviceListRequest(OCIRequest)
Request to add one or more devices to an enterprise level session admission control group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| devices | List[OCI.devices] | devices |
EnterpriseSessionAdmissionControlGroupAddRequest(OCIRequest)
Request to add a session admission control group for the enterprise.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| max_session | int | maxSession |
| max_user_originating_sessions | int | maxUserOriginatingSessions Optional |
| max_user_terminating_sessions | int | maxUserTerminatingSessions Optional |
| reserved_session | int | reservedSession |
| reserved_user_originating_sessions | int | reservedUserOriginatingSessions Optional |
| reserved_user_terminating_sessions | int | reservedUserTerminatingSessions Optional |
| become_default_group | bool | becomeDefaultGroup |
| count_intra_sac_group_sessions | bool | countIntraSACGroupSessions |
| devices | List[OCI.devices] | devices Optional |
EnterpriseSessionAdmissionControlGroupAddRequest19sp1(OCIRequest)
Request to add a session admission control group for the enterprise.
The response is either a SuccessResponse() or an ErrorResponse(). Note that to
provision the accessInfoPattern element, the captureAccessInfoInPaniHeader system
parameter needs to be set to "true".
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| max_session | int | maxSession |
| max_user_originating_sessions | int | maxUserOriginatingSessions Optional |
| max_user_terminating_sessions | int | maxUserTerminatingSessions Optional |
| reserved_session | int | reservedSession |
| reserved_user_originating_sessions | int | reservedUserOriginatingSessions Optional |
| reserved_user_terminating_sessions | int | reservedUserTerminatingSessions Optional |
| become_default_group | bool | becomeDefaultGroup |
| count_intra_sac_group_sessions | bool | countIntraSACGroupSessions |
| devices | List[OCI.devices] | devices Optional |
| block_emergency_and_repair_calls_due_to_sac_limits | bool | blockEmergencyAndRepairCallsDueToSACLimits |
| media_group_name | str | mediaGroupName Optional |
| access_info_pattern | str | accessInfoPattern Optional |
EnterpriseSessionAdmissionControlGroupDeleteDeviceListRequest(OCIRequest)
Request to delete one or more devices from an enterprise level session admission control group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| devices | List[OCI.devices] | devices |
EnterpriseUserCallForwardingSettingsGetListRequest(OCIRequest)
Get a list of users and the service settings for a Call Forwarding service.
The response is either EnterpriseUserCallForwardingSettingsGetListResponse() or
ErrorResponse(). By default, virtual users and non-virtual users that match the
selected search criteria are included in the response when "includeVirtualUsers" is
present; otherwise, if "includeVirtualUsers" is absent, then only non-virtual users
are returned. The search can be performed using multiple criteria. If search
criteria is specified, only the users matching all of the specified search criteria
are included in the response. If no search criteria is specified, all results are
returned.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| call_forwarding_service | str | callForwardingService |
| response_paging_control | OCI.responsePagingControl | responsePagingControl |
| sort_by_user_last_name | OCI.sortByUserLastName | sortByUserLastName Optional |
| sort_by_user_first_name | OCI.sortByUserFirstName | sortByUserFirstName Optional |
| sort_by_user_department | OCI.sortByUserDepartment | sortByUserDepartment Optional |
| sort_by_dn | OCI.sortByDn | sortByDn Optional |
| sort_by_extension | OCI.sortByExtension | sortByExtension Optional |
| sort_by_group_id | OCI.sortByGroupId | sortByGroupId Optional |
| sort_by_forwarded_to_number | OCI.sortByForwardedToNumber | sortByForwardedToNumber Optional |
| include_virtual_users | bool | includeVirtualUsers Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_in_trunk_group | OCI.searchCriteriaExactUserInTrunkGroup | searchCriteriaExactUserInTrunkGroup Optional |
| search_criteria_forwarded_to_number | List[OCI.searchCriteriaForwardedToNumber] | searchCriteriaForwardedToNumber Optional |
EnterpriseUserCallWaitingSettingsGetListRequest(OCIRequest)
Get a list of users and the Call Waiting service status (active or not active).
The response is either EnterpriseUserCallWaitingSettingsGetListResponse() or
ErrorResponse(). By default, virtual users and non-virtual users that match the
selected search criteria are included in the response when "includeVirtualUsers" is
present; otherwise, if "includeVirtualUsers" is absent, then only non-virtual users
are returned. The search can be performed using multiple criteria. If search
criteria is specified, only the users matching all of the specified search criteria
are included in the response. If no search criteria is specified, all results are
returned.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl |
| sort_by_user_last_name | OCI.sortByUserLastName | sortByUserLastName Optional |
| sort_by_user_first_name | OCI.sortByUserFirstName | sortByUserFirstName Optional |
| sort_by_user_department | OCI.sortByUserDepartment | sortByUserDepartment Optional |
| sort_by_dn | OCI.sortByDn | sortByDn Optional |
| sort_by_extension | OCI.sortByExtension | sortByExtension Optional |
| sort_by_service_status | OCI.sortByServiceStatus | sortByServiceStatus Optional |
| sort_by_group_id | OCI.sortByGroupId | sortByGroupId Optional |
| include_virtual_users | bool | includeVirtualUsers Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_in_trunk_group | OCI.searchCriteriaExactUserInTrunkGroup | searchCriteriaExactUserInTrunkGroup Optional |
| search_criteria_service_status | OCI.searchCriteriaServiceStatus | searchCriteriaServiceStatus Optional |
EnterpriseUserCallingPlanSettingsGetListRequest(OCIRequest)
Get a list of users and the default or custom calling plan setting.
The response is either EnterpriseUserCallingPlanSettingsGetListResponse() or
ErrorResponse(). By default, virtual users and non-virtual users that match the
selected search criteria are included in the response when "includeVirtualUsers" is
present; otherwise, if "includeVirtualUsers" is absent, then only non-virtual users
are returned. The search can be performed using multiple criteria. If search
criteria is specified, only the users matching all of the specified search criteria
are included in the response. If no search criteria is specified, all results are
returned.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| calling_plan_service | str | callingPlanService |
| response_paging_control | OCI.responsePagingControl | responsePagingControl |
| sort_by_user_last_name | OCI.sortByUserLastName | sortByUserLastName Optional |
| sort_by_user_first_name | OCI.sortByUserFirstName | sortByUserFirstName Optional |
| sort_by_user_department | OCI.sortByUserDepartment | sortByUserDepartment Optional |
| sort_by_dn | OCI.sortByDn | sortByDn Optional |
| sort_by_extension | OCI.sortByExtension | sortByExtension Optional |
| sort_by_group_id | OCI.sortByGroupId | sortByGroupId Optional |
| include_virtual_users | bool | includeVirtualUsers Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_in_trunk_group | OCI.searchCriteriaExactUserInTrunkGroup | searchCriteriaExactUserInTrunkGroup Optional |
EnterpriseUserHotelingGuestSettingsGetListRequest(OCIRequest)
Get a list of users and their Hoteling Guest service status (active or not active).
The response is either EnterpriseUserHotelingGuestSettingsGetListResponse() or
ErrorResponse(). By default, virtual users and non-virtual users that match the
selected search criteria are included in the response when "includeVirtualUsers" is
present; otherwise, if "includeVirtualUsers" is absent, then only non-virtual users
are returned. The search can be performed using multiple criteria. If search
criteria is specified, only the users matching all of the specified search criteria
are included in the response. If no search criteria is specified, all results are
returned.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl |
| sort_by_user_last_name | OCI.sortByUserLastName | sortByUserLastName Optional |
| sort_by_user_first_name | OCI.sortByUserFirstName | sortByUserFirstName Optional |
| sort_by_user_department | OCI.sortByUserDepartment | sortByUserDepartment Optional |
| sort_by_dn | OCI.sortByDn | sortByDn Optional |
| sort_by_extension | OCI.sortByExtension | sortByExtension Optional |
| sort_by_service_status | OCI.sortByServiceStatus | sortByServiceStatus Optional |
| sort_by_group_id | OCI.sortByGroupId | sortByGroupId Optional |
| include_virtual_users | bool | includeVirtualUsers Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_in_trunk_group | OCI.searchCriteriaExactUserInTrunkGroup | searchCriteriaExactUserInTrunkGroup Optional |
EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest(OCIRequest)
Request the list of Virtual On-Net users in an Enterprise.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either a
EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_group_location_code | List[OCI.searchCriteriaGroupLocationCode] | searchCriteriaGroupLocationCode Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_virtual_on_net_call_type_name | OCI.searchCriteriaExactVirtualOnNetCallTypeName | searchCriteriaExactVirtualOnNetCallTypeName Optional |
EnterpriseVoiceVPNGetPolicyListRequest(OCIRequest)
Request the list of Voice VPN locations.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either a EnterpriseVoiceVPNGetPolicyListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_group_location_code | List[OCI.searchCriteriaGroupLocationCode] | searchCriteriaGroupLocationCode Optional |
| search_criteria_exact_policy_selection | OCI.searchCriteriaExactPolicySelection | searchCriteriaExactPolicySelection Optional |
GroupAccessDeviceGetListRequest(OCIRequest)
Requests the list of access devices in a group.
The following elements are only used in AS data mode and ignored in XS data mode: groupExternalId
The response is either GroupAccessDeviceGetListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| group_external_id | str | groupExternalId Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_device_name | List[OCI.searchCriteriaDeviceName] | searchCriteriaDeviceName Optional |
| search_criteria_device_mac_address | List[OCI.searchCriteriaDeviceMACAddress] | searchCriteriaDeviceMACAddress Optional |
| search_criteria_device_net_address | List[OCI.searchCriteriaDeviceNetAddress] | searchCriteriaDeviceNetAddress Optional |
| search_criteria_exact_device_type | OCI.searchCriteriaExactDeviceType | searchCriteriaExactDeviceType Optional |
| search_criteria_access_device_version | List[OCI.searchCriteriaAccessDeviceVersion] | searchCriteriaAccessDeviceVersion Optional |
GroupAccessDeviceGetPagedSortedListRequest(OCIRequest)
Requests the list of access devices in a group.
The response is either GroupAccessDeviceGetPagedSortedListResponse() or
ErrorResponse(). If no sortOrder is included, the response is sorted by Device Name
ascending by default. If the responsePagingControl element is not provided, the
paging startIndex will be set to 1 by default, and the responsePageSize will be set to
the maximum responsePageSize by default. Multiple search criteria are logically ANDed
together unless the searchCriteriaModeOr option is included. Then the search criteria
are logically ORed together. The getVisualDeviceManagementAPIDevicesOnly element can
only be set when CloudPBX is licenced. If the getVisualDeviceManagementAPIDevicesOnly
element is not set, all devices are returned with Visual Device Management API flag
set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true,
only SIP devices supporting Visual Device Management API are returned. If the
getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are
returned with their current Visual Device Management API flag value. Replaced by
GroupAccessDeviceGetPagedSortedListRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_by_device_name | OCI.sortByDeviceName | sortByDeviceName Optional |
| sort_by_device_type | OCI.sortByDeviceType | sortByDeviceType Optional |
| sort_by_device_net_address | OCI.sortByDeviceNetAddress | sortByDeviceNetAddress Optional |
| sort_by_device_mac_address | OCI.sortByDeviceMACAddress | sortByDeviceMACAddress Optional |
| search_criteria_device_name | List[OCI.searchCriteriaDeviceName] | searchCriteriaDeviceName Optional |
| search_criteria_device_mac_address | List[OCI.searchCriteriaDeviceMACAddress] | searchCriteriaDeviceMACAddress Optional |
| search_criteria_device_net_address | List[OCI.searchCriteriaDeviceNetAddress] | searchCriteriaDeviceNetAddress Optional |
| search_criteria_exact_device_type | List[OCI.searchCriteriaExactDeviceType] | searchCriteriaExactDeviceType Optional |
| search_criteria_access_device_version | List[OCI.searchCriteriaAccessDeviceVersion] | searchCriteriaAccessDeviceVersion Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
| get_visual_device_management_api_devices_only | bool | getVisualDeviceManagementAPIDevicesOnly Optional |
GroupAccessDeviceGetUserListRequest(OCIRequest)
Requests the configuration of a specified group access device.
The response is either GroupAccessDeviceGetUserListResponse() or ErrorResponse().
The following elements are only used in XS data mode and ignored in AS data mode:
searchCriteriaAccessDeviceEndpointPrivateIdentity Replaced by:
GroupAccessDeviceGetUserListRequest21sp1() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_line_port_user_part | List[OCI.searchCriteriaLinePortUserPart] | searchCriteriaLinePortUserPart Optional |
| search_criteria_line_port_domain | List[OCI.searchCriteriaLinePortDomain] | searchCriteriaLinePortDomain Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_exact_endpoint_type | OCI.searchCriteriaExactEndpointType | searchCriteriaExactEndpointType Optional |
| search_criteria_exact_user_type | OCI.searchCriteriaExactUserType | searchCriteriaExactUserType Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_port_number | OCI.searchCriteriaExactPortNumber | searchCriteriaExactPortNumber Optional |
| search_criteria_access_device_endpoint_private_identity | List[OCI.searchCriteriaAccessDeviceEndpointPrivateIdentity] | searchCriteriaAccessDeviceEndpointPrivateIdentity Optional |
GroupAccessDeviceGetUserListRequest21sp1(OCIRequest)
Requests the configuration of a specified group access device.
The response is either GroupAccessDeviceGetUserListResponse21sp1() or
ErrorResponse(). The following elements are only used in XS data mode and ignored in
AS data mode: searchCriteriaAccessDeviceEndpointPrivateIdentity
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| device_name | str | deviceName |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_line_port_user_part | List[OCI.searchCriteriaLinePortUserPart] | searchCriteriaLinePortUserPart Optional |
| search_criteria_line_port_domain | List[OCI.searchCriteriaLinePortDomain] | searchCriteriaLinePortDomain Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_exact_endpoint_type | OCI.searchCriteriaExactEndpointType | searchCriteriaExactEndpointType Optional |
| search_criteria_exact_user_type | OCI.searchCriteriaExactUserType | searchCriteriaExactUserType Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_port_number | OCI.searchCriteriaExactPortNumber | searchCriteriaExactPortNumber Optional |
| search_criteria_access_device_endpoint_private_identity | List[OCI.searchCriteriaAccessDeviceEndpointPrivateIdentity] | searchCriteriaAccessDeviceEndpointPrivateIdentity Optional |
| search_criteria_user_hotline_contact | List[OCI.searchCriteriaUserHotlineContact] | searchCriteriaUserHotlineContact Optional |
GroupAccountAuthorizationCodesGetAvailableUserListRequest(OCIRequest)
Get a list of non restricted users for the account/authorization codes service.
The response is either GroupAccountAuthorizationCodesGetAvailableUserListResponse()
or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupAlternateUserIdGetListRequest(OCIRequest)
Request to get the list of alternate user ids in the group.
The response is either GroupAlternateUserIdGetListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_alternate_user_id | List[OCI.searchCriteriaAlternateUserId] | searchCriteriaAlternateUserId Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
GroupAnnouncementFileGetListRequest(OCIRequest)
Get the list of available announcement files for a Group.
The following elements are only used in AS data mode and ignored in XS data mode: groupExternalId
The response is either a GroupAnnouncementFileGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| group_external_id | str | groupExternalId Optional |
| announcement_file_type | str | announcementFileType Optional |
| include_announcement_table | bool | includeAnnouncementTable |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_announcement_file_name | List[OCI.searchCriteriaAnnouncementFileName] | searchCriteriaAnnouncementFileName Optional |
GroupAnnouncementFileGetPagedSortedListRequest(OCIRequest)
Get the list of available announcement files for a Group.
If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum responsePageSize by default. If no sortOrder is included, the response is sorted by Name ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together. The following elements are only used in AS data mode and ignored in XS data mode: groupExternalId
The response is either a GroupAnnouncementFileGetPagedSortedListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| group_external_id | str | groupExternalId Optional |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_by_announcement_file_name | OCI.sortByAnnouncementFileName | sortByAnnouncementFileName Optional |
| sort_by_announcement_file_size | OCI.sortByAnnouncementFileSize | sortByAnnouncementFileSize Optional |
| search_criteria_announcement_file_name | List[OCI.searchCriteriaAnnouncementFileName] | searchCriteriaAnnouncementFileName Optional |
| search_criteria_exact_announcement_file_type | OCI.searchCriteriaExactAnnouncementFileType | searchCriteriaExactAnnouncementFileType Optional |
| search_criteria_exact_media_file_type | List[OCI.searchCriteriaExactMediaFileType] | searchCriteriaExactMediaFileType Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupAutoAttendantModifyInstanceExecutionServerRequest(OCIRequest)
Request to modify an Auto Attendant instance.
Only Group and Enterprise level schedules are accepted.
The response is either SuccessResponse() or ErrorResponse(). Engineering Note:
This command can only be executed from the Execution Server
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| business_hours_menu | OCI.businessHoursMenu | businessHoursMenu Optional |
| after_hours_menu | OCI.afterHoursMenu | afterHoursMenu Optional |
| holiday_menu | OCI.holidayMenu | holidayMenu Optional |
GroupBroadWorksAnywhereAddInstanceRequest(OCIRequest)
Add a BroadWorks Anywhere instance to a group.
The domain is required in the serviceUserId. The following elements are only used in AS data mode: networkClassOfService
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| broad_works_anywhere_scope | str | broadWorksAnywhereScope |
| prompt_for_clid | str | promptForCLID |
| silent_prompt_mode | bool | silentPromptMode |
| prompt_for_passcode | bool | promptForPasscode |
| network_class_of_service | str | networkClassOfService Optional |
GroupBroadWorksAnywhereModifyInstanceRequest(OCIRequest)
Request to modify a BroadWorks Anywhere instance.
The following elements are only used in AS data mode: networkClassOfService
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| broad_works_anywhere_scope | str | broadWorksAnywhereScope Optional |
| prompt_for_clid | str | promptForCLID Optional |
| silent_prompt_mode | bool | silentPromptMode Optional |
| prompt_for_passcode | bool | promptForPasscode Optional |
| network_class_of_service | str | networkClassOfService Optional |
GroupBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentListRequest(OCIRequest)
Get the list of assigned and unassigned Mobile Subscriber Directory Numbers in a group.
Each DN can be assigned to a user. . This command is applicable only for group in a service provider and will fail for a group in an enterprise.
The response is either a
GroupBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentListResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_mobile_subscriber_directory_number | List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] | searchCriteriaMobileSubscriberDirectoryNumber Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupCallCapacityManagementGetAvailableUserListRequest(OCIRequest)
Get a list of users that can be assigned to a Call Capacity Management group.
The available user list for a new Call Capacity Management group can be obtained by not setting the name.
The response is either GroupCallCapacityManagementGetAvailableUserListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupCallCenterAddInstanceRequest14(OCIRequest)
Add a Call Center instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: GroupCallCenterAddInstanceRequest14sp3()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| policy | str | policy |
| hunt_after_no_answer | bool | huntAfterNoAnswer |
| no_answer_number_of_rings | int | noAnswerNumberOfRings |
| forward_after_timeout | bool | forwardAfterTimeout |
| forward_timeout_seconds | int | forwardTimeoutSeconds |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| enable_video | bool | enableVideo |
| queue_length | int | queueLength |
| allow_agent_logoff | bool | allowAgentLogoff |
| play_music_on_hold | bool | playMusicOnHold |
| play_comfort_message | bool | playComfortMessage |
| time_between_comfort_messages_seconds | int | timeBetweenComfortMessagesSeconds |
| enable_guard_timer | bool | enableGuardTimer |
| guard_timer_seconds | int | guardTimerSeconds |
| agent_user_id | List[str] | agentUserId Optional |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents |
GroupCallCenterAddInstanceRequest14sp3(OCIRequest)
Add a Call Center instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: GroupCallCenterAddInstanceRequest14sp9()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| policy | str | policy |
| hunt_after_no_answer | bool | huntAfterNoAnswer |
| no_answer_number_of_rings | int | noAnswerNumberOfRings |
| forward_after_timeout | bool | forwardAfterTimeout |
| forward_timeout_seconds | int | forwardTimeoutSeconds |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| enable_video | bool | enableVideo |
| queue_length | int | queueLength |
| allow_agent_logoff | bool | allowAgentLogoff |
| play_music_on_hold | bool | playMusicOnHold |
| play_comfort_message | bool | playComfortMessage |
| time_between_comfort_messages_seconds | int | timeBetweenComfortMessagesSeconds |
| enable_guard_timer | bool | enableGuardTimer |
| guard_timer_seconds | int | guardTimerSeconds |
| agent_user_id | List[str] | agentUserId Optional |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents |
| allow_calls_to_agents_in_wrap_up | bool | allowCallsToAgentsInWrapUp |
| enable_call_queue_when_no_agents_available | bool | enableCallQueueWhenNoAgentsAvailable |
GroupCallCenterAddInstanceRequest14sp9(OCIRequest)
Add a Call Center instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: GroupCallCenterAddInstanceRequest16(),
GroupCallCenterAddAgentListRequest(), GroupCallCenterModifyPolicyRequest(),
GroupCallCenterModifyAnnouncementRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| policy | str | policy |
| hunt_after_no_answer | bool | huntAfterNoAnswer |
| no_answer_number_of_rings | int | noAnswerNumberOfRings |
| forward_after_timeout | bool | forwardAfterTimeout |
| forward_timeout_seconds | int | forwardTimeoutSeconds |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| enable_video | bool | enableVideo |
| queue_length | int | queueLength |
| allow_agent_logoff | bool | allowAgentLogoff |
| play_music_on_hold | bool | playMusicOnHold |
| play_comfort_message | bool | playComfortMessage |
| time_between_comfort_messages_seconds | int | timeBetweenComfortMessagesSeconds |
| enable_guard_timer | bool | enableGuardTimer |
| guard_timer_seconds | int | guardTimerSeconds |
| agent_user_id | List[str] | agentUserId Optional |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents |
| allow_calls_to_agents_in_wrap_up | bool | allowCallsToAgentsInWrapUp |
| enable_call_queue_when_no_agents_available | bool | enableCallQueueWhenNoAgentsAvailable |
| statistics_source | str | statisticsSource |
GroupCallCenterAddInstanceRequest16(OCIRequest)
Add a Call Center instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
GroupCallCenterAddInstanceRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| type | str | type |
| policy | str | policy |
| enable_video | bool | enableVideo |
| queue_length | int | queueLength |
| reporting_server_name | str | reportingServerName Optional |
| allow_caller_to_dial_escape_digit | bool | allowCallerToDialEscapeDigit |
| escape_digit | str | escapeDigit |
| reset_call_statistics_upon_entry_in_queue | bool | resetCallStatisticsUponEntryInQueue Optional |
| allow_agent_logoff | bool | allowAgentLogoff |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents |
| allow_calls_to_agents_in_wrap_up | bool | allowCallsToAgentsInWrapUp Optional |
| override_agent_wrap_up_time | bool | overrideAgentWrapUpTime Optional |
| wrap_up_seconds | int | wrapUpSeconds Optional |
| force_delivery_of_calls | bool | forceDeliveryOfCalls Optional |
| force_delivery_wait_time_seconds | int | forceDeliveryWaitTimeSeconds Optional |
| external_preferred_audio_codec | str | externalPreferredAudioCodec |
| internal_preferred_audio_codec | str | internalPreferredAudioCodec |
| play_ringing_when_offering_call | bool | playRingingWhenOfferingCall |
GroupCallCenterAddInstanceRequest17(OCIRequest)
Add a Call Center instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| type | str | type |
| policy | str | policy |
| enable_video | bool | enableVideo |
| queue_length | int | queueLength |
| reporting_server_name | str | reportingServerName Optional |
| allow_caller_to_dial_escape_digit | bool | allowCallerToDialEscapeDigit |
| escape_digit | str | escapeDigit |
| reset_call_statistics_upon_entry_in_queue | bool | resetCallStatisticsUponEntryInQueue Optional |
| allow_agent_logoff | bool | allowAgentLogoff |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents |
| allow_calls_to_agents_in_wrap_up | bool | allowCallsToAgentsInWrapUp Optional |
| override_agent_wrap_up_time | bool | overrideAgentWrapUpTime Optional |
| wrap_up_seconds | int | wrapUpSeconds Optional |
| force_delivery_of_calls | bool | forceDeliveryOfCalls Optional |
| force_delivery_wait_time_seconds | int | forceDeliveryWaitTimeSeconds Optional |
| enable_automatic_state_change_for_agents | bool | enableAutomaticStateChangeForAgents Optional |
| agent_state_after_call | str | agentStateAfterCall Optional |
| agent_unavailable_code | str | agentUnavailableCode Optional |
| external_preferred_audio_codec | str | externalPreferredAudioCodec |
| internal_preferred_audio_codec | str | internalPreferredAudioCodec |
| play_ringing_when_offering_call | bool | playRingingWhenOfferingCall |
GroupCallCenterAddInstanceRequest17sp1(OCIRequest)
Add a Call Center instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
GroupCallCenterAddInstanceRequest17sp3()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| type | str | type |
| policy | str | policy |
| enable_video | bool | enableVideo |
| queue_length | int | queueLength |
| enable_reporting | bool | enableReporting Optional |
| reporting_server_name | str | reportingServerName Optional |
| allow_caller_to_dial_escape_digit | bool | allowCallerToDialEscapeDigit |
| escape_digit | str | escapeDigit |
| reset_call_statistics_upon_entry_in_queue | bool | resetCallStatisticsUponEntryInQueue Optional |
| allow_agent_logoff | bool | allowAgentLogoff |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents |
| allow_calls_to_agents_in_wrap_up | bool | allowCallsToAgentsInWrapUp Optional |
| override_agent_wrap_up_time | bool | overrideAgentWrapUpTime Optional |
| wrap_up_seconds | int | wrapUpSeconds Optional |
| force_delivery_of_calls | bool | forceDeliveryOfCalls Optional |
| force_delivery_wait_time_seconds | int | forceDeliveryWaitTimeSeconds Optional |
| enable_automatic_state_change_for_agents | bool | enableAutomaticStateChangeForAgents Optional |
| agent_state_after_call | str | agentStateAfterCall Optional |
| agent_unavailable_code | str | agentUnavailableCode Optional |
| external_preferred_audio_codec | str | externalPreferredAudioCodec |
| internal_preferred_audio_codec | str | internalPreferredAudioCodec |
| play_ringing_when_offering_call | bool | playRingingWhenOfferingCall |
GroupCallCenterAddInstanceRequest17sp3(OCIRequest)
Add a Call Center instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse(). Replaced by
GroupCallCenterAddInstanceRequest19()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| type | str | type |
| policy | str | policy |
| enable_video | bool | enableVideo |
| queue_length | int | queueLength |
| enable_reporting | bool | enableReporting Optional |
| reporting_server_name | str | reportingServerName Optional |
| allow_caller_to_dial_escape_digit | bool | allowCallerToDialEscapeDigit |
| escape_digit | str | escapeDigit |
| reset_call_statistics_upon_entry_in_queue | bool | resetCallStatisticsUponEntryInQueue |
| allow_agent_logoff | bool | allowAgentLogoff |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents |
| allow_calls_to_agents_in_wrap_up | bool | allowCallsToAgentsInWrapUp Optional |
| override_agent_wrap_up_time | bool | overrideAgentWrapUpTime Optional |
| wrap_up_seconds | int | wrapUpSeconds Optional |
| force_delivery_of_calls | bool | forceDeliveryOfCalls Optional |
| force_delivery_wait_time_seconds | int | forceDeliveryWaitTimeSeconds Optional |
| enable_automatic_state_change_for_agents | bool | enableAutomaticStateChangeForAgents Optional |
| agent_state_after_call | str | agentStateAfterCall Optional |
| agent_unavailable_code | str | agentUnavailableCode Optional |
| external_preferred_audio_codec | str | externalPreferredAudioCodec |
| internal_preferred_audio_codec | str | internalPreferredAudioCodec |
| play_ringing_when_offering_call | bool | playRingingWhenOfferingCall |
GroupCallCenterAddInstanceRequest19(OCIRequest)
Add a Call Center instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse(). Replaced by
GroupCallCenterAddInstanceRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| type | str | type |
| routing_type | str | routingType Optional |
| policy | str | policy |
| enable_video | bool | enableVideo |
| queue_length | int | queueLength |
| enable_reporting | bool | enableReporting Optional |
| allow_caller_to_dial_escape_digit | bool | allowCallerToDialEscapeDigit |
| escape_digit | str | escapeDigit |
| reset_call_statistics_upon_entry_in_queue | bool | resetCallStatisticsUponEntryInQueue |
| allow_agent_logoff | bool | allowAgentLogoff |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents |
| allow_calls_to_agents_in_wrap_up | bool | allowCallsToAgentsInWrapUp Optional |
| override_agent_wrap_up_time | bool | overrideAgentWrapUpTime Optional |
| wrap_up_seconds | int | wrapUpSeconds Optional |
| force_delivery_of_calls | bool | forceDeliveryOfCalls Optional |
| force_delivery_wait_time_seconds | int | forceDeliveryWaitTimeSeconds Optional |
| enable_automatic_state_change_for_agents | bool | enableAutomaticStateChangeForAgents Optional |
| agent_state_after_call | str | agentStateAfterCall Optional |
| agent_unavailable_code | str | agentUnavailableCode Optional |
| external_preferred_audio_codec | str | externalPreferredAudioCodec |
| internal_preferred_audio_codec | str | internalPreferredAudioCodec |
| play_ringing_when_offering_call | bool | playRingingWhenOfferingCall |
| network_class_of_service | str | networkClassOfService Optional |
GroupCallCenterAddInstanceRequest22(OCIRequest)
Add a Call Center instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: routingType
enableReporting allowCallsToAgentsInWrapUp overrideAgentWrapUpTime wrapUpSeconds
forceDeliveryOfCalls forceDeliveryWaitTimeSeconds enableAutomaticStateChangeForAgents
agentStateAfterCall agentUnavailableCode networkClassOfService
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| type | str | type |
| routing_type | str | routingType Optional |
| policy | str | policy |
| enable_video | bool | enableVideo |
| queue_length | int | queueLength |
| enable_reporting | bool | enableReporting Optional |
| allow_caller_to_dial_escape_digit | bool | allowCallerToDialEscapeDigit |
| escape_digit | str | escapeDigit |
| reset_call_statistics_upon_entry_in_queue | bool | resetCallStatisticsUponEntryInQueue |
| allow_agent_logoff | bool | allowAgentLogoff |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents |
| allow_calls_to_agents_in_wrap_up | bool | allowCallsToAgentsInWrapUp Optional |
| override_agent_wrap_up_time | bool | overrideAgentWrapUpTime Optional |
| wrap_up_seconds | int | wrapUpSeconds Optional |
| force_delivery_of_calls | bool | forceDeliveryOfCalls Optional |
| force_delivery_wait_time_seconds | int | forceDeliveryWaitTimeSeconds Optional |
| enable_automatic_state_change_for_agents | bool | enableAutomaticStateChangeForAgents Optional |
| agent_state_after_call | str | agentStateAfterCall Optional |
| agent_unavailable_code | str | agentUnavailableCode Optional |
| external_preferred_audio_codec | str | externalPreferredAudioCodec |
| internal_preferred_audio_codec | str | internalPreferredAudioCodec |
| play_ringing_when_offering_call | bool | playRingingWhenOfferingCall |
| network_class_of_service | str | networkClassOfService Optional |
GroupCallCenterAgentThresholdDefaultProfileGetRequest(OCIRequest)
Gets an existing default Call Center Agent Threshold Profile in a Group.
If includeAgentsTable is set to true, a table with the list of agents assigned to the profile is included in the response. The search criteria is used to filter the list of agents to be included in the table.
The response is either a GroupCallCenterAgentThresholdDefaultProfileGetResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| include_agents_table | bool | includeAgentsTable |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupCallCenterAgentThresholdProfileGetAvailableAgentListRequest(OCIRequest)
Get the list of all Agents in the Group that can be assigned to a given Call Center Agent Threshold Profile in a Group.
An agent is available to be assigned to a given Agent Threshold Profile if it is a Call Center Standard or Call Center Premium agent and the agent is not yet assigned to the profile. The available agent list for a new Call Center Agent Threshold profile can be obtained by not setting the excludeAgentsAssignedToProfileName. When the excludeAgentsAssignedToProfileName is specified, all agents already assigned to the specified profile are not included in the response, even if the search criterion element searchCriteriaAgentThresholdProfile is specified using the same profile name.
The response is either a
GroupCallCenterAgentThresholdProfileGetAvailableAgentListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| exclude_agents_assigned_to_profile_name | str | excludeAgentsAssignedToProfileName Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_agent_threshold_profile | List[OCI.searchCriteriaAgentThresholdProfile] | searchCriteriaAgentThresholdProfile Optional |
GroupCallCenterComfortMessageBypassModifyRequest(OCIRequest)
Modify a call center's comfort message bypass settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| is_active | bool | isActive Optional |
| call_waiting_age_threshold_seconds | int | callWaitingAgeThresholdSeconds Optional |
| play_announcement_after_ringing | bool | playAnnouncementAfterRinging Optional |
| ring_time_before_playing_announcement_seconds | int | ringTimeBeforePlayingAnnouncementSeconds Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_file | OCI.videoFile | videoFile Optional |
GroupCallCenterComfortMessageBypassModifyRequest17(OCIRequest)
Modify a call center's comfort message bypass settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| is_active | bool | isActive Optional |
| call_waiting_age_threshold_seconds | int | callWaitingAgeThresholdSeconds Optional |
| play_announcement_after_ringing | bool | playAnnouncementAfterRinging Optional |
| ring_time_before_playing_announcement_seconds | int | ringTimeBeforePlayingAnnouncementSeconds Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupCallCenterComfortMessageBypassModifyRequest20(OCIRequest)
Modify a call center's comfort message bypass settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| is_active | bool | isActive Optional |
| call_waiting_age_threshold_seconds | int | callWaitingAgeThresholdSeconds Optional |
| play_announcement_after_ringing | bool | playAnnouncementAfterRinging Optional |
| ring_time_before_playing_announcement_seconds | int | ringTimeBeforePlayingAnnouncementSeconds Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupCallCenterCurrentAndPastAgentGetListRequest(OCIRequest)
Request to get all the current and past agents for the group.
The response is either GroupCallCenterCurrentAndPastAgentGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupCallCenterCurrentAndPastCallCenterGetListRequest(OCIRequest)
Request to get all the current and past call centers for the group.
The response is either GroupCallCenterCurrentAndPastCallCenterGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| is_premium_only | bool | isPremiumOnly Optional |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_call_center_name | OCI.searchCriteriaCallCenterName | searchCriteriaCallCenterName Optional |
GroupCallCenterEnhancedReportingScheduledReportGetActiveListRequest(OCIRequest)
Request to get a list of active group level call center reporting scheduled reports.
The response is either a
GroupCallCenterEnhancedReportingScheduledReportGetActiveListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_call_center_scheduled_report_name | List[OCI.searchCriteriaCallCenterScheduledReportName] | searchCriteriaCallCenterScheduledReportName Optional |
| search_criteria_exact_call_center_scheduled_report_created_by_supervisor | OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor | searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor Optional |
| search_criteria_exact_call_center_report_template_key | OCI.searchCriteriaExactCallCenterReportTemplateKey | searchCriteriaExactCallCenterReportTemplateKey Optional |
GroupCallCenterEnhancedReportingScheduledReportGetCompletedListRequest(OCIRequest)
Request to get a list of completed group level call center reporting scheduled reports.
The response is either a
GroupCallCenterEnhancedReportingScheduledReportGetCompletedListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_call_center_scheduled_report_name | List[OCI.searchCriteriaCallCenterScheduledReportName] | searchCriteriaCallCenterScheduledReportName Optional |
| search_criteria_exact_call_center_scheduled_report_created_by_supervisor | OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor | searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor Optional |
| search_criteria_exact_call_center_report_template_key | OCI.searchCriteriaExactCallCenterReportTemplateKey | searchCriteriaExactCallCenterReportTemplateKey Optional |
GroupCallCenterEnhancedReportingScheduledReportGetListRequest(OCIRequest)
Request to get a list of group level call center reporting scheduled reports.
The response is either a
GroupCallCenterEnhancedReportingScheduledReportGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_call_center_scheduled_report_name | List[OCI.searchCriteriaCallCenterScheduledReportName] | searchCriteriaCallCenterScheduledReportName Optional |
| search_criteria_exact_call_center_scheduled_report_created_by_supervisor | OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor | searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor Optional |
| search_criteria_exact_call_center_report_template_key | OCI.searchCriteriaExactCallCenterReportTemplateKey | searchCriteriaExactCallCenterReportTemplateKey Optional |
GroupCallCenterForcedForwardingModifyRequest(OCIRequest)
Modify a call center's forced forwarding settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| is_active | bool | isActive Optional |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| allow_enable_via_fac | bool | allowEnableViaFAC Optional |
| play_announcement_before_forwarding | bool | playAnnouncementBeforeForwarding Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_file | OCI.videoFile | videoFile Optional |
GroupCallCenterForcedForwardingModifyRequest17(OCIRequest)
Modify a call center's forced forwarding settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| is_active | bool | isActive Optional |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| allow_enable_via_fac | bool | allowEnableViaFAC Optional |
| play_announcement_before_forwarding | bool | playAnnouncementBeforeForwarding Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupCallCenterForcedForwardingModifyRequest20(OCIRequest)
Modify a call center's forced forwarding settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| is_active | bool | isActive Optional |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| allow_enable_via_fac | bool | allowEnableViaFAC Optional |
| play_announcement_before_forwarding | bool | playAnnouncementBeforeForwarding Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupCallCenterGetAgentListRequest(OCIRequest)
Get a list of agents assigned to a call center.
The response is either a GroupCallCenterGetAgentListResponse() or an
ErrorResponse(). The following element is only used in AS data mode and ignored in
XS data mode: searchCriteriaExactSkillLevel
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_skill_level | OCI.searchCriteriaExactSkillLevel | searchCriteriaExactSkillLevel Optional |
GroupCallCenterGetAgentPagedSortedListRequest(OCIRequest)
Get a list of agents assigned to a call center.
If the responsePagingControl element is not provided, the paging startIndex will be
set to 1 by default, and the responsePageSize will be set to the maximum
ResponsePageSize by default. It is possible to search by various criteria to restrict
the number of rows returned. Multiple search criteria are logically ANDed together
unless the searchCriteriaModeOr option is included. Then the search criteria are
logically ORed together. ErrorResponse() is returned if
searchCriteriaExactUserGroup or searchCriteriaExactSkillLevel have multiple entries
and searchCriteriaModeOr is not included. Sorting is done on either a priority basis
or a skill basis depending on the type of call center.
The response is either a GroupCallCenterGetAgentPagedSortedListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_skill_level | List[OCI.searchCriteriaExactSkillLevel] | searchCriteriaExactSkillLevel Optional |
| search_criteria_exact_user_group | List[OCI.searchCriteriaExactUserGroup] | searchCriteriaExactUserGroup Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupCallCenterGetAvailableAgentListRequest(OCIRequest)
Get a list of users that can be assigned as agents to a given type of Call Center.
Searching for users by group only makes sense when the call center is part of an Enterprise.
The response is either GroupCallCenterGetAvailableAgentListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| call_center_type | str | callCenterType |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupCallCenterGetAvailableSupervisorListRequest(OCIRequest)
Get a list of users that can be assigned as supervisors to a Call Center.
Searching for users by group only makes sense when the call center is part of an Enterprise.
The response is either GroupCallCenterGetAvailableSupervisorListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupCallCenterGetAvailableUserListRequest(OCIRequest)
Get a list of users that can be assigned to a Call Center group.
Searching for users by group only makes sense when the call center is part of an Enterprise.
The response is either GroupCallCenterGetAvailableUserListResponse() or
ErrorResponse().
Replaced By: GroupCallCenterGetAvailableAgentListRequest() and
GroupCallCenterGetAvailableSupervisorListRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
GroupCallCenterHolidayServiceModifyRequest(OCIRequest)
Modify a call center's holiday service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| holiday_schedule | str | holidaySchedule Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| play_announcement_before_action | bool | playAnnouncementBeforeAction Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_file | OCI.videoFile | videoFile Optional |
GroupCallCenterHolidayServiceModifyRequest17(OCIRequest)
Modify a call center's holiday service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| holiday_schedule | str | holidaySchedule Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| play_announcement_before_action | bool | playAnnouncementBeforeAction Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupCallCenterHolidayServiceModifyRequest17sp1(OCIRequest)
Modify a call center's holiday service settings.
Only Group and Enterprise level schedules are accepted.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| play_announcement_before_action | bool | playAnnouncementBeforeAction Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupCallCenterHolidayServiceModifyRequest20(OCIRequest)
Modify a call center's holiday service settings.
Only Group and Enterprise level schedules are accepted.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| play_announcement_before_action | bool | playAnnouncementBeforeAction Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupCallCenterModifyAgentListRequest(OCIRequest)
Request to modify the agent list for a call center.
The response is either SuccessResponse() or ErrorResponse(). If the
agentUserIdList is used for Skill Based Premium call centers, the agents will be set
to skill level 1. The following element is only used in AS data mode and ignored in XS
data mode: skilledAgentUserIdList
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| agent_user_id_list | OCI.agentUserIdList | agentUserIdList Optional |
| skilled_agent_user_id_list | List[OCI.skilledAgentUserIdList] | skilledAgentUserIdList Optional |
GroupCallCenterModifyInstanceRequest(OCIRequest)
Request to modify a Call Center instance.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: GroupCallCenterModifyInstanceRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| policy | str | policy Optional |
| hunt_after_no_answer | bool | huntAfterNoAnswer Optional |
| no_answer_number_of_rings | int | noAnswerNumberOfRings Optional |
| forward_after_timeout | bool | forwardAfterTimeout Optional |
| forward_timeout_seconds | int | forwardTimeoutSeconds Optional |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| enable_video | bool | enableVideo Optional |
| queue_length | int | queueLength Optional |
| allow_agent_logoff | bool | allowAgentLogoff Optional |
| play_music_on_hold | bool | playMusicOnHold Optional |
| play_comfort_message | bool | playComfortMessage Optional |
| time_between_comfort_messages_seconds | int | timeBetweenComfortMessagesSeconds Optional |
| enable_guard_timer | bool | enableGuardTimer Optional |
| guard_timer_seconds | int | guardTimerSeconds Optional |
| agent_user_id_list | OCI.agentUserIdList | agentUserIdList Optional |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents Optional |
| allow_calls_to_agents_in_wrap_up | bool | allowCallsToAgentsInWrapUp Optional |
| enable_call_queue_when_no_agents_available | bool | enableCallQueueWhenNoAgentsAvailable Optional |
| statistics_source | str | statisticsSource Optional |
GroupCallCenterModifyInstanceRequest16(OCIRequest)
Request to modify a Call Center instance.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| type | str | type Optional |
| policy | str | policy Optional |
| enable_video | bool | enableVideo Optional |
| queue_length | int | queueLength Optional |
| reporting_server_name | str | reportingServerName Optional |
| allow_caller_to_dial_escape_digit | bool | allowCallerToDialEscapeDigit Optional |
| escape_digit | str | escapeDigit Optional |
| reset_call_statistics_upon_entry_in_queue | bool | resetCallStatisticsUponEntryInQueue Optional |
| allow_agent_logoff | bool | allowAgentLogoff Optional |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents Optional |
| allow_calls_to_agents_in_wrap_up | bool | allowCallsToAgentsInWrapUp Optional |
| override_agent_wrap_up_time | bool | overrideAgentWrapUpTime Optional |
| wrap_up_seconds | int | wrapUpSeconds Optional |
| force_delivery_of_calls | bool | forceDeliveryOfCalls Optional |
| force_delivery_wait_time_seconds | int | forceDeliveryWaitTimeSeconds Optional |
| enable_automatic_state_change_for_agents | bool | enableAutomaticStateChangeForAgents Optional |
| agent_state_after_call | str | agentStateAfterCall Optional |
| agent_unavailable_code | str | agentUnavailableCode Optional |
| external_preferred_audio_codec | str | externalPreferredAudioCodec Optional |
| internal_preferred_audio_codec | str | internalPreferredAudioCodec Optional |
| play_ringing_when_offering_call | bool | playRingingWhenOfferingCall Optional |
GroupCallCenterModifyInstanceRequest17sp1(OCIRequest)
Request to modify a Call Center instance.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
GroupCallCenterModifyInstanceRequest19()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| type | str | type Optional |
| policy | str | policy Optional |
| enable_video | bool | enableVideo Optional |
| queue_length | int | queueLength Optional |
| enable_reporting | bool | enableReporting Optional |
| reporting_server_name | str | reportingServerName Optional |
| allow_caller_to_dial_escape_digit | bool | allowCallerToDialEscapeDigit Optional |
| escape_digit | str | escapeDigit Optional |
| reset_call_statistics_upon_entry_in_queue | bool | resetCallStatisticsUponEntryInQueue Optional |
| allow_agent_logoff | bool | allowAgentLogoff Optional |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents Optional |
| allow_calls_to_agents_in_wrap_up | bool | allowCallsToAgentsInWrapUp Optional |
| override_agent_wrap_up_time | bool | overrideAgentWrapUpTime Optional |
| wrap_up_seconds | int | wrapUpSeconds Optional |
| force_delivery_of_calls | bool | forceDeliveryOfCalls Optional |
| force_delivery_wait_time_seconds | int | forceDeliveryWaitTimeSeconds Optional |
| enable_automatic_state_change_for_agents | bool | enableAutomaticStateChangeForAgents Optional |
| agent_state_after_call | str | agentStateAfterCall Optional |
| agent_unavailable_code | str | agentUnavailableCode Optional |
| external_preferred_audio_codec | str | externalPreferredAudioCodec Optional |
| internal_preferred_audio_codec | str | internalPreferredAudioCodec Optional |
| play_ringing_when_offering_call | bool | playRingingWhenOfferingCall Optional |
GroupCallCenterModifyInstanceRequest19(OCIRequest)
Request to modify a Call Center instance.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| type | str | type Optional |
| routing_type | str | routingType Optional |
| policy | str | policy Optional |
| enable_video | bool | enableVideo Optional |
| queue_length | int | queueLength Optional |
| enable_reporting | bool | enableReporting Optional |
| allow_caller_to_dial_escape_digit | bool | allowCallerToDialEscapeDigit Optional |
| escape_digit | str | escapeDigit Optional |
| reset_call_statistics_upon_entry_in_queue | bool | resetCallStatisticsUponEntryInQueue Optional |
| allow_agent_logoff | bool | allowAgentLogoff Optional |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents Optional |
| allow_calls_to_agents_in_wrap_up | bool | allowCallsToAgentsInWrapUp Optional |
| override_agent_wrap_up_time | bool | overrideAgentWrapUpTime Optional |
| wrap_up_seconds | int | wrapUpSeconds Optional |
| force_delivery_of_calls | bool | forceDeliveryOfCalls Optional |
| force_delivery_wait_time_seconds | int | forceDeliveryWaitTimeSeconds Optional |
| enable_automatic_state_change_for_agents | bool | enableAutomaticStateChangeForAgents Optional |
| agent_state_after_call | str | agentStateAfterCall Optional |
| agent_unavailable_code | str | agentUnavailableCode Optional |
| external_preferred_audio_codec | str | externalPreferredAudioCodec Optional |
| internal_preferred_audio_codec | str | internalPreferredAudioCodec Optional |
| play_ringing_when_offering_call | bool | playRingingWhenOfferingCall Optional |
| network_class_of_service | str | networkClassOfService Optional |
GroupCallCenterModifyInstanceRequest22(OCIRequest)
Request to modify a Call Center instance.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: routingType
enableReporting allowCallsToAgentsInWrapUp overrideAgentWrapUpTime wrapUpSeconds
forceDeliveryOfCalls forceDeliveryWaitTimeSeconds enableAutomaticStateChangeForAgents
agentStateAfterCall agentUnavailableCode callCenterQueueThresholdsIsActive
networkClassOfService
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| type | str | type Optional |
| routing_type | str | routingType Optional |
| policy | str | policy Optional |
| enable_video | bool | enableVideo Optional |
| queue_length | int | queueLength Optional |
| enable_reporting | bool | enableReporting Optional |
| allow_caller_to_dial_escape_digit | bool | allowCallerToDialEscapeDigit Optional |
| escape_digit | str | escapeDigit Optional |
| reset_call_statistics_upon_entry_in_queue | bool | resetCallStatisticsUponEntryInQueue Optional |
| allow_agent_logoff | bool | allowAgentLogoff Optional |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents Optional |
| allow_calls_to_agents_in_wrap_up | bool | allowCallsToAgentsInWrapUp Optional |
| override_agent_wrap_up_time | bool | overrideAgentWrapUpTime Optional |
| wrap_up_seconds | int | wrapUpSeconds Optional |
| force_delivery_of_calls | bool | forceDeliveryOfCalls Optional |
| force_delivery_wait_time_seconds | int | forceDeliveryWaitTimeSeconds Optional |
| enable_automatic_state_change_for_agents | bool | enableAutomaticStateChangeForAgents Optional |
| agent_state_after_call | str | agentStateAfterCall Optional |
| agent_unavailable_code | str | agentUnavailableCode Optional |
| external_preferred_audio_codec | str | externalPreferredAudioCodec Optional |
| internal_preferred_audio_codec | str | internalPreferredAudioCodec Optional |
| play_ringing_when_offering_call | bool | playRingingWhenOfferingCall Optional |
| network_class_of_service | str | networkClassOfService Optional |
GroupCallCenterNightServiceModifyRequest(OCIRequest)
Modify a call center's night service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| business_hours | str | businessHours Optional |
| force_night_service | bool | forceNightService Optional |
| allow_manual_override_via_fac | bool | allowManualOverrideViaFAC Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| play_announcement_before_action | bool | playAnnouncementBeforeAction Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_file | OCI.videoFile | videoFile Optional |
| manual_announcement_mode | str | manualAnnouncementMode Optional |
| manual_audio_message_selection | str | manualAudioMessageSelection Optional |
| manual_audio_file | OCI.manualAudioFile | manualAudioFile Optional |
| manual_video_message_selection | str | manualVideoMessageSelection Optional |
| manual_video_file | OCI.manualVideoFile | manualVideoFile Optional |
GroupCallCenterNightServiceModifyRequest17(OCIRequest)
Modify a call center's night service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| business_hours | str | businessHours Optional |
| force_night_service | bool | forceNightService Optional |
| allow_manual_override_via_fac | bool | allowManualOverrideViaFAC Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| play_announcement_before_action | bool | playAnnouncementBeforeAction Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
| manual_announcement_mode | str | manualAnnouncementMode Optional |
| manual_audio_message_selection | str | manualAudioMessageSelection Optional |
| manual_audio_url_list | OCI.manualAudioUrlList | manualAudioUrlList Optional |
| manual_audio_file_list | OCI.manualAudioFileList | manualAudioFileList Optional |
| manual_video_message_selection | str | manualVideoMessageSelection Optional |
| manual_video_url_list | OCI.manualVideoUrlList | manualVideoUrlList Optional |
| manual_video_file_list | OCI.manualVideoFileList | manualVideoFileList Optional |
GroupCallCenterNightServiceModifyRequest17sp1(OCIRequest)
Modify a call center's night service settings.
Only Group and Enterprise level schedules are accepted.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| business_hours | OCI.businessHours | businessHours Optional |
| force_night_service | bool | forceNightService Optional |
| allow_manual_override_via_fac | bool | allowManualOverrideViaFAC Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| play_announcement_before_action | bool | playAnnouncementBeforeAction Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
| manual_announcement_mode | str | manualAnnouncementMode Optional |
| manual_audio_message_selection | str | manualAudioMessageSelection Optional |
| manual_audio_url_list | OCI.manualAudioUrlList | manualAudioUrlList Optional |
| manual_audio_file_list | OCI.manualAudioFileList | manualAudioFileList Optional |
| manual_video_message_selection | str | manualVideoMessageSelection Optional |
| manual_video_url_list | OCI.manualVideoUrlList | manualVideoUrlList Optional |
| manual_video_file_list | OCI.manualVideoFileList | manualVideoFileList Optional |
GroupCallCenterNightServiceModifyRequest20(OCIRequest)
Modify a call center's night service settings.
Only Group and Enterprise level schedules are accepted.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| business_hours | OCI.businessHours | businessHours Optional |
| force_night_service | bool | forceNightService Optional |
| allow_manual_override_via_fac | bool | allowManualOverrideViaFAC Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| play_announcement_before_action | bool | playAnnouncementBeforeAction Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
| manual_announcement_mode | str | manualAnnouncementMode Optional |
| manual_audio_message_selection | str | manualAudioMessageSelection Optional |
| manual_audio_url_list | OCI.manualAudioUrlList | manualAudioUrlList Optional |
| manual_audio_file_list | OCI.manualAudioFileList | manualAudioFileList Optional |
| manual_video_message_selection | str | manualVideoMessageSelection Optional |
| manual_video_url_list | OCI.manualVideoUrlList | manualVideoUrlList Optional |
| manual_video_file_list | OCI.manualVideoFileList | manualVideoFileList Optional |
GroupCallCenterOverflowModifyRequest(OCIRequest)
Modify a call center's overflow settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| overflow_after_timeout | bool | overflowAfterTimeout Optional |
| timeout_seconds | int | timeoutSeconds Optional |
| play_announcement_before_overflow_processing | bool | playAnnouncementBeforeOverflowProcessing Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_file | OCI.videoFile | videoFile Optional |
GroupCallCenterOverflowModifyRequest17(OCIRequest)
Modify a call center's overflow settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| overflow_after_timeout | bool | overflowAfterTimeout Optional |
| timeout_seconds | int | timeoutSeconds Optional |
| play_announcement_before_overflow_processing | bool | playAnnouncementBeforeOverflowProcessing Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupCallCenterOverflowModifyRequest20(OCIRequest)
Modify a call center's overflow settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| overflow_after_timeout | bool | overflowAfterTimeout Optional |
| timeout_seconds | int | timeoutSeconds Optional |
| play_announcement_before_overflow_processing | bool | playAnnouncementBeforeOverflowProcessing Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupCallCenterStrandedCallModifyRequest(OCIRequest)
Modify a call center's stranded call settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_file | OCI.videoFile | videoFile Optional |
GroupCallCenterStrandedCallModifyRequest17(OCIRequest)
Modify a call center's stranded call settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupCallCenterStrandedCallModifyRequest20(OCIRequest)
Modify a call center's stranded call settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupCallCenterStrandedCallUnavailableModifyRequest(OCIRequest)
Modify a call center's stranded calls - unavailable settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| condition_policy_on_number_of_agents_with_specified_unavailable_code | bool | conditionPolicyOnNumberOfAgentsWithSpecifiedUnavailableCode Optional |
| number_of_agents_with_specified_unavailable_code | int | numberOfAgentsWithSpecifiedUnavailableCode Optional |
| agents_unavailable_code | str | agentsUnavailableCode Optional |
| action | str | action Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupCallCenterStrandedCallUnavailableModifyRequest20(OCIRequest)
Modify a call center's stranded calls - unavailable settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| condition_policy_on_number_of_agents_with_specified_unavailable_code | bool | conditionPolicyOnNumberOfAgentsWithSpecifiedUnavailableCode Optional |
| number_of_agents_with_specified_unavailable_code | int | numberOfAgentsWithSpecifiedUnavailableCode Optional |
| agents_unavailable_code | str | agentsUnavailableCode Optional |
| action | str | action Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupCallParkGetAvailableAlternateRecallUserListRequest(OCIRequest)
Get a list of hunt groups that are available to select as an alternate recall user.
The response is either GroupCallParkGetAvailableAlternateRecallUserListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
GroupCallParkGetAvailableUserListRequest(OCIRequest)
Get a list of users that can be assigned to a Call Park group.
The available user list for a new Call Park group can be obtained by not setting the name.
The response is either GroupCallParkGetAvailableUserListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupCallParkGetInstancePagedSortedListRequest(OCIRequest)
Request to get a list of Call Park group instances within a group.
If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.
The response is either GroupCallParkGetInstancePagedSortedListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_by_call_park_name | OCI.sortByCallParkName | sortByCallParkName Optional |
| search_criteria_call_park_name | List[OCI.searchCriteriaCallParkName] | searchCriteriaCallParkName Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupCallParkGetInstancePagedSortedRequest(OCIRequest)
Gets a Call Park group.
If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. It is possible to search by various criteria to restrict the number of rows returned. The sort order is based on the user order provided when creating or modifying the call park instance. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.
The response is either GroupCallParkGetInstancePagedSortedResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupCallPickupGetAvailableUserListRequest(OCIRequest)
Get a list of users that can be assigned to a Call Pickup group.
The available user list for a new Call Pickup group can be obtained by not setting the name.
The response is either GroupCallPickupGetAvailableUserListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupCallPickupGetInstancePagedSortedListRequest(OCIRequest)
Request to get a list of Call Pickup instances within a group.
If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.
The response is either GroupCallPickupGetInstancePagedSortedListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_by_call_pickup_name | OCI.sortByCallPickupName | sortByCallPickupName Optional |
| search_criteria_call_pickup_name | List[OCI.searchCriteriaCallPickupName] | searchCriteriaCallPickupName Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupCollaborateBridgeAddInstanceRequest(OCIRequest)
Add a collaborate bridge to a group.
The domain is required in the serviceUserId. The request fails when supportOutdial is enabled and the system-level collaborate supportOutdial setting is disabled.
The response is either SuccessResponse() or ErrorResponse(). Replaced by
GroupCollaborateBridgeAddInstanceRequest20sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| maximum_bridge_participants | OCI.maximumBridgeParticipants | maximumBridgeParticipants |
| network_class_of_service | str | networkClassOfService Optional |
| max_collaborate_room_participants | int | maxCollaborateRoomParticipants |
| support_outdial | bool | supportOutdial |
| collaborate_owner_user_id | List[str] | collaborateOwnerUserId Optional |
GroupCollaborateBridgeAddInstanceRequest20sp1(OCIRequest)
Add a collaborate bridge to a group.
The domain is required in the serviceUserId. The request fails when supportOutdial is enabled and the system-level collaborate supportOutdial setting is disabled.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| maximum_bridge_participants | OCI.maximumBridgeParticipants | maximumBridgeParticipants |
| network_class_of_service | str | networkClassOfService Optional |
| max_collaborate_room_participants | int | maxCollaborateRoomParticipants |
| support_outdial | bool | supportOutdial |
| collaborate_owner_user_id | List[str] | collaborateOwnerUserId Optional |
GroupCollaborateBridgeConsolidatedAddInstanceRequest(OCIRequest)
Add a collaborate bridge to a group.
The domain is required in the serviceUserId. The request fails when supportOutdial is enabled and the system-level collaborate supportOutdial setting is disabled. If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true, it will be added to group if the command is executed by a service provider administrator or above and the number is already assigned to the service provider. The command will fail otherwise.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| add_phone_number_to_group | bool | addPhoneNumberToGroup Optional |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| maximum_bridge_participants | OCI.maximumBridgeParticipants | maximumBridgeParticipants |
| network_class_of_service | str | networkClassOfService Optional |
| max_collaborate_room_participants | int | maxCollaborateRoomParticipants |
| support_outdial | bool | supportOutdial |
| collaborate_owner_user_id | List[str] | collaborateOwnerUserId Optional |
| service | List[OCI.service] | service Optional |
GroupCollaborateBridgeGetAvailableUserListRequest(OCIRequest)
Get a list of users with the Collaborate – Audio service assigned that can be assigned to a collaborate bridge.
For an Enterprise Group this will include all users in the group’s enterprise. The SearchCriteriaExactUserGroup parameter is only applicable for enterprise groups.
The response is either GroupCollaborateBridgeGetAvailableUserListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupCollaborateBridgeModifyInstanceRequest(OCIRequest)
Request to modify a Collaborate bridge.
The request fails when the collaborateOwnerUserIdList is included in the request for the default collaborate bridge. The request fails when the supportOutdial is included in the request and the system-level collaborate supportOutdial setting is disabled.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
GroupCollaborateBridgeModifyInstanceRequest20sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| maximum_bridge_participants | OCI.maximumBridgeParticipants | maximumBridgeParticipants Optional |
| network_class_of_service | str | networkClassOfService Optional |
| max_collaborate_room_participants | int | maxCollaborateRoomParticipants Optional |
| support_outdial | bool | supportOutdial Optional |
| collaborate_owner_user_id_list | OCI.collaborateOwnerUserIdList | collaborateOwnerUserIdList Optional |
GroupCollaborateBridgeModifyInstanceRequest20sp1(OCIRequest)
Request to modify a Collaborate bridge.
The request fails when the collaborateOwnerUserIdList is included in the request for the default collaborate bridge. The request fails when the supportOutdial is included in the request and the system-level collaborate supportOutdial setting is disabled.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| maximum_bridge_participants | OCI.maximumBridgeParticipants | maximumBridgeParticipants Optional |
| network_class_of_service | str | networkClassOfService Optional |
| max_collaborate_room_participants | int | maxCollaborateRoomParticipants Optional |
| support_outdial | bool | supportOutdial Optional |
| collaborate_owner_user_id_list | OCI.collaborateOwnerUserIdList | collaborateOwnerUserIdList Optional |
GroupCommonPhoneListGetListRequest(OCIRequest)
Get a group's common phone list.
The response is either a GroupCommonPhoneListGetListResponse() or an
ErrorResponse(). The search can be done using multiple criterion. If the
searchCriteriaModeOr is present, any result matching any one criteria is included in
the results. Otherwise, only results matching all the search criterion are included
in the results. If no search criteria is specified, all results are returned.
Specifying searchCriteriaModeOr without any search criteria results in an
ErrorResponse(). In all cases, if a responseSizeLimit is specified and the number of
matching results is more than this limit, then an ErrorResponse() is returned.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
| search_criteria_group_common_phone_list_name | List[OCI.searchCriteriaGroupCommonPhoneListName] | searchCriteriaGroupCommonPhoneListName Optional |
| search_criteria_group_common_phone_list_number | List[OCI.searchCriteriaGroupCommonPhoneListNumber] | searchCriteriaGroupCommonPhoneListNumber Optional |
GroupCommunicationBarringAuthorizationCodeGetListRequest21sp1(OCIRequest)
Get a list of Communication Barring Authorization Codes for a group.
The response is either
GroupCommunicationBarringAuthorizationCodeGetListResponse21sp1() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_communication_barring_authorization_code | List[OCI.searchCriteriaCommunicationBarringAuthorizationCode] | searchCriteriaCommunicationBarringAuthorizationCode Optional |
| search_criteria_communication_barring_authorization_code_description | List[OCI.searchCriteriaCommunicationBarringAuthorizationCodeDescription] | searchCriteriaCommunicationBarringAuthorizationCodeDescription Optional |
| search_criteria_network_class_of_service_name | List[OCI.searchCriteriaNetworkClassOfServiceName] | searchCriteriaNetworkClassOfServiceName Optional |
GroupConsolidatedAddRequest(OCIRequest)
Add a group.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
serviceProviderExternalId groupExternalId The following elements are ignored in AS and
XS data mode: servicePolicy, callProcessingSliceId, provisioningSliceId,
subscriberPartition. The following elements are only used in XS data mode and ignored
in AS mode: preferredDataCenter. Only Provisioning admin and above can change the
preferredDataCenter. The following elements are only used in XS data mode and ignored
in AS data mode: defaultUserCallingLineIdPhoneNumber. The following elements are
optional for the group. If the elements are included, they will be either added,
authorized, or modified on the group. Should any of the following elements be
rejected to due existing system or service provider settings, the group will not be
added and the response will be an ErrorResponse(): domain admin minExtensionLength
maxExtensionLength defaultExtensionLength servicePackAuthorization
groupServiceAuthorizationAndAssignment userServiceAuthorization servicePack
activatablePhoneNumber activatableDNRange routingProfile trunkGroupMaxActiveCalls
trunkGroupBurstingMaxActiveCalls meetMeConferencingAllocatedPorts When a group or user
service is included that is not activated, is not licensed, or not authorized to the
service provider, the response will be an ErrorResponse(). If the group service
authorized quantity is not included it will default to Unlimited. If
activatablePhoneNumber and activatableDNRange elements are included, when activate
element is present, this value overrides the system group default activatable
settings.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| service_provider_external_id | str | serviceProviderExternalId Optional |
| group_id | str | groupId Optional |
| group_external_id | str | groupExternalId Optional |
| default_domain | str | defaultDomain |
| user_limit | int | userLimit |
| group_name | str | groupName Optional |
| calling_line_id_name | str | callingLineIdName Optional |
| time_zone | str | timeZone Optional |
| location_dialing_code | str | locationDialingCode Optional |
| contact | OCI.contact | contact Optional |
| address | OCI.address | address Optional |
| service_policy | str | servicePolicy Optional |
| call_processing_slice_id | str | callProcessingSliceId Optional |
| provisioning_slice_id | str | provisioningSliceId Optional |
| subscriber_partition | str | subscriberPartition Optional |
| preferred_data_center | str | preferredDataCenter Optional |
| default_user_calling_line_id_phone_number | str | defaultUserCallingLineIdPhoneNumber Optional |
| domain | List[str] | domain Optional |
| admin | List[OCI.admin] | admin Optional |
| min_extension_length | int | minExtensionLength Optional |
| max_extension_length | int | maxExtensionLength Optional |
| default_extension_length | int | defaultExtensionLength Optional |
| group_service_authorization_and_assignment | List[OCI.groupServiceAuthorizationAndAssignment] | groupServiceAuthorizationAndAssignment Optional |
| user_service_authorization | List[OCI.userServiceAuthorization] | userServiceAuthorization Optional |
| service_pack_authorization | List[OCI.servicePackAuthorization] | servicePackAuthorization Optional |
| activatable_phone_number | List[OCI.activatablePhoneNumber] | activatablePhoneNumber Optional |
| activatable_dn_range | List[OCI.activatableDNRange] | activatableDNRange Optional |
| routing_profile | str | routingProfile Optional |
| meet_me_conferencing_allocated_ports | OCI.meetMeConferencingAllocatedPorts | meetMeConferencingAllocatedPorts Optional |
| trunk_group_max_active_calls | int | trunkGroupMaxActiveCalls Optional |
| trunk_group_bursting_max_active_calls | OCI.trunkGroupBurstingMaxActiveCalls | trunkGroupBurstingMaxActiveCalls Optional |
GroupConsolidatedAddRequest22(OCIRequest)
Add a group.
The following elements are only used in AS data mode and ignored in XS data mode:
serviceProviderExternalId groupExternalId The following elements are ignored in AS and
XS data mode: servicePolicy, callProcessingSliceId, provisioningSliceId,
subscriberPartition. The following elements are only used in XS data mode and ignored
in AS mode: preferredDataCenter. Only Provisioning admin and above can change the
preferredDataCenter. The following elements are only used in XS data mode and ignored
in AS data mode: defaultUserCallingLineIdPhoneNumber. The following elements are
optional for the group. If the elements are included, they will be either added,
authorized, or modified on the group. Should any of the following elements be
rejected to due existing system or service provider settings, the group will not be
added and the response will be an ErrorResponse(): domain admin minExtensionLength
maxExtensionLength defaultExtensionLength servicePackAuthorization
groupServiceAuthorizationAndAssignment userServiceAuthorization servicePack
activatablePhoneNumber activatableDNRange routingProfile trunkGroupMaxActiveCalls
trunkGroupBurstingMaxActiveCalls meetMeConferencingAllocatedPorts When a group or user
service is included that is not activated, is not licensed, or not authorized to the
service provider, the response will be an ErrorResponse(). If the group service
authorized quantity is not included it will default to Unlimited. If
activatablePhoneNumber and activatableDNRange elements are included, when activate
element is present, this value overrides the system group default activatable
settings. If the activatablePhoneNumber and activatableDNRange element are included,
the phone numbers are added to the service provider if they are available to be
assigned to the group and not currently added to the service provider.
The response returned is a - SuccessResponse() if all the data is successfully
added. - ErrorResponse() if any data other than the DN validation/assignment fails.
- GroupConsolidatedAddResponse22() if any of the activatablePhoneNumber or
activatableDNRange fails validation.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| service_provider_external_id | str | serviceProviderExternalId Optional |
| group_id | str | groupId Optional |
| group_external_id | str | groupExternalId Optional |
| default_domain | str | defaultDomain |
| user_limit | int | userLimit |
| group_name | str | groupName Optional |
| calling_line_id_name | str | callingLineIdName Optional |
| time_zone | str | timeZone Optional |
| location_dialing_code | str | locationDialingCode Optional |
| contact | OCI.contact | contact Optional |
| address | OCI.address | address Optional |
| service_policy | str | servicePolicy Optional |
| call_processing_slice_id | str | callProcessingSliceId Optional |
| provisioning_slice_id | str | provisioningSliceId Optional |
| subscriber_partition | str | subscriberPartition Optional |
| preferred_data_center | str | preferredDataCenter Optional |
| default_user_calling_line_id_phone_number | str | defaultUserCallingLineIdPhoneNumber Optional |
| domain | List[str] | domain Optional |
| admin | List[OCI.admin] | admin Optional |
| min_extension_length | int | minExtensionLength Optional |
| max_extension_length | int | maxExtensionLength Optional |
| default_extension_length | int | defaultExtensionLength Optional |
| group_service_authorization_and_assignment | List[OCI.groupServiceAuthorizationAndAssignment] | groupServiceAuthorizationAndAssignment Optional |
| user_service_authorization | List[OCI.userServiceAuthorization] | userServiceAuthorization Optional |
| service_pack_authorization | List[OCI.servicePackAuthorization] | servicePackAuthorization Optional |
| activatable_phone_number | List[OCI.activatablePhoneNumber] | activatablePhoneNumber Optional |
| activatable_dn_range | List[OCI.activatableDNRange] | activatableDNRange Optional |
| routing_profile | str | routingProfile Optional |
| meet_me_conferencing_allocated_ports | OCI.meetMeConferencingAllocatedPorts | meetMeConferencingAllocatedPorts Optional |
| trunk_group_max_active_calls | int | trunkGroupMaxActiveCalls Optional |
| trunk_group_bursting_max_active_calls | OCI.trunkGroupBurstingMaxActiveCalls | trunkGroupBurstingMaxActiveCalls Optional |
GroupCustomContactDirectoryGetAvailableUserListRequest(OCIRequest)
Get a list of users that can be part of a custom contact directory.
The response is either GroupCustomContactDirectoryGetAvailableUserListResponse() or
ErrorResponse(). Replace by:
GroupCustomContactDirectoryGetAvailableUserListRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
GroupCustomContactDirectoryGetAvailableUserListRequest17(OCIRequest)
Get a list of users that can be part of a custom contact directory.
The response is either GroupCustomContactDirectoryGetAvailableUserListResponse17()
or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupCustomContactDirectoryGetRequest17(OCIRequest)
Gets a Custom Contact Directory in a group.
The response is either GroupCustomContactDirectoryGetResponse17() or
ErrorResponse(). The search can be done using multiple criterion. If the
searchCriteriaModeOr is present, any result matching any one criteria is included in
the results. Otherwise, only results matching all the search criterion are included
in the results. If no search criteria is specified, all results are returned.
Specifying searchCriteriaModeOr without any search criteria results in an
ErrorResponse(). In all cases, if a responseSizeLimit is specified and the number of
matching results is more than this limit, then an ErrorResponse() is returned. The
Receptionist Note column is only populated in AS mode; and populated only if the user
sending the request is a the owner of this Receptionist Note and a Note exists.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_mobile_phone_number | List[OCI.searchCriteriaMobilePhoneNumber] | searchCriteriaMobilePhoneNumber Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
| search_criteria_title | List[OCI.searchCriteriaTitle] | searchCriteriaTitle Optional |
| search_criteria_receptionist_note | List[OCI.searchCriteriaReceptionistNote] | searchCriteriaReceptionistNote Optional |
GroupCustomContactDirectoryModifyRequest17(OCIRequest)
Adds a Custom Contact Directory to a group.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| new_name | str | newName Optional |
| entry_list | OCI.entryList | entryList Optional |
GroupCustomRingbackGroupModifyRequest(OCIRequest)
Modify the group's custom ring back service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: GroupCustomRingbackGroupModifyRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| is_active | bool | isActive Optional |
| audio_selection | str | audioSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_selection | str | videoSelection Optional |
| video_file | OCI.videoFile | videoFile Optional |
GroupCustomRingbackGroupModifyRequest16(OCIRequest)
Modify the group's custom ring back service settings.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
GroupCustomRingbackGroupModifyRequest20() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| is_active | bool | isActive Optional |
| audio_selection | str | audioSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_selection | str | videoSelection Optional |
| video_file | OCI.videoFile | videoFile Optional |
GroupCustomRingbackGroupModifyRequest20(OCIRequest)
Modify the group's custom ring back service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| is_active | bool | isActive Optional |
| audio_selection | str | audioSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_selection | str | videoSelection Optional |
| video_file | OCI.videoFile | videoFile Optional |
GroupDepartmentAdminAddRequest(OCIRequest)
Add a department administrator to a group department.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| department_key | OCI.departmentKey | departmentKey |
| user_id | str | userId |
| first_name | str | firstName Optional |
| last_name | str | lastName Optional |
| password | str | password Optional |
| language | str | language Optional |
GroupDepartmentAdminGetListRequest(OCIRequest)
Get a list of department administrators for the department.
The response is either a GroupDepartmentAdminGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| department_key | OCI.departmentKey | departmentKey |
GroupDeviceManagementEventGetListRequest(OCIRequest)
Request device management's events for a specific queue.
It is possible to restrict the number of rows returned using responseSizeLimit. If eventQueueType is not specified, the events from all the event queues are returned.
The response is either a GroupDeviceManagementEventGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| event_queue_type | str | eventQueueType Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_exact_device_management_event_status_in_progress_or_pending | OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending | searchCriteriaExactDeviceManagementEventStatusInProgressOrPending Optional |
| search_criteria_exact_device_management_event_status_completed | OCI.searchCriteriaExactDeviceManagementEventStatusCompleted | searchCriteriaExactDeviceManagementEventStatusCompleted Optional |
| search_criteria_exact_device_management_event_action | OCI.searchCriteriaExactDeviceManagementEventAction | searchCriteriaExactDeviceManagementEventAction Optional |
| search_criteria_exact_device_management_event_level | OCI.searchCriteriaExactDeviceManagementEventLevel | searchCriteriaExactDeviceManagementEventLevel Optional |
| search_criteria_exact_device_management_event_type | OCI.searchCriteriaExactDeviceManagementEventType | searchCriteriaExactDeviceManagementEventType Optional |
| search_criteria_device_management_event_additional_info | List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] | searchCriteriaDeviceManagementEventAdditionalInfo Optional |
| search_criteria_device_management_event_login_id | List[OCI.searchCriteriaDeviceManagementEventLoginId] | searchCriteriaDeviceManagementEventLoginId Optional |
GroupDeviceManagementEventGetListRequest22(OCIRequest)
Request device management's events for a specific queue.
It is possible to restrict the number of rows returned using responseSizeLimit. If eventQueueType is not specified, the events from all the event queues are returned.
The response is either a GroupDeviceManagementEventGetListResponse22() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| event_queue_type | str | eventQueueType Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_exact_device_management_event_status_in_progress_or_pending | OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending | searchCriteriaExactDeviceManagementEventStatusInProgressOrPending Optional |
| search_criteria_exact_device_management_event_status_completed | OCI.searchCriteriaExactDeviceManagementEventStatusCompleted | searchCriteriaExactDeviceManagementEventStatusCompleted Optional |
| search_criteria_exact_device_management_event_action | OCI.searchCriteriaExactDeviceManagementEventAction | searchCriteriaExactDeviceManagementEventAction Optional |
| search_criteria_exact_device_management_event_level | OCI.searchCriteriaExactDeviceManagementEventLevel | searchCriteriaExactDeviceManagementEventLevel Optional |
| search_criteria_exact_device_management_event_type | OCI.searchCriteriaExactDeviceManagementEventType | searchCriteriaExactDeviceManagementEventType Optional |
| search_criteria_device_management_event_additional_info | List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] | searchCriteriaDeviceManagementEventAdditionalInfo Optional |
| search_criteria_device_management_event_login_id | List[OCI.searchCriteriaDeviceManagementEventLoginId] | searchCriteriaDeviceManagementEventLoginId Optional |
| search_criteria_device_management_event_request | List[OCI.searchCriteriaDeviceManagementEventRequest] | searchCriteriaDeviceManagementEventRequest Optional |
| search_criteria_device_management_event_request_tracking_id | List[OCI.searchCriteriaDeviceManagementEventRequestTrackingId] | searchCriteriaDeviceManagementEventRequestTrackingId Optional |
GroupDnGetAssignmentListRequest(OCIRequest)
Get the list of assigned and unassigned DNs in a group.
Each DN can be assigned to a user and/or department. Ranges of DNs with identical assignment and activation properties are coalesced to a single table row entry.
The response is either a GroupDnGetAssignmentListResponse() or an ErrorResponse().
Replaced by: GroupDnGetAssignmentListRequest18()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_exact_dn_department | OCI.searchCriteriaExactDnDepartment | searchCriteriaExactDnDepartment Optional |
| search_criteria_exact_dn_activation | OCI.searchCriteriaExactDnActivation | searchCriteriaExactDnActivation Optional |
GroupDnGetAssignmentListRequest18(OCIRequest)
Get the list of assigned and unassigned DNs in a group.
Each DN can be assigned to a user and/or department. Ranges of DNs with identical assignment and activation properties are coalesced to a single table row entry. Dns assigned to the IMRN pool are not listed in the response.
The response is either a GroupDnGetAssignmentListResponse18() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_exact_dn_department | OCI.searchCriteriaExactDnDepartment | searchCriteriaExactDnDepartment Optional |
| search_criteria_exact_dn_activation | OCI.searchCriteriaExactDnActivation | searchCriteriaExactDnActivation Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupDomainGetAssignedUserListRequest(OCIRequest)
Request a list of users within in a group that have a given domain assigned.
The response is either GroupDomainGetAssignedUserListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| domain | str | domain |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupEndpointGetListRequest(OCIRequest)
Request to search endpoints in the group.
The response is either GroupEndpointGetListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_line_port_user_part | List[OCI.searchCriteriaLinePortUserPart] | searchCriteriaLinePortUserPart Optional |
| search_criteria_line_port_domain | List[OCI.searchCriteriaLinePortDomain] | searchCriteriaLinePortDomain Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_device_type | List[OCI.searchCriteriaDeviceType] | searchCriteriaDeviceType Optional |
| search_criteria_device_name | List[OCI.searchCriteriaDeviceName] | searchCriteriaDeviceName Optional |
| search_criteria_device_mac_address | List[OCI.searchCriteriaDeviceMACAddress] | searchCriteriaDeviceMACAddress Optional |
| search_criteria_device_net_address | List[OCI.searchCriteriaDeviceNetAddress] | searchCriteriaDeviceNetAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
GroupEnterpriseTrunkGetAvailableTrunkGroupListRequest(OCIRequest)
Request to get the list of all available trunk groups defined in a group.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either a GroupEnterpriseTrunkGetAvailableTrunkGroupListResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_trunk_group_name | List[OCI.searchCriteriaTrunkGroupName] | searchCriteriaTrunkGroupName Optional |
GroupEnterpriseTrunkGetAvailableUserListRequest(OCIRequest)
Request the list of users that are available to be added to an enterprise trunk.
This list contains users in the group that are trunk users and not already assigned to an enterprise trunk. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either a GroupEnterpriseTrunkGetAvailableUserListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_alternate_trunk_identity | List[OCI.searchCriteriaAlternateTrunkIdentity] | searchCriteriaAlternateTrunkIdentity Optional |
| search_criteria_alternate_trunk_identity_domain | List[OCI.searchCriteriaAlternateTrunkIdentityDomain] | searchCriteriaAlternateTrunkIdentityDomain Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
GroupEnterpriseTrunkGetUserListRequest(OCIRequest)
Request the list of users in an enterprise trunk.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either a GroupEnterpriseTrunkGetUserListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| enterprise_trunk_name | str | enterpriseTrunkName |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_alternate_trunk_identity | List[OCI.searchCriteriaAlternateTrunkIdentity] | searchCriteriaAlternateTrunkIdentity Optional |
| search_criteria_alternate_trunk_identity_domain | List[OCI.searchCriteriaAlternateTrunkIdentityDomain] | searchCriteriaAlternateTrunkIdentityDomain Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_route_list_assigned | OCI.searchCriteriaExactUserRouteListAssigned | searchCriteriaExactUserRouteListAssigned Optional |
GroupFindMeFollowMeAddInstanceRequest(OCIRequest)
Add a Find-me/Follow-me instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| network_class_of_service | str | networkClassOfService Optional |
GroupFindMeFollowMeAlertingGroupGetAvailableUserListRequest(OCIRequest)
Get a list of users that can be assigned to a Find-me/Follow-me alerting group.
The response is either
GroupFindMeFollowMeAlertingGroupGetAvailableUserListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupFindMeFollowMeModifyAlertingGroupSelectiveCriteriaRequest(OCIRequest)
Modify a Find-me/Follow-me alerting group criteria.
For the callToNumbers in the callToNumberList, the extension and number elements are not used and the only types accepted for each number are Primary and Alternates. If other type is specified the command fails.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| alerting_group_name | str | alertingGroupName |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted Optional |
| call_to_number_list | OCI.callToNumberList | callToNumberList Optional |
GroupFindMeFollowMeModifyInstanceRequest(OCIRequest)
Request to modify a Find-me/Follow-me instance.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| network_class_of_service | str | networkClassOfService Optional |
GroupFlexibleSeatingHostAddInstanceRequest(OCIRequest)
Add a flexible seating host instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
GroupFlexibleSeatingHostAddInstanceRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| network_class_of_service | str | networkClassOfService Optional |
GroupFlexibleSeatingHostAddInstanceRequest22(OCIRequest)
Add a flexible seating host instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| network_class_of_service | str | networkClassOfService Optional |
GroupFlexibleSeatingHostGetInstanceListRequest(OCIRequest)
Get a list of flexible seating host instances within a group.
The response is either GroupFlexibleSeatingHostGetInstanceListResponse() or
ErrorResponse(). It is possible to get the instances within a specified department.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_department_name | str | groupDepartmentName Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_service_instance_name | List[OCI.searchCriteriaServiceInstanceName] | searchCriteriaServiceInstanceName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupFlexibleSeatingHostModifyInstanceRequest(OCIRequest)
Request to modify a flexible seating host instance.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
GroupFlexibleSeatingHostModifyInstanceRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| network_class_of_service | str | networkClassOfService Optional |
GroupGetListInServiceProviderRequest(OCIRequest)
Request the list of groups in a service provider or enterprise.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either a GroupGetListInServiceProviderResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_group_name | List[OCI.searchCriteriaGroupName] | searchCriteriaGroupName Optional |
GroupGetListInSystemRequest(OCIRequest)
Request the list of groups in the system.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the groups in the administrator's reseller meeting the search criteria are returned.
The response is either a GroupGetListInSystemResponse() or an ErrorResponse(). The
following data elements are only used in AS data mode: searchCriteriaResellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_group_name | List[OCI.searchCriteriaGroupName] | searchCriteriaGroupName Optional |
| search_criteria_exact_service_provider | OCI.searchCriteriaExactServiceProvider | searchCriteriaExactServiceProvider Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_reseller_id | List[OCI.searchCriteriaResellerId] | searchCriteriaResellerId Optional |
GroupGroupPagingAddInstanceRequest(OCIRequest)
Add a Group Paging instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse(). The following element
is only used in AS data mode and ignored in XS data mode: networkClassOfService
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| confirmation_tone_timeout_seconds | int | confirmationToneTimeoutSeconds |
| deliver_originator_clid_instead | bool | deliverOriginatorCLIDInstead |
| originator_clid_prefix | str | originatorCLIDPrefix Optional |
| network_class_of_service | str | networkClassOfService Optional |
GroupGroupPagingGetAvailableOriginatorListRequest(OCIRequest)
Get a list of users that can be assigned as originators to a given paging group.
Searching for users by group only makes sense when the paging group is part of an Enterprise.
The response is either GroupGroupPagingGetAvailableOriginatorListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupGroupPagingGetAvailableTargetListRequest(OCIRequest)
Get a list of users that can be assigned as targets to a given paging group.
Searching for users by group only makes sense when the paging group is part of an Enterprise.
The response is either GroupGroupPagingGetAvailableTargetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupGroupPagingModifyInstanceRequest(OCIRequest)
Request to modify a Group Paging instance.
The response is either SuccessResponse() or ErrorResponse(). The following element
is only used in AS data mode and ignored in XS data mode: networkClassOfService
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| confirmation_tone_timeout_seconds | int | confirmationToneTimeoutSeconds Optional |
| deliver_originator_clid_instead | bool | deliverOriginatorCLIDInstead Optional |
| originator_clid_prefix | str | originatorCLIDPrefix Optional |
| network_class_of_service | str | networkClassOfService Optional |
GroupHuntGroupAddInstanceRequest14(OCIRequest)
Add a Hunt Group instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| policy | str | policy |
| hunt_after_no_answer | bool | huntAfterNoAnswer |
| no_answer_number_of_rings | int | noAnswerNumberOfRings |
| forward_after_timeout | bool | forwardAfterTimeout |
| forward_timeout_seconds | int | forwardTimeoutSeconds |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| agent_user_id | List[str] | agentUserId Optional |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents |
GroupHuntGroupAddInstanceRequest17sp3(OCIRequest)
Add a Hunt Group instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode: useSystemHuntGroupCLIDSetting, use value
"true" in XS data mode includeHuntGroupNameInCLID, use value "true" in XS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| policy | str | policy |
| hunt_after_no_answer | bool | huntAfterNoAnswer |
| no_answer_number_of_rings | int | noAnswerNumberOfRings |
| forward_after_timeout | bool | forwardAfterTimeout |
| forward_timeout_seconds | int | forwardTimeoutSeconds |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| agent_user_id | List[str] | agentUserId Optional |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents |
| use_system_hunt_group_clid_setting | bool | useSystemHuntGroupCLIDSetting |
| include_hunt_group_name_in_clid | bool | includeHuntGroupNameInCLID |
GroupHuntGroupAddInstanceRequest17sp4(OCIRequest)
Add a Hunt Group instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode: useSystemHuntGroupCLIDSetting, use value
"true" in XS data mode includeHuntGroupNameInCLID, use value "true" in XS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| policy | str | policy |
| hunt_after_no_answer | bool | huntAfterNoAnswer |
| no_answer_number_of_rings | int | noAnswerNumberOfRings |
| forward_after_timeout | bool | forwardAfterTimeout |
| forward_timeout_seconds | int | forwardTimeoutSeconds |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| agent_user_id | List[str] | agentUserId Optional |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents |
| use_system_hunt_group_clid_setting | bool | useSystemHuntGroupCLIDSetting |
| include_hunt_group_name_in_clid | bool | includeHuntGroupNameInCLID |
| enable_not_reachable_forwarding | bool | enableNotReachableForwarding |
| not_reachable_forward_to_phone_number | str | notReachableForwardToPhoneNumber Optional |
| make_busy_when_not_reachable | bool | makeBusyWhenNotReachable |
GroupHuntGroupAddInstanceRequest19(OCIRequest)
Add a Hunt Group instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode: useSystemHuntGroupCLIDSetting, use value
"true" in XS data mode includeHuntGroupNameInCLID, use value "true" in XS data mode
Replaced by: GroupHuntGroupAddInstanceRequest20() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| policy | str | policy |
| hunt_after_no_answer | bool | huntAfterNoAnswer |
| no_answer_number_of_rings | int | noAnswerNumberOfRings |
| forward_after_timeout | bool | forwardAfterTimeout |
| forward_timeout_seconds | int | forwardTimeoutSeconds |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| agent_user_id | List[str] | agentUserId Optional |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents |
| use_system_hunt_group_clid_setting | bool | useSystemHuntGroupCLIDSetting |
| include_hunt_group_name_in_clid | bool | includeHuntGroupNameInCLID |
| enable_not_reachable_forwarding | bool | enableNotReachableForwarding |
| not_reachable_forward_to_phone_number | str | notReachableForwardToPhoneNumber Optional |
| make_busy_when_not_reachable | bool | makeBusyWhenNotReachable |
| allow_members_to_control_group_busy | bool | allowMembersToControlGroupBusy |
| enable_group_busy | bool | enableGroupBusy |
| network_class_of_service | str | networkClassOfService Optional |
GroupHuntGroupAddInstanceRequest20(OCIRequest)
Add a Hunt Group instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode: useSystemHuntGroupCLIDSetting, use value
"true" in XS data mode includeHuntGroupNameInCLID, use value "true" in XS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| policy | str | policy |
| hunt_after_no_answer | bool | huntAfterNoAnswer |
| no_answer_number_of_rings | int | noAnswerNumberOfRings |
| forward_after_timeout | bool | forwardAfterTimeout |
| forward_timeout_seconds | int | forwardTimeoutSeconds |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| agent_user_id | List[str] | agentUserId Optional |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents |
| use_system_hunt_group_clid_setting | bool | useSystemHuntGroupCLIDSetting |
| include_hunt_group_name_in_clid | bool | includeHuntGroupNameInCLID |
| enable_not_reachable_forwarding | bool | enableNotReachableForwarding |
| not_reachable_forward_to_phone_number | str | notReachableForwardToPhoneNumber Optional |
| make_busy_when_not_reachable | bool | makeBusyWhenNotReachable |
| allow_members_to_control_group_busy | bool | allowMembersToControlGroupBusy |
| enable_group_busy | bool | enableGroupBusy |
| apply_group_busy_when_terminating_to_agent | bool | applyGroupBusyWhenTerminatingToAgent |
| network_class_of_service | str | networkClassOfService Optional |
GroupHuntGroupConsolidatedAddInstanceRequest(OCIRequest)
Add a Hunt Group instance to a group.
The domain is required in the serviceUserId. If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true, it will be added to group if the command is executed by a service provider administrator or above and the number is already assigned to the service provider. The command will fail otherwise. The weight element inside the agentWeight element will only take effect if the policy element is set to "Weighted" in the request.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode: useSystemHuntGroupCLIDSetting, use value
"true" in XS data mode includeHuntGroupNameInCLID, use value "true" in XS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| add_phone_number_to_group | bool | addPhoneNumberToGroup Optional |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| policy | str | policy |
| hunt_after_no_answer | bool | huntAfterNoAnswer |
| no_answer_number_of_rings | int | noAnswerNumberOfRings |
| forward_after_timeout | bool | forwardAfterTimeout |
| forward_timeout_seconds | int | forwardTimeoutSeconds |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| agent_user_id | List[str] | agentUserId Optional |
| agent_weight | List[OCI.agentWeight] | agentWeight Optional |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents |
| use_system_hunt_group_clid_setting | bool | useSystemHuntGroupCLIDSetting |
| include_hunt_group_name_in_clid | bool | includeHuntGroupNameInCLID |
| enable_not_reachable_forwarding | bool | enableNotReachableForwarding |
| not_reachable_forward_to_phone_number | str | notReachableForwardToPhoneNumber Optional |
| make_busy_when_not_reachable | bool | makeBusyWhenNotReachable |
| allow_members_to_control_group_busy | bool | allowMembersToControlGroupBusy |
| enable_group_busy | bool | enableGroupBusy |
| apply_group_busy_when_terminating_to_agent | bool | applyGroupBusyWhenTerminatingToAgent |
| network_class_of_service | str | networkClassOfService Optional |
| service | List[OCI.service] | service Optional |
| is_active | bool | isActive |
| directory_number_hunting_agent_user_id_list | List[str] | directoryNumberHuntingAgentUserIdList Optional |
| directory_number_hunting_use_terminate_call_to_agent_first | bool | directoryNumberHuntingUseTerminateCallToAgentFirst Optional |
| directory_number_hunting_use_original_agent_services_for_busy_and_no_answer_calls | bool | directoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls Optional |
GroupHuntGroupGetAvailableUserListRequest(OCIRequest)
Get a list of users that can be assigned to a Hunt Group group.
Searching for users by group only makes sense when the hunt group is part of an Enterprise.
The response is either GroupHuntGroupGetAvailableUserListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupHuntGroupModifyInstanceRequest(OCIRequest)
Request to modify a Hunt Group instance.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode: useSystemHuntGroupCLIDSetting
includeHuntGroupNameInCLID applyGroupBusyWhenTerminatingToAgent networkClassOfService
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| policy | str | policy Optional |
| hunt_after_no_answer | bool | huntAfterNoAnswer Optional |
| no_answer_number_of_rings | int | noAnswerNumberOfRings Optional |
| forward_after_timeout | bool | forwardAfterTimeout Optional |
| forward_timeout_seconds | int | forwardTimeoutSeconds Optional |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| agent_user_id_list | OCI.agentUserIdList | agentUserIdList Optional |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents Optional |
| use_system_hunt_group_clid_setting | bool | useSystemHuntGroupCLIDSetting Optional |
| include_hunt_group_name_in_clid | bool | includeHuntGroupNameInCLID Optional |
| enable_not_reachable_forwarding | bool | enableNotReachableForwarding Optional |
| not_reachable_forward_to_phone_number | str | notReachableForwardToPhoneNumber Optional |
| make_busy_when_not_reachable | bool | makeBusyWhenNotReachable Optional |
| allow_members_to_control_group_busy | bool | allowMembersToControlGroupBusy Optional |
| enable_group_busy | bool | enableGroupBusy Optional |
| apply_group_busy_when_terminating_to_agent | bool | applyGroupBusyWhenTerminatingToAgent Optional |
| network_class_of_service | str | networkClassOfService Optional |
GroupIncomingCallingPlanModifyListRequest(OCIRequest)
Change the group's incoming calling plan settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_permissions | OCI.groupPermissions | groupPermissions Optional |
| department_permissions | List[OCI.departmentPermissions] | departmentPermissions Optional |
GroupInstantGroupCallAddInstanceRequest14(OCIRequest)
Request to add an Instant Group Call service instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| destination_phone_number | List[str] | destinationPhoneNumber Optional |
| is_answer_timeout_enabled | bool | isAnswerTimeoutEnabled |
| answer_timeout_minutes | int | answerTimeoutMinutes Optional |
| network_class_of_service | str | networkClassOfService Optional |
GroupInstantGroupCallModifyInstanceRequest(OCIRequest)
Request to modify an Instant Group Call service instance.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| destination_phone_number_list | OCI.destinationPhoneNumberList | destinationPhoneNumberList Optional |
| is_answer_timeout_enabled | bool | isAnswerTimeoutEnabled Optional |
| answer_timeout_minutes | int | answerTimeoutMinutes Optional |
| network_class_of_service | str | networkClassOfService Optional |
GroupMWIDeliveryToMobileEndpointCustomTemplateAddRequest(OCIRequest)
Create a MWI Delivery to Mobile Endpoint Custom Template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| language | str | language |
| type | str | type |
| is_enabled | bool | isEnabled |
| template_body | OCI.templateBody | templateBody |
GroupMWIDeliveryToMobileEndpointCustomTemplateAddRequest23(OCIRequest)
Create a MWI Delivery to Mobile Endpoint Custom Template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| language | str | language |
| type | str | type |
| is_enabled | bool | isEnabled |
| month_abbreviations | str | monthAbbreviations Optional |
| template_body | OCI.templateBody | templateBody |
GroupMWIDeliveryToMobileEndpointCustomTemplateModifyRequest(OCIRequest)
Modify a MWI Delivery to Mobile Endpoint Custom Template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| language | str | language |
| type | str | type |
| is_enabled | bool | isEnabled Optional |
| template_body | OCI.templateBody | templateBody Optional |
GroupMWIDeliveryToMobileEndpointCustomTemplateModifyRequest23(OCIRequest)
Modify a MWI Delivery to Mobile Endpoint Custom Template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| language | str | language |
| type | str | type |
| is_enabled | bool | isEnabled Optional |
| month_abbreviations | str | monthAbbreviations Optional |
| template_body | OCI.templateBody | templateBody Optional |
GroupMeetMeConferencingAddInstanceRequest(OCIRequest)
Add a Meet-Me Conferencing bridge to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| allocated_ports | OCI.allocatedPorts | allocatedPorts |
| network_class_of_service | str | networkClassOfService Optional |
| allow_individual_out_dial | bool | allowIndividualOutDial |
| operator_number | str | operatorNumber Optional |
| conference_host_user_id | List[str] | conferenceHostUserId Optional |
GroupMeetMeConferencingAddInstanceRequest18(OCIRequest)
Add a Meet-Me Conferencing bridge to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| allocated_ports | OCI.allocatedPorts | allocatedPorts |
| network_class_of_service | str | networkClassOfService Optional |
| allow_individual_out_dial | bool | allowIndividualOutDial |
| operator_number | str | operatorNumber Optional |
| conference_host_user_id | List[str] | conferenceHostUserId Optional |
| play_warning_prompt | bool | playWarningPrompt |
| conference_end_warning_prompt_minutes | int | conferenceEndWarningPromptMinutes |
| enable_max_conference_duration | bool | enableMaxConferenceDuration |
| max_conference_duration_minutes | OCI.maxConferenceDurationMinutes | maxConferenceDurationMinutes |
GroupMeetMeConferencingAddInstanceRequest19(OCIRequest)
Add a Meet-Me Conferencing bridge to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| allocated_ports | OCI.allocatedPorts | allocatedPorts |
| network_class_of_service | str | networkClassOfService Optional |
| security_pin_length | int | securityPinLength |
| allow_individual_out_dial | bool | allowIndividualOutDial |
| operator_number | str | operatorNumber Optional |
| conference_host_user_id | List[str] | conferenceHostUserId Optional |
| play_warning_prompt | bool | playWarningPrompt |
| conference_end_warning_prompt_minutes | int | conferenceEndWarningPromptMinutes |
| enable_max_conference_duration | bool | enableMaxConferenceDuration |
| max_conference_duration_minutes | OCI.maxConferenceDurationMinutes | maxConferenceDurationMinutes |
| max_scheduled_conference_duration_minutes | OCI.maxScheduledConferenceDurationMinutes | maxScheduledConferenceDurationMinutes |
GroupMeetMeConferencingGetAvailableUserListRequest(OCIRequest)
Get a list of users that can be assigned to a Meet-Me Conferencing bridge.
Searching for users by group only makes sense when the Meet-Me Conferencing is part of an Enterprise.
The response is either GroupMeetMeConferencingGetAvailableUserListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupMeetMeConferencingModifyInstanceRequest(OCIRequest)
Request to modify a Meet-Me Conferencing bridge.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| allocated_ports | OCI.allocatedPorts | allocatedPorts Optional |
| network_class_of_service | str | networkClassOfService Optional |
| security_pin_length | int | securityPinLength Optional |
| allow_individual_out_dial | bool | allowIndividualOutDial Optional |
| operator_number | str | operatorNumber Optional |
| conference_host_user_id_list | OCI.conferenceHostUserIdList | conferenceHostUserIdList Optional |
| play_warning_prompt | bool | playWarningPrompt Optional |
| conference_end_warning_prompt_minutes | int | conferenceEndWarningPromptMinutes Optional |
| enable_max_conference_duration | bool | enableMaxConferenceDuration Optional |
| max_conference_duration_minutes | OCI.maxConferenceDurationMinutes | maxConferenceDurationMinutes Optional |
| max_scheduled_conference_duration_minutes | OCI.maxScheduledConferenceDurationMinutes | maxScheduledConferenceDurationMinutes Optional |
GroupMusicOnHoldAddInstanceRequest14(OCIRequest)
Add a Music On Hold Instance to a department.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: GroupMusicOnHoldAddInstanceRequest14Sp4
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department |
| is_active_during_call_hold | bool | isActiveDuringCallHold |
| is_active_during_call_park | bool | isActiveDuringCallPark |
| message_selection | str | messageSelection |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_file | OCI.videoFile | videoFile Optional |
GroupMusicOnHoldAddInstanceRequest14sp4(OCIRequest)
Add a Music On Hold Instance to a department.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department |
| is_active_during_call_hold | bool | isActiveDuringCallHold |
| is_active_during_call_park | bool | isActiveDuringCallPark |
| is_active_during_busy_camp_on | bool | isActiveDuringBusyCampOn |
| message_selection | str | messageSelection |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_file | OCI.videoFile | videoFile Optional |
GroupMusicOnHoldModifyInstanceRequest14(OCIRequest)
Modify data for a group or department Music On Hold Instance.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| department | OCI.department | department Optional |
| is_active_during_call_hold | bool | isActiveDuringCallHold Optional |
| is_active_during_call_park | bool | isActiveDuringCallPark Optional |
| is_active_during_busy_camp_on | bool | isActiveDuringBusyCampOn Optional |
| message_selection | str | messageSelection Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_file | OCI.videoFile | videoFile Optional |
GroupNetworkClassOfServiceGetAssignedUserListRequest(OCIRequest)
Get a list of users within a group that have a given Network Class of Service assigned.
The response is either a GroupNetworkClassOfServiceGetAssignedUserListResponse() or
an ErorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| network_class_of_service | str | networkClassOfService |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupNetworkClassOfServiceGetAssignedUserListRequest21(OCIRequest)
Get a list of users within a group that have a given Network Class of Service assigned.
The response is either a GroupNetworkClassOfServiceGetAssignedUserListResponse21()
or an ErorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| network_class_of_service | str | networkClassOfService |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupOfficeZoneGetAssignedUserListRequest(OCIRequest)
Get a list of users within a group that have a given Office Zone assigned.
The response is either a GroupOfficeZoneGetAssignedUserListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| office_zone_name | str | officeZoneName |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupOutgoingCallingPlanCallMeNowModifyListRequest(OCIRequest)
Modify the Call Me Now call permissions for a group default and it's departments.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_permissions | OCI.groupPermissions | groupPermissions Optional |
| department_permissions | List[OCI.departmentPermissions] | departmentPermissions Optional |
GroupOutgoingCallingPlanOriginatingModifyListRequest(OCIRequest)
Modify the originating permissions for a group default and it's departments.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_permissions | OCI.groupPermissions | groupPermissions Optional |
| department_permissions | List[OCI.departmentPermissions] | departmentPermissions Optional |
GroupOutgoingCallingPlanRedirectedModifyListRequest(OCIRequest)
Modify the call forwarded/transferred permissions for a group default and it's departments.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_permissions | OCI.groupPermissions | groupPermissions Optional |
| department_permissions | List[OCI.departmentPermissions] | departmentPermissions Optional |
GroupOutgoingCallingPlanRedirectingModifyListRequest(OCIRequest)
Modify the initiating call forwards/transfer permissions for a group default and it's departments.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_permissions | OCI.groupPermissions | groupPermissions Optional |
| department_permissions | List[OCI.departmentPermissions] | departmentPermissions Optional |
GroupOutgoingCallingPlanTransferNumbersModifyListRequest(OCIRequest)
Modify the list of transfer numbers for a group default and it's departments.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_numbers | OCI.groupNumbers | groupNumbers Optional |
| department_numbers | List[OCI.departmentNumbers] | departmentNumbers Optional |
GroupPhoneDirectoryGetListRequest(OCIRequest)
Request a table containing the phone directory for a group.
If the specified group is part of an enterprise, the directory includes all users in the enterprise and all entries in the enterprise common phone list and the common phone list of the specified group. If the specified group is part of a service provider, the directory includes all users in the group and all entries in the common phone list of the specified group. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either GroupPhoneDirectoryGetListResponse() or ErrorResponse().
Replace by: GroupPhoneDirectoryGetListRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| is_extended_info_requested | bool | isExtendedInfoRequested |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_group_location_code | List[OCI.searchCriteriaGroupLocationCode] | searchCriteriaGroupLocationCode Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_mobile_phone_number | List[OCI.searchCriteriaMobilePhoneNumber] | searchCriteriaMobilePhoneNumber Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_yahoo_id | List[OCI.searchCriteriaYahooId] | searchCriteriaYahooId Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
GroupPhoneDirectoryGetListRequest17(OCIRequest)
Request a table containing the phone directory for a group.
If the specified group is part of an enterprise, the directory includes all users in the enterprise and all entries in the enterprise common phone list and the common phone list of the specified group. If the specified group is part of a service provider, the directory includes all users in the group and all entries in the common phone list of the specified group. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either GroupPhoneDirectoryGetListResponse17() or ErrorResponse().
Replaced by: GroupPhoneDirectoryGetListRequest18()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| is_extended_info_requested | bool | isExtendedInfoRequested |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_group_location_code | List[OCI.searchCriteriaGroupLocationCode] | searchCriteriaGroupLocationCode Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_mobile_phone_number | List[OCI.searchCriteriaMobilePhoneNumber] | searchCriteriaMobilePhoneNumber Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_yahoo_id | List[OCI.searchCriteriaYahooId] | searchCriteriaYahooId Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
GroupPhoneDirectoryGetListRequest17sp3(OCIRequest)
Request a table containing the phone directory for a group.
If the specified group is part of an enterprise, the directory includes all users in the enterprise and all entries in the enterprise common phone list and the common phone list of the specified group. If the specified group is part of a service provider, the directory includes all users in the group and all entries in the common phone list of the specified group. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either GroupPhoneDirectoryGetListResponse17sp3() or
ErrorResponse(). Replaced by: GroupPhoneDirectoryGetListRequest18()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| is_extended_info_requested | bool | isExtendedInfoRequested |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_group_location_code | List[OCI.searchCriteriaGroupLocationCode] | searchCriteriaGroupLocationCode Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_mobile_phone_number | List[OCI.searchCriteriaMobilePhoneNumber] | searchCriteriaMobilePhoneNumber Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_yahoo_id | List[OCI.searchCriteriaYahooId] | searchCriteriaYahooId Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
GroupPhoneDirectoryGetListRequest18(OCIRequest)
Request a table containing the phone directory for a group.
If the specified group is part of an enterprise, the directory includes all users in the enterprise and all entries in the enterprise common phone list and the common phone list of the specified group. If the specified group is part of a service provider, the directory includes all users in the group and all entries in the common phone list of the specified group. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either GroupPhoneDirectoryGetListResponse18() or ErrorResponse().
Replaced By: GroupPhoneDirectoryGetPagedSortedListRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| is_extended_info_requested | bool | isExtendedInfoRequested |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_group_location_code | List[OCI.searchCriteriaGroupLocationCode] | searchCriteriaGroupLocationCode Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_mobile_phone_number | List[OCI.searchCriteriaMobilePhoneNumber] | searchCriteriaMobilePhoneNumber Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_yahoo_id | List[OCI.searchCriteriaYahooId] | searchCriteriaYahooId Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
GroupPhoneDirectoryGetPagedListRequest(OCIRequest)
Request a table containing the phone directory for a group.
If the specified group is part of an enterprise, the directory includes all users in the enterprise and all entries in the enterprise common phone list and the common phone list of the specified group. If the specified group is part of a service provider, the directory includes all users in the group and all entries in the common phone list of the specified group. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either GroupPhoneDirectoryGetPagedListResponse() or
ErrorResponse().
Replaced By: GroupPhoneDirectoryGetPagedSortedListRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| is_extended_info_requested | bool | isExtendedInfoRequested |
| response_paging_control | OCI.responsePagingControl | responsePagingControl |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_group_location_code | List[OCI.searchCriteriaGroupLocationCode] | searchCriteriaGroupLocationCode Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_mobile_phone_number | List[OCI.searchCriteriaMobilePhoneNumber] | searchCriteriaMobilePhoneNumber Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_yahoo_id | List[OCI.searchCriteriaYahooId] | searchCriteriaYahooId Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
GroupPreAlertingAnnouncementModifyRequest(OCIRequest)
Modify the group level pre-alerting service settings.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
GroupPreAlertingAnnouncementModifyRequest20() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| announcement_interruption | str | announcementInterruption Optional |
| interruption_digit_sequence | str | interruptionDigitSequence Optional |
| audio_selection | str | audioSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_selection | str | videoSelection Optional |
| video_file | OCI.videoFile | videoFile Optional |
GroupPreAlertingAnnouncementModifyRequest20(OCIRequest)
Modify the group level pre-alerting service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| announcement_interruption | str | announcementInterruption Optional |
| interruption_digit_sequence | str | interruptionDigitSequence Optional |
| audio_selection | str | audioSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_selection | str | videoSelection Optional |
| video_file | OCI.videoFile | videoFile Optional |
GroupRoutePointAddInstanceRequest(OCIRequest)
Add a Route Point instance to a group.
The Route Point is a Call Center queue that performs the same function but allows an external system to perform the distribution of calls instead of making those decisions itself. The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse(). Replace by
GroupRoutePointAddInstanceRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| network_class_of_service | str | networkClassOfService Optional |
| external_preferred_audio_codec | str | externalPreferredAudioCodec |
| internal_preferred_audio_codec | str | internalPreferredAudioCodec |
| queue_length | int | queueLength |
| no_answer_timeout_rings | int | noAnswerTimeoutRings |
| enable_video | bool | enableVideo |
| play_ringing_when_offering_call | bool | playRingingWhenOfferingCall |
| override_agent_wrap_up_time | bool | overrideAgentWrapUpTime |
| wrap_up_seconds | int | wrapUpSeconds Optional |
| enable_automatic_state_change_for_agents | bool | enableAutomaticStateChangeForAgents |
| agent_state_after_call | str | agentStateAfterCall |
| agent_unavailable_code | str | agentUnavailableCode Optional |
| force_delivery_of_calls | bool | forceDeliveryOfCalls |
| force_delivery_wait_time_seconds | int | forceDeliveryWaitTimeSeconds Optional |
GroupRoutePointAddInstanceRequest22(OCIRequest)
Add a Route Point instance to a group.
The Route Point is a Call Center queue that performs the same function but allows an external system to perform the distribution of calls instead of making those decisions itself. The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse(). Replaced by
GroupRoutePointAddInstanceRequest23().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| network_class_of_service | str | networkClassOfService Optional |
| external_preferred_audio_codec | str | externalPreferredAudioCodec |
| internal_preferred_audio_codec | str | internalPreferredAudioCodec |
| queue_length | int | queueLength |
| no_answer_timeout_rings | int | noAnswerTimeoutRings |
| enable_video | bool | enableVideo |
| play_ringing_when_offering_call | bool | playRingingWhenOfferingCall |
| override_agent_wrap_up_time | bool | overrideAgentWrapUpTime |
| wrap_up_seconds | int | wrapUpSeconds Optional |
| enable_automatic_state_change_for_agents | bool | enableAutomaticStateChangeForAgents |
| agent_state_after_call | str | agentStateAfterCall |
| agent_unavailable_code | str | agentUnavailableCode Optional |
| force_delivery_of_calls | bool | forceDeliveryOfCalls |
| force_delivery_wait_time_seconds | int | forceDeliveryWaitTimeSeconds Optional |
GroupRoutePointAddInstanceRequest23(OCIRequest)
Add a Route Point instance to a group.
The Route Point is a Call Center queue that performs the same function but allows an external system to perform the distribution of calls instead of making those decisions itself. The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse(). The Following
elements are only used in AS data mode and ignored in XS data mode: -
sendCallAdmissionNotification, use value ‘false’ in XS data mode. -
callAdmissionTimerSeconds, use value ‘3’ in XS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| network_class_of_service | str | networkClassOfService Optional |
| external_preferred_audio_codec | str | externalPreferredAudioCodec |
| internal_preferred_audio_codec | str | internalPreferredAudioCodec |
| queue_length | int | queueLength |
| no_answer_timeout_rings | int | noAnswerTimeoutRings |
| enable_video | bool | enableVideo |
| play_ringing_when_offering_call | bool | playRingingWhenOfferingCall |
| override_agent_wrap_up_time | bool | overrideAgentWrapUpTime |
| wrap_up_seconds | int | wrapUpSeconds Optional |
| enable_automatic_state_change_for_agents | bool | enableAutomaticStateChangeForAgents |
| agent_state_after_call | str | agentStateAfterCall |
| agent_unavailable_code | str | agentUnavailableCode Optional |
| force_delivery_of_calls | bool | forceDeliveryOfCalls |
| force_delivery_wait_time_seconds | int | forceDeliveryWaitTimeSeconds Optional |
| send_call_admission_notification | bool | sendCallAdmissionNotification |
| call_admission_timer_seconds | int | callAdmissionTimerSeconds |
| enable_unlimited_queue_length | bool | enableUnlimitedQueueLength Optional |
GroupRoutePointExternalSystemGetAssignedRoutePointListRequest(OCIRequest)
Request a list of route points within in a group that have a given external system assigned.
The response is either
GroupRoutePointExternalSystemGetAssignedRoutePointListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| external_system | str | externalSystem |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_route_point_name | List[OCI.searchCriteriaRoutePointName] | searchCriteriaRoutePointName Optional |
GroupRoutePointForcedForwardingModifyRequest(OCIRequest)
Modify a route point's forced forwarding settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| is_active | bool | isActive Optional |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| play_announcement_before_forwarding | bool | playAnnouncementBeforeForwarding Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupRoutePointForcedForwardingModifyRequest20(OCIRequest)
Modify a route point's forced forwarding settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| is_active | bool | isActive Optional |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| play_announcement_before_forwarding | bool | playAnnouncementBeforeForwarding Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupRoutePointGetInstanceListRequest(OCIRequest)
Get a list of Route Point instances within a group.
It is possible to search by various criteria to restrict the number of rows returned.
The response is either GroupRoutePointGetInstanceListResponse() or
ErrorResponse(). It is possible to get the instances within a specified department.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_department_name | str | groupDepartmentName Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_route_point_name | List[OCI.searchCriteriaRoutePointName] | searchCriteriaRoutePointName Optional |
GroupRoutePointHolidayServiceModifyRequest(OCIRequest)
Modify a route point's holiday service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| holiday_schedule | str | holidaySchedule Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| play_announcement_before_action | bool | playAnnouncementBeforeAction Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupRoutePointHolidayServiceModifyRequest17sp1(OCIRequest)
Modify a route point's holiday service settings.
Only Group and Enterprise level schedules are accepted.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| play_announcement_before_action | bool | playAnnouncementBeforeAction Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupRoutePointHolidayServiceModifyRequest20(OCIRequest)
Modify a route point's holiday service settings.
Only Group and Enterprise level schedules are accepted.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| play_announcement_before_action | bool | playAnnouncementBeforeAction Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupRoutePointModifyInstanceRequest(OCIRequest)
Request to modify a Route Point instance.
The response is either SuccessResponse() or ErrorResponse(). Replaced by
GroupRoutePointModifyInstanceRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| network_class_of_service | str | networkClassOfService Optional |
| external_preferred_audio_codec | str | externalPreferredAudioCodec Optional |
| internal_preferred_audio_codec | str | internalPreferredAudioCodec Optional |
| queue_length | int | queueLength Optional |
| no_answer_timeout_rings | int | noAnswerTimeoutRings Optional |
| enable_video | bool | enableVideo Optional |
| play_ringing_when_offering_call | bool | playRingingWhenOfferingCall Optional |
| override_agent_wrap_up_time | bool | overrideAgentWrapUpTime Optional |
| wrap_up_seconds | int | wrapUpSeconds Optional |
| enable_automatic_state_change_for_agents | bool | enableAutomaticStateChangeForAgents Optional |
| agent_state_after_call | str | agentStateAfterCall Optional |
| agent_unavailable_code | str | agentUnavailableCode Optional |
| force_delivery_of_calls | bool | forceDeliveryOfCalls Optional |
| force_delivery_wait_time_seconds | int | forceDeliveryWaitTimeSeconds Optional |
GroupRoutePointModifyInstanceRequest22(OCIRequest)
Request to modify a Route Point instance.
The response is either SuccessResponse() or ErrorResponse(). The Following
elements are only used in AS data mode and ignored in XS data mode: -
sendCallAdmissionNotification, use value ‘false’ in XS data mode. -
callAdmissionTimerSeconds, use value ‘3’ in XS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| network_class_of_service | str | networkClassOfService Optional |
| external_preferred_audio_codec | str | externalPreferredAudioCodec Optional |
| internal_preferred_audio_codec | str | internalPreferredAudioCodec Optional |
| queue_length | int | queueLength Optional |
| no_answer_timeout_rings | int | noAnswerTimeoutRings Optional |
| enable_video | bool | enableVideo Optional |
| play_ringing_when_offering_call | bool | playRingingWhenOfferingCall Optional |
| override_agent_wrap_up_time | bool | overrideAgentWrapUpTime Optional |
| wrap_up_seconds | int | wrapUpSeconds Optional |
| enable_automatic_state_change_for_agents | bool | enableAutomaticStateChangeForAgents Optional |
| agent_state_after_call | str | agentStateAfterCall Optional |
| agent_unavailable_code | str | agentUnavailableCode Optional |
| force_delivery_of_calls | bool | forceDeliveryOfCalls Optional |
| force_delivery_wait_time_seconds | int | forceDeliveryWaitTimeSeconds Optional |
| send_call_admission_notification | bool | sendCallAdmissionNotification Optional |
| call_admission_timer_seconds | int | callAdmissionTimerSeconds Optional |
| enable_unlimited_queue_length | bool | enableUnlimitedQueueLength Optional |
GroupRoutePointNightServiceModifyRequest(OCIRequest)
Modify a route point's night service settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| business_hours | str | businessHours Optional |
| force_night_service | bool | forceNightService Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| play_announcement_before_action | bool | playAnnouncementBeforeAction Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
| manual_announcement_mode | str | manualAnnouncementMode Optional |
| manual_audio_message_selection | str | manualAudioMessageSelection Optional |
| manual_audio_url_list | OCI.manualAudioUrlList | manualAudioUrlList Optional |
| manual_audio_file_list | OCI.manualAudioFileList | manualAudioFileList Optional |
| manual_video_message_selection | str | manualVideoMessageSelection Optional |
| manual_video_url_list | OCI.manualVideoUrlList | manualVideoUrlList Optional |
| manual_video_file_list | OCI.manualVideoFileList | manualVideoFileList Optional |
GroupRoutePointNightServiceModifyRequest17sp1(OCIRequest)
Modify a route point's night service settings.
Only Group and Enterprise level schedules are accepted.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| business_hours | OCI.businessHours | businessHours Optional |
| force_night_service | bool | forceNightService Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| play_announcement_before_action | bool | playAnnouncementBeforeAction Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
| manual_announcement_mode | str | manualAnnouncementMode Optional |
| manual_audio_message_selection | str | manualAudioMessageSelection Optional |
| manual_audio_url_list | OCI.manualAudioUrlList | manualAudioUrlList Optional |
| manual_audio_file_list | OCI.manualAudioFileList | manualAudioFileList Optional |
| manual_video_message_selection | str | manualVideoMessageSelection Optional |
| manual_video_url_list | OCI.manualVideoUrlList | manualVideoUrlList Optional |
| manual_video_file_list | OCI.manualVideoFileList | manualVideoFileList Optional |
GroupRoutePointNightServiceModifyRequest20(OCIRequest)
Modify a route point's night service settings.
Only Group and Enterprise level schedules are accepted.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| business_hours | OCI.businessHours | businessHours Optional |
| force_night_service | bool | forceNightService Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| play_announcement_before_action | bool | playAnnouncementBeforeAction Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
| manual_announcement_mode | str | manualAnnouncementMode Optional |
| manual_audio_message_selection | str | manualAudioMessageSelection Optional |
| manual_audio_url_list | OCI.manualAudioUrlList | manualAudioUrlList Optional |
| manual_audio_file_list | OCI.manualAudioFileList | manualAudioFileList Optional |
| manual_video_message_selection | str | manualVideoMessageSelection Optional |
| manual_video_url_list | OCI.manualVideoUrlList | manualVideoUrlList Optional |
| manual_video_file_list | OCI.manualVideoFileList | manualVideoFileList Optional |
GroupRoutePointOverflowModifyRequest(OCIRequest)
Modify a route point's overflow settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| overflow_after_timeout | bool | overflowAfterTimeout Optional |
| timeout_seconds | int | timeoutSeconds Optional |
| play_announcement_before_overflow_processing | bool | playAnnouncementBeforeOverflowProcessing Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupRoutePointOverflowModifyRequest20(OCIRequest)
Modify a route point's overflow settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| action | str | action Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| overflow_after_timeout | bool | overflowAfterTimeout Optional |
| timeout_seconds | int | timeoutSeconds Optional |
| play_announcement_before_overflow_processing | bool | playAnnouncementBeforeOverflowProcessing Optional |
| audio_message_selection | str | audioMessageSelection Optional |
| audio_url_list | OCI.audioUrlList | audioUrlList Optional |
| audio_file_list | OCI.audioFileList | audioFileList Optional |
| video_message_selection | str | videoMessageSelection Optional |
| video_url_list | OCI.videoUrlList | videoUrlList Optional |
| video_file_list | OCI.videoFileList | videoFileList Optional |
GroupScheduleGetPagedSortedListRequest(OCIRequest)
Get the list of schedules viewable by a group.
The response is either a GroupScheduleGetPagedSortedListResponse() or an
ErrorResponse(). If no sortOrder is included, the response is sorted by Name
ascending by default. If the responsePagingControl element is not provided, the
paging startIndex will be set to 1 by default, and the responsePageSize will be set to
the maximum responsePageSize by default. Multiple search criteria are logically ANDed
together unless the searchCriteriaModeOr option is included. Then the search criteria
are logically ORed together.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_by_schedule_name | OCI.sortByScheduleName | sortByScheduleName Optional |
| search_criteria_schedule_name | List[OCI.searchCriteriaScheduleName] | searchCriteriaScheduleName Optional |
| search_criteria_exact_schedule_type | List[OCI.searchCriteriaExactScheduleType] | searchCriteriaExactScheduleType Optional |
| search_criteria_exact_schedule_level | List[OCI.searchCriteriaExactScheduleLevel] | searchCriteriaExactScheduleLevel Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupSeriesCompletionGetAvailableUserListRequest(OCIRequest)
Get a list of users that can be assigned to a Series Completion group.
The available user list for a new Series Completion group can be obtained by not setting the name.
The response is either GroupSeriesCompletionGetAvailableUserListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupServiceModifyAuthorizationListRequest(OCIRequest)
Requests to change the group's service authorization status.
The boolean flags are used to authorize or unauthorize services and packs.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_pack_authorization | List[OCI.servicePackAuthorization] | servicePackAuthorization Optional |
| group_service_authorization | List[OCI.groupServiceAuthorization] | groupServiceAuthorization Optional |
| user_service_authorization | List[OCI.userServiceAuthorization] | userServiceAuthorization Optional |
GroupSessionAdmissionControlGetAvailableDeviceListRequest(OCIRequest)
Request to get the list of devices can be assigned to session admission control group for the group.
The response is either an
GroupSessionAdmissionControlGetAvailableDeviceListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_device_name | List[OCI.searchCriteriaDeviceName] | searchCriteriaDeviceName Optional |
| search_criteria_device_mac_address | List[OCI.searchCriteriaDeviceMACAddress] | searchCriteriaDeviceMACAddress Optional |
| search_criteria_device_net_address | List[OCI.searchCriteriaDeviceNetAddress] | searchCriteriaDeviceNetAddress Optional |
| search_criteria_exact_device_type | OCI.searchCriteriaExactDeviceType | searchCriteriaExactDeviceType Optional |
| search_criteria_exact_device_level | OCI.searchCriteriaExactDeviceLevel | searchCriteriaExactDeviceLevel Optional |
GroupSessionAdmissionControlGroupModifyRequest(OCIRequest)
Request to modify a session admission control group for the group.
The response is either a SuccessResponse() or an ErrorResponse(). Note that to
provision the accessInfoPattern element, the captureAccessInfoInPaniHeader system
parameter needs to be set to "true".
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| new_name | str | newName Optional |
| max_session | int | maxSession Optional |
| max_user_originating_sessions | int | maxUserOriginatingSessions Optional |
| max_user_terminating_sessions | int | maxUserTerminatingSessions Optional |
| reserved_session | int | reservedSession Optional |
| reserved_user_originating_sessions | int | reservedUserOriginatingSessions Optional |
| reserved_user_terminating_sessions | int | reservedUserTerminatingSessions Optional |
| become_default_group | bool | becomeDefaultGroup Optional |
| count_intra_sac_group_sessions | bool | countIntraSACGroupSessions Optional |
| device_list | OCI.deviceList | deviceList Optional |
| block_emergency_and_repair_calls_due_to_sac_limits | bool | blockEmergencyAndRepairCallsDueToSACLimits Optional |
| media_group_name | str | mediaGroupName Optional |
| access_info_pattern | str | accessInfoPattern Optional |
GroupTrunkGroupAddInstanceRequest14(OCIRequest)
Add a Trunk Group instance to a group.
The domain is required in the serviceUserId. The publicUserIdentity in the ServiceInstanceAddProfile is not allowed for trunk groups.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| max_active_calls | int | maxActiveCalls |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| require_authentication | bool | requireAuthentication |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
GroupTrunkGroupAddInstanceRequest14sp1(OCIRequest)
Add a Trunk Group instance to a group.
The domain is required in the serviceUserId. The publicUserIdentity in the ServiceInstanceAddProfile is not allowed for trunk groups.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| max_active_calls | int | maxActiveCalls |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_id | str | capacityExceededRerouteTrunkGroupId Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_id | str | unreachableDestinationRerouteTrunkGroupId Optional |
| unreachable_destination_trap_initial_calls | int | unreachableDestinationTrapInitialCalls |
| unreachable_destination_trap_offset_calls | int | unreachableDestinationTrapOffsetCalls |
| invitation_timeout | int | invitationTimeout |
| require_authentication | bool | requireAuthentication |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
GroupTrunkGroupAddInstanceRequest14sp4(OCIRequest)
Add a Trunk Group instance to a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| pilot_user | OCI.pilotUser | pilotUser Optional |
| department | OCI.department | department Optional |
| access_device | OCI.accessDevice | accessDevice Optional |
| max_active_calls | int | maxActiveCalls |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_key | OCI.capacityExceededRerouteTrunkGroupKey | capacityExceededRerouteTrunkGroupKey Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_key | OCI.unreachableDestinationRerouteTrunkGroupKey | unreachableDestinationRerouteTrunkGroupKey Optional |
| unreachable_destination_trap_initial_calls | int | unreachableDestinationTrapInitialCalls |
| unreachable_destination_trap_offset_calls | int | unreachableDestinationTrapOffsetCalls |
| invitation_timeout | int | invitationTimeout |
| require_authentication | bool | requireAuthentication |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
| hosted_user_id | List[str] | hostedUserId Optional |
GroupTrunkGroupAddInstanceRequest14sp9(OCIRequest)
Add a Trunk Group instance to a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| pilot_user | OCI.pilotUser | pilotUser Optional |
| department | OCI.department | department Optional |
| access_device | OCI.accessDevice | accessDevice Optional |
| max_active_calls | int | maxActiveCalls |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_key | OCI.capacityExceededRerouteTrunkGroupKey | capacityExceededRerouteTrunkGroupKey Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_key | OCI.unreachableDestinationRerouteTrunkGroupKey | unreachableDestinationRerouteTrunkGroupKey Optional |
| unreachable_destination_trap_initial_calls | int | unreachableDestinationTrapInitialCalls |
| unreachable_destination_trap_offset_calls | int | unreachableDestinationTrapOffsetCalls |
| invitation_timeout | int | invitationTimeout |
| require_authentication | bool | requireAuthentication |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
| hosted_user_id | List[str] | hostedUserId Optional |
| trunk_group_identity | str | trunkGroupIdentity Optional |
| otg_dtg_identity | str | otgDtgIdentity Optional |
| include_trunk_group_identity | bool | includeTrunkGroupIdentity |
| include_dtg_identity | bool | includeDtgIdentity |
| enable_network_address_identity | bool | enableNetworkAddressIdentity |
| allow_unscreened_calls | bool | allowUnscreenedCalls |
| allow_unscreened_emergency_calls | bool | allowUnscreenedEmergencyCalls |
| use_pilot_user_calling_line_identity | bool | usePilotUserCallingLineIdentity |
| use_pilot_user_charge_number | bool | usePilotUserChargeNumber |
| call_forwarding_always_action | str | callForwardingAlwaysAction Optional |
| call_forwarding_always_forward_address | str | callForwardingAlwaysForwardAddress Optional |
| call_forwarding_always_reroute_trunk_group_key | OCI.callForwardingAlwaysRerouteTrunkGroupKey | callForwardingAlwaysRerouteTrunkGroupKey Optional |
GroupTrunkGroupAddInstanceRequest15(OCIRequest)
Add a Trunk Group instance to a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| pilot_user | OCI.pilotUser | pilotUser Optional |
| department | OCI.department | department Optional |
| access_device | OCI.accessDevice | accessDevice Optional |
| max_active_calls | int | maxActiveCalls |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_key | OCI.capacityExceededRerouteTrunkGroupKey | capacityExceededRerouteTrunkGroupKey Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_key | OCI.unreachableDestinationRerouteTrunkGroupKey | unreachableDestinationRerouteTrunkGroupKey Optional |
| invitation_timeout | int | invitationTimeout |
| require_authentication | bool | requireAuthentication |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
| hosted_user_id | List[str] | hostedUserId Optional |
GroupTrunkGroupAddInstanceRequest15sp2(OCIRequest)
Add a Trunk Group instance to a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| pilot_user | OCI.pilotUser | pilotUser Optional |
| department | OCI.department | department Optional |
| access_device | OCI.accessDevice | accessDevice Optional |
| max_active_calls | int | maxActiveCalls |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_key | OCI.capacityExceededRerouteTrunkGroupKey | capacityExceededRerouteTrunkGroupKey Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_key | OCI.unreachableDestinationRerouteTrunkGroupKey | unreachableDestinationRerouteTrunkGroupKey Optional |
| invitation_timeout | int | invitationTimeout |
| require_authentication | bool | requireAuthentication |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
| hosted_user_id | List[str] | hostedUserId Optional |
| trunk_group_identity | str | trunkGroupIdentity Optional |
| otg_dtg_identity | str | otgDtgIdentity Optional |
| include_trunk_group_identity | bool | includeTrunkGroupIdentity |
| include_dtg_identity | bool | includeDtgIdentity |
| enable_network_address_identity | bool | enableNetworkAddressIdentity |
| allow_unscreened_calls | bool | allowUnscreenedCalls |
| allow_unscreened_emergency_calls | bool | allowUnscreenedEmergencyCalls |
| pilot_user_calling_line_identity_policy | str | pilotUserCallingLineIdentityPolicy |
| pilot_user_charge_number_policy | str | pilotUserChargeNumberPolicy |
| call_forwarding_always_action | str | callForwardingAlwaysAction Optional |
| call_forwarding_always_forward_address | str | callForwardingAlwaysForwardAddress Optional |
| call_forwarding_always_reroute_trunk_group_key | OCI.callForwardingAlwaysRerouteTrunkGroupKey | callForwardingAlwaysRerouteTrunkGroupKey Optional |
GroupTrunkGroupAddInstanceRequest17(OCIRequest)
Replaced By GroupTrunkGroupAddInstanceRequest17sp4() Add a Trunk Group instance to a
group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| pilot_user | OCI.pilotUser | pilotUser Optional |
| department | OCI.department | department Optional |
| access_device | OCI.accessDevice | accessDevice Optional |
| max_active_calls | int | maxActiveCalls |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_key | OCI.capacityExceededRerouteTrunkGroupKey | capacityExceededRerouteTrunkGroupKey Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_key | OCI.unreachableDestinationRerouteTrunkGroupKey | unreachableDestinationRerouteTrunkGroupKey Optional |
| invitation_timeout | int | invitationTimeout |
| require_authentication | bool | requireAuthentication |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
| hosted_user_id | List[str] | hostedUserId Optional |
| trunk_group_identity | str | trunkGroupIdentity Optional |
| otg_dtg_identity | str | otgDtgIdentity Optional |
| include_trunk_group_identity | bool | includeTrunkGroupIdentity |
| include_dtg_identity | bool | includeDtgIdentity |
| enable_network_address_identity | bool | enableNetworkAddressIdentity |
| allow_unscreened_calls | bool | allowUnscreenedCalls |
| allow_unscreened_emergency_calls | bool | allowUnscreenedEmergencyCalls |
| pilot_user_calling_line_identity_policy | str | pilotUserCallingLineIdentityPolicy |
| pilot_user_charge_number_policy | str | pilotUserChargeNumberPolicy |
| call_forwarding_always_action | str | callForwardingAlwaysAction Optional |
| call_forwarding_always_forward_address | str | callForwardingAlwaysForwardAddress Optional |
| call_forwarding_always_reroute_trunk_group_key | OCI.callForwardingAlwaysRerouteTrunkGroupKey | callForwardingAlwaysRerouteTrunkGroupKey Optional |
| peering_domain | str | peeringDomain Optional |
| route_to_peering_domain | bool | routeToPeeringDomain |
GroupTrunkGroupAddInstanceRequest17sp3(OCIRequest)
Add a Trunk Group instance to a group.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
GroupTrunkGroupAddInstanceRequest17sp4()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| pilot_user | OCI.pilotUser | pilotUser Optional |
| department | OCI.department | department Optional |
| access_device | OCI.accessDevice | accessDevice Optional |
| max_active_calls | int | maxActiveCalls |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_key | OCI.capacityExceededRerouteTrunkGroupKey | capacityExceededRerouteTrunkGroupKey Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_key | OCI.unreachableDestinationRerouteTrunkGroupKey | unreachableDestinationRerouteTrunkGroupKey Optional |
| invitation_timeout | int | invitationTimeout |
| require_authentication | bool | requireAuthentication |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
| hosted_user_id | List[str] | hostedUserId Optional |
| trunk_group_identity | str | trunkGroupIdentity Optional |
| otg_dtg_identity | str | otgDtgIdentity Optional |
| include_trunk_group_identity | bool | includeTrunkGroupIdentity |
| include_dtg_identity | bool | includeDtgIdentity |
| enable_network_address_identity | bool | enableNetworkAddressIdentity |
| allow_unscreened_calls | bool | allowUnscreenedCalls |
| allow_unscreened_emergency_calls | bool | allowUnscreenedEmergencyCalls |
| pilot_user_calling_line_identity_policy | str | pilotUserCallingLineIdentityPolicy |
| pilot_user_charge_number_policy | str | pilotUserChargeNumberPolicy |
| call_forwarding_always_action | str | callForwardingAlwaysAction Optional |
| call_forwarding_always_forward_address | str | callForwardingAlwaysForwardAddress Optional |
| call_forwarding_always_reroute_trunk_group_key | OCI.callForwardingAlwaysRerouteTrunkGroupKey | callForwardingAlwaysRerouteTrunkGroupKey Optional |
| peering_domain | str | peeringDomain Optional |
| route_to_peering_domain | bool | routeToPeeringDomain |
| prefix_enabled | bool | prefixEnabled |
| prefix | str | prefix Optional |
| stateful_rerouting_enabled | bool | statefulReroutingEnabled |
| send_continuous_options_message | bool | sendContinuousOptionsMessage |
| continuous_options_sending_interval_seconds | int | continuousOptionsSendingIntervalSeconds |
| failure_options_sending_interval_seconds | int | failureOptionsSendingIntervalSeconds |
| failure_threshold_counter | int | failureThresholdCounter |
| success_threshold_counter | int | successThresholdCounter |
| invite_failure_threshold_counter | int | inviteFailureThresholdCounter |
| invite_failure_threshold_window_seconds | int | inviteFailureThresholdWindowSeconds |
GroupTrunkGroupAddInstanceRequest17sp4(OCIRequest)
Add a Trunk Group instance to a group.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| pilot_user | OCI.pilotUser | pilotUser Optional |
| department | OCI.department | department Optional |
| access_device | OCI.accessDevice | accessDevice Optional |
| max_active_calls | int | maxActiveCalls |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_key | OCI.capacityExceededRerouteTrunkGroupKey | capacityExceededRerouteTrunkGroupKey Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_key | OCI.unreachableDestinationRerouteTrunkGroupKey | unreachableDestinationRerouteTrunkGroupKey Optional |
| invitation_timeout | int | invitationTimeout |
| require_authentication | bool | requireAuthentication |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
| hosted_user_id | List[str] | hostedUserId Optional |
| trunk_group_identity | str | trunkGroupIdentity Optional |
| otg_dtg_identity | str | otgDtgIdentity Optional |
| allow_termination_to_trunk_group_identity | bool | allowTerminationToTrunkGroupIdentity |
| allow_termination_to_dtg_identity | bool | allowTerminationToDtgIdentity |
| include_trunk_group_identity | bool | includeTrunkGroupIdentity |
| include_dtg_identity | bool | includeDtgIdentity |
| include_trunk_group_identity_for_network_calls | bool | includeTrunkGroupIdentityForNetworkCalls |
| include_otg_identity_for_network_calls | bool | includeOtgIdentityForNetworkCalls |
| enable_network_address_identity | bool | enableNetworkAddressIdentity |
| allow_unscreened_calls | bool | allowUnscreenedCalls |
| allow_unscreened_emergency_calls | bool | allowUnscreenedEmergencyCalls |
| pilot_user_calling_line_identity_policy | str | pilotUserCallingLineIdentityPolicy |
| pilot_user_charge_number_policy | str | pilotUserChargeNumberPolicy |
| call_forwarding_always_action | str | callForwardingAlwaysAction Optional |
| call_forwarding_always_forward_address | str | callForwardingAlwaysForwardAddress Optional |
| call_forwarding_always_reroute_trunk_group_key | OCI.callForwardingAlwaysRerouteTrunkGroupKey | callForwardingAlwaysRerouteTrunkGroupKey Optional |
| peering_domain | str | peeringDomain Optional |
| route_to_peering_domain | bool | routeToPeeringDomain |
| prefix_enabled | bool | prefixEnabled |
| prefix | str | prefix Optional |
| stateful_rerouting_enabled | bool | statefulReroutingEnabled |
| send_continuous_options_message | bool | sendContinuousOptionsMessage |
| continuous_options_sending_interval_seconds | int | continuousOptionsSendingIntervalSeconds |
| failure_options_sending_interval_seconds | int | failureOptionsSendingIntervalSeconds |
| failure_threshold_counter | int | failureThresholdCounter |
| success_threshold_counter | int | successThresholdCounter |
| invite_failure_threshold_counter | int | inviteFailureThresholdCounter |
| invite_failure_threshold_window_seconds | int | inviteFailureThresholdWindowSeconds |
| pilot_user_calling_line_asserted_identity_policy | str | pilotUserCallingLineAssertedIdentityPolicy |
| use_system_calling_line_asserted_identity_policy | bool | useSystemCallingLineAssertedIdentityPolicy |
GroupTrunkGroupAddInstanceRequest19(OCIRequest)
Add a Trunk Group instance to a group.
The command will fail if enableNetworkAddressIdentity is set to true and administrator is not System/Provisioning level administrator.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by
GroupTrunkGroupAddInstanceRequest19sp1().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| pilot_user | OCI.pilotUser | pilotUser Optional |
| department | OCI.department | department Optional |
| access_device | OCI.accessDevice | accessDevice Optional |
| max_active_calls | int | maxActiveCalls |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_key | OCI.capacityExceededRerouteTrunkGroupKey | capacityExceededRerouteTrunkGroupKey Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_key | OCI.unreachableDestinationRerouteTrunkGroupKey | unreachableDestinationRerouteTrunkGroupKey Optional |
| invitation_timeout | int | invitationTimeout |
| require_authentication | bool | requireAuthentication |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
| hosted_user_id | List[str] | hostedUserId Optional |
| trunk_group_identity | str | trunkGroupIdentity Optional |
| otg_dtg_identity | str | otgDtgIdentity Optional |
| allow_termination_to_trunk_group_identity | bool | allowTerminationToTrunkGroupIdentity |
| allow_termination_to_dtg_identity | bool | allowTerminationToDtgIdentity |
| include_trunk_group_identity | bool | includeTrunkGroupIdentity |
| include_dtg_identity | bool | includeDtgIdentity |
| include_trunk_group_identity_for_network_calls | bool | includeTrunkGroupIdentityForNetworkCalls |
| include_otg_identity_for_network_calls | bool | includeOtgIdentityForNetworkCalls |
| enable_network_address_identity | bool | enableNetworkAddressIdentity |
| allow_unscreened_calls | bool | allowUnscreenedCalls |
| allow_unscreened_emergency_calls | bool | allowUnscreenedEmergencyCalls |
| pilot_user_calling_line_identity_policy | str | pilotUserCallingLineIdentityPolicy |
| pilot_user_charge_number_policy | str | pilotUserChargeNumberPolicy |
| call_forwarding_always_action | str | callForwardingAlwaysAction Optional |
| call_forwarding_always_forward_address | str | callForwardingAlwaysForwardAddress Optional |
| call_forwarding_always_reroute_trunk_group_key | OCI.callForwardingAlwaysRerouteTrunkGroupKey | callForwardingAlwaysRerouteTrunkGroupKey Optional |
| peering_domain | str | peeringDomain Optional |
| route_to_peering_domain | bool | routeToPeeringDomain |
| prefix_enabled | bool | prefixEnabled |
| prefix | str | prefix Optional |
| stateful_rerouting_enabled | bool | statefulReroutingEnabled |
| send_continuous_options_message | bool | sendContinuousOptionsMessage |
| continuous_options_sending_interval_seconds | int | continuousOptionsSendingIntervalSeconds |
| failure_options_sending_interval_seconds | int | failureOptionsSendingIntervalSeconds |
| failure_threshold_counter | int | failureThresholdCounter |
| success_threshold_counter | int | successThresholdCounter |
| invite_failure_threshold_counter | int | inviteFailureThresholdCounter |
| invite_failure_threshold_window_seconds | int | inviteFailureThresholdWindowSeconds |
| pilot_user_calling_line_asserted_identity_policy | str | pilotUserCallingLineAssertedIdentityPolicy |
| use_system_calling_line_asserted_identity_policy | bool | useSystemCallingLineAssertedIdentityPolicy |
| pilot_user_call_optimization_policy | str | pilotUserCallOptimizationPolicy |
GroupTrunkGroupAddInstanceRequest19sp1(OCIRequest)
Add a Trunk Group instance to a group.
The command will fail if enableNetworkAddressIdentity is set to true and administrator is not System/Provisioning level administrator.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
GroupTrunkGroupAddInstanceRequest20sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| pilot_user | OCI.pilotUser | pilotUser Optional |
| department | OCI.department | department Optional |
| access_device | OCI.accessDevice | accessDevice Optional |
| max_active_calls | int | maxActiveCalls |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_key | OCI.capacityExceededRerouteTrunkGroupKey | capacityExceededRerouteTrunkGroupKey Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_key | OCI.unreachableDestinationRerouteTrunkGroupKey | unreachableDestinationRerouteTrunkGroupKey Optional |
| invitation_timeout | int | invitationTimeout |
| require_authentication | bool | requireAuthentication |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
| hosted_user_id | List[str] | hostedUserId Optional |
| trunk_group_identity | str | trunkGroupIdentity Optional |
| otg_dtg_identity | str | otgDtgIdentity Optional |
| allow_termination_to_trunk_group_identity | bool | allowTerminationToTrunkGroupIdentity |
| allow_termination_to_dtg_identity | bool | allowTerminationToDtgIdentity |
| include_trunk_group_identity | bool | includeTrunkGroupIdentity |
| include_dtg_identity | bool | includeDtgIdentity |
| include_trunk_group_identity_for_network_calls | bool | includeTrunkGroupIdentityForNetworkCalls |
| include_otg_identity_for_network_calls | bool | includeOtgIdentityForNetworkCalls |
| enable_network_address_identity | bool | enableNetworkAddressIdentity |
| allow_unscreened_calls | bool | allowUnscreenedCalls |
| allow_unscreened_emergency_calls | bool | allowUnscreenedEmergencyCalls |
| pilot_user_calling_line_identity_for_external_calls_policy | str | pilotUserCallingLineIdentityForExternalCallsPolicy |
| pilot_user_charge_number_policy | str | pilotUserChargeNumberPolicy |
| call_forwarding_always_action | str | callForwardingAlwaysAction Optional |
| call_forwarding_always_forward_address | str | callForwardingAlwaysForwardAddress Optional |
| call_forwarding_always_reroute_trunk_group_key | OCI.callForwardingAlwaysRerouteTrunkGroupKey | callForwardingAlwaysRerouteTrunkGroupKey Optional |
| peering_domain | str | peeringDomain Optional |
| route_to_peering_domain | bool | routeToPeeringDomain |
| prefix_enabled | bool | prefixEnabled |
| prefix | str | prefix Optional |
| stateful_rerouting_enabled | bool | statefulReroutingEnabled |
| send_continuous_options_message | bool | sendContinuousOptionsMessage |
| continuous_options_sending_interval_seconds | int | continuousOptionsSendingIntervalSeconds |
| failure_options_sending_interval_seconds | int | failureOptionsSendingIntervalSeconds |
| failure_threshold_counter | int | failureThresholdCounter |
| success_threshold_counter | int | successThresholdCounter |
| invite_failure_threshold_counter | int | inviteFailureThresholdCounter |
| invite_failure_threshold_window_seconds | int | inviteFailureThresholdWindowSeconds |
| pilot_user_calling_line_asserted_identity_policy | str | pilotUserCallingLineAssertedIdentityPolicy |
| use_system_calling_line_asserted_identity_policy | bool | useSystemCallingLineAssertedIdentityPolicy |
| pilot_user_call_optimization_policy | str | pilotUserCallOptimizationPolicy |
| clid_source_for_screened_calls_policy | str | clidSourceForScreenedCallsPolicy |
| use_system_clid_source_for_screened_calls_policy | bool | useSystemCLIDSourceForScreenedCallsPolicy |
| user_lookup_policy | str | userLookupPolicy |
| use_system_user_lookup_policy | bool | useSystemUserLookupPolicy |
| pilot_user_calling_line_identity_for_emergency_calls_policy | str | pilotUserCallingLineIdentityForEmergencyCallsPolicy |
| pilot_user_network_class_of_service | str | pilotUserNetworkClassOfService Optional |
GroupTrunkGroupAddInstanceRequest20sp1(OCIRequest)
Add a Trunk Group instance to a group.
The command will fail if enableNetworkAddressIdentity is set to true and administrator is not System/Provisioning level administrator.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
GroupTrunkGroupAddInstanceRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| pilot_user | OCI.pilotUser | pilotUser Optional |
| department | OCI.department | department Optional |
| access_device | OCI.accessDevice | accessDevice Optional |
| max_active_calls | int | maxActiveCalls |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_key | OCI.capacityExceededRerouteTrunkGroupKey | capacityExceededRerouteTrunkGroupKey Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_key | OCI.unreachableDestinationRerouteTrunkGroupKey | unreachableDestinationRerouteTrunkGroupKey Optional |
| invitation_timeout | int | invitationTimeout |
| require_authentication | bool | requireAuthentication |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
| hosted_user_id | List[str] | hostedUserId Optional |
| trunk_group_identity | str | trunkGroupIdentity Optional |
| otg_dtg_identity | str | otgDtgIdentity Optional |
| allow_termination_to_trunk_group_identity | bool | allowTerminationToTrunkGroupIdentity |
| allow_termination_to_dtg_identity | bool | allowTerminationToDtgIdentity |
| include_trunk_group_identity | bool | includeTrunkGroupIdentity |
| include_dtg_identity | bool | includeDtgIdentity |
| include_trunk_group_identity_for_network_calls | bool | includeTrunkGroupIdentityForNetworkCalls |
| include_otg_identity_for_network_calls | bool | includeOtgIdentityForNetworkCalls |
| enable_network_address_identity | bool | enableNetworkAddressIdentity |
| allow_unscreened_calls | bool | allowUnscreenedCalls |
| allow_unscreened_emergency_calls | bool | allowUnscreenedEmergencyCalls |
| pilot_user_calling_line_identity_for_external_calls_policy | str | pilotUserCallingLineIdentityForExternalCallsPolicy |
| pilot_user_charge_number_policy | str | pilotUserChargeNumberPolicy |
| call_forwarding_always_action | str | callForwardingAlwaysAction Optional |
| call_forwarding_always_forward_address | str | callForwardingAlwaysForwardAddress Optional |
| call_forwarding_always_reroute_trunk_group_key | OCI.callForwardingAlwaysRerouteTrunkGroupKey | callForwardingAlwaysRerouteTrunkGroupKey Optional |
| peering_domain | str | peeringDomain Optional |
| route_to_peering_domain | bool | routeToPeeringDomain |
| prefix_enabled | bool | prefixEnabled |
| prefix | str | prefix Optional |
| stateful_rerouting_enabled | bool | statefulReroutingEnabled |
| send_continuous_options_message | bool | sendContinuousOptionsMessage |
| continuous_options_sending_interval_seconds | int | continuousOptionsSendingIntervalSeconds |
| failure_options_sending_interval_seconds | int | failureOptionsSendingIntervalSeconds |
| failure_threshold_counter | int | failureThresholdCounter |
| success_threshold_counter | int | successThresholdCounter |
| invite_failure_threshold_counter | int | inviteFailureThresholdCounter |
| invite_failure_threshold_window_seconds | int | inviteFailureThresholdWindowSeconds |
| pilot_user_calling_line_asserted_identity_policy | str | pilotUserCallingLineAssertedIdentityPolicy |
| use_system_calling_line_asserted_identity_policy | bool | useSystemCallingLineAssertedIdentityPolicy |
| pilot_user_call_optimization_policy | str | pilotUserCallOptimizationPolicy |
| clid_source_for_screened_calls_policy | str | clidSourceForScreenedCallsPolicy |
| use_system_clid_source_for_screened_calls_policy | bool | useSystemCLIDSourceForScreenedCallsPolicy |
| user_lookup_policy | str | userLookupPolicy |
| use_system_user_lookup_policy | bool | useSystemUserLookupPolicy |
| pilot_user_calling_line_identity_for_emergency_calls_policy | str | pilotUserCallingLineIdentityForEmergencyCallsPolicy |
| pilot_user_network_class_of_service | str | pilotUserNetworkClassOfService Optional |
GroupTrunkGroupAddInstanceRequest21(OCIRequest)
Add a Trunk Group instance to a group.
The command will fail if enableNetworkAddressIdentity is set to true and administrator is not System/Provisioning level administrator.
The response is either a SuccessResponse() or an ErrorResponse(). Following
attributes are only used in IMS mode: implicitRegistrationSetSupportPolicy
useSystemImplicitRegistrationSetSupportPolicy
sipIdentityForPilotAndProxyTrunkModesPolicy
useSystemSIPIdentityForPilotAndProxyTrunkModesPolicy Replaced by:
GroupTrunkGroupAddInstanceRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| pilot_user | OCI.pilotUser | pilotUser Optional |
| department | OCI.department | department Optional |
| access_device | OCI.accessDevice | accessDevice Optional |
| max_active_calls | int | maxActiveCalls |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_key | OCI.capacityExceededRerouteTrunkGroupKey | capacityExceededRerouteTrunkGroupKey Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_key | OCI.unreachableDestinationRerouteTrunkGroupKey | unreachableDestinationRerouteTrunkGroupKey Optional |
| invitation_timeout | int | invitationTimeout |
| require_authentication | bool | requireAuthentication |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
| hosted_user_id | List[str] | hostedUserId Optional |
| trunk_group_identity | str | trunkGroupIdentity Optional |
| otg_dtg_identity | str | otgDtgIdentity Optional |
| allow_termination_to_trunk_group_identity | bool | allowTerminationToTrunkGroupIdentity |
| allow_termination_to_dtg_identity | bool | allowTerminationToDtgIdentity |
| include_trunk_group_identity | bool | includeTrunkGroupIdentity |
| include_dtg_identity | bool | includeDtgIdentity |
| include_trunk_group_identity_for_network_calls | bool | includeTrunkGroupIdentityForNetworkCalls |
| include_otg_identity_for_network_calls | bool | includeOtgIdentityForNetworkCalls |
| enable_network_address_identity | bool | enableNetworkAddressIdentity |
| allow_unscreened_calls | bool | allowUnscreenedCalls |
| allow_unscreened_emergency_calls | bool | allowUnscreenedEmergencyCalls |
| pilot_user_calling_line_identity_for_external_calls_policy | str | pilotUserCallingLineIdentityForExternalCallsPolicy |
| pilot_user_charge_number_policy | str | pilotUserChargeNumberPolicy |
| call_forwarding_always_action | str | callForwardingAlwaysAction Optional |
| call_forwarding_always_forward_address | str | callForwardingAlwaysForwardAddress Optional |
| call_forwarding_always_reroute_trunk_group_key | OCI.callForwardingAlwaysRerouteTrunkGroupKey | callForwardingAlwaysRerouteTrunkGroupKey Optional |
| peering_domain | str | peeringDomain Optional |
| route_to_peering_domain | bool | routeToPeeringDomain |
| prefix_enabled | bool | prefixEnabled |
| prefix | str | prefix Optional |
| stateful_rerouting_enabled | bool | statefulReroutingEnabled |
| send_continuous_options_message | bool | sendContinuousOptionsMessage |
| continuous_options_sending_interval_seconds | int | continuousOptionsSendingIntervalSeconds |
| failure_options_sending_interval_seconds | int | failureOptionsSendingIntervalSeconds |
| failure_threshold_counter | int | failureThresholdCounter |
| success_threshold_counter | int | successThresholdCounter |
| invite_failure_threshold_counter | int | inviteFailureThresholdCounter |
| invite_failure_threshold_window_seconds | int | inviteFailureThresholdWindowSeconds |
| pilot_user_calling_line_asserted_identity_policy | str | pilotUserCallingLineAssertedIdentityPolicy |
| use_system_calling_line_asserted_identity_policy | bool | useSystemCallingLineAssertedIdentityPolicy |
| pilot_user_call_optimization_policy | str | pilotUserCallOptimizationPolicy |
| clid_source_for_screened_calls_policy | str | clidSourceForScreenedCallsPolicy |
| use_system_clid_source_for_screened_calls_policy | bool | useSystemCLIDSourceForScreenedCallsPolicy |
| user_lookup_policy | str | userLookupPolicy |
| use_system_user_lookup_policy | bool | useSystemUserLookupPolicy |
| pilot_user_calling_line_identity_for_emergency_calls_policy | str | pilotUserCallingLineIdentityForEmergencyCallsPolicy |
| pilot_user_network_class_of_service | str | pilotUserNetworkClassOfService Optional |
| implicit_registration_set_support_policy | str | implicitRegistrationSetSupportPolicy |
| use_system_implicit_registration_set_support_policy | bool | useSystemImplicitRegistrationSetSupportPolicy |
| sip_identity_for_pilot_and_proxy_trunk_modes_policy | str | sipIdentityForPilotAndProxyTrunkModesPolicy |
| use_system_sip_identity_for_pilot_and_proxy_trunk_modes_policy | bool | useSystemSIPIdentityForPilotAndProxyTrunkModesPolicy |
| use_system_support_connected_identity_policy | bool | useSystemSupportConnectedIdentityPolicy |
| support_connected_identity_policy | str | supportConnectedIdentityPolicy |
GroupTrunkGroupAddInstanceRequest22(OCIRequest)
Add a Trunk Group instance to a group.
The command will fail if enableNetworkAddressIdentity is set to true and administrator is not System/Provisioning level administrator.
The response is either a SuccessResponse() or an ErrorResponse(). Following
attributes are only used in IMS mode: implicitRegistrationSetSupportPolicy
useSystemImplicitRegistrationSetSupportPolicy
sipIdentityForPilotAndProxyTrunkModesPolicy
useSystemSIPIdentityForPilotAndProxyTrunkModesPolicy
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| pilot_user | OCI.pilotUser | pilotUser Optional |
| department | OCI.department | department Optional |
| access_device | OCI.accessDevice | accessDevice Optional |
| max_active_calls | int | maxActiveCalls |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_key | OCI.capacityExceededRerouteTrunkGroupKey | capacityExceededRerouteTrunkGroupKey Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_key | OCI.unreachableDestinationRerouteTrunkGroupKey | unreachableDestinationRerouteTrunkGroupKey Optional |
| invitation_timeout | int | invitationTimeout |
| require_authentication | bool | requireAuthentication |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
| hosted_user_id | List[str] | hostedUserId Optional |
| trunk_group_identity | str | trunkGroupIdentity Optional |
| otg_dtg_identity | str | otgDtgIdentity Optional |
| allow_termination_to_trunk_group_identity | bool | allowTerminationToTrunkGroupIdentity |
| allow_termination_to_dtg_identity | bool | allowTerminationToDtgIdentity |
| include_trunk_group_identity | bool | includeTrunkGroupIdentity |
| include_dtg_identity | bool | includeDtgIdentity |
| include_trunk_group_identity_for_network_calls | bool | includeTrunkGroupIdentityForNetworkCalls |
| include_otg_identity_for_network_calls | bool | includeOtgIdentityForNetworkCalls |
| enable_network_address_identity | bool | enableNetworkAddressIdentity |
| allow_unscreened_calls | bool | allowUnscreenedCalls |
| allow_unscreened_emergency_calls | bool | allowUnscreenedEmergencyCalls |
| pilot_user_calling_line_identity_for_external_calls_policy | str | pilotUserCallingLineIdentityForExternalCallsPolicy |
| pilot_user_charge_number_policy | str | pilotUserChargeNumberPolicy |
| call_forwarding_always_action | str | callForwardingAlwaysAction Optional |
| call_forwarding_always_forward_address | str | callForwardingAlwaysForwardAddress Optional |
| call_forwarding_always_reroute_trunk_group_key | OCI.callForwardingAlwaysRerouteTrunkGroupKey | callForwardingAlwaysRerouteTrunkGroupKey Optional |
| peering_domain | str | peeringDomain Optional |
| route_to_peering_domain | bool | routeToPeeringDomain |
| prefix_enabled | bool | prefixEnabled |
| prefix | str | prefix Optional |
| stateful_rerouting_enabled | bool | statefulReroutingEnabled |
| send_continuous_options_message | bool | sendContinuousOptionsMessage |
| continuous_options_sending_interval_seconds | int | continuousOptionsSendingIntervalSeconds |
| failure_options_sending_interval_seconds | int | failureOptionsSendingIntervalSeconds |
| failure_threshold_counter | int | failureThresholdCounter |
| success_threshold_counter | int | successThresholdCounter |
| invite_failure_threshold_counter | int | inviteFailureThresholdCounter |
| invite_failure_threshold_window_seconds | int | inviteFailureThresholdWindowSeconds |
| pilot_user_calling_line_asserted_identity_policy | str | pilotUserCallingLineAssertedIdentityPolicy |
| use_system_calling_line_asserted_identity_policy | bool | useSystemCallingLineAssertedIdentityPolicy |
| pilot_user_call_optimization_policy | str | pilotUserCallOptimizationPolicy |
| clid_source_for_screened_calls_policy | str | clidSourceForScreenedCallsPolicy |
| use_system_clid_source_for_screened_calls_policy | bool | useSystemCLIDSourceForScreenedCallsPolicy |
| user_lookup_policy | str | userLookupPolicy |
| use_system_user_lookup_policy | bool | useSystemUserLookupPolicy |
| pilot_user_calling_line_identity_for_emergency_calls_policy | str | pilotUserCallingLineIdentityForEmergencyCallsPolicy |
| pilot_user_network_class_of_service | str | pilotUserNetworkClassOfService Optional |
| implicit_registration_set_support_policy | str | implicitRegistrationSetSupportPolicy |
| use_system_implicit_registration_set_support_policy | bool | useSystemImplicitRegistrationSetSupportPolicy |
| sip_identity_for_pilot_and_proxy_trunk_modes_policy | str | sipIdentityForPilotAndProxyTrunkModesPolicy |
| use_system_sip_identity_for_pilot_and_proxy_trunk_modes_policy | bool | useSystemSIPIdentityForPilotAndProxyTrunkModesPolicy |
| use_system_support_connected_identity_policy | bool | useSystemSupportConnectedIdentityPolicy |
| support_connected_identity_policy | str | supportConnectedIdentityPolicy |
GroupTrunkGroupGetAvailableHostedUserListRequest(OCIRequest)
Get a list of hosted users that can be assigned to a Trunk Group.
The response is either GroupTrunkGroupGetAvailableHostedUserListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupTrunkGroupGetInstanceUserListRequest(OCIRequest)
Get a list of user's on a Trunk Group Instance.
The response is either a GroupTrunkGroupGetInstanceUserListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
GroupTrunkGroupGetInstanceUserListRequest14sp4(OCIRequest)
Get a list of user's on a Trunk Group Instance.
The response is either a GroupTrunkGroupGetInstanceUserListResponse14sp4() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| trunk_group_key | OCI.trunkGroupKey | trunkGroupKey |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
GroupTrunkGroupModifyInstanceRequest14(OCIRequest)
Modify a Trunk Group Instance in a group.
The publicUserIdentity in the ServiceInstanceModifyProfile is not allowed for trunk groups.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| max_active_calls | int | maxActiveCalls Optional |
| max_incoming_calls | int | maxIncomingCalls Optional |
| max_outgoing_calls | int | maxOutgoingCalls Optional |
| enable_bursting | bool | enableBursting Optional |
| bursting_max_active_calls | int | burstingMaxActiveCalls Optional |
| bursting_max_incoming_calls | int | burstingMaxIncomingCalls Optional |
| bursting_max_outgoing_calls | int | burstingMaxOutgoingCalls Optional |
| capacity_exceeded_action | str | capacityExceededAction Optional |
| capacity_exceeded_forward_address | str | capacityExceededForwardAddress Optional |
| capacity_exceeded_reroute_trunk_group_id | str | capacityExceededRerouteTrunkGroupId Optional |
| capacity_exceeded_trap_initial_calls | int | capacityExceededTrapInitialCalls Optional |
| capacity_exceeded_trap_offset_calls | int | capacityExceededTrapOffsetCalls Optional |
| unreachable_destination_action | str | unreachableDestinationAction Optional |
| unreachable_destination_forward_address | str | unreachableDestinationForwardAddress Optional |
| unreachable_destination_reroute_trunk_group_id | str | unreachableDestinationRerouteTrunkGroupId Optional |
| unreachable_destination_trap_initial_calls | int | unreachableDestinationTrapInitialCalls Optional |
| unreachable_destination_trap_offset_calls | int | unreachableDestinationTrapOffsetCalls Optional |
| invitation_timeout | int | invitationTimeout Optional |
| require_authentication | bool | requireAuthentication Optional |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| sip_authentication_password | str | sipAuthenticationPassword Optional |
GroupUserCallForwardingSettingsGetListRequest(OCIRequest)
Get a list of users and the service settings for a Call Forwarding service.
The response is either GroupUserCallForwardingSettingsGetListResponse() or
ErrorResponse(). By default, virtual users and non-virtual users that match the
selected search criteria are included in the response when "includeVirtualUsers" is
present; otherwise, if "includeVirtualUsers" is absent, then only non-virtual users
are returned. The search can be performed using multiple criteria. If search
criteria is specified, only the users matching all of the specified search criteria
are included in the response. If no search criteria is specified, all results are
returned.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| call_forwarding_service | str | callForwardingService |
| response_paging_control | OCI.responsePagingControl | responsePagingControl |
| sort_by_user_last_name | OCI.sortByUserLastName | sortByUserLastName Optional |
| sort_by_user_first_name | OCI.sortByUserFirstName | sortByUserFirstName Optional |
| sort_by_user_department | OCI.sortByUserDepartment | sortByUserDepartment Optional |
| sort_by_dn | OCI.sortByDn | sortByDn Optional |
| sort_by_extension | OCI.sortByExtension | sortByExtension Optional |
| sort_by_forwarded_to_number | OCI.sortByForwardedToNumber | sortByForwardedToNumber Optional |
| include_virtual_users | bool | includeVirtualUsers Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_in_trunk_group | OCI.searchCriteriaExactUserInTrunkGroup | searchCriteriaExactUserInTrunkGroup Optional |
| search_criteria_forwarded_to_number | List[OCI.searchCriteriaForwardedToNumber] | searchCriteriaForwardedToNumber Optional |
GroupUserCallWaitingSettingsGetListRequest(OCIRequest)
Get a list of users and the Call Waiting service status (active or not active).
The response is either GroupUserCallWaitingSettingsGetListResponse() or
ErrorResponse(). By default, virtual users and non-virtual users that match the
selected search criteria are included in the response when "includeVirtualUsers" is
present; otherwise, if "includeVirtualUsers" is absent, then only non-virtual users
are returned. The search can be performed using multiple criteria. If search
criteria is specified, only the users matching all of the specified search criteria
are included in the response. If no search criteria is specified, all results are
returned.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl |
| sort_by_user_last_name | OCI.sortByUserLastName | sortByUserLastName Optional |
| sort_by_user_first_name | OCI.sortByUserFirstName | sortByUserFirstName Optional |
| sort_by_user_department | OCI.sortByUserDepartment | sortByUserDepartment Optional |
| sort_by_dn | OCI.sortByDn | sortByDn Optional |
| sort_by_extension | OCI.sortByExtension | sortByExtension Optional |
| sort_by_service_status | OCI.sortByServiceStatus | sortByServiceStatus Optional |
| include_virtual_users | bool | includeVirtualUsers Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_in_trunk_group | OCI.searchCriteriaExactUserInTrunkGroup | searchCriteriaExactUserInTrunkGroup Optional |
| search_criteria_service_status | OCI.searchCriteriaServiceStatus | searchCriteriaServiceStatus Optional |
GroupUserCallingPlanSettingsGetListRequest(OCIRequest)
Get a list of users and the default or custom calling plan setting.
The response is either GroupUserCallingPlanSettingsGetListResponse() or
ErrorResponse(). By default, virtual users and non-virtual users that match the
selected search criteria are included in the response when "includeVirtualUsers" is
present; otherwise, if "includeVirtualUsers" is absent, then only non-virtual users
are returned. The search can be performed using multiple criteria. If search
criteria is specified, only the users matching all of the specified search criteria
are included in the response. If no search criteria is specified, all results are
returned.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| calling_plan_service | str | callingPlanService |
| response_paging_control | OCI.responsePagingControl | responsePagingControl |
| sort_by_user_last_name | OCI.sortByUserLastName | sortByUserLastName Optional |
| sort_by_user_first_name | OCI.sortByUserFirstName | sortByUserFirstName Optional |
| sort_by_user_department | OCI.sortByUserDepartment | sortByUserDepartment Optional |
| sort_by_dn | OCI.sortByDn | sortByDn Optional |
| sort_by_extension | OCI.sortByExtension | sortByExtension Optional |
| include_virtual_users | bool | includeVirtualUsers Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_in_trunk_group | OCI.searchCriteriaExactUserInTrunkGroup | searchCriteriaExactUserInTrunkGroup Optional |
GroupUserHotelingGuestSettingsGetListRequest(OCIRequest)
Get a list of users and their Hoteling Guest service status (active or not active).
The response is either GroupUserHotelingGuestSettingsGetListResponse() or
ErrorResponse(). By default, virtual users and non-virtual users that match the
selected search criteria are included in the response when "includeVirtualUsers" is
present; otherwise, if "includeVirtualUsers" is absent, then only non-virtual users
are returned. The search can be performed using multiple criteria. If search
criteria is specified, only the users matching all of the specified search criteria
are included in the response. If no search criteria is specified, all results are
returned.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl |
| sort_by_user_last_name | OCI.sortByUserLastName | sortByUserLastName Optional |
| sort_by_user_first_name | OCI.sortByUserFirstName | sortByUserFirstName Optional |
| sort_by_user_department | OCI.sortByUserDepartment | sortByUserDepartment Optional |
| sort_by_dn | OCI.sortByDn | sortByDn Optional |
| sort_by_extension | OCI.sortByExtension | sortByExtension Optional |
| sort_by_service_status | OCI.sortByServiceStatus | sortByServiceStatus Optional |
| include_virtual_users | bool | includeVirtualUsers Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_in_trunk_group | OCI.searchCriteriaExactUserInTrunkGroup | searchCriteriaExactUserInTrunkGroup Optional |
GroupVirtualOnNetEnterpriseExtensionsAddUserRequest(OCIRequest)
Adds Virtual On-Net users to a Group.
It is possible to add either: a single user, or a list of users, or a range of users, or any combination thereof.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| virtual_on_net_user | List[OCI.virtualOnNetUser] | virtualOnNetUser Optional |
| virtual_on_net_user_range | OCI.virtualOnNetUserRange | virtualOnNetUserRange Optional |
GroupVirtualOnNetEnterpriseExtensionsGetUserListRequest(OCIRequest)
Request the list of Virtual On-Net users in a Group.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either a GroupVirtualOnNetEnterpriseExtensionsGetUserListResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_virtual_on_net_call_type_name | OCI.searchCriteriaExactVirtualOnNetCallTypeName | searchCriteriaExactVirtualOnNetCallTypeName Optional |
GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest(OCIRequest)
Request to modify the group's voice messaging settings and voice portal branding settings.
If UnassignPhoneNumbersLevel is set to 'Group', the user's primary phone number, fax
number and any alternate numbers, will be un-assigned from the group if the command is
executed by a service provider administrator or above. When set to 'Service
Provider', they will be un-assigned from the group and service provider if the command
is executed by a provisioning administrator or above. When omitted, the number(s)
will be left assigned to the group. An ErrorResponse() will be returned if any
number cannot be unassigned because of insufficient privilege.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| unassign_phone_numbers | str | unassignPhoneNumbers Optional |
| add_phone_number_to_group | bool | addPhoneNumberToGroup Optional |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| is_active | bool | isActive Optional |
| enable_extended_scope | bool | enableExtendedScope Optional |
| allow_identification_by_phone_number_or_voice_mail_aliases_on_login | bool | allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin Optional |
| use_voice_portal_wizard | bool | useVoicePortalWizard Optional |
| voice_portal_external_routing_scope | str | voicePortalExternalRoutingScope Optional |
| use_external_routing | bool | useExternalRouting Optional |
| external_routing_address | str | externalRoutingAddress Optional |
| home_zone_name | str | homeZoneName Optional |
| network_class_of_service | str | networkClassOfService Optional |
| voice_portal_greeting_selection | str | voicePortalGreetingSelection Optional |
| voice_portal_greeting_file | OCI.voicePortalGreetingFile | voicePortalGreetingFile Optional |
| voice_messaging_greeting_selection | str | voiceMessagingGreetingSelection Optional |
| voice_messaging_greeting_file | OCI.voiceMessagingGreetingFile | voiceMessagingGreetingFile Optional |
GroupVoiceMessagingGroupModifyVoicePortalRequest(OCIRequest)
Request to modify the group voice portal information for a voice messaging group.
The following elements are only used in AS data mode: networkClassOfService The following elements are only used in AS data mode and ignored in XS data mode: expressMode
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| is_active | bool | isActive Optional |
| enable_extended_scope | bool | enableExtendedScope Optional |
| allow_identification_by_phone_number_or_voice_mail_aliases_on_login | bool | allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin Optional |
| use_voice_portal_wizard | bool | useVoicePortalWizard Optional |
| voice_portal_external_routing_scope | str | voicePortalExternalRoutingScope Optional |
| use_external_routing | bool | useExternalRouting Optional |
| external_routing_address | str | externalRoutingAddress Optional |
| home_zone_name | str | homeZoneName Optional |
| network_class_of_service | str | networkClassOfService Optional |
| express_mode | bool | expressMode Optional |
GroupVoiceXmlAddInstanceRequest(OCIRequest)
Add a VoiceXML instance to a group.
The domain is required in the serviceUserId. For a valid voiceXml instance to work properly, a device with Static Registration is expected with a valid contact. If not set, The webexMeetingCallback element will be set to "false". The following elements are only used in AS data mode and ignored in XS data mode: webexMeetingCallback
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| network_class_of_service | str | networkClassOfService Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| webex_meeting_callback | bool | webexMeetingCallback Optional |
GroupVoiceXmlModifyInstanceRequest(OCIRequest)
Request to modify a VoiceXML instance.
For a valid voiceXml instance to work properly, a device with Static Registration is expected with a valid contact. The following elements are only used in AS data mode and ignored in XS data mode: webexMeetingCallback
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| network_class_of_service | str | networkClassOfService Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| webex_meeting_callback | bool | webexMeetingCallback Optional |
GroupXsiPolicyProfileGetAssignedUserListRequest(OCIRequest)
Get a list of user within a group that have a given user Xsi policy profile assigned.
The response is either a GroupXsiPolicyProfileGetAssignedUserListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| xsi_policy_profile | OCI.xsiPolicyProfile | xsiPolicyProfile |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
ResellerGetListRequest(OCIRequest)
Request a list of resellers in the system.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either a ResellerGetListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_reseller_id | List[OCI.searchCriteriaResellerId] | searchCriteriaResellerId Optional |
| search_criteria_reseller_name | List[OCI.searchCriteriaResellerName] | searchCriteriaResellerName Optional |
ResellerNetworkClassOfServiceGetAssignedServiceProviderListRequest(OCIRequest)
Get a list of service provider/enterprises within a reseller that have a given Network Class of Service assigned.
The response is either a
ResellerNetworkClassOfServiceGetAssignedServiceProviderListResponse() or an
ErorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| network_class_of_service | str | networkClassOfService |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_service_provider_name | List[OCI.searchCriteriaServiceProviderName] | searchCriteriaServiceProviderName Optional |
ResellerXsiPolicyProfileGetAssignedServiceProviderListRequest(OCIRequest)
Get a list of service provider/enterprises within a reseller that have a given Service provider Xsi policy profile assigned.
The response is either a
ResellerXsiPolichProfileGetAssignedServiceProviderListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId |
| xsi_policy_profile | OCI.xsiPolicyProfile | xsiPolicyProfile |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_service_provider_name | List[OCI.searchCriteriaServiceProviderName] | searchCriteriaServiceProviderName Optional |
| search_criteria_exact_organization_type | OCI.searchCriteriaExactOrganizationType | searchCriteriaExactOrganizationType Optional |
ServiceProviderAccessDeviceGetListRequest(OCIRequest)
Requests the list of access devices in a service provider.
The following elements are only used in AS data mode and ignored in XS data mode: serviceProviderExternalId
The response is either ServiceProviderAccessDeviceGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| service_provider_external_id | str | serviceProviderExternalId Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_device_name | List[OCI.searchCriteriaDeviceName] | searchCriteriaDeviceName Optional |
| search_criteria_device_mac_address | List[OCI.searchCriteriaDeviceMACAddress] | searchCriteriaDeviceMACAddress Optional |
| search_criteria_device_net_address | List[OCI.searchCriteriaDeviceNetAddress] | searchCriteriaDeviceNetAddress Optional |
| search_criteria_exact_device_type | OCI.searchCriteriaExactDeviceType | searchCriteriaExactDeviceType Optional |
| search_criteria_access_device_version | List[OCI.searchCriteriaAccessDeviceVersion] | searchCriteriaAccessDeviceVersion Optional |
ServiceProviderAccessDeviceGetPagedSortedListRequest(OCIRequest)
Requests the list of service provider level access devices.
The response is either ServiceProviderAccessDeviceGetPagedSortedListResponse() or
ErrorResponse(). If no sortOrder is included, the response is sorted by Device Name
ascending by default. If the responsePagingControl element is not provided, the
paging startIndex will be set to 1 by default, and the responsePageSize will be set to
the maximum responsePageSize by default. Multiple search criteria are logically ANDed
together unless the searchCriteriaModeOr option is included. Then the search criteria
are logically ORed together. The getVisualDeviceManagementAPIDevicesOnly element can
only be set when CloudPBX is licenced. If the getVisualDeviceManagementAPIDevicesOnly
element is not set, all devices are returned with Visual Device Management API flag
set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true,
only SIP devices supporting Visual Device Management API are returned. If the
getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are
returned with their current Visual Device Management API flag value.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_by_device_name | OCI.sortByDeviceName | sortByDeviceName Optional |
| sort_by_device_type | OCI.sortByDeviceType | sortByDeviceType Optional |
| sort_by_device_net_address | OCI.sortByDeviceNetAddress | sortByDeviceNetAddress Optional |
| sort_by_device_mac_address | OCI.sortByDeviceMACAddress | sortByDeviceMACAddress Optional |
| search_criteria_device_name | List[OCI.searchCriteriaDeviceName] | searchCriteriaDeviceName Optional |
| search_criteria_device_mac_address | List[OCI.searchCriteriaDeviceMACAddress] | searchCriteriaDeviceMACAddress Optional |
| search_criteria_device_net_address | List[OCI.searchCriteriaDeviceNetAddress] | searchCriteriaDeviceNetAddress Optional |
| search_criteria_exact_device_type | List[OCI.searchCriteriaExactDeviceType] | searchCriteriaExactDeviceType Optional |
| search_criteria_access_device_version | List[OCI.searchCriteriaAccessDeviceVersion] | searchCriteriaAccessDeviceVersion Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
| get_visual_device_management_api_devices_only | bool | getVisualDeviceManagementAPIDevicesOnly Optional |
ServiceProviderAccessDeviceGetUserListRequest(OCIRequest)
Requests the list of users on a specified device.
The response is either ServiceProviderAccessDeviceGetResponse() or
ErrorResponse(). The following elements are only used in XS data mode and ignored in
AS data mode: searchCriteriaAccessDeviceEndpointPrivateIdentity Replaced by:
ServiceProviderAccessDeviceGetUserListRequest21sp1() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_line_port_user_part | List[OCI.searchCriteriaLinePortUserPart] | searchCriteriaLinePortUserPart Optional |
| search_criteria_line_port_domain | List[OCI.searchCriteriaLinePortDomain] | searchCriteriaLinePortDomain Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_exact_endpoint_type | OCI.searchCriteriaExactEndpointType | searchCriteriaExactEndpointType Optional |
| search_criteria_exact_user_type | OCI.searchCriteriaExactUserType | searchCriteriaExactUserType Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_port_number | OCI.searchCriteriaExactPortNumber | searchCriteriaExactPortNumber Optional |
| search_criteria_access_device_endpoint_private_identity | List[OCI.searchCriteriaAccessDeviceEndpointPrivateIdentity] | searchCriteriaAccessDeviceEndpointPrivateIdentity Optional |
ServiceProviderAccessDeviceGetUserListRequest21sp1(OCIRequest)
Requests the list of users on a specified device.
The response is either ServiceProviderAccessDeviceGetUserListResponse21sp1() or
ErrorResponse(). The following elements are only used in XS data mode and ignored in
AS data mode: searchCriteriaAccessDeviceEndpointPrivateIdentity
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| device_name | str | deviceName |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_line_port_user_part | List[OCI.searchCriteriaLinePortUserPart] | searchCriteriaLinePortUserPart Optional |
| search_criteria_line_port_domain | List[OCI.searchCriteriaLinePortDomain] | searchCriteriaLinePortDomain Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_exact_endpoint_type | OCI.searchCriteriaExactEndpointType | searchCriteriaExactEndpointType Optional |
| search_criteria_exact_user_type | OCI.searchCriteriaExactUserType | searchCriteriaExactUserType Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_port_number | OCI.searchCriteriaExactPortNumber | searchCriteriaExactPortNumber Optional |
| search_criteria_access_device_endpoint_private_identity | List[OCI.searchCriteriaAccessDeviceEndpointPrivateIdentity] | searchCriteriaAccessDeviceEndpointPrivateIdentity Optional |
| search_criteria_user_hotline_contact | List[OCI.searchCriteriaUserHotlineContact] | searchCriteriaUserHotlineContact Optional |
ServiceProviderAlternateUserIdGetListRequest(OCIRequest)
Request to get the list of alternate user ids in the service provider/enterprise.
The response is either ServiceProviderAlternateUserIdGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_alternate_user_id | List[OCI.searchCriteriaAlternateUserId] | searchCriteriaAlternateUserId Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest(OCIRequest)
Request a summary table of all Mobile Subscriber Directory Numbers in a service provider.
This command is applicable only for service providers and will fail for enterprises.
The response is either
ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListResponse()
or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_mobile_subscriber_directory_number | List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] | searchCriteriaMobileSubscriberDirectoryNumber Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_exact_mobile_network | OCI.searchCriteriaExactMobileNetwork | searchCriteriaExactMobileNetwork Optional |
ServiceProviderCommunicationBarringDigitPatternCriteriaGetPatternListRequest(OCIRequest)
Get an existing Digit Pattern Criteria.
The response is either a
ServiceProviderCommunicationBarringDigitPatternCriteriaGetPatternListResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_digit_pattern | List[OCI.searchCriteriaDigitPattern] | searchCriteriaDigitPattern Optional |
ServiceProviderCommunicationBarringProfileGetAssignedGroupListRequest(OCIRequest)
Get a list of groups within a service provider that have a given Communication Barring Profile assigned.
The response is either a
ServiceProviderCommunicationBarringProfileGetAssignedGroupListResponse() or an
ErorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| profile | str | profile |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_group_name | List[OCI.searchCriteriaGroupName] | searchCriteriaGroupName Optional |
ServiceProviderCommunicationBarringProfileModifyRequest(OCIRequest)
Modify an existing Communication Barring Profile.
The priorities for OriginatingRules, RedirectingRules, CallMeNowRules and IncomingRules are requantized to consecutive integers as part of the modify.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: callMeNowDefaultAction
callMeNowDefaultCallTimeout callMeNowRule applyToAttendedCallTransfers
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| originating_default_action | str | originatingDefaultAction Optional |
| originating_default_treatment_id | str | originatingDefaultTreatmentId Optional |
| originating_default_transfer_number | str | originatingDefaultTransferNumber Optional |
| originating_default_call_timeout | int | originatingDefaultCallTimeout Optional |
| originating_rule | OCI.originatingRule | originatingRule Optional |
| redirecting_default_action | str | redirectingDefaultAction Optional |
| redirecting_default_call_timeout | int | redirectingDefaultCallTimeout Optional |
| redirecting_rule | OCI.redirectingRule | redirectingRule Optional |
| call_me_now_default_action | str | callMeNowDefaultAction Optional |
| call_me_now_default_call_timeout | int | callMeNowDefaultCallTimeout Optional |
| call_me_now_rule | OCI.callMeNowRule | callMeNowRule Optional |
| incoming_default_action | str | incomingDefaultAction Optional |
| incoming_default_call_timeout | int | incomingDefaultCallTimeout Optional |
| incoming_rule | OCI.incomingRule | incomingRule Optional |
| become_default | bool | becomeDefault Optional |
| apply_to_attended_call_transfers | bool | applyToAttendedCallTransfers Optional |
ServiceProviderConsolidatedAddRequest(OCIRequest)
Add a service provider or enterprise.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
serviceProviderExtenalId provisioningSliceId The following elements are ignored in AS
and XS data mode: servicePolicy, callProcessingSliceId, subscriberPartition. Only
Provisioning admin and above can change the preferredDataCenter and
provisioningSliceId. The following data elements are only used in AS data mode:
resellerId resellerName The following elements are optional for the service provider.
If the elements are included, they will be either added, authorized, or modified on
the service provider. Should any of the following elements be rejected to due
existing system settings, the service provider will not be added and the response will
be an ErrorResponse(): domain admin groupServiceAuthorization
userServiceAuthorization servicePack phoneNumber dnRange routingProfile
meetMeConferencingAllocatedPorts trunkGroupMaxActiveCalls
trunkGroupBurstingMaxActiveCalls voiceMessagingGroupSettings
voiceMessagingVoicePortalScope When a group or user service is included that is not
activated or is not licensed, the response will be an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| is_enterprise | bool | isEnterprise Optional |
| use_custom_routing_profile | bool | useCustomRoutingProfile Optional |
| service_provider_id | str | serviceProviderId Optional |
| service_provider_external_id | str | serviceProviderExternalId Optional |
| default_domain | str | defaultDomain |
| service_provider_name | str | serviceProviderName Optional |
| support_email | str | supportEmail Optional |
| contact | OCI.contact | contact Optional |
| address | OCI.address | address Optional |
| service_policy | str | servicePolicy Optional |
| call_processing_slice_id | str | callProcessingSliceId Optional |
| provisioning_slice_id | str | provisioningSliceId Optional |
| subscriber_partition | str | subscriberPartition Optional |
| preferred_data_center | str | preferredDataCenter Optional |
| reseller_id | str | resellerId Optional |
| reseller_name | str | resellerName Optional |
| domain | List[str] | domain Optional |
| admin | List[OCI.admin] | admin Optional |
| group_service_authorization | List[OCI.groupServiceAuthorization] | groupServiceAuthorization Optional |
| user_service_authorization | List[OCI.userServiceAuthorization] | userServiceAuthorization Optional |
| service_pack | List[OCI.servicePack] | servicePack Optional |
| phone_number | List[str] | phoneNumber Optional |
| dn_range | List[OCI.dnRange] | dnRange Optional |
| routing_profile | str | routingProfile Optional |
| meet_me_conferencing_allocated_ports | OCI.meetMeConferencingAllocatedPorts | meetMeConferencingAllocatedPorts Optional |
| trunk_group_max_active_calls | OCI.trunkGroupMaxActiveCalls | trunkGroupMaxActiveCalls Optional |
| trunk_group_bursting_max_active_calls | OCI.trunkGroupBurstingMaxActiveCalls | trunkGroupBurstingMaxActiveCalls Optional |
| voice_messaging_group_settings | OCI.voiceMessagingGroupSettings | voiceMessagingGroupSettings Optional |
| voice_messaging_group_voice_portal_scope | str | voiceMessagingGroupVoicePortalScope Optional |
ServiceProviderDeviceManagementEventGetListRequest(OCIRequest)
Request device management's events for a specific queue.
It is possible to restrict the number of rows returned using responseSizeLimit. If eventQueueType is not specified, the events from all the event queues are returned.
The response is either a ServiceProviderDeviceManagementEventGetListResponse() or an
ErrorResponse(). Deprecated by:
ServiceProviderDeviceManagementEventGetListRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| event_queue_type | str | eventQueueType Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_exact_device_management_event_status_in_progress_or_pending | OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending | searchCriteriaExactDeviceManagementEventStatusInProgressOrPending Optional |
| search_criteria_exact_device_management_event_status_completed | OCI.searchCriteriaExactDeviceManagementEventStatusCompleted | searchCriteriaExactDeviceManagementEventStatusCompleted Optional |
| search_criteria_exact_device_management_event_action | OCI.searchCriteriaExactDeviceManagementEventAction | searchCriteriaExactDeviceManagementEventAction Optional |
| search_criteria_exact_device_management_event_level | OCI.searchCriteriaExactDeviceManagementEventLevel | searchCriteriaExactDeviceManagementEventLevel Optional |
| search_criteria_exact_device_management_event_type | OCI.searchCriteriaExactDeviceManagementEventType | searchCriteriaExactDeviceManagementEventType Optional |
| search_criteria_device_management_event_additional_info | List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] | searchCriteriaDeviceManagementEventAdditionalInfo Optional |
| search_criteria_device_management_event_login_id | List[OCI.searchCriteriaDeviceManagementEventLoginId] | searchCriteriaDeviceManagementEventLoginId Optional |
ServiceProviderDeviceManagementEventGetListRequest22(OCIRequest)
Request device management's events for a specific queue.
It is possible to restrict the number of rows returned using responseSizeLimit. If eventQueueType is not specified, the events from all the event queues are returned.
The response is either a ServiceProviderDeviceManagementEventGetListResponse22() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| event_queue_type | str | eventQueueType Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_exact_device_management_event_status_in_progress_or_pending | OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending | searchCriteriaExactDeviceManagementEventStatusInProgressOrPending Optional |
| search_criteria_exact_device_management_event_status_completed | OCI.searchCriteriaExactDeviceManagementEventStatusCompleted | searchCriteriaExactDeviceManagementEventStatusCompleted Optional |
| search_criteria_exact_device_management_event_action | OCI.searchCriteriaExactDeviceManagementEventAction | searchCriteriaExactDeviceManagementEventAction Optional |
| search_criteria_exact_device_management_event_level | OCI.searchCriteriaExactDeviceManagementEventLevel | searchCriteriaExactDeviceManagementEventLevel Optional |
| search_criteria_exact_device_management_event_type | OCI.searchCriteriaExactDeviceManagementEventType | searchCriteriaExactDeviceManagementEventType Optional |
| search_criteria_device_management_event_additional_info | List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] | searchCriteriaDeviceManagementEventAdditionalInfo Optional |
| search_criteria_device_management_event_login_id | List[OCI.searchCriteriaDeviceManagementEventLoginId] | searchCriteriaDeviceManagementEventLoginId Optional |
| search_criteria_device_management_event_request | List[OCI.searchCriteriaDeviceManagementEventRequest] | searchCriteriaDeviceManagementEventRequest Optional |
| search_criteria_device_management_event_request_tracking_id | List[OCI.searchCriteriaDeviceManagementEventRequestTrackingId] | searchCriteriaDeviceManagementEventRequestTrackingId Optional |
ServiceProviderDnGetSummaryListRequest(OCIRequest)
Request a summary table of all DNs in a service provider.
Dns assigned to the IMRN pool are not listed in the response. The search can be done using multiple criteria. Only results matching all the search criteria are included in the results.
The response is either ServiceProviderDnGetSummaryListResponse() or
ErrorResponse(). The following elements are only used in XS data mode and ignored in
AS data mode: searchCriteriaDn, searchCriteriaGroupId
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
ServiceProviderDomainGetAssignedGroupListRequest(OCIRequest)
Requests a list of groups within a service provider that have a given domain assigned.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either a ServiceProviderDomainGetAssignedGroupListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| domain | str | domain |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_group_name | List[OCI.searchCriteriaGroupName] | searchCriteriaGroupName Optional |
ServiceProviderDomainGetAssignedListRequest22(OCIRequest)
Requests the list of all matching domains assigned to a service provider .
The response is either ServiceProviderDomainGetAssignedListResponse22() or
ErrorResponse(). The following elements are only used in AS data mode and will be
ignored in XS data mode: responseSizeLimit searchCriteriaDomainName
searchCriteriaExactDomainLevel
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_domain_name | List[OCI.searchCriteriaDomainName] | searchCriteriaDomainName Optional |
| search_criteria_exact_domain_level | OCI.searchCriteriaExactDomainLevel | searchCriteriaExactDomainLevel Optional |
ServiceProviderEndpointGetListRequest(OCIRequest)
Request to search endpoints in the service provider/enterprise.
The response is either ServiceProviderEndpointGetListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_line_port_user_part | List[OCI.searchCriteriaLinePortUserPart] | searchCriteriaLinePortUserPart Optional |
| search_criteria_line_port_domain | List[OCI.searchCriteriaLinePortDomain] | searchCriteriaLinePortDomain Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_device_type | List[OCI.searchCriteriaDeviceType] | searchCriteriaDeviceType Optional |
| search_criteria_device_name | List[OCI.searchCriteriaDeviceName] | searchCriteriaDeviceName Optional |
| search_criteria_device_mac_address | List[OCI.searchCriteriaDeviceMACAddress] | searchCriteriaDeviceMACAddress Optional |
| search_criteria_device_net_address | List[OCI.searchCriteriaDeviceNetAddress] | searchCriteriaDeviceNetAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
ServiceProviderGetListRequest(OCIRequest)
Request a list of service providers and/or enterprises in the system.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. If reseller administrator sends the request, searchCriteriaResellerId is ignored. Service providers/enterprise within the administrator's reseller meeting the search criteria are returned.
The response is either a ServiceProviderGetListResponse() or an ErrorResponse().
The following data elements are only used in AS data mode: searchCriteriaResellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| is_enterprise | bool | isEnterprise Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_service_provider_name | List[OCI.searchCriteriaServiceProviderName] | searchCriteriaServiceProviderName Optional |
| search_criteria_reseller_id | List[OCI.searchCriteriaResellerId] | searchCriteriaResellerId Optional |
ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateAddRequest(OCIRequest)
Create a MWI Delivery to Mobile Endpoint Custom Template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| language | str | language |
| type | str | type |
| is_enabled | bool | isEnabled |
| template_body | OCI.templateBody | templateBody |
ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateAddRequest23(OCIRequest)
Create a MWI Delivery to Mobile Endpoint Custom Template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| language | str | language |
| type | str | type |
| is_enabled | bool | isEnabled |
| month_abbreviations | str | monthAbbreviations Optional |
| template_body | OCI.templateBody | templateBody |
ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateModifyRequest(OCIRequest)
Modify a MWI Delivery to Mobile Endpoint Custom Template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| language | str | language |
| type | str | type |
| is_enabled | bool | isEnabled Optional |
| template_body | OCI.templateBody | templateBody Optional |
ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateModifyRequest23(OCIRequest)
Modify a MWI Delivery to Mobile Endpoint Custom Template.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| language | str | language |
| type | str | type |
| is_enabled | bool | isEnabled Optional |
| month_abbreviations | str | monthAbbreviations Optional |
| template_body | OCI.templateBody | templateBody Optional |
ServiceProviderNetworkClassOfServiceGetAssignedGroupListRequest(OCIRequest)
Get a list of groups within a service provider that have a given Network Class of Service assigned.
The response is either a
ServiceProviderNetworkClassOfServiceGetAssignedGroupListResponse() or an
ErorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| network_class_of_service | str | networkClassOfService |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_group_name | List[OCI.searchCriteriaGroupName] | searchCriteriaGroupName Optional |
ServiceProviderNumberPortabilityQueryGetRequest(OCIRequest)
Request to get the Service Provider Number Portability Query Digit Pattern Trigger List information.
The response is either a ServiceProviderNumberPortabilityQueryGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| include_digit_patterns | bool | includeDigitPatterns |
| search_criteria_service_provider_number_portability_query_digit_pattern | List[OCI.searchCriteriaServiceProviderNumberPortabilityQueryDigitPattern] | searchCriteriaServiceProviderNumberPortabilityQueryDigitPattern Optional |
| response_size_limit | int | responseSizeLimit Optional |
ServiceProviderOfficeZoneGetAssignedGroupListRequest(OCIRequest)
Get a list of groups within a service provider that have a given Office Zone assigned.
The response is either a ServiceProviderOfficeZoneGetAssignedGroupListResponse() or
an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| office_zone_name | str | officeZoneName |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_group_name | List[OCI.searchCriteriaGroupName] | searchCriteriaGroupName Optional |
ServiceProviderRouteListEnterpriseTrunkNumberPrefixAddListRequest22(OCIRequest)
Add number prefixes to a service provider.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| prefix | List[OCI.prefix] | prefix |
ServiceProviderRouteListEnterpriseTrunkNumberPrefixModifyListRequest(OCIRequest)
Modify a list of number prefixes in a service provider.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| number_prefix | List[OCI.numberPrefix] | numberPrefix Optional |
ServiceProviderRouteListEnterpriseTrunkNumberRangeAddListRequest22(OCIRequest)
Add number ranges to a service provider.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| number_range | List[OCI.numberRange] | numberRange |
ServiceProviderRoutePointExternalSystemGetAssignedGroupListRequest(OCIRequest)
Requests a list of groups within a service provider that have a given external system assigned.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either a
ServiceProviderRoutePointExternalSystemGetAssignedGroupListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| external_system | str | externalSystem |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_group_name | List[OCI.searchCriteriaGroupName] | searchCriteriaGroupName Optional |
ServiceProviderServiceModifyAuthorizationListRequest(OCIRequest)
Requests to change the service provider's service authorization status.
The boolean flags are used to authorize or unauthorize services.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_service_authorization | List[OCI.groupServiceAuthorization] | groupServiceAuthorization Optional |
| user_service_authorization | List[OCI.userServiceAuthorization] | userServiceAuthorization Optional |
ServiceProviderServicePackMigrationTaskGetAvailableGroupListRequest(OCIRequest)
Requests a list of groups to migrate.
The response is either
ServiceProviderServicePackMigrationTaskGetAvailabeGroupListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_group_name | List[OCI.searchCriteriaGroupName] | searchCriteriaGroupName Optional |
ServiceProviderXsiPolicyProfileGetAssignedGroupListRequest(OCIRequest)
Get a list of group within a service provider that have a given group Xsi policy profile assigned.
The response is either a
ServiceProviderXsiPolicyProfileGetAssignedGroupListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| xsi_policy_profile | OCI.xsiPolicyProfile | xsiPolicyProfile |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_group_name | List[OCI.searchCriteriaGroupName] | searchCriteriaGroupName Optional |
SystemAccessDeviceGetAllRequest(OCIRequest)
Requests the list of all access devices in the entire system.
Prior to release 14, this functionality was provided with the
SystemAccessDeviceGetListRequest14(). If reseller administrator sends the request,
searchCriteriaResellerId is ignored. All the device profiles in the administrator's
reseller meeting the search criteria are returned.
The response is either SystemAccessDeviceGetAllResponse() or ErrorResponse(). The
following data elements are only used in AS data mode: searchCriteriaResellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_device_name | List[OCI.searchCriteriaDeviceName] | searchCriteriaDeviceName Optional |
| search_criteria_device_mac_address | List[OCI.searchCriteriaDeviceMACAddress] | searchCriteriaDeviceMACAddress Optional |
| search_criteria_device_net_address | List[OCI.searchCriteriaDeviceNetAddress] | searchCriteriaDeviceNetAddress Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_exact_device_type | OCI.searchCriteriaExactDeviceType | searchCriteriaExactDeviceType Optional |
| search_criteria_exact_device_service_provider | OCI.searchCriteriaExactDeviceServiceProvider | searchCriteriaExactDeviceServiceProvider Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_reseller_id | List[OCI.searchCriteriaResellerId] | searchCriteriaResellerId Optional |
SystemAccessDeviceGetListRequest14(OCIRequest)
Requests the list of access devices defined at the System-level.
Prior to release 14, this command requested a list of all devices in the entire
system. That functionality is now moved to the SystemAccessDeviceGetAllRequest().
The response is either SystemAccessDeviceGetListResponse14() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_device_name | List[OCI.searchCriteriaDeviceName] | searchCriteriaDeviceName Optional |
| search_criteria_device_mac_address | List[OCI.searchCriteriaDeviceMACAddress] | searchCriteriaDeviceMACAddress Optional |
| search_criteria_device_net_address | List[OCI.searchCriteriaDeviceNetAddress] | searchCriteriaDeviceNetAddress Optional |
| search_criteria_exact_device_type | OCI.searchCriteriaExactDeviceType | searchCriteriaExactDeviceType Optional |
| search_criteria_access_device_version | List[OCI.searchCriteriaAccessDeviceVersion] | searchCriteriaAccessDeviceVersion Optional |
SystemAccessDeviceGetPagedSortedListRequest(OCIRequest)
Requests the list of system-level access devices.
The response is either SystemAccessDeviceGetPagedSortedListResponse() or
ErrorResponse(). If no sortOrder is included, the response is sorted by Device Name
ascending by default. If the responsePagingControl element is not provided, the
paging startIndex will be set to 1 by default, and the responsePageSize will be set to
the maximum responsePageSize by default. Multiple search criteria are logically ANDed
together unless the searchCriteriaModeOr option is included. Then the search criteria
are logically ORed together. The getVisualDeviceManagementAPIDevicesOnly element can
only be set when CloudPBX is licenced. If the getVisualDeviceManagementAPIDevicesOnly
element is not set, all devices are returned with Visual Device Management API flag
set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true,
only SIP devices supporting Visual Device Management API are returned. If the
getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are
returned with their current Visual Device Management API flag value.
Attributes:
| Name | Type | Description |
|---|---|---|
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_by_device_name | OCI.sortByDeviceName | sortByDeviceName Optional |
| sort_by_device_type | OCI.sortByDeviceType | sortByDeviceType Optional |
| sort_by_device_net_address | OCI.sortByDeviceNetAddress | sortByDeviceNetAddress Optional |
| sort_by_device_mac_address | OCI.sortByDeviceMACAddress | sortByDeviceMACAddress Optional |
| search_criteria_device_name | List[OCI.searchCriteriaDeviceName] | searchCriteriaDeviceName Optional |
| search_criteria_device_mac_address | List[OCI.searchCriteriaDeviceMACAddress] | searchCriteriaDeviceMACAddress Optional |
| search_criteria_device_net_address | List[OCI.searchCriteriaDeviceNetAddress] | searchCriteriaDeviceNetAddress Optional |
| search_criteria_exact_device_type | List[OCI.searchCriteriaExactDeviceType] | searchCriteriaExactDeviceType Optional |
| search_criteria_access_device_version | List[OCI.searchCriteriaAccessDeviceVersion] | searchCriteriaAccessDeviceVersion Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
| get_visual_device_management_api_devices_only | bool | getVisualDeviceManagementAPIDevicesOnly Optional |
SystemAccessDeviceGetUserListRequest(OCIRequest)
Requests the users associated with a specified system access device.
The response is either SystemAccessDeviceGetUserListResponse() or ErrorResponse().
The following elements are only used in XS data mode and ignored in AS data mode:
searchCriteriaAccessDeviceEndpointPrivateIdentity Replaced by:
SystemAccessDeviceGetUserListRequest21sp1() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_line_port_user_part | List[OCI.searchCriteriaLinePortUserPart] | searchCriteriaLinePortUserPart Optional |
| search_criteria_line_port_domain | List[OCI.searchCriteriaLinePortDomain] | searchCriteriaLinePortDomain Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_exact_service_provider | OCI.searchCriteriaExactServiceProvider | searchCriteriaExactServiceProvider Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_exact_endpoint_type | OCI.searchCriteriaExactEndpointType | searchCriteriaExactEndpointType Optional |
| search_criteria_exact_user_type | OCI.searchCriteriaExactUserType | searchCriteriaExactUserType Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_port_number | OCI.searchCriteriaExactPortNumber | searchCriteriaExactPortNumber Optional |
| search_criteria_access_device_endpoint_private_identity | List[OCI.searchCriteriaAccessDeviceEndpointPrivateIdentity] | searchCriteriaAccessDeviceEndpointPrivateIdentity Optional |
SystemAccessDeviceGetUserListRequest21sp1(OCIRequest)
Requests the users associated with a specified system access device.
The response is either SystemAccessDeviceGetUserListResponse21sp1() or
ErrorResponse(). The following elements are only used in XS data mode and ignored in
AS data mode: searchCriteriaAccessDeviceEndpointPrivateIdentity
Attributes:
| Name | Type | Description |
|---|---|---|
| device_name | str | deviceName |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_line_port_user_part | List[OCI.searchCriteriaLinePortUserPart] | searchCriteriaLinePortUserPart Optional |
| search_criteria_line_port_domain | List[OCI.searchCriteriaLinePortDomain] | searchCriteriaLinePortDomain Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_exact_service_provider | OCI.searchCriteriaExactServiceProvider | searchCriteriaExactServiceProvider Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_exact_endpoint_type | OCI.searchCriteriaExactEndpointType | searchCriteriaExactEndpointType Optional |
| search_criteria_exact_user_type | OCI.searchCriteriaExactUserType | searchCriteriaExactUserType Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_port_number | OCI.searchCriteriaExactPortNumber | searchCriteriaExactPortNumber Optional |
| search_criteria_access_device_endpoint_private_identity | List[OCI.searchCriteriaAccessDeviceEndpointPrivateIdentity] | searchCriteriaAccessDeviceEndpointPrivateIdentity Optional |
| search_criteria_user_hotline_contact | List[OCI.searchCriteriaUserHotlineContact] | searchCriteriaUserHotlineContact Optional |
SystemAlternateUserIdGetListRequest(OCIRequest)
Request to get the list of alternate user ids.
If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the alternate user ids in the administrator's reseller meeting the search criteria are returned.
The response is either SystemAlternateUserIdGetListResponse() or ErrorResponse().
The following data elements are only used in AS data mode: searchCriteriaResellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_alternate_user_id | List[OCI.searchCriteriaAlternateUserId] | searchCriteriaAlternateUserId Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_reseller_id | List[OCI.searchCriteriaResellerId] | searchCriteriaResellerId Optional |
SystemBroadWorksMobilityGeographicalPoolIMRNGetListRequest(OCIRequest)
Get a list of BroadWorks Mobility IMRN numbers from a geographical pool.
The response is either a
SystemBroadWorksMobilityGeographicalPoolIMRNGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| geographical_pool_name | str | geographicalPoolName |
| search_criteria_imrn | List[OCI.searchCriteriaIMRN] | searchCriteriaIMRN Optional |
SystemBroadWorksMobilityGetIMRNListRequest(OCIRequest)
Request to get the list of BroadWorks Mobility IMRN numbers defined in the system.
The response is either a SystemBroadWorksMobilityGetIMRNListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| search_criteria_imrn | List[OCI.searchCriteriaIMRN] | searchCriteriaIMRN Optional |
SystemBroadWorksMobilityGetMobileNetworkIMRNListRequest(OCIRequest)
Get a list of BroadWorks Mobility IMRN numbers from a Mobile Network.
The response is either a SystemBroadWorksMobilityGetMobileNetworkIMRNListResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| mobile_network_name | str | mobileNetworkName |
| search_criteria_imrn | List[OCI.searchCriteriaIMRN] | searchCriteriaIMRN Optional |
SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest(OCIRequest)
Request a summary table of all Mobile Subscriber Directory Numbers in a system.
If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the mobile subscriber directory numbers in the administrator's reseller meeting the search criteria are returned.
The response is either
SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListResponse() or
ErrorResponse(). The following data elements are only used in AS data mode:
searchCriteriaResellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_mobile_subscriber_directory_number | List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] | searchCriteriaMobileSubscriberDirectoryNumber Optional |
| search_criteria_exact_mobile_network | OCI.searchCriteriaExactMobileNetwork | searchCriteriaExactMobileNetwork Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_exact_organization_type | OCI.searchCriteriaExactOrganizationType | searchCriteriaExactOrganizationType Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_reseller_id | List[OCI.searchCriteriaResellerId] | searchCriteriaResellerId Optional |
SystemCallCenterEnhancedReportingScheduledReportGetActiveListRequest(OCIRequest)
Request to get the list of all active call center reporting scheduled reports in the system.
The response is either a
SystemCallCenterEnhancedReportingScheduledReportGetActiveListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_call_center_scheduled_report_name | List[OCI.searchCriteriaCallCenterScheduledReportName] | searchCriteriaCallCenterScheduledReportName Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_exact_call_center_scheduled_report_service_provider | OCI.searchCriteriaExactCallCenterScheduledReportServiceProvider | searchCriteriaExactCallCenterScheduledReportServiceProvider Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_exact_call_center_scheduled_report_created_by_supervisor | OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor | searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor Optional |
| search_criteria_call_center_report_template_name | List[OCI.searchCriteriaCallCenterReportTemplateName] | searchCriteriaCallCenterReportTemplateName Optional |
SystemCallCenterEnhancedReportingScheduledReportGetCompletedListRequest(OCIRequest)
Request to get the list of all completed call center reporting scheduled reports in the system.
The response is either a
SystemCallCenterEnhancedReportingScheduledReportGetCompletedListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_call_center_scheduled_report_name | List[OCI.searchCriteriaCallCenterScheduledReportName] | searchCriteriaCallCenterScheduledReportName Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_exact_call_center_scheduled_report_service_provider | OCI.searchCriteriaExactCallCenterScheduledReportServiceProvider | searchCriteriaExactCallCenterScheduledReportServiceProvider Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_exact_call_center_scheduled_report_created_by_supervisor | OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor | searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor Optional |
| search_criteria_call_center_report_template_name | List[OCI.searchCriteriaCallCenterReportTemplateName] | searchCriteriaCallCenterReportTemplateName Optional |
SystemCallCenterEnhancedReportingScheduledReportGetListRequest(OCIRequest)
Request to get the list of all call center reporting scheduled reports in the system.
The response is either an
SystemCallCenterEnhancedReportingScheduledReportGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_call_center_scheduled_report_name | List[OCI.searchCriteriaCallCenterScheduledReportName] | searchCriteriaCallCenterScheduledReportName Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_exact_call_center_scheduled_report_service_provider | OCI.searchCriteriaExactCallCenterScheduledReportServiceProvider | searchCriteriaExactCallCenterScheduledReportServiceProvider Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_exact_call_center_scheduled_report_created_by_supervisor | OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor | searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor Optional |
| search_criteria_call_center_report_template_name | List[OCI.searchCriteriaCallCenterReportTemplateName] | searchCriteriaCallCenterReportTemplateName Optional |
SystemClassmarkGetUtilizationListRequest(OCIRequest)
Get the list of all users associated with a Class Mark in system.
It is possible to search by various criteria. Multiple search criteria are logically ANDed together.
The response is either a SystemClassmarkGetUtilizationListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| classmark | str | classmark |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_exact_service_provider_id | OCI.searchCriteriaExactServiceProviderId | searchCriteriaExactServiceProviderId Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
SystemCommunicationBarringDigitPatternCriteriaGetPatternListRequest(OCIRequest)
Get an existing Digit Pattern Criteria.
The response is either a
SystemCommunicationBarringDigitPatternCriteriaGetPatternListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_digit_pattern | List[OCI.searchCriteriaDigitPattern] | searchCriteriaDigitPattern Optional |
SystemCommunicationBarringProfileModifyRequest(OCIRequest)
Modify an existing Communication Barring Profile.
When the originatingDefaultAction is not Treatment, originatingDefaultTreatmentId will be automatically cleared. Also when the action of originatingRule is not Treatment, treatmentId will be automatically cleared for the rule. The priorities for IncomingRules are requantized to consecutive integers as part of the modify.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode: callMeNowDefaultAction
callMeNowDefaultCallTimeout callMeNowRule applyToAttendedCallTransfers
Attributes:
| Name | Type | Description |
|---|---|---|
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| originating_default_action | str | originatingDefaultAction Optional |
| originating_default_treatment_id | str | originatingDefaultTreatmentId Optional |
| originating_default_transfer_number | str | originatingDefaultTransferNumber Optional |
| originating_default_call_timeout | int | originatingDefaultCallTimeout Optional |
| originating_rule | OCI.originatingRule | originatingRule Optional |
| redirecting_default_action | str | redirectingDefaultAction Optional |
| redirecting_default_call_timeout | int | redirectingDefaultCallTimeout Optional |
| redirecting_rule | OCI.redirectingRule | redirectingRule Optional |
| incoming_default_action | str | incomingDefaultAction Optional |
| incoming_default_call_timeout | int | incomingDefaultCallTimeout Optional |
| incoming_rule | OCI.incomingRule | incomingRule Optional |
| call_me_now_default_action | str | callMeNowDefaultAction Optional |
| call_me_now_default_call_timeout | int | callMeNowDefaultCallTimeout Optional |
| call_me_now_rule | OCI.callMeNowRule | callMeNowRule Optional |
| apply_to_attended_call_transfers | bool | applyToAttendedCallTransfers Optional |
SystemDeviceFamilyGetListRequest(OCIRequest)
Request to get the list of device family managed by the Device Management System.
If includeSystemLevel is specified, all system level device families and the reseller device families matching search criteria are returned even when searchCriteriaResellerId is specified. If reseller administrator sends the request, searchCriteriaResellerId is ignored and automatically set to the administrator's reseller.
The response is either SystemDeviceFamilyGetListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| include_system_level | bool | includeSystemLevel Optional |
| search_criteria_reseller_id | List[OCI.searchCriteriaResellerId] | searchCriteriaResellerId Optional |
SystemDeviceManagementEventGetListRequest(OCIRequest)
Request device management's events for a specific queue.
It is possible to restrict the number of rows returned using responseSizeLimit. If eventQueueType is not specified, the events from all the event queues are returned.
The response is either a SystemDeviceManagementEventGetListResponse() or an
ErrorResponse(). Deprecated by: SystemDeviceManagementEventGetListRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| event_queue_type | str | eventQueueType Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_exact_device_management_event_status_in_progress_or_pending | OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending | searchCriteriaExactDeviceManagementEventStatusInProgressOrPending Optional |
| search_criteria_exact_device_management_event_status_completed | OCI.searchCriteriaExactDeviceManagementEventStatusCompleted | searchCriteriaExactDeviceManagementEventStatusCompleted Optional |
| search_criteria_exact_device_management_event_action | OCI.searchCriteriaExactDeviceManagementEventAction | searchCriteriaExactDeviceManagementEventAction Optional |
| search_criteria_exact_device_management_event_level | OCI.searchCriteriaExactDeviceManagementEventLevel | searchCriteriaExactDeviceManagementEventLevel Optional |
| search_criteria_exact_device_management_event_type | OCI.searchCriteriaExactDeviceManagementEventType | searchCriteriaExactDeviceManagementEventType Optional |
| search_criteria_device_management_event_additional_info | List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] | searchCriteriaDeviceManagementEventAdditionalInfo Optional |
| search_criteria_device_management_event_login_id | List[OCI.searchCriteriaDeviceManagementEventLoginId] | searchCriteriaDeviceManagementEventLoginId Optional |
SystemDeviceManagementEventGetListRequest22(OCIRequest)
Request device management's events for a specific queue.
It is possible to restrict the number of rows returned using responseSizeLimit. If eventQueueType is not specified, the events from all the event queues are returned.
The response is either a SystemDeviceManagementEventGetListResponse22() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| event_queue_type | str | eventQueueType Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_exact_device_management_event_status_in_progress_or_pending | OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending | searchCriteriaExactDeviceManagementEventStatusInProgressOrPending Optional |
| search_criteria_exact_device_management_event_status_completed | OCI.searchCriteriaExactDeviceManagementEventStatusCompleted | searchCriteriaExactDeviceManagementEventStatusCompleted Optional |
| search_criteria_exact_device_management_event_action | OCI.searchCriteriaExactDeviceManagementEventAction | searchCriteriaExactDeviceManagementEventAction Optional |
| search_criteria_exact_device_management_event_level | OCI.searchCriteriaExactDeviceManagementEventLevel | searchCriteriaExactDeviceManagementEventLevel Optional |
| search_criteria_exact_device_management_event_type | OCI.searchCriteriaExactDeviceManagementEventType | searchCriteriaExactDeviceManagementEventType Optional |
| search_criteria_device_management_event_additional_info | List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] | searchCriteriaDeviceManagementEventAdditionalInfo Optional |
| search_criteria_device_management_event_login_id | List[OCI.searchCriteriaDeviceManagementEventLoginId] | searchCriteriaDeviceManagementEventLoginId Optional |
| search_criteria_device_management_event_request | List[OCI.searchCriteriaDeviceManagementEventRequest] | searchCriteriaDeviceManagementEventRequest Optional |
| search_criteria_device_management_event_request_tracking_id | List[OCI.searchCriteriaDeviceManagementEventRequestTrackingId] | searchCriteriaDeviceManagementEventRequestTrackingId Optional |
SystemDeviceProfileAuthenticationLockoutGetRequest(OCIRequest)
Request to get device password authentication lockout data in the system.
The response is either a SystemDeviceProfileAuthenticationLockoutGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_exact_organization_type | OCI.searchCriteriaExactOrganizationType | searchCriteriaExactOrganizationType Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_device_name | List[OCI.searchCriteriaDeviceName] | searchCriteriaDeviceName Optional |
| search_criteria_exact_device_type | OCI.searchCriteriaExactDeviceType | searchCriteriaExactDeviceType Optional |
SystemDnGetSummaryListRequest(OCIRequest)
Request a summary table of all DNs in the system.
If resellerId is specified, the DNs assigned to the enterprises/service providers within the reseller are returned. If reseller administrator sends the request and resellerId is not specified, the administrator's resellerId is used. The search can be done using multiple criteria. Only results matching all the search criteria are included in the results.
The response is either SystemDnGetSummaryListResponse() or ErrorResponse(). The
following data elements are only used in AS data mode: resellerId The following
elements are only used in XS data mode and ignored in AS data mode: searchCriteriaDn,
searchCriteriaServiceProviderId, searchCriteriaExactOrganizationType
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_exact_organization_type | OCI.searchCriteriaExactOrganizationType | searchCriteriaExactOrganizationType Optional |
SystemDomainGetListRequest22V2(OCIRequest)
Requests the list of all matching system-level domains and all matching reseller level domains.
If excludeReseller is specified, returns all matching system-level domain names only. If resellerId is specified, returns all matching system-level domain names and the given reseller's domains. If reseller administrator sends the request and resellerId is not specified, the administrator's resellerId is used.
The response is either SystemDomainGetListResponse22V2() or ErrorResponse(). The
following elements are only used in AS data mode and will be ingored in XS data mode:
includeReseller resellerId responseSizeLimit searchCriteriaDomainName
searchCriteriaResellerId searchCriteriaExactDomainLevel
Attributes:
| Name | Type | Description |
|---|---|---|
| exclude_reseller | bool | excludeReseller Optional |
| reseller_id | str | resellerId Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_domain_name | List[OCI.searchCriteriaDomainName] | searchCriteriaDomainName Optional |
| search_criteria_reseller_id | List[OCI.searchCriteriaResellerId] | searchCriteriaResellerId Optional |
| search_criteria_exact_domain_level | OCI.searchCriteriaExactDomainLevel | searchCriteriaExactDomainLevel Optional |
SystemEndpointGetListRequest(OCIRequest)
Request to search endpoints in the system.
If reseller administrator sends the request, searchCriteriaResellerId is ignored. All endpoints in the administrator's reseller meeting the search criteria are returned.
The response is either SystemEndpointGetListResponse() or ErrorResponse(). The
following data elements are only used in AS data mode: searchCriteriaResellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_exact_organization_type | OCI.searchCriteriaExactOrganizationType | searchCriteriaExactOrganizationType Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_line_port_user_part | List[OCI.searchCriteriaLinePortUserPart] | searchCriteriaLinePortUserPart Optional |
| search_criteria_line_port_domain | List[OCI.searchCriteriaLinePortDomain] | searchCriteriaLinePortDomain Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_device_type | List[OCI.searchCriteriaDeviceType] | searchCriteriaDeviceType Optional |
| search_criteria_device_name | List[OCI.searchCriteriaDeviceName] | searchCriteriaDeviceName Optional |
| search_criteria_device_mac_address | List[OCI.searchCriteriaDeviceMACAddress] | searchCriteriaDeviceMACAddress Optional |
| search_criteria_device_net_address | List[OCI.searchCriteriaDeviceNetAddress] | searchCriteriaDeviceNetAddress Optional |
| search_criteria_reseller_id | List[OCI.searchCriteriaResellerId] | searchCriteriaResellerId Optional |
SystemGetRegistrationContactListRequest(OCIRequest)
Get the list of registration contacts.
This request handles all levels of administration privileges. The content of the response will only contain items within the scope of the requester's login id. At the system level any of the choice parameters may be specified to filter the registrations listed. At the reseller level, the resellerId must be specified. ResellerId is not valid at service provider, group or user level. At the service provider level the serviceProviderId must be specified for the service provider and group options. When using the userId or linePort options the specified value must be valid for that service provider login. At the group level the servicProviderId and the groupId must be specified for the group option. When using the userId or linePort options the specified value must be valid for that group login. The serviceProviderId option is not valid at the group level. At the user level when using the userId or linePort options the specified value must be valid for that user login. The serviceProviderId and groupId options are not valid at the user level.
The response is either SystemGetRegistrationContactListResponse() or
ErrorResponse(). The following elements are only used in AS data mode: resellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId Optional |
| service_provider_id | str | serviceProviderId Optional |
| svc_provider_id | str | svcProviderId Optional |
| group_id | str | groupId Optional |
| user_id | str | userId Optional |
| line_port | str | linePort Optional |
| device_level | str | deviceLevel Optional |
| device_name | str | deviceName Optional |
| device_type | str | deviceType Optional |
| search_criteria_registration_uri | List[OCI.searchCriteriaRegistrationURI] | searchCriteriaRegistrationURI Optional |
| search_criteria_sip_contact | List[OCI.searchCriteriaSIPContact] | searchCriteriaSIPContact Optional |
| endpoint_type | str | endpointType Optional |
| expired | bool | expired Optional |
SystemGetRegistrationContactListRequest21sp1(OCIRequest)
Get the list of registration contacts.
This request handles all levels of administration privileges. The content of the response will only contain items within the scope of the requester's login id. At the system level any of the choice parameters may be specified to filter the registrations listed. At the reseller level, the resellerId must be specified. ResellerId is not valid at service provider, group or user level. At the service provider level the serviceProviderId must be specified for the service provider and group options. When using the userId or linePort options the specified value must be valid for that service provider login. At the group level the servicProviderId and the groupId must be specified for the group option. When using the userId or linePort options the specified value must be valid for that group login. The serviceProviderId option is not valid at the group level. At the user level when using the userId or linePort options the specified value must be valid for that user login. The serviceProviderId and groupId options are not valid at the user level.
The response is either SystemGetRegistrationContactListResponse21sp1() or
ErrorResponse(). The RegistrationEndpointType21sp1 is sent in response The Endpoint
Type column contains one of the enumerated RegistrationEndpointType21sp1 values. The
value Mobility in Endpoint Type column is only applicable in AS data mode. The
following elements are only used in AS data mode: resellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| reseller_id | str | resellerId Optional |
| service_provider_id | str | serviceProviderId Optional |
| svc_provider_id | str | svcProviderId Optional |
| group_id | str | groupId Optional |
| user_id | str | userId Optional |
| line_port | str | linePort Optional |
| device_level | str | deviceLevel Optional |
| device_name | str | deviceName Optional |
| device_type | str | deviceType Optional |
| search_criteria_registration_uri | List[OCI.searchCriteriaRegistrationURI] | searchCriteriaRegistrationURI Optional |
| search_criteria_sip_contact | List[OCI.searchCriteriaSIPContact] | searchCriteriaSIPContact Optional |
| endpoint_type | str | endpointType Optional |
| expired | bool | expired Optional |
SystemHomeNetworkGetListRequest(OCIRequest)
Get the list of all Home Networks.
The response is either a SystemHomeNetworkGetListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_home_msc_address | List[OCI.searchCriteriaHomeMscAddress] | searchCriteriaHomeMscAddress Optional |
SystemNumberPortabilityQueryDigitPatternGetListRequest(OCIRequest)
Request to get the System Number Portability Query Digit Pattern List information.
The response is either a SystemNumberPortabilityQueryDigitPatternGetListResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| search_criteria_number_portability_query_digit_pattern | List[OCI.searchCriteriaNumberPortabilityQueryDigitPattern] | searchCriteriaNumberPortabilityQueryDigitPattern Optional |
| search_criteria_number_portability_status | List[OCI.searchCriteriaNumberPortabilityStatus] | searchCriteriaNumberPortabilityStatus Optional |
| response_size_limit | int | responseSizeLimit Optional |
SystemPreferredCarrierGetGroupListRequest(OCIRequest)
Requests a list of groups using the specified carrier.
It is possible to restrict the number of rows returned by specifying various search criteria. Multiple search criteria are logically ANDed together.
The response is either a SystemPreferredCarrierGetGroupListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| carrier | str | carrier |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_group_name | List[OCI.searchCriteriaGroupName] | searchCriteriaGroupName Optional |
| search_criteria_exact_service_provider | OCI.searchCriteriaExactServiceProvider | searchCriteriaExactServiceProvider Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
SystemPreferredCarrierGetUserListRequest(OCIRequest)
Requests a list of users using the specified carrier.
It is possible to restrict the number of rows returned by specifying various search criteria. Multiple search criteria are logically ANDed together.
The response is either a SystemPreferreredCarrierGetUserListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| carrier | str | carrier |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
SystemRoamingNetworkGetListRequest(OCIRequest)
Get the list of all Roaming Networks.
The response is either a SystemRoamingNetworkGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_roaming_msc_address | List[OCI.searchCriteriaRoamingMscAddress] | searchCriteriaRoamingMscAddress Optional |
SystemSIPAuthenticationEndpointLockoutGetRequest(OCIRequest)
Request to get sip authentication endpoint lockout data in the system.
The response is either a SystemSIPAuthenticationEndpointLockoutGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_exact_organization_type | OCI.searchCriteriaExactOrganizationType | searchCriteriaExactOrganizationType Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_line_port_user_part | List[OCI.searchCriteriaLinePortUserPart] | searchCriteriaLinePortUserPart Optional |
| search_criteria_line_port_domain | List[OCI.searchCriteriaLinePortDomain] | searchCriteriaLinePortDomain Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
SystemSIPAuthenticationTrunkGroupLockoutGetRequest(OCIRequest)
Request to get sip authentication trunk group lockout data in the system.
The response is either a SystemSIPAuthenticationTrunkGroupLockoutGetResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_exact_organization_type | OCI.searchCriteriaExactOrganizationType | searchCriteriaExactOrganizationType Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_trunk_group_name | List[OCI.searchCriteriaTrunkGroupName] | searchCriteriaTrunkGroupName Optional |
SystemSIPDeviceTypeGetListRequest(OCIRequest)
Request to get the list of sip device types in the system.
If includeSystemLevel is specified, all system level device types and the reseller
device types matching search criteria are returned even when searchCriteriaResellerId
is specified. If reseller administrator sends the request, searchCriteriaResellerId
is ignored. All system level device types and the device types in the administrator's
reseller meeting the search criteria are returned. See Also:
SystemDeviceTypeGetAvailableListRequest22() in AS data mode,
SystemDeviceTypeGetAvailableListRequest19() in XS data mode.
The response is either SystemSIPDeviceTypeGetListResponse() or ErrorResponse().
The following data elements are only used in AS data mode and ignored in XS data mode:
searchCriteriaExactDeviceTypeConfigurationOptionType
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_device_type | List[OCI.searchCriteriaDeviceType] | searchCriteriaDeviceType Optional |
| search_criteria_exact_signaling_address_type | OCI.searchCriteriaExactSignalingAddressType | searchCriteriaExactSignalingAddressType Optional |
| search_criteria_reseller_id | List[OCI.searchCriteriaResellerId] | searchCriteriaResellerId Optional |
| search_criteria_device_configuration_options | List[OCI.searchCriteriaDeviceConfigurationOptions] | searchCriteriaDeviceConfigurationOptions Optional |
| include_system_level | bool | includeSystemLevel Optional |
SystemSecurityClassificationGetClassificationTrunkGroupUsageListRequest(OCIRequest)
Get a list of users that currently have the specified Security Classification assigned.
The response is either
SystemSecurityClassificationGetClassificationTrunkGroupUsageListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| security_classification | str | securityClassification |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_trunk_group_name | List[OCI.searchCriteriaTrunkGroupName] | searchCriteriaTrunkGroupName Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_exact_organization_type | OCI.searchCriteriaExactOrganizationType | searchCriteriaExactOrganizationType Optional |
SystemSecurityClassificationGetClassificationUserUsageListRequest(OCIRequest)
Get a list of users that currently have the specified Security Classification assigned.
The response is either
SystemSecurityClassificationGetClassificationUserUsageListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| security_classification | str | securityClassification |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
SystemServiceCodeGetListRequest(OCIRequest)
Request to get all service codes that have been defined in the system.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either SystemServiceCodeGetListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_service_code | List[OCI.searchCriteriaServiceCode] | searchCriteriaServiceCode Optional |
| search_criteria_service_code_description | List[OCI.searchCriteriaServiceCodeDescription] | searchCriteriaServiceCodeDescription Optional |
SystemThirdPartyVoiceMailSupportGetDnListRequest(OCIRequest)
Request to get a list of ThirdPartyVoiceMailSupport User DN's defined in the system.
The response is either a SystemThirdPartyVoiceMailSupportGetDnListResponse() or an
ErrorResponse(). The search can be done using multiple criterion.
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_system_service_dn | List[OCI.searchCriteriaSystemServiceDn] | searchCriteriaSystemServiceDn Optional |
SystemTwoStageDialingGetDnListRequest(OCIRequest)
Request to get a list of Two Stage Dialing dns defined in the system.
The response is either a SystemTwoStageDialingGetDnListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_system_service_dn | List[OCI.searchCriteriaSystemServiceDn] | searchCriteriaSystemServiceDn Optional |
SystemVerifyTranslationAndRoutingRequest(OCIRequest)
Represents a Verify Translation and Routing request which can be either a request containing parameters or a request containing a SIP message.
Returns a SystemVerifyTranslationAndRoutingResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| parameters | OCI.parameters | parameters Optional |
| sip_message | str | sipMessage Optional |
SystemXsiPolicyProfileGetAssignedServiceProviderListRequest(OCIRequest)
Get usage of specific policy profile.
The response is either a
SystemXsiPolicyProfileGetAssignedServiceProviderListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| xsi_policy_profile | OCI.xsiPolicyProfile | xsiPolicyProfile |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_service_provider_name | List[OCI.searchCriteriaServiceProviderName] | searchCriteriaServiceProviderName Optional |
| search_criteria_exact_organization_type | OCI.searchCriteriaExactOrganizationType | searchCriteriaExactOrganizationType Optional |
| search_criteria_reseller_id | List[OCI.searchCriteriaResellerId] | searchCriteriaResellerId Optional |
SystemZoneCallingRestrictionsNetAddressGetListRequest(OCIRequest)
Gets a list of IP Addresses and/or Ranges assigned to a zone Response is
SystemZoneCallingRestrictionsNetAddressGetListResponse().
Replaced by: SystemZoneNetAddressGetListRequest()
Attributes:
| Name | Type | Description |
|---|---|---|
| zone_name | str | zoneName |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_zone_ip_address | List[OCI.searchCriteriaZoneIPAddress] | searchCriteriaZoneIPAddress Optional |
SystemZoneLocationBasedPhysicalLocationGetListRequest(OCIRequest)
Gets a list of physical locations assigned to a zone.
Response is SystemZoneLocationBasedPhysicalLocationGetListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| zone_name | str | zoneName |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_physical_location | List[OCI.searchCriteriaPhysicalLocation] | searchCriteriaPhysicalLocation Optional |
SystemZoneNetAddressGetListRequest(OCIRequest)
Gets a list of IP Addresses and/or Ranges assigned to a zone.
Response is SystemZoneNetAddressGetListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| zone_name | str | zoneName |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_zone_ip_address | List[OCI.searchCriteriaZoneIPAddress] | searchCriteriaZoneIPAddress Optional |
UserAddRequest14(OCIRequest)
Request to add a user.
The domain is required in the userId. The password is not required if external authentication is enabled.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| user_id | str | userId |
| last_name | str | lastName |
| first_name | str | firstName |
| calling_line_id_last_name | str | callingLineIdLastName |
| calling_line_id_first_name | str | callingLineIdFirstName |
| hiragana_last_name | str | hiraganaLastName Optional |
| hiragana_first_name | str | hiraganaFirstName Optional |
| phone_number | str | phoneNumber Optional |
| extension | str | extension Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| password | str | password Optional |
| department | OCI.department | department Optional |
| language | str | language Optional |
| time_zone | str | timeZone Optional |
| alias | List[str] | alias Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| trunk_group_device_endpoint | OCI.trunkGroupDeviceEndpoint | trunkGroupDeviceEndpoint Optional |
| title | str | title Optional |
| pager_phone_number | str | pagerPhoneNumber Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| email_address | str | emailAddress Optional |
| yahoo_id | str | yahooId Optional |
| address_location | str | addressLocation Optional |
| address | OCI.address | address Optional |
UserAddRequest14sp9(OCIRequest)
Replaced By UserAddRequest17sp4() Request to add a user.
The domain is required in the userId. The password is not required if external authentication is enabled. The officeZoneName and primaryZoneName elements are ignored and provided here for backwards compatibility only.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| user_id | str | userId |
| last_name | str | lastName |
| first_name | str | firstName |
| calling_line_id_last_name | str | callingLineIdLastName |
| calling_line_id_first_name | str | callingLineIdFirstName |
| hiragana_last_name | str | hiraganaLastName Optional |
| hiragana_first_name | str | hiraganaFirstName Optional |
| phone_number | str | phoneNumber Optional |
| extension | str | extension Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| password | str | password Optional |
| department | OCI.department | department Optional |
| language | str | language Optional |
| time_zone | str | timeZone Optional |
| alias | List[str] | alias Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| trunk_addressing | OCI.trunkAddressing | trunkAddressing Optional |
| title | str | title Optional |
| pager_phone_number | str | pagerPhoneNumber Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| email_address | str | emailAddress Optional |
| yahoo_id | str | yahooId Optional |
| address_location | str | addressLocation Optional |
| address | OCI.address | address Optional |
| network_class_of_service | str | networkClassOfService Optional |
| office_zone_name | str | officeZoneName Optional |
| primary_zone_name | str | primaryZoneName Optional |
UserAddRequest17sp4(OCIRequest)
Request to add a user.
The domain is required in the userId. The password is not required if external authentication is enabled. The following elements are only used in AS data mode and ignored in XS data mode: nameDialingName alternateUserId
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
UserAddRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| user_id | str | userId |
| last_name | str | lastName |
| first_name | str | firstName |
| calling_line_id_last_name | str | callingLineIdLastName |
| calling_line_id_first_name | str | callingLineIdFirstName |
| name_dialing_name | OCI.nameDialingName | nameDialingName Optional |
| hiragana_last_name | str | hiraganaLastName Optional |
| hiragana_first_name | str | hiraganaFirstName Optional |
| phone_number | str | phoneNumber Optional |
| extension | str | extension Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| password | str | password Optional |
| department | OCI.department | department Optional |
| language | str | language Optional |
| time_zone | str | timeZone Optional |
| alias | List[str] | alias Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| trunk_addressing | OCI.trunkAddressing | trunkAddressing Optional |
| title | str | title Optional |
| pager_phone_number | str | pagerPhoneNumber Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| email_address | str | emailAddress Optional |
| yahoo_id | str | yahooId Optional |
| address_location | str | addressLocation Optional |
| address | OCI.address | address Optional |
| network_class_of_service | str | networkClassOfService Optional |
| alternate_user_id | List[OCI.alternateUserId] | alternateUserId Optional |
UserAddRequest21(OCIRequest)
Request to add a user.
The domain is required in the userId. The password is not required if external authentication is enabled. The following elements are only used in AS data mode and will fail in XS data mode: trunkAddressing The following elements are only used in AS data mode and ignored in XS data mode: nameDialingName The following elements are only used in XS data mode and ignored in AS data mode: allowVideo
The response is either SuccessResponse() or ErrorResponse(). The following
elements can only be used by a system administrator:. allowVideo alternateUserId The
following elements can only be used by a provisioning administrator:. alternateUserId
Replaced by: UserAddRequest22() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| user_id | str | userId |
| last_name | str | lastName |
| first_name | str | firstName |
| calling_line_id_last_name | str | callingLineIdLastName |
| calling_line_id_first_name | str | callingLineIdFirstName |
| name_dialing_name | OCI.nameDialingName | nameDialingName Optional |
| hiragana_last_name | str | hiraganaLastName Optional |
| hiragana_first_name | str | hiraganaFirstName Optional |
| phone_number | str | phoneNumber Optional |
| extension | str | extension Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| password | str | password Optional |
| department | OCI.department | department Optional |
| language | str | language Optional |
| time_zone | str | timeZone Optional |
| alias | List[str] | alias Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| trunk_addressing | OCI.trunkAddressing | trunkAddressing Optional |
| title | str | title Optional |
| pager_phone_number | str | pagerPhoneNumber Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| email_address | str | emailAddress Optional |
| yahoo_id | str | yahooId Optional |
| address_location | str | addressLocation Optional |
| address | OCI.address | address Optional |
| network_class_of_service | str | networkClassOfService Optional |
| alternate_user_id | List[OCI.alternateUserId] | alternateUserId Optional |
| allow_video | bool | allowVideo Optional |
UserAnnouncementFileGetListRequest(OCIRequest)
Get the list of announcement names with associated media type and filesize for a User
and given Announcement Repository Type The response is either a
UserAnnouncementFileGetListResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| announcement_file_type | str | announcementFileType Optional |
| include_announcement_table | bool | includeAnnouncementTable |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_announcement_file_name | List[OCI.searchCriteriaAnnouncementFileName] | searchCriteriaAnnouncementFileName Optional |
UserAnnouncementFileGetPagedSortedListRequest(OCIRequest)
Get the list of announcement files for a user.
If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum responsePageSize by default. If no sortOrder is provided, the response is sorted by Name ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.
The response is either a UserAnnouncementFileGetPagedSortedListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_by_announcement_file_name | OCI.sortByAnnouncementFileName | sortByAnnouncementFileName Optional |
| sort_by_announcement_file_size | OCI.sortByAnnouncementFileSize | sortByAnnouncementFileSize Optional |
| search_criteria_announcement_file_name | List[OCI.searchCriteriaAnnouncementFileName] | searchCriteriaAnnouncementFileName Optional |
| search_criteria_exact_announcement_file_type | OCI.searchCriteriaExactAnnouncementFileType | searchCriteriaExactAnnouncementFileType Optional |
| search_criteria_exact_media_file_type | List[OCI.searchCriteriaExactMediaFileType] | searchCriteriaExactMediaFileType Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
UserBroadWorksAnywhereGetPhoneNumberPagedSortedListRequest(OCIRequest)
Get the list of all the BroadWorks Anywhere phone numbers for the user.
If no sortOrder is included the response is sorted by Phone Number ascending by default.
The response is either a
UserBroadWorksAnywhereGetPhoneNumberPagedSortedListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_by_location | OCI.sortByLocation | sortByLocation Optional |
| sort_by_enabled | OCI.sortByEnabled | sortByEnabled Optional |
| search_criteria_location | List[OCI.searchCriteriaLocation] | searchCriteriaLocation Optional |
| search_criteria_exact_location_enabled | OCI.searchCriteriaExactLocationEnabled | searchCriteriaExactLocationEnabled Optional |
UserBroadWorksAnywhereModifySelectiveCriteriaRequest(OCIRequest)
Modify selective criteria for the user's BroadWorks Anywhere phone number.
The following elements are only used in AS data mode: callToNumbers For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| phone_number | str | phoneNumber |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted Optional |
| call_to_number_list | OCI.callToNumberList | callToNumberList Optional |
UserBroadWorksMobilityMobileIdentityAddRequest(OCIRequest)
Add a mobile identity to the user's list of mobile identities.
The response is either a SuccessResponse() or an ErrorResponse(). The request
fails when the devicesToRing is set to Mobile and the mobileNumberAlerted list is
empty. Replaced by: UserBroadWorksMobilityMobileIdentityAddRequest21sp1().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mobile_number | str | mobileNumber |
| description | str | description Optional |
| is_primary | bool | isPrimary |
| enable_alerting | bool | enableAlerting |
| alert_agent_calls | bool | alertAgentCalls |
| alert_click_to_dial_calls | bool | alertClickToDialCalls |
| alert_group_paging_calls | bool | alertGroupPagingCalls |
| use_mobility_calling_line_id | bool | useMobilityCallingLineID |
| enable_diversion_inhibitor | bool | enableDiversionInhibitor |
| require_answer_confirmation | bool | requireAnswerConfirmation |
| broadworks_call_control | bool | broadworksCallControl |
| use_setting_level | str | useSettingLevel |
| deny_call_originations | bool | denyCallOriginations |
| deny_call_terminations | bool | denyCallTerminations |
| devices_to_ring | str | devicesToRing |
| include_shared_call_appearance | bool | includeSharedCallAppearance |
| include_broadworks_anywhere | bool | includeBroadworksAnywhere |
| include_executive_assistant | bool | includeExecutiveAssistant |
| mobile_number_alerted | List[str] | mobileNumberAlerted Optional |
| enable_call_anchoring | bool | enableCallAnchoring |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
UserBroadWorksMobilityMobileIdentityAddRequest21sp1(OCIRequest)
Add a mobile identity to the user's list of mobile identities.
The response is either a SuccessResponse() or an ErrorResponse(). The request
fails when the devicesToRing is set to Mobile and the mobileNumberAlerted list is
empty. Replaced by: UserBroadWorksMobilityMobileIdentityAddRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mobile_number | str | mobileNumber |
| description | str | description Optional |
| is_primary | bool | isPrimary |
| enable_alerting | bool | enableAlerting |
| alert_agent_calls | bool | alertAgentCalls |
| alert_click_to_dial_calls | bool | alertClickToDialCalls |
| alert_group_paging_calls | bool | alertGroupPagingCalls |
| use_mobility_calling_line_id | bool | useMobilityCallingLineID |
| enable_diversion_inhibitor | bool | enableDiversionInhibitor |
| require_answer_confirmation | bool | requireAnswerConfirmation |
| broadworks_call_control | bool | broadworksCallControl |
| use_setting_level | str | useSettingLevel |
| deny_call_originations | bool | denyCallOriginations |
| deny_call_terminations | bool | denyCallTerminations |
| devices_to_ring | str | devicesToRing |
| include_shared_call_appearance | bool | includeSharedCallAppearance |
| include_broadworks_anywhere | bool | includeBroadworksAnywhere |
| include_executive_assistant | bool | includeExecutiveAssistant |
| mobile_number_alerted | List[str] | mobileNumberAlerted Optional |
| enable_call_anchoring | bool | enableCallAnchoring |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| outbound_alternate_number | str | outboundAlternateNumber Optional |
| enable_direct_routing | bool | enableDirectRouting |
| mark_cdr_as_enterprise_group_calls | bool | markCDRAsEnterpriseGroupCalls |
UserBroadWorksMobilityMobileIdentityAddRequest22(OCIRequest)
Add a mobile identity to the user's list of mobile identities.
The response is either a SuccessResponse() or an ErrorResponse(). The request
fails when the devicesToRing is set to Mobile and the mobileNumberAlerted list is
empty.
Replaced By: UserBroadWorksMobilityMobileIdentityAddRequest22V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mobile_number | str | mobileNumber |
| description | str | description Optional |
| is_primary | bool | isPrimary |
| enable_alerting | bool | enableAlerting |
| alert_agent_calls | bool | alertAgentCalls |
| alert_click_to_dial_calls | bool | alertClickToDialCalls |
| alert_group_paging_calls | bool | alertGroupPagingCalls |
| use_mobility_calling_line_id | bool | useMobilityCallingLineID |
| enable_diversion_inhibitor | bool | enableDiversionInhibitor |
| require_answer_confirmation | bool | requireAnswerConfirmation |
| broadworks_call_control | bool | broadworksCallControl |
| use_setting_level | str | useSettingLevel |
| deny_call_originations | bool | denyCallOriginations |
| deny_call_terminations | bool | denyCallTerminations |
| devices_to_ring | str | devicesToRing |
| include_shared_call_appearance | bool | includeSharedCallAppearance |
| include_broadworks_anywhere | bool | includeBroadworksAnywhere |
| include_executive_assistant | bool | includeExecutiveAssistant |
| mobile_number_alerted | List[str] | mobileNumberAlerted Optional |
| enable_call_anchoring | bool | enableCallAnchoring |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| outbound_alternate_number | str | outboundAlternateNumber Optional |
| enable_direct_routing | bool | enableDirectRouting |
| mark_cdr_as_enterprise_group_calls | bool | markCDRAsEnterpriseGroupCalls |
| use_mobility_connected_identity | bool | useMobilityConnectedIdentity |
| network_translation_index | str | networkTranslationIndex Optional |
UserBroadWorksMobilityMobileIdentityAddRequest22V2(OCIRequest)
Add a mobile identity to the user's list of mobile identities.
The response is either a SuccessResponse() or an ErrorResponse(). The request
fails when the devicesToRing is set to Mobile and the mobileNumberAlerted list is
empty.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mobile_number | str | mobileNumber |
| description | str | description Optional |
| is_primary | bool | isPrimary |
| enable_alerting | bool | enableAlerting |
| alert_agent_calls | bool | alertAgentCalls |
| alert_click_to_dial_calls | bool | alertClickToDialCalls |
| alert_group_paging_calls | bool | alertGroupPagingCalls |
| use_mobility_calling_line_id | bool | useMobilityCallingLineID |
| enable_diversion_inhibitor | bool | enableDiversionInhibitor |
| require_answer_confirmation | bool | requireAnswerConfirmation |
| broadworks_call_control | bool | broadworksCallControl |
| use_setting_level | str | useSettingLevel |
| deny_call_originations | bool | denyCallOriginations |
| deny_call_terminations | bool | denyCallTerminations |
| devices_to_ring | str | devicesToRing |
| include_shared_call_appearance | bool | includeSharedCallAppearance |
| include_broadworks_anywhere | bool | includeBroadworksAnywhere |
| include_executive_assistant | bool | includeExecutiveAssistant |
| mobile_number_alerted | List[str] | mobileNumberAlerted Optional |
| enable_call_anchoring | bool | enableCallAnchoring |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| outbound_alternate_number | str | outboundAlternateNumber Optional |
| enable_direct_routing | bool | enableDirectRouting |
| mark_cdr_as_enterprise_group_calls | bool | markCDRAsEnterpriseGroupCalls |
| use_mobility_connected_identity | bool | useMobilityConnectedIdentity |
| network_translation_index | str | networkTranslationIndex Optional |
UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest(OCIRequest)
Add a mobile identity to the user's list of mobile identities.
The response is either a SuccessResponse() or an ErrorResponse(). The request
fails when the devicesToRing is set to Mobile and the mobileNumberAlerted list is
empty.
Replaced By: UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mobile_number | str | mobileNumber |
| description | str | description Optional |
| is_primary | bool | isPrimary |
| enable_alerting | bool | enableAlerting |
| alert_agent_calls | bool | alertAgentCalls |
| alert_click_to_dial_calls | bool | alertClickToDialCalls |
| alert_group_paging_calls | bool | alertGroupPagingCalls |
| use_mobility_calling_line_id | bool | useMobilityCallingLineID |
| enable_diversion_inhibitor | bool | enableDiversionInhibitor |
| require_answer_confirmation | bool | requireAnswerConfirmation |
| broadworks_call_control | bool | broadworksCallControl |
| use_setting_level | str | useSettingLevel |
| deny_call_originations | bool | denyCallOriginations |
| deny_call_terminations | bool | denyCallTerminations |
| devices_to_ring | str | devicesToRing |
| include_shared_call_appearance | bool | includeSharedCallAppearance |
| include_broadworks_anywhere | bool | includeBroadworksAnywhere |
| include_executive_assistant | bool | includeExecutiveAssistant |
| mobile_number_alerted | List[str] | mobileNumberAlerted Optional |
| enable_call_anchoring | bool | enableCallAnchoring |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| outbound_alternate_number | str | outboundAlternateNumber Optional |
| enable_direct_routing | bool | enableDirectRouting |
| mark_cdr_as_enterprise_group_calls | bool | markCDRAsEnterpriseGroupCalls |
UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest22(OCIRequest)
Add a mobile identity to the user's list of mobile identities.
The response is either a SuccessResponse() or an ErrorResponse(). The request
fails when the devicesToRing is set to Mobile and the mobileNumberAlerted list is
empty.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mobile_number | str | mobileNumber |
| description | str | description Optional |
| is_primary | bool | isPrimary |
| enable_alerting | bool | enableAlerting |
| alert_agent_calls | bool | alertAgentCalls |
| alert_click_to_dial_calls | bool | alertClickToDialCalls |
| alert_group_paging_calls | bool | alertGroupPagingCalls |
| use_mobility_calling_line_id | bool | useMobilityCallingLineID |
| enable_diversion_inhibitor | bool | enableDiversionInhibitor |
| require_answer_confirmation | bool | requireAnswerConfirmation |
| broadworks_call_control | bool | broadworksCallControl |
| use_setting_level | str | useSettingLevel |
| deny_call_originations | bool | denyCallOriginations |
| deny_call_terminations | bool | denyCallTerminations |
| devices_to_ring | str | devicesToRing |
| include_shared_call_appearance | bool | includeSharedCallAppearance |
| include_broadworks_anywhere | bool | includeBroadworksAnywhere |
| include_executive_assistant | bool | includeExecutiveAssistant |
| mobile_number_alerted | List[str] | mobileNumberAlerted Optional |
| enable_call_anchoring | bool | enableCallAnchoring |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| outbound_alternate_number | str | outboundAlternateNumber Optional |
| enable_direct_routing | bool | enableDirectRouting |
| mark_cdr_as_enterprise_group_calls | bool | markCDRAsEnterpriseGroupCalls |
UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest(OCIRequest)
Modify the settings for one of the user's BroadWorks Mobility mobile Identities.
The response is either a SuccessResponse() or an ErrorResponse(). If
deleteExistingDevices is set to true, when the devices for the endpoint are changed,
devices with no more endpoint will be deleted if the command is executed with the
correct privilege. The request fails when enableAlerting or timeSchedule or
holidaySchedule are included in the request when the use mobile identity call
anchoring controls for the user is disabled. The description, enableAlerting,
alertAgentCalls, alertClickToDialCalls, alertGroupPagingCalls,
useMobilityCallingLineID, enableDiversionInhibitor, requireAnswerConfirmation,
broadworksCallControl, devicesToRing, includeSharedCallAppearance,
includeBroadworksAnywhere, includeExecutiveAssistance, mobileNumberAlerted,
enableCallAnchoring, timeSchedule and holidaySchedule parameters require an
authorization level of User for modification when the BroadWorks Mobility service is
on. The isPrimary, useSettingLevel, denyCallOrigination, denyCallTerminations,
accessDeviceEndpoint, outboundAlternateNumber, enableDirectRouting,
markCDRAsEnterpriseGroupCalls and networkTranslationIndex parameters require an
authorization level of Group for modification.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mobile_number | str | mobileNumber |
| delete_existing_devices | bool | deleteExistingDevices Optional |
| description | str | description Optional |
| is_primary | bool | isPrimary Optional |
| enable_alerting | bool | enableAlerting Optional |
| alert_agent_calls | bool | alertAgentCalls Optional |
| alert_click_to_dial_calls | bool | alertClickToDialCalls Optional |
| alert_group_paging_calls | bool | alertGroupPagingCalls Optional |
| use_mobility_calling_line_id | bool | useMobilityCallingLineID Optional |
| enable_diversion_inhibitor | bool | enableDiversionInhibitor Optional |
| require_answer_confirmation | bool | requireAnswerConfirmation Optional |
| broadworks_call_control | bool | broadworksCallControl Optional |
| use_setting_level | str | useSettingLevel Optional |
| deny_call_originations | bool | denyCallOriginations Optional |
| deny_call_terminations | bool | denyCallTerminations Optional |
| devices_to_ring | str | devicesToRing Optional |
| include_shared_call_appearance | bool | includeSharedCallAppearance Optional |
| include_broadworks_anywhere | bool | includeBroadworksAnywhere Optional |
| include_executive_assistant | bool | includeExecutiveAssistant Optional |
| mobile_numbers_alerted | OCI.mobileNumbersAlerted | mobileNumbersAlerted Optional |
| enable_call_anchoring | bool | enableCallAnchoring Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| outbound_alternate_number | str | outboundAlternateNumber Optional |
| enable_direct_routing | bool | enableDirectRouting Optional |
| mark_cdr_as_enterprise_group_calls | bool | markCDRAsEnterpriseGroupCalls Optional |
| use_mobility_connected_identity | bool | useMobilityConnectedIdentity Optional |
| network_translation_index | str | networkTranslationIndex Optional |
UserBroadWorksMobilityMobileIdentityModifyRequest(OCIRequest)
Modify the settings for one of the user's BroadWorks Mobility mobile Identities.
The response is either a SuccessResponse() or an ErrorResponse(). The request
fails when enableAlerting or timeSchedule or holidaySchedule are included in the
request when the user's use mobile identity call anchoring controls is disabled. The
description, enableAlerting, alertAgentCalls, alertClickToDialCalls,
alertGroupPagingCalls, useMobilityCallingLineID, enableDiversionInhibitor,
requireAnswerConfirmation, broadworksCallControl, devicesToRing,
includeSharedCallAppearance, includeBroadworksAnywhere, includeExecutiveAssistance,
mobileNumberAlerted, enableCallAnchoring, timeSchedule, holidaySchedule and
useMobilityConnectedIdentity parameters require an authorization level of User for
modification when the BroadWorks Mobility service is on. The isPrimary,
useSettingLevel, denyCallOrigination, denyCallTerminations, accessDeviceEndpoint,
outboundAlternateNumber, enableDirectRouting, markCDRAsEnterpriseGroupCalls and
networkTranslationIndex parameters require an authorization level of Group for
modification.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mobile_number | str | mobileNumber |
| description | str | description Optional |
| is_primary | bool | isPrimary Optional |
| enable_alerting | bool | enableAlerting Optional |
| alert_agent_calls | bool | alertAgentCalls Optional |
| alert_click_to_dial_calls | bool | alertClickToDialCalls Optional |
| alert_group_paging_calls | bool | alertGroupPagingCalls Optional |
| use_mobility_calling_line_id | bool | useMobilityCallingLineID Optional |
| enable_diversion_inhibitor | bool | enableDiversionInhibitor Optional |
| require_answer_confirmation | bool | requireAnswerConfirmation Optional |
| broadworks_call_control | bool | broadworksCallControl Optional |
| use_setting_level | str | useSettingLevel Optional |
| deny_call_originations | bool | denyCallOriginations Optional |
| deny_call_terminations | bool | denyCallTerminations Optional |
| devices_to_ring | str | devicesToRing Optional |
| include_shared_call_appearance | bool | includeSharedCallAppearance Optional |
| include_broadworks_anywhere | bool | includeBroadworksAnywhere Optional |
| include_executive_assistant | bool | includeExecutiveAssistant Optional |
| mobile_numbers_alerted | OCI.mobileNumbersAlerted | mobileNumbersAlerted Optional |
| enable_call_anchoring | bool | enableCallAnchoring Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| outbound_alternate_number | str | outboundAlternateNumber Optional |
| enable_direct_routing | bool | enableDirectRouting Optional |
| mark_cdr_as_enterprise_group_calls | bool | markCDRAsEnterpriseGroupCalls Optional |
| use_mobility_connected_identity | bool | useMobilityConnectedIdentity Optional |
| network_translation_index | str | networkTranslationIndex Optional |
UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest(OCIRequest)
Get a list of available users for BroadWorks Receptionist - Enterprise monitoring.
The response is either
UserBroadWorksReceptionistEnterpriseGetAvailableUserListResponse() or
ErrorResponse(). The Receptionist Note column is only populated, if the user sending
the request is the owner of the Receptionist Note and a Note exists.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
| search_criteria_receptionist_note | List[OCI.searchCriteriaReceptionistNote] | searchCriteriaReceptionistNote Optional |
UserBroadWorksReceptionistEnterpriseNoteModifyListRequest(OCIRequest)
Add a list of notes for an existing Receptionist user.
The response is either a SuccessResponse() or an ErrorResponse(). If some of the
users add and some users fail to add, then the response will contain a
WarningResponse() containing only the a comma delimited list of users that failed to
add. If the user sending the request is the not the owner of the Receptionist Note,
then an ErrorResponse() will be returned.
Attributes:
| Name | Type | Description |
|---|---|---|
| receptionist_user_id | str | receptionistUserId |
| receptionist_user_and_note | List[OCI.receptionistUserAndNote] | receptionistUserAndNote |
UserBroadWorksReceptionistOfficeGetAvailableUserListRequest(OCIRequest)
Get the Receptionist Office available user list.
The response is either
UserBroadWorksReceptionistOfficeGetAvailableUserListResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
UserBroadWorksReceptionistSmallBusinessGetAvailableUserListRequest(OCIRequest)
Get a list of available users for the Receptionist Small Business service.
The response is either
UserBroadWorksReceptionistSmallBusinessGetAvailableUserListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
UserBroadworksMobilityAddMobileIdentityUsingSharedCallAppearanceRequest(OCIRequest)
Adding a new mobile identity using the Share Call Appearance.
The response is either a SuccessResponse() or an ErrorResponse(). The request
fails when the devicesToRing is set to Mobile and the mobileNumberAlerted list is
empty.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint |
| mobile_number | str | mobileNumber |
| description | str | description Optional |
| is_primary | bool | isPrimary |
| enable_alerting | bool | enableAlerting |
| alert_agent_calls | bool | alertAgentCalls |
| alert_click_to_dial_calls | bool | alertClickToDialCalls |
| alert_group_paging_calls | bool | alertGroupPagingCalls |
| use_mobility_calling_line_id | bool | useMobilityCallingLineID |
| enable_diversion_inhibitor | bool | enableDiversionInhibitor |
| require_answer_confirmation | bool | requireAnswerConfirmation |
| broadworks_call_control | bool | broadworksCallControl |
| use_setting_level | str | useSettingLevel |
| deny_call_originations | bool | denyCallOriginations |
| deny_call_terminations | bool | denyCallTerminations |
| devices_to_ring | str | devicesToRing |
| include_shared_call_appearance | bool | includeSharedCallAppearance |
| include_broadworks_anywhere | bool | includeBroadworksAnywhere |
| include_executive_assistant | bool | includeExecutiveAssistant |
| mobile_number_alerted | List[str] | mobileNumberAlerted Optional |
| enable_call_anchoring | bool | enableCallAnchoring |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| enable_direct_routing | bool | enableDirectRouting |
| mark_cdr_as_enterprise_group_calls | bool | markCDRAsEnterpriseGroupCalls |
UserBroadworksMobilityAddMobileIdentityUsingSharedCallAppearanceRequest22(OCIRequest)
Adding a new mobile identity using the Share Call Appearance.
The response is either a SuccessResponse() or an ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode: useHotline, use
value false in XS data mode hotlineContact The request fails when the devicesToRing is
set to Mobile and the mobileNumberAlerted list is empty.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint |
| mobile_number | str | mobileNumber |
| description | str | description Optional |
| is_primary | bool | isPrimary |
| enable_alerting | bool | enableAlerting |
| alert_agent_calls | bool | alertAgentCalls |
| alert_click_to_dial_calls | bool | alertClickToDialCalls |
| alert_group_paging_calls | bool | alertGroupPagingCalls |
| use_mobility_calling_line_id | bool | useMobilityCallingLineID |
| enable_diversion_inhibitor | bool | enableDiversionInhibitor |
| require_answer_confirmation | bool | requireAnswerConfirmation |
| broadworks_call_control | bool | broadworksCallControl |
| use_setting_level | str | useSettingLevel |
| deny_call_originations | bool | denyCallOriginations |
| deny_call_terminations | bool | denyCallTerminations |
| devices_to_ring | str | devicesToRing |
| include_shared_call_appearance | bool | includeSharedCallAppearance |
| include_broadworks_anywhere | bool | includeBroadworksAnywhere |
| include_executive_assistant | bool | includeExecutiveAssistant |
| mobile_number_alerted | List[str] | mobileNumberAlerted Optional |
| enable_call_anchoring | bool | enableCallAnchoring |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| enable_direct_routing | bool | enableDirectRouting |
| mark_cdr_as_enterprise_group_calls | bool | markCDRAsEnterpriseGroupCalls |
| use_hotline | bool | useHotline |
| hotline_contact | str | hotlineContact Optional |
UserBusyLampFieldGetAvailableUserListRequest(OCIRequest)
Get a list of available users for the busy lamp field service.
The response is either UserBusyLampFieldGetAvailableUserListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
UserCallCenterGetAvailableCallCenterPagedSortedListRequest(OCIRequest)
This request gets a list of all call centers which the user can be assigned to as an agent.
Some of the call centers may already have the user as an agent. It is the clients responsibility to discard the call centers that the user is already an agent of. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.
The response is either a
UserCallCenterGetAvailableCallCenterPagedSortedListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_by_user_id | OCI.sortByUserId | sortByUserId Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
UserCallCenterGetSupervisedAgentListRequest(OCIRequest)
Get a list of agents supervised by a supervisor on a given call center.
The response is either a UserCallCenterGetSupervisedAgentListResponse() or an
ErrorResponse(). The search can be done using multiple criterias. If the
searchCriteriaModeOr is present, any result matching any one criteria is included in
the results. Otherwise, only results matching all the search criterias are included
in the results. If no search criteria is specified, all results are returned. In all
cases, if a responseSizeLimit is specified and the number of matching results is more
than this limit, then an ErrorResponse() is returned. Specifying
searchCriteriaModeOr without any search criteria results in an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| supervisor_user_id | str | supervisorUserId |
| service_user_id | str | serviceUserId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
UserCallForwardingSelectiveModifyCriteriaRequest(OCIRequest)
Modify a criteria for the user's call forwarding selective service.
The following elements are only used in AS data mode: callToNumber For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| forward_to_number_selection | str | forwardToNumberSelection Optional |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria Optional |
| call_to_number_list | OCI.callToNumberList | callToNumberList Optional |
UserCallMeNowModifyCriteriaRequest(OCIRequest)
Modify a criteria for the user's call me now service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| reject_call | bool | rejectCall Optional |
| to_dn_criteria | OCI.toDnCriteria | toDnCriteria Optional |
UserCallNotifyModifyCriteriaRequest(OCIRequest)
Modify a criteria for the user's call notify service.
The following elements are only used in AS data mode: callToNumber For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted Optional |
| call_to_number_list | OCI.callToNumberList | callToNumberList Optional |
UserCommPilotExpressModifyRequest(OCIRequest)
Modify the user's commPilot express service setting.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command is used internally by Call Processing.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| profile | str | profile Optional |
| available_in_office | OCI.availableInOffice | availableInOffice Optional |
| available_out_of_office | OCI.availableOutOfOffice | availableOutOfOffice Optional |
| busy | OCI.busy | busy Optional |
| unavailable | OCI.unavailable | unavailable Optional |
UserCustomRingbackUserAddCriteriaRequest(OCIRequest)
Add a criteria to the user's custom ringback service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
| audio_selection | str | audioSelection |
| audio_file | OCI.audioFile | audioFile Optional |
| video_selection | str | videoSelection |
| video_file | OCI.videoFile | videoFile Optional |
| call_waiting_audio_selection | str | callWaitingAudioSelection Optional |
| call_waiting_audio_file | OCI.callWaitingAudioFile | callWaitingAudioFile Optional |
| call_waiting_video_selection | str | callWaitingVideoSelection Optional |
| call_waiting_video_file | OCI.callWaitingVideoFile | callWaitingVideoFile Optional |
UserCustomRingbackUserAddCriteriaRequest16(OCIRequest)
Add a criteria to the user's custom ringback service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
| audio_selection | str | audioSelection |
| audio_file | OCI.audioFile | audioFile Optional |
| video_selection | str | videoSelection |
| video_file | OCI.videoFile | videoFile Optional |
| call_waiting_audio_selection | str | callWaitingAudioSelection Optional |
| call_waiting_audio_file | OCI.callWaitingAudioFile | callWaitingAudioFile Optional |
| call_waiting_video_selection | str | callWaitingVideoSelection Optional |
| call_waiting_video_file | OCI.callWaitingVideoFile | callWaitingVideoFile Optional |
UserCustomRingbackUserAddCriteriaRequest20(OCIRequest)
Add a criteria to the user's custom ringback service.
For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria |
| call_to_number | List[OCI.callToNumber] | callToNumber Optional |
| audio_selection | str | audioSelection |
| audio_file | OCI.audioFile | audioFile Optional |
| video_selection | str | videoSelection |
| video_file | OCI.videoFile | videoFile Optional |
| call_waiting_audio_selection | str | callWaitingAudioSelection Optional |
| call_waiting_audio_file | OCI.callWaitingAudioFile | callWaitingAudioFile Optional |
| call_waiting_video_selection | str | callWaitingVideoSelection Optional |
| call_waiting_video_file | OCI.callWaitingVideoFile | callWaitingVideoFile Optional |
UserCustomRingbackUserModifyCriteriaRequest(OCIRequest)
Modify a criteria for the user's custom ringback service.
The response is either a SuccessResponse() or an ErrorResponse().
Replaced By: UserCustomRingbackUserModifyCriteriaRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria Optional |
| audio_selection | str | audioSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_selection | str | videoSelection Optional |
| video_file | OCI.videoFile | videoFile Optional |
| call_waiting_audio_selection | str | callWaitingAudioSelection Optional |
| call_waiting_audio_file | OCI.callWaitingAudioFile | callWaitingAudioFile Optional |
| call_waiting_video_selection | str | callWaitingVideoSelection Optional |
| call_waiting_video_file | OCI.callWaitingVideoFile | callWaitingVideoFile Optional |
UserCustomRingbackUserModifyCriteriaRequest16(OCIRequest)
Modify a criteria for the user's custom ringback service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria Optional |
| audio_selection | str | audioSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_selection | str | videoSelection Optional |
| video_file | OCI.videoFile | videoFile Optional |
| call_waiting_audio_selection | str | callWaitingAudioSelection Optional |
| call_waiting_audio_file | OCI.callWaitingAudioFile | callWaitingAudioFile Optional |
| call_waiting_video_selection | str | callWaitingVideoSelection Optional |
| call_waiting_video_file | OCI.callWaitingVideoFile | callWaitingVideoFile Optional |
UserCustomRingbackUserModifyCriteriaRequest20(OCIRequest)
Modify a criteria for the user's custom ringback service.
For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria Optional |
| call_to_number_list | OCI.callToNumberList | callToNumberList Optional |
| audio_selection | str | audioSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_selection | str | videoSelection Optional |
| video_file | OCI.videoFile | videoFile Optional |
| call_waiting_audio_selection | str | callWaitingAudioSelection Optional |
| call_waiting_audio_file | OCI.callWaitingAudioFile | callWaitingAudioFile Optional |
| call_waiting_video_selection | str | callWaitingVideoSelection Optional |
| call_waiting_video_file | OCI.callWaitingVideoFile | callWaitingVideoFile Optional |
UserEnterpriseCommonPhoneListGetPagedSortedListRequest(OCIRequest)
Get an enterprise's common phone list for a user.
The response is either a UserEnterpriseCommonPhoneListGetPagedSortedListResponse()
or an ErrorResponse(). The search can be done using multiple criterion. If the
searchCriteriaModeOr is present, any result matching any one criteria is included in
the results. Otherwise, only results matching all the search criterion are included
in the results. If no search criteria is specified, all results are returned.
Specifying searchCriteriaModeOr without any search criteria results in an
ErrorResponse(). The sort can be done on the name or the number in the common phone
list. The following elements are only used in AS data mode and ignored in XS data
mode: searchCriteriaEnterpriseCommonMultiPartPhoneListName
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl |
| sort_by_enterprise_common_phone_list_number | OCI.sortByEnterpriseCommonPhoneListNumber | sortByEnterpriseCommonPhoneListNumber Optional |
| sort_by_enterprise_common_phone_list_name | OCI.sortByEnterpriseCommonPhoneListName | sortByEnterpriseCommonPhoneListName Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
| search_criteria_enterprise_common_phone_list_name | List[OCI.searchCriteriaEnterpriseCommonPhoneListName] | searchCriteriaEnterpriseCommonPhoneListName Optional |
| search_criteria_enterprise_common_phone_list_number | List[OCI.searchCriteriaEnterpriseCommonPhoneListNumber] | searchCriteriaEnterpriseCommonPhoneListNumber Optional |
| search_criteria_enterprise_common_multi_part_phone_list_name | List[OCI.searchCriteriaEnterpriseCommonMultiPartPhoneListName] | searchCriteriaEnterpriseCommonMultiPartPhoneListName Optional |
UserExecutiveGetAvailableAssistantListRequest(OCIRequest)
Get a list of users that can be assigned to an executive.
Searching for users by group only makes sense when the executive user is part of an Enterprise.
The response is either UserExecutiveGetAvailableAssistantListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
UserExecutiveModifyFilteringSelectiveCriteriaRequest(OCIRequest)
Modify a filtering selective criteria for an executive.
Both executive and the executive assistant can run this command. For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| filter | bool | filter Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria Optional |
| call_to_number_list | OCI.callToNumberList | callToNumberList Optional |
UserFlexibleSeatingGuestGetAvailableHostListRequest(OCIRequest)
Get a list of hosts that can be assigned to flexible seating guests.
The response is either UserFlexibleSeatingGuestGetAvailableUserListResponse() or
ErrorResponse(). The response will include active hosts based on the following
criteria. - host that has the equivalent device type as the guest, host already
assigned to another guest and for a guest in a Service Provider host in the user’s
group and for a user in an Enterprise a host within the user’s group and host in the
user’s enterprise that has the accessLevel set to Enterprise.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
UserFlexibleSeatingGuestModifyRequest(OCIRequest)
Modify the user level data associated with flexible seating guest.
accessDeviceEndpoint can only be configured by group or a higher level administrator. The request fails if isActive is set to false and the guest is associated to a host. The request fails when enableAssociationLimit, associationLimitHours, unlockPhonePINCode are changed when the guest is associated to a host. The request fails when accessDeviceEndpoint is set in the request when the guest is associated to a host.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
UserFlexibleSeatingGuestModifyRequest22().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| enable_association_limit | bool | enableAssociationLimit Optional |
| association_limit_hours | int | associationLimitHours Optional |
| unlock_phone_pin_code | str | unlockPhonePINCode Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| host_user_id | str | hostUserId Optional |
UserGetListInGroupRequest(OCIRequest)
Request the list of users in a group.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The response is either a UserGetListInGroupResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | GroupId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_in_trunk_group | OCI.searchCriteriaExactUserInTrunkGroup | searchCriteriaExactUserInTrunkGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_external_id | List[OCI.searchCriteriaUserExternalId] | searchCriteriaUserExternalId Optional |
| search_criteria_exact_user_person_id | OCI.searchCriteriaExactUserPersonId | searchCriteriaExactUserPersonId Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
UserGetListInServiceProviderRequest(OCIRequest)
Request the list of users in a service provider or enterprise.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. The following elements are only used in AS data mode and ignored in XS data mode: serviceProviderExternalId
The response is either a UserGetListInServiceProviderResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| service_provider_external_id | str | serviceProviderExternalId Optional |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_in_trunk_group | OCI.searchCriteriaExactUserInTrunkGroup | searchCriteriaExactUserInTrunkGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_external_id | List[OCI.searchCriteriaUserExternalId] | searchCriteriaUserExternalId Optional |
| search_criteria_exact_user_person_id | OCI.searchCriteriaExactUserPersonId | searchCriteriaExactUserPersonId Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
UserGetListInSystemRequest(OCIRequest)
Request the list of users in the system.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the users in the administrator's reseller meeting the search criteria are returned.
The response is either a UserGetListInSystemResponse() or an ErrorResponse(). The
following data elements are only used in AS data mode: searchCriteriaResellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_exact_service_provider | OCI.searchCriteriaExactServiceProvider | searchCriteriaExactServiceProvider Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_exact_user_in_trunk_group | OCI.searchCriteriaExactUserInTrunkGroup | searchCriteriaExactUserInTrunkGroup Optional |
| search_criteria_exact_user_network_class_of_service | OCI.searchCriteriaExactUserNetworkClassOfService | searchCriteriaExactUserNetworkClassOfService Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_external_id | List[OCI.searchCriteriaUserExternalId] | searchCriteriaUserExternalId Optional |
| search_criteria_exact_user_person_id | OCI.searchCriteriaExactUserPersonId | searchCriteriaExactUserPersonId Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_reseller_id | List[OCI.searchCriteriaResellerId] | searchCriteriaResellerId Optional |
UserGetServiceInstanceListInServiceProviderRequest(OCIRequest)
Request the list of Service Instances in a service provider or an enterprise.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. searchCriteriaExactUserDepartment criteria is only applicable for an enterprise and is ignored if set for a service provider.
The response is either a UserGetServiceInstanceListInServiceProviderResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_group_id | List[OCI.SearchCriteriaGroupId] | SearchCriteriaGroupId Optional |
| search_criteria_exact_service_type | OCI.SearchCriteriaExactServiceType | SearchCriteriaExactServiceType Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
UserGetServiceInstanceListInSystemRequest(OCIRequest)
Request the list of Service Instances in the system.
It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the service instances in the administrator's reseller meeting the search criteria are returned.
The response is either a UserGetServiceInstanceListInSystemResponse() or an
ErrorResponse(). The following data elements are only used in AS data mode:
searchCriteriaResellerId
Attributes:
| Name | Type | Description |
|---|---|---|
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_exact_service_type | OCI.searchCriteriaExactServiceType | searchCriteriaExactServiceType Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_exact_service_provider | OCI.searchCriteriaExactServiceProvider | searchCriteriaExactServiceProvider Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_reseller_id | List[OCI.searchCriteriaResellerId] | searchCriteriaResellerId Optional |
UserGroupCommonPhoneListGetPagedSortedListRequest(OCIRequest)
Get a user's group's common phone list.
The response is either a UserGroupCommonPhoneListGetPagedSortedListResponse() or an
ErrorResponse(). The search can be done using multiple criterion. If the
searchCriteriaModeOr is present, any result matching any one criteria is included in
the results. Otherwise, only results matching all the search criterion are included
in the results. If no search criteria is specified, all results are returned.
Specifying searchCriteriaModeOr without any search criteria results in an
ErrorResponse(). The sort can be done on the name or the number in the common phone
list. The following elements are only used in AS data mode and ignored in XS data
mode: searchCriteriaGroupCommonMultiPartPhoneListName
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl |
| sort_by_group_common_phone_list_number | OCI.sortByGroupCommonPhoneListNumber | sortByGroupCommonPhoneListNumber Optional |
| sort_by_group_common_phone_list_name | OCI.sortByGroupCommonPhoneListName | sortByGroupCommonPhoneListName Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
| search_criteria_group_common_phone_list_name | List[OCI.searchCriteriaGroupCommonPhoneListName] | searchCriteriaGroupCommonPhoneListName Optional |
| search_criteria_group_common_phone_list_number | List[OCI.searchCriteriaGroupCommonPhoneListNumber] | searchCriteriaGroupCommonPhoneListNumber Optional |
| search_criteria_group_common_multi_part_phone_list_name | List[OCI.searchCriteriaGroupCommonMultiPartPhoneListName] | searchCriteriaGroupCommonMultiPartPhoneListName Optional |
UserGroupCustomContactDirectoryGetPagedSortedListRequest(OCIRequest)
Gets a Custom Contact Directory in a group.
The response is either UserGroupCustomContactDirectoryGetPagedSortedListResponse()
or ErrorResponse(). The search can be done using multiple criterion. If the
searchCriteriaModeOr is present, any result matching any one criteria is included in
the results. Otherwise, only results matching all the search criterion are included
in the results. If no search criteria is specified, all results are returned.
Specifying searchCriteriaModeOr without any search criteria results in an
ErrorResponse(). The sort can be done on the user last name, first name, department,
or contact notes. The Receptionist Note column is only populated, if the user sending
the request is a the owner of this Receptionist Note and a Note exists.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| name | str | name |
| response_paging_control | OCI.responsePagingControl | responsePagingControl |
| sort_by_user_last_name | OCI.sortByUserLastName | sortByUserLastName Optional |
| sort_by_user_first_name | OCI.sortByUserFirstName | sortByUserFirstName Optional |
| sort_by_user_department | OCI.sortByUserDepartment | sortByUserDepartment Optional |
| sort_by_receptionist_note | OCI.sortByReceptionistNote | sortByReceptionistNote Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_mobile_phone_number | List[OCI.searchCriteriaMobilePhoneNumber] | searchCriteriaMobilePhoneNumber Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
| search_criteria_title | List[OCI.searchCriteriaTitle] | searchCriteriaTitle Optional |
| search_criteria_receptionist_note | List[OCI.searchCriteriaReceptionistNote] | searchCriteriaReceptionistNote Optional |
UserHotelingGuestGetAvailableUserListRequest(OCIRequest)
Get a list of users that can be assigned as Hoteling Guests.
The response is either UserHotelingGuestGetAvailableUserListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
UserIncomingCallingPlanModifyRequest(OCIRequest)
Change the user's incoming calling plan settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_custom_settings | bool | useCustomSettings Optional |
| user_permissions | OCI.userPermissions | userPermissions Optional |
UserMeetMeConferencingGetAvailableDelegateListRequest(OCIRequest)
Get a list of users that can be assigned as a delegate to a Meet-Me Conference.
Searching for users, who are host on a Meet-Me Conferencing bridge.
The response is either UserMeetMeConferencingGetAvailableDelegateListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| conference_key | OCI.conferenceKey | conferenceKey |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
UserModifyRequest17sp4(OCIRequest)
Request to modify a user.
When oldPassword is specified, all password rule applies. If oldPassword in not specified, any password rule related to old password does not apply. The request will fail if officeZoneName or primaryZoneName is present but the Location-Based Calling Restrictions service is not assigned to the user.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and ignored in XS data mode:
contact[2]-contact[5] nameDialingName alternateUserIdList The impId and impPassword
are accepted when the Third-Party IMP service is assigned to the user; when Integrated
IMP service is assigned to the user and active, only the impPassword is accepted; all
other cases, the request fails if either field is changed. Replaced by:
UserModifyRequest21()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| last_name | str | lastName Optional |
| first_name | str | firstName Optional |
| calling_line_id_last_name | str | callingLineIdLastName Optional |
| calling_line_id_first_name | str | callingLineIdFirstName Optional |
| name_dialing_name | OCI.nameDialingName | nameDialingName Optional |
| hiragana_last_name | str | hiraganaLastName Optional |
| hiragana_first_name | str | hiraganaFirstName Optional |
| phone_number | str | phoneNumber Optional |
| extension | str | extension Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| old_password | str | oldPassword Optional |
| new_password | str | newPassword Optional |
| department | OCI.department | department Optional |
| language | str | language Optional |
| time_zone | str | timeZone Optional |
| sip_alias_list | OCI.sipAliasList | sipAliasList Optional |
| endpoint | OCI.endpoint | endpoint Optional |
| title | str | title Optional |
| pager_phone_number | str | pagerPhoneNumber Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| email_address | str | emailAddress Optional |
| yahoo_id | str | yahooId Optional |
| address_location | str | addressLocation Optional |
| address | OCI.address | address Optional |
| network_class_of_service | str | networkClassOfService Optional |
| office_zone_name | str | officeZoneName Optional |
| primary_zone_name | str | primaryZoneName Optional |
| imp_id | str | impId Optional |
| imp_password | str | impPassword Optional |
| alternate_user_id_list | OCI.alternateUserIdList | alternateUserIdList Optional |
UserModifyRequest21(OCIRequest)
Request to modify a user.
When oldPassword is specified, all password rule applies. If oldPassword in not specified, any password rule related to old password does not apply. The request will fail if officeZoneName or primaryZoneName is present but the Location-Based Calling Restrictions service is not assigned to the user.
The response is either SuccessResponse() or ErrorResponse(). The following data
elements are only used in AS data mode: contact[2]-contact[5] nameDialingName
alternateUserIdList The following elements are only used in AS data mode and will fail
in XS data mode: trunkAddressing The following elements are only used in XS data mode
and ignored in AS data mode: allowVideo The allowVideo element can only be used by a
system administrator. The impId and impPassword are accepted when the Third-Party IMP
service is assigned to the user; when Integrated IMP service is assigned to the user
and active, only the impPassword is accepted; all other cases, the request fails if
either field is changed. Replaced by : UserAddRequest22() in AS mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| last_name | str | lastName Optional |
| first_name | str | firstName Optional |
| calling_line_id_last_name | str | callingLineIdLastName Optional |
| calling_line_id_first_name | str | callingLineIdFirstName Optional |
| name_dialing_name | OCI.nameDialingName | nameDialingName Optional |
| hiragana_last_name | str | hiraganaLastName Optional |
| hiragana_first_name | str | hiraganaFirstName Optional |
| phone_number | str | phoneNumber Optional |
| extension | str | extension Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| old_password | str | oldPassword Optional |
| new_password | str | newPassword Optional |
| department | OCI.department | department Optional |
| language | str | language Optional |
| time_zone | str | timeZone Optional |
| sip_alias_list | OCI.sipAliasList | sipAliasList Optional |
| endpoint | OCI.endpoint | endpoint Optional |
| title | str | title Optional |
| pager_phone_number | str | pagerPhoneNumber Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| email_address | str | emailAddress Optional |
| yahoo_id | str | yahooId Optional |
| address_location | str | addressLocation Optional |
| address | OCI.address | address Optional |
| network_class_of_service | str | networkClassOfService Optional |
| office_zone_name | str | officeZoneName Optional |
| primary_zone_name | str | primaryZoneName Optional |
| imp_id | str | impId Optional |
| imp_password | str | impPassword Optional |
| alternate_user_id_list | OCI.alternateUserIdList | alternateUserIdList Optional |
| allow_video | bool | allowVideo Optional |
UserModifyRequest22(OCIRequest)
The following data elements are only used in AS data mode: contact[2]-contact[5] The following elements are only used in AS data mode and will fail in XS data mode: trunkAddressing newUserExternalId The following elements are only used in AS data mode and ignored in XS data mode: nameDialingName alternateUserIdList newUserExternalId The following elements are only used in XS data mode and ignored in AS data mode: allowVideo The allowVideo element can only be used by a system administrator.
The impId and impPassword are accepted when the Third-Party IMP service is assigned to the user; when Integrated IMP service is assigned to the user and active, only the impPassword is accepted; all other cases, the request fails if either field is changed.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| last_name | str | lastName Optional |
| first_name | str | firstName Optional |
| calling_line_id_last_name | str | callingLineIdLastName Optional |
| calling_line_id_first_name | str | callingLineIdFirstName Optional |
| name_dialing_name | OCI.nameDialingName | nameDialingName Optional |
| hiragana_last_name | str | hiraganaLastName Optional |
| hiragana_first_name | str | hiraganaFirstName Optional |
| phone_number | str | phoneNumber Optional |
| extension | str | extension Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| old_password | str | oldPassword Optional |
| new_password | str | newPassword Optional |
| department | OCI.department | department Optional |
| language | str | language Optional |
| time_zone | str | timeZone Optional |
| sip_alias_list | OCI.sipAliasList | sipAliasList Optional |
| endpoint | OCI.endpoint | endpoint Optional |
| title | str | title Optional |
| pager_phone_number | str | pagerPhoneNumber Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| email_address | str | emailAddress Optional |
| yahoo_id | str | yahooId Optional |
| address_location | str | addressLocation Optional |
| address | OCI.address | address Optional |
| network_class_of_service | str | networkClassOfService Optional |
| office_zone_name | str | officeZoneName Optional |
| primary_zone_name | str | primaryZoneName Optional |
| imp_id | str | impId Optional |
| imp_password | str | impPassword Optional |
| alternate_user_id_list | OCI.alternateUserIdList | alternateUserIdList Optional |
| allow_video | bool | allowVideo Optional |
| new_user_external_id | str | newUserExternalId Optional |
| new_user_person_id | str | newUserPersonId Optional |
UserOutgoingCallingPlanDigitPlanCallMeNowModifyRequest(OCIRequest)
Modify the Call Me Now call permissions for digit patterns for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_custom_settings | bool | useCustomSettings Optional |
| user_permissions | OCI.userPermissions | userPermissions Optional |
UserOutgoingCallingPlanDigitPlanOriginatingModifyRequest(OCIRequest)
Modify the originating permissions for digit patterns for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_custom_settings | bool | useCustomSettings Optional |
| user_permissions | OCI.userPermissions | userPermissions Optional |
UserOutgoingCallingPlanDigitPlanRedirectingModifyRequest(OCIRequest)
Modify the redirecting permissions for digit patterns for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_custom_settings | bool | useCustomSettings Optional |
| user_permissions | OCI.userPermissions | userPermissions Optional |
UserOutgoingCallingPlanPinholeDigitPlanCallMeNowModifyRequest(OCIRequest)
Modify the Call Me Now permissions for Pinhole digit patterns for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_custom_settings | bool | useCustomSettings Optional |
| user_permissions | OCI.userPermissions | userPermissions Optional |
UserOutgoingCallingPlanPinholeDigitPlanOriginatingModifyRequest(OCIRequest)
Modify the originating permissions for Pinhole digit patterns for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_custom_settings | bool | useCustomSettings Optional |
| user_permissions | OCI.userPermissions | userPermissions Optional |
UserOutgoingCallingPlanPinholeDigitPlanRedirectingModifyRequest(OCIRequest)
Modify the redirecting permissions for Pinhole digit patterns for a user.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| use_custom_settings | bool | useCustomSettings Optional |
| user_permissions | OCI.userPermissions | userPermissions Optional |
UserPersonalAssistantCallToNumberModifyListRequest(OCIRequest)
Request to modify the user assigned Call to Number List information.
The response is either a SuccessResponse() or an ErrorResponse(). For the
callToNumbers in the callToNumberList, the extension element is not used and the
number element is only used when the type is BroadWorks Mobility.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| call_to_number_list | OCI.callToNumberList | callToNumberList Optional |
UserPersonalAssistantExclusionNumberGetListRequest(OCIRequest)
Request to get the User Personal Assistant Exclusion Number List information.
The response is either a userPersonalAssistantExclusionNumberGetListResponse or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| search_criteria_personal_assistant_exclusion_number | List[OCI.searchCriteriaPersonalAssistantExclusionNumber] | searchCriteriaPersonalAssistantExclusionNumber Optional |
| search_criteria_personal_assistant_exclusion_number_description | List[OCI.searchCriteriaPersonalAssistantExclusionNumberDescription] | searchCriteriaPersonalAssistantExclusionNumberDescription Optional |
| response_size_limit | int | responseSizeLimit Optional |
UserPersonalPhoneListGetListRequest(OCIRequest)
Get a user's personal phone list.
The response is either a UserPersonalPhoneListGetListResponse() or an
ErrorResponse(). The search can be done using multiple criterion. If the
searchCriteriaModeOr is present, any result matching any one criteria is included in
the results. Otherwise, only results matching all the search criterion are included
in the results. If no search criteria is specified, all results are returned.
Specifying searchCriteriaModeOr without any search criteria results in an
ErrorResponse(). In all cases, if a responseSizeLimit is specified and the number of
matching results is more than this limit, then an ErrorResponse() is returned.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
| search_criteria_user_personal_phone_list_name | List[OCI.searchCriteriaUserPersonalPhoneListName] | searchCriteriaUserPersonalPhoneListName Optional |
| search_criteria_user_personal_phone_list_number | List[OCI.searchCriteriaUserPersonalPhoneListNumber] | searchCriteriaUserPersonalPhoneListNumber Optional |
UserPersonalPhoneListGetPagedSortedListRequest(OCIRequest)
Get a user's personal phone list.
The response is either a UserPersonalPhoneListGetPagedSortedListResponse() or an
ErrorResponse(). The search can be done using multiple criterion. If the
searchCriteriaModeOr is present, any result matching any one criteria is included in
the results. Otherwise, only results matching all the search criterion are included
in the results. If no search criteria is specified, all results are returned.
Specifying searchCriteriaModeOr without any search criteria results in an
ErrorResponse(). The sort can done by the personal phone list number or name. The
following elements are only used in AS data mode and ignored in XS data mode:
searchCriteriaUserPersonalMultiPartPhoneListName
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl |
| sort_by_user_personal_phone_list_number | OCI.sortByUserPersonalPhoneListNumber | sortByUserPersonalPhoneListNumber Optional |
| sort_by_user_personal_phone_list_name | OCI.sortByUserPersonalPhoneListName | sortByUserPersonalPhoneListName Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
| search_criteria_user_personal_phone_list_name | List[OCI.searchCriteriaUserPersonalPhoneListName] | searchCriteriaUserPersonalPhoneListName Optional |
| search_criteria_user_personal_phone_list_number | List[OCI.searchCriteriaUserPersonalPhoneListNumber] | searchCriteriaUserPersonalPhoneListNumber Optional |
| search_criteria_user_personal_multi_part_phone_list_name | List[OCI.searchCriteriaUserPersonalMultiPartPhoneListName] | searchCriteriaUserPersonalMultiPartPhoneListName Optional |
UserPhoneDirectoryGetListRequest(OCIRequest)
Request a table containing the phone directory for a user's group.
If the user's group is part of an enterprise, the directory includes all users in the enterprise and all entries in the enterprise common phone list and the common phone list of the specified group (if includeCommonPhoneList is set to true). If the user's group is part of a service provider, the directory includes all users in the group and all entries in the common phone list (if includeCommonPhoneList is set to true) of the specified group.
The response is either UserPhoneDirectoryGetListResponse() or ErrorResponse(). If
the searchCriteriaModeOr is present, any result matching any one criteria is included
in the results. Otherwise, only results matching all the search criteria are included
in the results. If no search criteria is specified, all results are returned. In all
cases, if a responseSizeLimit is specified and the number of matching results is more
than this limit, then an ErrorResponse() is returned. Specifying
searchCriteriaModeOr without any search criteria results in an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| include_common_phone_list | bool | includeCommonPhoneList |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_mobile_phone_number | List[OCI.searchCriteriaMobilePhoneNumber] | searchCriteriaMobilePhoneNumber Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_exact_custom_contact_directory | OCI.searchCriteriaExactCustomContactDirectory | searchCriteriaExactCustomContactDirectory Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
UserPhoneDirectoryGetPagedListRequest(OCIRequest)
Request a table containing the phone directory for a user.
Setting isEnterpriseRequested to true will return enterprise directory members in the response if the user is in an enterprise. Otherwise, just the group directory members for a user are returned in the response.
The response is either UserPhoneDirectoryGetPagedListResponse() or
ErrorResponse(). The search can be done using multiple criteria. If the
searchCriteriaModeOr is present, any result matching any one criteria is included in
the results. Otherwise, only results matching all the search criteria are included in
the results. If no search criteria is specified, all results are returned. In all
cases, if a responseSizeLimit is specified and the number of matching results is more
than this limit, then an ErrorResponse() is returned. Specifying
searchCriteriaModeOr without any search criteria results in an ErrorResponse(). The
boolean sortByFirstName is optional. If it is not specified, the response is sorted
by Last Name. The Receptionist Note column is only populated, if the user sending the
request is the owner of the Receptionist Note and a Note exists.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_enterprise_info_requested | bool | isEnterpriseInfoRequested |
| response_paging_control | OCI.responsePagingControl | responsePagingControl |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_group_location_code | List[OCI.searchCriteriaGroupLocationCode] | searchCriteriaGroupLocationCode Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_mobile_phone_number | List[OCI.searchCriteriaMobilePhoneNumber] | searchCriteriaMobilePhoneNumber Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_yahoo_id | List[OCI.searchCriteriaYahooId] | searchCriteriaYahooId Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
| sort_by_first_name | bool | sortByFirstName Optional |
| search_criteria_title | List[OCI.searchCriteriaTitle] | searchCriteriaTitle Optional |
| search_criteria_receptionist_note | List[OCI.searchCriteriaReceptionistNote] | searchCriteriaReceptionistNote Optional |
UserPhoneDirectoryGetPagedSortedListRequest(OCIRequest)
Request a table containing the phone directory for a user.
Setting isEnterpriseRequested to true will return enterprise directory members in the response if the user is in an enterprise. Otherwise, just the group directory members for a user are returned in the response.
The response is either UserPhoneDirectoryGetPagedSortedListResponse() or
ErrorResponse(). The search can be done using multiple criteria. If the
searchCriteriaModeOr is present, any result matching any one criteria is included in
the results. Otherwise, only results matching all the search criteria are included in
the results. If no search criteria is specified, all results are returned.
Specifying searchCriteriaModeOr without any search criteria results in an
ErrorResponse(). The sort can be performed on user last name, first name,
department, or receptionist note. The Receptionist Note column is only populated, if
the user sending the request is the owner of the Receptionist Note and a Note exists.
The following elements are only used in AS data mode and ignored in XS data mode:
searchCriteriaMultiPartName
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_enterprise_info_requested | bool | isEnterpriseInfoRequested |
| response_paging_control | OCI.responsePagingControl | responsePagingControl |
| sort_by_user_last_name | OCI.sortByUserLastName | sortByUserLastName Optional |
| sort_by_user_first_name | OCI.sortByUserFirstName | sortByUserFirstName Optional |
| sort_by_user_department | OCI.sortByUserDepartment | sortByUserDepartment Optional |
| sort_by_receptionist_note | OCI.sortByReceptionistNote | sortByReceptionistNote Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_name | List[OCI.searchCriteriaUserName] | searchCriteriaUserName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_group_location_code | List[OCI.searchCriteriaGroupLocationCode] | searchCriteriaGroupLocationCode Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_mobile_phone_number | List[OCI.searchCriteriaMobilePhoneNumber] | searchCriteriaMobilePhoneNumber Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_yahoo_id | List[OCI.searchCriteriaYahooId] | searchCriteriaYahooId Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
| search_criteria_title | List[OCI.searchCriteriaTitle] | searchCriteriaTitle Optional |
| search_criteria_receptionist_note | List[OCI.searchCriteriaReceptionistNote] | searchCriteriaReceptionistNote Optional |
| search_criteria_multi_part_name | List[OCI.searchCriteriaMultiPartName] | searchCriteriaMultiPartName Optional |
UserPreAlertingAnnouncementModifyCriteriaRequest(OCIRequest)
Modify a criteria for the user's pre-alerting service.
The following elements are only used in AS data mode: callToNumber For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria Optional |
| call_to_number_list | OCI.callToNumberList | callToNumberList Optional |
UserPreAlertingAnnouncementModifyRequest(OCIRequest)
Modify the user's pre-alerting service setting.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
UserPreAlertingAnnouncementModifyRequest20() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| audio_selection | str | audioSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_selection | str | videoSelection Optional |
| video_file | OCI.videoFile | videoFile Optional |
| criteria_activation | List[OCI.criteriaActivation] | criteriaActivation Optional |
UserPreAlertingAnnouncementModifyRequest20(OCIRequest)
Modify the user's pre-alerting service setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| audio_selection | str | audioSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_selection | str | videoSelection Optional |
| video_file | OCI.videoFile | videoFile Optional |
| criteria_activation | List[OCI.criteriaActivation] | criteriaActivation Optional |
UserPreferredAnswerEndpointModifyRequest(OCIRequest)
Request to configure a user's Preferred Answer Endpoint for Auto-Answer and Forced Answer.
Setting preferredAnswerEndpoint to nil will clear the user's configured Preferred Answer Endpoint.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| preferred_answer_endpoint | OCI.preferredAnswerEndpoint | preferredAnswerEndpoint Optional |
UserPriorityAlertModifyCriteriaRequest(OCIRequest)
Modify a criteria for the user's priority alert service.
The following elements are only used in AS data mode: callToNumberList For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted Optional |
| call_to_number_list | OCI.callToNumberList | callToNumberList Optional |
UserPrivacyGetAvailableMonitorsUserListRequest(OCIRequest)
Retrieves a list of users in the enterprise or group available for phone status monitoring the user specified in the userId element.
The response is either UserPrivacyGetAvailableMonitorsUserListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
UserPushToTalkGetAvailableUserListRequest(OCIRequest)
Get a list of available users for the push to talk service.
The response is either UserPushToTalkGetAvailableUserListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| response_size_limit | int | responseSizeLimit Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
UserScheduleGetEventDetailListRequest(OCIRequest)
Request the list of schedules viewable by a User.
The list can be filtered by schedule type.
The response is either a UserScheduleGetEventListForGroupResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| schedule_global_key | OCI.scheduleGlobalKey | scheduleGlobalKey |
UserScheduleGetPagedSortedListRequest(OCIRequest)
Get the list of schedules viewable by a User.
The list can be filtered by schedule name, schedule type, and schedule level.
The response is either a UserScheduleGetPagedSortedListResponse() or an
ErrorResponse(). This command is authorized to user who is Executive-Assistant of
the Executive. If no sortOrder is included, the response is sorted by Name ascending
by default. If the responsePagingControl element is not provided, the paging
startIndex will be set to 1 by default, and the responsePageSize will be set to the
maximum responsePageSize by default. Multiple search criteria are logically ANDed
together unless the searchCriteriaModeOr option is included. Then the search criteria
are logically ORed together.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_by_schedule_name | OCI.sortByScheduleName | sortByScheduleName Optional |
| search_criteria_schedule_name | List[OCI.searchCriteriaScheduleName] | searchCriteriaScheduleName Optional |
| search_criteria_exact_schedule_type | List[OCI.searchCriteriaExactScheduleType] | searchCriteriaExactScheduleType Optional |
| search_criteria_exact_schedule_level | List[OCI.searchCriteriaExactScheduleLevel] | searchCriteriaExactScheduleLevel Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
UserSelectiveCallAcceptanceModifyCriteriaRequest(OCIRequest)
Modify a criteria for the user's selective call acceptance service.
The following elements are only used in AS data mode: callToNumberList For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted Optional |
| call_to_number_list | OCI.callToNumberList | callToNumberList Optional |
UserSelectiveCallRejectionModifyCriteriaRequest(OCIRequest)
Modify a criteria for the user's selective call rejection service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted Optional |
UserSelectiveCallRejectionModifyCriteriaRequest16(OCIRequest)
Modify a criteria for the user's selective call rejection service.
The following elements are only used in AS data mode: callToNumberList For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted Optional |
| call_to_number_list | OCI.callToNumberList | callToNumberList Optional |
UserSequentialRingModifyCriteriaRequest(OCIRequest)
Modify a criteria for the user's sequential ring service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted Optional |
UserSequentialRingModifyCriteriaRequest23(OCIRequest)
Modify a criteria for the user's sequential ring service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| from_dn_criteria23 | OCI.fromDnCriteria23 | fromDnCriteria23 Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted Optional |
UserSharedCallAppearanceAddEndpointRequest14(OCIRequest)
Associate an access device instance to the user's Shared Call Appearance.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint |
UserSharedCallAppearanceAddEndpointRequest14sp2(OCIRequest)
Associate an access device instance to the user's Shared Call Appearance.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
UserSharedCallAppearanceAddEndpointRequest21() in XS data mode Replaced by:
UserSharedCallAppearanceAddEndpointRequest22() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint |
| is_active | bool | isActive |
| allow_origination | bool | allowOrigination |
| allow_termination | bool | allowTermination |
UserSharedCallAppearanceAddEndpointRequest21sp2(OCIRequest)
Associate an access device instance to the user's Shared Call Appearance.
The response is either a SuccessResponse() or an ErrorResponse(). Replaced by:
UserSharedCallAppearanceAddEndpointRequest21sp2().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint |
| is_active | bool | isActive |
| allow_origination | bool | allowOrigination |
| allow_termination | bool | allowTermination |
| allow_video | bool | allowVideo |
UserSharedCallAppearanceAddEndpointRequest22(OCIRequest)
Associate an access device instance to the user's Shared Call Appearance.
The following elements are ignored in XS data mode: allowVideo, useValue true in AS data mode
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint |
| is_active | bool | isActive |
| allow_origination | bool | allowOrigination |
| allow_termination | bool | allowTermination |
| allow_video | bool | allowVideo |
UserSharedCallAppearanceDeleteEndpointListRequest14(OCIRequest)
Disassociate one or more of a user's Shared Call Appearance endpoints.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| access_device_endpoint | List[OCI.accessDeviceEndpoint] | accessDeviceEndpoint |
UserSharedCallAppearanceGetEndpointRequest(OCIRequest)
Get the user's Shared Call Appearance endpoint setting.
The response is either a UserSharedCallAppearanceGetEndpointResponse() or an
ErrorResponse(). Replaced by: UserSharedCallAppearanceGetEndpointRequest21() in XS
data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint |
UserSharedCallAppearanceGetEndpointRequest22(OCIRequest)
Get the user's Shared Call Appearance endpoint setting.
The response is either a UserSharedCallAppearanceGetEndpointResponse22() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint |
UserSharedCallAppearanceModifyEndpointRequest(OCIRequest)
Associate/Disassociate an access device instance to the user's Shared Call Appearance.
The following elements are only used in AS data mode and ignored in XS data mode: useHotline hotlineContact
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint |
| is_active | bool | isActive Optional |
| allow_origination | bool | allowOrigination Optional |
| allow_termination | bool | allowTermination Optional |
| use_hotline | bool | useHotline Optional |
| hotline_contact | str | hotlineContact Optional |
UserSimultaneousRingFamilyModifyCriteriaRequest(OCIRequest)
Modify a criteria for the user's simultaneous ring family service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria Optional |
UserSimultaneousRingFamilyModifyRequest17(OCIRequest)
Modify the user's simultaneous ring family service setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| do_not_ring_if_on_call | bool | doNotRingIfOnCall Optional |
| simultaneous_ring_number_list | OCI.simultaneousRingNumberList | simultaneousRingNumberList Optional |
| criteria_activation | List[OCI.criteriaActivation] | criteriaActivation Optional |
UserSimultaneousRingPersonalModifyCriteriaRequest(OCIRequest)
Modify a criteria for the user's simultaneous ring personal service.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| criteria_name | str | criteriaName |
| new_criteria_name | str | newCriteriaName Optional |
| time_schedule | OCI.timeSchedule | timeSchedule Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| blacklisted | bool | blacklisted Optional |
| from_dn_criteria | OCI.fromDnCriteria | fromDnCriteria Optional |
UserSimultaneousRingPersonalModifyRequest17(OCIRequest)
Modify the user's simultaneous ring personal service setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| do_not_ring_if_on_call | bool | doNotRingIfOnCall Optional |
| simultaneous_ring_number_list | OCI.simultaneousRingNumberList | simultaneousRingNumberList Optional |
| criteria_activation | List[OCI.criteriaActivation] | criteriaActivation Optional |
UserVideoAddOnModifyRequest14(OCIRequest)
Modify the user's Video Add-On service setting.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| max_originating_call_delay_seconds | int | maxOriginatingCallDelaySeconds Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
UserVoiceMessagingUserModifyGreetingRequest(OCIRequest)
Modify the user's voice messaging greeting.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command is used internally by Call Processing.
Replaced By: UserVoiceMessagingUserModifyGreetingRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| busy_announcement_selection | str | busyAnnouncementSelection Optional |
| busy_personal_audio_file | OCI.busyPersonalAudioFile | busyPersonalAudioFile Optional |
| busy_personal_video_file | OCI.busyPersonalVideoFile | busyPersonalVideoFile Optional |
| no_answer_announcement_selection | str | noAnswerAnnouncementSelection Optional |
| no_answer_personal_audio_file | OCI.noAnswerPersonalAudioFile | noAnswerPersonalAudioFile Optional |
| no_answer_personal_video_file | OCI.noAnswerPersonalVideoFile | noAnswerPersonalVideoFile Optional |
| no_answer_alternate_greeting01 | OCI.noAnswerAlternateGreeting01 | noAnswerAlternateGreeting01 Optional |
| no_answer_alternate_greeting02 | OCI.noAnswerAlternateGreeting02 | noAnswerAlternateGreeting02 Optional |
| no_answer_alternate_greeting03 | OCI.noAnswerAlternateGreeting03 | noAnswerAlternateGreeting03 Optional |
| no_answer_number_of_rings | int | noAnswerNumberOfRings Optional |
UserVoiceMessagingUserModifyGreetingRequest16(OCIRequest)
Modify the user's voice messaging greeting.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command is used internally by Call Processing. The following elements are
only used in AS data mode and ignored in XS data mode: disableMessageDeposit
disableMessageDepositAction greetingOnlyForwardDestination Replaced by
UserVoiceMessagingUserModifyGreetingRequest20() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| busy_announcement_selection | str | busyAnnouncementSelection Optional |
| busy_personal_audio_file | OCI.busyPersonalAudioFile | busyPersonalAudioFile Optional |
| busy_personal_video_file | OCI.busyPersonalVideoFile | busyPersonalVideoFile Optional |
| no_answer_announcement_selection | str | noAnswerAnnouncementSelection Optional |
| no_answer_personal_audio_file | OCI.noAnswerPersonalAudioFile | noAnswerPersonalAudioFile Optional |
| no_answer_personal_video_file | OCI.noAnswerPersonalVideoFile | noAnswerPersonalVideoFile Optional |
| extended_away_enabled | bool | extendedAwayEnabled Optional |
| extended_away_disable_message_deposit | bool | extendedAwayDisableMessageDeposit Optional |
| extended_away_audio_file | OCI.extendedAwayAudioFile | extendedAwayAudioFile Optional |
| extended_away_video_file | OCI.extendedAwayVideoFile | extendedAwayVideoFile Optional |
| no_answer_alternate_greeting01 | OCI.noAnswerAlternateGreeting01 | noAnswerAlternateGreeting01 Optional |
| no_answer_alternate_greeting02 | OCI.noAnswerAlternateGreeting02 | noAnswerAlternateGreeting02 Optional |
| no_answer_alternate_greeting03 | OCI.noAnswerAlternateGreeting03 | noAnswerAlternateGreeting03 Optional |
| no_answer_number_of_rings | int | noAnswerNumberOfRings Optional |
| disable_message_deposit | bool | disableMessageDeposit Optional |
| disable_message_deposit_action | str | disableMessageDepositAction Optional |
| greeting_only_forward_destination | str | greetingOnlyForwardDestination Optional |
UserVoiceMessagingUserModifyGreetingRequest20(OCIRequest)
Modify the user's voice messaging greeting.
The response is either a SuccessResponse() or an ErrorResponse(). Engineering
Note: This command is used internally by Call Processing. The following elements are
only used in AS data mode: disableMessageDeposit disableMessageDepositAction
greetingOnlyForwardDestination
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| busy_announcement_selection | str | busyAnnouncementSelection Optional |
| busy_personal_audio_file | OCI.busyPersonalAudioFile | busyPersonalAudioFile Optional |
| busy_personal_video_file | OCI.busyPersonalVideoFile | busyPersonalVideoFile Optional |
| no_answer_announcement_selection | str | noAnswerAnnouncementSelection Optional |
| no_answer_personal_audio_file | OCI.noAnswerPersonalAudioFile | noAnswerPersonalAudioFile Optional |
| no_answer_personal_video_file | OCI.noAnswerPersonalVideoFile | noAnswerPersonalVideoFile Optional |
| no_answer_alternate_greeting01 | OCI.noAnswerAlternateGreeting01 | noAnswerAlternateGreeting01 Optional |
| no_answer_alternate_greeting02 | OCI.noAnswerAlternateGreeting02 | noAnswerAlternateGreeting02 Optional |
| no_answer_alternate_greeting03 | OCI.noAnswerAlternateGreeting03 | noAnswerAlternateGreeting03 Optional |
| extended_away_enabled | bool | extendedAwayEnabled Optional |
| extended_away_disable_message_deposit | bool | extendedAwayDisableMessageDeposit Optional |
| extended_away_audio_file | OCI.extendedAwayAudioFile | extendedAwayAudioFile Optional |
| extended_away_video_file | OCI.extendedAwayVideoFile | extendedAwayVideoFile Optional |
| no_answer_number_of_rings | int | noAnswerNumberOfRings Optional |
| disable_message_deposit | bool | disableMessageDeposit Optional |
| disable_message_deposit_action | str | disableMessageDepositAction Optional |
| greeting_only_forward_destination | str | greetingOnlyForwardDestination Optional |
UserVoiceMessagingUserModifyRequest(OCIRequest)
Modify the user's voice messaging advanced voice management service setting.
Modify a voice mail distribution list for a users voice message. Modify the user's voice messaging greeting. Modify the user's voice messaging outgoing message waiting indicator service setting. Modify the user's voice messaging voice portal settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mail_server_selection | str | mailServerSelection Optional |
| group_mail_server_email_address | str | groupMailServerEmailAddress Optional |
| group_mail_server_user_id | str | groupMailServerUserId Optional |
| group_mail_server_password | str | groupMailServerPassword Optional |
| use_group_default_mail_server_full_mailbox_limit | bool | useGroupDefaultMailServerFullMailboxLimit Optional |
| group_mail_server_full_mailbox_limit | int | groupMailServerFullMailboxLimit Optional |
| personal_mail_server_net_address | str | personalMailServerNetAddress Optional |
| personal_mail_server_protocol | str | personalMailServerProtocol Optional |
| personal_mail_server_real_delete_for_imap | bool | personalMailServerRealDeleteForImap Optional |
| personal_mail_server_email_address | str | personalMailServerEmailAddress Optional |
| personal_mail_server_user_id | str | personalMailServerUserId Optional |
| personal_mail_server_password | str | personalMailServerPassword Optional |
| voice_messaging_distribution_list | List[OCI.voiceMessagingDistributionList] | voiceMessagingDistributionList Optional |
| busy_announcement_selection | str | busyAnnouncementSelection Optional |
| busy_personal_audio_file | OCI.busyPersonalAudioFile | busyPersonalAudioFile Optional |
| busy_personal_video_file | OCI.busyPersonalVideoFile | busyPersonalVideoFile Optional |
| no_answer_announcement_selection | str | noAnswerAnnouncementSelection Optional |
| no_answer_personal_audio_file | OCI.noAnswerPersonalAudioFile | noAnswerPersonalAudioFile Optional |
| no_answer_personal_video_file | OCI.noAnswerPersonalVideoFile | noAnswerPersonalVideoFile Optional |
| no_answer_alternate_greeting01 | OCI.noAnswerAlternateGreeting01 | noAnswerAlternateGreeting01 Optional |
| no_answer_alternate_greeting02 | OCI.noAnswerAlternateGreeting02 | noAnswerAlternateGreeting02 Optional |
| no_answer_alternate_greeting03 | OCI.noAnswerAlternateGreeting03 | noAnswerAlternateGreeting03 Optional |
| extended_away_enabled | bool | extendedAwayEnabled Optional |
| extended_away_disable_message_deposit | bool | extendedAwayDisableMessageDeposit Optional |
| extended_away_audio_file | OCI.extendedAwayAudioFile | extendedAwayAudioFile Optional |
| extended_away_video_file | OCI.extendedAwayVideoFile | extendedAwayVideoFile Optional |
| no_answer_number_of_rings | int | noAnswerNumberOfRings Optional |
| disable_message_deposit | bool | disableMessageDeposit Optional |
| disable_message_deposit_action | str | disableMessageDepositAction Optional |
| greeting_only_forward_destination | str | greetingOnlyForwardDestination Optional |
| outgoing_smdimw_iis_active | bool | outgoingSMDIMWIisActive Optional |
| outgoing_smdimwi_phone_number_list | OCI.outgoingSMDIMWIPhoneNumberList | outgoingSMDIMWIPhoneNumberList Optional |
| voice_managementis_active | bool | voiceManagementisActive Optional |
| processing | str | processing Optional |
| voice_message_delivery_email_address | str | voiceMessageDeliveryEmailAddress Optional |
| use_phone_message_waiting_indicator | bool | usePhoneMessageWaitingIndicator Optional |
| send_voice_message_notify_email | bool | sendVoiceMessageNotifyEmail Optional |
| voice_message_notify_email_address | str | voiceMessageNotifyEmailAddress Optional |
| send_carbon_copy_voice_message | bool | sendCarbonCopyVoiceMessage Optional |
| voice_message_carbon_copy_email_address | str | voiceMessageCarbonCopyEmailAddress Optional |
| transfer_on_zero_to_phone_number | bool | transferOnZeroToPhoneNumber Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| always_redirect_to_voice_mail | bool | alwaysRedirectToVoiceMail Optional |
| busy_redirect_to_voice_mail | bool | busyRedirectToVoiceMail Optional |
| no_answer_redirect_to_voice_mail | bool | noAnswerRedirectToVoiceMail Optional |
| out_of_primary_zone_redirect_to_voice_mail | bool | outOfPrimaryZoneRedirectToVoiceMail Optional |
| use_personalized_name | bool | usePersonalizedName Optional |
| voice_portal_auto_login | bool | voicePortalAutoLogin Optional |
| personalized_name_audio_file | OCI.personalizedNameAudioFile | personalizedNameAudioFile Optional |
| user_messaging_alias_list | OCI.userMessagingAliasList | userMessagingAliasList Optional |
UserVoiceMessagingUserModifyRequest23(OCIRequest)
Modify the user's voice messaging advanced voice management service setting.
Modify a voice mail distribution list for a users voice message. Modify the user's voice messaging greeting. Modify the user's voice messaging outgoing message waiting indicator service setting. Modify the user's voice messaging voice portal settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mail_server_selection | str | mailServerSelection Optional |
| group_mail_server_email_address | str | groupMailServerEmailAddress Optional |
| group_mail_server_user_id | str | groupMailServerUserId Optional |
| group_mail_server_password | str | groupMailServerPassword Optional |
| use_group_default_mail_server_full_mailbox_limit | bool | useGroupDefaultMailServerFullMailboxLimit Optional |
| group_mail_server_full_mailbox_limit | int | groupMailServerFullMailboxLimit Optional |
| personal_mail_server_net_address | str | personalMailServerNetAddress Optional |
| personal_mail_server_protocol | str | personalMailServerProtocol Optional |
| personal_mail_server_real_delete_for_imap | bool | personalMailServerRealDeleteForImap Optional |
| personal_mail_server_email_address | str | personalMailServerEmailAddress Optional |
| personal_mail_server_user_id | str | personalMailServerUserId Optional |
| personal_mail_server_password | str | personalMailServerPassword Optional |
| voice_messaging_distribution_list | List[OCI.voiceMessagingDistributionList] | voiceMessagingDistributionList Optional |
| busy_announcement_selection | str | busyAnnouncementSelection Optional |
| busy_personal_audio_file | OCI.busyPersonalAudioFile | busyPersonalAudioFile Optional |
| busy_personal_video_file | OCI.busyPersonalVideoFile | busyPersonalVideoFile Optional |
| no_answer_announcement_selection | str | noAnswerAnnouncementSelection Optional |
| no_answer_personal_audio_file | OCI.noAnswerPersonalAudioFile | noAnswerPersonalAudioFile Optional |
| no_answer_personal_video_file | OCI.noAnswerPersonalVideoFile | noAnswerPersonalVideoFile Optional |
| no_answer_alternate_greeting01 | OCI.noAnswerAlternateGreeting01 | noAnswerAlternateGreeting01 Optional |
| no_answer_alternate_greeting02 | OCI.noAnswerAlternateGreeting02 | noAnswerAlternateGreeting02 Optional |
| no_answer_alternate_greeting03 | OCI.noAnswerAlternateGreeting03 | noAnswerAlternateGreeting03 Optional |
| extended_away_enabled | bool | extendedAwayEnabled Optional |
| extended_away_disable_message_deposit | bool | extendedAwayDisableMessageDeposit Optional |
| extended_away_audio_file | OCI.extendedAwayAudioFile | extendedAwayAudioFile Optional |
| extended_away_video_file | OCI.extendedAwayVideoFile | extendedAwayVideoFile Optional |
| no_answer_number_of_rings | int | noAnswerNumberOfRings Optional |
| disable_message_deposit | bool | disableMessageDeposit Optional |
| disable_message_deposit_action | str | disableMessageDepositAction Optional |
| greeting_only_forward_destination | str | greetingOnlyForwardDestination Optional |
| outgoing_smdimw_iis_active | bool | outgoingSMDIMWIisActive Optional |
| outgoing_smdimwi_phone_number_list | OCI.outgoingSMDIMWIPhoneNumberList | outgoingSMDIMWIPhoneNumberList Optional |
| voice_managementis_active | bool | voiceManagementisActive Optional |
| processing | str | processing Optional |
| voice_message_delivery_email_address | str | voiceMessageDeliveryEmailAddress Optional |
| use_phone_message_waiting_indicator | bool | usePhoneMessageWaitingIndicator Optional |
| send_voice_message_notify_email | bool | sendVoiceMessageNotifyEmail Optional |
| voice_message_notify_email_address | str | voiceMessageNotifyEmailAddress Optional |
| send_carbon_copy_voice_message | bool | sendCarbonCopyVoiceMessage Optional |
| voice_message_carbon_copy_email_address | str | voiceMessageCarbonCopyEmailAddress Optional |
| transfer_on_zero_to_phone_number | bool | transferOnZeroToPhoneNumber Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| always_redirect_to_voice_mail | bool | alwaysRedirectToVoiceMail Optional |
| busy_redirect_to_voice_mail | bool | busyRedirectToVoiceMail Optional |
| no_answer_redirect_to_voice_mail | bool | noAnswerRedirectToVoiceMail Optional |
| out_of_primary_zone_redirect_to_voice_mail | bool | outOfPrimaryZoneRedirectToVoiceMail Optional |
| use_personalized_name | bool | usePersonalizedName Optional |
| voice_portal_auto_login | bool | voicePortalAutoLogin Optional |
| personalized_name_audio_file | OCI.personalizedNameAudioFile | personalizedNameAudioFile Optional |
| user_messaging_alias_list | OCI.userMessagingAliasList | userMessagingAliasList Optional |
UserVoiceMessagingUserModifyRequest23V2(OCIRequest)
Modify the user's voice messaging advanced voice management service setting.
Modify a voice mail distribution list for a users voice message. Modify the user's voice messaging greeting. Modify the user's voice messaging outgoing message waiting indicator service setting. Modify the user's voice messaging voice portal settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| mail_server_selection | str | mailServerSelection Optional |
| group_mail_server_email_address | str | groupMailServerEmailAddress Optional |
| group_mail_server_user_id | str | groupMailServerUserId Optional |
| group_mail_server_password | str | groupMailServerPassword Optional |
| use_group_default_mail_server_full_mailbox_limit | bool | useGroupDefaultMailServerFullMailboxLimit Optional |
| group_mail_server_full_mailbox_limit | int | groupMailServerFullMailboxLimit Optional |
| personal_mail_server_net_address | str | personalMailServerNetAddress Optional |
| personal_mail_server_protocol | str | personalMailServerProtocol Optional |
| personal_mail_server_real_delete_for_imap | bool | personalMailServerRealDeleteForImap Optional |
| personal_mail_server_email_address | str | personalMailServerEmailAddress Optional |
| personal_mail_server_user_id | str | personalMailServerUserId Optional |
| personal_mail_server_password | str | personalMailServerPassword Optional |
| voice_messaging_distribution_list | List[OCI.voiceMessagingDistributionList] | voiceMessagingDistributionList Optional |
| busy_announcement_selection | str | busyAnnouncementSelection Optional |
| busy_personal_audio_file | OCI.busyPersonalAudioFile | busyPersonalAudioFile Optional |
| busy_personal_video_file | OCI.busyPersonalVideoFile | busyPersonalVideoFile Optional |
| no_answer_announcement_selection | str | noAnswerAnnouncementSelection Optional |
| no_answer_personal_audio_file | OCI.noAnswerPersonalAudioFile | noAnswerPersonalAudioFile Optional |
| no_answer_personal_video_file | OCI.noAnswerPersonalVideoFile | noAnswerPersonalVideoFile Optional |
| no_answer_alternate_greeting01 | OCI.noAnswerAlternateGreeting01 | noAnswerAlternateGreeting01 Optional |
| no_answer_alternate_greeting02 | OCI.noAnswerAlternateGreeting02 | noAnswerAlternateGreeting02 Optional |
| no_answer_alternate_greeting03 | OCI.noAnswerAlternateGreeting03 | noAnswerAlternateGreeting03 Optional |
| extended_away_enabled | bool | extendedAwayEnabled Optional |
| extended_away_disable_message_deposit | bool | extendedAwayDisableMessageDeposit Optional |
| extended_away_audio_file | OCI.extendedAwayAudioFile | extendedAwayAudioFile Optional |
| extended_away_video_file | OCI.extendedAwayVideoFile | extendedAwayVideoFile Optional |
| no_answer_number_of_rings | int | noAnswerNumberOfRings Optional |
| disable_message_deposit | bool | disableMessageDeposit Optional |
| disable_message_deposit_action | str | disableMessageDepositAction Optional |
| greeting_only_forward_destination | str | greetingOnlyForwardDestination Optional |
| outgoing_smdimw_iis_active | bool | outgoingSMDIMWIisActive Optional |
| outgoing_smdimwi_phone_number_list | OCI.outgoingSMDIMWIPhoneNumberList | outgoingSMDIMWIPhoneNumberList Optional |
| voice_managementis_active | bool | voiceManagementisActive Optional |
| processing | str | processing Optional |
| voice_message_delivery_email_address | OCI.voiceMessageDeliveryEmailAddress | voiceMessageDeliveryEmailAddress Optional |
| use_phone_message_waiting_indicator | bool | usePhoneMessageWaitingIndicator Optional |
| send_voice_message_notify_email | bool | sendVoiceMessageNotifyEmail Optional |
| voice_message_notify_email_address | str | voiceMessageNotifyEmailAddress Optional |
| send_carbon_copy_voice_message | bool | sendCarbonCopyVoiceMessage Optional |
| voice_message_carbon_copy_email_address | str | voiceMessageCarbonCopyEmailAddress Optional |
| transfer_on_zero_to_phone_number | bool | transferOnZeroToPhoneNumber Optional |
| transfer_phone_number | str | transferPhoneNumber Optional |
| always_redirect_to_voice_mail | bool | alwaysRedirectToVoiceMail Optional |
| busy_redirect_to_voice_mail | bool | busyRedirectToVoiceMail Optional |
| no_answer_redirect_to_voice_mail | bool | noAnswerRedirectToVoiceMail Optional |
| out_of_primary_zone_redirect_to_voice_mail | bool | outOfPrimaryZoneRedirectToVoiceMail Optional |
| use_personalized_name | bool | usePersonalizedName Optional |
| voice_portal_auto_login | bool | voicePortalAutoLogin Optional |
| personalized_name_audio_file | OCI.personalizedNameAudioFile | personalizedNameAudioFile Optional |
| user_messaging_alias_list | OCI.userMessagingAliasList | userMessagingAliasList Optional |
EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest(OCIRequest)
Request a summary table of all Mobile Subscriber Directory Numbers in an enterprise.
If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. If no sortOrder is included the response is sorted by Mobile Number ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together. The department in both the search criteria and sort by fields refer to the department of the user.
The response is either
EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListResponse()
or ErrorResponse(). Replaced by:
EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_mobile_subscriber_directory_number | List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] | searchCriteriaMobileSubscriberDirectoryNumber Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_exact_mobile_network | List[OCI.searchCriteriaExactMobileNetwork] | searchCriteriaExactMobileNetwork Optional |
| search_criteria_exact_mobile_dn_availability | OCI.searchCriteriaExactMobileDnAvailability | searchCriteriaExactMobileDnAvailability Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest22(OCIRequest)
Request a summary table of all Mobile Subscriber Directory Numbers in an enterprise.
If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. If no sortOrder is included the response is sorted by Mobile Number ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together. The department in both the search criteria and sort by fields refer to the department of the user.
The response is either
EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListResponse22()
or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| include_total_number_of_rows | bool | includeTotalNumberOfRows Optional |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_mobile_subscriber_directory_number | List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] | searchCriteriaMobileSubscriberDirectoryNumber Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_exact_mobile_network | List[OCI.searchCriteriaExactMobileNetwork] | searchCriteriaExactMobileNetwork Optional |
| search_criteria_exact_mobile_dn_availability | OCI.searchCriteriaExactMobileDnAvailability | searchCriteriaExactMobileDnAvailability Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest(OCIRequest)
Get the list of all Agents in the Enterprise that can be assigned to a given Call Center Agent Threshold Profile in an Enterprise.
An agent is available to be assigned to a given Agent Threshold Profile if it is a
Call Center Standard or Call Center Premium agent and the agent is not yet assigned to
the profile. If the responsePagingControl element is not provided, the paging
startIndex will be set to 1 by default, and the responsePageSize will be set to the
maximum ResponsePageSize by default. It is possible to search by various criteria to
restrict the number of rows returned. The available agent list for a new Call Center
Agent Threshold profile can be obtained by not setting the
excludeAgentsAssignedToProfileName. When the excludeAgentsAssignedToProfileName is
specified, all agents already assigned to the specified profile are not included in
the response, even if the search criterion element searchCriteriaAgentThresholdProfile
is specified using the same profile name. If no sortOrder is included the response is
sorted by User Id ascending by default. Multiple search criteria are logically ANDed
together unless the searchCriteriaModeOr option is included. Then the search criteria
are logically ORed together. ErrorResponse() is returned if
searchCriteriaExactUserGroup has multiple entries and searchCriteriaModeOr is not
included.
The response is either a
EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListResponse()
or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| exclude_agents_assigned_to_profile_name | str | excludeAgentsAssignedToProfileName Optional |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_agent_threshold_profile | List[OCI.searchCriteriaAgentThresholdProfile] | searchCriteriaAgentThresholdProfile Optional |
| search_criteria_exact_user_group | List[OCI.searchCriteriaExactUserGroup] | searchCriteriaExactUserGroup Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest(OCIRequest)
Gets an existing specified Call Center Agent Threshold Profile in an Enterprise.
The agentTable is what the search, sort, and pagination fields apply to. If the
responsePagingControl element is not provided, the paging startIndex will be set to 1
by default, and the responsePageSize will be set to the maximum ResponsePageSize by
default. It is possible to search by various criteria to restrict the number of rows
returned. If no sortOrder is included the response is sorted by User Id ascending by
default. Multiple search criteria are logically ANDed together unless the
searchCriteriaModeOr option is included. Then the search criteria are logically ORed
together. ErrorResponse() is returned if searchCriteriaExactUserGroup has multiple
entries and searchCriteriaModeOr is not included.
The response is either a
EnterpriseCallCenterAgentThresholdProfileGetPagedSortedResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| profile_name | str | profileName |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_exact_user_group | List[OCI.searchCriteriaExactUserGroup] | searchCriteriaExactUserGroup Optional |
| search_criteria_group_name | List[OCI.searchCriteriaGroupName] | searchCriteriaGroupName Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
EnterpriseCallCenterEnhancedReportingScheduledReportAddRequest(OCIRequest)
Request to add an enterprise level call center reporting scheduled report.
The response is either a SuccessResponse() or an ErrorResponse(). The startDate
element is adjusted to the first occurrence of the recurrent schedule that comes at or
after startDate.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| description | str | description Optional |
| report_template | OCI.reportTemplate | reportTemplate |
| schedule | OCI.schedule | schedule |
| sampling_period | str | samplingPeriod Optional |
| start_day_of_week | str | startDayOfWeek Optional |
| report_time_zone | str | reportTimeZone |
| report_date_format | str | reportDateFormat |
| report_time_format | str | reportTimeFormat |
| report_interval | OCI.reportInterval | reportInterval |
| report_format | str | reportFormat |
| agent | OCI.agent | agent Optional |
| call_center | OCI.callCenter | callCenter Optional |
| dnis | OCI.dnis | dnis Optional |
| call_completion_threshold_seconds | int | callCompletionThresholdSeconds Optional |
| short_duration_threshold_seconds | int | shortDurationThresholdSeconds Optional |
| service_level_threshold_seconds | List[int] | serviceLevelThresholdSeconds Optional |
| service_level_inclusions | OCI.serviceLevelInclusions | serviceLevelInclusions Optional |
| service_level_objective_percentage | int | serviceLevelObjectivePercentage Optional |
| abandoned_call_threshold_seconds | List[int] | abandonedCallThresholdSeconds Optional |
| email_address | List[str] | emailAddress |
EnterpriseCallCenterEnhancedReportingScheduledReportModifyRequest(OCIRequest)
Request to modify an enterprise level call center reporting scheduled report.
The response is either a SuccessResponse() or an ErrorResponse(). The startDate
element is adjusted to the first occurrence of the recurrent schedule that comes at or
after startDate.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| schedule | OCI.schedule | schedule Optional |
| sampling_period | str | samplingPeriod Optional |
| start_day_of_week | str | startDayOfWeek Optional |
| report_time_zone | str | reportTimeZone Optional |
| report_date_format | str | reportDateFormat Optional |
| report_time_format | str | reportTimeFormat Optional |
| report_interval | OCI.reportInterval | reportInterval Optional |
| report_format | str | reportFormat Optional |
| agent | OCI.agent | agent Optional |
| call_center | OCI.callCenter | callCenter Optional |
| dnis | OCI.dnis | dnis Optional |
| call_completion_threshold_seconds | int | callCompletionThresholdSeconds Optional |
| short_duration_threshold_seconds | int | shortDurationThresholdSeconds Optional |
| service_level_threshold_seconds | OCI.serviceLevelThresholdSeconds | serviceLevelThresholdSeconds Optional |
| service_level_inclusions | OCI.serviceLevelInclusions | serviceLevelInclusions Optional |
| service_level_objective_percentage | int | serviceLevelObjectivePercentage Optional |
| abandoned_call_threshold_seconds | OCI.abandonedCallThresholdSeconds | abandonedCallThresholdSeconds Optional |
| email_address | OCI.emailAddress | emailAddress Optional |
EnterprisePhoneDirectoryGetPagedSortedListRequest(OCIRequest)
Request a table containing the phone directory for an enterprise.
The directory includes all users in the enterprise and all entries in the enterprise
common phone list. If the responsePagingControl element is not provided, the paging
startIndex will be set to 1 by default, and the responsePageSize will be set to the
maximum ResponsePageSize by default. It is possible to search by various criteria to
restrict the number of rows returned. If no sortOrder is included the response is
sorted by User Id ascending with a secondary sort by User Last Name ascending by
default. Multiple search criteria are logically ANDed together unless the
searchCriteriaModeOr option is included. Then the search criteria are logically ORed
together. ErrorResponse() is returned if searchCriteriaExactUserGroup or
searchCriteriaExactUserDepartment have multiple entries and searchCriteriaModeOr is
not included The following elements are only used in AS data mode and ignored in XS
data mode: "sortByImpId" "searchCriteriaImpId"
The response is either EnterprisePhoneDirectoryGetPagedSortedListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| enterprise_id | str | enterpriseId |
| is_extended_info_requested | bool | isExtendedInfoRequested |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_group_location_code | List[OCI.searchCriteriaGroupLocationCode] | searchCriteriaGroupLocationCode Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_mobile_phone_number | List[OCI.searchCriteriaMobilePhoneNumber] | searchCriteriaMobilePhoneNumber Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_group_name | List[OCI.searchCriteriaGroupName] | searchCriteriaGroupName Optional |
| search_criteria_yahoo_id | List[OCI.searchCriteriaYahooId] | searchCriteriaYahooId Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
EnterpriseSessionAdmissionControlGroupModifyRequest(OCIRequest)
Request to modify a session admission control group for the enterprise.
The response is either a SuccessResponse() or an ErrorResponse(). Note that to
provision the accessInfoPattern element, the captureAccessInfoInPaniHeader system
parameter needs to be set to "true".
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| name | str | name |
| new_name | str | newName Optional |
| max_session | int | maxSession Optional |
| max_user_originating_sessions | int | maxUserOriginatingSessions Optional |
| max_user_terminating_sessions | int | maxUserTerminatingSessions Optional |
| reserved_session | int | reservedSession Optional |
| reserved_user_originating_sessions | int | reservedUserOriginatingSessions Optional |
| reserved_user_terminating_sessions | int | reservedUserTerminatingSessions Optional |
| become_default_group | bool | becomeDefaultGroup Optional |
| count_intra_sac_group_sessions | bool | countIntraSACGroupSessions Optional |
| device_list | OCI.deviceList | deviceList Optional |
| block_emergency_and_repair_calls_due_to_sac_limits | bool | blockEmergencyAndRepairCallsDueToSACLimits Optional |
| media_group_name | str | mediaGroupName Optional |
| access_info_pattern | str | accessInfoPattern Optional |
GroupAccessDeviceGetPagedSortedListRequest22(OCIRequest)
Requests the list of access devices in a group.
The response is either GroupAccessDeviceGetPagedSortedListResponse() or
ErrorResponse(). If no sortOrder is included, the response is sorted by Device Name
ascending by default. If the responsePagingControl element is not provided, the
paging startIndex will be set to 1 by default, and the responsePageSize will be set to
the maximum responsePageSize by default. Multiple search criteria are logically ANDed
together unless the searchCriteriaModeOr option is included. Then the search criteria
are logically ORed together. The getVisualDeviceManagementAPIDevicesOnly element can
only be set when CloudPBX is licenced. If the getVisualDeviceManagementAPIDevicesOnly
element is not set, all devices are returned with Visual Device Management API flag
set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true,
only SIP devices supporting Visual Device Management API are returned. If the
getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are
returned with their current Visual Device Management API flag value.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| include_total_number_of_rows | bool | includeTotalNumberOfRows Optional |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_device_name | List[OCI.searchCriteriaDeviceName] | searchCriteriaDeviceName Optional |
| search_criteria_device_mac_address | List[OCI.searchCriteriaDeviceMACAddress] | searchCriteriaDeviceMACAddress Optional |
| search_criteria_device_net_address | List[OCI.searchCriteriaDeviceNetAddress] | searchCriteriaDeviceNetAddress Optional |
| search_criteria_exact_device_type | List[OCI.searchCriteriaExactDeviceType] | searchCriteriaExactDeviceType Optional |
| search_criteria_access_device_version | List[OCI.searchCriteriaAccessDeviceVersion] | searchCriteriaAccessDeviceVersion Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
| get_visual_device_management_api_devices_only | bool | getVisualDeviceManagementAPIDevicesOnly Optional |
GroupAdminGetPagedSortedListRequest(OCIRequest)
Get a list of group and department administrators within the group.
The response is either a GroupAdminGetPagedSortedListResponse() or an
ErrorResponse(). If no sort criterion is included, the response is sorted by
administrator id ascending by default. If the responsePagingControl element is not
provided, the paging startIndex will be set to 1 by default, and the responsePageSize
will be set to the maximum responsePageSize by default. Multiple search criteria are
logically ANDed together unless the searchCriteriaModeOr option is included. Then the
search criteria are logically ORed together.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_admin_id | List[OCI.searchCriteriaAdminId] | searchCriteriaAdminId Optional |
| search_criteria_admin_last_name | List[OCI.searchCriteriaAdminLastName] | searchCriteriaAdminLastName Optional |
| search_criteria_admin_first_name | List[OCI.searchCriteriaAdminFirstName] | searchCriteriaAdminFirstName Optional |
| search_criteria_exact_group_admin_type | List[OCI.searchCriteriaExactGroupAdminType] | searchCriteriaExactGroupAdminType Optional |
| search_criteria_language | List[OCI.searchCriteriaLanguage] | searchCriteriaLanguage Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupAutoAttendantGetInstancePagedSortedListRequest(OCIRequest)
Get a list of Auto Attendant instances within a group.
The response is either GroupAutoAttendantGetInstancePagedSortedListResponse() or
ErrorResponse(). If no sortOrder is included the response is sorted by Name
ascending by default. A limitation to the search by DN activation exists when the
Number Activation mode is set to Off. In this case DNs not assigned to users are
never returned by queries with the "dnActivationSearchCriteria" included. If the
responsePagingControl element is not provided, the paging startIndex will be set to 1
by default, and the responsePageSize will be set to the maximum responsePageSize by
default. Multiple search criteria are logically ANDed together unless the
searchCriteriaModeOr option is included. Then the search criteria are logically ORed
together.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_dn_activation | OCI.searchCriteriaExactDnActivation | searchCriteriaExactDnActivation Optional |
| search_criteria_service_status | OCI.searchCriteriaServiceStatus | searchCriteriaServiceStatus Optional |
| search_criteria_exact_auto_attendant_type | OCI.searchCriteriaExactAutoAttendantType | searchCriteriaExactAutoAttendantType Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupAutoAttendantSubmenuAddRequest(OCIRequest)
Request to add an Auto Attendant submenu instance.
The response is either SuccessResponse() or ErrorResponse(). This request is only
valid for Standard auto attendants. Replaced by:
GroupAutoAttendantSubmenuAddRequest20() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| submenu_id | str | submenuId |
| announcement_selection | str | announcementSelection |
| audio_file | OCI.audioFile | audioFile Optional |
| video_file | OCI.videoFile | videoFile Optional |
| enable_level_extension_dialing | bool | enableLevelExtensionDialing |
| key_configuration | List[OCI.keyConfiguration] | keyConfiguration Optional |
GroupAutoAttendantSubmenuAddRequest20(OCIRequest)
Request to add an Auto Attendant submenu instance.
The response is either SuccessResponse() or ErrorResponse(). This request is only
valid for Standard auto attendants.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| submenu_id | str | submenuId |
| announcement_selection | str | announcementSelection |
| audio_file | OCI.audioFile | audioFile Optional |
| video_file | OCI.videoFile | videoFile Optional |
| enable_level_extension_dialing | bool | enableLevelExtensionDialing |
| key_configuration | List[OCI.keyConfiguration] | keyConfiguration Optional |
GroupAutoAttendantSubmenuModifyRequest(OCIRequest)
Request to modify an Auto Attendant submenu instance.
The response is either SuccessResponse() or ErrorResponse(). This request is only
valid for Standard auto attendants. Replaced by:
GroupAutoAttendantSubmenuModifyRequest20() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| submenu_id | str | submenuId |
| new_submenu_id | str | newSubmenuId Optional |
| announcement_selection | str | announcementSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_file | OCI.videoFile | videoFile Optional |
| enable_level_extension_dialing | bool | enableLevelExtensionDialing Optional |
| key_configuration | List[OCI.keyConfiguration] | keyConfiguration Optional |
GroupAutoAttendantSubmenuModifyRequest20(OCIRequest)
Request to modify an Auto Attendant submenu instance.
The response is either SuccessResponse() or ErrorResponse(). This request is only
valid for Standard auto attendants.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| submenu_id | str | submenuId |
| new_submenu_id | str | newSubmenuId Optional |
| announcement_selection | str | announcementSelection Optional |
| audio_file | OCI.audioFile | audioFile Optional |
| video_file | OCI.videoFile | videoFile Optional |
| enable_level_extension_dialing | bool | enableLevelExtensionDialing Optional |
| key_configuration | List[OCI.keyConfiguration] | keyConfiguration Optional |
GroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest(OCIRequest)
Get the list of all Agents in the Group that can be assigned to a given Call Center Agent Threshold Profile in a Group.
An agent is available to be assigned to a given Agent Threshold Profile if it is a Call Center Standard or Call Center Premium agent and the agent is not yet assigned to the profile. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. It is possible to search by various criteria to restrict the number of rows returned. The available agent list for a new Call Center Agent Threshold profile can be obtained by not setting the excludeAgentsAssignedToProfileName. When the excludeAgentsAssignedToProfileName is specified, all agents already assigned to the specified profile are not included in the response, even if the search criterion element searchCriteriaAgentThresholdProfile is specified using the same profile name. If no sortOrder is included the response is sorted by User Id ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.
The response is either a
GroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| exclude_agents_assigned_to_profile_name | str | excludeAgentsAssignedToProfileName Optional |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_agent_threshold_profile | List[OCI.searchCriteriaAgentThresholdProfile] | searchCriteriaAgentThresholdProfile Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupCallCenterAgentThresholdProfileGetPagedSortedRequest(OCIRequest)
Gets an existing non-default Call Center Agent Threshold Profile in a Group.
If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. It is possible to search by various criteria to restrict the number of rows returned. If no sortOrder is included the response is sorted by User Id ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.
The response is either a
GroupCallCenterAgentThresholdProfileGetPagedSortedResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| profile_name | str | profileName |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupCallCenterEnhancedReportingScheduledReportAddRequest(OCIRequest)
Request to add a group level call center reporting scheduled report.
The response is either a SuccessResponse() or an ErrorResponse(). The startDate
element is adjusted to the first occurrence of the recurrent schedule that comes at or
after startDate.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| description | str | description Optional |
| report_template | OCI.reportTemplate | reportTemplate |
| schedule | OCI.schedule | schedule |
| sampling_period | str | samplingPeriod Optional |
| start_day_of_week | str | startDayOfWeek Optional |
| report_time_zone | str | reportTimeZone |
| report_date_format | str | reportDateFormat |
| report_time_format | str | reportTimeFormat |
| report_interval | OCI.reportInterval | reportInterval |
| report_format | str | reportFormat |
| agent | OCI.agent | agent Optional |
| call_center | OCI.callCenter | callCenter Optional |
| dnis | OCI.dnis | dnis Optional |
| call_completion_threshold_seconds | int | callCompletionThresholdSeconds Optional |
| short_duration_threshold_seconds | int | shortDurationThresholdSeconds Optional |
| service_level_threshold_seconds | List[int] | serviceLevelThresholdSeconds Optional |
| service_level_inclusions | OCI.serviceLevelInclusions | serviceLevelInclusions Optional |
| service_level_objective_percentage | int | serviceLevelObjectivePercentage Optional |
| abandoned_call_threshold_seconds | List[int] | abandonedCallThresholdSeconds Optional |
| email_address | List[str] | emailAddress |
GroupCallCenterEnhancedReportingScheduledReportModifyRequest(OCIRequest)
Request to modify a group level call center reporting scheduled report.
The response is either a SuccessResponse() or an ErrorResponse(). The startDate
element is adjusted to the first occurrence of the recurrent schedule that comes at or
after startDate.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| schedule | OCI.schedule | schedule Optional |
| sampling_period | str | samplingPeriod Optional |
| start_day_of_week | str | startDayOfWeek Optional |
| report_time_zone | str | reportTimeZone Optional |
| report_date_format | str | reportDateFormat Optional |
| report_time_format | str | reportTimeFormat Optional |
| report_interval | OCI.reportInterval | reportInterval Optional |
| report_format | str | reportFormat Optional |
| agent | OCI.agent | agent Optional |
| call_center | OCI.callCenter | callCenter Optional |
| dnis | OCI.dnis | dnis Optional |
| call_completion_threshold_seconds | int | callCompletionThresholdSeconds Optional |
| short_duration_threshold_seconds | int | shortDurationThresholdSeconds Optional |
| service_level_threshold_seconds | OCI.serviceLevelThresholdSeconds | serviceLevelThresholdSeconds Optional |
| service_level_inclusions | OCI.serviceLevelInclusions | serviceLevelInclusions Optional |
| service_level_objective_percentage | int | serviceLevelObjectivePercentage Optional |
| abandoned_call_threshold_seconds | OCI.abandonedCallThresholdSeconds | abandonedCallThresholdSeconds Optional |
| email_address | OCI.emailAddress | emailAddress Optional |
GroupCallCenterGetAvailableAgentPagedSortedListRequest(OCIRequest)
Get a list of users that can be assigned as agents to a given type of Call Center.
Searching for users by group only makes sense when the call center is part of an
Enterprise. If the responsePagingControl element is not provided, the paging
startIndex will be set to 1 by default, and the responsePageSize will be set to the
maximum ResponsePageSize by default. It is possible to search by various criteria to
restrict the number of rows returned. If no sortOrder is included the response is
sorted by User Id ascending by default. Multiple search criteria are logically ANDed
together unless the searchCriteriaModeOr option is included. Then the search criteria
are logically ORed together. ErrorResponse() is returned if
searchCriteriaExactUserGroup has multiple entries and searchCriteriaModeOr is not
included.
The response is either GroupCallCenterGetAvailableAgentPagedSortedListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| call_center_type | str | callCenterType |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_group | List[OCI.searchCriteriaExactUserGroup] | searchCriteriaExactUserGroup Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupCallCenterGetInstancePagedSortedListRequest(OCIRequest)
Get a list of Call Center instances within a group.
The response is either GroupCallCenterGetInstancePagedSortedListResponse() or
ErrorResponse(). It is possible to get the instances within a specified department.
If the responsePagingControl element is not provided, the paging startIndex will be
set to 1 by default, and the responsePageSize will be set to the maximum
ResponsePageSize by default. It is possible to search by various criteria to restrict
the number of rows returned. If no sortOrder is included the response is sorted by
User Id ascending by default. Multiple search criteria are logically ANDed together
unless the searchCriteriaModeOr option is included. Then the search criteria are
logically ORed together. ErrorResponse() is returned if
searchCriteriaExactHuntPolicy or searchCriteriaExactCallCenterType have multiple
entries and searchCriteriaModeOr is not include.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_call_center_name | List[OCI.searchCriteriaCallCenterName] | searchCriteriaCallCenterName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_service_status | OCI.searchCriteriaServiceStatus | searchCriteriaServiceStatus Optional |
| search_criteria_exact_hunt_policy | List[OCI.searchCriteriaExactHuntPolicy] | searchCriteriaExactHuntPolicy Optional |
| search_criteria_exact_call_center_type | List[OCI.searchCriteriaExactCallCenterType] | searchCriteriaExactCallCenterType Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupCallCenterModifyAnnouncementRequest16(OCIRequest)
Modify a call center's announcement settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| play_entrance_message | bool | playEntranceMessage Optional |
| mandatory_entrance_message | bool | mandatoryEntranceMessage Optional |
| entrance_audio_message_selection | str | entranceAudioMessageSelection Optional |
| entrance_message_audio_file | OCI.entranceMessageAudioFile | entranceMessageAudioFile Optional |
| entrance_video_message_selection | str | entranceVideoMessageSelection Optional |
| entrance_message_video_file | OCI.entranceMessageVideoFile | entranceMessageVideoFile Optional |
| play_periodic_comfort_message | bool | playPeriodicComfortMessage Optional |
| time_between_comfort_messages_seconds | int | timeBetweenComfortMessagesSeconds Optional |
| periodic_comfort_audio_message_selection | str | periodicComfortAudioMessageSelection Optional |
| periodic_comfort_message_audio_file | OCI.periodicComfortMessageAudioFile | periodicComfortMessageAudioFile Optional |
| periodic_comfort_video_message_selection | str | periodicComfortVideoMessageSelection Optional |
| periodic_comfort_message_video_file | OCI.periodicComfortMessageVideoFile | periodicComfortMessageVideoFile Optional |
| enable_media_on_hold_for_queued_calls | bool | enableMediaOnHoldForQueuedCalls Optional |
| media_on_hold_source | OCI.mediaOnHoldSource | mediaOnHoldSource Optional |
| media_on_hold_use_alternate_source_for_internal_calls | bool | mediaOnHoldUseAlternateSourceForInternalCalls Optional |
| media_on_hold_internal_source | OCI.mediaOnHoldInternalSource | mediaOnHoldInternalSource Optional |
GroupCallCenterModifyAnnouncementRequest17(OCIRequest)
Modify a call center's announcement settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| play_entrance_message | bool | playEntranceMessage Optional |
| mandatory_entrance_message | bool | mandatoryEntranceMessage Optional |
| entrance_audio_message_selection | str | entranceAudioMessageSelection Optional |
| entrance_message_audio_url_list | OCI.entranceMessageAudioUrlList | entranceMessageAudioUrlList Optional |
| entrance_message_audio_file_list | OCI.entranceMessageAudioFileList | entranceMessageAudioFileList Optional |
| entrance_video_message_selection | str | entranceVideoMessageSelection Optional |
| entrance_message_video_url_list | OCI.entranceMessageVideoUrlList | entranceMessageVideoUrlList Optional |
| entrance_message_video_file_list | OCI.entranceMessageVideoFileList | entranceMessageVideoFileList Optional |
| play_periodic_comfort_message | bool | playPeriodicComfortMessage Optional |
| time_between_comfort_messages_seconds | int | timeBetweenComfortMessagesSeconds Optional |
| periodic_comfort_audio_message_selection | str | periodicComfortAudioMessageSelection Optional |
| periodic_comfort_message_audio_url_list | OCI.periodicComfortMessageAudioUrlList | periodicComfortMessageAudioUrlList Optional |
| periodic_comfort_message_audio_file_list | OCI.periodicComfortMessageAudioFileList | periodicComfortMessageAudioFileList Optional |
| periodic_comfort_video_message_selection | str | periodicComfortVideoMessageSelection Optional |
| periodic_comfort_message_video_url_list | OCI.periodicComfortMessageVideoUrlList | periodicComfortMessageVideoUrlList Optional |
| periodic_comfort_message_video_file_list | OCI.periodicComfortMessageVideoFileList | periodicComfortMessageVideoFileList Optional |
| enable_media_on_hold_for_queued_calls | bool | enableMediaOnHoldForQueuedCalls Optional |
| media_on_hold_source | OCI.mediaOnHoldSource | mediaOnHoldSource Optional |
| media_on_hold_use_alternate_source_for_internal_calls | bool | mediaOnHoldUseAlternateSourceForInternalCalls Optional |
| media_on_hold_internal_source | OCI.mediaOnHoldInternalSource | mediaOnHoldInternalSource Optional |
| play_whisper_message | bool | playWhisperMessage Optional |
| whisper_audio_message_selection | str | whisperAudioMessageSelection Optional |
| whisper_message_audio_url_list | OCI.whisperMessageAudioUrlList | whisperMessageAudioUrlList Optional |
| whisper_message_audio_file_list | OCI.whisperMessageAudioFileList | whisperMessageAudioFileList Optional |
| whisper_video_message_selection | str | whisperVideoMessageSelection Optional |
| whisper_message_video_url_list | OCI.whisperMessageVideoUrlList | whisperMessageVideoUrlList Optional |
| whisper_message_video_file_list | OCI.whisperMessageVideoFileList | whisperMessageVideoFileList Optional |
| estimated_wait_message_options_modify | OCI.estimatedWaitMessageOptionsModify | estimatedWaitMessageOptionsModify Optional |
GroupCallCenterModifyAnnouncementRequest20(OCIRequest)
Modify a call center's announcement settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| play_entrance_message | bool | playEntranceMessage Optional |
| mandatory_entrance_message | bool | mandatoryEntranceMessage Optional |
| entrance_audio_message_selection | str | entranceAudioMessageSelection Optional |
| entrance_message_audio_url_list | OCI.entranceMessageAudioUrlList | entranceMessageAudioUrlList Optional |
| entrance_message_audio_file_list | OCI.entranceMessageAudioFileList | entranceMessageAudioFileList Optional |
| entrance_video_message_selection | str | entranceVideoMessageSelection Optional |
| entrance_message_video_url_list | OCI.entranceMessageVideoUrlList | entranceMessageVideoUrlList Optional |
| entrance_message_video_file_list | OCI.entranceMessageVideoFileList | entranceMessageVideoFileList Optional |
| play_periodic_comfort_message | bool | playPeriodicComfortMessage Optional |
| time_between_comfort_messages_seconds | int | timeBetweenComfortMessagesSeconds Optional |
| periodic_comfort_audio_message_selection | str | periodicComfortAudioMessageSelection Optional |
| periodic_comfort_message_audio_url_list | OCI.periodicComfortMessageAudioUrlList | periodicComfortMessageAudioUrlList Optional |
| periodic_comfort_message_audio_file_list | OCI.periodicComfortMessageAudioFileList | periodicComfortMessageAudioFileList Optional |
| periodic_comfort_video_message_selection | str | periodicComfortVideoMessageSelection Optional |
| periodic_comfort_message_video_url_list | OCI.periodicComfortMessageVideoUrlList | periodicComfortMessageVideoUrlList Optional |
| periodic_comfort_message_video_file_list | OCI.periodicComfortMessageVideoFileList | periodicComfortMessageVideoFileList Optional |
| enable_media_on_hold_for_queued_calls | bool | enableMediaOnHoldForQueuedCalls Optional |
| media_on_hold_source | OCI.mediaOnHoldSource | mediaOnHoldSource Optional |
| media_on_hold_use_alternate_source_for_internal_calls | bool | mediaOnHoldUseAlternateSourceForInternalCalls Optional |
| media_on_hold_internal_source | OCI.mediaOnHoldInternalSource | mediaOnHoldInternalSource Optional |
| play_whisper_message | bool | playWhisperMessage Optional |
| whisper_audio_message_selection | str | whisperAudioMessageSelection Optional |
| whisper_message_audio_url_list | OCI.whisperMessageAudioUrlList | whisperMessageAudioUrlList Optional |
| whisper_message_audio_file_list | OCI.whisperMessageAudioFileList | whisperMessageAudioFileList Optional |
| whisper_video_message_selection | str | whisperVideoMessageSelection Optional |
| whisper_message_video_url_list | OCI.whisperMessageVideoUrlList | whisperMessageVideoUrlList Optional |
| whisper_message_video_file_list | OCI.whisperMessageVideoFileList | whisperMessageVideoFileList Optional |
| estimated_wait_message_options_modify | OCI.estimatedWaitMessageOptionsModify | estimatedWaitMessageOptionsModify Optional |
GroupCallCenterModifyDNISAnnouncementRequest(OCIRequest)
Modify a call center DNIS announcement settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
| play_entrance_message | bool | playEntranceMessage Optional |
| mandatory_entrance_message | bool | mandatoryEntranceMessage Optional |
| entrance_audio_message_selection | str | entranceAudioMessageSelection Optional |
| entrance_message_audio_url_list | OCI.entranceMessageAudioUrlList | entranceMessageAudioUrlList Optional |
| entrance_message_audio_file_list | OCI.entranceMessageAudioFileList | entranceMessageAudioFileList Optional |
| entrance_video_message_selection | str | entranceVideoMessageSelection Optional |
| entrance_message_video_url_list | OCI.entranceMessageVideoUrlList | entranceMessageVideoUrlList Optional |
| entrance_message_video_file_list | OCI.entranceMessageVideoFileList | entranceMessageVideoFileList Optional |
| play_periodic_comfort_message | bool | playPeriodicComfortMessage Optional |
| time_between_comfort_messages_seconds | int | timeBetweenComfortMessagesSeconds Optional |
| periodic_comfort_audio_message_selection | str | periodicComfortAudioMessageSelection Optional |
| periodic_comfort_message_audio_url_list | OCI.periodicComfortMessageAudioUrlList | periodicComfortMessageAudioUrlList Optional |
| periodic_comfort_message_audio_file_list | OCI.periodicComfortMessageAudioFileList | periodicComfortMessageAudioFileList Optional |
| periodic_comfort_video_message_selection | str | periodicComfortVideoMessageSelection Optional |
| periodic_comfort_message_video_url_list | OCI.periodicComfortMessageVideoUrlList | periodicComfortMessageVideoUrlList Optional |
| periodic_comfort_message_video_file_list | OCI.periodicComfortMessageVideoFileList | periodicComfortMessageVideoFileList Optional |
| enable_media_on_hold_for_queued_calls | bool | enableMediaOnHoldForQueuedCalls Optional |
| media_on_hold_source | OCI.mediaOnHoldSource | mediaOnHoldSource Optional |
| play_whisper_message | bool | playWhisperMessage Optional |
| whisper_audio_message_selection | str | whisperAudioMessageSelection Optional |
| whisper_message_audio_url_list | OCI.whisperMessageAudioUrlList | whisperMessageAudioUrlList Optional |
| whisper_message_audio_file_list | OCI.whisperMessageAudioFileList | whisperMessageAudioFileList Optional |
| whisper_video_message_selection | str | whisperVideoMessageSelection Optional |
| whisper_message_video_url_list | OCI.whisperMessageVideoUrlList | whisperMessageVideoUrlList Optional |
| whisper_message_video_file_list | OCI.whisperMessageVideoFileList | whisperMessageVideoFileList Optional |
| estimated_wait_message_options_modify | OCI.estimatedWaitMessageOptionsModify | estimatedWaitMessageOptionsModify Optional |
GroupCallCenterModifyDNISAnnouncementRequest20(OCIRequest)
Modify a call center DNIS announcement settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
| play_entrance_message | bool | playEntranceMessage Optional |
| mandatory_entrance_message | bool | mandatoryEntranceMessage Optional |
| entrance_audio_message_selection | str | entranceAudioMessageSelection Optional |
| entrance_message_audio_url_list | OCI.entranceMessageAudioUrlList | entranceMessageAudioUrlList Optional |
| entrance_message_audio_file_list | OCI.entranceMessageAudioFileList | entranceMessageAudioFileList Optional |
| entrance_video_message_selection | str | entranceVideoMessageSelection Optional |
| entrance_message_video_url_list | OCI.entranceMessageVideoUrlList | entranceMessageVideoUrlList Optional |
| entrance_message_video_file_list | OCI.entranceMessageVideoFileList | entranceMessageVideoFileList Optional |
| play_periodic_comfort_message | bool | playPeriodicComfortMessage Optional |
| time_between_comfort_messages_seconds | int | timeBetweenComfortMessagesSeconds Optional |
| periodic_comfort_audio_message_selection | str | periodicComfortAudioMessageSelection Optional |
| periodic_comfort_message_audio_url_list | OCI.periodicComfortMessageAudioUrlList | periodicComfortMessageAudioUrlList Optional |
| periodic_comfort_message_audio_file_list | OCI.periodicComfortMessageAudioFileList | periodicComfortMessageAudioFileList Optional |
| periodic_comfort_video_message_selection | str | periodicComfortVideoMessageSelection Optional |
| periodic_comfort_message_video_url_list | OCI.periodicComfortMessageVideoUrlList | periodicComfortMessageVideoUrlList Optional |
| periodic_comfort_message_video_file_list | OCI.periodicComfortMessageVideoFileList | periodicComfortMessageVideoFileList Optional |
| enable_media_on_hold_for_queued_calls | bool | enableMediaOnHoldForQueuedCalls Optional |
| media_on_hold_source | OCI.mediaOnHoldSource | mediaOnHoldSource Optional |
| play_whisper_message | bool | playWhisperMessage Optional |
| whisper_audio_message_selection | str | whisperAudioMessageSelection Optional |
| whisper_message_audio_url_list | OCI.whisperMessageAudioUrlList | whisperMessageAudioUrlList Optional |
| whisper_message_audio_file_list | OCI.whisperMessageAudioFileList | whisperMessageAudioFileList Optional |
| whisper_video_message_selection | str | whisperVideoMessageSelection Optional |
| whisper_message_video_url_list | OCI.whisperMessageVideoUrlList | whisperMessageVideoUrlList Optional |
| whisper_message_video_file_list | OCI.whisperMessageVideoFileList | whisperMessageVideoFileList Optional |
| estimated_wait_message_options_modify | OCI.estimatedWaitMessageOptionsModify | estimatedWaitMessageOptionsModify Optional |
GroupCallParkGetAvailableAlternateRecallUserPagedSortedListRequest(OCIRequest)
Get a list of hunt groups that are available to select as an alternate recall user.
If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. It is possible to search by various criteria to restrict the number of rows returned. If no sortOrder is included the response is sorted by User Id ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.
The response is either
GroupCallParkGetAvailableAlternateRecallUserPagedSortedListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupCallParkGetAvailableUserPagedSortedListRequest(OCIRequest)
Get a list of users that can be assigned to a Call Park group.
The available user list for a new Call Park group can be obtained by not setting the name. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. It is possible to search by various criteria to restrict the number of rows returned. If no sortOrder is included the response is sorted by User Id ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.
The response is either GroupCallParkGetAvailableUserPagedSortedListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name Optional |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupCallPickupGetAvailableUserPagedSortedListRequest(OCIRequest)
Get a list of users that can be assigned to a Call Pickup group.
The available user list for a new Call Pickup group can be obtained by not setting the name. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. It is possible to search by various criteria to restrict the number of rows returned. If no sortOrder is included the response is sorted by User Id ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.
The response is either GroupCallPickupGetAvailableUserPagedSortedListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name Optional |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupCallPickupGetInstancePagedSortedRequest(OCIRequest)
Gets a Call Pickup group.
If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together. If no sortOrder is included the response is sorted by User Id ascending by default.
The response is either GroupCallPickupGetInstancePagedSortedResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| name | str | name |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupCollaborateBridgeConsolidatedModifyInstanceRequest(OCIRequest)
Request to modify a Collaborate bridge.
The request fails when the collaborateOwnerUserIdList is included in the request for
the default collaborate bridge. The request fails when the supportOutdial is included
in the request and the system-level collaborate supportOutdial setting is disabled.
When phone numbers are un-assigned from the user, the unused numbers may be un-
assigned from the group and service provider. If UnassignPhoneNumbersLevel is set to
'Group', the user's primary phone number, fax number and any alternate numbers, will
be un-assigned from the group if the command is executed by a service provider
administrator or above. When set to 'Service Provider', they will be un-assigned from
the group and service provider if the command is executed by a provisioning
administrator or above. When omitted, the number(s) will be left assigned to the
group. An ErrorResponse() will be returned if any number cannot be unassigned
because of insufficient privilege. If the phoneNumber has not been assigned to the
group and addPhoneNumberToGroup is set to true, it will be added to group if needed if
the command is executed by a service provider administrator and above. The command
will fail otherwise.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| unassign_phone_numbers | str | unassignPhoneNumbers Optional |
| add_phone_number_to_group | bool | addPhoneNumberToGroup Optional |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| maximum_bridge_participants | OCI.maximumBridgeParticipants | maximumBridgeParticipants Optional |
| network_class_of_service | str | networkClassOfService Optional |
| max_collaborate_room_participants | int | maxCollaborateRoomParticipants Optional |
| support_outdial | bool | supportOutdial Optional |
| collaborate_owner_user_id_list | OCI.collaborateOwnerUserIdList | collaborateOwnerUserIdList Optional |
| service_list | OCI.serviceList | serviceList Optional |
GroupCollaborateBridgeGetAvailableUserPagedSortedListRequest(OCIRequest)
Get a list of users with the Collaborate – Audio service assigned that can be assigned to a collaborate bridge.
For an Enterprise Group this will include all users in the group’s enterprise. The searchCriteriaGroupId parameter is only applicable for enterprise groups. If no sortOrder is included the response is sorted by Last Name ascending by default. A limitation to the search by DN activation exists when the Number Activation mode is set to Off. In this case DNs not assigned to users are never returned by queries with the "dnActivationSearchCriteria" included. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.
The response is either
GroupCollaborateBridgeGetAvailableUserPagedSortedListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_dn_activation | OCI.searchCriteriaExactDnActivation | searchCriteriaExactDnActivation Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupCollaborateBridgeGetInstancePagedSortedListRequest(OCIRequest)
Get a list of collaborate bridges within a group.
The response is either GroupCollaborateBridgeGetInstancePagedSortedListResponse() or
ErrorResponse(). If the responsePagingControl element is not provided, the paging
startIndex will be set to 1 by default, and the responsePageSize will be set to the
maximum responsePageSize by default. If no sortOrder is included the response is
sorted by Name ascending by default. . Multiple search criteria are logically ANDed
together unless the searchCriteriaModeOr option is included. Then the search criteria
are logically ORed together.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_dn_activation | OCI.searchCriteriaExactDnActivation | searchCriteriaExactDnActivation Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupDnGetAssignmentPagedSortedListRequest(OCIRequest)
Get the list of assigned and unassigned DNs in a group.
Each DN can be assigned to a user and/or department. Ranges of DNs with identical assignment and activation properties are coalesced to a single table row entry. Dns assigned to the IMRN pool are not listed in the response. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. If no sortOrder is included the response is sorted by Phone Number by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criterion are logically ORed together. The department in both the search criteria and sort by fields refer to the department to which the dn belongs. A limitation to the search by DN activation exists when the Number Activation mode is set to Off. In this case DNs not assigned to users are never returned by queries with the "dnActivationSearchCriteria" included.
The response is either a GroupDnGetAssignmentPagedSortedListResponse() or an
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_exact_dn_activation | OCI.searchCriteriaExactDnActivation | searchCriteriaExactDnActivation Optional |
| search_criteria_exact_dn_availability | OCI.searchCriteriaExactDnAvailability | searchCriteriaExactDnAvailability Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_exact_user_type | List[OCI.searchCriteriaExactUserType] | searchCriteriaExactUserType Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupFlexibleSeatingHostModifyInstanceRequest22(OCIRequest)
Request to modify a flexible seating host instance.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| network_class_of_service | str | networkClassOfService Optional |
GroupGetListInServiceProviderPagedSortedListRequest(OCIRequest)
Request the list of groups in a service provider or enterprise.
If no sortOrder is included, the response is sorted by Group Id ascending by default.
The response is either a GroupGetListInServiceProviderPagedSortedListResponse() or
an ErrorResponse(). If the responsePagingControl element is not provided, the paging
startIndex will be set to 1 by default, and the responsePageSize will be set to the
maximum responsePageSize by default. Multiple search criteria are logically ANDed
together unless the searchCriteriaModeOr option is included. Then the search criteria
are logically ORed together.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_group_name | List[OCI.searchCriteriaGroupName] | searchCriteriaGroupName Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupHuntGroupConsolidatedModifyInstanceRequest(OCIRequest)
Request to modify a Hunt Group instance.
When phone numbers are un-assigned from the user, the unused numbers may be un-
assigned from the group and service provider. If UnassignPhoneNumbersLevel is set to
'Group', the user's primary phone number, fax number and any alternate numbers, will
be un-assigned from the group if the command is executed by a service provider
administrator or above. When set to 'Service Provider', they will be un-assigned from
the group and service provider if the command is executed by a provisioning
administrator or above. When omitted, the number(s) will be left assigned to the
group. An ErrorResponse() will be returned if any number cannot be unassigned
because of insufficient privilege. If the phoneNumber has not been assigned to the
group and addPhoneNumberToGroup is set to true, it will be added to group if needed if
the command is executed by a service provider administrator and above. The command
will fail otherwise.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode: useSystemHuntGroupCLIDSetting
includeHuntGroupNameInCLID
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| unassign_phone_numbers | str | unassignPhoneNumbers Optional |
| add_phone_number_to_group | bool | addPhoneNumberToGroup Optional |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| policy | str | policy Optional |
| hunt_after_no_answer | bool | huntAfterNoAnswer Optional |
| no_answer_number_of_rings | int | noAnswerNumberOfRings Optional |
| forward_after_timeout | bool | forwardAfterTimeout Optional |
| forward_timeout_seconds | int | forwardTimeoutSeconds Optional |
| forward_to_phone_number | str | forwardToPhoneNumber Optional |
| agent_user_id_list | OCI.agentUserIdList | agentUserIdList Optional |
| agent_weight_list | OCI.agentWeightList | agentWeightList Optional |
| allow_call_waiting_for_agents | bool | allowCallWaitingForAgents Optional |
| use_system_hunt_group_clid_setting | bool | useSystemHuntGroupCLIDSetting Optional |
| include_hunt_group_name_in_clid | bool | includeHuntGroupNameInCLID Optional |
| enable_not_reachable_forwarding | bool | enableNotReachableForwarding Optional |
| not_reachable_forward_to_phone_number | str | notReachableForwardToPhoneNumber Optional |
| make_busy_when_not_reachable | bool | makeBusyWhenNotReachable Optional |
| allow_members_to_control_group_busy | bool | allowMembersToControlGroupBusy Optional |
| enable_group_busy | bool | enableGroupBusy Optional |
| apply_group_busy_when_terminating_to_agent | bool | applyGroupBusyWhenTerminatingToAgent Optional |
| network_class_of_service | str | networkClassOfService Optional |
| service_list | OCI.serviceList | serviceList Optional |
| is_active | bool | isActive Optional |
| directory_number_hunting_agent_user_id_list | OCI.directoryNumberHuntingAgentUserIdList | directoryNumberHuntingAgentUserIdList Optional |
| directory_number_hunting_use_terminate_call_to_agent_first | bool | directoryNumberHuntingUseTerminateCallToAgentFirst Optional |
| directory_number_hunting_use_original_agent_services_for_busy_and_no_answer_calls | bool | directoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls Optional |
GroupHuntGroupGetAvailableUserPagedSortedListRequest(OCIRequest)
Get a list of users that can be assigned to a Hunt Group group.
Searching for users by group only makes sense when the hunt group is part of an Enterprise. A limitation to the search by DN activation exists when the Number Activation mode is set to Off. In this case DNs not assigned to users are never returned by queries with the "dnActivationSearchCriteria" included.
The response is either GroupHuntGroupGetAvailableUserPagedSortedListResponse() or
ErrorResponse(). If no sortOrder is included, the response is sorted by User Id
ascending by default. If the responsePagingControl element is not provided, the
paging startIndex will be set to 1 by default, and the responsePageSize will be set to
the maximum responsePageSize by default. Multiple search criteria are logically ANDed
together unless the searchCriteriaModeOr option is included. Then the search criteria
are logically ORed together.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_group_id | List[OCI.searchCriteriaGroupId] | searchCriteriaGroupId Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_dn_activation | OCI.searchCriteriaExactDnActivation | searchCriteriaExactDnActivation Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupHuntGroupGetInstancePagedSortedListRequest(OCIRequest)
Get a list of Hunt Group instances within a group.
The response is either GroupHuntGroupGetInstancePagedSortedListResponse() or
ErrorResponse(). It is possible to get the instances within a specified department.
The department in both the search criteria and sort by fields refer to the department
to which the dn belongs. If no sortOrder is included, the response is sorted by User
Id ascending by default. If the responsePagingControl element is not provided, the
paging startIndex will be set to 1 by default, and the responsePageSize will be set to
the maximum responsePageSize by default. Multiple search criteria are logically ANDed
together unless the searchCriteriaModeOr option is included. Then the search criteria
are logically ORed together.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_dn_activation | OCI.searchCriteriaExactDnActivation | searchCriteriaExactDnActivation Optional |
| search_criteria_service_status | OCI.searchCriteriaServiceStatus | searchCriteriaServiceStatus Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupOutgoingCallingPlanDigitPlanCallMeNowModifyListRequest(OCIRequest)
Modify the Call Me Now call permissions for digit patterns for a group default and it's departments.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_permissions | OCI.groupPermissions | groupPermissions Optional |
| department_permissions | List[OCI.departmentPermissions] | departmentPermissions Optional |
GroupOutgoingCallingPlanDigitPlanOriginatingModifyListRequest(OCIRequest)
Modify the originating permissions for digit patterns for a group default and it's departments.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_permissions | OCI.groupPermissions | groupPermissions Optional |
| department_permissions | List[OCI.departmentPermissions] | departmentPermissions Optional |
GroupOutgoingCallingPlanDigitPlanRedirectingModifyListRequest(OCIRequest)
Modify the redirecting permissions for digit patterns for a group default and it's departments.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_permissions | OCI.groupPermissions | groupPermissions Optional |
| department_permissions | List[OCI.departmentPermissions] | departmentPermissions Optional |
GroupOutgoingCallingPlanPinholeDigitPlanCallMeNowModifyListRequest(OCIRequest)
Modify the Call Me Now permissions for Pinhole digit patterns for a group default and its departments.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_permissions | OCI.groupPermissions | groupPermissions Optional |
| department_permissions | List[OCI.departmentPermissions] | departmentPermissions Optional |
GroupOutgoingCallingPlanPinholeDigitPlanOriginatingModifyListRequest(OCIRequest)
Modify the originating permissions for Pinhole digit patterns for a group default and its departments.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_permissions | OCI.groupPermissions | groupPermissions Optional |
| department_permissions | List[OCI.departmentPermissions] | departmentPermissions Optional |
GroupOutgoingCallingPlanPinholeDigitPlanRedirectingModifyListRequest(OCIRequest)
Modify the redirecting permissions for Pinhole digit patterns for a group default and its departments.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| group_permissions | OCI.groupPermissions | groupPermissions Optional |
| department_permissions | List[OCI.departmentPermissions] | departmentPermissions Optional |
GroupPhoneDirectoryGetPagedSortedListRequest(OCIRequest)
Request a table containing the phone directory for a group.
The directory includes all users in the group and all entries in the group common
phone list. If the specified group is part of an enterprise, the directory includes
all users in the enterprise and all entries in the enterprise common phone list and
the common phone list of the specified group. If the specified group is part of a
service provider, the directory includes all users in the group and all entries in the
common phone list of the specified group. If the responsePagingControl element is not
provided, the paging startIndex will be set to 1 by default, and the responsePageSize
will be set to the maximum ResponsePageSize by default. It is possible to search by
various criteria to restrict the number of rows returned. If no sortOrder is included
the response is sorted by User Id ascending with a secondary sort by User Last Name
ascending by default. Multiple search criteria are logically ANDed together unless
the searchCriteriaModeOr option is included. Then the search criteria are logically
ORed together. ErrorResponse() is returned if searchCriteriaExactUserGroup or
searchCriteriaExactUserDepartment have multiple entries and searchCriteriaModeOr is
not included. The following elements are only used in AS data mode and ignored in XS
data mode: "sortByImpId" "searchCriteriaImpId"
The response is either GroupPhoneDirectoryGetPagedSortedListResponse() or
ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| is_extended_info_requested | bool | isExtendedInfoRequested |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_group_location_code | List[OCI.searchCriteriaGroupLocationCode] | searchCriteriaGroupLocationCode Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_mobile_phone_number | List[OCI.searchCriteriaMobilePhoneNumber] | searchCriteriaMobilePhoneNumber Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_exact_user_department | OCI.searchCriteriaExactUserDepartment | searchCriteriaExactUserDepartment Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_exact_user_group | OCI.searchCriteriaExactUserGroup | searchCriteriaExactUserGroup Optional |
| search_criteria_yahoo_id | List[OCI.searchCriteriaYahooId] | searchCriteriaYahooId Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_imp_id | List[OCI.searchCriteriaImpId] | searchCriteriaImpId Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupRoutePointModifyAnnouncementRequest(OCIRequest)
Modify a route point's announcement settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| media_on_hold_source | OCI.mediaOnHoldSource | mediaOnHoldSource Optional |
GroupRoutePointModifyAnnouncementRequest20(OCIRequest)
Modify a route point's announcement settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| media_on_hold_source | OCI.mediaOnHoldSource | mediaOnHoldSource Optional |
GroupRoutePointModifyDNISAnnouncementRequest(OCIRequest)
Modify a route point DNIS announcement settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
| media_on_hold_source | OCI.mediaOnHoldSource | mediaOnHoldSource Optional |
GroupRoutePointModifyDNISAnnouncementRequest20(OCIRequest)
Modify a route point DNIS announcement settings.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| dnis_key | OCI.dnisKey | dnisKey |
| media_on_hold_source | OCI.mediaOnHoldSource | mediaOnHoldSource Optional |
ServiceProviderAdminGetPagedSortedListRequest(OCIRequest)
Get a list of service provider administrators.
The response is either a ServiceProviderAdminGetPagedSortedListResponse() or an
ErrorResponse(). If no sortOrder is included, the response is sorted by
Administrator ID ascending by default. If the responsePagingControl element is not
provided, the paging startIndex will be set to 1 by default, and the responsePageSize
will be set to the maximum responsePageSize by default. Multiple search criteria are
logically ANDed together unless the searchCriteriaModeOr option is included. Then the
search criteria are logically ORed together.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_admin_id | List[OCI.searchCriteriaAdminId] | searchCriteriaAdminId Optional |
| search_criteria_admin_last_name | List[OCI.searchCriteriaAdminLastName] | searchCriteriaAdminLastName Optional |
| search_criteria_admin_first_name | List[OCI.searchCriteriaAdminFirstName] | searchCriteriaAdminFirstName Optional |
| search_criteria_exact_service_provider_admin_type | List[OCI.searchCriteriaExactServiceProviderAdminType] | searchCriteriaExactServiceProviderAdminType Optional |
| search_criteria_language | List[OCI.searchCriteriaLanguage] | searchCriteriaLanguage Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
ServiceProviderGetPagedSortedListRequest(OCIRequest)
Request a list of service providers and/or enterprises in the system.
The response is either a ServiceProviderGetPagedSortedListResponse() or an
ErrorResponse(). If reseller administrator sends the request,
searchCriteriaResellerId is ignored. Service providers/enterprise within the
administrator's reseller meeting the search criteria are returned. If the
responsePagingControl element is not provided, the paging startIndex will be set to 1
by default, and the responsePageSize will be set to the maximum responsePageSize by
default. If no sortOrder is included, the response is sorted by Service Provider Id
ascending by default. Multiple search criteria are logically ANDed together unless
the searchCriteriaModeOr option is included. Then the search criteria are logically
ORed together.
Attributes:
| Name | Type | Description |
|---|---|---|
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_service_provider_id | List[OCI.searchCriteriaServiceProviderId] | searchCriteriaServiceProviderId Optional |
| search_criteria_service_provider_name | List[OCI.searchCriteriaServiceProviderName] | searchCriteriaServiceProviderName Optional |
| search_criteria_exact_organization_type | OCI.searchCriteriaExactOrganizationType | searchCriteriaExactOrganizationType Optional |
| search_criteria_reseller_id | List[OCI.searchCriteriaResellerId] | searchCriteriaResellerId Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
SystemSIPDeviceTypeAddRequest14sp6(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse().
Replaced By : SystemSIPDeviceTypeAddRequest15()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| rfc3264_hold | bool | RFC3264Hold |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| use_business_trunking_contact | bool | useBusinessTrunkingContact |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| tdm_overlay | bool | tdmOverlay |
| supports_broad_works_info_for_call_waiting | bool | supportsBroadWorksINFOForCallWaiting |
SystemSIPDeviceTypeAddRequest15(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse().
Replaced By : SystemSIPDeviceTypeAddRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| rfc3264_hold | bool | RFC3264Hold |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| use_business_trunking_contact | bool | useBusinessTrunkingContact |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| tdm_overlay | bool | tdmOverlay |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
SystemSIPDeviceTypeAddRequest16(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
SystemSIPDeviceTypeAddRequest16sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| rfc3264_hold | bool | RFC3264Hold |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| use_business_trunking_contact | bool | useBusinessTrunkingContact |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
SystemSIPDeviceTypeAddRequest16sp1(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
SystemSIPDeviceTypeAddRequest17()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| rfc3264_hold | bool | RFC3264Hold |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| use_business_trunking_contact | bool | useBusinessTrunkingContact |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
SystemSIPDeviceTypeAddRequest17(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| rfc3264_hold | bool | RFC3264Hold |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
SystemSIPDeviceTypeAddRequest17sp4(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
SystemSIPDeviceTypeAddRequest18()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| rfc3264_hold | bool | RFC3264Hold |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
SystemSIPDeviceTypeAddRequest18(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in XS data mode: enable3G4GContinuity Replaced by:
SystemSIPDeviceTypeAddRequest19()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| rfc3264_hold | bool | RFC3264Hold |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enable3_g4_g_continuity | bool | enable3G4GContinuity |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
SystemSIPDeviceTypeAddRequest18sp1(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in XS data mode: enable3G4GContinuity, use value "false" in AS
data mode The following elements are only used in AS data mode:
holdAnnouncementMethod, use value "useInactive" in XS data mode The following element
values are only applicable in AS data mode: holdNormalization=useRfc3264Hold will
raise an error in XS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enable3_g4_g_continuity | bool | enable3G4GContinuity |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
SystemSIPDeviceTypeAddRequest19(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in XS data mode: enable3G4GContinuity, use value "false" in AS
data mode The following elements are only used in AS data mode:
holdAnnouncementMethod, use value "useInactive" in XS data mode supportRFC3398, use
value "false" in XS data mode The following element values are only applicable in AS
data mode: holdNormalization=useRfc3264Hold will raise an error in XS data mode
Replaced by: SystemSIPDeviceTypeAddRequest19sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enable3_g4_g_continuity | bool | enable3G4GContinuity |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
SystemSIPDeviceTypeAddRequest19sp1(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in XS data mode: enable3G4GContinuity, use value "false" in AS
data mode The following elements are only used in AS data mode:
holdAnnouncementMethod, use value "useInactive" in XS data mode supportRFC3398, use
value "false" in XS data mode bypassMediaTreatment, use value "false" in XS data mode
The following element values are only applicable in AS data mode:
holdNormalization=useRfc3264Hold will raise an error in XS data mode Replaced by:
SystemSIPDeviceTypeAddRequest20()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enable3_g4_g_continuity | bool | enable3G4GContinuity |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| bypass_media_treatment | bool | bypassMediaTreatment |
SystemSIPDeviceTypeAddRequest20(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in XS data mode: enable3G4GContinuity, use value "false" in AS
data mode The following elements are only used in AS data mode:
holdAnnouncementMethod, use value "useInactive" in XS data mode supportRFC3398, use
value "false" in XS data mode supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode The following element values
are only applicable in AS data mode: holdNormalization=useRfc3264Hold will raise an
error in XS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enable3_g4_g_continuity | bool | enable3G4GContinuity |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management | bool | supportVisualDeviceManagement |
| bypass_media_treatment | bool | bypassMediaTreatment |
SystemSIPDeviceTypeAddRequest20sp1(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in HSS data mode: enable3G4GContinuity, use value "false" in AS
data mode The following logic applies to these elements: macInCert macInNonRequestURI
The two elements are mutually exclusive. When both are set to true, the command
fails. The following elements are only used in AS data mode: holdAnnouncementMethod,
use value "useInactive" in HSS data mode supportRFC3398, use value "false" in HSS data
mode supportClientSessionInfo, use value "false" in HSS data mode
supportCallInfoConferenceSubscriptionURI, use value "false" in HSS data mode
supportRemotePartyInfo, use value "false" in HSS data mode The following element
values are only applicable in AS data mode: holdNormalization=useRfc3264Hold will
raise an error in HSS data mode Replaced by: SystemSIPDeviceTypeAddRequest21sp1V2.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enable3_g4_g_continuity | bool | enable3G4GContinuity |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management | bool | supportVisualDeviceManagement |
| bypass_media_treatment | bool | bypassMediaTreatment |
SystemSIPDeviceTypeAddRequest21(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in XS data mode: enhancedForICS, use value "false" in AS data
mode supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence,
use value "false" in AS data mode The following elements are only used in AS data
mode: holdAnnouncementMethod, use value "useInactive" in XS data mode supportRFC3398,
use value "false" in XS data mode supportClientSessionInfo, use value "false" in XS
data mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode bypassMediaTreatment, use
value "false" in XS data mode supportCauseParameter, use value "false" in XS data mode
The following element values are only applicable in AS data mode:
holdNormalization=useRfc3264Hold will raise an error in XS data mode The following
elements are only used in AS data mode and ignored in XS data mode:
supportCauseParameter Replaced by: SystemSIPDeviceTypeAddRequest21sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management | bool | supportVisualDeviceManagement |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
SystemSIPDeviceTypeAddRequest21sp1(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in XS data mode: enhancedForICS, use value "false" in AS data
mode supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence,
use value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
The following elements are only used in AS data mode: holdAnnouncementMethod, use
value "useInactive" in XS data mode supportRFC3398, use value "false" in XS data mode
supportClientSessionInfo, use value "false" in XS data mode
supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode bypassMediaTreatment, use
value "false" in XS data mode supportCauseParameter, use value "false" in XS data mode
The following element values are only applicable in AS data mode:
holdNormalization=useRfc3264Hold will raise an error in XS data mode The following
elements are only used in AS data mode and ignored in XS data mode:
supportCauseParameter Replaced by: SystemSIPDeviceTypeAddRequest21Sp1V2
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management | bool | supportVisualDeviceManagement |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
SystemSIPDeviceTypeAddRequest22(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS supports3G4GContinuity publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode The
following elements are only used in AS data mode and ignored in the XS data mode:
supportRFC3398, use value "false" in XS data mode supportClientSessionInfo, use value
"false" in XS data mode supportCallInfoConferenceSubscriptionURI, use value "false" in
XS data mode supportRemotePartyInfo, use value "false" in XS data mode
bypassMediaTreatment, use value "false" in XS data mode supportCauseParameter, use
value "false" in XS data mode resellerId The following values for element profile are
only used in AS data mode and an error is returned in the XS data mode: Non-
intelligent Device Addressing Intelligent Device Addressing The following logic
applies to these elements: macInCert macInNonRequestURI The two elements are mutually
exclusive. When both are set to true, the command fails. Deprecated by:
SystemSIPDeviceTypeAddRequest22V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management | bool | supportVisualDeviceManagement |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
SystemSIPDeviceTypeAddRequest22V10(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagementRedirectLink, use value "false" in XS data mode
bypassMediaTreatment, use value "false" in XS data mode supportCauseParameter, use
value "false" in XS data mode resellerId supportVisualDeviceManagementAPI, use value
"false" in XS data mode deviceCategory verstatInPAIHeader, use value "false" in XS
data mode verstatInFromHeader, use value "false" in XS data mode The following values
for element profile are only used in AS data mode and an error is returned in the XS
data mode: SignalingAddressType=Non-intelligent Device Addressing
SignalingAddressType=Intelligent Device Addressing The following logic applies to
these elements: macInCert macInNonRequestURI The two elements are mutually exclusive.
When both are set to true, the command fails. Replaced by:
SystemSIPDeviceTypeAddRequest23V7().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| reset_string | str | resetString Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
| verstat_in_pai_header | bool | verstatInPAIHeader Optional |
| verstat_in_from_header | bool | verstatInFromHeader Optional |
SystemSIPDeviceTypeAddRequest22V11(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagementRedirectLink, use value "false" in XS data mode
bypassMediaTreatment, use value "false" in XS data mode supportCauseParameter, use
value "false" in XS data mode resellerId supportVisualDeviceManagementAPI, use value
"false" in XS data mode deviceCategory verstatInPAIHeader, use value "false" in XS
data mode verstatInFromHeader, use value "false" in XS data mode The following values
for element profile are only used in AS data mode and an error is returned in the XS
data mode: SignalingAddressType=Non-intelligent Device Addressing
SignalingAddressType=Intelligent Device Addressing The following logic applies to
these elements: macInCert macInNonRequestURI The two elements are mutually exclusive.
When both are set to true, the command fails. Replaced by:
SystemSIPDeviceTypeAddRequest23V8().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| reset_string | str | resetString Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
| support_calling_party_category_in_outbound_from_header | bool | supportCallingPartyCategoryInOutboundFromHeader |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
| add_to_file_server | bool | addToFileServer Optional |
| verstat_in_pai_header | bool | verstatInPAIHeader Optional |
| verstat_in_from_header | bool | verstatInFromHeader Optional |
SystemSIPDeviceTypeAddRequest22V12(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagementRedirectLink, use value "false" in XS data mode
bypassMediaTreatment, use value "false" in XS data mode supportCauseParameter, use
value "false" in XS data mode resellerId supportVisualDeviceManagementAPI, use value
"false" in XS data mode deviceCategory verstatInPAIHeader, use value "false" in XS
data mode verstatInFromHeader, use value "false" in XS data mode The following values
for element profile are only used in AS data mode and an error is returned in the XS
data mode: SignalingAddressType=Non-intelligent Device Addressing
SignalingAddressType=Intelligent Device Addressing The following logic applies to
these elements: macInCert macInNonRequestURI The two elements are mutually exclusive.
When both are set to true, the command fails. Replaced by:
SystemSIPDeviceTypeAddRequest23V9().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| reset_string | str | resetString Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
| add_to_file_server | bool | addToFileServer Optional |
| verstat_in_pai_header | bool | verstatInPAIHeader Optional |
| verstat_in_from_header | bool | verstatInFromHeader Optional |
SystemSIPDeviceTypeAddRequest22V2(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS supports3G4GContinuity publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportRFC3398, use value "false" in XS data mode
supportClientSessionInfo, use value "false" in XS data mode
supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode bypassMediaTreatment, use
value "false" in XS data mode supportCauseParameter, use value "false" in XS data mode
resellerId The following values for element profile are only used in AS data mode and
an error is returned in the XS data mode: Non-intelligent Device Addressing
Intelligent Device Addressing The following logic applies to these elements: macInCert
macInNonRequestURI The two elements are mutually exclusive. When both are set to
true, the command fails. Deprecated by SystemSIPDeviceTypeAddRequest22V3()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management | bool | supportVisualDeviceManagement |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
| reseller_id | str | resellerId Optional |
SystemSIPDeviceTypeAddRequest22V3(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagement, use value "false" in XS data mode bypassMediaTreatment,
use value "false" in XS data mode supportCauseParameter, use value "false" in XS data
mode resellerId The following values for element profile are only used in AS data mode
and an error is returned in the XS data mode: SignalingAddressType=Non-intelligent
Device Addressing SignalingAddressType=Intelligent Device Addressing The following
logic applies to these elements: macInCert macInNonRequestURI The two elements are
mutually exclusive. When both are set to true, the command fails.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management | bool | supportVisualDeviceManagement |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
SystemSIPDeviceTypeAddRequest22V4(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagement, use value "false" in XS data mode bypassMediaTreatment,
use value "false" in XS data mode supportCauseParameter, use value "false" in XS data
mode resellerId The following values for element profile are only used in AS data mode
and an error is returned in the XS data mode: SignalingAddressType=Non-intelligent
Device Addressing SignalingAddressType=Intelligent Device Addressing The following
logic applies to these elements: macInCert macInNonRequestURI The two elements are
mutually exclusive. When both are set to true, the command fails.
Replaced By: SystemSIPDeviceTypeAddRequest23()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management | bool | supportVisualDeviceManagement |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
SystemSIPDeviceTypeAddRequest22V5(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagement, use value "false" in XS data mode bypassMediaTreatment,
use value "false" in XS data mode supportCauseParameter, use value "false" in XS data
mode resellerId The following values for element profile are only used in AS data mode
and an error is returned in the XS data mode: SignalingAddressType=Non-intelligent
Device Addressing SignalingAddressType=Intelligent Device Addressing The following
logic applies to these elements: macInCert macInNonRequestURI The two elements are
mutually exclusive. When both are set to true, the command fails. Deprecated by:
SystemSIPDeviceTypeAddRequest23V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management | bool | supportVisualDeviceManagement |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
SystemSIPDeviceTypeAddRequest22V6(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagementRedirectLink, use value "false" in XS data mode
bypassMediaTreatment, use value "false" in XS data mode supportCauseParameter, use
value "false" in XS data mode resellerId supportVisualDeviceManagementAPI, use value
"false" in XS data mode deviceCategory The following values for element profile are
only used in AS data mode and an error is returned in the XS data mode:
SignalingAddressType=Non-intelligent Device Addressing
SignalingAddressType=Intelligent Device Addressing The following logic applies to
these elements: macInCert macInNonRequestURI The two elements are mutually exclusive.
When both are set to true, the command fails. Deprecated by:
SystemSIPDeviceTypeAddRequest23V3() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
SystemSIPDeviceTypeAddRequest22V7(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagementRedirectLink, use value "false" in XS data mode
bypassMediaTreatment, use value "false" in XS data mode supportCauseParameter, use
value "false" in XS data mode resellerId supportVisualDeviceManagementAPI, use value
"false" in XS data mode deviceCategory The following values for element profile are
only used in AS data mode and an error is returned in the XS data mode:
SignalingAddressType=Non-intelligent Device Addressing
SignalingAddressType=Intelligent Device Addressing The following logic applies to
these elements: macInCert macInNonRequestURI The two elements are mutually exclusive.
When both are set to true, the command fails.
Replaced By: SystemSIPDeviceTypeAddRequest23V4()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
SystemSIPDeviceTypeAddRequest22V8(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagementRedirectLink, use value "false" in XS data mode
bypassMediaTreatment, use value "false" in XS data mode supportCauseParameter, use
value "false" in XS data mode resellerId supportVisualDeviceManagementAPI, use value
"false" in XS data mode deviceCategory verstatInPAIHeader, use value "false" in XS
data mode verstatInFromHeader, use value "false" in XS data mode The following values
for element profile are only used in AS data mode and an error is returned in the XS
data mode: SignalingAddressType=Non-intelligent Device Addressing
SignalingAddressType=Intelligent Device Addressing The following logic applies to
these elements: macInCert macInNonRequestURI The two elements are mutually exclusive.
When both are set to true, the command fails. Replaced by
SystemSIPDeviceTypeAddRequest23V5().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
| verstat_in_pai_header | bool | verstatInPAIHeader Optional |
| verstat_in_from_header | bool | verstatInFromHeader Optional |
SystemSIPDeviceTypeAddRequest22V9(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagementRedirectLink, use value "false" in XS data mode
bypassMediaTreatment, use value "false" in XS data mode supportCauseParameter, use
value "false" in XS data mode resellerId supportVisualDeviceManagementAPI, use value
"false" in XS data mode deviceCategory verstatInPAIHeader, use value "false" in XS
data mode verstatInFromHeader, use value "false" in XS data mode The following values
for element profile are only used in AS data mode and an error is returned in the XS
data mode: SignalingAddressType=Non-intelligent Device Addressing
SignalingAddressType=Intelligent Device Addressing The following logic applies to
these elements: macInCert macInNonRequestURI The two elements are mutually exclusive.
When both are set to true, the command fails. Replaced by
SystemSIPDeviceTypeAddRequest23V6().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
| verstat_in_pai_header | bool | verstatInPAIHeader Optional |
| verstat_in_from_header | bool | verstatInFromHeader Optional |
SystemSIPDeviceTypeAddRequest23(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagement, use value "false" in XS data mode bypassMediaTreatment,
use value "false" in XS data mode supportCauseParameter, use value "false" in XS data
mode supportCallingPartyCategoryInOutboundFromHeader, use value "true" in XS data mode
resellerId The following values for element profile are only used in AS data mode and
an error is returned in the XS data mode: SignalingAddressType=Non-intelligent Device
Addressing SignalingAddressType=Intelligent Device Addressing The following logic
applies to these elements: macInCert macInNonRequestURI The two elements are mutually
exclusive. When both are set to true, the command fails. Deprecated by:
SystemSIPDeviceTypeAddRequest23V2()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management | bool | supportVisualDeviceManagement |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
| support_calling_party_category_in_outbound_from_header | bool | supportCallingPartyCategoryInOutboundFromHeader |
SystemSIPDeviceTypeAddRequest23V2(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagement, use value "false" in XS data mode bypassMediaTreatment,
use value "false" in XS data mode supportCauseParameter, use value "false" in XS data
mode supportCallingPartyCategoryInOutboundFromHeader, use value "true" in XS data mode
resellerId The following values for element profile are only used in AS data mode and
an error is returned in the XS data mode: SignalingAddressType=Non-intelligent Device
Addressing SignalingAddressType=Intelligent Device Addressing The following logic
applies to these elements: macInCert macInNonRequestURI The two elements are mutually
exclusive. When both are set to true, the command fails.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management | bool | supportVisualDeviceManagement |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
| support_calling_party_category_in_outbound_from_header | bool | supportCallingPartyCategoryInOutboundFromHeader |
SystemSIPDeviceTypeAddRequest23V3(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagementRedirectLink, use value "false" in XS data mode
bypassMediaTreatment, use value "false" in XS data mode supportCauseParameter, use
value "false" in XS data mode supportCallingPartyCategoryInOutboundFromHeader, use
value "true" in XS data mode resellerId supportVisualDeviceManagementAPI, use value
"false" in XS data mode deviceCategory The following values for element profile are
only used in AS data mode and an error is returned in the XS data mode:
SignalingAddressType=Non-intelligent Device Addressing
SignalingAddressType=Intelligent Device Addressing The following logic applies to
these elements: macInCert macInNonRequestURI The two elements are mutually exclusive.
When both are set to true, the command fails.
Replaced By: SystemSIPDeviceTypeAddRequest23V4()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
| support_calling_party_category_in_outbound_from_header | bool | supportCallingPartyCategoryInOutboundFromHeader |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
SystemSIPDeviceTypeAddRequest23V4(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagementRedirectLink, use value "false" in XS data mode
bypassMediaTreatment, use value "false" in XS data mode supportCauseParameter, use
value "false" in XS data mode supportCallingPartyCategoryInOutboundFromHeader, use
value "true" in XS data mode resellerId supportVisualDeviceManagementAPI, use value
"false" in XS data mode deviceCategory The following values for element profile are
only used in AS data mode and an error is returned in the XS data mode:
SignalingAddressType=Non-intelligent Device Addressing
SignalingAddressType=Intelligent Device Addressing The following logic applies to
these elements: macInCert macInNonRequestURI The two elements are mutually exclusive.
When both are set to true, the command fails. Replaced by
SystemSIPDeviceTypeAddRequest23V5()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
| support_calling_party_category_in_outbound_from_header | bool | supportCallingPartyCategoryInOutboundFromHeader |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
| add_to_file_server | bool | addToFileServer Optional |
SystemSIPDeviceTypeAddRequest23V5(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagementRedirectLink, use value "false" in XS data mode
bypassMediaTreatment, use value "false" in XS data mode supportCauseParameter, use
value "false" in XS data mode supportCallingPartyCategoryInOutboundFromHeader, use
value "true" in XS data mode resellerId supportVisualDeviceManagementAPI, use value
"false" in XS data mode deviceCategory verstatInPAIHeader verstatInFromHeader The
following values for element profile are only used in AS data mode and an error is
returned in the XS data mode: SignalingAddressType=Non-intelligent Device Addressing
SignalingAddressType=Intelligent Device Addressing The following logic applies to
these elements: macInCert macInNonRequestURI The two elements are mutually exclusive.
When both are set to true, the command fails. Replaced by
SystemSIPDeviceTypeAddRequest23V6()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
| support_calling_party_category_in_outbound_from_header | bool | supportCallingPartyCategoryInOutboundFromHeader |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
| add_to_file_server | bool | addToFileServer Optional |
| verstat_in_pai_header | bool | verstatInPAIHeader Optional |
| verstat_in_from_header | bool | verstatInFromHeader Optional |
SystemSIPDeviceTypeAddRequest23V6(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagementRedirectLink, use value "false" in XS data mode
bypassMediaTreatment, use value "false" in XS data mode supportCauseParameter, use
value "false" in XS data mode supportCallingPartyCategoryInOutboundFromHeader, use
value "true" in XS data mode resellerId supportVisualDeviceManagementAPI, use value
"false" in XS data mode deviceCategory verstatInPAIHeader verstatInFromHeader The
following values for element profile are only used in AS data mode and an error is
returned in the XS data mode: SignalingAddressType=Non-intelligent Device Addressing
SignalingAddressType=Intelligent Device Addressing The following logic applies to
these elements: macInCert macInNonRequestURI The two elements are mutually exclusive.
When both are set to true, the command fails. Replaced by:
SystemSIPDeviceTypeAddRequest23V7().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
| support_calling_party_category_in_outbound_from_header | bool | supportCallingPartyCategoryInOutboundFromHeader |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
| add_to_file_server | bool | addToFileServer Optional |
| verstat_in_pai_header | bool | verstatInPAIHeader Optional |
| verstat_in_from_header | bool | verstatInFromHeader Optional |
SystemSIPDeviceTypeAddRequest23V7(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagementRedirectLink, use value "false" in XS data mode
bypassMediaTreatment, use value "false" in XS data mode supportCauseParameter, use
value "false" in XS data mode resellerId supportVisualDeviceManagementAPI, use value
"false" in XS data mode deviceCategory verstatInPAIHeader, use value "false" in XS
data mode verstatInFromHeader, use value "false" in XS data mode The following values
for element profile are only used in AS data mode and an error is returned in the XS
data mode: SignalingAddressType=Non-intelligent Device Addressing
SignalingAddressType=Intelligent Device Addressing The following logic applies to
these elements: macInCert macInNonRequestURI The two elements are mutually exclusive.
When both are set to true, the command fails.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| reset_string | str | resetString Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
| support_calling_party_category_in_outbound_from_header | bool | supportCallingPartyCategoryInOutboundFromHeader |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
| add_to_file_server | bool | addToFileServer Optional |
| verstat_in_pai_header | bool | verstatInPAIHeader Optional |
| verstat_in_from_header | bool | verstatInFromHeader Optional |
SystemSIPDeviceTypeAddRequest23V8(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique through out the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagementRedirectLink, use value "false" in XS data mode
bypassMediaTreatment, use value "false" in XS data mode supportCauseParameter, use
value "false" in XS data mode resellerId supportVisualDeviceManagementAPI, use value
"false" in XS data mode deviceCategory verstatInPAIHeader, use value "false" in XS
data mode verstatInFromHeader, use value "false" in XS data mode The following values
for element profile are only used in AS data mode and an error is returned in the XS
data mode: SignalingAddressType=Non-intelligent Device Addressing
SignalingAddressType=Intelligent Device Addressing The following logic applies to
these elements: macInCert macInNonRequestURI The two elements are mutually exclusive.
When both are set to true, the command fails.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| reset_string | str | resetString Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
| support_calling_party_category_in_outbound_from_header | bool | supportCallingPartyCategoryInOutboundFromHeader |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
| add_to_file_server | bool | addToFileServer Optional |
| verstat_in_pai_header | bool | verstatInPAIHeader Optional |
| verstat_in_from_header | bool | verstatInFromHeader Optional |
SystemSIPDeviceTypeAddRequest23V9(OCIRequest)
Request to add a sip device type.
The response is either SuccessResponse() or ErrorResponse(). When the optional
element resellerId is specified, the device type created is at reseller level. Device
type name should be unique throughout the system including all the reseller level
device types. The following elements are only used in the XS data mode and ignored in
the AS data mode: enhancedForICS, use value "false" in AS data mode
supports3G4GContinuity, use value "false" in AS data mode publishesOwnPresence, use
value "false" in AS data mode locationNetwork, use value "Fixed" in AS data mode
allowTerminationBasedOnICSI, use value "false" in AS data mode roamingMode, use value
"None" in AS data mode The following elements are only used in AS data mode and
ignored in the XS data mode: supportClientSessionInfo, use value "false" in XS data
mode supportCallInfoConferenceSubscriptionURI, use value "false" in XS data mode
supportRemotePartyInfo, use value "false" in XS data mode
supportVisualDeviceManagementRedirectLink, use value "false" in XS data mode
bypassMediaTreatment, use value "false" in XS data mode supportCauseParameter, use
value "false" in XS data mode resellerId supportVisualDeviceManagementAPI, use value
"false" in XS data mode deviceCategory verstatInPAIHeader, use value "false" in XS
data mode verstatInFromHeader, use value "false" in XS data mode
supportPreferredAutoAndForcedAnswer supportCiscoCallerIdDispositionHeader The
following values for element profile are only used in AS data mode and an error is
returned in the XS data mode: SignalingAddressType=Non-intelligent Device Addressing
SignalingAddressType=Intelligent Device Addressing The following logic applies to
these elements: macInCert macInNonRequestURI The two elements are mutually exclusive.
When both are set to true, the command fails.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts |
| profile | str | profile |
| registration_capable | bool | registrationCapable |
| is_conference_device | bool | isConferenceDevice |
| is_mobility_manager_device | bool | isMobilityManagerDevice |
| is_music_on_hold_device | bool | isMusicOnHoldDevice |
| hold_normalization | str | holdNormalization |
| hold_announcement_method | str | holdAnnouncementMethod |
| is_trusted | bool | isTrusted |
| e164_capable | bool | E164Capable |
| route_advance | bool | routeAdvance |
| forwarding_override | bool | forwardingOverride |
| wireless_integration | bool | wirelessIntegration |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable |
| pbx_integration | bool | PBXIntegration |
| static_registration_capable | bool | staticRegistrationCapable |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport |
| authenticate_refer | bool | authenticateRefer |
| auto_config_soft_client | bool | autoConfigSoftClient |
| authentication_mode | str | authenticationMode |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone |
| requires_mwi_subscription | bool | requiresMWISubscription |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide |
| advice_of_charge_capable | bool | adviceOfChargeCapable |
| reset_event | str | resetEvent Optional |
| reset_string | str | resetString Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType |
| trunk_mode | str | trunkMode |
| add_p_called_party_id | bool | addPCalledPartyId |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy |
| enhanced_for_ics | bool | enhancedForICS |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl |
| device_type_configuration_option | str | deviceTypeConfigurationOption |
| support_rfc3398 | bool | supportRFC3398 |
| static_line_ordering | bool | staticLineOrdering |
| support_client_session_info | bool | supportClientSessionInfo |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI |
| support_remote_party_info | bool | supportRemotePartyInfo |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink |
| bypass_media_treatment | bool | bypassMediaTreatment |
| supports3_g4_g_continuity | bool | supports3G4GContinuity |
| publishes_own_presence | bool | publishesOwnPresence |
| support_cause_parameter | bool | supportCauseParameter |
| location_network | str | locationNetwork |
| reseller_id | str | resellerId Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI |
| roaming_mode | str | roamingMode |
| support_calling_party_category_in_outbound_from_header | bool | supportCallingPartyCategoryInOutboundFromHeader |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
| add_to_file_server | bool | addToFileServer Optional |
| verstat_in_pai_header | bool | verstatInPAIHeader Optional |
| verstat_in_from_header | bool | verstatInFromHeader Optional |
| support_preferred_auto_and_forced_answer | bool | supportPreferredAutoAndForcedAnswer Optional |
| support_cisco_caller_id_disposition_header | bool | supportCiscoCallerIdDispositionHeader Optional |
SystemSIPDeviceTypeModifyRequest(OCIRequest)
Request to modify a sip device type.
The following elements are not changeable: numberOfPorts SignalingAddressType isConferenceDevice isMusicOnHoldDevice
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| is_obsolete | bool | isObsolete Optional |
| registration_capable | bool | registrationCapable Optional |
| authentication_override | bool | authenticationOverride Optional |
| rfc3264_hold | bool | RFC3264Hold Optional |
| is_trusted | bool | isTrusted Optional |
| e164_capable | bool | E164Capable Optional |
| route_advance | bool | routeAdvance Optional |
| forwarding_override | bool | forwardingOverride Optional |
| wireless_integration | bool | wirelessIntegration Optional |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable Optional |
| pbx_integration | bool | PBXIntegration Optional |
| use_business_trunking_contact | bool | useBusinessTrunkingContact Optional |
| static_registration_capable | bool | staticRegistrationCapable Optional |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport Optional |
SystemSIPDeviceTypeModifyRequest14sp2(OCIRequest)
Request to modify a sip device type.
The following elements are not changeable: numberOfPorts SignalingAddressType isConferenceDevice isMusicOnHoldDevice isMobilityManagerDevice
The response is either SuccessResponse() or ErrorResponse().
Replaced By : SystemSIPDeviceTypeModifyRequest15()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| is_obsolete | bool | isObsolete Optional |
| registration_capable | bool | registrationCapable Optional |
| rfc3264_hold | bool | RFC3264Hold Optional |
| is_trusted | bool | isTrusted Optional |
| e164_capable | bool | E164Capable Optional |
| route_advance | bool | routeAdvance Optional |
| forwarding_override | bool | forwardingOverride Optional |
| wireless_integration | bool | wirelessIntegration Optional |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable Optional |
| pbx_integration | bool | PBXIntegration Optional |
| use_business_trunking_contact | bool | useBusinessTrunkingContact Optional |
| static_registration_capable | bool | staticRegistrationCapable Optional |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport Optional |
| authenticate_refer | bool | authenticateRefer Optional |
| auto_config_soft_client | bool | autoConfigSoftClient Optional |
| authentication_mode | str | authenticationMode Optional |
| tdm_overlay | bool | tdmOverlay Optional |
| supports_broad_works_info_for_call_waiting | bool | supportsBroadWorksINFOForCallWaiting Optional |
SystemSIPDeviceTypeModifyRequest15(OCIRequest)
Request to modify a sip device type.
The following elements are not changeable: numberOfPorts SignalingAddressType isConferenceDevice isMusicOnHoldDevice isMobilityManagerDevice
The response is either SuccessResponse() or ErrorResponse().
Replaced By : SystemSIPDeviceTypeModifyRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| is_obsolete | bool | isObsolete Optional |
| registration_capable | bool | registrationCapable Optional |
| rfc3264_hold | bool | RFC3264Hold Optional |
| is_trusted | bool | isTrusted Optional |
| e164_capable | bool | E164Capable Optional |
| route_advance | bool | routeAdvance Optional |
| forwarding_override | bool | forwardingOverride Optional |
| wireless_integration | bool | wirelessIntegration Optional |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable Optional |
| pbx_integration | bool | PBXIntegration Optional |
| use_business_trunking_contact | bool | useBusinessTrunkingContact Optional |
| static_registration_capable | bool | staticRegistrationCapable Optional |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport Optional |
| authenticate_refer | bool | authenticateRefer Optional |
| auto_config_soft_client | bool | autoConfigSoftClient Optional |
| authentication_mode | str | authenticationMode Optional |
| tdm_overlay | bool | tdmOverlay Optional |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone Optional |
| requires_mwi_subscription | bool | requiresMWISubscription Optional |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide Optional |
SystemSIPDeviceTypeModifyRequest16(OCIRequest)
Request to modify a sip device type.
The following elements are not changeable: numberOfPorts SignalingAddressType isConferenceDevice isMusicOnHoldDevice isMobilityManagerDevice
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
SystemSIPDeviceTypeModifyRequest16sp1()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| is_obsolete | bool | isObsolete Optional |
| registration_capable | bool | registrationCapable Optional |
| rfc3264_hold | bool | RFC3264Hold Optional |
| is_trusted | bool | isTrusted Optional |
| e164_capable | bool | E164Capable Optional |
| route_advance | bool | routeAdvance Optional |
| forwarding_override | bool | forwardingOverride Optional |
| wireless_integration | bool | wirelessIntegration Optional |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable Optional |
| pbx_integration | bool | PBXIntegration Optional |
| use_business_trunking_contact | bool | useBusinessTrunkingContact Optional |
| static_registration_capable | bool | staticRegistrationCapable Optional |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport Optional |
| authenticate_refer | bool | authenticateRefer Optional |
| auto_config_soft_client | bool | autoConfigSoftClient Optional |
| authentication_mode | str | authenticationMode Optional |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection Optional |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone Optional |
| requires_mwi_subscription | bool | requiresMWISubscription Optional |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide Optional |
| advice_of_charge_capable | bool | adviceOfChargeCapable Optional |
SystemSIPDeviceTypeModifyRequest16sp1(OCIRequest)
Request to modify a sip device type.
The following elements are not changeable: numberOfPorts SignalingAddressType isConferenceDevice isMusicOnHoldDevice isMobilityManagerDevice
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| is_obsolete | bool | isObsolete Optional |
| registration_capable | bool | registrationCapable Optional |
| rfc3264_hold | bool | RFC3264Hold Optional |
| is_trusted | bool | isTrusted Optional |
| e164_capable | bool | E164Capable Optional |
| route_advance | bool | routeAdvance Optional |
| forwarding_override | bool | forwardingOverride Optional |
| wireless_integration | bool | wirelessIntegration Optional |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable Optional |
| pbx_integration | bool | PBXIntegration Optional |
| use_business_trunking_contact | bool | useBusinessTrunkingContact Optional |
| static_registration_capable | bool | staticRegistrationCapable Optional |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport Optional |
| authenticate_refer | bool | authenticateRefer Optional |
| auto_config_soft_client | bool | autoConfigSoftClient Optional |
| authentication_mode | str | authenticationMode Optional |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection Optional |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone Optional |
| requires_mwi_subscription | bool | requiresMWISubscription Optional |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide Optional |
| advice_of_charge_capable | bool | adviceOfChargeCapable Optional |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType Optional |
SystemSIPDeviceTypeModifyRequest17(OCIRequest)
Request to modify a sip device type.
The following elements are not changeable: numberOfPorts SignalingAddressType isConferenceDevice isMusicOnHoldDevice isMobilityManagerDevice
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in XS data mode: enable3G4GContinuity Replaced by:
SystemSIPDeviceTypeModifyRequest19()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| is_obsolete | bool | isObsolete Optional |
| registration_capable | bool | registrationCapable Optional |
| rfc3264_hold | bool | RFC3264Hold Optional |
| is_trusted | bool | isTrusted Optional |
| e164_capable | bool | E164Capable Optional |
| route_advance | bool | routeAdvance Optional |
| forwarding_override | bool | forwardingOverride Optional |
| wireless_integration | bool | wirelessIntegration Optional |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable Optional |
| pbx_integration | bool | PBXIntegration Optional |
| static_registration_capable | bool | staticRegistrationCapable Optional |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport Optional |
| authenticate_refer | bool | authenticateRefer Optional |
| auto_config_soft_client | bool | autoConfigSoftClient Optional |
| authentication_mode | str | authenticationMode Optional |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection Optional |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone Optional |
| requires_mwi_subscription | bool | requiresMWISubscription Optional |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide Optional |
| advice_of_charge_capable | bool | adviceOfChargeCapable Optional |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType Optional |
| trunk_mode | str | trunkMode Optional |
| add_p_called_party_id | bool | addPCalledPartyId Optional |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite Optional |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy Optional |
| enable3_g4_g_continuity | bool | enable3G4GContinuity Optional |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl Optional |
SystemSIPDeviceTypeModifyRequest18sp1(OCIRequest)
Request to modify a sip device type.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are not changeable: numberOfPorts SignalingAddressType isConferenceDevice
isMusicOnHoldDevice isMobilityManagerDevice deviceTypeConfigurationOption
staticLineOrdering The following elements are only used in XS data mode:
enable3G4GContinuity allowTerminationBasedOnICSI The following elements are only used
in AS data mode: holdAnnouncementMethod supportRFC3398 supportClientSessionInfo
supportCallInfoConferenceSubscriptionURI supportRemotePartyInfo The following element
values are only applicable in AS data mode: holdNormalization=useRfc3264Hold will
raise an error in XS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| is_obsolete | bool | isObsolete Optional |
| registration_capable | bool | registrationCapable Optional |
| hold_normalization | str | holdNormalization Optional |
| hold_announcement_method | str | holdAnnouncementMethod Optional |
| is_trusted | bool | isTrusted Optional |
| e164_capable | bool | E164Capable Optional |
| route_advance | bool | routeAdvance Optional |
| forwarding_override | bool | forwardingOverride Optional |
| wireless_integration | bool | wirelessIntegration Optional |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable Optional |
| pbx_integration | bool | PBXIntegration Optional |
| static_registration_capable | bool | staticRegistrationCapable Optional |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport Optional |
| authenticate_refer | bool | authenticateRefer Optional |
| auto_config_soft_client | bool | autoConfigSoftClient Optional |
| authentication_mode | str | authenticationMode Optional |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection Optional |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone Optional |
| requires_mwi_subscription | bool | requiresMWISubscription Optional |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide Optional |
| advice_of_charge_capable | bool | adviceOfChargeCapable Optional |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType Optional |
| trunk_mode | str | trunkMode Optional |
| add_p_called_party_id | bool | addPCalledPartyId Optional |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite Optional |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy Optional |
| enable3_g4_g_continuity | bool | enable3G4GContinuity Optional |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl Optional |
| support_rfc3398 | bool | supportRFC3398 Optional |
| support_client_session_info | bool | supportClientSessionInfo Optional |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI Optional |
| support_remote_party_info | bool | supportRemotePartyInfo Optional |
| support_visual_device_management | bool | supportVisualDeviceManagement Optional |
| bypass_media_treatment | bool | bypassMediaTreatment Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI Optional |
SystemSIPDeviceTypeModifyRequest21(OCIRequest)
Request to modify a sip device type.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are not changeable: numberOfPorts SignalingAddressType isConferenceDevice
isMusicOnHoldDevice isMobilityManagerDevice deviceTypeConfigurationOption
staticLineOrdering The following elements are only used in AS data mode and ignored in
XS data mode: holdAnnouncementMethod supportRFC3398 supportClientSessionInfo
supportCallInfoConferenceSubscriptionURI supportRemotePartyInfo
supportVisualDeviceManagement bypassMediaTreatment supportCauseParameter The following
elements are only used in XS data mode and ignored in AS mode: enhancedForICS
supports3G4GContinuity publishesOwnPresence locationNetwork roamingMode The following
logic applies to these elements: macInCert macInNonRequestURI The two elements are
mutually exclusive. When both are set to true, the command fails. When macInCert is
set to true, macInNonRequestURI will be reset to false. When macInNonRequestURI is
set to true, macInCert will be reset to false. Replaced by:
SystemSIPDeviceTypeModifyRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| is_obsolete | bool | isObsolete Optional |
| registration_capable | bool | registrationCapable Optional |
| hold_normalization | str | holdNormalization Optional |
| hold_announcement_method | str | holdAnnouncementMethod Optional |
| is_trusted | bool | isTrusted Optional |
| e164_capable | bool | E164Capable Optional |
| route_advance | bool | routeAdvance Optional |
| forwarding_override | bool | forwardingOverride Optional |
| wireless_integration | bool | wirelessIntegration Optional |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable Optional |
| pbx_integration | bool | PBXIntegration Optional |
| static_registration_capable | bool | staticRegistrationCapable Optional |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport Optional |
| authenticate_refer | bool | authenticateRefer Optional |
| auto_config_soft_client | bool | autoConfigSoftClient Optional |
| authentication_mode | str | authenticationMode Optional |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection Optional |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone Optional |
| requires_mwi_subscription | bool | requiresMWISubscription Optional |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide Optional |
| advice_of_charge_capable | bool | adviceOfChargeCapable Optional |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType Optional |
| trunk_mode | str | trunkMode Optional |
| add_p_called_party_id | bool | addPCalledPartyId Optional |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite Optional |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy Optional |
| enhanced_for_ics | bool | enhancedForICS Optional |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl Optional |
| support_rfc3398 | bool | supportRFC3398 Optional |
| support_client_session_info | bool | supportClientSessionInfo Optional |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI Optional |
| support_remote_party_info | bool | supportRemotePartyInfo Optional |
| support_visual_device_management | bool | supportVisualDeviceManagement Optional |
| bypass_media_treatment | bool | bypassMediaTreatment Optional |
| supports3_g4_g_continuity | bool | supports3G4GContinuity Optional |
| publishes_own_presence | bool | publishesOwnPresence Optional |
| support_cause_parameter | bool | supportCauseParameter Optional |
| location_network | str | locationNetwork Optional |
| roaming_mode | str | roamingMode Optional |
SystemSIPDeviceTypeModifyRequest22(OCIRequest)
Request to modify a sip device type.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are not changeable: numberOfPorts SignalingAddressType isConferenceDevice
isMusicOnHoldDevice isMobilityManagerDevice deviceTypeConfigurationOption
staticLineOrdering The following elements are only used in AS data mode and ignored in
XS data mode: supportClientSessionInfo supportCallInfoConferenceSubscriptionURI
supportRemotePartyInfo supportVisualDeviceManagement bypassMediaTreatment
supportCauseParameter The following elements are only used in XS data mode and ignored
in AS mode: enhancedForICS supports3G4GContinuity publishesOwnPresence locationNetwork
allowTerminationBasedOnICSI roamingMode The following logic applies to these elements:
macInCert macInNonRequestURI The two elements are mutually exclusive. When both are
set to true, the command fails. When macInCert is set to true, macInNonRequestURI
will be reset to false. When macInNonRequestURI is set to true, macInCert will be
reset to false.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| is_obsolete | bool | isObsolete Optional |
| registration_capable | bool | registrationCapable Optional |
| hold_normalization | str | holdNormalization Optional |
| hold_announcement_method | str | holdAnnouncementMethod Optional |
| is_trusted | bool | isTrusted Optional |
| e164_capable | bool | E164Capable Optional |
| route_advance | bool | routeAdvance Optional |
| forwarding_override | bool | forwardingOverride Optional |
| wireless_integration | bool | wirelessIntegration Optional |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable Optional |
| pbx_integration | bool | PBXIntegration Optional |
| static_registration_capable | bool | staticRegistrationCapable Optional |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport Optional |
| authenticate_refer | bool | authenticateRefer Optional |
| auto_config_soft_client | bool | autoConfigSoftClient Optional |
| authentication_mode | str | authenticationMode Optional |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection Optional |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone Optional |
| requires_mwi_subscription | bool | requiresMWISubscription Optional |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide Optional |
| advice_of_charge_capable | bool | adviceOfChargeCapable Optional |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType Optional |
| trunk_mode | str | trunkMode Optional |
| add_p_called_party_id | bool | addPCalledPartyId Optional |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite Optional |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy Optional |
| enhanced_for_ics | bool | enhancedForICS Optional |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl Optional |
| support_rfc3398 | bool | supportRFC3398 Optional |
| support_client_session_info | bool | supportClientSessionInfo Optional |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI Optional |
| support_remote_party_info | bool | supportRemotePartyInfo Optional |
| support_visual_device_management | bool | supportVisualDeviceManagement Optional |
| bypass_media_treatment | bool | bypassMediaTreatment Optional |
| supports3_g4_g_continuity | bool | supports3G4GContinuity Optional |
| publishes_own_presence | bool | publishesOwnPresence Optional |
| support_cause_parameter | bool | supportCauseParameter Optional |
| location_network | str | locationNetwork Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI Optional |
| roaming_mode | str | roamingMode Optional |
SystemSIPDeviceTypeModifyRequest22V2(OCIRequest)
Request to modify a sip device type.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are not changeable: numberOfPorts SignalingAddressType isConferenceDevice
isMusicOnHoldDevice isMobilityManagerDevice deviceTypeConfigurationOption
staticLineOrdering The following elements are only used in AS data mode and ignored in
XS data mode: supportClientSessionInfo supportCallInfoConferenceSubscriptionURI
supportRemotePartyInfo supportVisualDeviceManagement bypassMediaTreatment
supportCauseParameter supportCallingPartyCategoryInOutboundFromHeader The following
elements are only used in XS data mode and ignored in AS mode: enhancedForICS
supports3G4GContinuity publishesOwnPresence locationNetwork
allowTerminationBasedOnICSI roamingMode The following logic applies to these elements:
macInCert macInNonRequestURI The two elements are mutually exclusive. When both are
set to true, the command fails. When macInCert is set to true, macInNonRequestURI
will be reset to false. When macInNonRequestURI is set to true, macInCert will be
reset to false. Replaced by: SystemSIPDeviceTypeModifyRequest22V3() in AS data
mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| is_obsolete | bool | isObsolete Optional |
| registration_capable | bool | registrationCapable Optional |
| hold_normalization | str | holdNormalization Optional |
| hold_announcement_method | str | holdAnnouncementMethod Optional |
| is_trusted | bool | isTrusted Optional |
| e164_capable | bool | E164Capable Optional |
| route_advance | bool | routeAdvance Optional |
| forwarding_override | bool | forwardingOverride Optional |
| wireless_integration | bool | wirelessIntegration Optional |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable Optional |
| pbx_integration | bool | PBXIntegration Optional |
| static_registration_capable | bool | staticRegistrationCapable Optional |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport Optional |
| authenticate_refer | bool | authenticateRefer Optional |
| auto_config_soft_client | bool | autoConfigSoftClient Optional |
| authentication_mode | str | authenticationMode Optional |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection Optional |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone Optional |
| requires_mwi_subscription | bool | requiresMWISubscription Optional |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide Optional |
| advice_of_charge_capable | bool | adviceOfChargeCapable Optional |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType Optional |
| trunk_mode | str | trunkMode Optional |
| add_p_called_party_id | bool | addPCalledPartyId Optional |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite Optional |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy Optional |
| enhanced_for_ics | bool | enhancedForICS Optional |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl Optional |
| support_rfc3398 | bool | supportRFC3398 Optional |
| support_client_session_info | bool | supportClientSessionInfo Optional |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI Optional |
| support_remote_party_info | bool | supportRemotePartyInfo Optional |
| support_visual_device_management | bool | supportVisualDeviceManagement Optional |
| bypass_media_treatment | bool | bypassMediaTreatment Optional |
| supports3_g4_g_continuity | bool | supports3G4GContinuity Optional |
| publishes_own_presence | bool | publishesOwnPresence Optional |
| support_cause_parameter | bool | supportCauseParameter Optional |
| location_network | str | locationNetwork Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI Optional |
| roaming_mode | str | roamingMode Optional |
| support_calling_party_category_in_outbound_from_header | bool | supportCallingPartyCategoryInOutboundFromHeader Optional |
SystemSIPDeviceTypeModifyRequest22V3(OCIRequest)
Request to modify a sip device type.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are not changeable: numberOfPorts SignalingAddressType isConferenceDevice
isMusicOnHoldDevice isMobilityManagerDevice deviceTypeConfigurationOption
staticLineOrdering The following elements are only used in AS data mode and ignored in
XS data mode: supportClientSessionInfo supportCallInfoConferenceSubscriptionURI
supportRemotePartyInfo supportVisualDeviceManagementRedirectLink bypassMediaTreatment
supportCauseParameter supportCallingPartyCategoryInOutboundFromHeader
supportVisualDeviceManagementAPI deviceCategory The following elements are only used
in XS data mode and ignored in AS mode: enhancedForICS supports3G4GContinuity
publishesOwnPresence locationNetwork allowTerminationBasedOnICSI roamingMode The
following logic applies to these elements: macInCert macInNonRequestURI The two
elements are mutually exclusive. When both are set to true, the command fails. When
macInCert is set to true, macInNonRequestURI will be reset to false. When
macInNonRequestURI is set to true, macInCert will be reset to false.
Replaced By: SystemSIPDeviceTypeModifyRequest22V4()
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| is_obsolete | bool | isObsolete Optional |
| registration_capable | bool | registrationCapable Optional |
| hold_normalization | str | holdNormalization Optional |
| hold_announcement_method | str | holdAnnouncementMethod Optional |
| is_trusted | bool | isTrusted Optional |
| e164_capable | bool | E164Capable Optional |
| route_advance | bool | routeAdvance Optional |
| forwarding_override | bool | forwardingOverride Optional |
| wireless_integration | bool | wirelessIntegration Optional |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable Optional |
| pbx_integration | bool | PBXIntegration Optional |
| static_registration_capable | bool | staticRegistrationCapable Optional |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport Optional |
| authenticate_refer | bool | authenticateRefer Optional |
| auto_config_soft_client | bool | autoConfigSoftClient Optional |
| authentication_mode | str | authenticationMode Optional |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection Optional |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone Optional |
| requires_mwi_subscription | bool | requiresMWISubscription Optional |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide Optional |
| advice_of_charge_capable | bool | adviceOfChargeCapable Optional |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType Optional |
| trunk_mode | str | trunkMode Optional |
| add_p_called_party_id | bool | addPCalledPartyId Optional |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite Optional |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy Optional |
| enhanced_for_ics | bool | enhancedForICS Optional |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl Optional |
| support_rfc3398 | bool | supportRFC3398 Optional |
| support_client_session_info | bool | supportClientSessionInfo Optional |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI Optional |
| support_remote_party_info | bool | supportRemotePartyInfo Optional |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink Optional |
| bypass_media_treatment | bool | bypassMediaTreatment Optional |
| supports3_g4_g_continuity | bool | supports3G4GContinuity Optional |
| publishes_own_presence | bool | publishesOwnPresence Optional |
| support_cause_parameter | bool | supportCauseParameter Optional |
| location_network | str | locationNetwork Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI Optional |
| roaming_mode | str | roamingMode Optional |
| support_calling_party_category_in_outbound_from_header | bool | supportCallingPartyCategoryInOutboundFromHeader Optional |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
SystemSIPDeviceTypeModifyRequest22V4(OCIRequest)
Request to modify a sip device type.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are not changeable: numberOfPorts SignalingAddressType isConferenceDevice
isMusicOnHoldDevice isMobilityManagerDevice deviceTypeConfigurationOption
staticLineOrdering The following elements are only used in AS data mode and ignored in
XS data mode: supportClientSessionInfo supportCallInfoConferenceSubscriptionURI
supportRemotePartyInfo supportVisualDeviceManagementRedirectLink bypassMediaTreatment
supportCauseParameter supportCallingPartyCategoryInOutboundFromHeader
supportVisualDeviceManagementAPI deviceCategory verstatInPAIHeader verstatInFromHeader
The following elements are only used in XS data mode and ignored in AS mode:
enhancedForICS supports3G4GContinuity publishesOwnPresence locationNetwork
allowTerminationBasedOnICSI roamingMode The following logic applies to these elements:
macInCert macInNonRequestURI The two elements are mutually exclusive. When both are
set to true, the command fails. When macInCert is set to true, macInNonRequestURI
will be reset to false. When macInNonRequestURI is set to true, macInCert will be
reset to false. Replaced by: SystemSIPDeviceTypeModifyRequest22V5() in AS data
mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| is_obsolete | bool | isObsolete Optional |
| registration_capable | bool | registrationCapable Optional |
| hold_normalization | str | holdNormalization Optional |
| hold_announcement_method | str | holdAnnouncementMethod Optional |
| is_trusted | bool | isTrusted Optional |
| e164_capable | bool | E164Capable Optional |
| route_advance | bool | routeAdvance Optional |
| forwarding_override | bool | forwardingOverride Optional |
| wireless_integration | bool | wirelessIntegration Optional |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable Optional |
| pbx_integration | bool | PBXIntegration Optional |
| static_registration_capable | bool | staticRegistrationCapable Optional |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport Optional |
| authenticate_refer | bool | authenticateRefer Optional |
| auto_config_soft_client | bool | autoConfigSoftClient Optional |
| authentication_mode | str | authenticationMode Optional |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection Optional |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone Optional |
| requires_mwi_subscription | bool | requiresMWISubscription Optional |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide Optional |
| advice_of_charge_capable | bool | adviceOfChargeCapable Optional |
| reset_event | str | resetEvent Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType Optional |
| trunk_mode | str | trunkMode Optional |
| add_p_called_party_id | bool | addPCalledPartyId Optional |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite Optional |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy Optional |
| enhanced_for_ics | bool | enhancedForICS Optional |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl Optional |
| support_rfc3398 | bool | supportRFC3398 Optional |
| support_client_session_info | bool | supportClientSessionInfo Optional |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI Optional |
| support_remote_party_info | bool | supportRemotePartyInfo Optional |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink Optional |
| bypass_media_treatment | bool | bypassMediaTreatment Optional |
| supports3_g4_g_continuity | bool | supports3G4GContinuity Optional |
| publishes_own_presence | bool | publishesOwnPresence Optional |
| support_cause_parameter | bool | supportCauseParameter Optional |
| location_network | str | locationNetwork Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI Optional |
| roaming_mode | str | roamingMode Optional |
| support_calling_party_category_in_outbound_from_header | bool | supportCallingPartyCategoryInOutboundFromHeader Optional |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
| verstat_in_pai_header | bool | verstatInPAIHeader Optional |
| verstat_in_from_header | bool | verstatInFromHeader Optional |
SystemSIPDeviceTypeModifyRequest22V5(OCIRequest)
Request to modify a sip device type.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are not changeable: numberOfPorts SignalingAddressType isConferenceDevice
isMusicOnHoldDevice isMobilityManagerDevice deviceTypeConfigurationOption
staticLineOrdering The following elements are only used in AS data mode and ignored in
XS data mode: supportClientSessionInfo supportCallInfoConferenceSubscriptionURI
supportRemotePartyInfo supportVisualDeviceManagementRedirectLink bypassMediaTreatment
supportCauseParameter supportCallingPartyCategoryInOutboundFromHeader
supportVisualDeviceManagementAPI deviceCategory verstatInPAIHeader verstatInFromHeader
The following elements are only used in XS data mode and ignored in AS mode:
enhancedForICS supports3G4GContinuity publishesOwnPresence locationNetwork
allowTerminationBasedOnICSI roamingMode The following logic applies to these elements:
macInCert macInNonRequestURI The two elements are mutually exclusive. When both are
set to true, the command fails. When macInCert is set to true, macInNonRequestURI
will be reset to false. When macInNonRequestURI is set to true, macInCert will be
reset to false. Replaced by: SystemSIPDeviceTypeModifyRequest22V6() in AS data
mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| is_obsolete | bool | isObsolete Optional |
| registration_capable | bool | registrationCapable Optional |
| hold_normalization | str | holdNormalization Optional |
| hold_announcement_method | str | holdAnnouncementMethod Optional |
| is_trusted | bool | isTrusted Optional |
| e164_capable | bool | E164Capable Optional |
| route_advance | bool | routeAdvance Optional |
| forwarding_override | bool | forwardingOverride Optional |
| wireless_integration | bool | wirelessIntegration Optional |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable Optional |
| pbx_integration | bool | PBXIntegration Optional |
| static_registration_capable | bool | staticRegistrationCapable Optional |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport Optional |
| authenticate_refer | bool | authenticateRefer Optional |
| auto_config_soft_client | bool | autoConfigSoftClient Optional |
| authentication_mode | str | authenticationMode Optional |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection Optional |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone Optional |
| requires_mwi_subscription | bool | requiresMWISubscription Optional |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide Optional |
| advice_of_charge_capable | bool | adviceOfChargeCapable Optional |
| reset_event | str | resetEvent Optional |
| reset_string | str | resetString Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType Optional |
| trunk_mode | str | trunkMode Optional |
| add_p_called_party_id | bool | addPCalledPartyId Optional |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite Optional |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy Optional |
| enhanced_for_ics | bool | enhancedForICS Optional |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl Optional |
| support_rfc3398 | bool | supportRFC3398 Optional |
| support_client_session_info | bool | supportClientSessionInfo Optional |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI Optional |
| support_remote_party_info | bool | supportRemotePartyInfo Optional |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink Optional |
| bypass_media_treatment | bool | bypassMediaTreatment Optional |
| supports3_g4_g_continuity | bool | supports3G4GContinuity Optional |
| publishes_own_presence | bool | publishesOwnPresence Optional |
| support_cause_parameter | bool | supportCauseParameter Optional |
| location_network | str | locationNetwork Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI Optional |
| roaming_mode | str | roamingMode Optional |
| support_calling_party_category_in_outbound_from_header | bool | supportCallingPartyCategoryInOutboundFromHeader Optional |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
| verstat_in_pai_header | bool | verstatInPAIHeader Optional |
| verstat_in_from_header | bool | verstatInFromHeader Optional |
SystemSIPDeviceTypeModifyRequest22V6(OCIRequest)
Request to modify a sip device type.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are not changeable: numberOfPorts SignalingAddressType isConferenceDevice
isMusicOnHoldDevice isMobilityManagerDevice deviceTypeConfigurationOption
staticLineOrdering The following elements are only used in AS data mode and ignored in
XS data mode: supportClientSessionInfo supportCallInfoConferenceSubscriptionURI
supportRemotePartyInfo supportVisualDeviceManagementRedirectLink bypassMediaTreatment
supportCauseParameter supportCallingPartyCategoryInOutboundFromHeader
supportVisualDeviceManagementAPI deviceCategory verstatInPAIHeader verstatInFromHeader
The following elements are only used in XS data mode and ignored in AS mode:
enhancedForICS supports3G4GContinuity publishesOwnPresence locationNetwork
allowTerminationBasedOnICSI roamingMode The following logic applies to these elements:
macInCert macInNonRequestURI The two elements are mutually exclusive. When both are
set to true, the command fails. When macInCert is set to true, macInNonRequestURI
will be reset to false. When macInNonRequestURI is set to true, macInCert will be
reset to false.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| is_obsolete | bool | isObsolete Optional |
| registration_capable | bool | registrationCapable Optional |
| hold_normalization | str | holdNormalization Optional |
| hold_announcement_method | str | holdAnnouncementMethod Optional |
| is_trusted | bool | isTrusted Optional |
| e164_capable | bool | E164Capable Optional |
| route_advance | bool | routeAdvance Optional |
| forwarding_override | bool | forwardingOverride Optional |
| wireless_integration | bool | wirelessIntegration Optional |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable Optional |
| pbx_integration | bool | PBXIntegration Optional |
| static_registration_capable | bool | staticRegistrationCapable Optional |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport Optional |
| authenticate_refer | bool | authenticateRefer Optional |
| auto_config_soft_client | bool | autoConfigSoftClient Optional |
| authentication_mode | str | authenticationMode Optional |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection Optional |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone Optional |
| requires_mwi_subscription | bool | requiresMWISubscription Optional |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide Optional |
| advice_of_charge_capable | bool | adviceOfChargeCapable Optional |
| reset_event | str | resetEvent Optional |
| reset_string | str | resetString Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType Optional |
| trunk_mode | str | trunkMode Optional |
| add_p_called_party_id | bool | addPCalledPartyId Optional |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite Optional |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy Optional |
| enhanced_for_ics | bool | enhancedForICS Optional |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl Optional |
| support_rfc3398 | bool | supportRFC3398 Optional |
| support_client_session_info | bool | supportClientSessionInfo Optional |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI Optional |
| support_remote_party_info | bool | supportRemotePartyInfo Optional |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink Optional |
| bypass_media_treatment | bool | bypassMediaTreatment Optional |
| supports3_g4_g_continuity | bool | supports3G4GContinuity Optional |
| publishes_own_presence | bool | publishesOwnPresence Optional |
| support_cause_parameter | bool | supportCauseParameter Optional |
| location_network | str | locationNetwork Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI Optional |
| roaming_mode | str | roamingMode Optional |
| support_calling_party_category_in_outbound_from_header | bool | supportCallingPartyCategoryInOutboundFromHeader Optional |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
| verstat_in_pai_header | bool | verstatInPAIHeader Optional |
| verstat_in_from_header | bool | verstatInFromHeader Optional |
SystemSIPDeviceTypeModifyRequest22V7(OCIRequest)
Request to modify a sip device type.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are not changeable: SignalingAddressType isConferenceDevice
isMusicOnHoldDevice isMobilityManagerDevice deviceTypeConfigurationOption
staticLineOrdering The following elements are only used in AS data mode and ignored in
XS data mode: supportClientSessionInfo supportCallInfoConferenceSubscriptionURI
supportRemotePartyInfo supportVisualDeviceManagementRedirectLink bypassMediaTreatment
supportCauseParameter supportCallingPartyCategoryInOutboundFromHeader
supportVisualDeviceManagementAPI deviceCategory verstatInPAIHeader verstatInFromHeader
supportPreferredAutoAndForcedAnswer supportCiscoCallerIdDispositionHeader The
following elements are only used in XS data mode and ignored in AS mode:
enhancedForICS supports3G4GContinuity publishesOwnPresence locationNetwork
allowTerminationBasedOnICSI roamingMode The following logic applies to these elements:
macInCert macInNonRequestURI The two elements are mutually exclusive. When both are
set to true, the command fails. When macInCert is set to true, macInNonRequestURI
will be reset to false. When macInNonRequestURI is set to true, macInCert will be
reset to false.
Attributes:
| Name | Type | Description |
|---|---|---|
| device_type | str | deviceType |
| number_of_ports | OCI.numberOfPorts | numberOfPorts Optional |
| is_obsolete | bool | isObsolete Optional |
| registration_capable | bool | registrationCapable Optional |
| hold_normalization | str | holdNormalization Optional |
| hold_announcement_method | str | holdAnnouncementMethod Optional |
| is_trusted | bool | isTrusted Optional |
| e164_capable | bool | E164Capable Optional |
| route_advance | bool | routeAdvance Optional |
| forwarding_override | bool | forwardingOverride Optional |
| wireless_integration | bool | wirelessIntegration Optional |
| web_based_config_url | str | webBasedConfigURL Optional |
| is_video_capable | bool | isVideoCapable Optional |
| pbx_integration | bool | PBXIntegration Optional |
| static_registration_capable | bool | staticRegistrationCapable Optional |
| cpe_device_options | OCI.cpeDeviceOptions | cpeDeviceOptions Optional |
| early_media_support | str | earlyMediaSupport Optional |
| authenticate_refer | bool | authenticateRefer Optional |
| auto_config_soft_client | bool | autoConfigSoftClient Optional |
| authentication_mode | str | authenticationMode Optional |
| requires_broad_works_digit_collection | bool | requiresBroadWorksDigitCollection Optional |
| requires_broad_works_call_waiting_tone | bool | requiresBroadWorksCallWaitingTone Optional |
| requires_mwi_subscription | bool | requiresMWISubscription Optional |
| use_history_info_header_on_access_side | bool | useHistoryInfoHeaderOnAccessSide Optional |
| advice_of_charge_capable | bool | adviceOfChargeCapable Optional |
| reset_event | str | resetEvent Optional |
| reset_string | str | resetString Optional |
| support_call_center_mime_type | bool | supportCallCenterMIMEType Optional |
| trunk_mode | str | trunkMode Optional |
| add_p_called_party_id | bool | addPCalledPartyId Optional |
| support_identity_in_update_and_re_invite | bool | supportIdentityInUpdateAndReInvite Optional |
| unscreened_presentation_identity_policy | str | unscreenedPresentationIdentityPolicy Optional |
| enhanced_for_ics | bool | enhancedForICS Optional |
| support_emergency_disconnect_control | bool | supportEmergencyDisconnectControl Optional |
| support_rfc3398 | bool | supportRFC3398 Optional |
| support_client_session_info | bool | supportClientSessionInfo Optional |
| support_call_info_conference_subscription_uri | bool | supportCallInfoConferenceSubscriptionURI Optional |
| support_remote_party_info | bool | supportRemotePartyInfo Optional |
| support_visual_device_management_redirect_link | bool | supportVisualDeviceManagementRedirectLink Optional |
| bypass_media_treatment | bool | bypassMediaTreatment Optional |
| supports3_g4_g_continuity | bool | supports3G4GContinuity Optional |
| publishes_own_presence | bool | publishesOwnPresence Optional |
| support_cause_parameter | bool | supportCauseParameter Optional |
| location_network | str | locationNetwork Optional |
| allow_termination_based_on_icsi | bool | allowTerminationBasedOnICSI Optional |
| roaming_mode | str | roamingMode Optional |
| support_calling_party_category_in_outbound_from_header | bool | supportCallingPartyCategoryInOutboundFromHeader Optional |
| support_visual_device_management_api | bool | supportVisualDeviceManagementAPI Optional |
| device_category | str | deviceCategory Optional |
| verstat_in_pai_header | bool | verstatInPAIHeader Optional |
| verstat_in_from_header | bool | verstatInFromHeader Optional |
| support_preferred_auto_and_forced_answer | bool | supportPreferredAutoAndForcedAnswer Optional |
| support_cisco_caller_id_disposition_header | bool | supportCiscoCallerIdDispositionHeader Optional |
UserAddRequest22(OCIRequest)
Request to add a user.
The domain is required in the userId. The password is not required if external authentication is enabled. The following elements are only used in AS data mode and will fail in XS data mode: trunkAddressing The following elements are only used in AS data mode and ignored in XS data mode: nameDialingName alternateUserId The following elements are only used in XS data mode and ignored in AS data mode: allowVideo
The response is either SuccessResponse() or ErrorResponse(). The following
elements can only be used by a system administrator:. allowVideo alternateUserId The
following elements can only be used by a provisioning administrator:. alternateUserId
The response is either SuccessResponse() or ErrorResponse(). Replaced by:
UserAddRequest22V2() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| user_id | str | userId |
| last_name | str | lastName |
| first_name | str | firstName |
| calling_line_id_last_name | str | callingLineIdLastName |
| calling_line_id_first_name | str | callingLineIdFirstName |
| name_dialing_name | OCI.nameDialingName | nameDialingName Optional |
| hiragana_last_name | str | hiraganaLastName Optional |
| hiragana_first_name | str | hiraganaFirstName Optional |
| phone_number | str | phoneNumber Optional |
| extension | str | extension Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| password | str | password Optional |
| department | OCI.department | department Optional |
| language | str | language Optional |
| time_zone | str | timeZone Optional |
| alias | List[str] | alias Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| trunk_addressing | OCI.trunkAddressing | trunkAddressing Optional |
| title | str | title Optional |
| pager_phone_number | str | pagerPhoneNumber Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| email_address | str | emailAddress Optional |
| yahoo_id | str | yahooId Optional |
| address_location | str | addressLocation Optional |
| address | OCI.address | address Optional |
| network_class_of_service | str | networkClassOfService Optional |
| alternate_user_id | List[OCI.alternateUserId] | alternateUserId Optional |
UserAddRequest22V2(OCIRequest)
Request to add a user.
The domain is required in the userId. The password is not required if external authentication is enabled. The following elements are only used in AS data mode and will fail in XS data mode: trunkAddressing The following elements are only used in AS data mode and ignored in XS data mode: nameDialingName alternateUserId isPlace The following elements are only used in XS data mode and ignored in AS data mode: allowVideo
The response is either SuccessResponse() or ErrorResponse(). The following
elements can only be used by a system administrator:. allowVideo The response is
either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| user_id | str | userId |
| last_name | str | lastName |
| first_name | str | firstName |
| calling_line_id_last_name | str | callingLineIdLastName |
| calling_line_id_first_name | str | callingLineIdFirstName |
| name_dialing_name | OCI.nameDialingName | nameDialingName Optional |
| hiragana_last_name | str | hiraganaLastName Optional |
| hiragana_first_name | str | hiraganaFirstName Optional |
| phone_number | str | phoneNumber Optional |
| extension | str | extension Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| password | str | password Optional |
| department | OCI.department | department Optional |
| language | str | language Optional |
| time_zone | str | timeZone Optional |
| alias | List[str] | alias Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| trunk_addressing | OCI.trunkAddressing | trunkAddressing Optional |
| title | str | title Optional |
| pager_phone_number | str | pagerPhoneNumber Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| email_address | str | emailAddress Optional |
| yahoo_id | str | yahooId Optional |
| address_location | str | addressLocation Optional |
| address | OCI.address | address Optional |
| network_class_of_service | str | networkClassOfService Optional |
| alternate_user_id | List[OCI.alternateUserId] | alternateUserId Optional |
| is_place | bool | isPlace Optional |
UserCallCenterEnhancedReportingScheduledReportModifyRequest(OCIRequest)
Request to modify a call center reporting scheduled report created by a supervisor.
The response is either a SuccessResponse() or an ErrorResponse(). The startDate
element is adjusted to the first occurrence of the recurrent schedule that comes at or
after startDate.
Attributes:
| Name | Type | Description |
|---|---|---|
| supervisor_user_id | str | supervisorUserId |
| name | str | name |
| new_name | str | newName Optional |
| description | str | description Optional |
| schedule | OCI.schedule | schedule Optional |
| sampling_period | str | samplingPeriod Optional |
| start_day_of_week | str | startDayOfWeek Optional |
| report_time_zone | str | reportTimeZone Optional |
| report_date_format | str | reportDateFormat Optional |
| report_time_format | str | reportTimeFormat Optional |
| report_interval | OCI.reportInterval | reportInterval Optional |
| report_format | str | reportFormat Optional |
| agent | OCI.agent | agent Optional |
| call_center | OCI.callCenter | callCenter Optional |
| dnis | OCI.dnis | dnis Optional |
| call_completion_threshold_seconds | int | callCompletionThresholdSeconds Optional |
| short_duration_threshold_seconds | int | shortDurationThresholdSeconds Optional |
| service_level_threshold_seconds | OCI.serviceLevelThresholdSeconds | serviceLevelThresholdSeconds Optional |
| service_level_inclusions | OCI.serviceLevelInclusions | serviceLevelInclusions Optional |
| service_level_objective_percentage | int | serviceLevelObjectivePercentage Optional |
| abandoned_call_threshold_seconds | OCI.abandonedCallThresholdSeconds | abandonedCallThresholdSeconds Optional |
| email_address | OCI.emailAddress | emailAddress Optional |
UserConsolidatedAddRequest(OCIRequest)
The response is either SuccessResponse() or ErrorResponse().
In AS Data Mode: The group user limit will be increased by one if needed. The group
will be added if it does not exist and if the command is executed by a Service
Provider level administrator or above. If the group needs to be created, the
groupProperties element must be set or the request will fail. The groupProperties
element will be ignored if the group already exists. If the domain has not been
assigned to the group, it will be added to group if the command is executed by a
Service provider level administrator or above. If the domain has not been assigned to
the service provider, it will be added to the service provider if the command is
executed by a Provisioning level administrator or above. The command will fail
otherwise. If the phoneNumber has not been assigned to the group and
addPhoneNumberToGroup is set to true, it will be added to group if the command is
executed by a service provider administrator or above and the number is already
assigned to the service provider. The command will fail otherwise. The password is
not required if external authentication is enabled. Alternate user ids can be added
by a group level administrator or above. When
sharedCallAppearanceAccessDeviceEndpoint element is included and the Shared Call
Appearance is not included in the service/service pack of the request or in the "new
user template", the request will fail. The userService/servicePack will be authorized
to the group if it has not been authorized to the group if the command is executed by
a Service Provider level administrator or above. The command will fail otherwise.
The authorizedQuantity will be set to unlimited if not present. When
thirdPartyVoiceMail elements are included and the Third Party Voice Mail Support
service is not included in the service/service pack of the request or in the "new user
template", the request will fail. When sipAuthenticationData element is included and
the Authentication service is not included in the service/service pack of the request
or in the "new user template", the request will fail. In XS data mode: only the
System level administrator has the authorization level to execute the command. The
group will be added if it does not exist. If the group needs to be created, the
groupProperties element must be set or the request will fail. The groupProperties
element will be ignored if the group already exists. If the phoneNumber has not been
assigned to the group, it will be added to group and service provider if needed. When
sharedCallAppearanceAccessDeviceEndpoint element is included and the Shared Call
Appearance is not included in the service/service pack of the request, the request
will fail. The following elements are ignored in XS data mode: addPhoneNumberToGroup
nameDialingName alternateUserId passcode trunkAddressing
thirdPartyVoiceMailServerSelection thirdPartyVoiceMailServerUserServer
thirdPartyVoiceMailServerMailboxIdType thirdPartyVoiceMailMailboxURL
sipAuthenticationData Replaced by: UserConsolidatedAddRequest22() in AS data mode.
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| group_external_id | str | groupExternalId Optional |
| group_properties | OCI.groupProperties | groupProperties Optional |
| user_id | str | userId |
| user_external_id | str | userExternalId Optional |
| add_phone_number_to_group | bool | addPhoneNumberToGroup Optional |
| last_name | str | lastName |
| first_name | str | firstName |
| calling_line_id_last_name | str | callingLineIdLastName |
| calling_line_id_first_name | str | callingLineIdFirstName |
| name_dialing_name | OCI.nameDialingName | nameDialingName Optional |
| hiragana_last_name | str | hiraganaLastName Optional |
| hiragana_first_name | str | hiraganaFirstName Optional |
| phone_number | str | phoneNumber Optional |
| alternate_user_id | List[OCI.alternateUserId] | alternateUserId Optional |
| extension | str | extension Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| password | str | password Optional |
| passcode | str | passcode Optional |
| department | OCI.department | department Optional |
| language | str | language Optional |
| time_zone | str | timeZone Optional |
| alias | List[str] | alias Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| trunk_addressing | OCI.trunkAddressing | trunkAddressing Optional |
| shared_call_appearance_access_device_endpoint | List[OCI.sharedCallAppearanceAccessDeviceEndpoint] | sharedCallAppearanceAccessDeviceEndpoint Optional |
| title | str | title Optional |
| pager_phone_number | str | pagerPhoneNumber Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| email_address | str | emailAddress Optional |
| yahoo_id | str | yahooId Optional |
| address_location | str | addressLocation Optional |
| address | OCI.address | address Optional |
| network_class_of_service | str | networkClassOfService Optional |
| user_service | List[OCI.userService] | userService Optional |
| service_pack | List[OCI.servicePack] | servicePack Optional |
| third_party_voice_mail_server_selection | str | thirdPartyVoiceMailServerSelection Optional |
| third_party_voice_mail_server_user_server | str | thirdPartyVoiceMailServerUserServer Optional |
| third_party_voice_mail_server_mailbox_id_type | str | thirdPartyVoiceMailServerMailboxIdType Optional |
| third_party_voice_mail_mailbox_url | str | thirdPartyVoiceMailMailboxURL Optional |
| sip_authentication_data | OCI.sipAuthenticationData | sipAuthenticationData Optional |
UserConsolidatedAddRequest22(OCIRequest)
The response is either SuccessResponse() or ErrorResponse().
In AS Data Mode: The group user limit will be increased by one if needed. The group will be added if it does not exist and if the command is executed by a Service Provider level administrator or above. If the group needs to be created, the groupProperties element must be set or the request will fail. The groupProperties element will be ignored if the group already exists. If the domain has not been assigned to the group, it will be added to group if the command is executed by a Service provider level administrator or above. If the domain has not been assigned to the service provider, it will be added to the service provider if the command is executed by a Provisioning level administrator or above. The command will fail otherwise. If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true, it will be added to group if the command is executed by a service provider administrator or above and the number is already assigned to the service provider. The command will fail otherwise. The password is not required if external authentication is enabled. Alternate user ids can be added by a group level administrator or above. When sharedCallAppearanceAccessDeviceEndpoint element is included and the Shared Call Appearance is not included in the service/service pack of the request or in the "new user template", the request will fail. The userService/servicePack will be authorized to the group if it has not been authorized to the group if the command is executed by a Service Provider level administrator or above. The command will fail otherwise. The authorizedQuantity will be set to unlimited if not present. When thirdPartyVoiceMail elements are included and the Third Party Voice Mail Support service is not included in the service/service pack of the request or in the "new user template", the request will fail. When sipAuthenticationData element is included and the Authentication service is not included in the service/service pack of the request or in the "new user template", the request will fail. In XS data mode: only the System level administrator has the authorization level to execute the command. The group will be added if it does not exist. If the group needs to be created, the groupProperties element must be set or the request will fail. The groupProperties element will be ignored if the group already exists. If the phoneNumber has not been assigned to the group, it will be added to group and service provider if needed. When sharedCallAppearanceAccessDeviceEndpoint element is included and the Shared Call Appearance is not included in the service/service pack of the request, the request will fail. The following elements are ignored in XS data mode: addPhoneNumberToGroup nameDialingName alternateUserId passcode trunkAddressing thirdPartyVoiceMailServerSelection thirdPartyVoiceMailServerUserServer thirdPartyVoiceMailServerMailboxIdType thirdPartyVoiceMailMailboxURL sipAuthenticationData isPlace
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| group_external_id | str | groupExternalId Optional |
| group_properties | OCI.groupProperties | groupProperties Optional |
| user_id | str | userId |
| user_external_id | str | userExternalId Optional |
| user_person_id | str | userPersonId Optional |
| add_phone_number_to_group | bool | addPhoneNumberToGroup Optional |
| last_name | str | lastName |
| first_name | str | firstName |
| calling_line_id_last_name | str | callingLineIdLastName |
| calling_line_id_first_name | str | callingLineIdFirstName |
| name_dialing_name | OCI.nameDialingName | nameDialingName Optional |
| hiragana_last_name | str | hiraganaLastName Optional |
| hiragana_first_name | str | hiraganaFirstName Optional |
| phone_number | str | phoneNumber Optional |
| alternate_user_id | List[OCI.alternateUserId] | alternateUserId Optional |
| extension | str | extension Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| password | str | password Optional |
| passcode | str | passcode Optional |
| department | OCI.department | department Optional |
| language | str | language Optional |
| time_zone | str | timeZone Optional |
| alias | List[str] | alias Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| trunk_addressing | OCI.trunkAddressing | trunkAddressing Optional |
| shared_call_appearance_access_device_endpoint | List[OCI.sharedCallAppearanceAccessDeviceEndpoint] | sharedCallAppearanceAccessDeviceEndpoint Optional |
| title | str | title Optional |
| pager_phone_number | str | pagerPhoneNumber Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| email_address | str | emailAddress Optional |
| yahoo_id | str | yahooId Optional |
| address_location | str | addressLocation Optional |
| address | OCI.address | address Optional |
| network_class_of_service | str | networkClassOfService Optional |
| user_service | List[OCI.userService] | userService Optional |
| service_pack | List[OCI.servicePack] | servicePack Optional |
| third_party_voice_mail_server_selection | str | thirdPartyVoiceMailServerSelection Optional |
| third_party_voice_mail_server_user_server | str | thirdPartyVoiceMailServerUserServer Optional |
| third_party_voice_mail_server_mailbox_id_type | str | thirdPartyVoiceMailServerMailboxIdType Optional |
| third_party_voice_mail_mailbox_url | str | thirdPartyVoiceMailMailboxURL Optional |
| sip_authentication_data | OCI.sipAuthenticationData | sipAuthenticationData Optional |
| is_place | bool | isPlace Optional |
UserConsolidatedModifyRequest(OCIRequest)
Request to modify a user.
If deleteExistingDevices is set to true, when the devices for the main endpoint or SCA
service are changed, devices with no more endpoint will be deleted if the command is
executed with the correct priviledge. Group administrator or above running this
command can delete any group level devices. Service provider administrator or above
can delete any service provider and group devices. Provisioning administrator or
above can delete any devices. An ErrorResponse() will be returned if any device
cannot be deleted because of insufficient privilege. When phone numbers are un-
assigned from the user, the unused numbers may be un-assigned from the group and
service provider. If UnassignPhoneNumbersLevel is set to 'Group', the user's primary
phone number, fax number and any alternate numbers, will be un-assigned from the group
if the command is executed by a service provider administrator or above. When set to
'Service Provider', they will be un-assigned from the group and service provider if
the command is executed by a provisioning administrator or above. When omitted, the
number(s) will be left assigned to the group. An ErrorResponse() will be returned
if any number cannot be unassigned because of insufficient privilege. If the
phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to
true, it will be added to group if needed if the command is executed by a service
provider administrator and above. The command will fail otherwise. Alternate user
ids can be added by a group level administrator or above. The password is not
required if external authentication is enabled. When
sharedCallAppearanceAccessDeviceEndpoint element is included and the Shared Call
Appearance service is not assigned after this request, the request will fail. The
userService/servicePackwill be authorized to the group if it has not been authorized
to the group and the command is excuted by a service provider administrator. The
request will fail otherwise. If not present, the authorizedQuantity will be set to
unlimited if allowed. If any of the third party voice mail elements are included but
the service is not assigned after this request, the request will fail. If the sip
authentication elements are included but the SPI Authentication service is not
assigned after this request, the request will fail. If the impPassword element is
included but the Integrated IMP service is not assigned after this request, the
request will fail. The following elements are ignored in XS data mode:
nameDialingName alternateUserIdList passcode trunkAddressing
thirdPartyVoiceMailServerSelection thirdPartyVoiceMailServerUserServer
thirdPartyVoiceMailServerMailboxIdType thirdPartyVoiceMailMailboxURL
sipAuthenticationData newUserExternalId
The response is either SuccxessResponse() or ErrorResponse(). Replaced by:
UserConsolidatedModifyRequest22()
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| delete_existing_devices | bool | deleteExistingDevices Optional |
| unassign_phone_numbers | str | unassignPhoneNumbers Optional |
| add_phone_number_to_group | bool | addPhoneNumberToGroup Optional |
| new_user_id | str | newUserId Optional |
| last_name | str | lastName Optional |
| first_name | str | firstName Optional |
| calling_line_id_last_name | str | callingLineIdLastName Optional |
| calling_line_id_first_name | str | callingLineIdFirstName Optional |
| name_dialing_name | OCI.nameDialingName | nameDialingName Optional |
| hiragana_last_name | str | hiraganaLastName Optional |
| hiragana_first_name | str | hiraganaFirstName Optional |
| phone_number | str | phoneNumber Optional |
| alternate_user_id_list | OCI.alternateUserIdList | alternateUserIdList Optional |
| extension | str | extension Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| old_password | str | oldPassword Optional |
| new_password | str | newPassword Optional |
| department | OCI.department | department Optional |
| language | str | language Optional |
| time_zone | str | timeZone Optional |
| sip_alias_list | OCI.sipAliasList | sipAliasList Optional |
| endpoint | OCI.endpoint | endpoint Optional |
| shared_call_appearance_access_device_endpoint_list | OCI.sharedCallAppearanceAccessDeviceEndpointList | sharedCallAppearanceAccessDeviceEndpointList Optional |
| title | str | title Optional |
| pager_phone_number | str | pagerPhoneNumber Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| email_address | str | emailAddress Optional |
| yahoo_id | str | yahooId Optional |
| address_location | str | addressLocation Optional |
| address | OCI.address | address Optional |
| network_class_of_service | str | networkClassOfService Optional |
| user_service_list | OCI.userServiceList | userServiceList Optional |
| service_pack_list | OCI.servicePackList | servicePackList Optional |
| third_party_voice_mail_server_selection | str | thirdPartyVoiceMailServerSelection Optional |
| third_party_voice_mail_server_user_server | str | thirdPartyVoiceMailServerUserServer Optional |
| third_party_voice_mail_server_mailbox_id_type | str | thirdPartyVoiceMailServerMailboxIdType Optional |
| third_party_voice_mail_mailbox_url | str | thirdPartyVoiceMailMailboxURL Optional |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| new_sip_authentication_password | str | newSipAuthenticationPassword Optional |
| old_sip_authentication_password | str | OldSipAuthenticationPassword Optional |
| new_passcode | str | newPasscode Optional |
| old_passcode | str | oldPasscode Optional |
| imp_password | str | impPassword Optional |
| new_user_external_id | str | newUserExternalId Optional |
UserConsolidatedModifyRequest22(OCIRequest)
Request to modify a user.
If deleteExistingDevices is set to true, when the devices for the main endpoint or SCA
service are changed, devices with no more endpoint will be deleted if the command is
executed with the correct privilege. Group administrator or above running this
command can delete any group level devices. Service provider administrator or above
can delete any service provider and group devices. Provisioning administrator or
above can delete any devices. An ErrorResponse() will be returned if any device
cannot be deleted because of insufficient privilege. When phone numbers are un-
assigned from the user, the unused numbers may be un-assigned from the group and
service provider. If UnassignPhoneNumbersLevel is set to 'Group', the user's primary
phone number, fax number and any alternate numbers, will be un-assigned from the group
if the command is executed by a service provider administrator or above. When set to
'Service Provider', they will be un-assigned from the group and service provider if
the command is executed by a provisioning administrator or above. When omitted, the
number(s) will be left assigned to the group. An ErrorResponse() will be returned
if any number cannot be unassigned because of insufficient privilege. If the
phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to
true, it will be added to group if needed if the command is executed by a service
provider administrator and above. The command will fail otherwise. Alternate user
ids can be added by a group level administrator or above. The password is not
required if external authentication is enabled. When
sharedCallAppearanceAccessDeviceEndpoint element is included and the Shared Call
Appearance service is not assigned after this request, the request will fail. The
userService/servicePackwill be authorized to the group if it has not been authorized
to the group and the command is excuted by a service provider administrator. The
request will fail otherwise. If not present, the authorizedQuantity will be set to
unlimited if allowed. If any of the third party voice mail elements are included but
the service is not assigned after this request, the request will fail. If the sip
authentication elements are included but the SPI Authentication service is not
assigned after this request, the request will fail. If the impPassword element is
included but the Integrated IMP service is not assigned after this request, the
request will fail. The following elements are ignored in XS data mode:
nameDialingName alternateUserIdList passcode trunkAddressing
thirdPartyVoiceMailServerSelection thirdPartyVoiceMailServerUserServer
thirdPartyVoiceMailServerMailboxIdType thirdPartyVoiceMailMailboxURL
sipAuthenticationData newUserExternalId
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| delete_existing_devices | bool | deleteExistingDevices Optional |
| unassign_phone_numbers | str | unassignPhoneNumbers Optional |
| add_phone_number_to_group | bool | addPhoneNumberToGroup Optional |
| new_user_id | str | newUserId Optional |
| last_name | str | lastName Optional |
| first_name | str | firstName Optional |
| calling_line_id_last_name | str | callingLineIdLastName Optional |
| calling_line_id_first_name | str | callingLineIdFirstName Optional |
| name_dialing_name | OCI.nameDialingName | nameDialingName Optional |
| hiragana_last_name | str | hiraganaLastName Optional |
| hiragana_first_name | str | hiraganaFirstName Optional |
| phone_number | str | phoneNumber Optional |
| alternate_user_id_list | OCI.alternateUserIdList | alternateUserIdList Optional |
| extension | str | extension Optional |
| calling_line_id_phone_number | str | callingLineIdPhoneNumber Optional |
| old_password | str | oldPassword Optional |
| new_password | str | newPassword Optional |
| department | OCI.department | department Optional |
| language | str | language Optional |
| time_zone | str | timeZone Optional |
| sip_alias_list | OCI.sipAliasList | sipAliasList Optional |
| endpoint | OCI.endpoint | endpoint Optional |
| shared_call_appearance_access_device_endpoint_list | OCI.sharedCallAppearanceAccessDeviceEndpointList | sharedCallAppearanceAccessDeviceEndpointList Optional |
| title | str | title Optional |
| pager_phone_number | str | pagerPhoneNumber Optional |
| mobile_phone_number | str | mobilePhoneNumber Optional |
| email_address | str | emailAddress Optional |
| yahoo_id | str | yahooId Optional |
| address_location | str | addressLocation Optional |
| address | OCI.address | address Optional |
| network_class_of_service | str | networkClassOfService Optional |
| user_service_list | OCI.userServiceList | userServiceList Optional |
| service_pack_list | OCI.servicePackList | servicePackList Optional |
| third_party_voice_mail_server_selection | str | thirdPartyVoiceMailServerSelection Optional |
| third_party_voice_mail_server_user_server | str | thirdPartyVoiceMailServerUserServer Optional |
| third_party_voice_mail_server_mailbox_id_type | str | thirdPartyVoiceMailServerMailboxIdType Optional |
| third_party_voice_mail_mailbox_url | str | thirdPartyVoiceMailMailboxURL Optional |
| sip_authentication_user_name | str | sipAuthenticationUserName Optional |
| new_sip_authentication_password | str | newSipAuthenticationPassword Optional |
| old_sip_authentication_password | str | OldSipAuthenticationPassword Optional |
| new_passcode | str | newPasscode Optional |
| old_passcode | str | oldPasscode Optional |
| imp_password | str | impPassword Optional |
| new_user_external_id | str | newUserExternalId Optional |
UserEnhancedCallLogsGetListRequest17sp4(OCIRequest)
Request user's call logs.
If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. The filters "dateTimeRange", "numberFilter", "redirectedNumberFilter", accountAuthorizationCodeFilter" and ""subscriberType" are ignored if call logs are stored in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored in CDS, all call logs including placed will be returned. It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control the maximum number of call logs can be returned.
The response is either a UserEnhancedCallLogsGetListResponse17sp4() or an
ErrorResponse(). Replaced by UserEnhancedCallLogsGetListRequest17sp4V2. Originally
deprecated in release 20.
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| call_log_type | str | callLogType Optional |
| date_time_range | OCI.dateTimeRange | dateTimeRange |
| number_filter | OCI.numberFilter | numberFilter Optional |
| redirected_number_filter | OCI.redirectedNumberFilter | redirectedNumberFilter Optional |
| account_authorization_code_filter | OCI.accountAuthorizationCodeFilter | accountAuthorizationCodeFilter Optional |
| subscriber_type | str | subscriberType Optional |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
UserEnhancedCallLogsGetListRequest20(OCIRequest)
Request user's call logs.
If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. The filters "dateTimeRange", "numberFilter", "redirectedNumberFilter", "accountAuthorizationCodeFilter" "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored in CDS, all call logs including placed will be returned. It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control the maximum number of call logs can be returned.
The response is either a UserEnhancedCallLogsGetListResponse20() or an
ErrorResponse(). The following elements are only used in AS data mode and not
returned in XS data mode: callAuthorizationCodeFilter
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| call_log_type | str | callLogType Optional |
| date_time_range | OCI.dateTimeRange | dateTimeRange |
| number_filter | OCI.numberFilter | numberFilter Optional |
| redirected_number_filter | OCI.redirectedNumberFilter | redirectedNumberFilter Optional |
| account_authorization_code_filter | OCI.accountAuthorizationCodeFilter | accountAuthorizationCodeFilter Optional |
| call_authorization_code_filter | OCI.callAuthorizationCodeFilter | callAuthorizationCodeFilter Optional |
| subscriber_type | str | subscriberType Optional |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
UserEnhancedCallLogsGetListRequest20sp1(OCIRequest)
Request user's call logs.
If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. The filters "dateTimeRange", "numberFilter", "redirectedNumberFilter", "accountAuthorizationCodeFilter" "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored in CDS, all call logs including placed will be returned. It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control the maximum number of call logs can be returned.
The response is either a UserEnhancedCallLogsGetListResponse20sp1() or an
ErrorResponse(). The following elements are only used in AS data mode:
callAuthorizationCodeFilter callSecurityClassification
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| call_log_type | str | callLogType Optional |
| date_time_range | OCI.dateTimeRange | dateTimeRange |
| number_filter | OCI.numberFilter | numberFilter Optional |
| redirected_number_filter | OCI.redirectedNumberFilter | redirectedNumberFilter Optional |
| account_authorization_code_filter | OCI.accountAuthorizationCodeFilter | accountAuthorizationCodeFilter Optional |
| call_authorization_code_filter | OCI.callAuthorizationCodeFilter | callAuthorizationCodeFilter Optional |
| subscriber_type | str | subscriberType Optional |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
UserEnhancedCallLogsGetListRequest21(OCIRequest)
Request user's call logs.
If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. The filters "dateTimeRange", "numberFilter", "redirectedNumberFilter", "accountAuthorizationCodeFilter" "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored in CDS, all call logs including placed will be returned. It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control the maximum number of call logs can be returned.
The response is either a UserEnhancedCallLogsGetListResponse21() or an
ErrorResponse(). The following elements are only used in AS data mode and not
returned in XS data mode: callAuthorizationCodeFilter Replaced by:
UserEnhancedCallLogsGetListRequest21Sp1 in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| call_log_type | str | callLogType Optional |
| date_time_range | OCI.dateTimeRange | dateTimeRange |
| number_filter | OCI.numberFilter | numberFilter Optional |
| redirected_number_filter | OCI.redirectedNumberFilter | redirectedNumberFilter Optional |
| account_authorization_code_filter | OCI.accountAuthorizationCodeFilter | accountAuthorizationCodeFilter Optional |
| call_authorization_code_filter | OCI.callAuthorizationCodeFilter | callAuthorizationCodeFilter Optional |
| subscriber_type | str | subscriberType Optional |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
UserEnhancedCallLogsGetListRequest21sp1(OCIRequest)
Request user's call logs.
If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. The filters "dateTimeRange", "numberFilter", "redirectedNumberFilter", "accountAuthorizationCodeFilter" "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored in CDS, all call logs including placed will be returned. It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control the maximum number of call logs can be returned.
The response is either a UserEnhancedCallLogsGetListResponse21sp1() or an
ErrorResponse(). The following elements are only used in AS data mode and ignored in
XS data mode: callAuthorizationCodeFilter Replaced by:
UserEnhancedCallLogsGetListRequest21Sp1V2 in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| call_log_type | str | callLogType Optional |
| date_time_range | OCI.dateTimeRange | dateTimeRange |
| number_filter | OCI.numberFilter | numberFilter Optional |
| redirected_number_filter | OCI.redirectedNumberFilter | redirectedNumberFilter Optional |
| account_authorization_code_filter | OCI.accountAuthorizationCodeFilter | accountAuthorizationCodeFilter Optional |
| call_authorization_code_filter | OCI.callAuthorizationCodeFilter | callAuthorizationCodeFilter Optional |
| subscriber_type | str | subscriberType Optional |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
UserEnhancedCallLogsGetListRequest22(OCIRequest)
Request user's call logs.
If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. The filters "dateTimeRange", "numberFilter", "redirectedNumberFilter", "accountAuthorizationCodeFilter" "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored in CDS, all call logs including placed will be returned. It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control the maximum number of call logs can be returned.
The response is either a UserEnhancedCallLogsGetListResponse22() or an
ErrorResponse(). The following elements are only used in AS data mode and ignored in
XS data mode: callAuthorizationCodeFilter
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| call_log_type | str | callLogType Optional |
| date_time_range | OCI.dateTimeRange | dateTimeRange |
| number_filter | OCI.numberFilter | numberFilter Optional |
| redirected_number_filter | OCI.redirectedNumberFilter | redirectedNumberFilter Optional |
| account_authorization_code_filter | OCI.accountAuthorizationCodeFilter | accountAuthorizationCodeFilter Optional |
| call_authorization_code_filter | OCI.callAuthorizationCodeFilter | callAuthorizationCodeFilter Optional |
| subscriber_type | str | subscriberType Optional |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
UserEnhancedCallLogsGetListRequest23(OCIRequest)
Request user's call logs.
If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. The filters "dateTimeRange", "numberFilter", "redirectedNumberFilter", "accountAuthorizationCodeFilter" "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored in CDS, all call logs including placed will be returned. It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control the maximum number of call logs can be returned.
The response is either a UserEnhancedCallLogsGetListResponse23() or an
ErrorResponse(). The following elements are only used in AS data mode and ignored in
XS data mode: callAuthorizationCodeFilter
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| call_log_type | str | callLogType Optional |
| date_time_range | OCI.dateTimeRange | dateTimeRange |
| number_filter | OCI.numberFilter | numberFilter Optional |
| redirected_number_filter | OCI.redirectedNumberFilter | redirectedNumberFilter Optional |
| account_authorization_code_filter | OCI.accountAuthorizationCodeFilter | accountAuthorizationCodeFilter Optional |
| call_authorization_code_filter | OCI.callAuthorizationCodeFilter | callAuthorizationCodeFilter Optional |
| subscriber_type | str | subscriberType Optional |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
UserFlexibleSeatingGuestModifyRequest22(OCIRequest)
Modify the user level data associated with flexible seating guest.
accessDeviceEndpoint can only be configured by group or a higher level administrator. The request fails if isActive is set to false and the guest is associated to a host. The request fails when enableAssociationLimit, associationLimitHours, unlockPhonePINCode are changed when the guest is associated to a host. The request fails when accessDeviceEndpoint is set in the request when the guest is associated to a host.
The response is either a SuccessResponse() or an ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| user_id | str | userId |
| is_active | bool | isActive Optional |
| enable_association_limit | bool | enableAssociationLimit Optional |
| association_limit_hours | int | associationLimitHours Optional |
| unlock_phone_pin_code | str | unlockPhonePINCode Optional |
| access_device_endpoint | OCI.accessDeviceEndpoint | accessDeviceEndpoint Optional |
| host_user_id | str | hostUserId Optional |
UserGetListInGroupPagedSortedListRequest(OCIRequest)
Request the list of users in a group.
The response is either a UserGetListInGroupPagedSortedListResponse() or an
ErrorResponse(). If the responsePagingControl element is not provided, the paging
startIndex will be set to 1 by default, and the responsePageSize will be set to the
maximum ResponsePageSize by default. It is possible to search by various criteria to
restrict the number of rows returned. If no sortOrder is included the response is
sorted by User Id ascending by default. A limitation to the search by DN activation
exists when the Number Activation mode is set to Off. In this case DNs not assigned
to users are never returned by queries with the "dnActivationSearchCriteria" included.
Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr
option is included. Then the search criteria are logically ORed together. The
following elements are used in AS data mode and ignored in XS data mode:
groupExternalId
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId Optional |
| group_id | str | groupId Optional |
| group_external_id | str | groupExternalId Optional |
| response_paging_control | OCI.responsePagingControl | responsePagingControl Optional |
| sort_order | List[OCI.sortOrder] | sortOrder Optional |
| search_criteria_user_last_name | List[OCI.searchCriteriaUserLastName] | searchCriteriaUserLastName Optional |
| search_criteria_user_first_name | List[OCI.searchCriteriaUserFirstName] | searchCriteriaUserFirstName Optional |
| search_criteria_dn | List[OCI.searchCriteriaDn] | searchCriteriaDn Optional |
| search_criteria_email_address | List[OCI.searchCriteriaEmailAddress] | searchCriteriaEmailAddress Optional |
| search_criteria_department_name | List[OCI.searchCriteriaDepartmentName] | searchCriteriaDepartmentName Optional |
| search_criteria_exact_user_in_trunk_group | OCI.searchCriteriaExactUserInTrunkGroup | searchCriteriaExactUserInTrunkGroup Optional |
| search_criteria_user_id | List[OCI.searchCriteriaUserId] | searchCriteriaUserId Optional |
| search_criteria_user_external_id | List[OCI.searchCriteriaUserExternalId] | searchCriteriaUserExternalId Optional |
| search_criteria_exact_user_person_id | OCI.searchCriteriaExactUserPersonId | searchCriteriaExactUserPersonId Optional |
| search_criteria_extension | List[OCI.searchCriteriaExtension] | searchCriteriaExtension Optional |
| search_criteria_exact_dn_activation | OCI.searchCriteriaExactDnActivation | searchCriteriaExactDnActivation Optional |
| search_criteria_mode_or | bool | searchCriteriaModeOr Optional |
GroupAutoAttendantAddInstanceRequest14(OCIRequest)
Add a Auto Attendant instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: GroupAutoAttendantAddInstanceRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| enable_video | bool | enableVideo |
| business_hours | str | businessHours Optional |
| holiday_schedule_name | str | holidayScheduleName Optional |
| extension_dialing_scope | str | extensionDialingScope |
| name_dialing_scope | str | nameDialingScope |
| name_dialing_entries | str | nameDialingEntries |
| business_hours_menu | OCI.businessHoursMenu | businessHoursMenu Optional |
| after_hours_menu | OCI.afterHoursMenu | afterHoursMenu Optional |
GroupAutoAttendantAddInstanceRequest16(OCIRequest)
Add a Auto Attendant instance to a group.
The domain is required in the serviceUserId.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| enable_video | bool | enableVideo |
| business_hours | str | businessHours Optional |
| holiday_schedule_name | str | holidayScheduleName Optional |
| extension_dialing_scope | str | extensionDialingScope |
| name_dialing_scope | str | nameDialingScope |
| name_dialing_entries | str | nameDialingEntries |
| business_hours_menu | OCI.businessHoursMenu | businessHoursMenu Optional |
| after_hours_menu | OCI.afterHoursMenu | afterHoursMenu Optional |
GroupAutoAttendantAddInstanceRequest17sp1(OCIRequest)
Add a Auto Attendant instance to a group.
The domain is required in the serviceUserId. Only Group and Enterprise level schedules are accepted.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| enable_video | bool | enableVideo |
| business_hours | OCI.businessHours | businessHours Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| extension_dialing_scope | str | extensionDialingScope |
| name_dialing_scope | str | nameDialingScope |
| name_dialing_entries | str | nameDialingEntries |
| business_hours_menu | OCI.businessHoursMenu | businessHoursMenu Optional |
| after_hours_menu | OCI.afterHoursMenu | afterHoursMenu Optional |
GroupAutoAttendantAddInstanceRequest19(OCIRequest)
Add a Auto Attendant instance to a group.
The domain is required in the serviceUserId. Only Group and Enterprise level schedules are accepted.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode: type, use value "Basic" in XS data mode The
following elements are only used in AS data mode and ignored in XS data mode:
holidayMenu The following elements are only valid for Standard Auto Attendants:
holidayMenu Replaced by: GroupAutoAttendantAddInstanceRequest20() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| type | str | type |
| enable_video | bool | enableVideo |
| business_hours | OCI.businessHours | businessHours Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| extension_dialing_scope | str | extensionDialingScope |
| name_dialing_scope | str | nameDialingScope |
| name_dialing_entries | str | nameDialingEntries |
| business_hours_menu | OCI.businessHoursMenu | businessHoursMenu Optional |
| after_hours_menu | OCI.afterHoursMenu | afterHoursMenu Optional |
| holiday_menu | OCI.holidayMenu | holidayMenu Optional |
| network_class_of_service | str | networkClassOfService Optional |
GroupAutoAttendantAddInstanceRequest20(OCIRequest)
Add a Auto Attendant instance to a group.
The domain is required in the serviceUserId. Only Group and Enterprise level schedules are accepted.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode: type, use AutoAttendantType.BASIC in XS mode.
holidayMenu. The following elements are only valid for Standard Auto Attendants:
holidayMenu
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| type | str | type |
| first_digit_timeout_seconds | int | firstDigitTimeoutSeconds |
| enable_video | bool | enableVideo |
| business_hours | OCI.businessHours | businessHours Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| extension_dialing_scope | str | extensionDialingScope |
| name_dialing_scope | str | nameDialingScope |
| name_dialing_entries | str | nameDialingEntries |
| business_hours_menu | OCI.businessHoursMenu | businessHoursMenu Optional |
| after_hours_menu | OCI.afterHoursMenu | afterHoursMenu Optional |
| holiday_menu | OCI.holidayMenu | holidayMenu Optional |
| network_class_of_service | str | networkClassOfService Optional |
GroupAutoAttendantConsolidatedAddInstanceRequest(OCIRequest)
Add a Auto Attendant instance to a group and assign services to the Auto Attendant.
The domain is required in the serviceUserId. Only Group and Enterprise level schedules are accepted.
The response is either SuccessResponse() or ErrorResponse(). If the phoneNumber
has not been assigned to the group and addPhoneNumberToGroup is set to true, it will
be added to group if the command is executed by a service provider administrator or
above and the number is already assigned to the service provider. The command will
fail otherwise. The following elements are only used in AS data mode: type, use
AutoAttendantType.BASIC in XS mode. holidayMenu. The following elements are only
valid for Standard Auto Attendants: holidayMenu
Attributes:
| Name | Type | Description |
|---|---|---|
| service_provider_id | str | serviceProviderId |
| group_id | str | groupId |
| service_user_id | str | serviceUserId |
| add_phone_number_to_group | bool | addPhoneNumberToGroup Optional |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile |
| type | str | type |
| first_digit_timeout_seconds | int | firstDigitTimeoutSeconds |
| enable_video | bool | enableVideo |
| business_hours | OCI.businessHours | businessHours Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| extension_dialing_scope | str | extensionDialingScope |
| name_dialing_scope | str | nameDialingScope |
| name_dialing_entries | str | nameDialingEntries |
| business_hours_menu | OCI.businessHoursMenu | businessHoursMenu Optional |
| after_hours_menu | OCI.afterHoursMenu | afterHoursMenu Optional |
| holiday_menu | OCI.holidayMenu | holidayMenu Optional |
| network_class_of_service | str | networkClassOfService Optional |
| service | List[OCI.service] | service Optional |
| is_active | bool | isActive |
GroupAutoAttendantConsolidatedModifyInstanceRequest(OCIRequest)
Request to modify an Auto Attendant instance and assign services to the Auto Attendant.
Only Group and Enterprise level schedules are accepted.
The response is either SuccessResponse() or ErrorResponse(). When phone numbers
are un-assigned from the user, the unused numbers may be un-assigned from the group
and service provider. If UnassignPhoneNumbersLevel is set to 'Group', the user's
primary phone number, fax number and any alternate numbers, will be un-assigned from
the group if the command is executed by a service provider administrator or above.
When set to 'Service Provider', they will be un-assigned from the group and service
provider if the command is executed by a provisioning administrator or above. When
omitted, the number(s) will be left assigned to the group. An ErrorResponse() will
be returned if any number cannot be unassigned because of insufficient privilege. If
the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to
true, it will be added to group if needed if the command is executed by a service
provider administrator and above. The command will fail otherwise. The following
elements are only used in AS data mode: holidayMenu. The following elements are only
valid for Standard Auto Attendants: holidayMenu
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| unassign_phone_numbers | str | unassignPhoneNumbers Optional |
| add_phone_number_to_group | bool | addPhoneNumberToGroup Optional |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| first_digit_timeout_seconds | int | firstDigitTimeoutSeconds Optional |
| transfer_to_operator_announcement_selection | str | transferToOperatorAnnouncementSelection Optional |
| transfer_to_operator_audio_file | OCI.transferToOperatorAudioFile | transferToOperatorAudioFile Optional |
| transfer_to_operator_video_file | OCI.transferToOperatorVideoFile | transferToOperatorVideoFile Optional |
| enable_video | bool | enableVideo Optional |
| business_hours | OCI.businessHours | businessHours Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| extension_dialing_scope | str | extensionDialingScope Optional |
| name_dialing_scope | str | nameDialingScope Optional |
| name_dialing_entries | str | nameDialingEntries Optional |
| business_hours_menu | OCI.businessHoursMenu | businessHoursMenu Optional |
| after_hours_menu | OCI.afterHoursMenu | afterHoursMenu Optional |
| holiday_menu | OCI.holidayMenu | holidayMenu Optional |
| network_class_of_service | str | networkClassOfService Optional |
| service_list | OCI.serviceList | serviceList Optional |
| is_active | bool | isActive Optional |
GroupAutoAttendantModifyInstanceRequest(OCIRequest)
Request to modify an Auto Attendant instance.
The response is either SuccessResponse() or ErrorResponse().
Replaced By: GroupAutoAttendantModifyInstanceRequest16()
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| enable_video | bool | enableVideo Optional |
| business_hours | str | businessHours Optional |
| holiday_schedule_name | str | holidayScheduleName Optional |
| extension_dialing_scope | str | extensionDialingScope Optional |
| name_dialing_scope | str | nameDialingScope Optional |
| name_dialing_entries | str | nameDialingEntries Optional |
| business_hours_menu | OCI.businessHoursMenu | businessHoursMenu Optional |
| after_hours_menu | OCI.afterHoursMenu | afterHoursMenu Optional |
GroupAutoAttendantModifyInstanceRequest16(OCIRequest)
Request to modify an Auto Attendant instance.
The response is either SuccessResponse() or ErrorResponse().
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| enable_video | bool | enableVideo Optional |
| business_hours | str | businessHours Optional |
| holiday_schedule_name | str | holidayScheduleName Optional |
| extension_dialing_scope | str | extensionDialingScope Optional |
| name_dialing_scope | str | nameDialingScope Optional |
| name_dialing_entries | str | nameDialingEntries Optional |
| business_hours_menu | OCI.businessHoursMenu | businessHoursMenu Optional |
| after_hours_menu | OCI.afterHoursMenu | afterHoursMenu Optional |
GroupAutoAttendantModifyInstanceRequest17sp1(OCIRequest)
Request to modify an Auto Attendant instance.
Only Group and Enterprise level schedules are accepted.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and not returned in XS data mode: holidayMenu.
The following elementsare only valid for Standard Auto Attendants: holidayMenu
Replaced by: GroupAutoAttendantModifyInstanceRequest20() in AS data mode
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| first_digit_timeout_seconds | int | firstDigitTimeoutSeconds Optional |
| enable_video | bool | enableVideo Optional |
| business_hours | OCI.businessHours | businessHours Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| extension_dialing_scope | str | extensionDialingScope Optional |
| name_dialing_scope | str | nameDialingScope Optional |
| name_dialing_entries | str | nameDialingEntries Optional |
| business_hours_menu | OCI.businessHoursMenu | businessHoursMenu Optional |
| after_hours_menu | OCI.afterHoursMenu | afterHoursMenu Optional |
| holiday_menu | OCI.holidayMenu | holidayMenu Optional |
| network_class_of_service | str | networkClassOfService Optional |
GroupAutoAttendantModifyInstanceRequest20(OCIRequest)
Request to modify an Auto Attendant instance.
Only Group and Enterprise level schedules are accepted.
The response is either SuccessResponse() or ErrorResponse(). The following
elements are only used in AS data mode and not returned in XS datamode:
transferToOperatorAudioFile, transferToOperatorVideoFile, holidayMenu The following
element is only used in AS data mode: transferToOperatorAnnouncementSelection, value
"Default" is returned in XS data mode. The following elements are only valid for
Standard Auto Attendants: holidayMenu
Attributes:
| Name | Type | Description |
|---|---|---|
| service_user_id | str | serviceUserId |
| service_instance_profile | OCI.serviceInstanceProfile | serviceInstanceProfile Optional |
| first_digit_timeout_seconds | int | firstDigitTimeoutSeconds Optional |
| transfer_to_operator_announcement_selection | str | transferToOperatorAnnouncementSelection Optional |
| transfer_to_operator_audio_file | OCI.transferToOperatorAudioFile | transferToOperatorAudioFile Optional |
| transfer_to_operator_video_file | OCI.transferToOperatorVideoFile | transferToOperatorVideoFile Optional |
| enable_video | bool | enableVideo Optional |
| business_hours | OCI.businessHours | businessHours Optional |
| holiday_schedule | OCI.holidaySchedule | holidaySchedule Optional |
| extension_dialing_scope | str | extensionDialingScope Optional |
| name_dialing_scope | str | nameDialingScope Optional |
| name_dialing_entries | str | nameDialingEntries Optional |
| business_hours_menu | OCI.businessHoursMenu | businessHoursMenu Optional |
| after_hours_menu | OCI.afterHoursMenu | afterHoursMenu Optional |
| holiday_menu | OCI.holidayMenu | holidayMenu Optional |
| network_class_of_service | str | networkClassOfService Optional |