Sign in
Phone Number Campaigns

List phone number campaigns

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

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

Changed in 4 of the 99 revisions of this API.314

  • 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

  • eb02d7e7280b2See the full diff
    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

Of the 99 revisions, 1 has no diff computed.