Campaign

List Campaigns

Changed on

Retrieve a list of campaigns associated with a supplied brandId.

get/10dlc/campaign

Request

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

Query parameters

brandIdstring required

Filter results by brand id.

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' | 'campaignId' | '-campaignId' | 'createdAt' | '-createdAt' | 'status' | '-status' | 'tcrCampaignId' | '-tcrCampaignId'

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": [
    {
      "brandId": "d2ca9d69-641b-4131-83fa-5d0744f4c8a9",
      "brandDisplayName": "ABC Mobile",
      "campaignId": "823d6b1a-6ed6-41a3-9c50-c8ff41b682ba",
      "tcrBrandId": "BBRAND1",
      "tcrCampaignId": "CCAMP1",
      "webhookURL": "https://example.com/webhook",
      "webhookFailoverURL": "https://example.com/failover-webhook",
      "campaignStatus": "TCR_ACCEPTED",
      "assignedPhoneNumbersCount": 3
    }
  ]
}

Changes

  • 19db5ee4ec59Revision 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

  • a6a61a29ecddRevision 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