Get Single Phone Number Campaign

GET 
/phoneNumberCampaign/:phoneNumber

Retrieve an individual phone number/campaign assignment by phoneNumber.

Path Parameters

phoneNumber Phonenumberrequired

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

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

{
  "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"
}

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/10dlc/phoneNumberCampaign/:phoneNumber' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "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"
}

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