Skip to main content

Retrieve All Phone Number Campaigns

GET 

/phoneNumberCampaign

Retrieve all of your organization's phone number/campaign assignments.

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

Responses

200: Successful Response

Schema

    records

    object[]

    required

  • Array [

  • phoneNumber Phonenumberrequired
    campaignId Campaignidrequired
    createdAt date-timerequired
    updatedAt date-timerequired
  • ]

  • page Pagerequired
    totalRecords Totalrecordsrequired

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.

  • ]

Loading...