Skip to content

Latest commit

 

History

History
156 lines (112 loc) · 5.36 KB

SharedCampaignsApi.md

File metadata and controls

156 lines (112 loc) · 5.36 KB
Raw

SharedCampaignsApi

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

Method HTTP request Description
getCampaignSharingStatus GET /partnerCampaign/{campaignId}/sharing Get Sharing Status
getPartnerCampaignsSharedByUser GET /partnerCampaign/sharedByMe Get Partner Campaigns Shared By User

getCampaignSharingStatus

Map<String, CampaignSharingStatus> getCampaignSharingStatus(campaignId)

Get Sharing Status

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.SharedCampaignsApi;

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

        SharedCampaignsApi apiInstance = new SharedCampaignsApi(defaultClient);
        String campaignId = "campaignId_example"; // String | ID of the campaign in question
        try {
            Map<String, CampaignSharingStatus> result = apiInstance.getCampaignSharingStatus(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SharedCampaignsApi#getCampaignSharingStatus");
            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
campaignId String ID of the campaign in question

Return type

Map<String, CampaignSharingStatus>

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

getPartnerCampaignsSharedByUser

SharedCampaignRecordSet getPartnerCampaignsSharedByUser(page, recordsPerPage)

Get Partner Campaigns Shared By User

Get all partner campaigns you have shared to Telnyx in a paginated fashion

This endpoint is currently limited to only returning shared campaigns that Telnyx has accepted. In other words, shared but pending campaigns are currently omitted from the response from this endpoint.

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.SharedCampaignsApi;

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

        SharedCampaignsApi apiInstance = new SharedCampaignsApi(defaultClient);
        Integer page = 1; // Integer | The 1-indexed page number to get. The default value is `1`.
        Integer recordsPerPage = 10; // Integer | The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`.
        try {
            SharedCampaignRecordSet result = apiInstance.getPartnerCampaignsSharedByUser(page, recordsPerPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SharedCampaignsApi#getPartnerCampaignsSharedByUser");
            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
page Integer The 1-indexed page number to get. The default value is `1`. [optional] [default to 1]
recordsPerPage Integer The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`. [optional] [default to 10]

Return type

SharedCampaignRecordSet

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -