purecloudplatformclientv2 34.0.0 → 35.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AlertingApi.md +66 -0
- data/docs/AnalyticsApi.md +144 -0
- data/docs/ArchitectApi.md +492 -2
- data/docs/AssignedWrapupCode.md +17 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AttributeEntityListing.md +1 -1
- data/docs/AttributesApi.md +36 -0
- data/docs/AuthorizationApi.md +102 -0
- data/docs/BillingApi.md +6 -0
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignDivisionView.md +16 -0
- data/docs/CampaignDivisionViewListing.md +22 -0
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ContentManagementApi.md +228 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationsApi.md +590 -14
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EndpointEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalContactsApi.md +238 -69
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FaxApi.md +36 -0
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/Flow.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GeneralDataProtectionRegulationApi.md +24 -0
- data/docs/GeolocationApi.md +24 -0
- data/docs/GreetingListing.md +1 -1
- data/docs/GreetingsApi.md +96 -0
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/GroupsApi.md +84 -0
- data/docs/IVREntityListing.md +1 -1
- data/docs/IdentityProviderApi.md +168 -0
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/IntegrationsApi.md +246 -0
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/JsonNode.md +4 -4
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LanguagesApi.md +60 -0
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LicenseApi.md +48 -0
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationsApi.md +24 -0
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MobileDevicesApi.md +30 -0
- data/docs/NoteListing.md +1 -1
- data/docs/NotificationsApi.md +42 -0
- data/docs/OAuthApi.md +36 -0
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationApi.md +24 -0
- data/docs/OrganizationAuthorizationApi.md +138 -0
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundApi.md +611 -0
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PresenceApi.md +48 -0
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityApi.md +300 -0
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingApi.md +222 -0
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseManagementApi.md +66 -0
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +351 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/ScriptsApi.md +66 -0
- data/docs/SearchApi.md +84 -0
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/StationsApi.md +30 -0
- data/docs/SuggestApi.md +24 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TelephonyProvidersEdgeApi.md +762 -0
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeZone.md +2 -2
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TokensApi.md +12 -0
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserRecordingsApi.md +36 -0
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +321 -3
- data/docs/UtilitiesApi.md +18 -0
- data/docs/VoicemailApi.md +144 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatApi.md +48 -0
- data/docs/WebChatConfig.md +13 -0
- data/docs/WebChatDeployment.md +2 -1
- data/docs/WorkforceManagementApi.md +74 -2
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +4 -1
- data/lib/purecloudplatformclientv2/api/architect_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +21 -21
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +90 -68
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +117 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +1 -1
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/assigned_wrapup_code.rb +308 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/{authz_division.rb → campaign_division_view.rb} +9 -68
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow.rb +13 -12
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/json_node.rb +65 -65
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/note_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/web_chat_config.rb +202 -0
- data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +27 -2
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +10 -4
- data/docs/AuthzDivision.md +0 -18
|
@@ -13,9 +13,9 @@ title: SecurityProfileEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/ShareEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: ShareEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/SiteEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: SiteEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/SkillEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: SkillEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: SmsPhoneNumberEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: StationEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/StationsApi.md
CHANGED
|
@@ -19,12 +19,18 @@ Method | Description
|
|
|
19
19
|
|
|
20
20
|
## - delete_station_associateduser(station_id)
|
|
21
21
|
|
|
22
|
+
|
|
23
|
+
|
|
22
24
|
Unassigns the user assigned to this station
|
|
23
25
|
|
|
24
26
|
|
|
25
27
|
|
|
26
28
|
Wraps DELETE /api/v2/stations/{stationId}/associateduser
|
|
27
29
|
|
|
30
|
+
Requires NO permissions:
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
28
34
|
|
|
29
35
|
### Example
|
|
30
36
|
~~~ruby
|
|
@@ -77,12 +83,18 @@ nil (empty response body)
|
|
|
77
83
|
|
|
78
84
|
## -[**Station**](Station.html) get_station(station_id)
|
|
79
85
|
|
|
86
|
+
|
|
87
|
+
|
|
80
88
|
Get station.
|
|
81
89
|
|
|
82
90
|
|
|
83
91
|
|
|
84
92
|
Wraps GET /api/v2/stations/{stationId}
|
|
85
93
|
|
|
94
|
+
Requires NO permissions:
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
86
98
|
|
|
87
99
|
### Example
|
|
88
100
|
~~~ruby
|
|
@@ -136,12 +148,18 @@ Name | Type | Description | Notes
|
|
|
136
148
|
|
|
137
149
|
## -[**StationEntityListing**](StationEntityListing.html) get_stations(opts)
|
|
138
150
|
|
|
151
|
+
|
|
152
|
+
|
|
139
153
|
Get the list of available stations.
|
|
140
154
|
|
|
141
155
|
|
|
142
156
|
|
|
143
157
|
Wraps GET /api/v2/stations
|
|
144
158
|
|
|
159
|
+
Requires NO permissions:
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
145
163
|
|
|
146
164
|
### Example
|
|
147
165
|
~~~ruby
|
|
@@ -210,12 +228,18 @@ Name | Type | Description | Notes
|
|
|
210
228
|
|
|
211
229
|
## -[**StationSettings**](StationSettings.html) get_stations_settings
|
|
212
230
|
|
|
231
|
+
|
|
232
|
+
|
|
213
233
|
Get an organization's StationSettings
|
|
214
234
|
|
|
215
235
|
|
|
216
236
|
|
|
217
237
|
Wraps GET /api/v2/stations/settings
|
|
218
238
|
|
|
239
|
+
Requires ANY permissions:
|
|
240
|
+
|
|
241
|
+
* telephony:plugin:all
|
|
242
|
+
|
|
219
243
|
|
|
220
244
|
### Example
|
|
221
245
|
~~~ruby
|
|
@@ -263,12 +287,18 @@ This endpoint does not need any parameter.
|
|
|
263
287
|
|
|
264
288
|
## -[**StationSettings**](StationSettings.html) patch_stations_settings(body)
|
|
265
289
|
|
|
290
|
+
|
|
291
|
+
|
|
266
292
|
Patch an organization's StationSettings
|
|
267
293
|
|
|
268
294
|
|
|
269
295
|
|
|
270
296
|
Wraps PATCH /api/v2/stations/settings
|
|
271
297
|
|
|
298
|
+
Requires ANY permissions:
|
|
299
|
+
|
|
300
|
+
* telephony:plugin:all
|
|
301
|
+
|
|
272
302
|
|
|
273
303
|
### Example
|
|
274
304
|
~~~ruby
|
data/docs/SuggestApi.md
CHANGED
|
@@ -18,12 +18,18 @@ Method | Description
|
|
|
18
18
|
|
|
19
19
|
## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_search(q64, opts)
|
|
20
20
|
|
|
21
|
+
|
|
22
|
+
|
|
21
23
|
Search using the q64 value returned from a previous search.
|
|
22
24
|
|
|
23
25
|
|
|
24
26
|
|
|
25
27
|
Wraps GET /api/v2/search
|
|
26
28
|
|
|
29
|
+
Requires NO permissions:
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
27
33
|
|
|
28
34
|
### Example
|
|
29
35
|
~~~ruby
|
|
@@ -83,12 +89,18 @@ Name | Type | Description | Notes
|
|
|
83
89
|
|
|
84
90
|
## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_search_suggest(q64, opts)
|
|
85
91
|
|
|
92
|
+
|
|
93
|
+
|
|
86
94
|
Suggest resources using the q64 value returned from a previous suggest query.
|
|
87
95
|
|
|
88
96
|
|
|
89
97
|
|
|
90
98
|
Wraps GET /api/v2/search/suggest
|
|
91
99
|
|
|
100
|
+
Requires NO permissions:
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
92
104
|
|
|
93
105
|
### Example
|
|
94
106
|
~~~ruby
|
|
@@ -148,12 +160,18 @@ Name | Type | Description | Notes
|
|
|
148
160
|
|
|
149
161
|
## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_search(body, opts)
|
|
150
162
|
|
|
163
|
+
|
|
164
|
+
|
|
151
165
|
Search resources.
|
|
152
166
|
|
|
153
167
|
|
|
154
168
|
|
|
155
169
|
Wraps POST /api/v2/search
|
|
156
170
|
|
|
171
|
+
Requires NO permissions:
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
157
175
|
|
|
158
176
|
### Example
|
|
159
177
|
~~~ruby
|
|
@@ -211,12 +229,18 @@ Name | Type | Description | Notes
|
|
|
211
229
|
|
|
212
230
|
## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_search_suggest(body, opts)
|
|
213
231
|
|
|
232
|
+
|
|
233
|
+
|
|
214
234
|
Suggest resources.
|
|
215
235
|
|
|
216
236
|
|
|
217
237
|
|
|
218
238
|
Wraps POST /api/v2/search/suggest
|
|
219
239
|
|
|
240
|
+
Requires NO permissions:
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
220
244
|
|
|
221
245
|
### Example
|
|
222
246
|
~~~ruby
|
|
@@ -13,9 +13,9 @@ title: SurveyFormEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: SystemPromptAssetEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: SystemPromptEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: TagValueEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -141,12 +141,18 @@ Method | Description
|
|
|
141
141
|
|
|
142
142
|
## - delete_telephony_providers_edge(edge_id)
|
|
143
143
|
|
|
144
|
+
|
|
145
|
+
|
|
144
146
|
Delete a edge.
|
|
145
147
|
|
|
146
148
|
|
|
147
149
|
|
|
148
150
|
Wraps DELETE /api/v2/telephony/providers/edges/{edgeId}
|
|
149
151
|
|
|
152
|
+
Requires ANY permissions:
|
|
153
|
+
|
|
154
|
+
* telephony:plugin:all
|
|
155
|
+
|
|
150
156
|
|
|
151
157
|
### Example
|
|
152
158
|
~~~ruby
|
|
@@ -199,12 +205,18 @@ nil (empty response body)
|
|
|
199
205
|
|
|
200
206
|
## - delete_telephony_providers_edge_logicalinterface(edge_id, interface_id)
|
|
201
207
|
|
|
208
|
+
|
|
209
|
+
|
|
202
210
|
Delete an edge logical interface
|
|
203
211
|
|
|
204
212
|
|
|
205
213
|
|
|
206
214
|
Wraps DELETE /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}
|
|
207
215
|
|
|
216
|
+
Requires ANY permissions:
|
|
217
|
+
|
|
218
|
+
* telephony:plugin:all
|
|
219
|
+
|
|
208
220
|
|
|
209
221
|
### Example
|
|
210
222
|
~~~ruby
|
|
@@ -260,12 +272,18 @@ nil (empty response body)
|
|
|
260
272
|
|
|
261
273
|
## - delete_telephony_providers_edge_softwareupdate(edge_id)
|
|
262
274
|
|
|
275
|
+
|
|
276
|
+
|
|
263
277
|
Cancels any in-progress update for this edge.
|
|
264
278
|
|
|
265
279
|
|
|
266
280
|
|
|
267
281
|
Wraps DELETE /api/v2/telephony/providers/edges/{edgeId}/softwareupdate
|
|
268
282
|
|
|
283
|
+
Requires NO permissions:
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
269
287
|
|
|
270
288
|
### Example
|
|
271
289
|
~~~ruby
|
|
@@ -318,12 +336,18 @@ nil (empty response body)
|
|
|
318
336
|
|
|
319
337
|
## - delete_telephony_providers_edges_certificateauthority(certificate_id)
|
|
320
338
|
|
|
339
|
+
|
|
340
|
+
|
|
321
341
|
Delete a certificate authority.
|
|
322
342
|
|
|
323
343
|
|
|
324
344
|
|
|
325
345
|
Wraps DELETE /api/v2/telephony/providers/edges/certificateauthorities/{certificateId}
|
|
326
346
|
|
|
347
|
+
Requires ANY permissions:
|
|
348
|
+
|
|
349
|
+
* telephony:plugin:all
|
|
350
|
+
|
|
327
351
|
|
|
328
352
|
### Example
|
|
329
353
|
~~~ruby
|
|
@@ -376,12 +400,18 @@ nil (empty response body)
|
|
|
376
400
|
|
|
377
401
|
## - delete_telephony_providers_edges_didpool(did_pool_id)
|
|
378
402
|
|
|
403
|
+
|
|
404
|
+
|
|
379
405
|
Delete a DID Pool by ID.
|
|
380
406
|
|
|
381
407
|
|
|
382
408
|
|
|
383
409
|
Wraps DELETE /api/v2/telephony/providers/edges/didpools/{didPoolId}
|
|
384
410
|
|
|
411
|
+
Requires ANY permissions:
|
|
412
|
+
|
|
413
|
+
* telephony:plugin:all
|
|
414
|
+
|
|
385
415
|
|
|
386
416
|
### Example
|
|
387
417
|
~~~ruby
|
|
@@ -434,12 +464,18 @@ nil (empty response body)
|
|
|
434
464
|
|
|
435
465
|
## - delete_telephony_providers_edges_edgegroup(edge_group_id)
|
|
436
466
|
|
|
467
|
+
|
|
468
|
+
|
|
437
469
|
Delete an edge group.
|
|
438
470
|
|
|
439
471
|
|
|
440
472
|
|
|
441
473
|
Wraps DELETE /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}
|
|
442
474
|
|
|
475
|
+
Requires ANY permissions:
|
|
476
|
+
|
|
477
|
+
* telephony:plugin:all
|
|
478
|
+
|
|
443
479
|
|
|
444
480
|
### Example
|
|
445
481
|
~~~ruby
|
|
@@ -492,12 +528,18 @@ nil (empty response body)
|
|
|
492
528
|
|
|
493
529
|
## - delete_telephony_providers_edges_endpoint(endpoint_id)
|
|
494
530
|
|
|
531
|
+
|
|
532
|
+
|
|
495
533
|
Delete endpoint
|
|
496
534
|
|
|
497
535
|
|
|
498
536
|
|
|
499
537
|
Wraps DELETE /api/v2/telephony/providers/edges/endpoints/{endpointId}
|
|
500
538
|
|
|
539
|
+
Requires ANY permissions:
|
|
540
|
+
|
|
541
|
+
* telephony:plugin:all
|
|
542
|
+
|
|
501
543
|
|
|
502
544
|
### Example
|
|
503
545
|
~~~ruby
|
|
@@ -550,12 +592,18 @@ nil (empty response body)
|
|
|
550
592
|
|
|
551
593
|
## - delete_telephony_providers_edges_extensionpool(extension_pool_id)
|
|
552
594
|
|
|
595
|
+
|
|
596
|
+
|
|
553
597
|
Delete an extension pool by ID
|
|
554
598
|
|
|
555
599
|
|
|
556
600
|
|
|
557
601
|
Wraps DELETE /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}
|
|
558
602
|
|
|
603
|
+
Requires ANY permissions:
|
|
604
|
+
|
|
605
|
+
* telephony:plugin:all
|
|
606
|
+
|
|
559
607
|
|
|
560
608
|
### Example
|
|
561
609
|
~~~ruby
|
|
@@ -608,12 +656,18 @@ nil (empty response body)
|
|
|
608
656
|
|
|
609
657
|
## - delete_telephony_providers_edges_outboundroute(outbound_route_id)
|
|
610
658
|
|
|
659
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
660
|
+
|
|
611
661
|
Delete Outbound Route
|
|
612
662
|
|
|
613
663
|
|
|
614
664
|
|
|
615
665
|
Wraps DELETE /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}
|
|
616
666
|
|
|
667
|
+
Requires ANY permissions:
|
|
668
|
+
|
|
669
|
+
* telephony:plugin:all
|
|
670
|
+
|
|
617
671
|
|
|
618
672
|
### Example
|
|
619
673
|
~~~ruby
|
|
@@ -666,12 +720,18 @@ nil (empty response body)
|
|
|
666
720
|
|
|
667
721
|
## - delete_telephony_providers_edges_phone(phone_id)
|
|
668
722
|
|
|
723
|
+
|
|
724
|
+
|
|
669
725
|
Delete a Phone by ID
|
|
670
726
|
|
|
671
727
|
|
|
672
728
|
|
|
673
729
|
Wraps DELETE /api/v2/telephony/providers/edges/phones/{phoneId}
|
|
674
730
|
|
|
731
|
+
Requires ANY permissions:
|
|
732
|
+
|
|
733
|
+
* telephony:plugin:all
|
|
734
|
+
|
|
675
735
|
|
|
676
736
|
### Example
|
|
677
737
|
~~~ruby
|
|
@@ -724,12 +784,18 @@ nil (empty response body)
|
|
|
724
784
|
|
|
725
785
|
## - delete_telephony_providers_edges_phonebasesetting(phone_base_id)
|
|
726
786
|
|
|
787
|
+
|
|
788
|
+
|
|
727
789
|
Delete a Phone Base Settings by ID
|
|
728
790
|
|
|
729
791
|
|
|
730
792
|
|
|
731
793
|
Wraps DELETE /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}
|
|
732
794
|
|
|
795
|
+
Requires ANY permissions:
|
|
796
|
+
|
|
797
|
+
* telephony:plugin:all
|
|
798
|
+
|
|
733
799
|
|
|
734
800
|
### Example
|
|
735
801
|
~~~ruby
|
|
@@ -782,12 +848,18 @@ nil (empty response body)
|
|
|
782
848
|
|
|
783
849
|
## - delete_telephony_providers_edges_site(site_id)
|
|
784
850
|
|
|
851
|
+
|
|
852
|
+
|
|
785
853
|
Delete a Site by ID
|
|
786
854
|
|
|
787
855
|
|
|
788
856
|
|
|
789
857
|
Wraps DELETE /api/v2/telephony/providers/edges/sites/{siteId}
|
|
790
858
|
|
|
859
|
+
Requires ANY permissions:
|
|
860
|
+
|
|
861
|
+
* telephony:plugin:all
|
|
862
|
+
|
|
791
863
|
|
|
792
864
|
### Example
|
|
793
865
|
~~~ruby
|
|
@@ -840,12 +912,18 @@ nil (empty response body)
|
|
|
840
912
|
|
|
841
913
|
## - delete_telephony_providers_edges_site_outboundroute(site_id, outbound_route_id)
|
|
842
914
|
|
|
915
|
+
|
|
916
|
+
|
|
843
917
|
Delete Outbound Route
|
|
844
918
|
|
|
845
919
|
|
|
846
920
|
|
|
847
921
|
Wraps DELETE /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}
|
|
848
922
|
|
|
923
|
+
Requires ANY permissions:
|
|
924
|
+
|
|
925
|
+
* telephony:plugin:all
|
|
926
|
+
|
|
849
927
|
|
|
850
928
|
### Example
|
|
851
929
|
~~~ruby
|
|
@@ -901,12 +979,18 @@ nil (empty response body)
|
|
|
901
979
|
|
|
902
980
|
## - delete_telephony_providers_edges_trunkbasesetting(trunk_base_settings_id)
|
|
903
981
|
|
|
982
|
+
|
|
983
|
+
|
|
904
984
|
Delete a Trunk Base Settings object by ID
|
|
905
985
|
|
|
906
986
|
|
|
907
987
|
|
|
908
988
|
Wraps DELETE /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}
|
|
909
989
|
|
|
990
|
+
Requires ANY permissions:
|
|
991
|
+
|
|
992
|
+
* telephony:plugin:all
|
|
993
|
+
|
|
910
994
|
|
|
911
995
|
### Example
|
|
912
996
|
~~~ruby
|
|
@@ -959,12 +1043,18 @@ nil (empty response body)
|
|
|
959
1043
|
|
|
960
1044
|
## -[**SchemaCategoryEntityListing**](SchemaCategoryEntityListing.html) get_configuration_schemas_edges_vnext(opts)
|
|
961
1045
|
|
|
1046
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
1047
|
+
|
|
962
1048
|
Lists available schema categories (Deprecated)
|
|
963
1049
|
|
|
964
1050
|
|
|
965
1051
|
|
|
966
1052
|
Wraps GET /api/v2/configuration/schemas/edges/vnext
|
|
967
1053
|
|
|
1054
|
+
Requires NO permissions:
|
|
1055
|
+
|
|
1056
|
+
|
|
1057
|
+
|
|
968
1058
|
|
|
969
1059
|
### Example
|
|
970
1060
|
~~~ruby
|
|
@@ -1021,12 +1111,18 @@ Name | Type | Description | Notes
|
|
|
1021
1111
|
|
|
1022
1112
|
## -[**SchemaReferenceEntityListing**](SchemaReferenceEntityListing.html) get_configuration_schemas_edges_vnext_schema_category(schema_category, opts)
|
|
1023
1113
|
|
|
1114
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
1115
|
+
|
|
1024
1116
|
List schemas of a specific category (Deprecated)
|
|
1025
1117
|
|
|
1026
1118
|
|
|
1027
1119
|
|
|
1028
1120
|
Wraps GET /api/v2/configuration/schemas/edges/vnext/{schemaCategory}
|
|
1029
1121
|
|
|
1122
|
+
Requires NO permissions:
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
|
|
1030
1126
|
|
|
1031
1127
|
### Example
|
|
1032
1128
|
~~~ruby
|
|
@@ -1086,12 +1182,18 @@ Name | Type | Description | Notes
|
|
|
1086
1182
|
|
|
1087
1183
|
## -[**SchemaReferenceEntityListing**](SchemaReferenceEntityListing.html) get_configuration_schemas_edges_vnext_schema_category_schema_type(schema_category, schema_type, opts)
|
|
1088
1184
|
|
|
1185
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
1186
|
+
|
|
1089
1187
|
List schemas of a specific category (Deprecated)
|
|
1090
1188
|
|
|
1091
1189
|
|
|
1092
1190
|
|
|
1093
1191
|
Wraps GET /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}
|
|
1094
1192
|
|
|
1193
|
+
Requires NO permissions:
|
|
1194
|
+
|
|
1195
|
+
|
|
1196
|
+
|
|
1095
1197
|
|
|
1096
1198
|
### Example
|
|
1097
1199
|
~~~ruby
|
|
@@ -1154,12 +1256,18 @@ Name | Type | Description | Notes
|
|
|
1154
1256
|
|
|
1155
1257
|
## -[**Organization**](Organization.html) get_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id(schema_category, schema_type, schema_id)
|
|
1156
1258
|
|
|
1259
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
1260
|
+
|
|
1157
1261
|
Get a json schema (Deprecated)
|
|
1158
1262
|
|
|
1159
1263
|
|
|
1160
1264
|
|
|
1161
1265
|
Wraps GET /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}
|
|
1162
1266
|
|
|
1267
|
+
Requires NO permissions:
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
|
|
1163
1271
|
|
|
1164
1272
|
### Example
|
|
1165
1273
|
~~~ruby
|
|
@@ -1219,12 +1327,18 @@ Name | Type | Description | Notes
|
|
|
1219
1327
|
|
|
1220
1328
|
## -[**Organization**](Organization.html) get_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id_extension_type_metadata_id(schema_category, schema_type, schema_id, extension_type, metadata_id, opts)
|
|
1221
1329
|
|
|
1330
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
1331
|
+
|
|
1222
1332
|
Get metadata for a schema (Deprecated)
|
|
1223
1333
|
|
|
1224
1334
|
|
|
1225
1335
|
|
|
1226
1336
|
Wraps GET /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extensionType}/{metadataId}
|
|
1227
1337
|
|
|
1338
|
+
Requires NO permissions:
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
|
|
1228
1342
|
|
|
1229
1343
|
### Example
|
|
1230
1344
|
~~~ruby
|
|
@@ -1294,12 +1408,18 @@ Name | Type | Description | Notes
|
|
|
1294
1408
|
|
|
1295
1409
|
## -[**Edge**](Edge.html) get_telephony_providers_edge(edge_id, opts)
|
|
1296
1410
|
|
|
1411
|
+
|
|
1412
|
+
|
|
1297
1413
|
Get edge.
|
|
1298
1414
|
|
|
1299
1415
|
|
|
1300
1416
|
|
|
1301
1417
|
Wraps GET /api/v2/telephony/providers/edges/{edgeId}
|
|
1302
1418
|
|
|
1419
|
+
Requires ANY permissions:
|
|
1420
|
+
|
|
1421
|
+
* telephony:plugin:all
|
|
1422
|
+
|
|
1303
1423
|
|
|
1304
1424
|
### Example
|
|
1305
1425
|
~~~ruby
|
|
@@ -1357,12 +1477,18 @@ Name | Type | Description | Notes
|
|
|
1357
1477
|
|
|
1358
1478
|
## -[**EdgeLine**](EdgeLine.html) get_telephony_providers_edge_line(edge_id, line_id)
|
|
1359
1479
|
|
|
1480
|
+
|
|
1481
|
+
|
|
1360
1482
|
Get line
|
|
1361
1483
|
|
|
1362
1484
|
|
|
1363
1485
|
|
|
1364
1486
|
Wraps GET /api/v2/telephony/providers/edges/{edgeId}/lines/{lineId}
|
|
1365
1487
|
|
|
1488
|
+
Requires ANY permissions:
|
|
1489
|
+
|
|
1490
|
+
* telephony:plugin:all
|
|
1491
|
+
|
|
1366
1492
|
|
|
1367
1493
|
### Example
|
|
1368
1494
|
~~~ruby
|
|
@@ -1419,12 +1545,18 @@ Name | Type | Description | Notes
|
|
|
1419
1545
|
|
|
1420
1546
|
## -[**EdgeLineEntityListing**](EdgeLineEntityListing.html) get_telephony_providers_edge_lines(edge_id, opts)
|
|
1421
1547
|
|
|
1548
|
+
|
|
1549
|
+
|
|
1422
1550
|
Get the list of lines.
|
|
1423
1551
|
|
|
1424
1552
|
|
|
1425
1553
|
|
|
1426
1554
|
Wraps GET /api/v2/telephony/providers/edges/{edgeId}/lines
|
|
1427
1555
|
|
|
1556
|
+
Requires ANY permissions:
|
|
1557
|
+
|
|
1558
|
+
* telephony:plugin:all
|
|
1559
|
+
|
|
1428
1560
|
|
|
1429
1561
|
### Example
|
|
1430
1562
|
~~~ruby
|
|
@@ -1484,12 +1616,18 @@ Name | Type | Description | Notes
|
|
|
1484
1616
|
|
|
1485
1617
|
## -[**DomainLogicalInterface**](DomainLogicalInterface.html) get_telephony_providers_edge_logicalinterface(edge_id, interface_id, opts)
|
|
1486
1618
|
|
|
1619
|
+
|
|
1620
|
+
|
|
1487
1621
|
Get an edge logical interface
|
|
1488
1622
|
|
|
1489
1623
|
|
|
1490
1624
|
|
|
1491
1625
|
Wraps GET /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}
|
|
1492
1626
|
|
|
1627
|
+
Requires ANY permissions:
|
|
1628
|
+
|
|
1629
|
+
* telephony:plugin:all
|
|
1630
|
+
|
|
1493
1631
|
|
|
1494
1632
|
### Example
|
|
1495
1633
|
~~~ruby
|
|
@@ -1550,12 +1688,18 @@ Name | Type | Description | Notes
|
|
|
1550
1688
|
|
|
1551
1689
|
## -[**LogicalInterfaceEntityListing**](LogicalInterfaceEntityListing.html) get_telephony_providers_edge_logicalinterfaces(edge_id, opts)
|
|
1552
1690
|
|
|
1691
|
+
|
|
1692
|
+
|
|
1553
1693
|
Get edge logical interfaces.
|
|
1554
1694
|
|
|
1555
1695
|
Retrieve a list of all configured logical interfaces from a specific edge.
|
|
1556
1696
|
|
|
1557
1697
|
Wraps GET /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces
|
|
1558
1698
|
|
|
1699
|
+
Requires ANY permissions:
|
|
1700
|
+
|
|
1701
|
+
* telephony:plugin:all
|
|
1702
|
+
|
|
1559
1703
|
|
|
1560
1704
|
### Example
|
|
1561
1705
|
~~~ruby
|
|
@@ -1613,12 +1757,18 @@ Name | Type | Description | Notes
|
|
|
1613
1757
|
|
|
1614
1758
|
## -[**EdgeLogsJob**](EdgeLogsJob.html) get_telephony_providers_edge_logs_job(edge_id, job_id)
|
|
1615
1759
|
|
|
1760
|
+
|
|
1761
|
+
|
|
1616
1762
|
Get an Edge logs job.
|
|
1617
1763
|
|
|
1618
1764
|
|
|
1619
1765
|
|
|
1620
1766
|
Wraps GET /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}
|
|
1621
1767
|
|
|
1768
|
+
Requires ANY permissions:
|
|
1769
|
+
|
|
1770
|
+
* telephony:plugin:all
|
|
1771
|
+
|
|
1622
1772
|
|
|
1623
1773
|
### Example
|
|
1624
1774
|
~~~ruby
|
|
@@ -1675,12 +1825,18 @@ Name | Type | Description | Notes
|
|
|
1675
1825
|
|
|
1676
1826
|
## -[**EdgeMetrics**](EdgeMetrics.html) get_telephony_providers_edge_metrics(edge_id)
|
|
1677
1827
|
|
|
1828
|
+
|
|
1829
|
+
|
|
1678
1830
|
Get the edge metrics.
|
|
1679
1831
|
|
|
1680
1832
|
|
|
1681
1833
|
|
|
1682
1834
|
Wraps GET /api/v2/telephony/providers/edges/{edgeId}/metrics
|
|
1683
1835
|
|
|
1836
|
+
Requires ANY permissions:
|
|
1837
|
+
|
|
1838
|
+
* telephony:plugin:all
|
|
1839
|
+
|
|
1684
1840
|
|
|
1685
1841
|
### Example
|
|
1686
1842
|
~~~ruby
|
|
@@ -1734,12 +1890,18 @@ Name | Type | Description | Notes
|
|
|
1734
1890
|
|
|
1735
1891
|
## -[**DomainPhysicalInterface**](DomainPhysicalInterface.html) get_telephony_providers_edge_physicalinterface(edge_id, interface_id)
|
|
1736
1892
|
|
|
1893
|
+
|
|
1894
|
+
|
|
1737
1895
|
Get edge physical interface.
|
|
1738
1896
|
|
|
1739
1897
|
Retrieve a physical interface from a specific edge.
|
|
1740
1898
|
|
|
1741
1899
|
Wraps GET /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}
|
|
1742
1900
|
|
|
1901
|
+
Requires ANY permissions:
|
|
1902
|
+
|
|
1903
|
+
* telephony:plugin:all
|
|
1904
|
+
|
|
1743
1905
|
|
|
1744
1906
|
### Example
|
|
1745
1907
|
~~~ruby
|
|
@@ -1796,12 +1958,18 @@ Name | Type | Description | Notes
|
|
|
1796
1958
|
|
|
1797
1959
|
## -[**PhysicalInterfaceEntityListing**](PhysicalInterfaceEntityListing.html) get_telephony_providers_edge_physicalinterfaces(edge_id)
|
|
1798
1960
|
|
|
1961
|
+
|
|
1962
|
+
|
|
1799
1963
|
Retrieve a list of all configured physical interfaces from a specific edge.
|
|
1800
1964
|
|
|
1801
1965
|
|
|
1802
1966
|
|
|
1803
1967
|
Wraps GET /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces
|
|
1804
1968
|
|
|
1969
|
+
Requires ANY permissions:
|
|
1970
|
+
|
|
1971
|
+
* telephony:plugin:all
|
|
1972
|
+
|
|
1805
1973
|
|
|
1806
1974
|
### Example
|
|
1807
1975
|
~~~ruby
|
|
@@ -1855,12 +2023,18 @@ Name | Type | Description | Notes
|
|
|
1855
2023
|
|
|
1856
2024
|
## -[**VmPairingInfo**](VmPairingInfo.html) get_telephony_providers_edge_setuppackage(edge_id)
|
|
1857
2025
|
|
|
2026
|
+
|
|
2027
|
+
|
|
1858
2028
|
Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.
|
|
1859
2029
|
|
|
1860
2030
|
|
|
1861
2031
|
|
|
1862
2032
|
Wraps GET /api/v2/telephony/providers/edges/{edgeId}/setuppackage
|
|
1863
2033
|
|
|
2034
|
+
Requires ANY permissions:
|
|
2035
|
+
|
|
2036
|
+
* telephony:plugin:all
|
|
2037
|
+
|
|
1864
2038
|
|
|
1865
2039
|
### Example
|
|
1866
2040
|
~~~ruby
|
|
@@ -1914,12 +2088,18 @@ Name | Type | Description | Notes
|
|
|
1914
2088
|
|
|
1915
2089
|
## -[**DomainEdgeSoftwareUpdateDto**](DomainEdgeSoftwareUpdateDto.html) get_telephony_providers_edge_softwareupdate(edge_id)
|
|
1916
2090
|
|
|
2091
|
+
|
|
2092
|
+
|
|
1917
2093
|
Gets software update status information about any edge.
|
|
1918
2094
|
|
|
1919
2095
|
|
|
1920
2096
|
|
|
1921
2097
|
Wraps GET /api/v2/telephony/providers/edges/{edgeId}/softwareupdate
|
|
1922
2098
|
|
|
2099
|
+
Requires NO permissions:
|
|
2100
|
+
|
|
2101
|
+
|
|
2102
|
+
|
|
1923
2103
|
|
|
1924
2104
|
### Example
|
|
1925
2105
|
~~~ruby
|
|
@@ -1973,12 +2153,18 @@ Name | Type | Description | Notes
|
|
|
1973
2153
|
|
|
1974
2154
|
## -[**DomainEdgeSoftwareVersionDtoEntityListing**](DomainEdgeSoftwareVersionDtoEntityListing.html) get_telephony_providers_edge_softwareversions(edge_id)
|
|
1975
2155
|
|
|
2156
|
+
|
|
2157
|
+
|
|
1976
2158
|
Gets all the available software versions for this edge.
|
|
1977
2159
|
|
|
1978
2160
|
|
|
1979
2161
|
|
|
1980
2162
|
Wraps GET /api/v2/telephony/providers/edges/{edgeId}/softwareversions
|
|
1981
2163
|
|
|
2164
|
+
Requires NO permissions:
|
|
2165
|
+
|
|
2166
|
+
|
|
2167
|
+
|
|
1982
2168
|
|
|
1983
2169
|
### Example
|
|
1984
2170
|
~~~ruby
|
|
@@ -2032,12 +2218,18 @@ Name | Type | Description | Notes
|
|
|
2032
2218
|
|
|
2033
2219
|
## -[**TrunkEntityListing**](TrunkEntityListing.html) get_telephony_providers_edge_trunks(edge_id, opts)
|
|
2034
2220
|
|
|
2221
|
+
|
|
2222
|
+
|
|
2035
2223
|
Get the list of available trunks for the given Edge.
|
|
2036
2224
|
|
|
2037
2225
|
Trunks are created by assigning trunk base settings to an Edge or Edge Group.
|
|
2038
2226
|
|
|
2039
2227
|
Wraps GET /api/v2/telephony/providers/edges/{edgeId}/trunks
|
|
2040
2228
|
|
|
2229
|
+
Requires ANY permissions:
|
|
2230
|
+
|
|
2231
|
+
* telephony:plugin:all
|
|
2232
|
+
|
|
2041
2233
|
|
|
2042
2234
|
### Example
|
|
2043
2235
|
~~~ruby
|
|
@@ -2105,12 +2297,18 @@ Name | Type | Description | Notes
|
|
|
2105
2297
|
|
|
2106
2298
|
## -[**EdgeEntityListing**](EdgeEntityListing.html) get_telephony_providers_edges(opts)
|
|
2107
2299
|
|
|
2300
|
+
|
|
2301
|
+
|
|
2108
2302
|
Get the list of edges.
|
|
2109
2303
|
|
|
2110
2304
|
|
|
2111
2305
|
|
|
2112
2306
|
Wraps GET /api/v2/telephony/providers/edges
|
|
2113
2307
|
|
|
2308
|
+
Requires ANY permissions:
|
|
2309
|
+
|
|
2310
|
+
* telephony:plugin:all
|
|
2311
|
+
|
|
2114
2312
|
|
|
2115
2313
|
### Example
|
|
2116
2314
|
~~~ruby
|
|
@@ -2177,12 +2375,18 @@ Name | Type | Description | Notes
|
|
|
2177
2375
|
|
|
2178
2376
|
## -[**AvailableLanguageList**](AvailableLanguageList.html) get_telephony_providers_edges_availablelanguages
|
|
2179
2377
|
|
|
2378
|
+
|
|
2379
|
+
|
|
2180
2380
|
Get the list of available languages.
|
|
2181
2381
|
|
|
2182
2382
|
|
|
2183
2383
|
|
|
2184
2384
|
Wraps GET /api/v2/telephony/providers/edges/availablelanguages
|
|
2185
2385
|
|
|
2386
|
+
Requires NO permissions:
|
|
2387
|
+
|
|
2388
|
+
|
|
2389
|
+
|
|
2186
2390
|
|
|
2187
2391
|
### Example
|
|
2188
2392
|
~~~ruby
|
|
@@ -2230,12 +2434,18 @@ This endpoint does not need any parameter.
|
|
|
2230
2434
|
|
|
2231
2435
|
## -[**CertificateAuthorityEntityListing**](CertificateAuthorityEntityListing.html) get_telephony_providers_edges_certificateauthorities
|
|
2232
2436
|
|
|
2437
|
+
|
|
2438
|
+
|
|
2233
2439
|
Get the list of certificate authorities.
|
|
2234
2440
|
|
|
2235
2441
|
|
|
2236
2442
|
|
|
2237
2443
|
Wraps GET /api/v2/telephony/providers/edges/certificateauthorities
|
|
2238
2444
|
|
|
2445
|
+
Requires ANY permissions:
|
|
2446
|
+
|
|
2447
|
+
* telephony:plugin:all
|
|
2448
|
+
|
|
2239
2449
|
|
|
2240
2450
|
### Example
|
|
2241
2451
|
~~~ruby
|
|
@@ -2283,12 +2493,18 @@ This endpoint does not need any parameter.
|
|
|
2283
2493
|
|
|
2284
2494
|
## -[**DomainCertificateAuthority**](DomainCertificateAuthority.html) get_telephony_providers_edges_certificateauthority(certificate_id)
|
|
2285
2495
|
|
|
2496
|
+
|
|
2497
|
+
|
|
2286
2498
|
Get a certificate authority.
|
|
2287
2499
|
|
|
2288
2500
|
|
|
2289
2501
|
|
|
2290
2502
|
Wraps GET /api/v2/telephony/providers/edges/certificateauthorities/{certificateId}
|
|
2291
2503
|
|
|
2504
|
+
Requires ANY permissions:
|
|
2505
|
+
|
|
2506
|
+
* telephony:plugin:all
|
|
2507
|
+
|
|
2292
2508
|
|
|
2293
2509
|
### Example
|
|
2294
2510
|
~~~ruby
|
|
@@ -2342,12 +2558,18 @@ Name | Type | Description | Notes
|
|
|
2342
2558
|
|
|
2343
2559
|
## -[**DID**](DID.html) get_telephony_providers_edges_did(did_id)
|
|
2344
2560
|
|
|
2561
|
+
|
|
2562
|
+
|
|
2345
2563
|
Get a DID by ID.
|
|
2346
2564
|
|
|
2347
2565
|
|
|
2348
2566
|
|
|
2349
2567
|
Wraps GET /api/v2/telephony/providers/edges/dids/{didId}
|
|
2350
2568
|
|
|
2569
|
+
Requires ANY permissions:
|
|
2570
|
+
|
|
2571
|
+
* telephony:plugin:all
|
|
2572
|
+
|
|
2351
2573
|
|
|
2352
2574
|
### Example
|
|
2353
2575
|
~~~ruby
|
|
@@ -2401,12 +2623,18 @@ Name | Type | Description | Notes
|
|
|
2401
2623
|
|
|
2402
2624
|
## -[**DIDPool**](DIDPool.html) get_telephony_providers_edges_didpool(did_pool_id)
|
|
2403
2625
|
|
|
2626
|
+
|
|
2627
|
+
|
|
2404
2628
|
Get a DID Pool by ID.
|
|
2405
2629
|
|
|
2406
2630
|
|
|
2407
2631
|
|
|
2408
2632
|
Wraps GET /api/v2/telephony/providers/edges/didpools/{didPoolId}
|
|
2409
2633
|
|
|
2634
|
+
Requires ANY permissions:
|
|
2635
|
+
|
|
2636
|
+
* telephony:plugin:all
|
|
2637
|
+
|
|
2410
2638
|
|
|
2411
2639
|
### Example
|
|
2412
2640
|
~~~ruby
|
|
@@ -2460,12 +2688,18 @@ Name | Type | Description | Notes
|
|
|
2460
2688
|
|
|
2461
2689
|
## -[**DIDPoolEntityListing**](DIDPoolEntityListing.html) get_telephony_providers_edges_didpools(opts)
|
|
2462
2690
|
|
|
2691
|
+
|
|
2692
|
+
|
|
2463
2693
|
Get a listing of DID Pools
|
|
2464
2694
|
|
|
2465
2695
|
|
|
2466
2696
|
|
|
2467
2697
|
Wraps GET /api/v2/telephony/providers/edges/didpools
|
|
2468
2698
|
|
|
2699
|
+
Requires ANY permissions:
|
|
2700
|
+
|
|
2701
|
+
* telephony:plugin:all
|
|
2702
|
+
|
|
2469
2703
|
|
|
2470
2704
|
### Example
|
|
2471
2705
|
~~~ruby
|
|
@@ -2524,12 +2758,18 @@ Name | Type | Description | Notes
|
|
|
2524
2758
|
|
|
2525
2759
|
## -[**DIDEntityListing**](DIDEntityListing.html) get_telephony_providers_edges_dids(opts)
|
|
2526
2760
|
|
|
2761
|
+
|
|
2762
|
+
|
|
2527
2763
|
Get a listing of DIDs
|
|
2528
2764
|
|
|
2529
2765
|
|
|
2530
2766
|
|
|
2531
2767
|
Wraps GET /api/v2/telephony/providers/edges/dids
|
|
2532
2768
|
|
|
2769
|
+
Requires ANY permissions:
|
|
2770
|
+
|
|
2771
|
+
* telephony:plugin:all
|
|
2772
|
+
|
|
2533
2773
|
|
|
2534
2774
|
### Example
|
|
2535
2775
|
~~~ruby
|
|
@@ -2592,12 +2832,18 @@ Name | Type | Description | Notes
|
|
|
2592
2832
|
|
|
2593
2833
|
## -[**EdgeGroup**](EdgeGroup.html) get_telephony_providers_edges_edgegroup(edge_group_id, opts)
|
|
2594
2834
|
|
|
2835
|
+
|
|
2836
|
+
|
|
2595
2837
|
Get edge group.
|
|
2596
2838
|
|
|
2597
2839
|
|
|
2598
2840
|
|
|
2599
2841
|
Wraps GET /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}
|
|
2600
2842
|
|
|
2843
|
+
Requires ANY permissions:
|
|
2844
|
+
|
|
2845
|
+
* telephony:plugin:all
|
|
2846
|
+
|
|
2601
2847
|
|
|
2602
2848
|
### Example
|
|
2603
2849
|
~~~ruby
|
|
@@ -2655,12 +2901,18 @@ Name | Type | Description | Notes
|
|
|
2655
2901
|
|
|
2656
2902
|
## -[**EdgeTrunkBase**](EdgeTrunkBase.html) get_telephony_providers_edges_edgegroup_edgetrunkbase(edgegroup_id, edgetrunkbase_id)
|
|
2657
2903
|
|
|
2904
|
+
|
|
2905
|
+
|
|
2658
2906
|
Gets the edge trunk base associated with the edge group
|
|
2659
2907
|
|
|
2660
2908
|
|
|
2661
2909
|
|
|
2662
2910
|
Wraps GET /api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}
|
|
2663
2911
|
|
|
2912
|
+
Requires ANY permissions:
|
|
2913
|
+
|
|
2914
|
+
* telephony:plugin:all
|
|
2915
|
+
|
|
2664
2916
|
|
|
2665
2917
|
### Example
|
|
2666
2918
|
~~~ruby
|
|
@@ -2717,12 +2969,18 @@ Name | Type | Description | Notes
|
|
|
2717
2969
|
|
|
2718
2970
|
## -[**EdgeGroupEntityListing**](EdgeGroupEntityListing.html) get_telephony_providers_edges_edgegroups(opts)
|
|
2719
2971
|
|
|
2972
|
+
|
|
2973
|
+
|
|
2720
2974
|
Get the list of edge groups.
|
|
2721
2975
|
|
|
2722
2976
|
|
|
2723
2977
|
|
|
2724
2978
|
Wraps GET /api/v2/telephony/providers/edges/edgegroups
|
|
2725
2979
|
|
|
2980
|
+
Requires ANY permissions:
|
|
2981
|
+
|
|
2982
|
+
* telephony:plugin:all
|
|
2983
|
+
|
|
2726
2984
|
|
|
2727
2985
|
### Example
|
|
2728
2986
|
~~~ruby
|
|
@@ -2785,12 +3043,18 @@ Name | Type | Description | Notes
|
|
|
2785
3043
|
|
|
2786
3044
|
## -[**EdgeVersionReport**](EdgeVersionReport.html) get_telephony_providers_edges_edgeversionreport
|
|
2787
3045
|
|
|
3046
|
+
|
|
3047
|
+
|
|
2788
3048
|
Get the edge version report.
|
|
2789
3049
|
|
|
2790
3050
|
The report will not have consistent data about the edge version(s) until all edges have been reset.
|
|
2791
3051
|
|
|
2792
3052
|
Wraps GET /api/v2/telephony/providers/edges/edgeversionreport
|
|
2793
3053
|
|
|
3054
|
+
Requires NO permissions:
|
|
3055
|
+
|
|
3056
|
+
|
|
3057
|
+
|
|
2794
3058
|
|
|
2795
3059
|
### Example
|
|
2796
3060
|
~~~ruby
|
|
@@ -2838,12 +3102,18 @@ This endpoint does not need any parameter.
|
|
|
2838
3102
|
|
|
2839
3103
|
## -[**Endpoint**](Endpoint.html) get_telephony_providers_edges_endpoint(endpoint_id)
|
|
2840
3104
|
|
|
3105
|
+
|
|
3106
|
+
|
|
2841
3107
|
Get endpoint
|
|
2842
3108
|
|
|
2843
3109
|
|
|
2844
3110
|
|
|
2845
3111
|
Wraps GET /api/v2/telephony/providers/edges/endpoints/{endpointId}
|
|
2846
3112
|
|
|
3113
|
+
Requires ANY permissions:
|
|
3114
|
+
|
|
3115
|
+
* telephony:plugin:all
|
|
3116
|
+
|
|
2847
3117
|
|
|
2848
3118
|
### Example
|
|
2849
3119
|
~~~ruby
|
|
@@ -2897,12 +3167,18 @@ Name | Type | Description | Notes
|
|
|
2897
3167
|
|
|
2898
3168
|
## -[**EndpointEntityListing**](EndpointEntityListing.html) get_telephony_providers_edges_endpoints(opts)
|
|
2899
3169
|
|
|
3170
|
+
|
|
3171
|
+
|
|
2900
3172
|
Get endpoints
|
|
2901
3173
|
|
|
2902
3174
|
|
|
2903
3175
|
|
|
2904
3176
|
Wraps GET /api/v2/telephony/providers/edges/endpoints
|
|
2905
3177
|
|
|
3178
|
+
Requires ANY permissions:
|
|
3179
|
+
|
|
3180
|
+
* telephony:plugin:all
|
|
3181
|
+
|
|
2906
3182
|
|
|
2907
3183
|
### Example
|
|
2908
3184
|
~~~ruby
|
|
@@ -2963,12 +3239,18 @@ Name | Type | Description | Notes
|
|
|
2963
3239
|
|
|
2964
3240
|
## -[**Extension**](Extension.html) get_telephony_providers_edges_extension(extension_id)
|
|
2965
3241
|
|
|
3242
|
+
|
|
3243
|
+
|
|
2966
3244
|
Get an extension by ID.
|
|
2967
3245
|
|
|
2968
3246
|
|
|
2969
3247
|
|
|
2970
3248
|
Wraps GET /api/v2/telephony/providers/edges/extensions/{extensionId}
|
|
2971
3249
|
|
|
3250
|
+
Requires ANY permissions:
|
|
3251
|
+
|
|
3252
|
+
* telephony:plugin:all
|
|
3253
|
+
|
|
2972
3254
|
|
|
2973
3255
|
### Example
|
|
2974
3256
|
~~~ruby
|
|
@@ -3022,12 +3304,18 @@ Name | Type | Description | Notes
|
|
|
3022
3304
|
|
|
3023
3305
|
## -[**ExtensionPool**](ExtensionPool.html) get_telephony_providers_edges_extensionpool(extension_pool_id)
|
|
3024
3306
|
|
|
3307
|
+
|
|
3308
|
+
|
|
3025
3309
|
Get an extension pool by ID
|
|
3026
3310
|
|
|
3027
3311
|
|
|
3028
3312
|
|
|
3029
3313
|
Wraps GET /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}
|
|
3030
3314
|
|
|
3315
|
+
Requires ANY permissions:
|
|
3316
|
+
|
|
3317
|
+
* telephony:plugin:all
|
|
3318
|
+
|
|
3031
3319
|
|
|
3032
3320
|
### Example
|
|
3033
3321
|
~~~ruby
|
|
@@ -3081,12 +3369,18 @@ Name | Type | Description | Notes
|
|
|
3081
3369
|
|
|
3082
3370
|
## -[**ExtensionPoolEntityListing**](ExtensionPoolEntityListing.html) get_telephony_providers_edges_extensionpools(opts)
|
|
3083
3371
|
|
|
3372
|
+
|
|
3373
|
+
|
|
3084
3374
|
Get a listing of extension pools
|
|
3085
3375
|
|
|
3086
3376
|
|
|
3087
3377
|
|
|
3088
3378
|
Wraps GET /api/v2/telephony/providers/edges/extensionpools
|
|
3089
3379
|
|
|
3380
|
+
Requires ANY permissions:
|
|
3381
|
+
|
|
3382
|
+
* telephony:plugin:all
|
|
3383
|
+
|
|
3090
3384
|
|
|
3091
3385
|
### Example
|
|
3092
3386
|
~~~ruby
|
|
@@ -3147,12 +3441,18 @@ Name | Type | Description | Notes
|
|
|
3147
3441
|
|
|
3148
3442
|
## -[**ExtensionEntityListing**](ExtensionEntityListing.html) get_telephony_providers_edges_extensions(opts)
|
|
3149
3443
|
|
|
3444
|
+
|
|
3445
|
+
|
|
3150
3446
|
Get a listing of extensions
|
|
3151
3447
|
|
|
3152
3448
|
|
|
3153
3449
|
|
|
3154
3450
|
Wraps GET /api/v2/telephony/providers/edges/extensions
|
|
3155
3451
|
|
|
3452
|
+
Requires ANY permissions:
|
|
3453
|
+
|
|
3454
|
+
* telephony:plugin:all
|
|
3455
|
+
|
|
3156
3456
|
|
|
3157
3457
|
### Example
|
|
3158
3458
|
~~~ruby
|
|
@@ -3215,12 +3515,18 @@ Name | Type | Description | Notes
|
|
|
3215
3515
|
|
|
3216
3516
|
## -[**Line**](Line.html) get_telephony_providers_edges_line(line_id)
|
|
3217
3517
|
|
|
3518
|
+
|
|
3519
|
+
|
|
3218
3520
|
Get a Line by ID
|
|
3219
3521
|
|
|
3220
3522
|
|
|
3221
3523
|
|
|
3222
3524
|
Wraps GET /api/v2/telephony/providers/edges/lines/{lineId}
|
|
3223
3525
|
|
|
3526
|
+
Requires ANY permissions:
|
|
3527
|
+
|
|
3528
|
+
* telephony:plugin:all
|
|
3529
|
+
|
|
3224
3530
|
|
|
3225
3531
|
### Example
|
|
3226
3532
|
~~~ruby
|
|
@@ -3274,12 +3580,18 @@ Name | Type | Description | Notes
|
|
|
3274
3580
|
|
|
3275
3581
|
## -[**LineBase**](LineBase.html) get_telephony_providers_edges_linebasesetting(line_base_id)
|
|
3276
3582
|
|
|
3583
|
+
|
|
3584
|
+
|
|
3277
3585
|
Get a line base settings object by ID
|
|
3278
3586
|
|
|
3279
3587
|
|
|
3280
3588
|
|
|
3281
3589
|
Wraps GET /api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}
|
|
3282
3590
|
|
|
3591
|
+
Requires ANY permissions:
|
|
3592
|
+
|
|
3593
|
+
* telephony:plugin:all
|
|
3594
|
+
|
|
3283
3595
|
|
|
3284
3596
|
### Example
|
|
3285
3597
|
~~~ruby
|
|
@@ -3333,12 +3645,18 @@ Name | Type | Description | Notes
|
|
|
3333
3645
|
|
|
3334
3646
|
## -[**LineBaseEntityListing**](LineBaseEntityListing.html) get_telephony_providers_edges_linebasesettings(opts)
|
|
3335
3647
|
|
|
3648
|
+
|
|
3649
|
+
|
|
3336
3650
|
Get a listing of line base settings objects
|
|
3337
3651
|
|
|
3338
3652
|
|
|
3339
3653
|
|
|
3340
3654
|
Wraps GET /api/v2/telephony/providers/edges/linebasesettings
|
|
3341
3655
|
|
|
3656
|
+
Requires ANY permissions:
|
|
3657
|
+
|
|
3658
|
+
* telephony:plugin:all
|
|
3659
|
+
|
|
3342
3660
|
|
|
3343
3661
|
### Example
|
|
3344
3662
|
~~~ruby
|
|
@@ -3399,12 +3717,18 @@ Name | Type | Description | Notes
|
|
|
3399
3717
|
|
|
3400
3718
|
## -[**LineEntityListing**](LineEntityListing.html) get_telephony_providers_edges_lines(opts)
|
|
3401
3719
|
|
|
3720
|
+
|
|
3721
|
+
|
|
3402
3722
|
Get a list of Lines
|
|
3403
3723
|
|
|
3404
3724
|
|
|
3405
3725
|
|
|
3406
3726
|
Wraps GET /api/v2/telephony/providers/edges/lines
|
|
3407
3727
|
|
|
3728
|
+
Requires ANY permissions:
|
|
3729
|
+
|
|
3730
|
+
* telephony:plugin:all
|
|
3731
|
+
|
|
3408
3732
|
|
|
3409
3733
|
### Example
|
|
3410
3734
|
~~~ruby
|
|
@@ -3467,12 +3791,18 @@ Name | Type | Description | Notes
|
|
|
3467
3791
|
|
|
3468
3792
|
## -[**Line**](Line.html) get_telephony_providers_edges_lines_template(line_base_settings_id)
|
|
3469
3793
|
|
|
3794
|
+
|
|
3795
|
+
|
|
3470
3796
|
Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance
|
|
3471
3797
|
|
|
3472
3798
|
|
|
3473
3799
|
|
|
3474
3800
|
Wraps GET /api/v2/telephony/providers/edges/lines/template
|
|
3475
3801
|
|
|
3802
|
+
Requires ANY permissions:
|
|
3803
|
+
|
|
3804
|
+
* telephony:plugin:all
|
|
3805
|
+
|
|
3476
3806
|
|
|
3477
3807
|
### Example
|
|
3478
3808
|
~~~ruby
|
|
@@ -3526,12 +3856,18 @@ Name | Type | Description | Notes
|
|
|
3526
3856
|
|
|
3527
3857
|
## -[**LogicalInterfaceEntityListing**](LogicalInterfaceEntityListing.html) get_telephony_providers_edges_logicalinterfaces(edge_ids, opts)
|
|
3528
3858
|
|
|
3859
|
+
|
|
3860
|
+
|
|
3529
3861
|
Get edge logical interfaces.
|
|
3530
3862
|
|
|
3531
3863
|
Retrieve the configured logical interfaces for a list edges. Only 100 edges can be requested at a time.
|
|
3532
3864
|
|
|
3533
3865
|
Wraps GET /api/v2/telephony/providers/edges/logicalinterfaces
|
|
3534
3866
|
|
|
3867
|
+
Requires ANY permissions:
|
|
3868
|
+
|
|
3869
|
+
* telephony:plugin:all
|
|
3870
|
+
|
|
3535
3871
|
|
|
3536
3872
|
### Example
|
|
3537
3873
|
~~~ruby
|
|
@@ -3589,12 +3925,18 @@ Name | Type | Description | Notes
|
|
|
3589
3925
|
|
|
3590
3926
|
## -[**Array<EdgeMetrics>**](EdgeMetrics.html) get_telephony_providers_edges_metrics(edge_ids)
|
|
3591
3927
|
|
|
3928
|
+
|
|
3929
|
+
|
|
3592
3930
|
Get the metrics for a list of edges.
|
|
3593
3931
|
|
|
3594
3932
|
|
|
3595
3933
|
|
|
3596
3934
|
Wraps GET /api/v2/telephony/providers/edges/metrics
|
|
3597
3935
|
|
|
3936
|
+
Requires ANY permissions:
|
|
3937
|
+
|
|
3938
|
+
* telephony:plugin:all
|
|
3939
|
+
|
|
3598
3940
|
|
|
3599
3941
|
### Example
|
|
3600
3942
|
~~~ruby
|
|
@@ -3648,12 +3990,18 @@ Name | Type | Description | Notes
|
|
|
3648
3990
|
|
|
3649
3991
|
## -[**OutboundRoute**](OutboundRoute.html) get_telephony_providers_edges_outboundroute(outbound_route_id)
|
|
3650
3992
|
|
|
3993
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
3994
|
+
|
|
3651
3995
|
Get outbound route
|
|
3652
3996
|
|
|
3653
3997
|
|
|
3654
3998
|
|
|
3655
3999
|
Wraps GET /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}
|
|
3656
4000
|
|
|
4001
|
+
Requires ANY permissions:
|
|
4002
|
+
|
|
4003
|
+
* telephony:plugin:all
|
|
4004
|
+
|
|
3657
4005
|
|
|
3658
4006
|
### Example
|
|
3659
4007
|
~~~ruby
|
|
@@ -3707,12 +4055,18 @@ Name | Type | Description | Notes
|
|
|
3707
4055
|
|
|
3708
4056
|
## -[**OutboundRouteEntityListing**](OutboundRouteEntityListing.html) get_telephony_providers_edges_outboundroutes(opts)
|
|
3709
4057
|
|
|
4058
|
+
|
|
4059
|
+
|
|
3710
4060
|
Get outbound routes
|
|
3711
4061
|
|
|
3712
4062
|
|
|
3713
4063
|
|
|
3714
4064
|
Wraps GET /api/v2/telephony/providers/edges/outboundroutes
|
|
3715
4065
|
|
|
4066
|
+
Requires ANY permissions:
|
|
4067
|
+
|
|
4068
|
+
* telephony:plugin:all
|
|
4069
|
+
|
|
3716
4070
|
|
|
3717
4071
|
### Example
|
|
3718
4072
|
~~~ruby
|
|
@@ -3775,12 +4129,18 @@ Name | Type | Description | Notes
|
|
|
3775
4129
|
|
|
3776
4130
|
## -[**Phone**](Phone.html) get_telephony_providers_edges_phone(phone_id)
|
|
3777
4131
|
|
|
4132
|
+
|
|
4133
|
+
|
|
3778
4134
|
Get a Phone by ID
|
|
3779
4135
|
|
|
3780
4136
|
|
|
3781
4137
|
|
|
3782
4138
|
Wraps GET /api/v2/telephony/providers/edges/phones/{phoneId}
|
|
3783
4139
|
|
|
4140
|
+
Requires ANY permissions:
|
|
4141
|
+
|
|
4142
|
+
* telephony:plugin:all
|
|
4143
|
+
|
|
3784
4144
|
|
|
3785
4145
|
### Example
|
|
3786
4146
|
~~~ruby
|
|
@@ -3834,12 +4194,18 @@ Name | Type | Description | Notes
|
|
|
3834
4194
|
|
|
3835
4195
|
## -[**PhoneBase**](PhoneBase.html) get_telephony_providers_edges_phonebasesetting(phone_base_id)
|
|
3836
4196
|
|
|
4197
|
+
|
|
4198
|
+
|
|
3837
4199
|
Get a Phone Base Settings object by ID
|
|
3838
4200
|
|
|
3839
4201
|
|
|
3840
4202
|
|
|
3841
4203
|
Wraps GET /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}
|
|
3842
4204
|
|
|
4205
|
+
Requires ANY permissions:
|
|
4206
|
+
|
|
4207
|
+
* telephony:plugin:all
|
|
4208
|
+
|
|
3843
4209
|
|
|
3844
4210
|
### Example
|
|
3845
4211
|
~~~ruby
|
|
@@ -3893,12 +4259,18 @@ Name | Type | Description | Notes
|
|
|
3893
4259
|
|
|
3894
4260
|
## -[**PhoneBaseEntityListing**](PhoneBaseEntityListing.html) get_telephony_providers_edges_phonebasesettings(opts)
|
|
3895
4261
|
|
|
4262
|
+
|
|
4263
|
+
|
|
3896
4264
|
Get a list of Phone Base Settings objects
|
|
3897
4265
|
|
|
3898
4266
|
|
|
3899
4267
|
|
|
3900
4268
|
Wraps GET /api/v2/telephony/providers/edges/phonebasesettings
|
|
3901
4269
|
|
|
4270
|
+
Requires ANY permissions:
|
|
4271
|
+
|
|
4272
|
+
* telephony:plugin:all
|
|
4273
|
+
|
|
3902
4274
|
|
|
3903
4275
|
### Example
|
|
3904
4276
|
~~~ruby
|
|
@@ -3963,12 +4335,18 @@ Name | Type | Description | Notes
|
|
|
3963
4335
|
|
|
3964
4336
|
## -[**PhoneMetaBaseEntityListing**](PhoneMetaBaseEntityListing.html) get_telephony_providers_edges_phonebasesettings_availablemetabases(opts)
|
|
3965
4337
|
|
|
4338
|
+
|
|
4339
|
+
|
|
3966
4340
|
Get a list of available makes and models to create a new Phone Base Settings
|
|
3967
4341
|
|
|
3968
4342
|
|
|
3969
4343
|
|
|
3970
4344
|
Wraps GET /api/v2/telephony/providers/edges/phonebasesettings/availablemetabases
|
|
3971
4345
|
|
|
4346
|
+
Requires ANY permissions:
|
|
4347
|
+
|
|
4348
|
+
* telephony:plugin:all
|
|
4349
|
+
|
|
3972
4350
|
|
|
3973
4351
|
### Example
|
|
3974
4352
|
~~~ruby
|
|
@@ -4025,12 +4403,18 @@ Name | Type | Description | Notes
|
|
|
4025
4403
|
|
|
4026
4404
|
## -[**PhoneBase**](PhoneBase.html) get_telephony_providers_edges_phonebasesettings_template(phone_metabase_id)
|
|
4027
4405
|
|
|
4406
|
+
|
|
4407
|
+
|
|
4028
4408
|
Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance
|
|
4029
4409
|
|
|
4030
4410
|
|
|
4031
4411
|
|
|
4032
4412
|
Wraps GET /api/v2/telephony/providers/edges/phonebasesettings/template
|
|
4033
4413
|
|
|
4414
|
+
Requires ANY permissions:
|
|
4415
|
+
|
|
4416
|
+
* telephony:plugin:all
|
|
4417
|
+
|
|
4034
4418
|
|
|
4035
4419
|
### Example
|
|
4036
4420
|
~~~ruby
|
|
@@ -4084,12 +4468,18 @@ Name | Type | Description | Notes
|
|
|
4084
4468
|
|
|
4085
4469
|
## -[**PhoneEntityListing**](PhoneEntityListing.html) get_telephony_providers_edges_phones(opts)
|
|
4086
4470
|
|
|
4471
|
+
|
|
4472
|
+
|
|
4087
4473
|
Get a list of Phone Instances
|
|
4088
4474
|
|
|
4089
4475
|
|
|
4090
4476
|
|
|
4091
4477
|
Wraps GET /api/v2/telephony/providers/edges/phones
|
|
4092
4478
|
|
|
4479
|
+
Requires ANY permissions:
|
|
4480
|
+
|
|
4481
|
+
* telephony:plugin:all
|
|
4482
|
+
|
|
4093
4483
|
|
|
4094
4484
|
### Example
|
|
4095
4485
|
~~~ruby
|
|
@@ -4170,12 +4560,18 @@ Name | Type | Description | Notes
|
|
|
4170
4560
|
|
|
4171
4561
|
## -[**Phone**](Phone.html) get_telephony_providers_edges_phones_template(phone_base_settings_id)
|
|
4172
4562
|
|
|
4563
|
+
|
|
4564
|
+
|
|
4173
4565
|
Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance
|
|
4174
4566
|
|
|
4175
4567
|
|
|
4176
4568
|
|
|
4177
4569
|
Wraps GET /api/v2/telephony/providers/edges/phones/template
|
|
4178
4570
|
|
|
4571
|
+
Requires ANY permissions:
|
|
4572
|
+
|
|
4573
|
+
* telephony:plugin:all
|
|
4574
|
+
|
|
4179
4575
|
|
|
4180
4576
|
### Example
|
|
4181
4577
|
~~~ruby
|
|
@@ -4229,12 +4625,18 @@ Name | Type | Description | Notes
|
|
|
4229
4625
|
|
|
4230
4626
|
## -[**PhysicalInterfaceEntityListing**](PhysicalInterfaceEntityListing.html) get_telephony_providers_edges_physicalinterfaces(edge_ids)
|
|
4231
4627
|
|
|
4628
|
+
|
|
4629
|
+
|
|
4232
4630
|
Get physical interfaces for edges.
|
|
4233
4631
|
|
|
4234
4632
|
Retrieves a list of all configured physical interfaces for a list of edges. Only 100 edges can be requested at a time.
|
|
4235
4633
|
|
|
4236
4634
|
Wraps GET /api/v2/telephony/providers/edges/physicalinterfaces
|
|
4237
4635
|
|
|
4636
|
+
Requires ANY permissions:
|
|
4637
|
+
|
|
4638
|
+
* telephony:plugin:all
|
|
4639
|
+
|
|
4238
4640
|
|
|
4239
4641
|
### Example
|
|
4240
4642
|
~~~ruby
|
|
@@ -4288,12 +4690,18 @@ Name | Type | Description | Notes
|
|
|
4288
4690
|
|
|
4289
4691
|
## -[**Site**](Site.html) get_telephony_providers_edges_site(site_id)
|
|
4290
4692
|
|
|
4693
|
+
|
|
4694
|
+
|
|
4291
4695
|
Get a Site by ID.
|
|
4292
4696
|
|
|
4293
4697
|
|
|
4294
4698
|
|
|
4295
4699
|
Wraps GET /api/v2/telephony/providers/edges/sites/{siteId}
|
|
4296
4700
|
|
|
4701
|
+
Requires ANY permissions:
|
|
4702
|
+
|
|
4703
|
+
* telephony:plugin:all* telephony:sites:view
|
|
4704
|
+
|
|
4297
4705
|
|
|
4298
4706
|
### Example
|
|
4299
4707
|
~~~ruby
|
|
@@ -4347,12 +4755,18 @@ Name | Type | Description | Notes
|
|
|
4347
4755
|
|
|
4348
4756
|
## -[**AsgInfoResponse**](AsgInfoResponse.html) get_telephony_providers_edges_site_autoscalinggroups(site_id)
|
|
4349
4757
|
|
|
4758
|
+
|
|
4759
|
+
|
|
4350
4760
|
Gets the basic information about an asg in a specified site
|
|
4351
4761
|
|
|
4352
4762
|
|
|
4353
4763
|
|
|
4354
4764
|
Wraps GET /api/v2/telephony/providers/edges/sites/{siteId}/autoscalinggroups
|
|
4355
4765
|
|
|
4766
|
+
Requires ANY permissions:
|
|
4767
|
+
|
|
4768
|
+
* managed:all:all
|
|
4769
|
+
|
|
4356
4770
|
|
|
4357
4771
|
### Example
|
|
4358
4772
|
~~~ruby
|
|
@@ -4406,12 +4820,18 @@ Name | Type | Description | Notes
|
|
|
4406
4820
|
|
|
4407
4821
|
## -[**NumberPlan**](NumberPlan.html) get_telephony_providers_edges_site_numberplan(site_id, number_plan_id)
|
|
4408
4822
|
|
|
4823
|
+
|
|
4824
|
+
|
|
4409
4825
|
Get a Number Plan by ID.
|
|
4410
4826
|
|
|
4411
4827
|
|
|
4412
4828
|
|
|
4413
4829
|
Wraps GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}
|
|
4414
4830
|
|
|
4831
|
+
Requires ANY permissions:
|
|
4832
|
+
|
|
4833
|
+
* telephony:plugin:all
|
|
4834
|
+
|
|
4415
4835
|
|
|
4416
4836
|
### Example
|
|
4417
4837
|
~~~ruby
|
|
@@ -4468,12 +4888,18 @@ Name | Type | Description | Notes
|
|
|
4468
4888
|
|
|
4469
4889
|
## -[**Array<NumberPlan>**](NumberPlan.html) get_telephony_providers_edges_site_numberplans(site_id)
|
|
4470
4890
|
|
|
4891
|
+
|
|
4892
|
+
|
|
4471
4893
|
Get the list of Number Plans for this Site.
|
|
4472
4894
|
|
|
4473
4895
|
|
|
4474
4896
|
|
|
4475
4897
|
Wraps GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans
|
|
4476
4898
|
|
|
4899
|
+
Requires ANY permissions:
|
|
4900
|
+
|
|
4901
|
+
* telephony:plugin:all
|
|
4902
|
+
|
|
4477
4903
|
|
|
4478
4904
|
### Example
|
|
4479
4905
|
~~~ruby
|
|
@@ -4527,12 +4953,18 @@ Name | Type | Description | Notes
|
|
|
4527
4953
|
|
|
4528
4954
|
## -Array<String>** get_telephony_providers_edges_site_numberplans_classifications(site_id, opts)
|
|
4529
4955
|
|
|
4956
|
+
|
|
4957
|
+
|
|
4530
4958
|
Get a list of Classifications for this Site
|
|
4531
4959
|
|
|
4532
4960
|
|
|
4533
4961
|
|
|
4534
4962
|
Wraps GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications
|
|
4535
4963
|
|
|
4964
|
+
Requires ANY permissions:
|
|
4965
|
+
|
|
4966
|
+
* telephony:plugin:all
|
|
4967
|
+
|
|
4536
4968
|
|
|
4537
4969
|
### Example
|
|
4538
4970
|
~~~ruby
|
|
@@ -4590,12 +5022,18 @@ Name | Type | Description | Notes
|
|
|
4590
5022
|
|
|
4591
5023
|
## -[**OutboundRouteBase**](OutboundRouteBase.html) get_telephony_providers_edges_site_outboundroute(site_id, outbound_route_id)
|
|
4592
5024
|
|
|
5025
|
+
|
|
5026
|
+
|
|
4593
5027
|
Get an outbound route
|
|
4594
5028
|
|
|
4595
5029
|
|
|
4596
5030
|
|
|
4597
5031
|
Wraps GET /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}
|
|
4598
5032
|
|
|
5033
|
+
Requires ANY permissions:
|
|
5034
|
+
|
|
5035
|
+
* telephony:plugin:all
|
|
5036
|
+
|
|
4599
5037
|
|
|
4600
5038
|
### Example
|
|
4601
5039
|
~~~ruby
|
|
@@ -4652,12 +5090,18 @@ Name | Type | Description | Notes
|
|
|
4652
5090
|
|
|
4653
5091
|
## -[**OutboundRouteBaseEntityListing**](OutboundRouteBaseEntityListing.html) get_telephony_providers_edges_site_outboundroutes(site_id, opts)
|
|
4654
5092
|
|
|
5093
|
+
|
|
5094
|
+
|
|
4655
5095
|
Get outbound routes
|
|
4656
5096
|
|
|
4657
5097
|
|
|
4658
5098
|
|
|
4659
5099
|
Wraps GET /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes
|
|
4660
5100
|
|
|
5101
|
+
Requires ANY permissions:
|
|
5102
|
+
|
|
5103
|
+
* telephony:plugin:all
|
|
5104
|
+
|
|
4661
5105
|
|
|
4662
5106
|
### Example
|
|
4663
5107
|
~~~ruby
|
|
@@ -4721,12 +5165,18 @@ Name | Type | Description | Notes
|
|
|
4721
5165
|
|
|
4722
5166
|
## -[**SiteEntityListing**](SiteEntityListing.html) get_telephony_providers_edges_sites(opts)
|
|
4723
5167
|
|
|
5168
|
+
|
|
5169
|
+
|
|
4724
5170
|
Get the list of Sites.
|
|
4725
5171
|
|
|
4726
5172
|
|
|
4727
5173
|
|
|
4728
5174
|
Wraps GET /api/v2/telephony/providers/edges/sites
|
|
4729
5175
|
|
|
5176
|
+
Requires NO permissions:
|
|
5177
|
+
|
|
5178
|
+
|
|
5179
|
+
|
|
4730
5180
|
|
|
4731
5181
|
### Example
|
|
4732
5182
|
~~~ruby
|
|
@@ -4793,12 +5243,18 @@ Name | Type | Description | Notes
|
|
|
4793
5243
|
|
|
4794
5244
|
## -[**TimeZoneEntityListing**](TimeZoneEntityListing.html) get_telephony_providers_edges_timezones(opts)
|
|
4795
5245
|
|
|
5246
|
+
|
|
5247
|
+
|
|
4796
5248
|
Get a list of Edge-compatible time zones
|
|
4797
5249
|
|
|
4798
5250
|
|
|
4799
5251
|
|
|
4800
5252
|
Wraps GET /api/v2/telephony/providers/edges/timezones
|
|
4801
5253
|
|
|
5254
|
+
Requires NO permissions:
|
|
5255
|
+
|
|
5256
|
+
|
|
5257
|
+
|
|
4802
5258
|
|
|
4803
5259
|
### Example
|
|
4804
5260
|
~~~ruby
|
|
@@ -4855,12 +5311,18 @@ Name | Type | Description | Notes
|
|
|
4855
5311
|
|
|
4856
5312
|
## -[**Trunk**](Trunk.html) get_telephony_providers_edges_trunk(trunk_id)
|
|
4857
5313
|
|
|
5314
|
+
|
|
5315
|
+
|
|
4858
5316
|
Get a Trunk by ID
|
|
4859
5317
|
|
|
4860
5318
|
|
|
4861
5319
|
|
|
4862
5320
|
Wraps GET /api/v2/telephony/providers/edges/trunks/{trunkId}
|
|
4863
5321
|
|
|
5322
|
+
Requires ANY permissions:
|
|
5323
|
+
|
|
5324
|
+
* telephony:plugin:all
|
|
5325
|
+
|
|
4864
5326
|
|
|
4865
5327
|
### Example
|
|
4866
5328
|
~~~ruby
|
|
@@ -4914,12 +5376,18 @@ Name | Type | Description | Notes
|
|
|
4914
5376
|
|
|
4915
5377
|
## -[**TrunkMetrics**](TrunkMetrics.html) get_telephony_providers_edges_trunk_metrics(trunk_id)
|
|
4916
5378
|
|
|
5379
|
+
|
|
5380
|
+
|
|
4917
5381
|
Get the trunk metrics.
|
|
4918
5382
|
|
|
4919
5383
|
|
|
4920
5384
|
|
|
4921
5385
|
Wraps GET /api/v2/telephony/providers/edges/trunks/{trunkId}/metrics
|
|
4922
5386
|
|
|
5387
|
+
Requires ANY permissions:
|
|
5388
|
+
|
|
5389
|
+
* telephony:plugin:all
|
|
5390
|
+
|
|
4923
5391
|
|
|
4924
5392
|
### Example
|
|
4925
5393
|
~~~ruby
|
|
@@ -4973,12 +5441,18 @@ Name | Type | Description | Notes
|
|
|
4973
5441
|
|
|
4974
5442
|
## -[**TrunkBase**](TrunkBase.html) get_telephony_providers_edges_trunkbasesetting(trunk_base_settings_id, opts)
|
|
4975
5443
|
|
|
5444
|
+
|
|
5445
|
+
|
|
4976
5446
|
Get a Trunk Base Settings object by ID
|
|
4977
5447
|
|
|
4978
5448
|
Managed properties will not be returned unless the user is assigned the managed:all:all permission.
|
|
4979
5449
|
|
|
4980
5450
|
Wraps GET /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}
|
|
4981
5451
|
|
|
5452
|
+
Requires ANY permissions:
|
|
5453
|
+
|
|
5454
|
+
* telephony:plugin:all
|
|
5455
|
+
|
|
4982
5456
|
|
|
4983
5457
|
### Example
|
|
4984
5458
|
~~~ruby
|
|
@@ -5036,12 +5510,18 @@ Name | Type | Description | Notes
|
|
|
5036
5510
|
|
|
5037
5511
|
## -[**TrunkBaseEntityListing**](TrunkBaseEntityListing.html) get_telephony_providers_edges_trunkbasesettings(opts)
|
|
5038
5512
|
|
|
5513
|
+
|
|
5514
|
+
|
|
5039
5515
|
Get Trunk Base Settings listing
|
|
5040
5516
|
|
|
5041
5517
|
Managed properties will not be returned unless the user is assigned the managed:all:all permission.
|
|
5042
5518
|
|
|
5043
5519
|
Wraps GET /api/v2/telephony/providers/edges/trunkbasesettings
|
|
5044
5520
|
|
|
5521
|
+
Requires ANY permissions:
|
|
5522
|
+
|
|
5523
|
+
* telephony:plugin:all
|
|
5524
|
+
|
|
5045
5525
|
|
|
5046
5526
|
### Example
|
|
5047
5527
|
~~~ruby
|
|
@@ -5112,12 +5592,18 @@ Name | Type | Description | Notes
|
|
|
5112
5592
|
|
|
5113
5593
|
## -[**TrunkMetabaseEntityListing**](TrunkMetabaseEntityListing.html) get_telephony_providers_edges_trunkbasesettings_availablemetabases(opts)
|
|
5114
5594
|
|
|
5595
|
+
|
|
5596
|
+
|
|
5115
5597
|
Get a list of available makes and models to create a new Trunk Base Settings
|
|
5116
5598
|
|
|
5117
5599
|
|
|
5118
5600
|
|
|
5119
5601
|
Wraps GET /api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases
|
|
5120
5602
|
|
|
5603
|
+
Requires ANY permissions:
|
|
5604
|
+
|
|
5605
|
+
* telephony:plugin:all
|
|
5606
|
+
|
|
5121
5607
|
|
|
5122
5608
|
### Example
|
|
5123
5609
|
~~~ruby
|
|
@@ -5176,12 +5662,18 @@ Name | Type | Description | Notes
|
|
|
5176
5662
|
|
|
5177
5663
|
## -[**TrunkBase**](TrunkBase.html) get_telephony_providers_edges_trunkbasesettings_template(trunk_metabase_id)
|
|
5178
5664
|
|
|
5665
|
+
|
|
5666
|
+
|
|
5179
5667
|
Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance
|
|
5180
5668
|
|
|
5181
5669
|
|
|
5182
5670
|
|
|
5183
5671
|
Wraps GET /api/v2/telephony/providers/edges/trunkbasesettings/template
|
|
5184
5672
|
|
|
5673
|
+
Requires ANY permissions:
|
|
5674
|
+
|
|
5675
|
+
* telephony:plugin:all
|
|
5676
|
+
|
|
5185
5677
|
|
|
5186
5678
|
### Example
|
|
5187
5679
|
~~~ruby
|
|
@@ -5235,12 +5727,18 @@ Name | Type | Description | Notes
|
|
|
5235
5727
|
|
|
5236
5728
|
## -[**TrunkEntityListing**](TrunkEntityListing.html) get_telephony_providers_edges_trunks(opts)
|
|
5237
5729
|
|
|
5730
|
+
|
|
5731
|
+
|
|
5238
5732
|
Get the list of available trunks.
|
|
5239
5733
|
|
|
5240
5734
|
Trunks are created by assigning trunk base settings to an Edge or Edge Group.
|
|
5241
5735
|
|
|
5242
5736
|
Wraps GET /api/v2/telephony/providers/edges/trunks
|
|
5243
5737
|
|
|
5738
|
+
Requires ANY permissions:
|
|
5739
|
+
|
|
5740
|
+
* telephony:plugin:all
|
|
5741
|
+
|
|
5244
5742
|
|
|
5245
5743
|
### Example
|
|
5246
5744
|
~~~ruby
|
|
@@ -5307,12 +5805,18 @@ Name | Type | Description | Notes
|
|
|
5307
5805
|
|
|
5308
5806
|
## -[**Array<TrunkMetrics>**](TrunkMetrics.html) get_telephony_providers_edges_trunks_metrics(trunk_ids)
|
|
5309
5807
|
|
|
5808
|
+
|
|
5809
|
+
|
|
5310
5810
|
Get the metrics for a list of trunks.
|
|
5311
5811
|
|
|
5312
5812
|
|
|
5313
5813
|
|
|
5314
5814
|
Wraps GET /api/v2/telephony/providers/edges/trunks/metrics
|
|
5315
5815
|
|
|
5816
|
+
Requires ANY permissions:
|
|
5817
|
+
|
|
5818
|
+
* telephony:plugin:all
|
|
5819
|
+
|
|
5316
5820
|
|
|
5317
5821
|
### Example
|
|
5318
5822
|
~~~ruby
|
|
@@ -5366,12 +5870,18 @@ Name | Type | Description | Notes
|
|
|
5366
5870
|
|
|
5367
5871
|
## -[**TrunkRecordingEnabledCount**](TrunkRecordingEnabledCount.html) get_telephony_providers_edges_trunkswithrecording(opts)
|
|
5368
5872
|
|
|
5873
|
+
|
|
5874
|
+
|
|
5369
5875
|
Get Counts of trunks that have recording disabled or enabled
|
|
5370
5876
|
|
|
5371
5877
|
|
|
5372
5878
|
|
|
5373
5879
|
Wraps GET /api/v2/telephony/providers/edges/trunkswithrecording
|
|
5374
5880
|
|
|
5881
|
+
Requires ANY permissions:
|
|
5882
|
+
|
|
5883
|
+
* recording:retentionPolicy:view* telephony:plugin:all
|
|
5884
|
+
|
|
5375
5885
|
|
|
5376
5886
|
### Example
|
|
5377
5887
|
~~~ruby
|
|
@@ -5426,12 +5936,18 @@ Name | Type | Description | Notes
|
|
|
5426
5936
|
|
|
5427
5937
|
## -[**DomainLogicalInterface**](DomainLogicalInterface.html) post_telephony_providers_edge_logicalinterfaces(edge_id, body)
|
|
5428
5938
|
|
|
5939
|
+
|
|
5940
|
+
|
|
5429
5941
|
Create an edge logical interface.
|
|
5430
5942
|
|
|
5431
5943
|
Create
|
|
5432
5944
|
|
|
5433
5945
|
Wraps POST /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces
|
|
5434
5946
|
|
|
5947
|
+
Requires ANY permissions:
|
|
5948
|
+
|
|
5949
|
+
* telephony:plugin:all
|
|
5950
|
+
|
|
5435
5951
|
|
|
5436
5952
|
### Example
|
|
5437
5953
|
~~~ruby
|
|
@@ -5488,12 +6004,18 @@ Name | Type | Description | Notes
|
|
|
5488
6004
|
|
|
5489
6005
|
## - post_telephony_providers_edge_logs_job_upload(edge_id, job_id, body)
|
|
5490
6006
|
|
|
6007
|
+
|
|
6008
|
+
|
|
5491
6009
|
Request that the specified fileIds be uploaded from the Edge.
|
|
5492
6010
|
|
|
5493
6011
|
|
|
5494
6012
|
|
|
5495
6013
|
Wraps POST /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload
|
|
5496
6014
|
|
|
6015
|
+
Requires ANY permissions:
|
|
6016
|
+
|
|
6017
|
+
* telephony:plugin:all
|
|
6018
|
+
|
|
5497
6019
|
|
|
5498
6020
|
### Example
|
|
5499
6021
|
~~~ruby
|
|
@@ -5552,12 +6074,18 @@ nil (empty response body)
|
|
|
5552
6074
|
|
|
5553
6075
|
## -[**EdgeLogsJobResponse**](EdgeLogsJobResponse.html) post_telephony_providers_edge_logs_jobs(edge_id, body)
|
|
5554
6076
|
|
|
6077
|
+
|
|
6078
|
+
|
|
5555
6079
|
Create a job to upload a list of Edge logs.
|
|
5556
6080
|
|
|
5557
6081
|
|
|
5558
6082
|
|
|
5559
6083
|
Wraps POST /api/v2/telephony/providers/edges/{edgeId}/logs/jobs
|
|
5560
6084
|
|
|
6085
|
+
Requires ANY permissions:
|
|
6086
|
+
|
|
6087
|
+
* telephony:plugin:all
|
|
6088
|
+
|
|
5561
6089
|
|
|
5562
6090
|
### Example
|
|
5563
6091
|
~~~ruby
|
|
@@ -5614,12 +6142,18 @@ Name | Type | Description | Notes
|
|
|
5614
6142
|
|
|
5615
6143
|
## -String** post_telephony_providers_edge_reboot(edge_id, opts)
|
|
5616
6144
|
|
|
6145
|
+
|
|
6146
|
+
|
|
5617
6147
|
Reboot an Edge
|
|
5618
6148
|
|
|
5619
6149
|
|
|
5620
6150
|
|
|
5621
6151
|
Wraps POST /api/v2/telephony/providers/edges/{edgeId}/reboot
|
|
5622
6152
|
|
|
6153
|
+
Requires ANY permissions:
|
|
6154
|
+
|
|
6155
|
+
* telephony:plugin:all
|
|
6156
|
+
|
|
5623
6157
|
|
|
5624
6158
|
### Example
|
|
5625
6159
|
~~~ruby
|
|
@@ -5677,12 +6211,18 @@ Name | Type | Description | Notes
|
|
|
5677
6211
|
|
|
5678
6212
|
## -[**DomainEdgeSoftwareUpdateDto**](DomainEdgeSoftwareUpdateDto.html) post_telephony_providers_edge_softwareupdate(edge_id, body)
|
|
5679
6213
|
|
|
6214
|
+
|
|
6215
|
+
|
|
5680
6216
|
Starts a software update for this edge.
|
|
5681
6217
|
|
|
5682
6218
|
|
|
5683
6219
|
|
|
5684
6220
|
Wraps POST /api/v2/telephony/providers/edges/{edgeId}/softwareupdate
|
|
5685
6221
|
|
|
6222
|
+
Requires NO permissions:
|
|
6223
|
+
|
|
6224
|
+
|
|
6225
|
+
|
|
5686
6226
|
|
|
5687
6227
|
### Example
|
|
5688
6228
|
~~~ruby
|
|
@@ -5739,12 +6279,18 @@ Name | Type | Description | Notes
|
|
|
5739
6279
|
|
|
5740
6280
|
## -String** post_telephony_providers_edge_statuscode(edge_id, opts)
|
|
5741
6281
|
|
|
6282
|
+
|
|
6283
|
+
|
|
5742
6284
|
Take an Edge in or out of service
|
|
5743
6285
|
|
|
5744
6286
|
|
|
5745
6287
|
|
|
5746
6288
|
Wraps POST /api/v2/telephony/providers/edges/{edgeId}/statuscode
|
|
5747
6289
|
|
|
6290
|
+
Requires ANY permissions:
|
|
6291
|
+
|
|
6292
|
+
* telephony:plugin:all
|
|
6293
|
+
|
|
5748
6294
|
|
|
5749
6295
|
### Example
|
|
5750
6296
|
~~~ruby
|
|
@@ -5802,12 +6348,18 @@ Name | Type | Description | Notes
|
|
|
5802
6348
|
|
|
5803
6349
|
## -String** post_telephony_providers_edge_unpair(edge_id)
|
|
5804
6350
|
|
|
6351
|
+
|
|
6352
|
+
|
|
5805
6353
|
Unpair an Edge
|
|
5806
6354
|
|
|
5807
6355
|
|
|
5808
6356
|
|
|
5809
6357
|
Wraps POST /api/v2/telephony/providers/edges/{edgeId}/unpair
|
|
5810
6358
|
|
|
6359
|
+
Requires ANY permissions:
|
|
6360
|
+
|
|
6361
|
+
* telephony:plugin:all
|
|
6362
|
+
|
|
5811
6363
|
|
|
5812
6364
|
### Example
|
|
5813
6365
|
~~~ruby
|
|
@@ -5861,12 +6413,18 @@ Name | Type | Description | Notes
|
|
|
5861
6413
|
|
|
5862
6414
|
## -[**Edge**](Edge.html) post_telephony_providers_edges(body)
|
|
5863
6415
|
|
|
6416
|
+
|
|
6417
|
+
|
|
5864
6418
|
Create an edge.
|
|
5865
6419
|
|
|
5866
6420
|
|
|
5867
6421
|
|
|
5868
6422
|
Wraps POST /api/v2/telephony/providers/edges
|
|
5869
6423
|
|
|
6424
|
+
Requires ANY permissions:
|
|
6425
|
+
|
|
6426
|
+
* telephony:plugin:all
|
|
6427
|
+
|
|
5870
6428
|
|
|
5871
6429
|
### Example
|
|
5872
6430
|
~~~ruby
|
|
@@ -5920,12 +6478,18 @@ Name | Type | Description | Notes
|
|
|
5920
6478
|
|
|
5921
6479
|
## -[**ValidateAddressResponse**](ValidateAddressResponse.html) post_telephony_providers_edges_addressvalidation(body)
|
|
5922
6480
|
|
|
6481
|
+
|
|
6482
|
+
|
|
5923
6483
|
Validates a street address
|
|
5924
6484
|
|
|
5925
6485
|
|
|
5926
6486
|
|
|
5927
6487
|
Wraps POST /api/v2/telephony/providers/edges/addressvalidation
|
|
5928
6488
|
|
|
6489
|
+
Requires NO permissions:
|
|
6490
|
+
|
|
6491
|
+
|
|
6492
|
+
|
|
5929
6493
|
|
|
5930
6494
|
### Example
|
|
5931
6495
|
~~~ruby
|
|
@@ -5979,12 +6543,18 @@ Name | Type | Description | Notes
|
|
|
5979
6543
|
|
|
5980
6544
|
## -[**DomainCertificateAuthority**](DomainCertificateAuthority.html) post_telephony_providers_edges_certificateauthorities(body)
|
|
5981
6545
|
|
|
6546
|
+
|
|
6547
|
+
|
|
5982
6548
|
Create a certificate authority.
|
|
5983
6549
|
|
|
5984
6550
|
|
|
5985
6551
|
|
|
5986
6552
|
Wraps POST /api/v2/telephony/providers/edges/certificateauthorities
|
|
5987
6553
|
|
|
6554
|
+
Requires ANY permissions:
|
|
6555
|
+
|
|
6556
|
+
* telephony:plugin:all
|
|
6557
|
+
|
|
5988
6558
|
|
|
5989
6559
|
### Example
|
|
5990
6560
|
~~~ruby
|
|
@@ -6038,12 +6608,18 @@ Name | Type | Description | Notes
|
|
|
6038
6608
|
|
|
6039
6609
|
## -[**DIDPool**](DIDPool.html) post_telephony_providers_edges_didpools(body)
|
|
6040
6610
|
|
|
6611
|
+
|
|
6612
|
+
|
|
6041
6613
|
Create a new DID pool
|
|
6042
6614
|
|
|
6043
6615
|
|
|
6044
6616
|
|
|
6045
6617
|
Wraps POST /api/v2/telephony/providers/edges/didpools
|
|
6046
6618
|
|
|
6619
|
+
Requires ANY permissions:
|
|
6620
|
+
|
|
6621
|
+
* telephony:plugin:all
|
|
6622
|
+
|
|
6047
6623
|
|
|
6048
6624
|
### Example
|
|
6049
6625
|
~~~ruby
|
|
@@ -6097,12 +6673,18 @@ Name | Type | Description | Notes
|
|
|
6097
6673
|
|
|
6098
6674
|
## -[**EdgeGroup**](EdgeGroup.html) post_telephony_providers_edges_edgegroups(body)
|
|
6099
6675
|
|
|
6676
|
+
|
|
6677
|
+
|
|
6100
6678
|
Create an edge group.
|
|
6101
6679
|
|
|
6102
6680
|
|
|
6103
6681
|
|
|
6104
6682
|
Wraps POST /api/v2/telephony/providers/edges/edgegroups
|
|
6105
6683
|
|
|
6684
|
+
Requires ANY permissions:
|
|
6685
|
+
|
|
6686
|
+
* telephony:plugin:all
|
|
6687
|
+
|
|
6106
6688
|
|
|
6107
6689
|
### Example
|
|
6108
6690
|
~~~ruby
|
|
@@ -6156,12 +6738,18 @@ Name | Type | Description | Notes
|
|
|
6156
6738
|
|
|
6157
6739
|
## -[**Endpoint**](Endpoint.html) post_telephony_providers_edges_endpoints(body)
|
|
6158
6740
|
|
|
6741
|
+
|
|
6742
|
+
|
|
6159
6743
|
Create endpoint
|
|
6160
6744
|
|
|
6161
6745
|
|
|
6162
6746
|
|
|
6163
6747
|
Wraps POST /api/v2/telephony/providers/edges/endpoints
|
|
6164
6748
|
|
|
6749
|
+
Requires ANY permissions:
|
|
6750
|
+
|
|
6751
|
+
* telephony:plugin:all
|
|
6752
|
+
|
|
6165
6753
|
|
|
6166
6754
|
### Example
|
|
6167
6755
|
~~~ruby
|
|
@@ -6215,12 +6803,18 @@ Name | Type | Description | Notes
|
|
|
6215
6803
|
|
|
6216
6804
|
## -[**ExtensionPool**](ExtensionPool.html) post_telephony_providers_edges_extensionpools(body)
|
|
6217
6805
|
|
|
6806
|
+
|
|
6807
|
+
|
|
6218
6808
|
Create a new extension pool
|
|
6219
6809
|
|
|
6220
6810
|
|
|
6221
6811
|
|
|
6222
6812
|
Wraps POST /api/v2/telephony/providers/edges/extensionpools
|
|
6223
6813
|
|
|
6814
|
+
Requires ANY permissions:
|
|
6815
|
+
|
|
6816
|
+
* telephony:plugin:all
|
|
6817
|
+
|
|
6224
6818
|
|
|
6225
6819
|
### Example
|
|
6226
6820
|
~~~ruby
|
|
@@ -6274,12 +6868,18 @@ Name | Type | Description | Notes
|
|
|
6274
6868
|
|
|
6275
6869
|
## -[**OutboundRoute**](OutboundRoute.html) post_telephony_providers_edges_outboundroutes(body)
|
|
6276
6870
|
|
|
6871
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
6872
|
+
|
|
6277
6873
|
Create outbound rule
|
|
6278
6874
|
|
|
6279
6875
|
|
|
6280
6876
|
|
|
6281
6877
|
Wraps POST /api/v2/telephony/providers/edges/outboundroutes
|
|
6282
6878
|
|
|
6879
|
+
Requires ANY permissions:
|
|
6880
|
+
|
|
6881
|
+
* telephony:plugin:all
|
|
6882
|
+
|
|
6283
6883
|
|
|
6284
6884
|
### Example
|
|
6285
6885
|
~~~ruby
|
|
@@ -6333,12 +6933,18 @@ Name | Type | Description | Notes
|
|
|
6333
6933
|
|
|
6334
6934
|
## - post_telephony_providers_edges_phone_reboot(phone_id)
|
|
6335
6935
|
|
|
6936
|
+
|
|
6937
|
+
|
|
6336
6938
|
Reboot a Phone
|
|
6337
6939
|
|
|
6338
6940
|
|
|
6339
6941
|
|
|
6340
6942
|
Wraps POST /api/v2/telephony/providers/edges/phones/{phoneId}/reboot
|
|
6341
6943
|
|
|
6944
|
+
Requires ANY permissions:
|
|
6945
|
+
|
|
6946
|
+
* telephony:plugin:all
|
|
6947
|
+
|
|
6342
6948
|
|
|
6343
6949
|
### Example
|
|
6344
6950
|
~~~ruby
|
|
@@ -6391,12 +6997,18 @@ nil (empty response body)
|
|
|
6391
6997
|
|
|
6392
6998
|
## -[**PhoneBase**](PhoneBase.html) post_telephony_providers_edges_phonebasesettings(body)
|
|
6393
6999
|
|
|
7000
|
+
|
|
7001
|
+
|
|
6394
7002
|
Create a new Phone Base Settings object
|
|
6395
7003
|
|
|
6396
7004
|
|
|
6397
7005
|
|
|
6398
7006
|
Wraps POST /api/v2/telephony/providers/edges/phonebasesettings
|
|
6399
7007
|
|
|
7008
|
+
Requires ANY permissions:
|
|
7009
|
+
|
|
7010
|
+
* telephony:plugin:all
|
|
7011
|
+
|
|
6400
7012
|
|
|
6401
7013
|
### Example
|
|
6402
7014
|
~~~ruby
|
|
@@ -6450,12 +7062,18 @@ Name | Type | Description | Notes
|
|
|
6450
7062
|
|
|
6451
7063
|
## -[**Phone**](Phone.html) post_telephony_providers_edges_phones(body)
|
|
6452
7064
|
|
|
7065
|
+
|
|
7066
|
+
|
|
6453
7067
|
Create a new Phone
|
|
6454
7068
|
|
|
6455
7069
|
|
|
6456
7070
|
|
|
6457
7071
|
Wraps POST /api/v2/telephony/providers/edges/phones
|
|
6458
7072
|
|
|
7073
|
+
Requires ANY permissions:
|
|
7074
|
+
|
|
7075
|
+
* telephony:plugin:all
|
|
7076
|
+
|
|
6459
7077
|
|
|
6460
7078
|
### Example
|
|
6461
7079
|
~~~ruby
|
|
@@ -6509,12 +7127,18 @@ Name | Type | Description | Notes
|
|
|
6509
7127
|
|
|
6510
7128
|
## - post_telephony_providers_edges_phones_reboot(body)
|
|
6511
7129
|
|
|
7130
|
+
|
|
7131
|
+
|
|
6512
7132
|
Reboot Multiple Phones
|
|
6513
7133
|
|
|
6514
7134
|
|
|
6515
7135
|
|
|
6516
7136
|
Wraps POST /api/v2/telephony/providers/edges/phones/reboot
|
|
6517
7137
|
|
|
7138
|
+
Requires ANY permissions:
|
|
7139
|
+
|
|
7140
|
+
* telephony:plugin:all
|
|
7141
|
+
|
|
6518
7142
|
|
|
6519
7143
|
### Example
|
|
6520
7144
|
~~~ruby
|
|
@@ -6567,12 +7191,18 @@ nil (empty response body)
|
|
|
6567
7191
|
|
|
6568
7192
|
## -String** post_telephony_providers_edges_site_autoscalinggroups(site_id, body)
|
|
6569
7193
|
|
|
7194
|
+
|
|
7195
|
+
|
|
6570
7196
|
Creates an ASG for the specified site
|
|
6571
7197
|
|
|
6572
7198
|
|
|
6573
7199
|
|
|
6574
7200
|
Wraps POST /api/v2/telephony/providers/edges/sites/{siteId}/autoscalinggroups
|
|
6575
7201
|
|
|
7202
|
+
Requires ANY permissions:
|
|
7203
|
+
|
|
7204
|
+
* managed:all:all
|
|
7205
|
+
|
|
6576
7206
|
|
|
6577
7207
|
### Example
|
|
6578
7208
|
~~~ruby
|
|
@@ -6629,12 +7259,18 @@ Name | Type | Description | Notes
|
|
|
6629
7259
|
|
|
6630
7260
|
## -[**OutboundRouteBase**](OutboundRouteBase.html) post_telephony_providers_edges_site_outboundroutes(site_id, body)
|
|
6631
7261
|
|
|
7262
|
+
|
|
7263
|
+
|
|
6632
7264
|
Create outbound route
|
|
6633
7265
|
|
|
6634
7266
|
|
|
6635
7267
|
|
|
6636
7268
|
Wraps POST /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes
|
|
6637
7269
|
|
|
7270
|
+
Requires ANY permissions:
|
|
7271
|
+
|
|
7272
|
+
* telephony:plugin:all
|
|
7273
|
+
|
|
6638
7274
|
|
|
6639
7275
|
### Example
|
|
6640
7276
|
~~~ruby
|
|
@@ -6691,12 +7327,18 @@ Name | Type | Description | Notes
|
|
|
6691
7327
|
|
|
6692
7328
|
## - post_telephony_providers_edges_site_rebalance(site_id)
|
|
6693
7329
|
|
|
7330
|
+
|
|
7331
|
+
|
|
6694
7332
|
Triggers the rebalance operation.
|
|
6695
7333
|
|
|
6696
7334
|
|
|
6697
7335
|
|
|
6698
7336
|
Wraps POST /api/v2/telephony/providers/edges/sites/{siteId}/rebalance
|
|
6699
7337
|
|
|
7338
|
+
Requires ANY permissions:
|
|
7339
|
+
|
|
7340
|
+
* telephony:plugin:all
|
|
7341
|
+
|
|
6700
7342
|
|
|
6701
7343
|
### Example
|
|
6702
7344
|
~~~ruby
|
|
@@ -6749,12 +7391,18 @@ nil (empty response body)
|
|
|
6749
7391
|
|
|
6750
7392
|
## -[**Site**](Site.html) post_telephony_providers_edges_sites(body)
|
|
6751
7393
|
|
|
7394
|
+
|
|
7395
|
+
|
|
6752
7396
|
Create a Site.
|
|
6753
7397
|
|
|
6754
7398
|
|
|
6755
7399
|
|
|
6756
7400
|
Wraps POST /api/v2/telephony/providers/edges/sites
|
|
6757
7401
|
|
|
7402
|
+
Requires ANY permissions:
|
|
7403
|
+
|
|
7404
|
+
* telephony:plugin:all
|
|
7405
|
+
|
|
6758
7406
|
|
|
6759
7407
|
### Example
|
|
6760
7408
|
~~~ruby
|
|
@@ -6808,12 +7456,18 @@ Name | Type | Description | Notes
|
|
|
6808
7456
|
|
|
6809
7457
|
## -[**TrunkBase**](TrunkBase.html) post_telephony_providers_edges_trunkbasesettings(body)
|
|
6810
7458
|
|
|
7459
|
+
|
|
7460
|
+
|
|
6811
7461
|
Create a Trunk Base Settings object
|
|
6812
7462
|
|
|
6813
7463
|
|
|
6814
7464
|
|
|
6815
7465
|
Wraps POST /api/v2/telephony/providers/edges/trunkbasesettings
|
|
6816
7466
|
|
|
7467
|
+
Requires ANY permissions:
|
|
7468
|
+
|
|
7469
|
+
* telephony:plugin:all
|
|
7470
|
+
|
|
6817
7471
|
|
|
6818
7472
|
### Example
|
|
6819
7473
|
~~~ruby
|
|
@@ -6867,12 +7521,18 @@ Name | Type | Description | Notes
|
|
|
6867
7521
|
|
|
6868
7522
|
## -[**Edge**](Edge.html) put_telephony_providers_edge(edge_id, body)
|
|
6869
7523
|
|
|
7524
|
+
|
|
7525
|
+
|
|
6870
7526
|
Update a edge.
|
|
6871
7527
|
|
|
6872
7528
|
|
|
6873
7529
|
|
|
6874
7530
|
Wraps PUT /api/v2/telephony/providers/edges/{edgeId}
|
|
6875
7531
|
|
|
7532
|
+
Requires ANY permissions:
|
|
7533
|
+
|
|
7534
|
+
* telephony:plugin:all
|
|
7535
|
+
|
|
6876
7536
|
|
|
6877
7537
|
### Example
|
|
6878
7538
|
~~~ruby
|
|
@@ -6929,12 +7589,18 @@ Name | Type | Description | Notes
|
|
|
6929
7589
|
|
|
6930
7590
|
## -[**EdgeLine**](EdgeLine.html) put_telephony_providers_edge_line(edge_id, line_id, body)
|
|
6931
7591
|
|
|
7592
|
+
|
|
7593
|
+
|
|
6932
7594
|
Update a line.
|
|
6933
7595
|
|
|
6934
7596
|
|
|
6935
7597
|
|
|
6936
7598
|
Wraps PUT /api/v2/telephony/providers/edges/{edgeId}/lines/{lineId}
|
|
6937
7599
|
|
|
7600
|
+
Requires ANY permissions:
|
|
7601
|
+
|
|
7602
|
+
* telephony:plugin:all
|
|
7603
|
+
|
|
6938
7604
|
|
|
6939
7605
|
### Example
|
|
6940
7606
|
~~~ruby
|
|
@@ -6994,12 +7660,18 @@ Name | Type | Description | Notes
|
|
|
6994
7660
|
|
|
6995
7661
|
## -[**DomainLogicalInterface**](DomainLogicalInterface.html) put_telephony_providers_edge_logicalinterface(edge_id, interface_id, body)
|
|
6996
7662
|
|
|
7663
|
+
|
|
7664
|
+
|
|
6997
7665
|
Update an edge logical interface.
|
|
6998
7666
|
|
|
6999
7667
|
|
|
7000
7668
|
|
|
7001
7669
|
Wraps PUT /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}
|
|
7002
7670
|
|
|
7671
|
+
Requires ANY permissions:
|
|
7672
|
+
|
|
7673
|
+
* telephony:plugin:all
|
|
7674
|
+
|
|
7003
7675
|
|
|
7004
7676
|
### Example
|
|
7005
7677
|
~~~ruby
|
|
@@ -7059,12 +7731,18 @@ Name | Type | Description | Notes
|
|
|
7059
7731
|
|
|
7060
7732
|
## -[**DomainCertificateAuthority**](DomainCertificateAuthority.html) put_telephony_providers_edges_certificateauthority(certificate_id, body)
|
|
7061
7733
|
|
|
7734
|
+
|
|
7735
|
+
|
|
7062
7736
|
Update a certificate authority.
|
|
7063
7737
|
|
|
7064
7738
|
|
|
7065
7739
|
|
|
7066
7740
|
Wraps PUT /api/v2/telephony/providers/edges/certificateauthorities/{certificateId}
|
|
7067
7741
|
|
|
7742
|
+
Requires ANY permissions:
|
|
7743
|
+
|
|
7744
|
+
* telephony:plugin:all
|
|
7745
|
+
|
|
7068
7746
|
|
|
7069
7747
|
### Example
|
|
7070
7748
|
~~~ruby
|
|
@@ -7121,12 +7799,18 @@ Name | Type | Description | Notes
|
|
|
7121
7799
|
|
|
7122
7800
|
## -[**DID**](DID.html) put_telephony_providers_edges_did(did_id, body)
|
|
7123
7801
|
|
|
7802
|
+
|
|
7803
|
+
|
|
7124
7804
|
Update a DID by ID.
|
|
7125
7805
|
|
|
7126
7806
|
|
|
7127
7807
|
|
|
7128
7808
|
Wraps PUT /api/v2/telephony/providers/edges/dids/{didId}
|
|
7129
7809
|
|
|
7810
|
+
Requires ANY permissions:
|
|
7811
|
+
|
|
7812
|
+
* telephony:plugin:all
|
|
7813
|
+
|
|
7130
7814
|
|
|
7131
7815
|
### Example
|
|
7132
7816
|
~~~ruby
|
|
@@ -7183,12 +7867,18 @@ Name | Type | Description | Notes
|
|
|
7183
7867
|
|
|
7184
7868
|
## -[**DIDPool**](DIDPool.html) put_telephony_providers_edges_didpool(did_pool_id, body)
|
|
7185
7869
|
|
|
7870
|
+
|
|
7871
|
+
|
|
7186
7872
|
Update a DID Pool by ID.
|
|
7187
7873
|
|
|
7188
7874
|
|
|
7189
7875
|
|
|
7190
7876
|
Wraps PUT /api/v2/telephony/providers/edges/didpools/{didPoolId}
|
|
7191
7877
|
|
|
7878
|
+
Requires ANY permissions:
|
|
7879
|
+
|
|
7880
|
+
* telephony:plugin:all
|
|
7881
|
+
|
|
7192
7882
|
|
|
7193
7883
|
### Example
|
|
7194
7884
|
~~~ruby
|
|
@@ -7245,12 +7935,18 @@ Name | Type | Description | Notes
|
|
|
7245
7935
|
|
|
7246
7936
|
## -[**EdgeGroup**](EdgeGroup.html) put_telephony_providers_edges_edgegroup(edge_group_id, body)
|
|
7247
7937
|
|
|
7938
|
+
|
|
7939
|
+
|
|
7248
7940
|
Update an edge group.
|
|
7249
7941
|
|
|
7250
7942
|
|
|
7251
7943
|
|
|
7252
7944
|
Wraps PUT /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}
|
|
7253
7945
|
|
|
7946
|
+
Requires ANY permissions:
|
|
7947
|
+
|
|
7948
|
+
* telephony:plugin:all
|
|
7949
|
+
|
|
7254
7950
|
|
|
7255
7951
|
### Example
|
|
7256
7952
|
~~~ruby
|
|
@@ -7307,12 +8003,18 @@ Name | Type | Description | Notes
|
|
|
7307
8003
|
|
|
7308
8004
|
## -[**EdgeTrunkBase**](EdgeTrunkBase.html) put_telephony_providers_edges_edgegroup_edgetrunkbase(edgegroup_id, edgetrunkbase_id, body)
|
|
7309
8005
|
|
|
8006
|
+
|
|
8007
|
+
|
|
7310
8008
|
Update the edge trunk base associated with the edge group
|
|
7311
8009
|
|
|
7312
8010
|
|
|
7313
8011
|
|
|
7314
8012
|
Wraps PUT /api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}
|
|
7315
8013
|
|
|
8014
|
+
Requires ANY permissions:
|
|
8015
|
+
|
|
8016
|
+
* telephony:plugin:all
|
|
8017
|
+
|
|
7316
8018
|
|
|
7317
8019
|
### Example
|
|
7318
8020
|
~~~ruby
|
|
@@ -7372,12 +8074,18 @@ Name | Type | Description | Notes
|
|
|
7372
8074
|
|
|
7373
8075
|
## -[**Endpoint**](Endpoint.html) put_telephony_providers_edges_endpoint(endpoint_id, body)
|
|
7374
8076
|
|
|
8077
|
+
|
|
8078
|
+
|
|
7375
8079
|
Update endpoint
|
|
7376
8080
|
|
|
7377
8081
|
|
|
7378
8082
|
|
|
7379
8083
|
Wraps PUT /api/v2/telephony/providers/edges/endpoints/{endpointId}
|
|
7380
8084
|
|
|
8085
|
+
Requires ANY permissions:
|
|
8086
|
+
|
|
8087
|
+
* telephony:plugin:all
|
|
8088
|
+
|
|
7381
8089
|
|
|
7382
8090
|
### Example
|
|
7383
8091
|
~~~ruby
|
|
@@ -7434,12 +8142,18 @@ Name | Type | Description | Notes
|
|
|
7434
8142
|
|
|
7435
8143
|
## -[**Extension**](Extension.html) put_telephony_providers_edges_extension(extension_id, body)
|
|
7436
8144
|
|
|
8145
|
+
|
|
8146
|
+
|
|
7437
8147
|
Update an extension by ID.
|
|
7438
8148
|
|
|
7439
8149
|
|
|
7440
8150
|
|
|
7441
8151
|
Wraps PUT /api/v2/telephony/providers/edges/extensions/{extensionId}
|
|
7442
8152
|
|
|
8153
|
+
Requires ANY permissions:
|
|
8154
|
+
|
|
8155
|
+
* telephony:plugin:all
|
|
8156
|
+
|
|
7443
8157
|
|
|
7444
8158
|
### Example
|
|
7445
8159
|
~~~ruby
|
|
@@ -7496,12 +8210,18 @@ Name | Type | Description | Notes
|
|
|
7496
8210
|
|
|
7497
8211
|
## -[**ExtensionPool**](ExtensionPool.html) put_telephony_providers_edges_extensionpool(extension_pool_id, body)
|
|
7498
8212
|
|
|
8213
|
+
|
|
8214
|
+
|
|
7499
8215
|
Update an extension pool by ID
|
|
7500
8216
|
|
|
7501
8217
|
|
|
7502
8218
|
|
|
7503
8219
|
Wraps PUT /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}
|
|
7504
8220
|
|
|
8221
|
+
Requires ANY permissions:
|
|
8222
|
+
|
|
8223
|
+
* telephony:plugin:all
|
|
8224
|
+
|
|
7505
8225
|
|
|
7506
8226
|
### Example
|
|
7507
8227
|
~~~ruby
|
|
@@ -7558,12 +8278,18 @@ Name | Type | Description | Notes
|
|
|
7558
8278
|
|
|
7559
8279
|
## -[**OutboundRoute**](OutboundRoute.html) put_telephony_providers_edges_outboundroute(outbound_route_id, body)
|
|
7560
8280
|
|
|
8281
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
8282
|
+
|
|
7561
8283
|
Update outbound route
|
|
7562
8284
|
|
|
7563
8285
|
|
|
7564
8286
|
|
|
7565
8287
|
Wraps PUT /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}
|
|
7566
8288
|
|
|
8289
|
+
Requires ANY permissions:
|
|
8290
|
+
|
|
8291
|
+
* telephony:plugin:all
|
|
8292
|
+
|
|
7567
8293
|
|
|
7568
8294
|
### Example
|
|
7569
8295
|
~~~ruby
|
|
@@ -7620,12 +8346,18 @@ Name | Type | Description | Notes
|
|
|
7620
8346
|
|
|
7621
8347
|
## -[**Phone**](Phone.html) put_telephony_providers_edges_phone(phone_id, body)
|
|
7622
8348
|
|
|
8349
|
+
|
|
8350
|
+
|
|
7623
8351
|
Update a Phone by ID
|
|
7624
8352
|
|
|
7625
8353
|
|
|
7626
8354
|
|
|
7627
8355
|
Wraps PUT /api/v2/telephony/providers/edges/phones/{phoneId}
|
|
7628
8356
|
|
|
8357
|
+
Requires ANY permissions:
|
|
8358
|
+
|
|
8359
|
+
* telephony:plugin:all
|
|
8360
|
+
|
|
7629
8361
|
|
|
7630
8362
|
### Example
|
|
7631
8363
|
~~~ruby
|
|
@@ -7682,12 +8414,18 @@ Name | Type | Description | Notes
|
|
|
7682
8414
|
|
|
7683
8415
|
## -[**PhoneBase**](PhoneBase.html) put_telephony_providers_edges_phonebasesetting(phone_base_id, body)
|
|
7684
8416
|
|
|
8417
|
+
|
|
8418
|
+
|
|
7685
8419
|
Update a Phone Base Settings by ID
|
|
7686
8420
|
|
|
7687
8421
|
|
|
7688
8422
|
|
|
7689
8423
|
Wraps PUT /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}
|
|
7690
8424
|
|
|
8425
|
+
Requires ANY permissions:
|
|
8426
|
+
|
|
8427
|
+
* telephony:plugin:all
|
|
8428
|
+
|
|
7691
8429
|
|
|
7692
8430
|
### Example
|
|
7693
8431
|
~~~ruby
|
|
@@ -7744,12 +8482,18 @@ Name | Type | Description | Notes
|
|
|
7744
8482
|
|
|
7745
8483
|
## -[**Site**](Site.html) put_telephony_providers_edges_site(site_id, body)
|
|
7746
8484
|
|
|
8485
|
+
|
|
8486
|
+
|
|
7747
8487
|
Update a Site by ID.
|
|
7748
8488
|
|
|
7749
8489
|
|
|
7750
8490
|
|
|
7751
8491
|
Wraps PUT /api/v2/telephony/providers/edges/sites/{siteId}
|
|
7752
8492
|
|
|
8493
|
+
Requires ANY permissions:
|
|
8494
|
+
|
|
8495
|
+
* telephony:plugin:all
|
|
8496
|
+
|
|
7753
8497
|
|
|
7754
8498
|
### Example
|
|
7755
8499
|
~~~ruby
|
|
@@ -7806,12 +8550,18 @@ Name | Type | Description | Notes
|
|
|
7806
8550
|
|
|
7807
8551
|
## -[**Array<NumberPlan>**](NumberPlan.html) put_telephony_providers_edges_site_numberplans(site_id, body)
|
|
7808
8552
|
|
|
8553
|
+
|
|
8554
|
+
|
|
7809
8555
|
Update the list of Number Plans.
|
|
7810
8556
|
|
|
7811
8557
|
|
|
7812
8558
|
|
|
7813
8559
|
Wraps PUT /api/v2/telephony/providers/edges/sites/{siteId}/numberplans
|
|
7814
8560
|
|
|
8561
|
+
Requires ANY permissions:
|
|
8562
|
+
|
|
8563
|
+
* telephony:plugin:all
|
|
8564
|
+
|
|
7815
8565
|
|
|
7816
8566
|
### Example
|
|
7817
8567
|
~~~ruby
|
|
@@ -7868,12 +8618,18 @@ Name | Type | Description | Notes
|
|
|
7868
8618
|
|
|
7869
8619
|
## -[**OutboundRouteBase**](OutboundRouteBase.html) put_telephony_providers_edges_site_outboundroute(site_id, outbound_route_id, body)
|
|
7870
8620
|
|
|
8621
|
+
|
|
8622
|
+
|
|
7871
8623
|
Update outbound route
|
|
7872
8624
|
|
|
7873
8625
|
|
|
7874
8626
|
|
|
7875
8627
|
Wraps PUT /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}
|
|
7876
8628
|
|
|
8629
|
+
Requires ANY permissions:
|
|
8630
|
+
|
|
8631
|
+
* telephony:plugin:all
|
|
8632
|
+
|
|
7877
8633
|
|
|
7878
8634
|
### Example
|
|
7879
8635
|
~~~ruby
|
|
@@ -7933,12 +8689,18 @@ Name | Type | Description | Notes
|
|
|
7933
8689
|
|
|
7934
8690
|
## -[**TrunkBase**](TrunkBase.html) put_telephony_providers_edges_trunkbasesetting(trunk_base_settings_id, body)
|
|
7935
8691
|
|
|
8692
|
+
|
|
8693
|
+
|
|
7936
8694
|
Update a Trunk Base Settings object by ID
|
|
7937
8695
|
|
|
7938
8696
|
|
|
7939
8697
|
|
|
7940
8698
|
Wraps PUT /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}
|
|
7941
8699
|
|
|
8700
|
+
Requires ANY permissions:
|
|
8701
|
+
|
|
8702
|
+
* telephony:plugin:all
|
|
8703
|
+
|
|
7942
8704
|
|
|
7943
8705
|
### Example
|
|
7944
8706
|
~~~ruby
|