Telnyx Numbers Compliance - Java
telnyx-numbers-compliance-java
Manage regulatory requirements, number bundles, supporting documents, and verified numbers for compliance. This skill provides Java SDK examples.
SKILL.md
Full skill instructions
Telnyx Numbers Compliance - Java
Installation
// See https://github.com/team-telnyx/telnyx-java for Maven/Gradle setup
Setup
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.
Retrieve Bundles
Get all allowed bundles.
GET /bundle_pricing/billing_bundles
import com.telnyx.sdk.models.bundlepricing.billingbundles.BillingBundleListPage;
import com.telnyx.sdk.models.bundlepricing.billingbundles.BillingBundleListParams;
BillingBundleListPage page = client.bundlePricing().billingBundles().list();
Get Bundle By Id
Get a single bundle by ID.
GET /bundle_pricing/billing_bundles/{bundle_id}
import com.telnyx.sdk.models.bundlepricing.billingbundles.BillingBundleRetrieveParams;
import com.telnyx.sdk.models.bundlepricing.billingbundles.BillingBundleRetrieveResponse;
BillingBundleRetrieveResponse billingBundle = client.bundlePricing().billingBundles().retrieve("8661948c-a386-4385-837f-af00f40f111a");
Get User Bundles
Get a paginated list of user bundles.
GET /bundle_pricing/user_bundles
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListPage;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListParams;
UserBundleListPage page = client.bundlePricing().userBundles().list();
Create User Bundles
Creates multiple user bundles for the user.
POST /bundle_pricing/user_bundles/bulk
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleCreateParams;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleCreateResponse;
UserBundleCreateResponse userBundle = client.bundlePricing().userBundles().create();
Get Unused User Bundles
Returns all user bundles that aren't in use.
GET /bundle_pricing/user_bundles/unused
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListUnusedParams;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListUnusedResponse;
UserBundleListUnusedResponse response = client.bundlePricing().userBundles().listUnused();
Get User Bundle by Id
Retrieves a user bundle by its ID.
GET /bundle_pricing/user_bundles/{user_bundle_id}
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleRetrieveParams;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleRetrieveResponse;
UserBundleRetrieveResponse userBundle = client.bundlePricing().userBundles().retrieve("ca1d2263-d1f1-43ac-ba53-248e7a4bb26a");
Deactivate User Bundle
Deactivates a user bundle by its ID.
DELETE /bundle_pricing/user_bundles/{user_bundle_id}
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleDeactivateParams;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleDeactivateResponse;
UserBundleDeactivateResponse response = client.bundlePricing().userBundles().deactivate("ca1d2263-d1f1-43ac-ba53-248e7a4bb26a");
Get User Bundle Resources
Retrieves the resources of a user bundle by its ID.
GET /bundle_pricing/user_bundles/{user_bundle_id}/resources
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListResourcesParams;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListResourcesResponse;
UserBundleListResourcesResponse response = client.bundlePricing().userBundles().listResources("ca1d2263-d1f1-43ac-ba53-248e7a4bb26a");
List all document links
List all documents links ordered by created_at descending.
GET /document_links
import com.telnyx.sdk.models.documentlinks.DocumentLinkListPage;
import com.telnyx.sdk.models.documentlinks.DocumentLinkListParams;
DocumentLinkListPage page = client.documentLinks().list();
List all documents
List all documents ordered by created_at descending.
GET /documents
import com.telnyx.sdk.models.documents.DocumentListPage;
import com.telnyx.sdk.models.documents.DocumentListParams;
DocumentListPage page = client.documents().list();
Upload a document
Upload a document.<br /><br />Uploaded files must be linked to a service within 30 minutes or they will be automatically deleted.
POST /documents
import com.telnyx.sdk.models.documents.DocumentUploadJsonParams;
import com.telnyx.sdk.models.documents.DocumentUploadJsonResponse;
DocumentUploadJsonResponse response = client.documents().uploadJson();
Retrieve a document
Retrieve a document.
GET /documents/{id}
import com.telnyx.sdk.models.documents.DocumentRetrieveParams;
import com.telnyx.sdk.models.documents.DocumentRetrieveResponse;
DocumentRetrieveResponse document = client.documents().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58");
Update a document
Update a document.
PATCH /documents/{id}
import com.telnyx.sdk.models.documents.DocServiceDocument;
import com.telnyx.sdk.models.documents.DocumentUpdateParams;
import com.telnyx.sdk.models.documents.DocumentUpdateResponse;
DocumentUpdateParams params = DocumentUpdateParams.builder()
.documentId("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
.docServiceDocument(DocServiceDocument.builder().build())
.build();
DocumentUpdateResponse document = client.documents().update(params);
Delete a document
Delete a document.<br /><br />A document can only be deleted if it's not linked to a service.
DELETE /documents/{id}
import com.telnyx.sdk.models.documents.DocumentDeleteParams;
import com.telnyx.sdk.models.documents.DocumentDeleteResponse;
DocumentDeleteResponse document = client.documents().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58");
Download a document
Download a document.
GET /documents/{id}/download
import com.telnyx.sdk.core.http.HttpResponse;
import com.telnyx.sdk.models.documents.DocumentDownloadParams;
HttpResponse response = client.documents().download("6a09cdc3-8948-47f0-aa62-74ac943d6c58");
Generate a temporary download link for a document
Generates a temporary pre-signed URL that can be used to download the document directly from the storage backend without authentication.
GET /documents/{id}/download_link
import com.telnyx.sdk.models.documents.DocumentGenerateDownloadLinkParams;
import com.telnyx.sdk.models.documents.DocumentGenerateDownloadLinkResponse;
DocumentGenerateDownloadLinkResponse response = client.documents().generateDownloadLink("550e8400-e29b-41d4-a716-446655440000");
List all requirements
List all requirements with filtering, sorting, and pagination
GET /requirements
import com.telnyx.sdk.models.requirements.RequirementListPage;
import com.telnyx.sdk.models.requirements.RequirementListParams;
RequirementListPage page = client.requirements().list();
Retrieve a document requirement
Retrieve a document requirement record
GET /requirements/{id}
import com.telnyx.sdk.models.requirements.RequirementRetrieveParams;
import com.telnyx.sdk.models.requirements.RequirementRetrieveResponse;
RequirementRetrieveResponse requirement = client.requirements().retrieve("a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa");
List all requirement types
List all requirement types ordered by created_at descending
GET /requirement_types
import com.telnyx.sdk.models.requirementtypes.RequirementTypeListParams;
import com.telnyx.sdk.models.requirementtypes.RequirementTypeListResponse;
RequirementTypeListResponse requirementTypes = client.requirementTypes().list();
Retrieve a requirement types
Retrieve a requirement type by id
GET /requirement_types/{id}
import com.telnyx.sdk.models.requirementtypes.RequirementTypeRetrieveParams;
import com.telnyx.sdk.models.requirementtypes.RequirementTypeRetrieveResponse;
RequirementTypeRetrieveResponse requirementType = client.requirementTypes().retrieve("a38c217a-8019-48f8-bff6-0fdd9939075b");
Retrieve regulatory requirements
GET /regulatory_requirements
import com.telnyx.sdk.models.regulatoryrequirements.RegulatoryRequirementRetrieveParams;
import com.telnyx.sdk.models.regulatoryrequirements.RegulatoryRequirementRetrieveResponse;
RegulatoryRequirementRetrieveResponse regulatoryRequirement = client.regulatoryRequirements().retrieve();
List requirement groups
GET /requirement_groups
import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupListParams;
List<RequirementGroup> requirementGroups = client.requirementGroups().list();
Create a new requirement group
POST /requirement_groups — Required: country_code, phone_number_type, action
import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupCreateParams;
RequirementGroupCreateParams params = RequirementGroupCreateParams.builder()
.action(RequirementGroupCreateParams.Action.ORDERING)
.countryCode("US")
.phoneNumberType(RequirementGroupCreateParams.PhoneNumberType.LOCAL)
.build();
RequirementGroup requirementGroup = client.requirementGroups().create(params);
Get a single requirement group by ID
GET /requirement_groups/{id}
import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupRetrieveParams;
RequirementGroup requirementGroup = client.requirementGroups().retrieve("id");
Update requirement values in requirement group
PATCH /requirement_groups/{id}
import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupUpdateParams;
RequirementGroup requirementGroup = client.requirementGroups().update("id");
Delete a requirement group by ID
DELETE /requirement_groups/{id}
import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupDeleteParams;
RequirementGroup requirementGroup = client.requirementGroups().delete("id");
Submit a Requirement Group for Approval
POST /requirement_groups/{id}/submit_for_approval
import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupSubmitForApprovalParams;
RequirementGroup requirementGroup = client.requirementGroups().submitForApproval("id");
List all Verified Numbers
Gets a paginated list of Verified Numbers.
GET /verified_numbers
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberListPage;
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberListParams;
VerifiedNumberListPage page = client.verifiedNumbers().list();
Request phone number verification
Initiates phone number verification procedure.
POST /verified_numbers — Required: phone_number, verification_method
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberCreateParams;
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberCreateResponse;
VerifiedNumberCreateParams params = VerifiedNumberCreateParams.builder()
.phoneNumber("+15551234567")
.verificationMethod(VerifiedNumberCreateParams.VerificationMethod.SMS)
.build();
VerifiedNumberCreateResponse verifiedNumber = client.verifiedNumbers().create(params);
Retrieve a verified number
GET /verified_numbers/{phone_number}
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberDataWrapper;
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberRetrieveParams;
VerifiedNumberDataWrapper verifiedNumberDataWrapper = client.verifiedNumbers().retrieve("+15551234567");
Delete a verified number
DELETE /verified_numbers/{phone_number}
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberDataWrapper;
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberDeleteParams;
VerifiedNumberDataWrapper verifiedNumberDataWrapper = client.verifiedNumbers().delete("+15551234567");
Submit verification code
POST /verified_numbers/{phone_number}/actions/verify — Required: verification_code
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberDataWrapper;
import com.telnyx.sdk.models.verifiednumbers.actions.ActionSubmitVerificationCodeParams;
ActionSubmitVerificationCodeParams params = ActionSubmitVerificationCodeParams.builder()
.phoneNumber("+15551234567")
.verificationCode("123456")
.build();
VerifiedNumberDataWrapper verifiedNumberDataWrapper = client.verifiedNumbers().actions().submitVerificationCode(params);