Skip to main content

Retrieve All Phone Number Campaigns

GET 
/phone_number_campaigns

Retrieve All Phone Number Campaigns

Request

Query Parameters

    recordsPerPage Recordsperpage

    Default value: 20

    page Page

    Default value: 1

    filter object

    Consolidated filter parameter (deepObject style). Originally: filter[telnyx_campaign_id], filter[telnyx_brand_id], filter[tcr_campaign_id], filter[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

default: Unexpected error

Request samples


curl -L 'https://api.telnyx.com/v2/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",
"failureReasons": "string",
"createdAt": "2021-03-08T17:57:48.801186",
"updatedAt": "2021-03-08T17:57:48.801186"
}
],
"page": 0,
"totalRecords": 0
}