Phone Number Campaigns

Create New Phone Number Campaign

Changed on

Assigns a phone number to a 10DLC campaign. The assignment controls which registered campaign is used for traffic from that number.

post/10dlc/phone_number_campaigns

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/10dlc/phone_number_campaigns
  • Auth: HTTP bearer

Request body

phoneNumberstring required

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

campaignIdstring required

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

Example request

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

Response

Successful Response

phoneNumberstring required
brandIdstring

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

tcrBrandIdstring

TCR's alphanumeric ID for the brand.

campaignIdstring required

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

tcrCampaignIdstring

TCR's alphanumeric ID for the campaign.

telnyxCampaignIdstring

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

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

The assignment status of the number.

tmobileNumberMappingStatusstring

The T-Mobile assignment status of the number.

nonTmobileNumberMappingStatusstring

The assignment status of the number towards other carriers.

failureReasonsstring

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

createdAtstring required
updatedAtstring required

Example response

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

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • info

      added the optional property // to the response with the status