All URIs are relative to https://api.telnyx.com/v2
Method | HTTP request | Description |
---|---|---|
createFlashcallVerification | POST /verifications/flashcall | Trigger a Flash call verification |
createVerificationCall | POST /verifications/call | Trigger a Call verification |
createVerificationSms | POST /verifications/sms | Trigger a SMS verification |
createVerifyProfile | POST /verify_profiles | Create a Verify profile |
deleteProfile | DELETE /verify_profiles/{verify_profile_id} | Delete a Verify profile |
getVerifyProfile | GET /verify_profiles/{verify_profile_id} | Retrieve a Verify profile |
listProfileMessageTemplates | GET /verify_profiles/templates | Retrieve a Verify profile message templates |
listProfiles | GET /verify_profiles | List all Verify profiles |
listVerifications | GET /verifications/by_phone_number/{phone_number} | List verifications by phone number |
retrieveVerification | GET /verifications/{verification_id} | Retrieve a verification |
updateVerifyProfile | PATCH /verify_profiles/{verify_profile_id} | Update a Verify profile |
verifyVerificationCode | POST /verifications/by_phone_number/{phone_number}/actions/verify | Submit a verification code. Deprecation notice: `verify_profile_id' is now a mandatory field. The sunset date for this change is 2022-04-02 00:00:00. |
CreateVerificationResponse createFlashcallVerification(createVerificationRequestFlashcall)
Trigger a Flash call verification
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VerifyApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
VerifyApi apiInstance = new VerifyApi(defaultClient);
CreateVerificationRequestFlashcall createVerificationRequestFlashcall = new CreateVerificationRequestFlashcall(); // CreateVerificationRequestFlashcall |
try {
CreateVerificationResponse result = apiInstance.createFlashcallVerification(createVerificationRequestFlashcall);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerifyApi#createFlashcallVerification");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
createVerificationRequestFlashcall | CreateVerificationRequestFlashcall |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Expected verifications response to a valid request. | - |
400 | Unexpected error | - |
CreateVerificationResponse createVerificationCall(createVerificationRequestCall)
Trigger a Call verification
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VerifyApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
VerifyApi apiInstance = new VerifyApi(defaultClient);
CreateVerificationRequestCall createVerificationRequestCall = new CreateVerificationRequestCall(); // CreateVerificationRequestCall |
try {
CreateVerificationResponse result = apiInstance.createVerificationCall(createVerificationRequestCall);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerifyApi#createVerificationCall");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
createVerificationRequestCall | CreateVerificationRequestCall |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Expected verifications response to a valid request. | - |
400 | Unexpected error | - |
CreateVerificationResponse createVerificationSms(createVerificationRequestSMS)
Trigger a SMS verification
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VerifyApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
VerifyApi apiInstance = new VerifyApi(defaultClient);
CreateVerificationRequestSMS createVerificationRequestSMS = new CreateVerificationRequestSMS(); // CreateVerificationRequestSMS |
try {
CreateVerificationResponse result = apiInstance.createVerificationSms(createVerificationRequestSMS);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerifyApi#createVerificationSms");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
createVerificationRequestSMS | CreateVerificationRequestSMS |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Expected verifications response to a valid request. | - |
400 | Unexpected error | - |
VerifyProfileResponseDataWrapper createVerifyProfile(createVerifyProfileRequest)
Create a Verify profile
Creates a new Verify profile to associate verifications with.
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VerifyApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
VerifyApi apiInstance = new VerifyApi(defaultClient);
CreateVerifyProfileRequest createVerifyProfileRequest = new CreateVerifyProfileRequest(); // CreateVerifyProfileRequest |
try {
VerifyProfileResponseDataWrapper result = apiInstance.createVerifyProfile(createVerifyProfileRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerifyApi#createVerifyProfile");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
createVerifyProfileRequest | CreateVerifyProfileRequest |
VerifyProfileResponseDataWrapper
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Expected Verify profile response to a valid request. | - |
400 | Unexpected error | - |
VerifyProfileResponseDataWrapper deleteProfile(verifyProfileId)
Delete a Verify profile
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VerifyApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
VerifyApi apiInstance = new VerifyApi(defaultClient);
UUID verifyProfileId = UUID.fromString("12ade33a-21c0-473b-b055-b3c836e1c292"); // UUID | The identifier of the Verify profile to delete.
try {
VerifyProfileResponseDataWrapper result = apiInstance.deleteProfile(verifyProfileId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerifyApi#deleteProfile");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
verifyProfileId | UUID | The identifier of the Verify profile to delete. |
VerifyProfileResponseDataWrapper
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Expected Verify profile response to a valid request. | - |
400 | Unexpected error | - |
VerifyProfileResponseDataWrapper getVerifyProfile(verifyProfileId)
Retrieve a Verify profile
Gets a single Verify profile.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VerifyApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
VerifyApi apiInstance = new VerifyApi(defaultClient);
UUID verifyProfileId = UUID.fromString("12ade33a-21c0-473b-b055-b3c836e1c292"); // UUID | The identifier of the Verify profile to retrieve.
try {
VerifyProfileResponseDataWrapper result = apiInstance.getVerifyProfile(verifyProfileId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerifyApi#getVerifyProfile");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
verifyProfileId | UUID | The identifier of the Verify profile to retrieve. |
VerifyProfileResponseDataWrapper
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Expected Verify profile response to a valid request. | - |
400 | Unexpected error | - |
ListVerifyProfileMessageTemplateResponse listProfileMessageTemplates()
Retrieve a Verify profile message templates
List all Verify profile message templates.
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VerifyApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
VerifyApi apiInstance = new VerifyApi(defaultClient);
try {
ListVerifyProfileMessageTemplateResponse result = apiInstance.listProfileMessageTemplates();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerifyApi#listProfileMessageTemplates");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
This endpoint does not need any parameter.
ListVerifyProfileMessageTemplateResponse
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Expected Verify profile message template response to a valid request. | - |
ListVerifyProfilesResponse listProfiles().filterName(filterName).pageSize(pageSize).pageNumber(pageNumber).execute();
List all Verify profiles
Gets a paginated list of Verify profiles.
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VerifyApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
VerifyApi apiInstance = new VerifyApi(defaultClient);
String filterName = "filterName_example"; // String |
Integer pageSize = 25; // Integer |
Integer pageNumber = 1; // Integer |
try {
ListVerifyProfilesResponse result = api.listProfiles()
.filterName(filterName)
.pageSize(pageSize)
.pageNumber(pageNumber)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerifyApi#listProfiles");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
filterName | String | [optional] | |
pageSize | Integer | [optional] [default to 25] | |
pageNumber | Integer | [optional] [default to 1] |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Expected Verify profile response to a valid request. | - |
400 | Unexpected error | - |
ListVerificationsResponse listVerifications(phoneNumber)
List verifications by phone number
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VerifyApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
VerifyApi apiInstance = new VerifyApi(defaultClient);
String phoneNumber = "+13035551234"; // String | The phone number associated with the verifications to retrieve.
try {
ListVerificationsResponse result = apiInstance.listVerifications(phoneNumber);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerifyApi#listVerifications");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
phoneNumber | String | The phone number associated with the verifications to retrieve. |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Expected verifications response to a valid request. | - |
400 | Unexpected error | - |
RetrieveVerificationResponse retrieveVerification(verificationId)
Retrieve a verification
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VerifyApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
VerifyApi apiInstance = new VerifyApi(defaultClient);
UUID verificationId = UUID.fromString("12ade33a-21c0-473b-b055-b3c836e1c292"); // UUID | The identifier of the verification to retrieve.
try {
RetrieveVerificationResponse result = apiInstance.retrieveVerification(verificationId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerifyApi#retrieveVerification");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
verificationId | UUID | The identifier of the verification to retrieve. |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Expected verifications response to a valid request. | - |
400 | Unexpected error | - |
VerifyProfileResponseDataWrapper updateVerifyProfile(verifyProfileId, updateVerifyProfileRequest)
Update a Verify profile
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VerifyApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
VerifyApi apiInstance = new VerifyApi(defaultClient);
UUID verifyProfileId = UUID.fromString("12ade33a-21c0-473b-b055-b3c836e1c292"); // UUID | The identifier of the Verify profile to update.
UpdateVerifyProfileRequest updateVerifyProfileRequest = new UpdateVerifyProfileRequest(); // UpdateVerifyProfileRequest |
try {
VerifyProfileResponseDataWrapper result = apiInstance.updateVerifyProfile(verifyProfileId, updateVerifyProfileRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerifyApi#updateVerifyProfile");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
verifyProfileId | UUID | The identifier of the Verify profile to update. | |
updateVerifyProfileRequest | UpdateVerifyProfileRequest |
VerifyProfileResponseDataWrapper
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Expected Verify profile response to a valid request. | - |
400 | Unexpected error | - |
VerifyVerificationCodeResponse verifyVerificationCode(phoneNumber, verifyVerificationCodeRequest)
Submit a verification code. Deprecation notice: `verify_profile_id' is now a mandatory field. The sunset date for this change is 2022-04-02 00:00:00.
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VerifyApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
VerifyApi apiInstance = new VerifyApi(defaultClient);
String phoneNumber = "+13035551234"; // String | The phone number associated with the verification code being verified.
VerifyVerificationCodeRequest verifyVerificationCodeRequest = new VerifyVerificationCodeRequest(); // VerifyVerificationCodeRequest |
try {
VerifyVerificationCodeResponse result = apiInstance.verifyVerificationCode(phoneNumber, verifyVerificationCodeRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerifyApi#verifyVerificationCode");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
phoneNumber | String | The phone number associated with the verification code being verified. | |
verifyVerificationCodeRequest | VerifyVerificationCodeRequest |
VerifyVerificationCodeResponse
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Expected verify response to a valid request. | - |
400 | Unexpected error | - |