Sign in
Phone Number Campaigns

Create New Phone Number Campaign

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 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

Changed in 4 of the 99 revisions of this API.314

  • a6a61a29ecdd11See the full diff
    • ▲

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

      response-property-type-changed

    • ○

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

      response-optional-property-added

    This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1571b0380bd711See the full diff
    • ▲

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

      response-property-type-changed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e53799411See the full diff
    • ▲

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

      response-property-type-changed

    • ○

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

      response-optional-property-added

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • eb02d7e7280b2See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

Of the 99 revisions, 1 has no diff computed.