From 91e81cb898d60210715e23c7c9d827d65deabc62 Mon Sep 17 00:00:00 2001 From: adark Date: Tue, 13 Jun 2023 13:39:02 -0700 Subject: [PATCH 1/2] Adding documentation for the TN endpoint --- .../campaign-management/csp/campaign-api.mdx | 51 ++++++++++++++++++- 1 file changed, 49 insertions(+), 2 deletions(-) diff --git a/site/docs/messaging/campaign-management/csp/campaign-api.mdx b/site/docs/messaging/campaign-management/csp/campaign-api.mdx index 7169e4c38..c2f9842e2 100644 --- a/site/docs/messaging/campaign-management/csp/campaign-api.mdx +++ b/site/docs/messaging/campaign-management/csp/campaign-api.mdx @@ -73,8 +73,8 @@ HTTP/1.1 429 Too Many Requests 6. [Deactivate Campaign](#deactivate-campaign) 7. [Re-Vet Campaign](#re-vet-campaign) 8. [Update Campaign TN Relationship](#update-campaign-tn-relationship) -9. [Bulk Update Campaign TN Relationships](#bulk-update-campaign-tn-relationships) - +9. [Fetch Campaign TNs](#fetch-campaign-tns) +10. [Bulk Update Campaign TN Relationships](#bulk-update-campaign-tn-relationships) ## Create campaign @@ -955,6 +955,53 @@ Location: https://dashboard.bandwidth.com/api/accounts/accounts/{accountId}/tnop ``` +## Fetch Campaign TNs + +This endpoint allows you to fetch the telephone numbers that have been registered to a specific campaign. + +### Request URL + +GET https://dashboard.bandwidth.com/api/accounts/{accountId}/campaignManagement/10dlc/campaigns/{campaignId}/tn + +### Examples + +> Request + +```http +GET https://dashboard.bandwidth.com/api/accounts/{accountId}/campaignManagement/10dlc/campaigns/{campaignId}/tn HTTP/1.1 +Content-Type: application/xml; charset=utf-8 +Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ= +``` + +> Response + +```http +HTTP/1.1 200 No Content +Content-Type: application/xml + + + 1 + + 8888888888 + + +``` + +> Error Response + +```http + + + + 5081 + Number Format 'wrong' is invalid. + + +``` + + +asdf + ## Bulk Update Campaign TN Relationships We do not have a publicly exposed REST endpoint for bulk TN updates. Please see how to import a csv in our [CSP campaign Dashboard UI guide](https://support.bandwidth.com/hc/en-us/articles/5900095168663-How-to-register-a-campaign-for-10DLC).
For more info on TNs, please see [Number Management](/docs/numbers/).
From f8c5992b4cdf9083c31d27da8301bfe2d18a34d3 Mon Sep 17 00:00:00 2001 From: adark Date: Tue, 13 Jun 2023 13:50:52 -0700 Subject: [PATCH 2/2] Remove asdf --- site/docs/messaging/campaign-management/csp/campaign-api.mdx | 3 --- 1 file changed, 3 deletions(-) diff --git a/site/docs/messaging/campaign-management/csp/campaign-api.mdx b/site/docs/messaging/campaign-management/csp/campaign-api.mdx index c2f9842e2..6fbed53b1 100644 --- a/site/docs/messaging/campaign-management/csp/campaign-api.mdx +++ b/site/docs/messaging/campaign-management/csp/campaign-api.mdx @@ -999,9 +999,6 @@ Content-Type: application/xml ``` - -asdf - ## Bulk Update Campaign TN Relationships We do not have a publicly exposed REST endpoint for bulk TN updates. Please see how to import a csv in our [CSP campaign Dashboard UI guide](https://support.bandwidth.com/hc/en-us/articles/5900095168663-How-to-register-a-campaign-for-10DLC).
For more info on TNs, please see [Number Management](/docs/numbers/).