telnyx-10dlc-java

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. --> # Telnyx 10Dlc - 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. ## List Brands This endpoint is used to list all brands associated with your organization. `GET /10dlc/brand` ```java import com.telnyx.sdk.models.messaging10dlc.brand.BrandListPage; import com.telnyx.sdk.models.messaging10dlc.brand.BrandListParams; BrandListPage page = client.messaging10dlc().brand().list(); ``` ## Create Brand This endpoint is used to create a new brand. `POST /10dlc/brand` — Required: `entityType`, `displayName`, `country`, `email`, `vertical` ```java import com.telnyx.sdk.models.messaging10dlc.brand.BrandCreateParams; import com.telnyx.sdk.models.messaging10dlc.brand.EntityType; import com.telnyx.sdk.models.messaging10dlc.brand.TelnyxBrand; import com.telnyx.sdk.models.messaging10dlc.brand.Vertical; BrandCreateParams params = BrandCreateParams.builder() .country("US") .displayName("ABC Mobile") .email("email") .entityType(EntityType.PRIVATE_PROFIT) .vertical(Vertical.TECHNOLOGY) .build(); TelnyxBrand telnyxBrand = client.messaging10dlc().brand().create(params); ``` ## Get Brand Retrieve a brand by `brandId`. `GET /10dlc/brand/{brandId}` ```java import com.telnyx.sdk.models.messaging10dlc.brand.BrandRetrieveParams; import com.telnyx.sdk.models.messaging10dlc.brand.BrandRetrieveResponse; BrandRetrieveResponse brand = client.messaging10dlc().brand().retrieve("brandId"); ``` ## Update Brand Update a brand's attributes by `brandId`. `PUT /10dlc/brand/{brandId}` — Required: `entityType`, `displayName`, `country`, `email`, `vertical` ```java import com.telnyx.sdk.models.messaging10dlc.brand.BrandUpdateParams; import com.telnyx.sdk.models.messaging10dlc.brand.EntityType; import com.telnyx.sdk.models.messaging10dlc.brand.TelnyxBrand; import com.telnyx.sdk.models.messaging10dlc.brand.Vertical; BrandUpdateParams params = BrandUpdateParams.builder() .brandId("brandId") .country("US") .displayName("ABC Mobile") .email("email") .entityType(EntityType.PRIVATE_PROFIT) .vertical(Vertical.TECHNOLOGY) .build(); TelnyxBrand telnyxBrand = client.messaging10dlc().brand().update(params); ``` ## Delete Brand Delete Brand. `DELETE /10dlc/brand/{brandId}` ```java import com.telnyx.sdk.models.messaging10dlc.brand.BrandDeleteParams; client.messaging10dlc().brand().delete("brandId"); ``` ## Resend brand 2FA email `POST /10dlc/brand/{brandId}/2faEmail` ```java import com.telnyx.sdk.models.messaging10dlc.brand.BrandResend2faEmailParams; client.messaging10dlc().brand().resend2faEmail("brandId"); ``` ## List External Vettings Get list of valid external vetting record for a given brand `GET /10dlc/brand/{brandId}/externalVetting` ```java import com.telnyx.sdk.models.messaging10dlc.brand.externalvetting.ExternalVettingListParams; import com.telnyx.sdk.models.messaging10dlc.brand.externalvetting.ExternalVettingListResponse; List<ExternalVettingListResponse> externalVettings = client.messaging10dlc().brand().externalVetting().list("brandId"); ``` ## Order Brand External Vetting Order new external vetting for a brand `POST /10dlc/brand/{brandId}/externalVetting` — Required: `evpId`, `vettingClass` ```java import com.telnyx.sdk.models.messaging10dlc.brand.externalvetting.ExternalVettingOrderParams; import com.telnyx.sdk.models.messaging10dlc.brand.externalvetting.ExternalVettingOrderResponse; ExternalVettingOrderParams params = ExternalVettingOrderParams.builder() .brandId("brandId") .evpId("evpId") .vettingClass("vettingClass") .build(); ExternalVettingOrderResponse response = client.messaging10dlc().brand().externalVetting().order(params); ``` ## Import External Vetting Record This operation can be used to import an external vetting record from a TCR-approved vetting provider. `PUT /10dlc/brand/{brandId}/externalVetting` — Required: `evpId`, `vettingId` ```java import com.telnyx.sdk.models.messaging10dlc.brand.externalvetting.ExternalVettingImportsParams; import com.telnyx.sdk.models.messaging10dlc.brand.externalvetting.ExternalVettingImportsResponse; ExternalVettingImportsParams params = ExternalVettingImportsParams.builder() .brandId("brandId") .evpId("evpId") .vettingId("vettingId") .build(); ExternalVettingImportsResponse response = client.messaging10dlc().brand().externalVetting().imports(params); ``` ## Revet Brand This operation allows you to revet the brand. `PUT /10dlc/brand/{brandId}/revet` ```java import com.telnyx.sdk.models.messaging10dlc.brand.BrandRevetParams; import com.telnyx.sdk.models.messaging10dlc.brand.TelnyxBrand; TelnyxBrand telnyxBrand = client.messaging10dlc().brand().revet("brandId"); ``` ## Get Brand SMS OTP Status by Brand ID Query the status of an SMS OTP (One-Time Password) for Sole Proprietor brand verification using the Brand ID. `GET /10dlc/brand/{brandId}/smsOtp` ```java import com.telnyx.sdk.models.messaging10dlc.brand.BrandRetrieveSmsOtpStatusParams; import com.telnyx.sdk.models.messaging10dlc.brand.BrandRetrieveSmsOtpStatusResponse; BrandRetrieveSmsOtpStatusResponse response = client.messaging10dlc().brand().retrieveSmsOtpStatus("4b20019b-043a-78f8-0657-b3be3f4b4002"); ``` ## Trigger Brand SMS OTP Trigger or re-trigger an SMS OTP (One-Time Password) for Sole Proprietor brand verification. `POST /10dlc/brand/{brandId}/smsOtp` — Required: `pinSms`, `successSms` ```java import com.telnyx.sdk.models.messaging10dlc.brand.BrandTriggerSmsOtpParams; import com.telnyx.sdk.models.messaging10dlc.brand.BrandTriggerSmsOtpResponse; BrandTriggerSmsOtpParams params = BrandTriggerSmsOtpParams.builder() .brandId("4b20019b-043a-78f8-0657-b3be3f4b4002") .pinSms("Your PIN is @OTP_PIN@") .successSms("Verification successful!") .build(); BrandTriggerSmsOtpResponse response = client.messaging10dlc().brand().triggerSmsOtp(params); ``` ## Verify Brand SMS OTP Verify the SMS OTP (One-Time Password) for Sole Proprietor brand verification. `PUT /10dlc/brand/{brandId}/smsOtp` — Required: `otpPin` ```java import com.telnyx.sdk.models.messaging10dlc.brand.BrandVerifySmsOtpParams; BrandVerifySmsOtpParams params = BrandVerifySmsOtpParams.builder() .brandId("4b20019b-043a-78f8-0657-b3be3f4b4002") .otpPin("123456") .build(); client.messaging10dlc().brand().verifySmsOtp(params); ``` ## Get Brand Feedback By Id Get feedback about a brand by ID. `GET /10dlc/brand_feedback/{brandId}` ```java import com.telnyx.sdk.models.messaging10dlc.brand.BrandGetFeedbackParams; import com.telnyx.sdk.models.messaging10dlc.brand.BrandGetFeedbackResponse; BrandGetFeedbackResponse response = client.messaging10dlc().brand().getFeedback("brandId"); ``` ## Submit Campaign Before creating a campaign, use the [Qualify By Usecase endpoint](https://developers.telnyx.com/api-reference/campaign/qualify-by-usecase) to ensure that the brand you want to assign a new campaign... `POST /10dlc/campaignBuilder` — Required: `brandId`, `description`, `usecase` ```java import com.telnyx.sdk.models.messaging10dlc.campaign.TelnyxCampaignCsp; import com.telnyx.sdk.models.messaging10dlc.campaignbuilder.CampaignBuilderSubmitParams; CampaignBuilderSubmitParams params = CampaignBuilderSubmitParams.builder() .brandId("brandId") .description("description") .usecase("usecase") .build(); TelnyxCampaignCsp telnyxCampaignCsp = client.messaging10dlc().campaignBuilder().submit(params); ``` ## Qualify By Usecase This endpoint allows you to see whether or not the supplied brand is suitable for your desired campaign use case. `GET /10dlc/campaignBuilder/brand/{brandId}/usecase/{usecase}` ```java import com.telnyx.sdk.models.messaging10dlc.campaignbuilder.brand.BrandQualifyByUsecaseParams; import com.telnyx.sdk.models.messaging10dlc.campaignbuilder.brand.BrandQualifyByUsecaseResponse; BrandQualifyByUsecaseParams params = BrandQualifyByUsecaseParams.builder() .brandId("brandId") .usecase("usecase") .build(); BrandQualifyByUsecaseResponse response = client.messaging10dlc().campaignBuilder().brand().qualifyByUsecase(params); ``` ## List Campaigns Retrieve a list of campaigns associated with a supplied `brandId`. `GET /10dlc/campaign` ```java import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignListPage; import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignListParams; CampaignListParams params = CampaignListParams.builder() .brandId("brandId") .build(); CampaignListPage page = client.messaging10dlc().campaign().list(params); ``` ## Get campaign Retrieve campaign details by `campaignId`. `GET /10dlc/campaign/{campaignId}` ```java import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignRetrieveParams; import com.telnyx.sdk.models.messaging10dlc.campaign.TelnyxCampaignCsp; TelnyxCampaignCsp telnyxCampaignCsp = client.messaging10dlc().campaign().retrieve("campaignId"); ``` ## Update campaign Update a campaign's properties by `campaignId`. `PUT /10dlc/campaign/{campaignId}` ```java import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignUpdateParams; import com.telnyx.sdk.models.messaging10dlc.campaign.TelnyxCampaignCsp; TelnyxCampaignCsp telnyxCampaignCsp = client.messaging10dlc().campaign().update("campaignId"); ``` ## Deactivate campaign Terminate a campaign. `DELETE /10dlc/campaign/{campaignId}` ```java import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignDeactivateParams; import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignDeactivateResponse; CampaignDeactivateResponse response = client.messaging10dlc().campaign().deactivate("campaignId"); ``` ## Submit campaign appeal for manual review Submits an appeal for rejected native campaigns in TELNYX_FAILED or MNO_REJECTED status. `POST /10dlc/campaign/{campaignId}/appeal` — Required: `appeal_reason` ```java import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignSubmitAppealParams; import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignSubmitAppealResponse; CampaignSubmitAppealParams params = CampaignSubmitAppealParams.builder() .campaignId("5eb13888-32b7-4cab-95e6-d834dde21d64") .appealReason("The website has been updated to include the required privacy policy and terms of service.") .build(); CampaignSubmitAppealResponse response = client.messaging10dlc().campaign().submitAppeal(params); ``` ## Get Campaign Mno Metadata Get the campaign metadata for each MNO it was submitted to. `GET /10dlc/campaign/{campaignId}/mnoMetadata` ```java import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignGetMnoMetadataParams; import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignGetMnoMetadataResponse; CampaignGetMnoMetadataResponse response = client.messaging10dlc().campaign().getMnoMetadata("campaignId"); ``` ## Get campaign operation status Retrieve campaign's operation status at MNO level. `GET /10dlc/campaign/{campaignId}/operationStatus` ```java import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignGetOperationStatusParams; import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignGetOperationStatusResponse; CampaignGetOperationStatusResponse response = client.messaging10dlc().campaign().getOperationStatus("campaignId"); ``` ## Get OSR campaign attributes `GET /10dlc/campaign/{campaignId}/osr_attributes` ```java import com.telnyx.sdk.models.messaging10dlc.campaign.osr.OsrGetAttributesParams; import com.telnyx.sdk.models.messaging10dlc.campaign.osr.OsrGetAttributesResponse; OsrGetAttributesResponse response = client.messaging10dlc().campaign().osr().getAttributes("campaignId"); ``` ## Get Sharing Status `GET /10dlc/campaign/{campaignId}/sharing` ```java import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignGetSharingStatusParams; import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignGetSharingStatusResponse; CampaignGetSharingStatusResponse response = client.messaging10dlc().campaign().getSharingStatus("campaignId"); ``` ## Accept Shared Campaign Manually accept a campaign shared with Telnyx `POST /10dlc/campaign/acceptSharing/{campaignId}` ```java import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignAcceptSharingParams; import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignAcceptSharingResponse; CampaignAcceptSharingResponse response = client.messaging10dlc().campaign().acceptSharing("C26F1KLZN"); ``` ## Get Campaign Cost `GET /10dlc/campaign/usecase_cost` ```java import com.telnyx.sdk.models.messaging10dlc.campaign.usecase.UsecaseGetCostParams; import com.telnyx.sdk.models.messaging10dlc.campaign.usecase.UsecaseGetCostResponse; UsecaseGetCostParams params = UsecaseGetCostParams.builder() .usecase("usecase")