Phone Number Campaigns

List phone number campaigns

Changed on

Returns phone-number-to-campaign assignments for the authenticated account. Apply the documented filters and pagination parameters to narrow the result set.

get/10dlc/phone_number_campaigns

Request

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

Query parameters

recordsPerPageinteger

Number of records to return per page.

pageinteger

Page number to retrieve (1-based).

telnyx_campaign_idstring uuid

Filter results by the Telnyx Campaign id

telnyx_brand_idstring uuid

Filter results by the Telnyx Brand id

tcr_campaign_idstring

Filter results by the TCR Campaign id

tcr_brand_idstring

Filter results by the TCR Brand id

Consolidated filter parameter (deepObject style). Originally: filter[telnyx_campaign_id], filter[telnyx_brand_id], filter[tcr_campaign_id], filter[tcr_brand_id]

{
  "telnyx_campaign_id": "f3575e15-32ce-400e-a4c0-dd78800c20b0",
  "telnyx_brand_id": "f3575e15-32ce-400e-a4c0-dd78800c20b0",
  "tcr_campaign_id": "CAMPID3",
  "tcr_brand_id": "BRANDID"
}
sort'assignmentStatus' | '-assignmentStatus' | 'createdAt' | '-createdAt' | 'phoneNumber' | '-phoneNumber'

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 required
totalRecordsinteger required

Example response

{
  "records": [
    {
      "phoneNumber": "+18005550199",
      "brandId": "7ba705b7-22af-493f-addc-ac04b7ca071c",
      "tcrBrandId": "BBRAND1",
      "tcrCampaignId": "CCAMPA1",
      "telnyxCampaignId": "3008dd9f-66d7-40e0-bf23-bf2d8d1a96ba",
      "assignmentStatus": "ASSIGNED",
      "tmobileNumberMappingStatus": "ADDED",
      "nonTmobileNumberMappingStatus": "ADDED",
      "createdAt": "2021-03-08T17:57:48.801186",
      "updatedAt": "2021-03-08T17:57:48.801186"
    }
  ]
}

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