Sign in
Shared Campaigns

List Shared Campaigns

Retrieve 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.

get/10dlc/partner_campaigns

Query parameters

pageinteger

The 1-indexed page number to get. The default value is 1.

The 1-indexed page number to get. The default value is 1.

recordsPerPageinteger

The amount of records per page, limited to between 1 and 500 inclusive. The default value is 10.

The amount of records per page, limited to between 1 and 500 inclusive. The default value is 10.

sort'assignedPhoneNumbersCount' | '-assignedPhoneNumbersCount' | 'brandDisplayName' | '-brandDisplayName' | 'tcrBrandId' | '-tcrBrandId' | 'tcrCampaignId' | '-tcrCampaignId' | 'createdAt' | '-createdAt' | 'campaignStatus' | '-campaignStatus'

Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

Specifies the sort order for results. If not given, results are sorted by createdAt in descending order.

Response

Successful Response

pageinteger
totalRecordsinteger

Example response

{
  "records": [
    {
      "assignedPhoneNumbersCount": 3,
      "brandDisplayName": "ABC Mobile",
      "campaignStatus": "TCR_ACCEPTED",
      "tcrBrandId": "BBRAND1",
      "tcrCampaignId": "CCAMP1",
      "webhookURL": "https://example.com/webhook",
      "webhookFailoverURL": "https://example.com/failover-webhook",
      "createdAt": "2021-03-08T17:57:48.801186",
      "updatedAt": "2021-03-08T17:57:48.801186"
    }
  ]
}

Changes

Changed in 3 of the 99 revisions of this API.312

  • a6a61a29ecdd11See the full diff
    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1571b0380bd711See the full diff
    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      response-property-type-changed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e53799411See the full diff
    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 99 revisions, 1 has no diff computed.