telnyx-sip-integrations-java

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. --> # Telnyx Sip Integrations - 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 all call recordings Returns a list of your call recordings. `GET /recordings` ```java import com.telnyx.sdk.models.recordings.RecordingListPage; import com.telnyx.sdk.models.recordings.RecordingListParams; RecordingListPage page = client.recordings().list(); ``` ## Retrieve a call recording Retrieves the details of an existing call recording. `GET /recordings/{recording_id}` ```java import com.telnyx.sdk.models.recordings.RecordingRetrieveParams; import com.telnyx.sdk.models.recordings.RecordingRetrieveResponse; RecordingRetrieveResponse recording = client.recordings().retrieve("recording_id"); ``` ## Delete a call recording Permanently deletes a call recording. `DELETE /recordings/{recording_id}` ```java import com.telnyx.sdk.models.recordings.RecordingDeleteParams; import com.telnyx.sdk.models.recordings.RecordingDeleteResponse; RecordingDeleteResponse recording = client.recordings().delete("recording_id"); ``` ## Delete a list of call recordings Permanently deletes a list of call recordings. `POST /recordings/actions/delete` ```java import com.telnyx.sdk.models.recordings.actions.ActionDeleteParams; ActionDeleteParams params = ActionDeleteParams.builder() .addId("428c31b6-7af4-4bcb-b7f5-5013ef9657c1") .addId("428c31b6-7af4-4bcb-b7f5-5013ef9657c2") .build(); client.recordings().actions().delete(params); ``` ## List all recording transcriptions Returns a list of your recording transcriptions. `GET /recording_transcriptions` ```java import com.telnyx.sdk.models.recordingtranscriptions.RecordingTranscriptionListParams; import com.telnyx.sdk.models.recordingtranscriptions.RecordingTranscriptionListResponse; RecordingTranscriptionListResponse recordingTranscriptions = client.recordingTranscriptions().list(); ``` ## Retrieve a recording transcription Retrieves the details of an existing recording transcription. `GET /recording_transcriptions/{recording_transcription_id}` ```java import com.telnyx.sdk.models.recordingtranscriptions.RecordingTranscriptionRetrieveParams; import com.telnyx.sdk.models.recordingtranscriptions.RecordingTranscriptionRetrieveResponse; RecordingTranscriptionRetrieveResponse recordingTranscription = client.recordingTranscriptions().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Delete a recording transcription Permanently deletes a recording transcription. `DELETE /recording_transcriptions/{recording_transcription_id}` ```java import com.telnyx.sdk.models.recordingtranscriptions.RecordingTranscriptionDeleteParams; import com.telnyx.sdk.models.recordingtranscriptions.RecordingTranscriptionDeleteResponse; RecordingTranscriptionDeleteResponse recordingTranscription = client.recordingTranscriptions().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Retrieve a stored credential Returns the information about custom storage credentials. `GET /custom_storage_credentials/{connection_id}` ```java import com.telnyx.sdk.models.customstoragecredentials.CustomStorageCredentialRetrieveParams; import com.telnyx.sdk.models.customstoragecredentials.CustomStorageCredentialRetrieveResponse; CustomStorageCredentialRetrieveResponse customStorageCredential = client.customStorageCredentials().retrieve("connection_id"); ``` ## Create a custom storage credential Creates a custom storage credentials configuration. `POST /custom_storage_credentials/{connection_id}` ```java import com.telnyx.sdk.models.customstoragecredentials.CustomStorageConfiguration; import com.telnyx.sdk.models.customstoragecredentials.CustomStorageCredentialCreateParams; import com.telnyx.sdk.models.customstoragecredentials.CustomStorageCredentialCreateResponse; import com.telnyx.sdk.models.customstoragecredentials.GcsConfigurationData; CustomStorageCredentialCreateParams params = CustomStorageCredentialCreateParams.builder() .connectionId("connection_id") .customStorageConfiguration(CustomStorageConfiguration.builder() .backend(CustomStorageConfiguration.Backend.GCS) .configuration(GcsConfigurationData.builder() .backend(GcsConfigurationData.Backend.GCS) .build()) .build()) .build(); CustomStorageCredentialCreateResponse customStorageCredential = client.customStorageCredentials().create(params); ``` ## Update a stored credential Updates a stored custom credentials configuration. `PUT /custom_storage_credentials/{connection_id}` ```java import com.telnyx.sdk.models.customstoragecredentials.CustomStorageConfiguration; import com.telnyx.sdk.models.customstoragecredentials.CustomStorageCredentialUpdateParams; import com.telnyx.sdk.models.customstoragecredentials.CustomStorageCredentialUpdateResponse; import com.telnyx.sdk.models.customstoragecredentials.GcsConfigurationData; CustomStorageCredentialUpdateParams params = CustomStorageCredentialUpdateParams.builder() .connectionId("connection_id") .customStorageConfiguration(CustomStorageConfiguration.builder() .backend(CustomStorageConfiguration.Backend.GCS) .configuration(GcsConfigurationData.builder() .backend(GcsConfigurationData.Backend.GCS) .build()) .build()) .build(); CustomStorageCredentialUpdateResponse customStorageCredential = client.customStorageCredentials().update(params); ``` ## Delete a stored credential Deletes a stored custom credentials configuration. `DELETE /custom_storage_credentials/{connection_id}` ```java import com.telnyx.sdk.models.customstoragecredentials.CustomStorageCredentialDeleteParams; client.customStorageCredentials().delete("connection_id"); ``` ## Retrieve stored Dialogflow Connection Return details of the Dialogflow connection associated with the given CallControl connection. `GET /dialogflow_connections/{connection_id}` ```java import com.telnyx.sdk.models.dialogflowconnections.DialogflowConnectionRetrieveParams; import com.telnyx.sdk.models.dialogflowconnections.DialogflowConnectionRetrieveResponse; DialogflowConnectionRetrieveResponse dialogflowConnection = client.dialogflowConnections().retrieve("connection_id"); ``` ## Create a Dialogflow Connection Save Dialogflow Credentiails to Telnyx, so it can be used with other Telnyx services. `POST /dialogflow_connections/{connection_id}` ```java import com.telnyx.sdk.core.JsonValue; import com.telnyx.sdk.models.dialogflowconnections.DialogflowConnectionCreateParams; import com.telnyx.sdk.models.dialogflowconnections.DialogflowConnectionCreateResponse; DialogflowConnectionCreateParams params = DialogflowConnectionCreateParams.builder() .connectionId("connection_id") .serviceAccount(DialogflowConnectionCreateParams.ServiceAccount.builder() .putAdditionalProperty("type", JsonValue.from("bar")) .putAdditionalProperty("project_id", JsonValue.from("bar")) .putAdditionalProperty("private_key_id", JsonValue.from("bar")) .putAdditionalProperty("private_key", JsonValue.from("bar")) .putAdditionalProperty("client_email", JsonValue.from("bar")) .putAdditionalProperty("client_id", JsonValue.from("bar")) .putAdditionalProperty("auth_uri", JsonValue.from("bar")) .putAdditionalProperty("token_uri", JsonValue.from("bar")) .putAdditionalProperty("auth_provider_x509_cert_url", JsonValue.from("bar")) .putAdditionalProperty("client_x509_cert_url", JsonValue.from("bar")) .build()) .build(); DialogflowConnectionCreateResponse dialogflowConnection = client.dialogflowConnections().create(params); ``` ## Update stored Dialogflow Connection Updates a stored Dialogflow Connection. `PUT /dialogflow_connections/{connection_id}` ```java import com.telnyx.sdk.core.JsonValue; import com.telnyx.sdk.models.dialogflowconnections.DialogflowConnectionUpdateParams; import com.telnyx.sdk.models.dialogflowconnections.DialogflowConnectionUpdateResponse; DialogflowConnectionUpdateParams params = DialogflowConnectionUpdateParams.builder() .connectionId("connection_id") .serviceAccount(DialogflowConnectionUpdateParams.ServiceAccount.builder() .putAdditionalProperty("type", JsonValue.from("bar")) .putAdditionalProperty("project_id", JsonValue.from("bar")) .putAdditionalProperty("private_key_id", JsonValue.from("bar")) .putAdditionalProperty("private_key", JsonValue.from("bar")) .putAdditionalProperty("client_email", JsonValue.from("bar")) .putAdditionalProperty("client_id", JsonValue.from("bar")) .putAdditionalProperty("auth_uri", JsonValue.from("bar")) .putAdditionalProperty("token_uri", JsonValue.from("bar")) .putAdditionalProperty("auth_provider_x509_cert_url", JsonValue.from("bar")) .putAdditionalProperty("client_x509_cert_url", JsonValue.from("bar")) .build()) .build(); DialogflowConnectionUpdateResponse dialogflowConnection = client.dialogflowConnections().update(params); ``` ## Delete stored Dialogflow Connection Deletes a stored Dialogflow Connection. `DELETE /dialogflow_connections/{connection_id}` ```java import com.telnyx.sdk.models.dialogflowconnections.DialogflowConnectionDeleteParams; client.dialogflowConnections().delete("connection_id"); ``` ## List all External Connections This endpoint returns a list of your External Connections inside the 'data' attribute of the response. `GET /external_connections` ```java import com.telnyx.sdk.models.externalconnections.ExternalConnectionListPage; import com.telnyx.sdk.models.externalconnections.ExternalConnectionListParams; ExternalConnectionListPage page = client.externalConnections().list(); ``` ## Creates an External Connection Creates a new External Connection based on the parameters sent in the request. `POST /external_connections` — Required: `external_sip_connection`, `outbound` ```java import com.telnyx.sdk.models.externalconnections.ExternalConnectionCreateParams; import com.telnyx.sdk.models.externalconnections.ExternalConnectionCreateResponse; ExternalConnectionCreateParams params = ExternalConnectionCreateParams.builder() .externalSipConnection(ExternalConnectionCreateParams.ExternalSipConnection.ZOOM) .outbound(ExternalConnectionCreateParams.Outbound.builder().build()) .build(); ExternalConnectionCreateResponse externalConnection = client.externalConnections().create(params); ``` ## Retrieve an External Connection Return the details of an existing External Connection inside the 'data' attribute of the response. `GET /external_connections/{id}` ```java import com.telnyx.sdk.models.externalconnections.ExternalConnectionRetrieveParams; import com.telnyx.sdk.models.externalconnections.ExternalConnectionRetrieveResponse; ExternalConnectionRetrieveResponse externalConnection = client.externalConnections().retrieve("id"); ``` ## Update an External Connection Updates settings of an existing External Connection based on the parameters of the request. `PATCH /external_connections/{id}` — Required: `outbound` ```java import com.telnyx.sdk.models.externalconnections.ExternalConnectionUpdateParams; import com.telnyx.sdk.models.externalconnections.ExternalConnectionUpdateResponse; ExternalConnectionUpdateParams params = ExternalConnectionUpdateParams.builder() .id("id") .outbound(ExternalConnectionUpdateParams.Outbound.builder() .outboundVoiceProfileId("outbound_voice_profile_id") .build()) .build(); ExternalConnectionUpdateResponse externalConnection = client.externalConnections().update(params); ``` ## Deletes an External Connection Permanently deletes an External Connection. `DELETE /external_connections/{id}` ```java import com.telnyx.sdk.models.externalconnections.ExternalConnectionDeleteParams; import com.telnyx.sdk.models.externalconnections.ExternalConnectionDeleteResponse; ExternalConnectionDeleteResponse externalConnection = client.externalConnections().delete("id"); ``` ## List all civic addresses and locations Returns the civic addresses and locations from Microsoft Teams. `GET /external_connections/{id}/civic_addresses` ```java import com.telnyx.sdk.models.externalconnections.civicaddresses.CivicAddressListParams; import com.telnyx.sdk.models.externalconnections.civicaddresses.CivicAddressListResponse; CivicAddressListResponse civicAddresses = client.externalConnections().civicAddresses().list("id"); ``` ## Retrieve a Civic Address Return the details of an existing Civic Address with its Locations inside the 'data' attribute of the response. `GET /external_connections/{id}/civic_addresses/{address_id}` ```java import com.telnyx.sdk.models.externalconnections.civicaddresses.CivicAddressRetrieveParams; import com.telnyx.sdk.models.externalconnections.civicaddresses.CivicAddressRetrieveResponse; CivicAddressRetrieveParams params = CivicAddressRetrieveParams.builder() .id("id") .addressId("318fb664-d341-44d2-8405-e6bfb9ced6d9") .build(); CivicAddressRetrieveResponse civicAddress = client.externalConnections().civicAddresses().retrieve(params); ``` ## Update a location's static emergency address `PATCH /external_connections/{id}/locations/{location_id}` — Required: `static_emergency_address_id` ```java import com.telnyx.sdk.models.externalconnections.ExternalConnectionUpdateLocationParams; import com.telnyx.sdk.models.externalconnections.ExternalConnectionUpdateLocationResponse; ExternalConnectionUpdateLocationParams params = ExternalConnectionUpdateLocationParams.builder() .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") .locationId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") .staticEmergencyAddressId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") .build(); ExternalConnectionUpdateLocationResponse response = client.externalConnections().updateLocation(params); ``` ## List all phone numbers Returns a list of all active phone numbers associated with the given external connection. `GET /external_connections/{id}/phone_numbers` ```java import com.telnyx.sdk.models.externalconnections.phonenumbers.PhoneNumberListPage; import com.telnyx.sdk.models.externalconnections.phonenumbers.PhoneNumberListParams; PhoneNumberListPage page = client.externalConnections().phoneNumbers().list("id"); ``` ## Retrieve a phone number Return the details of a phone number associated with the given external connection. `GET /external_connections/{id}/phone_numbers/{phone_number_id}` ```java import com.telnyx.sdk.models.externalconnections.phonenumbers.PhoneNumberRetrieveParams; import com.telnyx.sdk.models.externalconnections.phonenumbers.PhoneNumberRetrieveResponse;