Retrieve All Phone Number Campaigns

GET 
/phone_number_campaigns

Retrieve All Phone Number Campaigns

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

200: Successful Response

application/json

• Schema
• Example (from schema)

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 Createdat (string)required

updatedAt Updatedat (string)required

]

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

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

default: Unexpected error

application/json

• Schema
• Example (from schema)

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.

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      }
    }
  ]
}

Request samples

• cURL

---

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

Response samples

• 200
• default

---

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

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      }
    }
  ]
}