Skip to content
This repository was archived by the owner on Nov 29, 2023. It is now read-only.

Commit 91e81cb

Browse files
Adding documentation for the TN endpoint
1 parent c571890 commit 91e81cb

File tree

1 file changed

+49
-2
lines changed

1 file changed

+49
-2
lines changed

site/docs/messaging/campaign-management/csp/campaign-api.mdx

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ HTTP/1.1 429 Too Many Requests
7373
6. [Deactivate Campaign](#deactivate-campaign)
7474
7. [Re-Vet Campaign](#re-vet-campaign)
7575
8. [Update Campaign TN Relationship](#update-campaign-tn-relationship)
76-
9. [Bulk Update Campaign TN Relationships](#bulk-update-campaign-tn-relationships)
77-
76+
9. [Fetch Campaign TNs](#fetch-campaign-tns)
77+
10. [Bulk Update Campaign TN Relationships](#bulk-update-campaign-tn-relationships)
7878

7979
## Create campaign
8080

@@ -955,6 +955,53 @@ Location: https://dashboard.bandwidth.com/api/accounts/accounts/{accountId}/tnop
955955
</TnOptionOrderResponse>
956956
```
957957

958+
## Fetch Campaign TNs
959+
960+
This endpoint allows you to fetch the telephone numbers that have been registered to a specific campaign.
961+
962+
### Request URL
963+
964+
<Highlight color="#ff6f47">GET</Highlight> <code>https://dashboard.bandwidth.com/api/accounts/{accountId}/campaignManagement/10dlc/campaigns/{campaignId}/tn</code>
965+
966+
### Examples
967+
968+
> Request
969+
970+
```http
971+
GET https://dashboard.bandwidth.com/api/accounts/{accountId}/campaignManagement/10dlc/campaigns/{campaignId}/tn HTTP/1.1
972+
Content-Type: application/xml; charset=utf-8
973+
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
974+
```
975+
976+
> Response
977+
978+
```http
979+
HTTP/1.1 200 No Content
980+
Content-Type: application/xml
981+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
982+
<CampaignTnsResponse>
983+
<TotalCount>1</TotalCount>
984+
<TelephoneNumbers>
985+
<TelephoneNumber>8888888888</TelephoneNumber>
986+
</TelephoneNumbers>
987+
</CampaignTnsResponse>
988+
```
989+
990+
> Error Response
991+
992+
```http
993+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
994+
<CampaignTnsResponse>
995+
<ResponseStatus>
996+
<ErrorCode>5081</ErrorCode>
997+
<Description>Number Format 'wrong' is invalid.</Description>
998+
</ResponseStatus>
999+
</CampaignTnsResponse>
1000+
```
1001+
1002+
1003+
asdf
1004+
9581005
## Bulk Update Campaign TN Relationships
9591006
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).<br/>
9601007
For more info on TNs, please see [Number Management](/docs/numbers/).<br/>

0 commit comments

Comments
 (0)