VerifiedCallsDisplayProfileApi

All URIs are relative to https://api.telnyx.com/v2

Method	HTTP request	Description
createProfile	POST /verified_calls_display_profiles	Creates a Verified Calls Display Profile
createProfileVerificationRequest	POST /verified_calls_display_profiles/{id}/verification_request	Creates a Verification Request
deleteProfile	DELETE /verified_calls_display_profiles/{id}	Deletes the Verified Calls Display Profile
displayProfile	GET /verified_calls_display_profiles/{id}	Display the Verified Calls Display Profile
listProfiles	GET /verified_calls_display_profiles	Lists the Verified Calls Display Profiles owned by the current user/organization
updateProfile	PATCH /verified_calls_display_profiles/{id}	Update a Verified Calls Display Profile

createProfile

ShowVerifiedCallsDisplayProfileResponse createProfile().createVerifiedCallsDisplayProfileRequest(createVerifiedCallsDisplayProfileRequest).execute();

Creates a Verified Calls Display Profile

Creates a Verified Calls Display Profile associated with the given Business Identity

Example

// 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.VerifiedCallsDisplayProfileApi;

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");

        VerifiedCallsDisplayProfileApi apiInstance = new VerifiedCallsDisplayProfileApi(defaultClient);
        CreateVerifiedCallsDisplayProfileRequest createVerifiedCallsDisplayProfileRequest = new CreateVerifiedCallsDisplayProfileRequest(); // CreateVerifiedCallsDisplayProfileRequest | 
        try {
            ShowVerifiedCallsDisplayProfileResponse result = api.createProfile()
                .createVerifiedCallsDisplayProfileRequest(createVerifiedCallsDisplayProfileRequest)
                .execute();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VerifiedCallsDisplayProfileApi#createProfile");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
createVerifiedCallsDisplayProfileRequest	CreateVerifiedCallsDisplayProfileRequest

Return type

ShowVerifiedCallsDisplayProfileResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Successful response with a Verified Calls Display Profile.	-
0	Unexpected error	-

createProfileVerificationRequest

createProfileVerificationRequest(id)

Creates a Verification Request

Starts a new Verified Calls Display Profile verification process.

Example

// 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.VerifiedCallsDisplayProfileApi;

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");

        VerifiedCallsDisplayProfileApi apiInstance = new VerifiedCallsDisplayProfileApi(defaultClient);
        String id = "id_example"; // String | Identifies the Verified Calls Display Profile
        try {
            apiInstance.createProfileVerificationRequest(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling VerifiedCallsDisplayProfileApi#createProfileVerificationRequest");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	Identifies the Verified Calls Display Profile

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	The Verification Request was issued.	-
0	Unexpected error	-

deleteProfile

ShowVerifiedCallsDisplayProfileResponse deleteProfile(id).execute();

Deletes the Verified Calls Display Profile

Deletes the Verified Calls Display Profile. This action will fail if any verification requests have been made for this Verified Calls Display Profile. Please contact support@telnyx.com in case you want to delete a Verified Calls Display Profile in that situation.

Example

// 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.VerifiedCallsDisplayProfileApi;

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");

        VerifiedCallsDisplayProfileApi apiInstance = new VerifiedCallsDisplayProfileApi(defaultClient);
        String id = "id_example"; // String | Identifies the Verified Calls Display Profile
        try {
            ShowVerifiedCallsDisplayProfileResponse result = api.deleteProfile(id)
                .execute();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VerifiedCallsDisplayProfileApi#deleteProfile");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	Identifies the Verified Calls Display Profile

Return type

ShowVerifiedCallsDisplayProfileResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response with a Verified Calls Display Profile.	-
0	Unexpected error	-

displayProfile

ShowVerifiedCallsDisplayProfileResponse displayProfile(id).execute();

Display the Verified Calls Display Profile

Example

// 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.VerifiedCallsDisplayProfileApi;

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");

        VerifiedCallsDisplayProfileApi apiInstance = new VerifiedCallsDisplayProfileApi(defaultClient);
        String id = "id_example"; // String | Identifies the Verified Calls Display Profile
        try {
            ShowVerifiedCallsDisplayProfileResponse result = api.displayProfile(id)
                .execute();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VerifiedCallsDisplayProfileApi#displayProfile");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	Identifies the Verified Calls Display Profile

Return type

ShowVerifiedCallsDisplayProfileResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response with a Verified Calls Display Profile.	-
0	Unexpected error	-

listProfiles

ListVerifiedCallsDisplayProfilesResponse listProfiles().pageNumber(pageNumber).pageSize(pageSize).execute();

Lists the Verified Calls Display Profiles owned by the current user/organization

Example

// 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.VerifiedCallsDisplayProfileApi;

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");

        VerifiedCallsDisplayProfileApi apiInstance = new VerifiedCallsDisplayProfileApi(defaultClient);
        Integer pageNumber = 1; // Integer | The page number to load
        Integer pageSize = 20; // Integer | The size of the page
        try {
            ListVerifiedCallsDisplayProfilesResponse result = api.listProfiles()
                .pageNumber(pageNumber)
                .pageSize(pageSize)
                .execute();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VerifiedCallsDisplayProfileApi#listProfiles");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
pageNumber	Integer	The page number to load	[optional] [default to 1]
pageSize	Integer	The size of the page	[optional] [default to 20]

Return type

ListVerifiedCallsDisplayProfilesResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response with a list of Verified Calls Display Profiles.	-
0	Unexpected error	-

updateProfile

updateProfile(id).updateVerifiedCallsDisplayProfileRequest(updateVerifiedCallsDisplayProfileRequest).execute();

Update a Verified Calls Display Profile

Update an existing Verified Calls Display Profile and allows adding/removing nested Call Reasons and Phone Numbers. Different attributes can be updated depending on the Verified Calls Display Profile's status: For the VERIFICATION_STATE_PENDING status, no fields can be updated. For the VERIFICATION_STATE_VERIFIED status, it is allowed only to add/remove Call Reaons and Phone Numbers. For the other statuses, all fields can be updated. All existing Call Reasons and Phone Numbers must be sent during the request, or the update will fail.

Example

// 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.VerifiedCallsDisplayProfileApi;

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");

        VerifiedCallsDisplayProfileApi apiInstance = new VerifiedCallsDisplayProfileApi(defaultClient);
        String id = "id_example"; // String | Identifies the Verified Calls Display Profile
        UpdateVerifiedCallsDisplayProfileRequest updateVerifiedCallsDisplayProfileRequest = new UpdateVerifiedCallsDisplayProfileRequest(); // UpdateVerifiedCallsDisplayProfileRequest | 
        try {
            api.updateProfile(id)
                .updateVerifiedCallsDisplayProfileRequest(updateVerifiedCallsDisplayProfileRequest)
                .execute();
        } catch (ApiException e) {
            System.err.println("Exception when calling VerifiedCallsDisplayProfileApi#updateProfile");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	Identifies the Verified Calls Display Profile
updateVerifiedCallsDisplayProfileRequest	UpdateVerifiedCallsDisplayProfileRequest

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Verified Calls Display Profile was updated.	-
0	Unexpected error	-

Files

VerifiedCallsDisplayProfileApi.md

Latest commit

History

VerifiedCallsDisplayProfileApi.md

File metadata and controls

VerifiedCallsDisplayProfileApi

createProfile

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createProfileVerificationRequest

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteProfile

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

displayProfile

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listProfiles

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateProfile

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details