telnyx-numbers-config-java

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. --> # Telnyx Numbers Config - Java ## Installation ```text // See https://github.com/team-telnyx/telnyx-java for Maven/Gradle setup ``` ## Setup ```java import com.telnyx.sdk.client.TelnyxClient; import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient; TelnyxClient client = TelnyxOkHttpClient.fromEnv(); ``` All examples below assume `client` is already initialized as shown above. ## Lists the phone number blocks jobs `GET /phone_number_blocks/jobs` ```java import com.telnyx.sdk.models.phonenumberblocks.jobs.JobListPage; import com.telnyx.sdk.models.phonenumberblocks.jobs.JobListParams; JobListPage page = client.phoneNumberBlocks().jobs().list(); ``` ## Retrieves a phone number blocks job `GET /phone_number_blocks/jobs/{id}` ```java import com.telnyx.sdk.models.phonenumberblocks.jobs.JobRetrieveParams; import com.telnyx.sdk.models.phonenumberblocks.jobs.JobRetrieveResponse; JobRetrieveResponse job = client.phoneNumberBlocks().jobs().retrieve("id"); ``` ## Deletes all numbers associated with a phone number block Creates a new background job to delete all the phone numbers associated with the given block. `POST /phone_number_blocks/jobs/delete_phone_number_block` — Required: `phone_number_block_id` ```java import com.telnyx.sdk.models.phonenumberblocks.jobs.JobDeletePhoneNumberBlockParams; import com.telnyx.sdk.models.phonenumberblocks.jobs.JobDeletePhoneNumberBlockResponse; JobDeletePhoneNumberBlockParams params = JobDeletePhoneNumberBlockParams.builder() .phoneNumberBlockId("f3946371-7199-4261-9c3d-81a0d7935146") .build(); JobDeletePhoneNumberBlockResponse response = client.phoneNumberBlocks().jobs().deletePhoneNumberBlock(params); ``` ## List phone numbers `GET /phone_numbers` ```java import com.telnyx.sdk.models.phonenumbers.PhoneNumberListPage; import com.telnyx.sdk.models.phonenumbers.PhoneNumberListParams; PhoneNumberListPage page = client.phoneNumbers().list(); ``` ## Retrieve a phone number `GET /phone_numbers/{id}` ```java import com.telnyx.sdk.models.phonenumbers.PhoneNumberRetrieveParams; import com.telnyx.sdk.models.phonenumbers.PhoneNumberRetrieveResponse; PhoneNumberRetrieveResponse phoneNumber = client.phoneNumbers().retrieve("1293384261075731499"); ``` ## Update a phone number `PATCH /phone_numbers/{id}` ```java import com.telnyx.sdk.models.phonenumbers.PhoneNumberUpdateParams; import com.telnyx.sdk.models.phonenumbers.PhoneNumberUpdateResponse; PhoneNumberUpdateResponse phoneNumber = client.phoneNumbers().update("1293384261075731499"); ``` ## Delete a phone number `DELETE /phone_numbers/{id}` ```java import com.telnyx.sdk.models.phonenumbers.PhoneNumberDeleteParams; import com.telnyx.sdk.models.phonenumbers.PhoneNumberDeleteResponse; PhoneNumberDeleteResponse phoneNumber = client.phoneNumbers().delete("1293384261075731499"); ``` ## Change the bundle status for a phone number (set to being in a bundle or remove from a bundle) `PATCH /phone_numbers/{id}/actions/bundle_status_change` — Required: `bundle_id` ```java import com.telnyx.sdk.models.phonenumbers.actions.ActionChangeBundleStatusParams; import com.telnyx.sdk.models.phonenumbers.actions.ActionChangeBundleStatusResponse; ActionChangeBundleStatusParams params = ActionChangeBundleStatusParams.builder() .id("1293384261075731499") .bundleId("5194d8fc-87e6-4188-baa9-1c434bbe861b") .build(); ActionChangeBundleStatusResponse response = client.phoneNumbers().actions().changeBundleStatus(params); ``` ## Enable emergency for a phone number `POST /phone_numbers/{id}/actions/enable_emergency` — Required: `emergency_enabled`, `emergency_address_id` ```java import com.telnyx.sdk.models.phonenumbers.actions.ActionEnableEmergencyParams; import com.telnyx.sdk.models.phonenumbers.actions.ActionEnableEmergencyResponse; ActionEnableEmergencyParams params = ActionEnableEmergencyParams.builder() .id("1293384261075731499") .emergencyAddressId("53829456729313") .emergencyEnabled(true) .build(); ActionEnableEmergencyResponse response = client.phoneNumbers().actions().enableEmergency(params); ``` ## Retrieve a phone number with voice settings `GET /phone_numbers/{id}/voice` ```java import com.telnyx.sdk.models.phonenumbers.voice.VoiceRetrieveParams; import com.telnyx.sdk.models.phonenumbers.voice.VoiceRetrieveResponse; VoiceRetrieveResponse voice = client.phoneNumbers().voice().retrieve("1293384261075731499"); ``` ## Update a phone number with voice settings `PATCH /phone_numbers/{id}/voice` ```java import com.telnyx.sdk.models.phonenumbers.voice.UpdateVoiceSettings; import com.telnyx.sdk.models.phonenumbers.voice.VoiceUpdateParams; import com.telnyx.sdk.models.phonenumbers.voice.VoiceUpdateResponse; VoiceUpdateParams params = VoiceUpdateParams.builder() .id("1293384261075731499") .updateVoiceSettings(UpdateVoiceSettings.builder().build()) .build(); VoiceUpdateResponse voice = client.phoneNumbers().voice().update(params); ``` ## Verify ownership of phone numbers Verifies ownership of the provided phone numbers and returns a mapping of numbers to their IDs, plus a list of numbers not found in the account. `POST /phone_numbers/actions/verify_ownership` — Required: `phone_numbers` ```java import com.telnyx.sdk.models.phonenumbers.actions.ActionVerifyOwnershipParams; import com.telnyx.sdk.models.phonenumbers.actions.ActionVerifyOwnershipResponse; ActionVerifyOwnershipParams params = ActionVerifyOwnershipParams.builder() .addPhoneNumber("+15551234567") .build(); ActionVerifyOwnershipResponse response = client.phoneNumbers().actions().verifyOwnership(params); ``` ## List CSV downloads `GET /phone_numbers/csv_downloads` ```java import com.telnyx.sdk.models.phonenumbers.csvdownloads.CsvDownloadListPage; import com.telnyx.sdk.models.phonenumbers.csvdownloads.CsvDownloadListParams; CsvDownloadListPage page = client.phoneNumbers().csvDownloads().list(); ``` ## Create a CSV download `POST /phone_numbers/csv_downloads` ```java import com.telnyx.sdk.models.phonenumbers.csvdownloads.CsvDownloadCreateParams; import com.telnyx.sdk.models.phonenumbers.csvdownloads.CsvDownloadCreateResponse; CsvDownloadCreateResponse csvDownload = client.phoneNumbers().csvDownloads().create(); ``` ## Retrieve a CSV download `GET /phone_numbers/csv_downloads/{id}` ```java import com.telnyx.sdk.models.phonenumbers.csvdownloads.CsvDownloadRetrieveParams; import com.telnyx.sdk.models.phonenumbers.csvdownloads.CsvDownloadRetrieveResponse; CsvDownloadRetrieveResponse csvDownload = client.phoneNumbers().csvDownloads().retrieve("id"); ``` ## Lists the phone numbers jobs `GET /phone_numbers/jobs` ```java import com.telnyx.sdk.models.phonenumbers.jobs.JobListPage; import com.telnyx.sdk.models.phonenumbers.jobs.JobListParams; JobListPage page = client.phoneNumbers().jobs().list(); ``` ## Retrieve a phone numbers job `GET /phone_numbers/jobs/{id}` ```java import com.telnyx.sdk.models.phonenumbers.jobs.JobRetrieveParams; import com.telnyx.sdk.models.phonenumbers.jobs.JobRetrieveResponse; JobRetrieveResponse job = client.phoneNumbers().jobs().retrieve("id"); ``` ## Delete a batch of numbers Creates a new background job to delete a batch of numbers. `POST /phone_numbers/jobs/delete_phone_numbers` — Required: `phone_numbers` ```java import com.telnyx.sdk.models.phonenumbers.jobs.JobDeleteBatchParams; import com.telnyx.sdk.models.phonenumbers.jobs.JobDeleteBatchResponse; import java.util.List; JobDeleteBatchParams params = JobDeleteBatchParams.builder() .phoneNumbers(List.of( "+19705555098", "+19715555098", "32873127836" )) .build(); JobDeleteBatchResponse response = client.phoneNumbers().jobs().deleteBatch(params); ``` ## Update the emergency settings from a batch of numbers Creates a background job to update the emergency settings of a collection of phone numbers. `POST /phone_numbers/jobs/update_emergency_settings` — Required: `emergency_enabled`, `phone_numbers` ```java import com.telnyx.sdk.models.phonenumbers.jobs.JobUpdateEmergencySettingsBatchParams; import com.telnyx.sdk.models.phonenumbers.jobs.JobUpdateEmergencySettingsBatchResponse; import java.util.List; JobUpdateEmergencySettingsBatchParams params = JobUpdateEmergencySettingsBatchParams.builder() .emergencyEnabled(true) .phoneNumbers(List.of( "+19705555098", "+19715555098", "32873127836" )) .build(); JobUpdateEmergencySettingsBatchResponse response = client.phoneNumbers().jobs().updateEmergencySettingsBatch(params); ``` ## Update a batch of numbers Creates a new background job to update a batch of numbers. `POST /phone_numbers/jobs/update_phone_numbers` — Required: `phone_numbers` ```java import com.telnyx.sdk.models.phonenumbers.jobs.JobUpdateBatchParams; import com.telnyx.sdk.models.phonenumbers.jobs.JobUpdateBatchResponse; JobUpdateBatchParams params = JobUpdateBatchParams.builder() .addPhoneNumber("1583466971586889004") .addPhoneNumber("+13127367254") .build(); JobUpdateBatchResponse response = client.phoneNumbers().jobs().updateBatch(params); ``` ## Retrieve regulatory requirements for a list of phone numbers `GET /phone_numbers/regulatory_requirements` ```java import com.telnyx.sdk.models.phonenumbersregulatoryrequirements.PhoneNumbersRegulatoryRequirementRetrieveParams; import com.telnyx.sdk.models.phonenumbersregulatoryrequirements.PhoneNumbersRegulatoryRequirementRetrieveResponse; PhoneNumbersRegulatoryRequirementRetrieveResponse phoneNumbersRegulatoryRequirement = client.phoneNumbersRegulatoryRequirements().retrieve(); ``` ## Slim List phone numbers List phone numbers, This endpoint is a lighter version of the /phone_numbers endpoint having higher performance and rate limit. `GET /phone_numbers/slim` ```java import com.telnyx.sdk.models.phonenumbers.PhoneNumberSlimListPage; import com.telnyx.sdk.models.phonenumbers.PhoneNumberSlimListParams; PhoneNumberSlimListPage page = client.phoneNumbers().slimList(); ``` ## List phone numbers with voice settings `GET /phone_numbers/voice` ```java import com.telnyx.sdk.models.phonenumbers.voice.VoiceListPage; import com.telnyx.sdk.models.phonenumbers.voice.VoiceListParams; VoiceListPage page = client.phoneNumbers().voice().list(); ``` ## List Mobile Phone Numbers `GET /v2/mobile_phone_numbers` ```java import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberListPage; import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberListParams; MobilePhoneNumberListPage page = client.mobilePhoneNumbers().list(); ``` ## Retrieve a Mobile Phone Number `GET /v2/mobile_phone_numbers/{id}` ```java import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberRetrieveParams; import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberRetrieveResponse; MobilePhoneNumberRetrieveResponse mobilePhoneNumber = client.mobilePhoneNumbers().retrieve("id"); ``` ## Update a Mobile Phone Number `PATCH /v2/mobile_phone_numbers/{id}` ```java import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberUpdateParams; import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberUpdateResponse; MobilePhoneNumberUpdateResponse mobilePhoneNumber = client.mobilePhoneNumbers().update("id"); ```