Shared Campaigns

List Shared Campaigns

Changed on

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

Request

  • Base URL
    https://api.telnyx.com/v2
  • URL
    https://api.telnyx.com/v2/10dlc/partner_campaigns
  • Auth
    HTTP bearer

Query parameters

pageinteger

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.

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

  • 67df31283a8aRevision changes
    • breaking

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

    • info

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

  • a72569d69430Revision changes
    • breaking

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

    • info

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