Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Phone Number Campaigns

Create New Phone Number Campaign

post/10dlc/phone_number_campaigns

Request body

campaignIdstring required

The ID of the campaign you want to link to the specified phone number.

phoneNumberstring required

The phone number you want to link to a specified campaign.

Example request

{
  "campaignId": "4b300178-131c-d902-d54e-72d90ba1620j",
  "phoneNumber": "+18005550199"
}

Response

Successful Response

assignmentStatus'FAILED_ASSIGNMENT' | 'PENDING_ASSIGNMENT' | 'ASSIGNED' | 'PENDING_UNASSIGNMENT' | 'FAILED_UNASSIGNMENT'

The assignment status of the number.

brandIdstring

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

campaignIdstring required

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

createdAtstring required
failureReasonsstring

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

nonTmobileNumberMappingStatusstring

The assignment status of the number towards other carriers.

phoneNumberstring required
tcrBrandIdstring

TCR's alphanumeric ID for the brand.

tcrCampaignIdstring

TCR's alphanumeric ID for the campaign.

telnyxCampaignIdstring

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

tmobileNumberMappingStatusstring

The T-Mobile assignment status of the number.

updatedAtstring required

Example response

{
  "assignmentStatus": "ASSIGNED",
  "brandId": "7ba705b7-22af-493f-addc-ac04b7ca071c",
  "createdAt": "2021-03-08T17:57:48.801186",
  "nonTmobileNumberMappingStatus": "ADDED",
  "phoneNumber": "+18005550199",
  "tcrBrandId": "BBRAND1",
  "tcrCampaignId": "CCAMPA1",
  "telnyxCampaignId": "3008dd9f-66d7-40e0-bf23-bf2d8d1a96ba",
  "tmobileNumberMappingStatus": "ADDED",
  "updatedAt": "2021-03-08T17:57:48.801186"
}