Skip to main content

Retrieve All Phone Number Campaigns

GET 
/phone_number_campaigns

Retrieve All Phone Number Campaigns

Request ​

Query Parameters

    recordsPerPage any
    page any
    filter[telnyx_campaign_id] uuid

    Filter results by the Telnyx Campaign id

    filter[telnyx_brand_id] uuid

    Filter results by the Telnyx Brand id

    filter[tcr_campaign_id] string

    Filter results by the TCR Campaign id

    filter[tcr_brand_id] string

    Filter results by the TCR Brand id

    sort Sort

    Possible values: [assignmentStatus, -assignmentStatus, createdAt, -createdAt, phoneNumber, -phoneNumber]

    Default value: -createdAt

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

    Example: -phoneNumber

Responses ​

200: Successful Response

Schema

    records

    object[]

    required

  • Array [

    • phoneNumber Phonenumber (string)required
    brandId BrandId (string)

    Brand ID. Empty if the number is associated to a shared campaign.

    tcrBrandId TcrBrandId (string)

    TCR's alphanumeric ID for the brand.

    campaignId Campaignid (string)required

    For shared campaigns, this is the TCR campaign ID, otherwise it is the campaign ID

    tcrCampaignId TcrCampaignid (string)

    TCR's alphanumeric ID for the campaign.

    telnyxCampaignId Telnyxcampaignid (string)

    Campaign ID. Empty if the number is associated to a shared campaign.

    assignmentStatus AssignmentStatus

    Possible values: [FAILED_ASSIGNMENT, PENDING_ASSIGNMENT, ASSIGNED, PENDING_UNASSIGNMENT, FAILED_UNASSIGNMENT]

    The assignment status of the number.

    failureReasons

    Extra info about a failure to assign/unassign a number. Relevant only if the assignmentStatus is either FAILED_ASSIGNMENT or FAILED_UNASSIGNMENT

    createdAt date-timerequired
    updatedAt date-timerequired

  • ]

    • page Page (integer)required
    totalRecords Totalrecords (integer)required

default: Unexpected error

Schema

    errors

    object[]

  • Array [

    • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

  • ]

Request samples

curl -L 'https://api.telnyx.com/10dlc/phone_number_campaigns' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "records": [
    {
      "phoneNumber": "+18005550199",
      "brandId": "7ba705b7-22af-493f-addc-ac04b7ca071c",
      "tcrBrandId": "BBRAND1",
      "campaignId": "string",
      "tcrCampaignId": "CCAMPA1",
      "telnyxCampaignId": "3008dd9f-66d7-40e0-bf23-bf2d8d1a96ba",
      "assignmentStatus": "ASSIGNED",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z"
    }
  ],
  "page": 0,
  "totalRecords": 0
}