telnyx-messaging-hosted-java

Telnyx Messaging Hosted - Java

Installation

<dependency> <groupId>com.telnyx.sdk</groupId> <artifactId>telnyx-java</artifactId> <version>6.26.0</version> </dependency>

// Gradle implementation("com.telnyx.sdk:telnyx-java:6.26.0")

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.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

import com.telnyx.sdk.errors.TelnyxServiceException;

try { var result = client.messages().send(params); } catch (TelnyxServiceException e) { System.err.println("API error " + e.statusCode() + ": " + e.getMessage()); if (e.statusCode() == 422) { System.err.println("Validation error — check required fields and formats"); } else if (e.statusCode() == 429) { // Rate limited — wait and retry with exponential backoff Thread.sleep(1000); } }

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

Important Notes

Phone numbers must be in E.164 format (e.g., +13125550001 ). Include the + prefix and country code. No spaces, dashes, or parentheses.
Pagination: List methods return a page. Use .autoPager() for automatic iteration: for (var item : page.autoPager()) { ... } . For manual control, use .hasNextPage() and .nextPage() .

Send an RCS message

POST /messages/rcs — Required: agent_id , to , messaging_profile_id , agent_message

Optional: mms_fallback (object), sms_fallback (object), type (enum: RCS), webhook_url (url)

import com.telnyx.sdk.models.messages.RcsAgentMessage; import com.telnyx.sdk.models.messages.rcs.RcSendParams; import com.telnyx.sdk.models.messages.rcs.RcSendResponse;

RcSendParams params = RcSendParams.builder() .agentId("Agent007") .agentMessage(RcsAgentMessage.builder().build()) .messagingProfileId("messaging_profile_id") .to("+13125551234") .build(); RcSendResponse response = client.messages().rcs().send(params);

Returns: body (object), direction (string), encoding (string), from (object), id (string), messaging_profile_id (string), organization_id (string), received_at (date-time), record_type (string), to (array[object]), type (string), wait_seconds (float)

Generate RCS deeplink

Generate a deeplink URL that can be used to start an RCS conversation with a specific agent.

GET /messages/rcs/deeplinks/{agent_id}

import com.telnyx.sdk.models.messages.rcs.RcGenerateDeeplinkParams; import com.telnyx.sdk.models.messages.rcs.RcGenerateDeeplinkResponse;

RcGenerateDeeplinkResponse response = client.messages().rcs().generateDeeplink("agent_id");

Returns: url (string)

List all RCS agents

GET /messaging/rcs/agents

import com.telnyx.sdk.models.messaging.rcs.agents.AgentListPage; import com.telnyx.sdk.models.messaging.rcs.agents.AgentListParams;

AgentListPage page = client.messaging().rcs().agents().list();

Returns: agent_id (string), agent_name (string), created_at (date-time), enabled (boolean), profile_id (uuid), updated_at (date-time), user_id (string), webhook_failover_url (url), webhook_url (url)

Retrieve an RCS agent

GET /messaging/rcs/agents/{id}

import com.telnyx.sdk.models.messaging.rcs.agents.AgentRetrieveParams; import com.telnyx.sdk.models.rcsagents.RcsAgentResponse;

RcsAgentResponse rcsAgentResponse = client.messaging().rcs().agents().retrieve("id");

Returns: agent_id (string), agent_name (string), created_at (date-time), enabled (boolean), profile_id (uuid), updated_at (date-time), user_id (string), webhook_failover_url (url), webhook_url (url)

Modify an RCS agent

PATCH /messaging/rcs/agents/{id}

Optional: profile_id (uuid), webhook_failover_url (url), webhook_url (url)

import com.telnyx.sdk.models.messaging.rcs.agents.AgentUpdateParams; import com.telnyx.sdk.models.rcsagents.RcsAgentResponse;

RcsAgentResponse rcsAgentResponse = client.messaging().rcs().agents().update("id");

Returns: agent_id (string), agent_name (string), created_at (date-time), enabled (boolean), profile_id (uuid), updated_at (date-time), user_id (string), webhook_failover_url (url), webhook_url (url)

Check RCS capabilities (batch)

POST /messaging/rcs/bulk_capabilities — Required: agent_id , phone_numbers

import com.telnyx.sdk.models.messaging.rcs.RcListBulkCapabilitiesParams; import com.telnyx.sdk.models.messaging.rcs.RcListBulkCapabilitiesResponse;

RcListBulkCapabilitiesParams params = RcListBulkCapabilitiesParams.builder() .agentId("TestAgent") .addPhoneNumber("+13125551234") .build(); RcListBulkCapabilitiesResponse response = client.messaging().rcs().listBulkCapabilities(params);

Returns: agent_id (string), agent_name (string), features (array[string]), phone_number (string), record_type (enum: rcs.capabilities)

Check RCS capabilities

GET /messaging/rcs/capabilities/{agent_id}/{phone_number}

import com.telnyx.sdk.models.messaging.rcs.RcRetrieveCapabilitiesParams; import com.telnyx.sdk.models.messaging.rcs.RcRetrieveCapabilitiesResponse;

RcRetrieveCapabilitiesParams params = RcRetrieveCapabilitiesParams.builder() .agentId("agent_id") .phoneNumber("phone_number") .build(); RcRetrieveCapabilitiesResponse response = client.messaging().rcs().retrieveCapabilities(params);

Returns: agent_id (string), agent_name (string), features (array[string]), phone_number (string), record_type (enum: rcs.capabilities)

Add RCS test number

Adds a test phone number to an RCS agent for testing purposes.

PUT /messaging/rcs/test_number_invite/{id}/{phone_number}

import com.telnyx.sdk.models.messaging.rcs.RcInviteTestNumberParams; import com.telnyx.sdk.models.messaging.rcs.RcInviteTestNumberResponse;

RcInviteTestNumberParams params = RcInviteTestNumberParams.builder() .id("id") .phoneNumber("phone_number") .build(); RcInviteTestNumberResponse response = client.messaging().rcs().inviteTestNumber(params);

Returns: agent_id (string), phone_number (string), record_type (enum: rcs.test_number_invite), status (string)

List messaging hosted number orders

GET /messaging_hosted_number_orders

import com.telnyx.sdk.models.messaginghostednumberorders.MessagingHostedNumberOrderListPage; import com.telnyx.sdk.models.messaginghostednumberorders.MessagingHostedNumberOrderListParams;

MessagingHostedNumberOrderListPage page = client.messagingHostedNumberOrders().list();

Returns: id (uuid), messaging_profile_id (string | null), phone_numbers (array[object]), record_type (string), status (enum: carrier_rejected, compliance_review_failed, deleted, failed, incomplete_documentation, incorrect_billing_information, ineligible_carrier, loa_file_invalid, loa_file_successful, pending, provisioning, successful)

Create a messaging hosted number order

POST /messaging_hosted_number_orders

Optional: messaging_profile_id (string), phone_numbers (array[string])

import com.telnyx.sdk.models.messaginghostednumberorders.MessagingHostedNumberOrderCreateParams; import com.telnyx.sdk.models.messaginghostednumberorders.MessagingHostedNumberOrderCreateResponse;

MessagingHostedNumberOrderCreateResponse messagingHostedNumberOrder = client.messagingHostedNumberOrders().create();

Check hosted messaging eligibility

POST /messaging_hosted_number_orders/eligibility_numbers_check — Required: phone_numbers

import com.telnyx.sdk.models.messaginghostednumberorders.MessagingHostedNumberOrderCheckEligibilityParams; import com.telnyx.sdk.models.messaginghostednumberorders.MessagingHostedNumberOrderCheckEligibilityResponse;

MessagingHostedNumberOrderCheckEligibilityParams params = MessagingHostedNumberOrderCheckEligibilityParams.builder() .addPhoneNumber("string") .build(); MessagingHostedNumberOrderCheckEligibilityResponse response = client.messagingHostedNumberOrders().checkEligibility(params);

Returns: phone_numbers (array[object])

Retrieve a messaging hosted number order

GET /messaging_hosted_number_orders/{id}

import com.telnyx.sdk.models.messaginghostednumberorders.MessagingHostedNumberOrderRetrieveParams; import com.telnyx.sdk.models.messaginghostednumberorders.MessagingHostedNumberOrderRetrieveResponse;

MessagingHostedNumberOrderRetrieveResponse messagingHostedNumberOrder = client.messagingHostedNumberOrders().retrieve("id");

Delete a messaging hosted number order

Delete a messaging hosted number order and all associated phone numbers.

DELETE /messaging_hosted_number_orders/{id}

import com.telnyx.sdk.models.messaginghostednumberorders.MessagingHostedNumberOrderDeleteParams; import com.telnyx.sdk.models.messaginghostednumberorders.MessagingHostedNumberOrderDeleteResponse;

MessagingHostedNumberOrderDeleteResponse messagingHostedNumberOrder = client.messagingHostedNumberOrders().delete("id");

Upload hosted number document

POST /messaging_hosted_number_orders/{id}/actions/file_upload

import com.telnyx.sdk.models.messaginghostednumberorders.actions.ActionUploadFileParams; import com.telnyx.sdk.models.messaginghostednumberorders.actions.ActionUploadFileResponse;

ActionUploadFileResponse response = client.messagingHostedNumberOrders().actions().uploadFile("id");

Validate hosted number codes

Validate the verification codes sent to the numbers of the hosted order. The verification codes must be created in the verification codes endpoint.

POST /messaging_hosted_number_orders/{id}/validation_codes — Required: verification_codes

import com.telnyx.sdk.models.messaginghostednumberorders.MessagingHostedNumberOrderValidateCodesParams; import com.telnyx.sdk.models.messaginghostednumberorders.MessagingHostedNumberOrderValidateCodesResponse;

MessagingHostedNumberOrderValidateCodesParams params = MessagingHostedNumberOrderValidateCodesParams.builder() .id("id") .addVerificationCode(MessagingHostedNumberOrderValidateCodesParams.VerificationCode.builder() .code("code") .phoneNumber("phone_number") .build()) .build(); MessagingHostedNumberOrderValidateCodesResponse response = client.messagingHostedNumberOrders().validateCodes(params);

Returns: order_id (uuid), phone_numbers (array[object])

Create hosted number verification codes

Create verification codes to validate numbers of the hosted order. The verification codes will be sent to the numbers of the hosted order.

POST /messaging_hosted_number_orders/{id}/verification_codes — Required: phone_numbers , verification_method

import com.telnyx.sdk.models.messaginghostednumberorders.MessagingHostedNumberOrderCreateVerificationCodesParams; import com.telnyx.sdk.models.messaginghostednumberorders.MessagingHostedNumberOrderCreateVerificationCodesResponse;

MessagingHostedNumberOrderCreateVerificationCodesParams params = MessagingHostedNumberOrderCreateVerificationCodesParams.builder() .id("id") .addPhoneNumber("string") .verificationMethod(MessagingHostedNumberOrderCreateVerificationCodesParams.VerificationMethod.SMS) .build(); MessagingHostedNumberOrderCreateVerificationCodesResponse response = client.messagingHostedNumberOrders().createVerificationCodes(params);

Returns: error (string), phone_number (string), type (enum: sms, call), verification_code_id (uuid)

Delete a messaging hosted number

DELETE /messaging_hosted_numbers/{id}

import com.telnyx.sdk.models.messaginghostednumbers.MessagingHostedNumberDeleteParams; import com.telnyx.sdk.models.messaginghostednumbers.MessagingHostedNumberDeleteResponse;

MessagingHostedNumberDeleteResponse messagingHostedNumber = client.messagingHostedNumbers().delete("id");

List Verification Requests

Get a list of previously-submitted tollfree verification requests

GET /messaging_tollfree/verification/requests

import com.telnyx.sdk.models.messagingtollfree.verification.requests.RequestListPage; import com.telnyx.sdk.models.messagingtollfree.verification.requests.RequestListParams;

RequestListParams params = RequestListParams.builder() .page(1L) .pageSize(1L) .build(); RequestListPage page = client.messagingTollfree().verification().requests().list(params);

Returns: records (array[object]), total_records (integer)

Submit Verification Request

Submit a new tollfree verification request

POST /messaging_tollfree/verification/requests — Required: businessName , corporateWebsite , businessAddr1 , businessCity , businessState , businessZip , businessContactFirstName , businessContactLastName , businessContactEmail , businessContactPhone , messageVolume , phoneNumbers , useCase , useCaseSummary , productionMessageContent , optInWorkflow , optInWorkflowImageURLs , additionalInformation

Optional: ageGatedContent (boolean), businessAddr2 (string), businessRegistrationCountry (string | null), businessRegistrationNumber (string | null), businessRegistrationType (string | null), campaignVerifyAuthorizationToken (string | null), doingBusinessAs (string | null), entityType (object), helpMessageResponse (string | null), isvReseller (string | null), optInConfirmationResponse (string | null), optInKeywords (string | null), privacyPolicyURL (string | null), termsAndConditionURL (string | null), webhookUrl (string)

import com.telnyx.sdk.models.messagingtollfree.verification.requests.RequestCreateParams; import com.telnyx.sdk.models.messagingtollfree.verification.requests.TfPhoneNumber; import com.telnyx.sdk.models.messagingtollfree.verification.requests.TfVerificationRequest; import com.telnyx.sdk.models.messagingtollfree.verification.requests.Url; import com.telnyx.sdk.models.messagingtollfree.verification.requests.UseCaseCategories; import com.telnyx.sdk.models.messagingtollfree.verification.requests.VerificationRequestEgress; import com.telnyx.sdk.models.messagingtollfree.verification.requests.Volume;

TfVerificationRequest params = TfVerificationRequest.builder() .additionalInformation("additionalInformation") .businessAddr1("600 Congress Avenue") .businessCity("Austin") .businessContactEmail("email@example.com") .businessContactFirstName("John") .businessContactLastName("Doe") .businessContactPhone("+18005550100") .businessName("Telnyx LLC") .businessState("Texas") .businessZip("78701") .corporateWebsite("http://example.com") .messageVolume(Volume.V_100000) .optInWorkflow("User signs into the Telnyx portal, enters a number and is prompted to select whether they want to use 2FA verification for security purposes. If they've opted in a confirmation message is sent out to the handset") .addOptInWorkflowImageUrl(Url.builder() .url("https://telnyx.com/sign-up") .build()) .addOptInWorkflowImageUrl(Url.builder() .url("https://telnyx.com/company/data-privacy") .build()) .addPhoneNumber(TfPhoneNumber.builder() .phoneNumber("+18773554398") .build()) .addPhoneNumber(TfPhoneNumber.builder() .phoneNumber("+18773554399") .build()) .productionMessageContent("Your Telnyx OTP is XXXX") .useCase(UseCaseCategories.TWO_FA) .useCaseSummary("This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal") .build(); VerificationRequestEgress verificationRequestEgress = client.messagingTollfree().verification().requests().create(params);

Returns: additionalInformation (string), ageGatedContent (boolean), businessAddr1 (string), businessAddr2 (string), businessCity (string), businessContactEmail (string), businessContactFirstName (string), businessContactLastName (string), businessContactPhone (string), businessName (string), businessRegistrationCountry (string), businessRegistrationNumber (string), businessRegistrationType (string), businessState (string), businessZip (string), campaignVerifyAuthorizationToken (string | null), corporateWebsite (string), doingBusinessAs (string), entityType (object), helpMessageResponse (string), id (uuid), isvReseller (string), messageVolume (object), optInConfirmationResponse (string), optInKeywords (string), optInWorkflow (string), optInWorkflowImageURLs (array[object]), phoneNumbers (array[object]), privacyPolicyURL (string), productionMessageContent (string), termsAndConditionURL (string), useCase (object), useCaseSummary (string), verificationRequestId (string), verificationStatus (object), webhookUrl (string)

Get Verification Request

Get a single verification request by its ID.

GET /messaging_tollfree/verification/requests/{id}

import com.telnyx.sdk.models.messagingtollfree.verification.requests.RequestRetrieveParams; import com.telnyx.sdk.models.messagingtollfree.verification.requests.VerificationRequestStatus;

VerificationRequestStatus verificationRequestStatus = client.messagingTollfree().verification().requests().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");

Returns: additionalInformation (string), ageGatedContent (boolean), businessAddr1 (string), businessAddr2 (string), businessCity (string), businessContactEmail (string), businessContactFirstName (string), businessContactLastName (string), businessContactPhone (string), businessName (string), businessRegistrationCountry (string), businessRegistrationNumber (string), businessRegistrationType (string), businessState (string), businessZip (string), campaignVerifyAuthorizationToken (string | null), corporateWebsite (string), createdAt (date-time), doingBusinessAs (string), entityType (object), helpMessageResponse (string), id (uuid), isvReseller (string), messageVolume (object), optInConfirmationResponse (string), optInKeywords (string), optInWorkflow (string), optInWorkflowImageURLs (array[object]), phoneNumbers (array[object]), privacyPolicyURL (string), productionMessageContent (string), reason (string), termsAndConditionURL (string), updatedAt (date-time), useCase (object), useCaseSummary (string), verificationStatus (object), webhookUrl (string)

Update Verification Request

Update an existing tollfree verification request. This is particularly useful when there are pending customer actions to be taken.

PATCH /messaging_tollfree/verification/requests/{id} — Required: businessName , corporateWebsite , businessAddr1 , businessCity , businessState , businessZip , businessContactFirstName , businessContactLastName , businessContactEmail , businessContactPhone , messageVolume , phoneNumbers , useCase , useCaseSummary , productionMessageContent , optInWorkflow , optInWorkflowImageURLs , additionalInformation

import com.telnyx.sdk.models.messagingtollfree.verification.requests.RequestUpdateParams; import com.telnyx.sdk.models.messagingtollfree.verification.requests.TfPhoneNumber; import com.telnyx.sdk.models.messagingtollfree.verification.requests.TfVerificationRequest; import com.telnyx.sdk.models.messagingtollfree.verification.requests.Url; import com.telnyx.sdk.models.messagingtollfree.verification.requests.UseCaseCategories; import com.telnyx.sdk.models.messagingtollfree.verification.requests.VerificationRequestEgress; import com.telnyx.sdk.models.messagingtollfree.verification.requests.Volume;

RequestUpdateParams params = RequestUpdateParams.builder() .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") .tfVerificationRequest(TfVerificationRequest.builder() .additionalInformation("additionalInformation") .businessAddr1("600 Congress Avenue") .businessCity("Austin") .businessContactEmail("email@example.com") .businessContactFirstName("John") .businessContactLastName("Doe") .businessContactPhone("+18005550100") .businessName("Telnyx LLC") .businessState("Texas") .businessZip("78701") .corporateWebsite("http://example.com") .messageVolume(Volume.V_100000) .optInWorkflow("User signs into the Telnyx portal, enters a number and is prompted to select whether they want to use 2FA verification for security purposes. If they've opted in a confirmation message is sent out to the handset") .addOptInWorkflowImageUrl(Url.builder() .url("https://telnyx.com/sign-up") .build()) .addOptInWorkflowImageUrl(Url.builder() .url("https://telnyx.com/company/data-privacy") .build()) .addPhoneNumber(TfPhoneNumber.builder() .phoneNumber("+18773554398") .build()) .addPhoneNumber(TfPhoneNumber.builder() .phoneNumber("+18773554399") .build()) .productionMessageContent("Your Telnyx OTP is XXXX") .useCase(UseCaseCategories.TWO_FA) .useCaseSummary("This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal") .build()) .build(); VerificationRequestEgress verificationRequestEgress = client.messagingTollfree().verification().requests().update(params);

Delete Verification Request

Delete a verification request

A request may only be deleted when when the request is in the "rejected" state. * HTTP 200 : request successfully deleted

HTTP 400 : request exists but can't be deleted (i.e. not rejected)
HTTP 404 : request unknown or already deleted

DELETE /messaging_tollfree/verification/requests/{id}

import com.telnyx.sdk.models.messagingtollfree.verification.requests.RequestDeleteParams;

client.messagingTollfree().verification().requests().delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");

Get Verification Request Status History

Get the history of status changes for a verification request. Returns a paginated list of historical status changes including the reason for each change and when it occurred.

GET /messaging_tollfree/verification/requests/{id}/status_history

import com.telnyx.sdk.models.messagingtollfree.verification.requests.RequestRetrieveStatusHistoryParams; import com.telnyx.sdk.models.messagingtollfree.verification.requests.RequestRetrieveStatusHistoryResponse;

RequestRetrieveStatusHistoryParams params = RequestRetrieveStatusHistoryParams.builder() .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") .pageNumber(1L) .pageSize(1L) .build(); RequestRetrieveStatusHistoryResponse response = client.messagingTollfree().verification().requests().retrieveStatusHistory(params);

Returns: records (array[object]), total_records (integer)

List messaging URL domains

GET /messaging_url_domains

import com.telnyx.sdk.models.messagingurldomains.MessagingUrlDomainListPage; import com.telnyx.sdk.models.messagingurldomains.MessagingUrlDomainListParams;

MessagingUrlDomainListPage page = client.messagingUrlDomains().list();

Returns: id (string), record_type (string), url_domain (string), use_case (string)

telnyx-messaging-hosted-java

Safety Notice

Copy this and send it to your AI assistant to learn

Source Transparency

Related Skills

telnyx-ai-assistants-javascript

telnyx-voice-media-javascript

telnyx-numbers-javascript