From 7fad2d7880a14074a3311086c89d1769082d2fef Mon Sep 17 00:00:00 2001 From: DX-Bandwidth <42817071+DX-Bandwidth@users.noreply.github.com> Date: Tue, 3 Oct 2023 09:44:58 -0400 Subject: [PATCH] SWI-3654 (#1167) * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files --- site/specs/messaging.yml | 67 +- site/specs/multi-factor-auth.yml | 12 +- site/specs/numbers_v2.yml | 6623 ++++++++++++++++------------ site/specs/phone-number-lookup.yml | 8 +- site/specs/voice.yml | 159 +- 5 files changed, 3826 insertions(+), 3043 deletions(-) diff --git a/site/specs/messaging.yml b/site/specs/messaging.yml index 4b418a374..eeea306fa 100644 --- a/site/specs/messaging.yml +++ b/site/specs/messaging.yml @@ -87,10 +87,12 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.MediaApi; - public class Example { + import java.util.List; + + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -280,30 +282,37 @@ paths: } - lang: Java source: | - import com.bandwidth.BandwidthClient; - import com.bandwidth.http.response.ApiResponse; + import com.bandwidth.sdk.ApiClient; + import com.bandwidth.sdk.ApiException; + import com.bandwidth.sdk.Configuration; + import com.bandwidth.sdk.auth.*; + import com.bandwidth.sdk.model.*; + import com.bandwidth.sdk.api.MediaApi; - import java.util.concurrent.CompletableFuture; - import java.util.concurrent.ExecutionException; - import java.io.InputStream; + import java.io.File; public class Sample { - public static final String USERNAME = "api-username"; - public static final String PASSWORD = "api-password"; - public static final String ACCOUNT_ID = "12345"; - public static void main(String[] args) { - String mediaId = "media-id-123"; + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); - BandwidthClient client = new BandwidthClient.Builder() - .messagingBasicAuthCredentials(USERNAME, PASSWORD) - .build(); + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + MediaApi apiInstance = new MediaApi(defaultClient); + String accountId = "9900000"; // String | Your Bandwidth Account ID. + String mediaId = "14762070468292kw2fuqty55yp2b2/0/bw.png"; // String | Media ID to retrieve. try { - CompletableFuture> completableFuture = client.getMessagingClient().getAPIController().getMediaAsync(ACCOUNT_ID, mediaId); - System.out.println(completableFuture.get().getResult()); - } catch (InterruptedException | ExecutionException e) { - System.out.println(e.getMessage()); + File result = apiInstance.getMedia(accountId, mediaId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling MediaApi#getMedia"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); } } } @@ -505,10 +514,12 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.MediaApi; - public class Example { + import java.io.File; + + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -753,10 +764,12 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.MediaApi; - public class Example { + import java.io.File; + + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -962,10 +975,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.MessagesApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -1204,10 +1217,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.MessagesApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure HTTP basic authorization: Basic diff --git a/site/specs/multi-factor-auth.yml b/site/specs/multi-factor-auth.yml index 2d9691a36..05c8a662c 100644 --- a/site/specs/multi-factor-auth.yml +++ b/site/specs/multi-factor-auth.yml @@ -106,10 +106,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.MfaApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -390,10 +390,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.MfaApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -671,10 +671,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.MfaApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); diff --git a/site/specs/numbers_v2.yml b/site/specs/numbers_v2.yml index 0ab48604d..79feab9d8 100644 --- a/site/specs/numbers_v2.yml +++ b/site/specs/numbers_v2.yml @@ -948,6 +948,68 @@ components: + badRequestErrorExample: + summary: An example of a generic Bad Request Error + value: + errors: + - code: 205617 + description: There was an issue with your request. + id: optional-error-id + type: bad-request + forbiddenErrorExample: + summary: An example of a generic Unauthorized Error + value: + errors: + - code: 109107 + description: User does not have permissions to access this resource. + id: optional-error-id + type: resource-permissions + internalServerErrorExample: + summary: An example of a generic Internal Server Error + value: + errors: + - code: 32030 + description: >- + Unexpected internal server error. Contact Bandwidth Customer + Support if this problem persists. + id: optional-error-id + type: internal-server-error + notAllowedErrorExample: + summary: An example of a generic Not Allowed Error + value: + errors: + - code: 205621 + description: The HTTP method used is not supported by this resource. + id: optional-error-id + meta: + method: TRACE + type: http-method-not-supported + notFoundErrorExample: + summary: An example of a generic Not Found Error + value: + errors: + - code: 50420 + description: The resource specified cannot be found. + id: optional-error-id + type: resource-not-found + tooManyRequestsErrorExample: + summary: An example of a generic Too Many Requests Error + value: + errors: + - code: 32002 + description: >- + Rate limit exceeded. Wait for the time specified in the + "Retry-After" header before sending another request. + id: optional-error-id + type: rate-limiting + unauthorizedErrorExample: + summary: An example of a generic Unauthorized Error + value: + errors: + - code: 206401 + description: Invalid or missing credentials. + id: optional-error-id + type: authentication-credentials parameters: AccountIDQueryParam: description: > @@ -1014,7 +1076,7 @@ components: CustomerOrderIdQueryParam: description: >- The Customer Order ID is an ID assigned by the account owner to provide - a reference number for the importVoiceTnOrder. + a reference number for the order. example: ABCCorp12345 in: query name: customerOrderId @@ -1183,19 +1245,13 @@ components: schema: type: string SipPeerIdPathParam: + description: SipPeer ID, also known as Location in: path name: sipPeerId required: true schema: format: int32 type: integer - SipPeerIdQueryParam: - description: A Sip Peer Id that is referenced in the order - example: 50139 - in: query - name: sipPeerId - schema: - type: integer SipPeerTnsPageQueryParam: description: The number of the paged results to be displayed. example: 4 @@ -1215,7 +1271,7 @@ components: default: 5000 type: integer SiteIdPathParam: - description: Site ID of the Sip Peer + description: Site ID, also known as Sub-Account example: '407' in: path name: siteId @@ -1275,37 +1331,249 @@ components: required: true schema: type: string - areaCodeQueryParameter: - description: Area code of a phone number - example: '07' + addressIdPathParam: + description: Address Id. + in: path + name: addressId + required: true + schema: + example: ArAnD0m1d + type: string + afterCursorQueryParam_eq: + description: Returns the page after the last record on the current page. + explode: true + in: query + name: afterCursor + required: false + schema: + properties: + eq: + example: ArAnD0m1d + type: string + type: object + style: deepObject + areaCodeQueryParam: + description: >- + The 1 to 6 digit area code associated with the phone number. The system + defaults to return all area codes when the query parameter is not + passed. The countryCodeA3 is a required parameter with areaCode. in: query name: areaCode required: false schema: + example: '435' type: string - countryCodeA3QueryParameter: - description: 3-letter, ISO 3166 country code - example: GBR + areaCodeQueryParam_eq: + description: >- + The 1 to 6 digit area code associated with the phone number. The system + defaults to return all area codes when the query parameter is not + passed. The countryCodeA3 is a required parameter with areaCode. + in: query + name: areaCode + required: false + schema: + properties: + eq: + example: '435' + type: string + type: object + beforeCursorQueryParam_eq: + description: Returns the page before the first record on the current page. + explode: true + in: query + name: beforeCursor + required: false + schema: + properties: + eq: + example: ArAnD0m1d + type: string + type: object + style: deepObject + cityQueryParam: + description: >- + The name of the city. The system defaults to return all cities when the + query parameter is not passed. The countryCodeA3 is a required parameter + with city. Some phone number types like TOLL_FREE may not have any + associated cities. + in: query + name: city + required: false + schema: + example: Raleigh + type: string + cityQueryParam_eq_startsWith: + description: >- + The name of the city. The system defaults to return all cities when the + query parameter is not passed. The countryCodeA3 is a required parameter + with city. Some phone number types like TOLL_FREE may not have any + associated cities. + explode: true + in: query + name: city + required: false + schema: + properties: + eq: + example: Raleigh + type: string + startsWith: + example: Ral + type: string + type: object + style: deepObject + countryCodeA3QueryParam: + description: Country code of the address in ISO 3166-1 alpha-3 format. + in: query + name: countryCodeA3 + required: false + schema: + example: USA + type: string + countryCodeA3QueryParam_eq: + description: Country code of the address in ISO 3166-1 alpha-3 format. + in: query + name: countryCodeA3 + required: false + schema: + properties: + eq: + example: USA + type: string + type: object + countryCodeA3RequiredQueryParam: + description: Country code of the address in ISO 3166-1 alpha-3 format. in: query - name: Country Code + name: countryCodeA3 required: true schema: + properties: + eq: + example: USA + type: string + type: object + customReferenceQueryParam_eq_startsWith: + description: Customer reference. It cannot be combined with any other query filter. + in: query + name: customReference + required: false + schema: + properties: + eq: + example: home_office + maxLength: 64 + minLength: 1 + type: string + startsWith: + example: home + maxLength: 64 + minLength: 1 + type: string + type: object + enddateQueryParam: + description: >- + The ending date of a search in yy-mm-dd format. startdate and enddate + must be used as a pair. + in: query + name: enddate + required: false + schema: + example: 23-10-31 type: string - phoneNumberTypeQueryParameter: - description: Phone number type - example: MOBILE + isHiddenQueryParam_eq: + description: >- + Returns hidden addresses when set to true. The system defaults to false + and only returns addresses that are not hidden. + in: query + name: isHidden + required: false + schema: + properties: + eq: + example: false + type: boolean + type: object + limitQueryParam_eq: + description: Limit the number of returned records. + explode: true + in: query + name: limit + required: false + schema: + properties: + eq: + default: 300 + maximum: 5000 + minimum: 1 + type: number + type: object + style: deepObject + pageQueryParam: + description: >- + An ID of the first element in a page. This value will indicate the + first value, not the page number, of the initial entry in the page being + requested. The initial page is tagged with the ID `1` as a convention. + in: query + name: page + required: false + schema: + default: 1 + example: 1 + type: integer + phoneNumberTypeQueryParam: + description: >- + The type of phone number. The system defaults to return phone numbers of + all types when the query parameter is not passed. The countryCodeA3 is a + required parameter with phone number type. in: query name: phoneNumberType required: false schema: enum: - GEOGRAPHIC - - SHARED_COST - - TOLL_FREE - NATIONAL - - SPECIAL - MOBILE + - TOLL_FREE + - SHARED_COST + example: MOBILE type: string + phoneNumberTypeQueryParam_eq: + description: >- + The type of phone number. The system defaults to return phone numbers of + all types when the query parameter is not passed. The countryCodeA3 is a + required parameter with phone number type. + in: query + name: phoneNumberType + required: false + schema: + properties: + eq: + enum: + - GEOGRAPHIC + - NATIONAL + - MOBILE + - TOLL_FREE + - SHARED_COST + example: MOBILE + type: string + type: object + postalCodeQueryParam_eq_startsWith: + description: >- + The postal code of the address. The system defaults to return all postal + codes when the query parameter is not passed. The countryCodeA3 is a + required parameter with postalCode. + in: query + name: postalCode + required: false + schema: + properties: + eq: + example: '98072' + type: string + startsWith: + example: '9807' + type: string + type: object shortCodeCountryPathParam: description: The short code number country. example: USA @@ -1373,12 +1641,53 @@ components: required: true schema: type: string + sizeQueryParam: + description: The number of elements to retrieve + in: query + name: page + required: false + schema: + example: 30 + type: integer + startdateQueryParam: + description: >- + The starting date of a search in yy-mm-dd format. startdate and enddate + must be used as a pair. + in: query + name: startdate + required: false + schema: + example: 22-10-31 + type: string + tierQueryParam: + description: >- + A service tier indicating the the vendor class that the TN is associated + with. Tier indicates whether the TN is on-net, domestic offnet, + Canadian, etc. + in: query + name: tier + required: false + schema: + example: 5 + type: integer requestBodies: + addAddressRequest: + content: + application/json: + schema: + $ref: '#/components/schemas/createAddressRequest' + description: Add address. shortCodeJsonPatchShortCodeRequest: content: application/json-patch+json: schema: $ref: '#/components/schemas/jsonPatch' + updateAddressRequest: + content: + application/json: + schema: + $ref: '#/components/schemas/updateAddressRequest' + description: Update address. verificationRequest: content: application/json: @@ -1445,21 +1754,15 @@ components: associated with the order, the state of the order, and a list of the successfully imported Telephone Numbers, and descriptions of any encountered errors. - badRequestLosingInvlaidCountryCodeCarriersResponse: + badRequestError: content: application/json: examples: - example: - description: example - value: - data: null - errors: - code: 7673 - description: '''%s'' is not a valid countryCodeA3 value' - links: null + badRequestErrorExample: + $ref: '#/components/examples/badRequestErrorExample' schema: - $ref: '#/components/schemas/portingLosingCarriersResponseSchema' - description: Error returned when the country code is invalid + $ref: '#/components/schemas/genericError' + description: Bad Request. bulkRateCenterGetResponse404Error: content: application/xml: @@ -1511,44 +1814,72 @@ components: description: >- Successful response which starts the bulk upsert for provided rate centers. - listOfLosingCarriersResponse: + createAddressResponse: + content: + application/json: + schema: + $ref: '#/components/schemas/createUpdateAddressResponse' + description: Created. + forbiddenError: content: application/json: examples: - example: - value: - data: - losingCarriers: - - name: Losing Carrier 1 - - name: Losing Carrier 2 - - name: Losing Carrier 3 - - name: Losing Carrier 4 - errors: null - links: - - href: /portingLosingCarriers - method: GET - rel: self + forbiddenErrorExample: + $ref: '#/components/examples/forbiddenErrorExample' + schema: + $ref: '#/components/schemas/genericError' + description: Forbidden. + getAddressFieldsResponse: + content: + application/json: + schema: + $ref: '#/components/schemas/getAddressFieldsResponse' + description: OK. + getAddressResponse: + content: + application/json: + schema: + $ref: '#/components/schemas/genericAddressResponse' + description: OK. + internalServerError: + content: + application/json: + examples: + internalServerErrorExample: + $ref: '#/components/examples/internalServerErrorExample' + schema: + $ref: '#/components/schemas/genericError' + description: Internal Server Error. + listAddressesResponse: + content: + application/json: + schema: + $ref: '#/components/schemas/listAddressesResponse' + description: OK. + listOfLosingCarriersResponse: + content: + application/json: schema: $ref: '#/components/schemas/portingLosingCarriersResponseSchema' description: A list of available carriers that can port out a phone number - noUpstreamServicesLosingCarriersResponse: + notAllowedError: content: application/json: examples: - example: - summary: example - value: - data: null - errors: - code: 7678 - description: >- - We received an error while attempting to retrieve the losing - carriers for your request. Please try this request again - later. - links: null + notAllowedErrorExample: + $ref: '#/components/examples/notAllowedErrorExample' schema: - $ref: '#/components/schemas/portingLosingCarriersResponseSchema' - description: Error returned when upstream services are unavailable + $ref: '#/components/schemas/genericError' + description: Method Not Allowed. + notFoundError: + content: + application/json: + examples: + notFoundErrorExample: + $ref: '#/components/examples/notFoundErrorExample' + schema: + $ref: '#/components/schemas/genericError' + description: Not Found. rateCenter401Error: content: application/json: @@ -1933,12 +2264,42 @@ components: schema: $ref: '#/components/schemas/tfvError' description: Client is providing incorrect or invalid credentials. + tooManyRequestsError: + content: + application/json: + examples: + tooManyRequestsErrorExample: + $ref: '#/components/examples/tooManyRequestsErrorExample' + schema: + $ref: '#/components/schemas/genericError' + description: Too Many Requests. + unauthorizedError: + content: + application/json: + examples: + unauthorizedErrorExample: + $ref: '#/components/examples/unauthorizedErrorExample' + schema: + $ref: '#/components/schemas/genericError' + description: Unauthorized. + updateAddressResponse: + content: + application/json: + schema: + $ref: '#/components/schemas/createUpdateAddressResponse' + description: OK. useCasesResponse: content: application/json: schema: $ref: '#/components/schemas/useCases' description: OK + validateAddressResponse: + content: + application/json: + schema: + $ref: '#/components/schemas/validateAddressResponse' + description: OK. verifyPostResponse: description: Accepted verifyStatusResponse: @@ -2121,30 +2482,25 @@ components: TollFreeMMSAllowed: type: boolean type: object - AccountProduct: + AccountProductResponse: properties: - Features: - items: - properties: - Feature: - type: string - type: object - type: array - Name: - type: string + product: + oneOf: + - $ref: '#/components/schemas/productWithCountrySettings' + - $ref: '#/components/schemas/product' type: object - AccountProducts: + AccountProductsResponse: properties: - Product: + products: items: - $ref: '#/components/schemas/AccountProduct' + $ref: '#/components/schemas/productWithCountrySettings' type: array + xml: + name: Products + wrapped: true type: object - AccountProductsResponse: - properties: - Products: - $ref: '#/components/schemas/AccountProducts' - type: object + xml: + name: AccountProductsResponse AccountResponse: properties: Account: @@ -2211,6 +2567,34 @@ components: type: integer type: object type: object + ActivationRequirement: + properties: + CountryCodeA3: + type: string + PhoneNumberType: + $ref: '#/components/schemas/phoneNumberType' + ProofOfAddressRequired: + type: boolean + ProofOfIdRequired: + type: boolean + TypeOfAddress: + $ref: '#/components/schemas/TypeOfAddress' + type: object + ActivationRequirementErrorResponse: + properties: + ActivationRequirementResponse: + $ref: '#/components/schemas/ResponseStatus' + type: object + ActivationRequirementResponse: + properties: + ActivationRequirementResponse: + properties: + ActivationRequirements: + items: + $ref: '#/components/schemas/ActivationRequirement' + type: array + type: object + type: object ActivationStatus: properties: ActivationStatus: @@ -2325,12 +2709,6 @@ components: type: string Latitude: type: string - LegacyAddressId: - deprecated: true - type: string - LegacyEntityId: - deprecated: true - type: string Longitude: type: string PlusFour: @@ -2350,10 +2728,6 @@ components: ServiceAddress. This element is optional when not needed to fully specify the ServiceAddress. type: string - RegionId: - deprecated: true - format: int32 - type: integer ResetAddressFields: type: boolean StateCode: @@ -2599,16 +2973,10 @@ components: $ref: '#/components/schemas/CallbackCreds' CallbackTimeout: type: string - CallbackUrl: - deprecated: true - type: string InboundCallbackCreds: $ref: '#/components/schemas/CallbackCreds' InboundCallbackUrl: type: string - MsgCallbackUrl: - deprecated: true - type: string OutboundCallbackCreds: $ref: '#/components/schemas/CallbackCreds' OutboundCallbackUrl: @@ -2658,15 +3026,6 @@ components: ApplicationsSettings: $ref: '#/components/schemas/ApplicationsSettings' type: object - AreaCodeSearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - AreaCodeSearchAndOrderType: - $ref: '#/components/schemas/AreaCodeSearchAndOrderType' - type: object - xml: - name: Order AreaCodeSearchAndOrderResponse: properties: order: @@ -2698,6 +3057,15 @@ components: type: object xml: name: AreaCodeSearchAndOrderType + AreaCodeSearchAndOrder_NANPA: + allOf: + - $ref: '#/components/schemas/orderMetadata' + - properties: + AreaCodeSearchAndOrderType: + $ref: '#/components/schemas/AreaCodeSearchAndOrderType' + type: object + xml: + name: Order AssociatedSipPeer: properties: PeerId: @@ -2838,42 +3206,6 @@ components: type: array type: object type: object - Bdr: - properties: - Bdr: - properties: - EndDate: - type: string - StartDate: - type: string - type: object - type: object - BdrCreationErrorResponse: - properties: - BdrCreationResponse: - $ref: '#/components/schemas/ResponseStatus' - type: object - BdrCreationResponse: - properties: - BdrCreationResponse: - properties: - Info: - type: string - type: object - type: object - BdrRetrievalErrorResponse: - properties: - BdrRetrievalResponse: - $ref: '#/components/schemas/ResponseStatus' - type: object - BdrRetrievalResponse: - properties: - BdrRetrievalResponse: - properties: - Info: - type: string - type: object - type: object BillingReport: properties: BillingReportId: @@ -4452,15 +4784,6 @@ components: type: object title: CampaignTnsResponse type: object - CitySearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - CitySearchAndOrderType: - $ref: '#/components/schemas/CitySearchAndOrderType' - type: object - xml: - name: Order CitySearchAndOrderResponse: properties: order: @@ -4494,6 +4817,15 @@ components: type: object xml: name: CitySearchAndOrderType + CitySearchAndOrder_NANPA: + allOf: + - $ref: '#/components/schemas/orderMetadata' + - properties: + CitySearchAndOrderType: + $ref: '#/components/schemas/CitySearchAndOrderType' + type: object + xml: + name: Order CitySearchResult: properties: AvailableTelephoneNumberCount: @@ -4525,15 +4857,6 @@ components: Count: type: integer type: object - CombinedSearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - CombinedSearchAndOrderType: - $ref: '#/components/schemas/CombinedSearchAndOrderType' - type: object - xml: - name: Order CombinedSearchAndOrderResponse: properties: order: @@ -4585,6 +4908,15 @@ components: type: object xml: name: CombinedSearchAndOrderType + CombinedSearchAndOrder_NANPA: + allOf: + - $ref: '#/components/schemas/orderMetadata' + - properties: + CombinedSearchAndOrderType: + $ref: '#/components/schemas/CombinedSearchAndOrderType' + type: object + xml: + name: Order Contact: properties: Email: @@ -4713,6 +5045,20 @@ components: type: object type: array type: object + CountryCoverageResponseError: + properties: + responseStatus: + $ref: '#/components/schemas/responseStatus' + type: object + xml: + name: CountryCoverageResponse + CountryCoverageResponseSuccess: + properties: + countryCoverages: + $ref: '#/components/schemas/countryCoverages' + type: object + xml: + name: CountryCoverageResponse CoverageMatrixEntry: properties: Abbreviation: @@ -5249,11 +5595,6 @@ components: type: string DisconnectTelephoneNumberOrderType: $ref: '#/components/schemas/DisconnectTelephoneNumberOrderType' - Name: - deprecated: true - description: The name of the order. - maxLength: 50 - type: string type: object type: object DisconnectTelephoneNumberOrderErrorResponse: @@ -6489,122 +6830,6 @@ components: type: object xml: name: ExistingTelephoneNumberOrderType - ExternalTnsOrder: - properties: - AccountId: - type: string - Action: - enum: - - IMPORT - - REMOVE - type: string - CreatedByUser: - type: string - CustomerOrderId: - type: string - Errors: - items: - $ref: '#/components/schemas/Error' - type: array - LastModifiedDate: - type: string - LoaType: - enum: - - CARRIER - - SUBSCRIBER - type: string - OrderCreateDate: - type: string - ProcessingStatus: - enum: - - RECEIVED - - PROCESSING - - COMPLETE - - PARTIAL - - FAILED - type: string - SipPeerId: - type: string - SiteId: - type: string - TelephoneNumbers: - items: - $ref: '#/components/schemas/TelephoneNumber' - type: array - type: object - ExternalTnsOrderErrorResponse: - properties: - ExternalTnsOrderResponse: - $ref: '#/components/schemas/ResponseStatus' - type: object - ExternalTnsOrderRequest: - properties: - ExternalTnsOrder: - properties: - Action: - description: Indentify the action on external TNs - enum: - - IMPORT - - REMOVE - type: string - CustomerOrderId: - description: An order ID created by the customer for their tracking purposes - format: Only alphanumeric values, dashes and spaces are allowed - maxLength: 40 - type: string - LoaType: - default: CARRIER - description: Identify the LoaType on external TNs - enum: - - CARRIER - - SUBSCRIBER - type: string - SipPeerId: - description: >- - The ID of the SIP Peer that the Telephone Numbers are to be - provisioned to - format: int32 - type: integer - SiteId: - description: >- - The ID of the Site that the Telephone Numbers are to be - provisioned to - format: int32 - type: integer - TelephoneNumbers: - items: - $ref: '#/components/schemas/TelephoneNumber' - type: array - required: - - SiteId - - Action - type: object - type: object - ExternalTnsOrderResponse: - properties: - ExternalTnsOrderResponse: - properties: - ExternalTnsOrder: - $ref: '#/components/schemas/ExternalTnsOrder' - type: object - type: object - ExternalTnsOrders: - properties: - ExternalTnsOrders: - properties: - ExternalTnsOrder: - items: - $ref: '#/components/schemas/ExternalTnsOrder' - type: array - TotalCount: - type: integer - type: object - type: object - ExternalTnsOrdersError: - properties: - ExternalTnsOrders: - $ref: '#/components/schemas/ResponseStatus' - type: object Feature: properties: Status: @@ -6975,8 +7200,6 @@ components: required: - TelephoneNumbers - SiteId - - Subscriber - - LoaAuthorizingPerson type: object title: ImportTnOrder ImportTnOrderResponse: @@ -7364,15 +7587,6 @@ components: Description: type: string type: object - LATASearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - LATASearchAndOrderType: - $ref: '#/components/schemas/LATASearchAndOrderType' - type: object - xml: - name: Order LATASearchAndOrderResponse: properties: order: @@ -7404,6 +7618,15 @@ components: type: object xml: name: LATASearchAndOrderType + LATASearchAndOrder_NANPA: + allOf: + - $ref: '#/components/schemas/orderMetadata' + - properties: + LATASearchAndOrderType: + $ref: '#/components/schemas/LATASearchAndOrderType' + type: object + xml: + name: Order LNPResponseWrapper: properties: LNPResponseWrapper: @@ -8630,10 +8853,6 @@ components: to fully specify the ServiceAddress. maxLength: 2 type: string - RegionId: - deprecated: true - format: int32 - type: integer StateCode: description: >- StateCode is the 2-letter abbreviation of the state of the @@ -9081,6 +9300,52 @@ components: TotalCount: type: integer type: object + NANPATNDetail: + description: Returned when `enableTnDetail=True` for NANPA numbers + properties: + LATA: + example: 426 + type: number + xml: + name: LATA + city: + $ref: '#/components/schemas/city' + countryCodeA3: + $ref: '#/components/schemas/countryCodeA3' + fullNumber: + example: 17722029845 + type: string + xml: + name: FullNumber + phoneNumberType: + $ref: '#/components/schemas/phoneNumberType' + rateCenter: + example: SEBASTIAN + type: string + xml: + name: RateCenter + state: + example: FL + type: string + xml: + name: State + tier: + example: 0 + type: number + xml: + name: Tier + vendorId: + example: 49 + type: number + xml: + name: VendorId + vendorName: + example: Bandwidth CLEC + type: string + xml: + name: VendorName + title: NANPA TN Detail + type: object NNRoute: properties: DeliveryNetwork: @@ -9101,15 +9366,6 @@ components: trafficType: type: string type: object - NPANXXSearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - NPANXXSearchAndOrderType: - $ref: '#/components/schemas/NPANXXSearchAndOrderType' - type: object - xml: - name: Order NPANXXSearchAndOrderResponse: properties: order: @@ -9143,6 +9399,15 @@ components: type: object xml: name: NPANXXSearchAndOrderType + NPANXXSearchAndOrder_NANPA: + allOf: + - $ref: '#/components/schemas/orderMetadata' + - properties: + NPANXXSearchAndOrderType: + $ref: '#/components/schemas/NPANXXSearchAndOrderType' + type: object + xml: + name: Order NonPortableTollFreeNumberList: properties: DeniedTollFreeNumberList: @@ -9586,6 +9851,29 @@ components: $ref: '#/components/schemas/OriginationRoutePayload' type: array type: object + OtherTNDetail: + description: Returned when `enableTnDetail=True` for Other numbers + properties: + areaCode: + $ref: '#/components/schemas/areaCode' + city: + $ref: '#/components/schemas/city' + countryCodeA3: + $ref: '#/components/schemas/countryCodeA3' + fullNumber: + example: 31208908115 + type: string + xml: + name: FullNumber + phoneNumberType: + $ref: '#/components/schemas/phoneNumberType' + tier: + example: 0 + type: number + xml: + name: Tier + title: Other TN Detail + type: object PaginationLinks: properties: first: @@ -9601,7 +9889,7 @@ components: PhoneNumber: properties: PhoneNumber: - description: Simple Telephone Number. + description: Telephone Number in E.164 format. type: string type: object PidfloAddressDeleting911Order: @@ -10412,15 +10700,6 @@ components: $ref: '#/components/schemas/LnpCheckerTnList' title: Rate Center information type: object - RateCenterSearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - RateCenterSearchAndOrderType: - $ref: '#/components/schemas/RateCenterSearchAndOrderType' - type: object - xml: - name: Order RateCenterSearchAndOrderResponse: properties: order: @@ -10456,6 +10735,15 @@ components: type: object xml: name: RateCenterSearchAndOrderType + RateCenterSearchAndOrder_NANPA: + allOf: + - $ref: '#/components/schemas/orderMetadata' + - properties: + RateCenterSearchAndOrderType: + $ref: '#/components/schemas/RateCenterSearchAndOrderType' + type: object + xml: + name: Order RateCenterSearchResult: properties: Abbreviation: @@ -10988,6 +11276,35 @@ components: type: integer type: object type: object + Restriction: + properties: + CountryCodeA3: + type: string + RestrictionCategory: + type: string + RestrictionDescription: + type: string + RestrictionType: + $ref: '#/components/schemas/RestrictionType' + type: object + RestrictionResponse: + properties: + RestrictionResponse: + properties: + Restrictions: + items: + $ref: '#/components/schemas/Restriction' + type: array + type: object + type: object + RestrictionType: + enum: + - LEGAL + - PURCHASE + - SERVICE + - NRA + example: LEGAL + type: string RogerTerminationSettings: properties: SubnetAddressingAllowed: @@ -11043,46 +11360,33 @@ components: type: object SearchResult: oneOf: - - properties: - ResultCount: - format: int32 - type: integer - TelephoneNumberList: - items: - $ref: '#/components/schemas/TelephoneNumber' - type: array - type: object - - properties: - resultCount: - format: int32 - type: integer - telephoneNumberDetailList: - items: - $ref: '#/components/schemas/telephoneNumberDetail' - type: array - xml: - name: TelephoneNumberDetailList - xml: - name: ResultCount - type: object + - $ref: '#/components/schemas/TNDetailDisabled' + - $ref: '#/components/schemas/TNDetailEnabled' xml: name: SearchResult SearchResultError: properties: - Error: + error: properties: - Code: + code: + example: 4010 type: integer - Description: + xml: + name: Code + description: + example: >- + One of more required search parameters are null or empty, please + refer to the api documentation type: string + xml: + name: Description type: object + xml: + name: Error title: SearchResult type: object - SearchResultErrorWrapper: - properties: - SearchResult: - $ref: '#/components/schemas/SearchResultError' - type: object + xml: + name: SearchResult SearchResultForAvailableNpaNxx: properties: AvailableNpaNxxList: @@ -11693,13 +11997,6 @@ components: MessagingSettings: description: Does this telephone number have any messaging system configured type: string - NumberFormat: - enum: - - 10digit - - 11digit - - e164 - - 'false' - type: string RPIDFormat: description: Telephone number RPID format enum: @@ -11719,26 +12016,6 @@ components: type: string type: array type: object - SipPeerTelephoneNumberBulk: - properties: - SipPeerTelephoneNumbers: - items: - type: string - xml: - name: FullNumber - maxItems: 5000 - type: array - type: object - SipPeerTelephoneNumberBulkErrorResponse: - properties: - SipPeerTelephoneNumberMoveResponse: - $ref: '#/components/schemas/ResponseStatus' - type: object - SipPeerTelephoneNumberBulkResponse: - properties: - SipPeerTelephoneNumberMoveResponse: - $ref: '#/components/schemas/SipPeerTelephoneNumberBulk' - type: object SipPeerTelephoneNumberResponse: properties: SipPeerTelephoneNumber: @@ -11902,21 +12179,6 @@ components: Name: type: string type: object - SiteOrdersResponse: - properties: - ResponseSelectWrapper: - properties: - ListOrderIdUserIdDate: - properties: - OrderIdUserIdDate: - items: - $ref: '#/components/schemas/OrderSummary' - type: array - TotalCount: - type: integer - type: object - type: object - type: object SitePayload: properties: Address: @@ -12074,15 +12336,6 @@ components: type: integer title: HttpSettings type: object - StateSearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - StateSearchAndOrderType: - $ref: '#/components/schemas/StateSearchAndOrderType' - type: object - xml: - name: Order StateSearchAndOrderResponse: properties: order: @@ -12114,6 +12367,15 @@ components: type: object xml: name: StateSearchAndOrderType + StateSearchAndOrder_NANPA: + allOf: + - $ref: '#/components/schemas/orderMetadata' + - properties: + StateSearchAndOrderType: + $ref: '#/components/schemas/StateSearchAndOrderType' + type: object + xml: + name: Order StateWithCount: properties: Count: @@ -12284,7 +12546,6 @@ components: - lsrorders - e911s - tnoptions - - externalTns - lidb - bulkPortins - importtnorders @@ -12332,6 +12593,43 @@ components: type: array type: object type: object + TNDetailDisabled: + properties: + resultCount: + example: 1 + type: integer + xml: + name: ResultCount + telephoneNumberList: + items: + example: '+17722029845' + type: string + xml: + name: TelephoneNumber + type: array + xml: + name: TelephoneNumberList + wrapped: true + title: TN Detail Disabled + type: object + TNDetailEnabled: + properties: + resultCount: + example: 1 + type: integer + xml: + name: ResultCount + telephoneNumberDetailList: + items: + oneOf: + - $ref: '#/components/schemas/NANPATNDetail' + - $ref: '#/components/schemas/OtherTNDetail' + type: array + xml: + name: TelephoneNumberDetailList + wrapped: true + title: TN Detail Enabled + type: object TNSipPeersResponse: properties: SipPeers: @@ -12429,7 +12727,7 @@ components: TelephoneNumber: properties: TelephoneNumber: - description: Simple Telephone Number. + description: Telephone Number in E.164 format. type: string type: object TelephoneNumberAvailableNnRoutes: @@ -13504,16 +13802,16 @@ components: OrderResponse: oneOf: - $ref: '#/components/schemas/ExistingTelephoneNumberOrder' - - $ref: '#/components/schemas/RateCenterSearchAndOrder' - - $ref: '#/components/schemas/AreaCodeSearchAndOrder' - - $ref: '#/components/schemas/NPANXXSearchAndOrder' - - $ref: '#/components/schemas/TollFreeWildCharSearchAndOrder' - - $ref: '#/components/schemas/TollFreeVanitySearchAndOrder' - - $ref: '#/components/schemas/LATASearchAndOrder' - - $ref: '#/components/schemas/ZIPSearchAndOrder' - - $ref: '#/components/schemas/CitySearchAndOrder' - - $ref: '#/components/schemas/StateSearchAndOrder' - - $ref: '#/components/schemas/CombinedSearchAndOrder' + - $ref: '#/components/schemas/RateCenterSearchAndOrder_NANPA' + - $ref: '#/components/schemas/AreaCodeSearchAndOrder_NANPA' + - $ref: '#/components/schemas/NPANXXSearchAndOrder_NANPA' + - $ref: '#/components/schemas/TollFreeWildCharSearchAndOrder_NANPA' + - $ref: '#/components/schemas/TollFreeVanitySearchAndOrder_NANPA' + - $ref: '#/components/schemas/LATASearchAndOrder_NANPA' + - $ref: '#/components/schemas/ZIPSearchAndOrder_NANPA' + - $ref: '#/components/schemas/CitySearchAndOrder_NANPA' + - $ref: '#/components/schemas/StateSearchAndOrder_NANPA' + - $ref: '#/components/schemas/CombinedSearchAndOrder_NANPA' xml: name: OrderResponse type: object @@ -13577,16 +13875,16 @@ components: Order: oneOf: - $ref: '#/components/schemas/ExistingTelephoneNumberOrder' - - $ref: '#/components/schemas/RateCenterSearchAndOrder' - - $ref: '#/components/schemas/AreaCodeSearchAndOrder' - - $ref: '#/components/schemas/NPANXXSearchAndOrder' - - $ref: '#/components/schemas/TollFreeWildCharSearchAndOrder' - - $ref: '#/components/schemas/TollFreeVanitySearchAndOrder' - - $ref: '#/components/schemas/LATASearchAndOrder' - - $ref: '#/components/schemas/ZIPSearchAndOrder' - - $ref: '#/components/schemas/CitySearchAndOrder' - - $ref: '#/components/schemas/StateSearchAndOrder' - - $ref: '#/components/schemas/CombinedSearchAndOrder' + - $ref: '#/components/schemas/RateCenterSearchAndOrder_NANPA' + - $ref: '#/components/schemas/AreaCodeSearchAndOrder_NANPA' + - $ref: '#/components/schemas/NPANXXSearchAndOrder_NANPA' + - $ref: '#/components/schemas/TollFreeWildCharSearchAndOrder_NANPA' + - $ref: '#/components/schemas/TollFreeVanitySearchAndOrder_NANPA' + - $ref: '#/components/schemas/LATASearchAndOrder_NANPA' + - $ref: '#/components/schemas/ZIPSearchAndOrder_NANPA' + - $ref: '#/components/schemas/CitySearchAndOrder_NANPA' + - $ref: '#/components/schemas/StateSearchAndOrder_NANPA' + - $ref: '#/components/schemas/CombinedSearchAndOrder_NANPA' OrderCompleteDate: type: string OrderStatus: @@ -13817,15 +14115,6 @@ components: TerminationSettings: $ref: '#/components/schemas/TollFreeSettings' type: object - TollFreeVanitySearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - TollFreeVanitySearchAndOrderType: - $ref: '#/components/schemas/TollFreeVanitySearchAndOrderType' - type: object - xml: - name: Order TollFreeVanitySearchAndOrderResponse: properties: order: @@ -13857,12 +14146,12 @@ components: type: object xml: name: TollFreeVanitySearchAndOrderType - TollFreeWildCharSearchAndOrder: + TollFreeVanitySearchAndOrder_NANPA: allOf: - $ref: '#/components/schemas/orderMetadata' - properties: - TollFreeWildCharSearchAndOrderType: - $ref: '#/components/schemas/TollFreeWildCharSearchAndOrderType' + TollFreeVanitySearchAndOrderType: + $ref: '#/components/schemas/TollFreeVanitySearchAndOrderType' type: object xml: name: Order @@ -13897,6 +14186,15 @@ components: type: object xml: name: TollFreeWildCharSearchAndOrderType + TollFreeWildCharSearchAndOrder_NANPA: + allOf: + - $ref: '#/components/schemas/orderMetadata' + - properties: + TollFreeWildCharSearchAndOrderType: + $ref: '#/components/schemas/TollFreeWildCharSearchAndOrderType' + type: object + xml: + name: Order Tpas: items: $ref: '#/components/schemas/Tpa' @@ -13908,6 +14206,13 @@ components: Ratio: type: integer type: object + TypeOfAddress: + enum: + - WORLDWIDE + - NATIONAL + - LOCAL + example: WORLDWIDE + type: string UcTrunkingCloudSettings: properties: BiDirectionalTrunks: @@ -14090,15 +14395,6 @@ components: type: string title: WirelessInfo type: object - ZIPSearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - ZIPSearchAndOrderType: - $ref: '#/components/schemas/ZIPSearchAndOrderType' - type: object - xml: - name: Order ZIPSearchAndOrderResponse: properties: order: @@ -14130,6 +14426,15 @@ components: type: object xml: name: ZIPSearchAndOrderType + ZIPSearchAndOrder_NANPA: + allOf: + - $ref: '#/components/schemas/orderMetadata' + - properties: + ZIPSearchAndOrderType: + $ref: '#/components/schemas/ZIPSearchAndOrderType' + type: object + xml: + name: Order Zone: properties: Id: @@ -14143,6 +14448,17 @@ components: description: User's account ID example: '1234567' type: string + additionalDetails: + properties: + comment: + description: Comment + example: Updating regulations + type: string + xml: + name: Comment + type: object + xml: + name: AdditionalDetails address: nullable: false properties: @@ -14193,6 +14509,115 @@ components: - zip - url type: object + addressFieldSchema: + properties: + changeable: + description: The address field value can be updated or not + example: false + title: Field Changeable + type: boolean + fieldName: + description: The name of the address field + example: addressLine1 + title: Field Name + type: string + maxLength: + description: The legth of the address field + example: 256 + title: Field Length + type: integer + required: + description: The address field is required or optional + example: true + title: Field Required + type: boolean + type: + description: The data type of the address field + example: string + title: Field Data Type + type: string + usedBy: + items: + properties: + feature: + description: The name of the feature that this address could be used for + enum: + - EMERGENCY + - PORTING + - REQUIREMENTS_PACKAGE + example: EMERGENCY + title: Feature Name + type: string + required: + description: The address field is required or optional for this feature + example: true + title: Field Required + type: boolean + type: object + title: Feature Specific Requirements + type: array + title: Country Specific Address Fields Schema + type: object + addressId: + description: Address Id + example: daa9dd0f-de97-4103-8530-b31bf4be8fc0 + title: Address Id + type: string + addressLinks: + items: + oneOf: + - $ref: '#/components/schemas/selfLink' + title: Links + type: array + addressResponse: + properties: + addressId: + $ref: '#/components/schemas/addressId' + addressLine1: + description: The number and street address of the address. + example: 14111 NE 145th St + title: Address Line1 + type: string + addressLine2: + description: The number and street address of the address. + example: Apt. 8 + title: Address Line2 + type: string + city: + $ref: '#/components/schemas/city' + countryCodeA3: + $ref: '#/components/schemas/countryCodeA3' + createdDateTime: + $ref: '#/components/schemas/createdDateTime' + customReference: + $ref: '#/components/schemas/customReference' + isHidden: + $ref: '#/components/schemas/isHidden' + postalCode: + $ref: '#/components/schemas/postalCode' + state: + description: The state or region of the address. + example: WA + title: State + type: string + updatedDateTime: + $ref: '#/components/schemas/updatedDateTime' + title: '=Address Response' + type: object + areaCode: + description: The 1 to 6 digit area code associated with the phone number. + example: '435' + title: Area Code + type: string + xml: + name: AreaCode + city: + description: The city of the address. + example: Raleigh + title: City + type: string + xml: + name: City contact: nullable: false properties: @@ -14216,6 +14641,158 @@ components: - email - phoneNumber type: object + countryCodeA3: + description: Country code of the address in ISO 3166-1 alpha-3 format. + example: USA + title: Country Code + type: string + xml: + name: CountryCodeA3 + countryCoverage: + properties: + countryCodeA3: + $ref: '#/components/schemas/countryCodeA3' + phoneNumberType: + $ref: '#/components/schemas/phoneNumberType' + regions: + items: + $ref: '#/components/schemas/region' + type: array + xml: + name: Regions + wrapped: true + type: object + xml: + name: CountryCoverage + countryCoverages: + items: + $ref: '#/components/schemas/countryCoverage' + type: array + xml: + name: CountryCoverages + wrapped: true + countrySetting: + properties: + additionalDetails: + $ref: '#/components/schemas/additionalDetails' + countryCodeA3: + $ref: '#/components/schemas/countryCodeA3' + features: + description: List of features configured for the specified countryCodeA3 + items: + properties: + featureName: + description: Feature Name + example: Ordering + type: string + xml: + name: FeatureName + isDisabled: + description: Feature Status + example: true + type: boolean + xml: + name: IsDisabled + type: object + xml: + name: Feature + type: array + xml: + name: Features + wrapped: true + phoneNumberType: + $ref: '#/components/schemas/phoneNumberType' + type: object + xml: + name: CountrySetting + countrySettings: + items: + $ref: '#/components/schemas/countrySetting' + type: array + xml: + name: CountrySettings + wrapped: true + createAddressRequest: + properties: + addressLine1: + description: The number and street address of the address. + example: 14111 NE 145th St + title: Address Line1 + type: string + addressLine2: + description: The number and street address of the address. + example: Apt. 8 + title: Address Line2 + type: string + city: + $ref: '#/components/schemas/city' + countryCodeA3: + $ref: '#/components/schemas/countryCodeA3' + customReference: + $ref: '#/components/schemas/customReference' + isHidden: + $ref: '#/components/schemas/isHidden' + postalCode: + $ref: '#/components/schemas/postalCode' + state: + description: The state or region of the address. + example: WA + title: State + type: string + title: Create Address Request + type: object + createUpdateAddressLink: + properties: + href: + description: URI of the link. + example: /accounts/{accountId}/addresses/{addressId} + type: string + method: + description: HTTP method to be used. + example: GET + type: string + rel: + description: Specifies the link to get the updated or created address. + example: RelatedResource + type: string + title: Create Address Link + type: object + createUpdateAddressLinks: + items: + oneOf: + - $ref: '#/components/schemas/selfLink' + - $ref: '#/components/schemas/createUpdateAddressLink' + title: Links + type: array + createUpdateAddressResponse: + properties: + data: + properties: + address: + $ref: '#/components/schemas/addressResponse' + type: object + errors: + example: [] + items: + $ref: '#/components/schemas/error' + type: array + links: + $ref: '#/components/schemas/createUpdateAddressLinks' + title: Update Address Response + type: object + createdDateTime: + description: The created date time in ISO 8601 format. + example: '2015-03-11T04:09:25.399Z' + type: string + customReference: + description: >- + Customer reference. It can be used for your own reference, e.g. to + uniquely identify one of your customers. + example: home_office + maxLength: 64 + minLength: 1 + title: Customer Reference + type: string denialReasonDescription: description: Denial reason explanation example: Disallowed Content - Gambling @@ -14232,6 +14809,65 @@ components: pattern: >- ^(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$ type: string + error: + properties: + code: + description: >- + An application-specific error code for services with extensive error + scenarios to supplement `description`. + example: 51130 + format: int32 + minimum: 4 + type: integer + description: + description: >- + A human-readable explanation that SHOULD be specific to this + occurrence of the problem. + example: There was an issue with a field in your request body + type: string + id: + description: A unique identifier for this particular instance of this problem. + example: optional-error-id + type: string + meta: + description: >- + A meta object containing application-specific information or + non-standard metadata about the error. + type: object + source: + $ref: '#/components/schemas/errorSource' + type: + description: >- + A short, human-readable summary of the problem that SHOULD NOT + change from occurrence to occurrence of the problem. + example: REQUEST_ERROR + type: string + required: + - description + title: Error + type: object + errorSource: + properties: + field: + description: A string indicating which request body field caused the error. + example: someField + type: string + header: + description: A string indicating which header field caused the error. + example: someHeader + type: string + parameter: + description: A string indicating which URI query parameter caused the error. + example: someParameter + type: string + reference: + description: >- + A string that references a resource ID or path to the resource (or + non-existent resource) causing the error. + example: /some/reference + type: string + title: Error Source + type: object failureWebhookRequest: properties: accountId: @@ -14276,6 +14912,56 @@ components: type: string type: object type: object + genericAddressResponse: + properties: + data: + properties: + address: + $ref: '#/components/schemas/addressResponse' + type: object + errors: + example: [] + items: + $ref: '#/components/schemas/error' + type: array + links: + $ref: '#/components/schemas/addressLinks' + title: Address Response + type: object + genericError: + properties: + errors: + items: + $ref: '#/components/schemas/error' + nullable: true + type: array + required: + - errors + title: Generic Error + type: object + getAddressFieldsResponse: + properties: + data: + properties: + addressFields: + items: + $ref: '#/components/schemas/addressFieldSchema' + type: array + type: object + errors: + example: [] + items: + $ref: '#/components/schemas/error' + type: array + title: Get Address Fields Response + type: object + isHidden: + description: >- + Hide Address. It can be used to hide the address when it is no longer + needed. + example: false + title: Hide Address + type: boolean jsonPatch: items: $ref: '#/components/schemas/jsonPatchItem' @@ -14306,6 +14992,64 @@ components: - op - path type: object + listAddressesLinks: + items: + oneOf: + - $ref: '#/components/schemas/selfLink' + - $ref: '#/components/schemas/listPrevPageAddressesLink' + - $ref: '#/components/schemas/listNextPageAddressesLink' + title: Links + type: array + listAddressesResponse: + properties: + data: + properties: + addresses: + items: + $ref: '#/components/schemas/addressResponse' + type: array + type: object + errors: + example: [] + items: + $ref: '#/components/schemas/error' + type: array + links: + $ref: '#/components/schemas/listAddressesLinks' + title: List Addresses Response + type: object + listNextPageAddressesLink: + properties: + href: + description: URI of the link. + example: /accounts/{accountId}/addresses?afterCursor={cursorId} + type: string + method: + description: HTTP method to be used. + example: GET + type: string + rel: + description: Specifies the link to next page + example: RelatedResource + type: string + title: Address Link for Next Page + type: object + listPrevPageAddressesLink: + properties: + href: + description: URI of the link. + example: /accounts/{accountId}/addresses?beforeCursor={cursorId} + type: string + method: + description: HTTP method to be used. + example: GET + type: string + rel: + description: Specifies the link to previous page + example: RelatedResource + type: string + title: Address Link for Previous Page + type: object lnpPortInfoForGivenStatus: properties: ActualFOCDate: @@ -14450,55 +15194,135 @@ components: name: OrderCreateDate type: object type: object + phoneNumberType: + description: Phone number type + enum: + - GEOGRAPHIC + - NATIONAL + - MOBILE + - TOLL_FREE + - SHARED_COST + example: MOBILE + title: Phone Number Type + type: string + xml: + name: PhoneNumberType portingLosingCarriersResponseSchema: - description: List of losing carriers for porting properties: data: - nullable: true properties: losingCarriers: items: properties: name: - description: The name of the carrier + description: The losing carrier name. example: Losing Carrier 1 + title: Losing Carrier Name type: string type: object type: array type: object errors: + example: [] items: - properties: - code: - description: An error code identifying the error - type: string - description: - description: A description of the error - type: string - meta: - description: Additional information regarding the error - type: object - type: object - nullable: true + $ref: '#/components/schemas/error' type: array links: + $ref: '#/components/schemas/selfLink' + title: List Addresses Response + type: object + postalCode: + description: The postal code of the address. + example: '98072' + title: Postal Code + type: string + product: + properties: + features: items: - properties: - href: - description: The API endpoint URL - example: /porting/losingCarriers - type: string - method: - description: The HTTP method used to make the request - example: GET - type: string - rel: - description: The relationship of the endpoint to the request - example: self - type: string - type: object - nullable: true + description: Feature Name + example: Ordering + type: string + xml: + name: Feature + type: array + xml: + name: Features + wrapped: true + name: + description: Product Name + example: NumberManagement + type: string + xml: + name: Name + type: object + xml: + name: Product + productWithCountrySettings: + properties: + countrySettings: + $ref: '#/components/schemas/countrySettings' + features: + items: + description: Feature Name + example: Ordering + type: string + xml: + name: Feature type: array + xml: + name: Features + wrapped: true + name: + description: Product Name + example: NumberManagement + type: string + xml: + name: Name + type: object + xml: + name: Product + region: + properties: + areaCode: + $ref: '#/components/schemas/areaCode' + city: + $ref: '#/components/schemas/city' + type: object + xml: + name: Region + responseStatus: + properties: + description: + description: 'Detailed explanation about error ' + example: A supplied phoneNumberType within '[SPECIALLL]' is invalid. + type: string + xml: + name: Description + errorCode: + description: Numeric designation of corresponding error + example: 4010 + type: integer + xml: + name: ErrorCode + type: object + xml: + name: ResponseStatus + selfLink: + properties: + href: + description: URI of the link. + example: /self/uri + type: string + method: + description: HTTP method to be used. + example: GET + type: string + rel: + description: Specifies the relationship between this link and the resource. + example: SelfResource + type: string + title: Self Link type: object shortCode: description: Short code registration. @@ -15047,52 +15871,6 @@ components: - is required - can not be empty type: object - telephoneNumberDetail: - description: Returned when `enableTnDetail=True` - properties: - city: - example: MICCO - type: string - xml: - name: City - fullNumber: - example: 17722029845 - type: string - xml: - name: FullNumber - lata: - example: 46018 - type: number - xml: - name: LATA - rateCenter: - example: SEBASTIAN - type: string - xml: - name: RateCenter - state: - example: FL - type: string - xml: - name: State - tier: - example: 0 - type: number - xml: - name: Tier - vendorId: - example: 49 - type: number - xml: - name: VendorId - vendorName: - example: Bandwidth CLEC - type: string - xml: - name: VendorName - type: object - xml: - name: TelephoneNumberDetail tfPhoneNumber: description: Toll-free telephone number in E.164 format example: '+18005555555' @@ -15185,6 +15963,40 @@ components: example: abc-d8569gh type: string type: object + unsupportedFeatures: + description: Excluded Features + items: + properties: + addressCriteria: + items: + properties: + description: + description: >- + A human-readable explanation that SHOULD be specific to this + occurrence of the problem. + example: 'missing fields: addressLine2' + type: string + type: object + type: array + featureName: + description: A unique identifier for feature. + example: EMERGENCY + type: string + type: object + title: Excluded Features + type: array + updateAddressRequest: + properties: + customReference: + $ref: '#/components/schemas/customReference' + isHidden: + $ref: '#/components/schemas/isHidden' + title: Update Address Request + type: object + updatedDateTime: + description: The updated date time in ISO 8601 format. + example: '2015-03-11T04:09:25.399Z' + type: string useCase: example: 2FA maxLength: 500 @@ -15205,6 +16017,47 @@ components: items: type: string type: array + validateAddressLink: + properties: + href: + description: URI of the link. + example: /accounts/{accountId}/addresses + type: string + method: + description: HTTP method to be used. + example: POST + type: string + rel: + description: Specifies the link to create the address. + example: RelatedResource + type: string + title: Validate Address Link + type: object + validateAddressLinks: + items: + oneOf: + - $ref: '#/components/schemas/selfLink' + - $ref: '#/components/schemas/validateAddressLink' + title: Links + type: array + validateAddressResponse: + properties: + data: + properties: + address: + $ref: '#/components/schemas/createAddressRequest' + unsupportedFeatures: + $ref: '#/components/schemas/unsupportedFeatures' + type: object + errors: + example: [] + items: + $ref: '#/components/schemas/error' + type: array + links: + $ref: '#/components/schemas/validateAddressLinks' + title: Validate Address Response + type: object verificationRequest: properties: additionalInformation: @@ -15456,6 +16309,250 @@ paths: summary: Retrieve account tags: - Account + /accounts/{accountId}/activationRequirements: + get: + description: >- + Some numbers have to be activated before the service can be enabled by + Bandwidth. Activating a number is done by providing an activation that + links to the number, and a proof of residency if required. This API + provides all countries and number types that need activation. + operationId: ListActivationRequirements + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - $ref: '#/components/parameters/countryCodeA3QueryParam' + - $ref: '#/components/parameters/phoneNumberTypeQueryParam' + responses: + '200': + content: + application/xml: + examples: + example: + value: |- + + + + + BEL + GEOGRAPHIC + WORLDWIDE + false + true + + + ITA + GEOGRAPHIC + WORLDWIDE + false + true + + + ZAF + GEOGRAPHIC + WORLDWIDE + false + true + + + TUR + GEOGRAPHIC + WORLDWIDE + false + true + + + + schema: + $ref: '#/components/schemas/ActivationRequirementResponse' + description: >- + This response returns the list of cities, along with the Rate + Centers that serve those Activation Requirements. If available is + specified then the number of TNs available in that city / RC + combination is also included. + '404': + content: + application/xml: + examples: + AccountNotFound: + description: >- + Below is an example of response API will produce when given + account is not found or locked. + value: |- + + + + 4022 + Account '2' does not exist or is locked + + + GlobalServicesNotEnabled: + description: >- + Below is an example of response API will produce when Global + Services are not enabled for an account. + value: |- + + + + 4026 + Global Services are currently disabled for the account. Please contact support if you believe Global Services should be enabled. + + + schema: + $ref: '#/components/schemas/ActivationRequirementErrorResponse' + description: >- + This error response is returned when Activation Requirements can not + be fetched for given customer/account because Global Services are + not enabled. In order to get activation requirement information, + Global Services setting must be enabled for the account. + summary: List Activation Requirements + tags: + - Compliance + /accounts/{accountId}/addresses: + get: + description: >- + List all addresses. The results are sorted by last updated time in + reverse chronological order by default without any query filters. + operationId: listAddresses + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - $ref: '#/components/parameters/customReferenceQueryParam_eq_startsWith' + - $ref: '#/components/parameters/countryCodeA3QueryParam_eq' + - $ref: '#/components/parameters/cityQueryParam_eq_startsWith' + - $ref: '#/components/parameters/postalCodeQueryParam_eq_startsWith' + - $ref: '#/components/parameters/isHiddenQueryParam_eq' + - $ref: '#/components/parameters/beforeCursorQueryParam_eq' + - $ref: '#/components/parameters/afterCursorQueryParam_eq' + - $ref: '#/components/parameters/limitQueryParam_eq' + responses: + '200': + $ref: '#/components/responses/listAddressesResponse' + '400': + $ref: '#/components/responses/badRequestError' + '401': + $ref: '#/components/responses/unauthorizedError' + '403': + $ref: '#/components/responses/forbiddenError' + '404': + $ref: '#/components/responses/notFoundError' + '405': + $ref: '#/components/responses/notAllowedError' + '429': + $ref: '#/components/responses/tooManyRequestsError' + '500': + $ref: '#/components/responses/internalServerError' + summary: List Addresses + tags: + - Addresses + post: + description: >- + Create an address. Use GET /adddresses/fields for a full list of country + specific address fields. + operationId: addAddress + requestBody: + $ref: '#/components/requestBodies/addAddressRequest' + responses: + '201': + $ref: '#/components/responses/createAddressResponse' + '400': + $ref: '#/components/responses/badRequestError' + '401': + $ref: '#/components/responses/unauthorizedError' + '403': + $ref: '#/components/responses/forbiddenError' + '404': + $ref: '#/components/responses/notFoundError' + '405': + $ref: '#/components/responses/notAllowedError' + '429': + $ref: '#/components/responses/tooManyRequestsError' + '500': + $ref: '#/components/responses/internalServerError' + summary: Add Address + tags: + - Addresses + /accounts/{accountId}/addresses/validator: + post: + description: >- + Returns features that will NOT work for the entered address. Please note + that if a feature is absent from unsupportedFeatures, it does not + guarantee that it will pass validation and can be used. + operationId: validateAddress + requestBody: + $ref: '#/components/requestBodies/addAddressRequest' + responses: + '200': + $ref: '#/components/responses/validateAddressResponse' + '400': + $ref: '#/components/responses/badRequestError' + '401': + $ref: '#/components/responses/unauthorizedError' + '403': + $ref: '#/components/responses/forbiddenError' + '404': + $ref: '#/components/responses/notFoundError' + '405': + $ref: '#/components/responses/notAllowedError' + '429': + $ref: '#/components/responses/tooManyRequestsError' + '500': + $ref: '#/components/responses/internalServerError' + summary: Validate Address + tags: + - Addresses + /accounts/{accountId}/addresses/{addressId}: + get: + description: Get an address. + operationId: getAddress + parameters: + - $ref: '#/components/parameters/addressIdPathParam' + responses: + '200': + $ref: '#/components/responses/getAddressResponse' + '400': + $ref: '#/components/responses/badRequestError' + '401': + $ref: '#/components/responses/unauthorizedError' + '403': + $ref: '#/components/responses/forbiddenError' + '404': + $ref: '#/components/responses/notFoundError' + '405': + $ref: '#/components/responses/notAllowedError' + '429': + $ref: '#/components/responses/tooManyRequestsError' + '500': + $ref: '#/components/responses/internalServerError' + summary: Get Address + tags: + - Addresses + patch: + description: >- + Update an address. Use GET /adddresses/fields for a full list of country + specific address fields that can be updated. + operationId: updateAddress + parameters: + - $ref: '#/components/parameters/addressIdPathParam' + requestBody: + $ref: '#/components/requestBodies/updateAddressRequest' + responses: + '200': + $ref: '#/components/responses/updateAddressResponse' + '400': + $ref: '#/components/responses/badRequestError' + '401': + $ref: '#/components/responses/unauthorizedError' + '403': + $ref: '#/components/responses/forbiddenError' + '404': + $ref: '#/components/responses/notFoundError' + '405': + $ref: '#/components/responses/notAllowedError' + '429': + $ref: '#/components/responses/tooManyRequestsError' + '500': + $ref: '#/components/responses/internalServerError' + summary: Update Address + tags: + - Addresses /accounts/{accountId}/aeuis: get: description: GET is used to retrieve all Alternate end user identifiers. @@ -16171,7 +17268,7 @@ paths: name: areaCode required: false schema: - type: integer + type: string - description: Returns only the NPA NXX information within the specified state. example: NC in: query @@ -16234,17 +17331,118 @@ paths: $ref: >- #/components/schemas/SearchResultForAvailableNpaNxxErrorWrapper description: There are no phone numbers within the specified scope. - summary: Retrieves available Npa-Nxx tns + summary: Retrieves available Npa-Nxx tns [NANPA] tags: - Available Tns /accounts/{accountId}/availableNumbers: get: - description: |- + description: >- Retrieves the phone numbers according to the input parameters. -

In this table are presented combinations of path parameters for different type of search:

Search TypeRequired ParametersCombinational ParametersOptional Parameters
Area CodeareaCoderateCenter (state required), city (state required), state, lata, zipquantity, enableTNDetail, protected
NPA-NXXnpaNxxrateCenter (state required), city (state required), state, lata, zip, orderByquantity, enableTNDetail, protected
NPA-NXX with Local Calling AreanpaNxxquantity, LCA, enableTNDetail, protected
NPA-NXX-XnpaNxxxrateCenter (state required), city (state required), state, lata, zip, orderByquantity, enableTNDetail, protected
NPA-NXX-X with Local Calling AreanpaNxxxrateCenter (state required), city (state required), state, lata, zipquantity, LCA, enableTNDetail, protected
RateCenterrateCenter, statecity, areaCode/npaNxx/npaNxxx, lata, zip, orderByquantity, enableTNDetail, protected
RateCenter with Local Calling ArearateCenter, statequantity, LCA, enableTNDetail, protected
StatestaterateCenter, city, areaCode/npaNxx/npaNxxx, lata, zipquantity, enableTNDetail, protected
Citystate, cityrateCenter, state, areaCode/npaNxx/npaNxxx, lata, zip, orderByquantity, enableTNDetail, protected
Zip CodeziprateCenter (state required), city (state required), state, areaCode/npaNxx/npaNxxx, lata, orderByquantity, enableTNDetail, protected
LATAlatarateCenter (state required), city (state required), state, areaCode/npaNxx/npaNxxx, zipquantity, enableTNDetail, protected
Local VanitylocalVanitystate, areaCodeendsIn, quantity, protected, enableTNdetails
TollFree VanitytollFreeVanityorderByquantity
TollFree WildCardtollFreeWildCardPatternorderByquantity
+ + + In this table are presented combinations of path parameters for non US + and Canadian countries: + + | Search | Required Parameters | Combinational Parameters | Optional + Parameters | + + |:-------|:--------------------|:-------------------------|:--------------------| + + |Phone Number Type|phoneNumberType|areaCode, city, features|quantity, + enableTNDetail| + + |Area Code|areaCode|phoneNumberType, city, features|quantity, + enableTNDetail| + + |City|city|phoneNumberType, areaCode, features|quantity, enableTNDetail| + + |Product Features|features|phoneNumberType, areaCode, city|quantity, + enableTNDetail| + + + In this table are presented combinations of path parameters for + different type of search when countryCodeA3 is configured, or defaulted, + to USA and/or CAN: + + | Search | Required Parameters | Combinational Parameters | Optional + Parameters | + + |:-------|:--------------------|:-------------------------|:--------------------| + + |Area Code|areaCode|rateCenter (state required), city (state required), + state, lata, zip|quantity, enableTNDetail, protected| + + |NPA-NXX|npaNxx|rateCenter (state required), city (state required), + state, lata, zip, orderBy|quantity, enableTNDetail, protected| + + |NPA-NXX with Local Calling Area|npaNxx||quantity, LCA, enableTNDetail, + protected| + + |NPA-NXX-X|npaNxxx|rateCenter (state required), city (state required), + state, lata, zip, orderBy|quantity, enableTNDetail, protected| + + |NPA-NXX-X with Local Calling Area|npaNxxx|rateCenter (state required), + city (state required), state, lata, zip|quantity, LCA, enableTNDetail, + protected| + + |RateCenter|rateCenter, state|city, areaCode/npaNxx/npaNxxx, lata, zip, + orderBy|quantity, enableTNDetail, protected| + + |RateCenter with Local Calling Area|rateCenter, state||quantity, LCA, + enableTNDetail, protected| + + |State|state|rateCenter, city, areaCode/npaNxx/npaNxxx, lata, + zip|quantity, enableTNDetail, protected| + + |City|state, city|rateCenter, state, areaCode/npaNxx/npaNxxx, lata, zip, + orderBy|quantity, enableTNDetail, protected| + + |Zip Code|zip|rateCenter (state required), city (state required), state, + areaCode/npaNxx/npaNxxx, lata, orderBy|quantity, enableTNDetail, + protected| + + |LATA|lata|rateCenter (state required), city (state required), state, + areaCode/npaNxx/npaNxxx, zip|quantity, enableTNDetail, protected| + + |Local Vanity|localVanity|state, areaCode|endsIn, quantity, protected, + enableTNdetails| + + |TollFree Vanity|tollFreeVanity|orderBy|quantity| + + |TollFree WildCard|tollFreeWildCardPattern|orderBy|quantity| operationId: GetAvailableTns parameters: - $ref: '#/components/parameters/AccountIdPathParam' + - description: >- + Country code of the country in its ISO 3166-1 alpha-3 format. Note + that only one country code (i.e. USA, CAN, GBR etc.) is allowed when + configured by the user. The system defaults country code to search + for numbers in both United States and Canada (i.e. USA,CAN). + example: GBR + in: query + name: countryCodeA3 + required: false + schema: + default: USA,CAN + type: string + - $ref: '#/components/parameters/phoneNumberTypeQueryParam' + - $ref: '#/components/parameters/areaCodeQueryParam' + - $ref: '#/components/parameters/cityQueryParam' + - description: >- + The product features supported by number such as VOICE, + VOICE_OUTBOUND_NATIONAL, VOICE_OUTBOUND_INTERNATIONAL, + VOICE_OUTBOUND_TOLLFREE, EMERGENCY, MESSAGING_SMS. The query can be + used if you want to only list phone numbers that support certain + features. The system defaults to return phone numbers of all + features when the query parameter is not passed. Note that you can + specify multiple features by repeating the query parameter i.e. + features=VOICE&features=EMERGENCY. + example: VOICE + in: query + name: features + required: false + schema: + type: string - description: The desired quantity of requested numbers. example: 30 in: query @@ -16283,16 +17481,6 @@ paths: schema: default: false type: boolean - - description: >- -

The 3-digit area code associated with the TN.

- example: 435 - in: query - name: areaCode - required: false - schema: - type: integer - description: >-

The 6-digit prefix associated with the TN.

- summary: Check Tns hostability + summary: Check Tns importability tags: - Hosted Messaging - /accounts/{accountId}/importTnOrders: + /accounts/{accountId}/importTnOrders/messaging: get: description: > Retrieves the importtnorders requests for the given account ID. A maximum of 1,000 orders can be retrieved per request. If no date range - or specific query parameter (marked by * below) - is provided, the order results will be limited to the last two years. - operationId: ReadImportTnOrders + or required query parameter is provided, the order results will be + limited to the last two years. + + + In this table are presented capabilities that are not universally + available. The following request query parameters are only allowed for + numbers from specific region/country: + + | Number Region | Request Query Parameter | + + |:--------------|:------------------------| + + |NANP|loaType| + operationId: ReadImportMessagingTnOrders parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: The status of the importTnOrder being searched for. - example: PARTIAL - in: query - name: status - required: false - schema: - items: - type: string - type: array - - description: A Telephone Number (TN) that is referenced in the order - example: '+19199918388' - in: query - name: tn - required: true - schema: - type: string - - description: >- - The Customer Order ID is an ID assigned by the account owner to - provide a reference number for the importTnOrder. - example: ABCCorp12345 - in: query - name: customerOrderId - required: true - schema: - type: string - - description: >- - Checks the order's creation date against this value. Orders that - have a creation date after this date will be included. Format is - yyyy-MM-dd - example: '2013-10-22' - in: query - name: createdDateFrom - required: false - schema: - type: string - - description: >- - Checks the order's creation date against this value. Orders that - have a creation date before this date will be included. Format is - yyyy-MM-dd - example: '2013-10-25' - in: query - name: createdDateTo - required: false - schema: - type: string - - description: >- - For Date-based searches, the starting date of a date range - (inclusive) that will be used to find Import Tn Orders that were - modified within the date range. It is in the form yyyy-MM-dd. - example: '2013-10-22' - in: query - name: modifiedDateFrom - required: false - schema: - type: string - - description: >- - For Date-based searches, the ending date of a date range (inclusive) - that will be used to find Import Tn Orders that were modified within - the date range. It is in the form yyyy-MM-dd. - example: '2013-10-25' - in: query - name: modifiedDateTo - required: false - schema: - type: string + - $ref: '#/components/parameters/StatusQueryParam' + - $ref: '#/components/parameters/TnQueryParam' + - $ref: '#/components/parameters/CustomerOrderIdQueryParam' + - $ref: '#/components/parameters/CreatedDateFromQueryParam' + - $ref: '#/components/parameters/CreatedDateToQueryParam' + - $ref: '#/components/parameters/ModifiedDateFromQueryParam' + - $ref: '#/components/parameters/ModifiedDateToQueryParam' - description: Indentify the LoaType on TNs. example: SUBSCRIBER in: query @@ -24604,7 +25243,7 @@ paths: associated with the order, the state of the order, and a list of the successfully imported Telephone Numbers, and descriptions of any encountered errors. - summary: List Import Tn orders + summary: List Import Messaging Tn orders tags: - Hosted Messaging post: @@ -24617,7 +25256,21 @@ paths: the telephone numbers were successfully imported and "PARTIAL" if some of the telephone numbers were imported. A failed order with will have a staus of "FAILED" and no telephone numbers would have been imported. - operationId: CreateImportTnOrder + + + The following request parameters are only required for numbers from + specific region/country: + + | Number Region | Request Parameter | + + |:--------------|:------------------------| + + |NANP|LoaAuthorizingPerson| + + |NANP|LoaType| + + |NANP|Subscriber| + operationId: CreateImportMessagingTnOrder parameters: - $ref: '#/components/parameters/AccountIdPathParam' requestBody: @@ -24628,28 +25281,28 @@ paths: value: |- - ICPA123ABC + ICPA123ABC 743 - 303716 - - ABC Inc. - - 11235 - Back - Denver - CO - 27541 - Canyon - - - The Authguy - CARRIER - - +19199918388 - +14158714245 - +14352154439 - +14352154466 - + 303716 + + ABC Inc. + + 11235 + Back + Denver + CO + 27541 + Canyon + + + The Authguy + CARRIER + + +19199918388 + +14158714245 + +14352154439 + +14352154466 + schema: $ref: '#/components/schemas/ImportTnOrderRequest' @@ -24723,426 +25376,16 @@ paths: The order failed; one of the input parameters is invalid. The error text and an error code will be provided in the ErrorList element.

- summary: Import Tn order + summary: Import Messaging Tn order tags: - Hosted Messaging - /accounts/{accountId}/importTnOrders/voice: - get: - description: > - Retrieves the ImportVoiceTnOrder requests for the given account ID. A - maximum of 1,000 orders can be retrieved per request. If no date range - or specific query parameter (marked by * below) - is provided, the order results will be limited to the last two years. - operationId: ReadImportVoiceTnOrders - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - $ref: '#/components/parameters/StatusQueryParam' - - $ref: '#/components/parameters/TnQueryParam' - - $ref: '#/components/parameters/CustomerOrderIdQueryParam' - - $ref: '#/components/parameters/CreatedDateFromQueryParam' - - $ref: '#/components/parameters/CreatedDateToQueryParam' - - $ref: '#/components/parameters/ModifiedDateFromQueryParam' - - $ref: '#/components/parameters/ModifiedDateToQueryParam' - - $ref: '#/components/parameters/SipPeerIdQueryParam' - responses: - '200': - content: - application/xml: - examples: - example: - value: |- - - - 2 - - 14 - 1 - CustomerOrderId - systemUser - 2019-01-24T11:08:09.770Z - 2019-01-24T11:08:09.770Z - import_voice_tn_orders - COMPLETE - 211a103c-5f9c-4117-8833-c574bdc390fd - - - 14 - 2 - CustomerOrderId - systemUser - 2019-01-24T10:43:16.934Z - 2019-01-24T10:43:16.934Z - import_voice_tn_orders - PARTIAL - 8dc32f09-2329-4c73-b702-526f46b02712 - - - schema: - $ref: '#/components/schemas/ImportVoiceTnOrdersResponseList' - description: >- - The descriptive payload for the importVoiceTnOrders query provides - information about the orders found by the query, including the data - associated with the order, the state of the order, and a list of the - successfully imported Telephone Numbers, and descriptions of any - encountered errors. - summary: List Import Voice Tn orders - tags: - - Hosted Voice - post: - description: >- - Creates an ImportVoiceTnOrders request to add numbers under the given - site ID and sipPeer ID as specified in the body. - - A successfully submitted order will have a status of "RECEIVED". A - successfully completed order will have a status of "COMPLETE" if all of - the telephone numbers were successfully imported and "PARTIAL" if some - of the telephone numbers were imported. A failed order with will have a - staus of "FAILED" and no telephone numbers would have been imported. - operationId: CreateVoiceImportTnOrder - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - requestBody: - content: - application/xml: - examples: - example: - value: |- - - - ICPA123ABC - 743 - 303716 - - +19199918388 - +14158714245 - +14352154439 - +14352154466 - - - schema: - $ref: '#/components/schemas/ImportVoiceTnOrderRequest' - responses: - '201': - content: - application/xml: - examples: - example: - value: |- - - - - SJM000001 - 2018-01-20T02:59:54.000Z - 9900012 - smckinnon - b05de7e6-0cab-4c83-81bb-9379cba8efd0 - 2018-01-20T02:59:54.000Z - 202 - 520565 - - +19199918388 - +14158714245 - +14352154439 - +14352154466 - - PROCESSING - - - - schema: - $ref: '#/components/schemas/ImportVoiceTnOrderResponse' - description: >- - The order has been created and an order ID will be specified in the - payload and in the header. - '400': - content: - application/xml: - examples: - example: - value: |- - - - FAILED - - 7309 - The site id was not supplied or is invalid. - - - 7312 - The sippeer id is invalid. - - - schema: - $ref: '#/components/schemas/ImportVoiceTnOrderError' - description: >- - The order failed; one of the input parameters is invalid. The error - text and an error code will be provided in the ErrorList - element.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

- ErrorCode -

- 		-

- Description -

-
-

- 25010 -

- 		-

- The account does not have permission to use the endpoint requested, please contact support if you believe you should have permission. -

-
-

- 5052 -

- 		-

- Customer order ID is invalid. Only alphanumeric values, dashes and spaces are allowed. Max length is 255 characters. -

-

- 1003 -

- 		-

- SiteId is required. -

-
-

- 5073 -

- 		-

- Telephone number is required. -

-
-

- 5095 -

- 		-

- The count of telephone numbers in order exceeds the maximum size of 5000. -

-
-

- 1003 -

- 		-

- TelephoneNumbers is required. -

-

- 5070 -

- 		-

- Telephone number is invalid. -

-

- 5093 -

- 		-

- Order cannot contain duplicate telephone numbers. -

- summary: Import Voice Tn order - tags: - - Hosted Voice - /accounts/{accountId}/importTnOrders/voice/{orderId}: - get: - description: Retrieve information about a importVoiceTnOrder with specified ID. - operationId: ReadImportVoiceTnOrder - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - $ref: '#/components/parameters/OrderIdPathParam' - responses: - '200': - content: - application/xml: - examples: - example: - value: |- - - - 2018-01-09T02:58:04.615Z - 9900012 - sjm - bf1305b8-8998-1111-2222-51ba3ce52d4e - 2018-01-09T02:58:05.298Z - 65487 - 885544 - - +12106078250 - +12109678273 - +12109678331 - +12109678337 - +12266401468 - - PARTIAL - - - 7518 - Telephone Number Not Active. - - +12262665583 - - - - - schema: - $ref: '#/components/schemas/ImportVoiceTnOrderResponse' - description: >- - The information has been successfully retrieved and displayed in the - payload. - - - - - - - - - - - - - - - - - - -
-

- ErrorCode -

- 		-

- Description -

-
-

- 19014 -

- 		-

- Numbers cannot be imported by this account at this time. -

-
-

- 5061 -

- 		-

- The SiteId submitted is invalid. -

-

- 5023 -

- 		-

- SIP peer submitted is invalid. -

-
- summary: Fetch Import Voice Tn order status - tags: - - Hosted Voice - /accounts/{accountId}/importTnOrders/voice/{orderId}/history: - get: - description: Retrieves the history of the specified importVoiceTnOrder. - operationId: ReadImportVoiceTnOrderHistory - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - $ref: '#/components/parameters/OrderIdPathParam' - responses: - '200': - content: - application/xml: - examples: - example: - value: |- - - - - 2015-06-16T14:03:10.225Z - Import Voice TN order is received. - admin - RECEIVED - - - 2015-06-16T14:03:10.330Z - Import TN order is processing. - admin - PROCESSING - - - 2015-06-16T14:03:10.789Z - Import Voice TN order is partial. - admin - PARTIAL - - - schema: - $ref: '#/components/schemas/OrderHistoryWrapper' - description: >- - The history has been successfully retrieved and displayed in the - payload. - summary: Fetch Import Voice Tn order history - tags: - - Hosted Voice - /accounts/{accountId}/importTnOrders/{orderId}: + /accounts/{accountId}/importTnOrders/messaging/{orderId}: get: description: Retrieve information about a importTnOrder with specified ID. - operationId: ReadImportTnOrder + operationId: ReadImportMessagingTnOrder parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: Import Tn order's ID - example: 093a9f9b-1a78-4e47-b6e2-776a484596f4 - in: path - name: orderId - required: true - schema: - type: string + - $ref: '#/components/parameters/OrderIdPathParam' responses: '200': content: @@ -25195,22 +25438,16 @@ paths: description: >- The information has been successfully retrieved and displayed in the payload. - summary: Fetch Import Tn order status + summary: Fetch Import Messaging Tn order status tags: - Hosted Messaging - /accounts/{accountId}/importTnOrders/{orderId}/history: + /accounts/{accountId}/importTnOrders/messaging/{orderId}/history: get: description: Retrieves the history of the specified importTnOrder. - operationId: ReadImportTnOrderHistory + operationId: ReadImportMessagingTnOrderHistory parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: Import Tn order's ID - example: 093a9f9b-1a78-4e47-b6e2-776a484596f4 - in: path - name: orderId - required: true - schema: - type: string + - $ref: '#/components/parameters/OrderIdPathParam' responses: '200': content: @@ -25244,18 +25481,18 @@ paths: description: >- The history has been successfully retrieved and displayed in the payload. - summary: Fetch Import Tn order history + summary: Fetch Import Messaging Tn order history tags: - Hosted Messaging - /accounts/{accountId}/importTnOrders/{orderId}/loas: + /accounts/{accountId}/importTnOrders/messaging/{orderId}/loas: get: description: >- Retrieves the list of the loa (and other) files associated with the order. - operationId: ReadImportTnOrderLoas + operationId: ReadImportMessagingTnOrderLoas parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: Import Tn order's ID + - description: Import Messaging Tn order's ID example: 093a9f9b-1a78-4e47-b6e2-776a484596f4 in: path name: orderId @@ -25295,7 +25532,7 @@ paths: description: >- The list of all files is being returned. This response includes the case where the list is empty. - summary: Fetch Import Tn order loas + summary: Fetch Import Messaging Tn order loas [NANP] tags: - Hosted Messaging post: @@ -25337,10 +25574,10 @@ paths:
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document
    • - operationId: CreateImportTnOrderLoas + operationId: CreateImportMessagingTnOrderLoas parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: Import Tn order's ID + - description: Import Messaging Tn order's ID example: 093a9f9b-1a78-4e47-b6e2-776a484596f4 in: path name: orderId @@ -25392,16 +25629,16 @@ paths: on the identified resource. '400': description: A 400 indicates that the requested upload failed. - summary: Import Tn order loas + summary: Import Messaging Tn order loas [NANP] tags: - Hosted Messaging - /accounts/{accountId}/importTnOrders/{orderId}/loas/{fileId}: + /accounts/{accountId}/importTnOrders/messaging/{orderId}/loas/{fileId}: delete: description: Deletes the file associated with the order - operationId: DeleteImportTnOrderLoasFile + operationId: DeleteImportMessagingTnOrderLoasFile parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: Import Tn order's ID + - description: Import Messaging Tn order's ID example: 093a9f9b-1a78-4e47-b6e2-776a484596f4 in: path name: orderId @@ -25422,65 +25659,483 @@ paths: description: >- a 404 indicates that the indicated file was not found in conjunction with the order id. - summary: Removing Import Tn order loas file + summary: Removing Import Messaging Tn order loas file [NANP] + tags: + - Hosted Messaging + get: + description: Retrieves the file associated with the order. + operationId: ReadImportMessagingTnOrderLoasFile + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - description: Import Messaging Tn order's ID + example: 093a9f9b-1a78-4e47-b6e2-776a484596f4 + in: path + name: orderId + required: true + schema: + type: string + - description: File id with format + example: 093a9f9b-1a78-4e47-b6e2-776a484596f4.pdf + in: path + name: fileId + required: true + schema: + type: string + responses: + '200': + description: >- + The 200 OK indicates a successful download request.
    + + The response to the get on a filename will result in the file being + prepared and delivered in a manner consistent with browser + download. The Response headers include the content-disposition + header describing the file download. + '404': + description: >- + a 404 indicates that the indicated file was not found in conjunction + with the order id. + summary: Fetch Import Messaging Tn order loas file [NANP] + tags: + - Hosted Messaging + put: + description: >- + A PUT on the filename will update / replace the identified file id. The + format of the PUT is identical to that of the POST. + operationId: UpdateImportMessagingTnOrderLoasFile + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - description: Import Messaging Tn order's ID + example: 093a9f9b-1a78-4e47-b6e2-776a484596f4 + in: path + name: orderId + required: true + schema: + type: string + - description: File id with format + example: 093a9f9b-1a78-4e47-b6e2-776a484596f4.pdf + in: path + name: fileId + required: true + schema: + type: string + responses: + '200': + content: + application/xml: + examples: + example: + value: |- + + + 63097af1-37ae-432f-8a0d-9b0e6517a35b-1429550165581.pdf + 0 + LOA file uploaded successfully for order 63097af1-37ae-432f-8a0d-9b0e6517a35b + + schema: + $ref: '#/components/schemas/FileUploadResponse' + description: >- + The 200 response indicates the successful replacement of a file + resource containing the uploaded content. + + The response header will include a link to the created file as a GET + on the identified resource. + '400': + description: A 400 indicates that the requested upload failed. + '404': + description: A 404 indicates that the file was not available for replacement. + summary: Updating Import Messaging Tn order loas file [NANP] + tags: + - Hosted Messaging + /accounts/{accountId}/importTnOrders/messaging/{orderId}/loas/{fileId}/metadata: + delete: + description: Deletes the metadata previously associated with the identified file. + operationId: RemoveImportMessagingTnOrderLoasFileMetadata + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - description: Import Messaging Tn order's ID + example: 093a9f9b-1a78-4e47-b6e2-776a484596f4 + in: path + name: orderId + required: true + schema: + type: string + - description: File id with format + example: 093a9f9b-1a78-4e47-b6e2-776a484596f4.pdf + in: path + name: fileId + required: true + schema: + type: string + responses: + '200': + description: >- + The 200 OK indicates a successful deletion of the identified + metadata. + '404': + description: >- + A 404 indicates that the indicated file was not found in conjunction + with the order id.cd + summary: Removing Import Messaging Tn order loas file metadata [NANP] + tags: + - Hosted Messaging + get: + description: Retrieves the metadata associated with the file. + operationId: ReadImportMessagingTnOrderLoasFileMetadata + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - description: Import Messaging Tn order's ID + example: 093a9f9b-1a78-4e47-b6e2-776a484596f4 + in: path + name: orderId + required: true + schema: + type: string + - description: File id with format + example: 093a9f9b-1a78-4e47-b6e2-776a484596f4.pdf + in: path + name: fileId + required: true + schema: + type: string + responses: + '200': + content: + application/xml: + examples: + example: + value: |- + + + [string] + [LOA | INVOICE | CSR | OTHER] + + schema: + $ref: '#/components/schemas/FileMetaData' + description: The Metatdata has been successfully retrieved. + '404': + description: >- + a 404 indicates that the indicated file was not found in conjunction + with the order id. + summary: Fetch Import Messaging Tn order loas file metadata [NANP] + tags: + - Hosted Messaging + put: + description: >- + Associate metadata with the file named in the resource path. This will + describe the file, and declare the data that is contained in the file, + selected from a list of [LOA | INVOICE | CSR | OTHER]. + operationId: UpdateImportMessagingTnOrderLoasFileMetadata + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - description: Import Messaging Tn order's ID + example: 093a9f9b-1a78-4e47-b6e2-776a484596f4 + in: path + name: orderId + required: true + schema: + type: string + - description: File id with format + example: 093a9f9b-1a78-4e47-b6e2-776a484596f4.pdf + in: path + name: fileId + required: true + schema: + type: string + requestBody: + content: + application/xml: + examples: + example: + value: |- + + + fileName + LOA + + schema: + $ref: '#/components/schemas/FileMetaDataRequest' + responses: + '200': + content: + application/xml: + schema: + $ref: '#/components/schemas/FileMetaData' + description: >- + Successful update of the metadata associated with the identified + file. + '400': + description: Some error has occured as a result of the attempt. + summary: Updating Import Messaging Tn order loas file metadata [NANP] + tags: + - Hosted Messaging + /accounts/{accountId}/importTnOrders/voice: + get: + description: > + Retrieves the ImportVoiceTnOrder requests for the given account ID. A + maximum of 1,000 orders can be retrieved per request. If no date range + or specific query parameter (marked by * below) + is provided, the order results will be limited to the last two years. + operationId: ReadImportVoiceTnOrders + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - $ref: '#/components/parameters/StatusQueryParam' + - $ref: '#/components/parameters/TnQueryParam' + - $ref: '#/components/parameters/CustomerOrderIdQueryParam' + - $ref: '#/components/parameters/CreatedDateFromQueryParam' + - $ref: '#/components/parameters/CreatedDateToQueryParam' + - $ref: '#/components/parameters/ModifiedDateFromQueryParam' + - $ref: '#/components/parameters/ModifiedDateToQueryParam' + responses: + '200': + content: + application/xml: + examples: + example: + value: |- + + + 2 + + 14 + 1 + CustomerOrderId + systemUser + 2019-01-24T11:08:09.770Z + 2019-01-24T11:08:09.770Z + import_voice_tn_orders + COMPLETE + 211a103c-5f9c-4117-8833-c574bdc390fd + + + 14 + 2 + CustomerOrderId + systemUser + 2019-01-24T10:43:16.934Z + 2019-01-24T10:43:16.934Z + import_voice_tn_orders + PARTIAL + 8dc32f09-2329-4c73-b702-526f46b02712 + + + schema: + $ref: '#/components/schemas/ImportVoiceTnOrdersResponseList' + description: >- + The descriptive payload for the importVoiceTnOrders query provides + information about the orders found by the query, including the data + associated with the order, the state of the order, and a list of the + successfully imported Telephone Numbers, and descriptions of any + encountered errors. + summary: List Import Voice Tn orders + tags: + - Hosted Voice + post: + description: >- + Creates an ImportVoiceTnOrders request to add numbers under the given + site ID and sipPeer ID as specified in the body. + + A successfully submitted order will have a status of "RECEIVED". A + successfully completed order will have a status of "COMPLETE" if all of + the telephone numbers were successfully imported and "PARTIAL" if some + of the telephone numbers were imported. A failed order with will have a + staus of "FAILED" and no telephone numbers would have been imported. + operationId: CreateImportVoiceTnOrder + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + requestBody: + content: + application/xml: + examples: + example: + value: |- + + + ICPA123ABC + 743 + 303716 + + +19199918388 + +14158714245 + +14352154439 + +14352154466 + + + schema: + $ref: '#/components/schemas/ImportVoiceTnOrderRequest' + responses: + '201': + content: + application/xml: + examples: + example: + value: |- + + + + SJM000001 + 2018-01-20T02:59:54.000Z + 9900012 + smckinnon + b05de7e6-0cab-4c83-81bb-9379cba8efd0 + 2018-01-20T02:59:54.000Z + 202 + 520565 + + +19199918388 + +14158714245 + +14352154439 + +14352154466 + + PROCESSING + + + + schema: + $ref: '#/components/schemas/ImportVoiceTnOrderResponse' + description: >- + The order has been created and an order ID will be specified in the + payload and in the header. + '400': + content: + application/xml: + examples: + example: + value: |- + + + FAILED + + 7309 + The site id was not supplied or is invalid. + + + 7312 + The sippeer id is invalid. + + + schema: + $ref: '#/components/schemas/ImportVoiceTnOrderError' + description: >- + The order failed; one of the input parameters is invalid. The error + text and an error code will be provided in the ErrorList + element.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +

    + ErrorCode +

    +     		+

    + Description +

    +
    +

    + 25010 +

    +     		+

    + The account does not have permission to use the endpoint requested, please contact support if you believe you should have permission. +

    +
    +

    + 5052 +

    +     		+

    + Customer order ID is invalid. Only alphanumeric values, dashes and spaces are allowed. Max length is 255 characters. +

    +

    + 1003 +

    +     		+

    + SiteId is required. +

    +
    +

    + 5073 +

    +     		+

    + Telephone number is required. +

    +
    +

    + 5095 +

    +     		+

    + The count of telephone numbers in order exceeds the maximum size of 5000. +

    +
    +

    + 1003 +

    +     		+

    + TelephoneNumbers is required. +

    +

    + 5070 +

    +     		+

    + Telephone number is invalid. +

    +

    + 5093 +

    +     		+

    + Order cannot contain duplicate telephone numbers. +

    + summary: Import Voice Tn order tags: - - Hosted Messaging + - Hosted Voice + /accounts/{accountId}/importTnOrders/voice/{orderId}: get: - description: Retrieves the file associated with the order. - operationId: ReadImportTnOrderLoasFile - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: Import Tn order's ID - example: 093a9f9b-1a78-4e47-b6e2-776a484596f4 - in: path - name: orderId - required: true - schema: - type: string - - description: File id with format - example: 093a9f9b-1a78-4e47-b6e2-776a484596f4.pdf - in: path - name: fileId - required: true - schema: - type: string - responses: - '200': - description: >- - The 200 OK indicates a successful download request.
    - - The response to the get on a filename will result in the file being - prepared and delivered in a manner consistent with browser - download. The Response headers include the content-disposition - header describing the file download. - '404': - description: >- - a 404 indicates that the indicated file was not found in conjunction - with the order id. - summary: Fetch Import Tn order loas file - tags: - - Hosted Messaging - put: - description: >- - A PUT on the filename will update / replace the identified file id. The - format of the PUT is identical to that of the POST. - operationId: UpdateImportTnOrderLoasFile + description: Retrieve information about a importVoiceTnOrder with specified ID. + operationId: ReadImportVoiceTnOrder parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: Import Tn order's ID - example: 093a9f9b-1a78-4e47-b6e2-776a484596f4 - in: path - name: orderId - required: true - schema: - type: string - - description: File id with format - example: 093a9f9b-1a78-4e47-b6e2-776a484596f4.pdf - in: path - name: fileId - required: true - schema: - type: string + - $ref: '#/components/parameters/OrderIdPathParam' responses: '200': content: @@ -25489,77 +26144,97 @@ paths: example: value: |- - - 63097af1-37ae-432f-8a0d-9b0e6517a35b-1429550165581.pdf - 0 - LOA file uploaded successfully for order 63097af1-37ae-432f-8a0d-9b0e6517a35b - + + 2018-01-09T02:58:04.615Z + 9900012 + sjm + bf1305b8-8998-1111-2222-51ba3ce52d4e + 2018-01-09T02:58:05.298Z + 65487 + 885544 + + +12106078250 + +12109678273 + +12109678331 + +12109678337 + +12266401468 + + PARTIAL + + + 7518 + Telephone Number Not Active. + + +12262665583 + + + + schema: - $ref: '#/components/schemas/FileUploadResponse' - description: >- - The 200 response indicates the successful replacement of a file - resource containing the uploaded content. - - The response header will include a link to the created file as a GET - on the identified resource. - '400': - description: A 400 indicates that the requested upload failed. - '404': - description: A 404 indicates that the file was not available for replacement. - summary: Updating Import Tn order loas file - tags: - - Hosted Messaging - /accounts/{accountId}/importTnOrders/{orderId}/loas/{fileId}/metadata: - delete: - description: Deletes the metadata previously associated with the identified file. - operationId: RemoveImportTnOrderLoasFileMetadata - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: Import Tn order's ID - example: 093a9f9b-1a78-4e47-b6e2-776a484596f4 - in: path - name: orderId - required: true - schema: - type: string - - description: File id with format - example: 093a9f9b-1a78-4e47-b6e2-776a484596f4.pdf - in: path - name: fileId - required: true - schema: - type: string - responses: - '200': - description: >- - The 200 OK indicates a successful deletion of the identified - metadata. - '404': + $ref: '#/components/schemas/ImportVoiceTnOrderResponse' description: >- - A 404 indicates that the indicated file was not found in conjunction - with the order id.cd - summary: Removing Import Tn order loas file metadata + The information has been successfully retrieved and displayed in the + payload. + + + + + + + + + + + + + + + + + + +
    +

    + ErrorCode +

    +     		+

    + Description +

    +
    +

    + 19014 +

    +     		+

    + Numbers cannot be imported by this account at this time. +

    +
    +

    + 5061 +

    +     		+

    + The SiteId submitted is invalid. +

    +

    + 5023 +

    +     		+

    + SIP peer submitted is invalid. +

    +
    + summary: Fetch Import Voice Tn order status tags: - - Hosted Messaging + - Hosted Voice + /accounts/{accountId}/importTnOrders/voice/{orderId}/history: get: - description: Retrieves the metadata associated with the file. - operationId: ReadImportTnOrderLoasFileMetadata + description: Retrieves the history of the specified importVoiceTnOrder. + operationId: ReadImportVoiceTnOrderHistory parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: Import Tn order's ID - example: 093a9f9b-1a78-4e47-b6e2-776a484596f4 - in: path - name: orderId - required: true - schema: - type: string - - description: File id with format - example: 093a9f9b-1a78-4e47-b6e2-776a484596f4.pdf - in: path - name: fileId - required: true - schema: - type: string + - $ref: '#/components/parameters/OrderIdPathParam' responses: '200': content: @@ -25568,69 +26243,34 @@ paths: example: value: |- - - [string] - [LOA | INVOICE | CSR | OTHER] - - schema: - $ref: '#/components/schemas/FileMetaData' - description: The Metatdata has been successfully retrieved. - '404': - description: >- - a 404 indicates that the indicated file was not found in conjunction - with the order id. - summary: Fetch Import Tn order loas file metadata - tags: - - Hosted Messaging - put: - description: >- - Associate metadata with the file named in the resource path. This will - describe the file, and declare the data that is contained in the file, - selected from a list of [LOA | INVOICE | CSR | OTHER]. - operationId: UpdateImportTnOrderLoasFileMetadata - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: Import Tn order's ID - example: 093a9f9b-1a78-4e47-b6e2-776a484596f4 - in: path - name: orderId - required: true - schema: - type: string - - description: File id with format - example: 093a9f9b-1a78-4e47-b6e2-776a484596f4.pdf - in: path - name: fileId - required: true - schema: - type: string - requestBody: - content: - application/xml: - examples: - example: - value: |- - - - fileName - LOA - - schema: - $ref: '#/components/schemas/FileMetaDataRequest' - responses: - '200': - content: - application/xml: + + + 2015-06-16T14:03:10.225Z + Import Voice TN order is received. + admin + RECEIVED + + + 2015-06-16T14:03:10.330Z + Import TN order is processing. + admin + PROCESSING + + + 2015-06-16T14:03:10.789Z + Import Voice TN order is partial. + admin + PARTIAL + + schema: - $ref: '#/components/schemas/FileMetaData' + $ref: '#/components/schemas/OrderHistoryWrapper' description: >- - Successful update of the metadata associated with the identified - file. - '400': - description: Some error has occured as a result of the attempt. - summary: Updating Import Tn order loas file metadata + The history has been successfully retrieved and displayed in the + payload. + summary: Fetch Import Voice Tn order history tags: - - Hosted Messaging + - Hosted Voice /accounts/{accountId}/importToAccount: get: description: > @@ -25850,41 +26490,67 @@ paths: get: description: >- Retrieves a list of in-service phone numbers associated with the account - ID + ID. + + + In this table are presented capabilities that are not universally + available. The following request query parameters are only allowed for + numbers from specific region/country: + + | Number Region | Request Query Parameter | + + |:--------------|:------------------------| + + |NANPA|city| + + |NANPA|tier| + + |NANPA|npaNxx| + + |NANPA|npaNxxx| + + |NANPA|lata| + + |NANPA|state| + + |NANPA|ratecenter| + + + When the query parameters listed in the table above are passed, only + inservice the North American Numbering Plan phone numbers from are + returned. operationId: ReadInserviceTns parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: The `page` to fetch in a paginated collection - example: 1 - in: query - name: page - required: false - schema: - default: 1 - type: integer - - description: The number of TNs to retrieve - example: 300 - in: query - name: size - required: false - schema: - default: 300 - type: integer + - $ref: '#/components/parameters/pageQueryParam' + - $ref: '#/components/parameters/sizeQueryParam' + - $ref: '#/components/parameters/startdateQueryParam' + - $ref: '#/components/parameters/enddateQueryParam' + - $ref: '#/components/parameters/countryCodeA3QueryParam' + - $ref: '#/components/parameters/phoneNumberTypeQueryParam' + - $ref: '#/components/parameters/areaCodeQueryParam' + - $ref: '#/components/parameters/cityQueryParam' + - $ref: '#/components/parameters/tierQueryParam' - description: >- - An Area Code search filter - all returned TNs will be in the entered - Area Code - example: 919 +

    The 6-digit prefix associated with the TN.

    + example: 919859 in: query - name: areacode + name: npaNxx required: false schema: type: integer - description: >- - An NPA NXX search filter - all returned TNs will be in the entered - NPA NXX dial plan - example: 919859 +

    The 7-digit prefix associated with the TN.

    in: query - name: npanxx + name: npaNxxx required: false schema: type: integer @@ -25917,24 +26583,6 @@ paths: required: false schema: type: string - - description: >- - The starting date of a date range that will filter numbers based on - activation or other change date. - example: yy-mm-dd - in: query - name: startdate - required: false - schema: - format: date - type: string - - description: The ending date of a date range - example: yy-mm-dd - in: query - name: enddate - required: false - schema: - format: date - type: string responses: '200': content: @@ -25948,9 +26596,10 @@ paths: 59 ( a link goes here ) + ( a link goes here ) - 59 + 15 +18043024183 +18042121778 +18042146066 @@ -25960,7 +26609,6 @@ paths: +18043326094 +18042121771 +18043024182 - +18043814900 +18047672642 +18043024368 @@ -28064,25 +28712,10 @@ paths: operationId: ListOrders parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: >- - All Order retrievals must be paginated, using page and size - indicators. The page parameter contains the order-id that is to - start the page, or "1" in the case of the first page - example: cbdcfc94-81b1-4ce9-8b6d-f8d6b85381ba - in: query - name: page - required: true - schema: - type: string - - description: >- - The size parameter indicates the number of orders to return in the - payload - example: 20 - in: query - name: size - required: true - schema: - type: integer + - $ref: '#/components/parameters/pageQueryParam' + - $ref: '#/components/parameters/sizeQueryParam' + - $ref: '#/components/parameters/startdateQueryParam' + - $ref: '#/components/parameters/enddateQueryParam' - description: The order ID that the Customer / Account assigned to the Order example: ORD12345 in: query @@ -28104,26 +28737,6 @@ paths: required: false schema: type: string - - description: >- - The first day of the search date range for a date-range-limited - search of net number orders. The format is YY-MM-DD - example: 13-12-15 - in: query - name: startdate - required: false - schema: - format: date - type: string - - description: >- - The last day of the search date range for a date-range-limited - search of net number orders. The format is YY-MM-DD - example: 13-12-31 - in: query - name: enddate - required: false - schema: - format: date - type: string responses: '200': content: @@ -28239,7 +28852,47 @@ paths: the Bandwidth Dashboard API to the request. A well-formed POST on the /orders resource will create an order record, and return an order-id string that can be used to uniquely identify the new number order - request.

    Please visit Please visit Guides and Tutorials to learn more.

    operationId: CreateOrder @@ -28249,7 +28902,7 @@ paths: content: application/xml: examples: - AreaCodeSearchAndOrderType: + AreaCodeSearchAndOrderType [NANPA]: description: >- Allowed ranges ~ [2-9] for the first digit and [0, 9] for both the second and third digits. @@ -28266,7 +28919,7 @@ paths: true 743 - CitySearchAndOrderType: + CitySearchAndOrderType [NANPA]: description: Specify the City and State to be ordered from. value: |- @@ -28282,36 +28935,7 @@ paths: true 743 - CombinedSearchAndOrderType: - description: >- - Specify the any combination of: AreaCode, RateCenter, State, - NpaNxx, NpaNxxX, Lata, City, Zip. But with following - limitations: AreaCode, NpaNxx and NpaNxxX are mutually - exclusive, LCA search is supported only for one of the - following criteria: NpaNxx, NpaNxxX, RateCenter and State. If - City or RateCenter is specified, then State is required. - value: |- - - - 123456789 - Area Code Order - false - - 1 - 617 - RALEIGH - NC - 919439 - 9194391 - 224 - RALEIGH - 27606 - false - - true - 743 - - CombinedSearchAndOrderType (local vanity): + CombinedSearchAndOrderType (local vanity) [NANPA]: description: >- Specify AreaCode and LocalVanity to order telephone numbers matching a specific alphanumeric pattern between 4 and 7 @@ -28333,7 +28957,7 @@ paths: 743 - CombinedSearchAndOrderType (protected status): + CombinedSearchAndOrderType (protected status) [NANPA]: description: CombinedSearchAndOrderType with established Protected status value: |- @@ -28356,6 +28980,35 @@ paths: true 743 + CombinedSearchAndOrderType [NANPA]: + description: >- + Specify the any combination of: AreaCode, RateCenter, State, + NpaNxx, NpaNxxX, Lata, City, Zip. But with following + limitations: AreaCode, NpaNxx and NpaNxxX are mutually + exclusive, LCA search is supported only for one of the + following criteria: NpaNxx, NpaNxxX, RateCenter and State. If + City or RateCenter is specified, then State is required. + value: |- + + + 123456789 + Area Code Order + false + + 1 + 617 + RALEIGH + NC + 919439 + 9194391 + 224 + RALEIGH + 27606 + false + + true + 743 + ExistingTelephoneNumberOrderType: description: >- Order a set of numbers known to be available. This often @@ -28397,7 +29050,7 @@ paths: 518824 - LATASearchAndOrderType: + LATASearchAndOrderType [NANPA]: description: Specify the LATA to order telephone numbers from. value: |- @@ -28412,7 +29065,7 @@ paths: true 743 - NPANXXSearchAndOrderType: + NPANXXSearchAndOrderType [NANPA]: description: >- Specify the NpaNxx combination to be ordered. Valid Npa values ~ [2-9] for the first digit, and [0-9] for both the second and @@ -28440,7 +29093,7 @@ paths: true 743 - RateCenterSearchAndOrderType: + RateCenterSearchAndOrderType [NANPA]: description: Specify the Rate Center and the State. value: |- @@ -28456,7 +29109,7 @@ paths: true 743 - StateSearchAndOrderType: + StateSearchAndOrderType [NANPA]: description: Specify the State to be searched for telephone numbers. value: |- @@ -28471,7 +29124,7 @@ paths: true 743 - TollFreeVanitySearchAndOrderType: + TollFreeVanitySearchAndOrderType [NANPA]: description: >- Specify a Toll Free Vanity search, where the numbers ordered match a specific alphanumeric pattern between 4 and 7 @@ -28489,7 +29142,7 @@ paths: true 743 - TollFreeWildCharSearchAndOrderType: + TollFreeWildCharSearchAndOrderType [NANPA]: description: >- Specify the Toll Free wild card pattern. To be ordered, comprised of 3 digits beginning with '8'. Examples are 8**, @@ -28507,7 +29160,7 @@ paths: true 743 - ZIPSearchAndOrderType: + ZIPSearchAndOrderType [NANPA]: description: Specify the Zip Code to be ordered from. value: |- @@ -28525,16 +29178,16 @@ paths: schema: oneOf: - $ref: '#/components/schemas/ExistingTelephoneNumberOrder' - - $ref: '#/components/schemas/RateCenterSearchAndOrder' - - $ref: '#/components/schemas/AreaCodeSearchAndOrder' - - $ref: '#/components/schemas/NPANXXSearchAndOrder' - - $ref: '#/components/schemas/TollFreeWildCharSearchAndOrder' - - $ref: '#/components/schemas/TollFreeVanitySearchAndOrder' - - $ref: '#/components/schemas/LATASearchAndOrder' - - $ref: '#/components/schemas/ZIPSearchAndOrder' - - $ref: '#/components/schemas/CitySearchAndOrder' - - $ref: '#/components/schemas/StateSearchAndOrder' - - $ref: '#/components/schemas/CombinedSearchAndOrder' + - $ref: '#/components/schemas/RateCenterSearchAndOrder_NANPA' + - $ref: '#/components/schemas/AreaCodeSearchAndOrder_NANPA' + - $ref: '#/components/schemas/NPANXXSearchAndOrder_NANPA' + - $ref: '#/components/schemas/TollFreeWildCharSearchAndOrder_NANPA' + - $ref: '#/components/schemas/TollFreeVanitySearchAndOrder_NANPA' + - $ref: '#/components/schemas/LATASearchAndOrder_NANPA' + - $ref: '#/components/schemas/ZIPSearchAndOrder_NANPA' + - $ref: '#/components/schemas/CitySearchAndOrder_NANPA' + - $ref: '#/components/schemas/StateSearchAndOrder_NANPA' + - $ref: '#/components/schemas/CombinedSearchAndOrder_NANPA' responses: '201': content: @@ -28710,7 +29363,7 @@ paths: - Orders put: description: >- - With the introduction of Backorder capabilities, new number orders may + For orders that support Backorder capabilities, new number orders may stay in backordered state while the order is filled. While in this state it is possible to update the modifiable fields in the record, as well as to request that backorder processing of the order be ended. @@ -28819,7 +29472,7 @@ paths: schema: $ref: '#/components/schemas/TelephoneDetailsAreaCodes' description: '' - summary: List Telephone Number order area codes + summary: List Telephone Number order area codes [NANPA] tags: - Orders /accounts/{accountId}/orders/{orderId}/history: @@ -29117,7 +29770,7 @@ paths: schema: $ref: '#/components/schemas/TelephoneDetailsNpaNxx' description: '' - summary: List Telephone Number order Npa-Nxx + summary: List Telephone Number order Npa-Nxx [NANPA] tags: - Orders /accounts/{accountId}/orders/{orderId}/tns: @@ -31473,10 +32126,96 @@ paths: responses: '200': content: + application/json: + examples: + example: + value: |- + { + "products": [ + { + "name": "Termination", + "features": [ + "TermHttpVoice" + ] + }, + { + "name": "TollFree" + }, + { + "name": "Origination", + "features": [ + "CallForwarding", + "DlDa", + "CNAM" + ] + }, + { + "name": "MESSAGING", + "features": [ + "SMS", + "MMS", + "HTTPV2", + "TollFree" + ] + }, + { + "name": "NumberManagement", + "features": [ + "Ordering", + "LNP", + "HostedTNS", + "IMPORT_TNS", + "HostedVoice", + "TN_ASSIGNMENT", + "RESERVATION", + "LSR" + ] + "countrySettings": [ + { + "countryCodeA3": "FRA", + "phoneNumberType": "GEOGRAPHIC", + "features": [ + { + "featureName": "LNP", + "isDisabled": true + }, + { + "featureName": "Ordering", + "isDisabled": true + } + ] + }, + { + "countryCodeA3": "DEU", + "phoneNumberType": "NATIONAL", + "features": [ + { + "featureName": "HostedTNS", + "isDisabled": true + }, + { + "featureName": "IMPORT_TNS", + "isDisabled": true + }, + { + "featureName": "HostedVoice", + "isDisabled": true + }, + { + "featureName": "Ordering", + "isDisabled": false + } + ] + } + ] + } + ] + } + schema: + $ref: '#/components/schemas/AccountProductsResponse' application/xml: examples: example: - description: example value: |- @@ -31487,9 +32226,6 @@ paths: TermHttpVoice - - VirtualInventory - TollFree @@ -31499,7 +32235,6 @@ paths: CallForwarding DlDa CNAM - OrigHttpVoice @@ -31507,7 +32242,6 @@ paths: SMS MMS - HTTP HTTPV2 TollFree @@ -31515,14 +32249,53 @@ paths: NumberManagement - ORDERING + Ordering LNP - EXTERNAL_TNS - PROTECTED_TNS + HostedTNS + IMPORT_TNS + HostedVoice TN_ASSIGNMENT RESERVATION LSR + + + FRA + GEOGRAPHIC + + + LNP + true + + + Ordering + true + + + + + DEU + NATIONAL + + + HostedTNS + true + + + IMPORT_TNS + true + + + HostedVoice + true + + + Ordering + true + + + + @@ -33140,11 +33913,11 @@ paths: summary: Update Realm tags: - Sip Registrar - /accounts/{accountId}/removeImportedTnOrders: + /accounts/{accountId}/removeImportedTnOrders/messaging: get: description: >- - Retrieves the Remove Imported Tn Orders requests for the given account - ID. + Retrieves the Remove Imported Messaging Tn Orders requests for the given + account ID. A maximum of 1,000 orders can be retrieved per request. If no date range or specific query parameter as required is provided, the order results @@ -33152,76 +33925,13 @@ paths: operationId: ListRemoveImportedTnOrders parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: The status of the Remove Imported Tn Orders being searched for - example: PARTIAL - in: query - name: status - required: false - schema: - items: - enum: - - PROCESSING - - COMPLETE - - PARTIAL - - FAILED - type: string - type: array - - description: A Telephone Number (TN) that is referenced in the order - example: '+19199918388' - in: query - name: tn - required: true - schema: - type: string - - description: >- - The Customer Order Id is an Id assigned by the account owner to - provide a reference number for the Remove Imported Tn Order - example: ABCCorp12345 - in: query - name: customerOrderId - required: true - schema: - type: string - - description: >- - Checks the order's creation date against this value. Orders that - have a creation date after this date will be included. Format is - yyyy-MM-dd - example: '2022-04-19' - in: query - name: createdDateFrom - required: false - schema: - type: string - - description: >- - Checks the order's creation date against this value. Orders that - have a creation date before this date will be included. Format is - yyyy-MM-dd - example: '2022-04-19' - in: query - name: createdDateTo - required: false - schema: - type: string - - description: >- - For Date-based searches, the starting date of a date range - (inclusive) that will be used to find Remove Imported Tn Orders that - were modified within the date range. It is in the form yyyy-MM-dd - example: '2022-04-19' - in: query - name: modifiedDateFrom - required: false - schema: - type: string - - description: >- - For Date-based searches, the ending date of a date range (inclusive) - that will be used to find Remove Imported Tn Orders that were - modified within the date range. It is in the form yyyy-MM-dd - example: '2022-04-19' - in: query - name: modifiedDateTo - required: false - schema: - type: string + - $ref: '#/components/parameters/StatusQueryParam' + - $ref: '#/components/parameters/TnQueryParam' + - $ref: '#/components/parameters/CustomerOrderIdQueryParam' + - $ref: '#/components/parameters/CreatedDateFromQueryParam' + - $ref: '#/components/parameters/CreatedDateToQueryParam' + - $ref: '#/components/parameters/ModifiedDateFromQueryParam' + - $ref: '#/components/parameters/ModifiedDateToQueryParam' responses: '200': content: @@ -33258,23 +33968,24 @@ paths: schema: $ref: '#/components/schemas/RemoveImportedTnOrders' description: >- - The descriptive payload for the Remove Imported Tn Orders query - provides information about the orders found by the query, including - the data associated with the order, the state of the order, and a - list of the successfully removed Telephone Numbers, and descriptions - of any encountered errors - summary: List Remove Imported Tn Orders + The descriptive payload for the Remove Imported Messaging Tn Orders + query provides information about the orders found by the query, + including the data associated with the order, the state of the + order, and a list of the successfully removed Telephone Numbers, and + descriptions of any encountered errors + summary: List Remove Imported Messaging Tn Orders tags: - Hosted Messaging post: description: >- - Creates a Remove Imported Tn Orders request to remove imported telephone - numbers from the given site ID and sippeer ID as specified in the body. - A successfully submitted order will have a status of "PROCESSING". A - successfully completed order will have a status of "COMPLETE" if all of - the telephone numbers were successfully removed and "PARTIAL" if some - of the telephone numbers were removed. A failed order with will have a - status of "FAILED" and no telephone numbers would have been removed + Creates a Remove Imported Messaging Tn Orders request to remove imported + telephone numbers from the given site ID and sippeer ID as specified in + the body. A successfully submitted order will have a status of + "PROCESSING". A successfully completed order will have a status of + "COMPLETE" if all of the telephone numbers were successfully removed + and "PARTIAL" if some of the telephone numbers were removed. A failed + order with will have a status of "FAILED" and no telephone numbers would + have been removed operationId: CreateRemoveImportedTnOrder parameters: - $ref: '#/components/parameters/AccountIdPathParam' @@ -33344,7 +34055,136 @@ paths: description: >- The order failed. One of the input parameters is invalid. The error text and an error code will be provided in the ErrorList element - summary: Create Remove Imported Tn Order + summary: Create Remove Imported Messaging Tn Order + tags: + - Hosted Messaging + /accounts/{accountId}/removeImportedTnOrders/messaging/{orderId}: + get: + description: Retrieve information about a removeImportedTnOrder with specified ID + operationId: RetrieveRemoveImportedTnOrder + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - $ref: '#/components/parameters/OrderIdPathParam' + responses: + '200': + content: + application/xml: + examples: + example: + value: |- + + + 2018-01-09T02:58:04.615Z + 9900012 + sjm + bf1305b8-8998-1111-2222-51ba3ce52d4e + 2018-01-09T02:58:05.298Z + + +12106078250 + +12109678273 + +12109678331 + +12109678337 + +12266401468 + + PARTIAL + + + 7518 + Telephone Number Not Active. + + +12262665583 + + + + + schema: + $ref: '#/components/schemas/RemoveImportedTnOrdersResponse' + description: >- + The information has been successfully retrieved and displayed in the + payload + '400': + content: + application/xml: + examples: + example: + value: |- + + + + The resource does not exist + + + schema: + $ref: '#/components/schemas/RemoveImportedTnOrdersHistoryResponse' + description: Order id is not valid + summary: Retrieve Remove Imported Messaging Tn Order + tags: + - Hosted Messaging + /accounts/{accountId}/removeImportedTnOrders/messaging/{orderId}/history: + get: + description: >- + Retrieves the history of the specified Remove Imported Messaging Tn + Order + operationId: RetrieveRemoveImportedTnOrderHistory + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - description: ID of `RemoveImportedTnOrder` to retrieve history + example: bf1305b8-8998-1111-2222-51ba3ce52d4e + in: path + name: orderId + required: true + schema: + type: string + responses: + '200': + content: + application/xml: + examples: + example: + value: |- + + + + 2015-06-16T14:03:10.225Z + Remove Imported TN order is received. + admin + RECEIVED + + + 2015-06-16T14:03:10.330Z + Remove Imported TN order is processing. + admin + PROCESSING + + + 2015-06-16T14:03:10.789Z + Remove Imported TN order is partial. + admin + PARTIAL + + + schema: + $ref: '#/components/schemas/OrderHistoryWrapper' + description: >- + The history has been successfully retrieved and displayed in the + payload + '400': + content: + application/xml: + examples: + example: + value: |- + + + + 1008 + 'some_invalid_uuid' is not a valid UUID + + + schema: + $ref: '#/components/schemas/RemoveImportedTnOrdersHistoryResponse' + description: Order id is not valid + summary: Retrieve Remove Imported Messaging Tn Order history tags: - Hosted Messaging /accounts/{accountId}/removeImportedTnOrders/voice: @@ -33366,7 +34206,6 @@ paths: - $ref: '#/components/parameters/CreatedDateToQueryParam' - $ref: '#/components/parameters/ModifiedDateFromQueryParam' - $ref: '#/components/parameters/ModifiedDateToQueryParam' - - $ref: '#/components/parameters/SipPeerIdQueryParam' responses: '200': content: @@ -33630,167 +34469,49 @@ paths:     - - schema: - $ref: '#/components/schemas/RemoveImportedVoiceTnOrderResponse' - description: > - The information has been successfully retrieved and displayed in the - payload. - - - - - - - - - - -
    -

    - ErrorCode -

    -     		-

    - Description -

    -
    -

    - 5158 -

    -     		-

    - Telephone number hasn't been previously imported. -

    -
    - summary: Retrieve Remove Imported Voice Tn Order - tags: - - Hosted Voice - /accounts/{accountId}/removeImportedTnOrders/voice/{orderId}/history: - get: - description: Retrieves the history of the specified Remove Imported Voice Tn Order - operationId: RetrieveRemoveImportedVoiceTnOrderHistory - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - $ref: '#/components/parameters/OrderIdPathParam' - responses: - '200': - content: - application/xml: - examples: - example: - value: |- - - - - 2015-06-16T14:03:10.225Z - Remove Imported Voice TN order is received. - admin - RECEIVED - - - 2015-06-16T14:03:10.330Z - Remove Imported TN order is processing. - admin - PROCESSING - - - 2015-06-16T14:03:10.789Z - Remove Imported Voice TN order is partial. - admin - PARTIAL - - - schema: - $ref: '#/components/schemas/OrderHistoryWrapper' - description: >- - The history has been successfully retrieved and displayed in the - payload - summary: Retrieve Remove Imported Voice Tn Order history - tags: - - Hosted Voice - /accounts/{accountId}/removeImportedTnOrders/{orderId}: - get: - description: Retrieve information about a removeImportedTnOrder with specified ID - operationId: RetrieveRemoveImportedTnOrder - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: ID of `RemoveImportedTnOrder` to retrieve - example: bf1305b8-8998-1111-2222-51ba3ce52d4e - in: path - name: orderId - required: true - schema: - type: string - responses: - '200': - content: - application/xml: - examples: - example: - value: |- - - - 2018-01-09T02:58:04.615Z - 9900012 - sjm - bf1305b8-8998-1111-2222-51ba3ce52d4e - 2018-01-09T02:58:05.298Z - - +12106078250 - +12109678273 - +12109678331 - +12109678337 - +12266401468 - - PARTIAL - - - 7518 - Telephone Number Not Active. - - +12262665583 - - - - + schema: - $ref: '#/components/schemas/RemoveImportedTnOrdersResponse' - description: >- + $ref: '#/components/schemas/RemoveImportedVoiceTnOrderResponse' + description: > The information has been successfully retrieved and displayed in the - payload - '400': - content: - application/xml: - examples: - example: - value: |- - - - - 1008 - 'some_invalid_uuid' is not a valid UUID - - - schema: - $ref: '#/components/schemas/RemoveImportedTnOrdersHistoryResponse' - description: Order id is not valid - summary: Retrieve Remove Imported Tn Order + payload. + + + + + + + + + + +
    +

    + ErrorCode +

    +     		+

    + Description +

    +
    +

    + 5158 +

    +     		+

    + Telephone number hasn't been previously imported. +

    +
    + summary: Retrieve Remove Imported Voice Tn Order tags: - - Hosted Messaging - /accounts/{accountId}/removeImportedTnOrders/{orderId}/history: + - Hosted Voice + /accounts/{accountId}/removeImportedTnOrders/voice/{orderId}/history: get: - description: Retrieves the history of the specified Remove Imported Tn Order - operationId: RetrieveRemoveImportedTnOrderHistory + description: Retrieves the history of the specified Remove Imported Voice Tn Order + operationId: RetrieveRemoveImportedVoiceTnOrderHistory parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: ID of `RemoveImportedTnOrder` to retrieve history - example: bf1305b8-8998-1111-2222-51ba3ce52d4e - in: path - name: orderId - required: true - schema: - type: string + - $ref: '#/components/parameters/OrderIdPathParam' responses: '200': content: @@ -33802,7 +34523,7 @@ paths: 2015-06-16T14:03:10.225Z - Remove Imported TN order is received. + Remove Imported Voice TN order is received. admin RECEIVED @@ -33814,7 +34535,7 @@ paths: 2015-06-16T14:03:10.789Z - Remove Imported TN order is partial. + Remove Imported Voice TN order is partial. admin PARTIAL @@ -33824,25 +34545,9 @@ paths: description: >- The history has been successfully retrieved and displayed in the payload - '400': - content: - application/xml: - examples: - example: - value: |- - - - - 1008 - 'some_invalid_uuid' is not a valid UUID - - - schema: - $ref: '#/components/schemas/RemoveImportedTnOrdersHistoryResponse' - description: Order id is not valid - summary: Retrieve Remove Imported Tn Order history + summary: Retrieve Remove Imported Voice Tn Order history tags: - - Hosted Messaging + - Hosted Voice /accounts/{accountId}/reports: get: description: >- @@ -33853,6 +34558,43 @@ paths: and creation of an instance of the report. Items of this list are sorted by display priority in ascending order and alphabetically by name within priority groups (display priority is displayed only for admin endpoint) + + + In this table are presented valid report types. Some are applicable + universally, and some are only applicable for numbers of specific + region. + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Report TypeReport IDReport NameDescriptionNumber Region
    Numbers37Bandwidth Phone Number InventoryA list of all telephone numbers in 'Available' status at the time that the report was compiledNANPA
    Numbers4Phone Number InventoryA list of all phone numbers associated with an account
    Numbers34End-User Phone Number AssignmentA list of phone numbers and their end-user assignment statusesNANPA
    Numbers50Protected Phone NumbersThis report will provide a simple report that lists all of the protected TNs on an account, as well as their status.NANPA
    Voice Enabled Numbers2Voice Phone Number DetailsComplete information about all phone numbers within the report’s scope
    Voice Enabled Numbers65Phone Number Route PlanThis report lists all of the route plans that are active for the indicated accountNANPA
    Voice Enabled Numbers48Phone Number UtilizationThis account report will provide insight into the current utilization and assignment data associated with the Bandwidth Dashboard TN inventoryNANPA
    Voice Enabled Numbers47Under-Utilized and Unassigned Phone NumbersThis report will list all of the Telephone Numbers that appear to be under-utilized and unassigned.NANPA
    Messaging Enabled Numbers67Messaging Phone Number DetailsDetails of phone numbers with active messaging for particular snapshot date
    Messaging Enabled Numbers31External Phone Number DetailsComplete information about customer provided phone numbers within the report’s scopeNANPA
    Emergency Enabled Numbers6Emergency Services Phone Number DetailsEmergency Service information associated with phone numbers within the report’s scopeNANPA
    Emergency Enabled Numbers36Alternate Caller ID E911 ReportE911 detail information for accounts that use an alternative identifier for the end userNANPA
    Emergency Enabled Numbers42E911 Dynamic Location Routing AddressesA list of all E911 addresses provisioned to an account. The list of addresses shown are only for Dynamic Location Routing-enabled accounts.NANPA
    Orders59New Number OrdersPhone number details for historic or current new number orders
    Orders30Disconnect OrdersInformation about all phone numbers that have been disconnected from the account
    Orders14Port-in OrdersPhone number details for historic or current port-in orders
    Orders8Port-out OrdersPhone number details for historic or current port-out orders
    Account16UC Account SummaryDetailed account information for a given UC accountNANPA
    Users24User InformationInformation about all active and inactive users for a given account
    + + + When reports tagged NANPA in table above are retrieved, only the North + American Numbering Plan phone numbers from are returned in the report. operationId: ListReports parameters: - $ref: '#/components/parameters/AccountIdPathParam' @@ -35678,105 +36420,100 @@ paths: get: description: >- Retrieves all the telephone numbers currently in-service for the given - Site + Site. + + + In this table are presented capabilities that are not universally + available. The following request query parameters are only allowed for + numbers from specific region/country: + + | Number Region | Request Query Parameter | + + |:--------------|:------------------------| + + |NANPA|city| + + |NANPA|tier| + + |NANPA|npaNxx| + + |NANPA|npaNxxx| + + |NANPA|lata| + + |NANPA|state| + + |NANPA|ratecenter| + + + When the query parameters listed in the table above are passed, only + inservice the North American Numbering Plan phone numbers from are + returned. operationId: RetrieveSiteInserviceNumbers parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: ID of the Site to retrieve all INSERVICE numbers - example: '407' - in: path - name: siteId - required: true - schema: - type: string + - $ref: '#/components/parameters/SiteIdPathParam' + - $ref: '#/components/parameters/pageQueryParam' + - $ref: '#/components/parameters/sizeQueryParam' + - $ref: '#/components/parameters/startdateQueryParam' + - $ref: '#/components/parameters/enddateQueryParam' + - $ref: '#/components/parameters/countryCodeA3QueryParam' + - $ref: '#/components/parameters/phoneNumberTypeQueryParam' + - $ref: '#/components/parameters/areaCodeQueryParam' + - $ref: '#/components/parameters/cityQueryParam' + - $ref: '#/components/parameters/tierQueryParam' - description: >- - The first in-service number displayed on the page. "1" is used as a - convention for the first number on the list. - example: 15555551845 +

    The 6-digit prefix associated with the TN.

    + example: 919859 in: query - name: page + name: npaNxx required: false schema: - default: 1 type: integer - - description: The count of in-service numbers displayed on the page. - example: 30 + - description: >- +

    The 7-digit prefix associated with the TN.

    in: query - name: size + name: npaNxxx required: false schema: - default: 300 type: integer - - description: A maximum five-digit number - example: 371 + - description: >- + A Rate Center search filter - all returned TNs will be in the + entered Rate Center. Typically this is a 3 or 5 digit value. + example: 435 in: query name: lata required: false schema: type: integer - - description: '' - example: 1 - in: query - name: tier - required: false - schema: - type: integer - - description: '' - example: ST GEORGE + - description: >- + A Rate Center search filter - all returned TNs will be in the + entered Rate Center. This `ratecenter` must be combined with a + `state` in the query. If State is not included in the query then + the query will fail. + example: PLANO in: query name: rateCenter required: false schema: type: string - - description: '' - example: Raleigh - in: query - name: city - required: false - schema: - type: string - - description: A two-letter representation of the State - example: NC + - description: >- + A State search filter - all returned TNs will be in the entered + State. This is a 2-character State or Province abbreviation. + example: TX in: query name: state required: false schema: type: string - - description: '' - example: '435' - in: query - name: areaCode - required: false - schema: - type: string - - description: '' - example: '435215' - in: query - name: npaNxx - required: false - schema: - type: string - - description: '' - example: '4352154' - in: query - name: npaNxxx - required: false - schema: - type: string - - description: Startdate and Enddate must be together - example: 12-01-01 - in: query - name: startdate - required: false - schema: - type: string - - description: Startdate and Enddate must be together - example: 14-01-01 - in: query - name: enddate - required: false - schema: - type: string responses: '200': content: @@ -35808,214 +36545,6 @@ paths: summary: Retrieve Site in-service numbers tags: - In-service Numbers - /accounts/{accountId}/sites/{siteId}/orders: - get: - description: Retrieves all orders associated with the given Site - operationId: RetrieveSiteOrders - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: ID of the Site to retrieve associated Orders - example: '407' - in: path - name: siteId - required: true - schema: - type: string - - description: Sets the amount of responses per page - example: 30 - in: query - name: size - required: true - schema: - type: integer - - description: >- - The first orders ID to show on the page. "1" is used as a convention - for the first page - example: 1 - in: query - name: page - required: true - schema: - type: integer - responses: - '200': - content: - application/xml: - examples: - example: - value: |- - - - - 47 - - Link=<https://dashboard.bandwidth.com/api/accounts/12346099/sites/743/orders?page=1&size=30>;rel="first"; - Link=<https://dashboard.bandwidth.com/api/accounts/12346099/sites/743/orders?page=fa7bc01a-cb4d-4eae-9621-560020f45105&size=30>;rel="next"; - - - 1 - jbm - 2014-01-06T19:09:44.027Z - new_number - 2014-01-06T19:09:43.695Z - 13c97416-9eee-4da3-aff8-ba85d1297ef2 - COMPLETE - - - - VA - 1 - - - - - 1 - GLOUCESTER - - - - - GLOUCESTER - 1 - - - - - 0 - 1 - - - - - 49 - Bandwidth CLEC - 1 - - - - - - - schema: - $ref: '#/components/schemas/SiteOrdersResponse' - description: '' - '404': - content: - application/xml: - examples: - example: - value: |- - - - Link=<https://dashboard.bandwidth.com/api/accounts/12346099/sites/3013/orders?page=1&size=300>;rel="first"; - - description: >- - Orders cannot be found for that Site. Possible explanations: - - - summary: Retrieve Site Orders - tags: - - Orders - /accounts/{accountId}/sites/{siteId}/orders/{orderId}: - get: - description: Retrieves order information associated with the given Site - operationId: RetrieveSiteOrder - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: Site ID of the order - example: '407' - in: path - name: siteId - required: true - schema: - type: string - - description: ID of the Order to retrieve - example: ca8065d1-ec1a-43da-af40-1dcee43becb5 - in: path - name: orderId - required: true - schema: - type: string - responses: - '200': - content: - application/xml: - examples: - example: - value: |- - - - 1 - jbm - 2014-01-06T19:09:44.027Z - 2014-01-06T19:09:44.041Z - - 123456789 - Area Code Order - 2014-01-06T19:09:43.695Z - 303716 - 743 - false - - 804 - 1 - - true - 743 - - COMPLETE - - - +18042105666 - - - 0 - - schema: - $ref: '#/components/schemas/TnOrderUpdatedResponse' - description: A successful result that contains the response data - summary: Retrieve Site Order - tags: - - Orders - /accounts/{accountId}/sites/{siteId}/orders/{orderId}/tns: - get: - description: Retrieves order TNs associated with the given Site - operationId: RetrieveSiteOrderTns - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: Site ID of the order - example: '407' - in: path - name: siteId - required: true - schema: - type: string - - description: ID of the Order to retrieve a list of TNs - example: ca8065d1-ec1a-43da-af40-1dcee43becb5 - in: path - name: orderId - required: true - schema: - type: string - responses: - '200': - content: - application/xml: - examples: - example: - value: |- - - - 1 - +18042105666 - - schema: - $ref: '#/components/schemas/OrderTelephoneNumbersResponse' - description: A successful result that contains the response data - summary: Retrieve Order TNs of Site - tags: - - Tns /accounts/{accountId}/sites/{siteId}/portins: get: description: Retrieves Port-in orders associated with the given Site @@ -36868,45 +37397,6 @@ paths: summary: Update Sip Peer tags: - SipPeer Management - /accounts/{accountId}/sites/{siteId}/sippeers/{sipPeerId}/movetns: - post: - description: >- - The POST method moves all telephone numbers specified in the body to the - given SIP peer.
    The source SIP peer is determined by the Telephone - Number, i.e. the PUT method can move multiple numbers from different - source SIP peers.
    The destination SIP peer is specified in the - URL.
    NOTE: only a maximum of 5000 Telephone Numbers can be moved in - one operation. - operationId: CreateSipPeerTelephoneNumberBulk - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - $ref: '#/components/parameters/SiteIdPathParam' - - $ref: '#/components/parameters/SipPeerIdPathParam' - requestBody: - content: - application/xml: - schema: - $ref: '#/components/schemas/SipPeerTelephoneNumberBulk' - responses: - '200': - content: - application/xml: - schema: - $ref: '#/components/schemas/SipPeerTelephoneNumberBulkResponse' - description: The request has been successfully received. - '400': - content: - application/xml: - schema: - $ref: '#/components/schemas/SipPeerTelephoneNumberBulkErrorResponse' - description: >- - Bad Request. Possible errors in response: - summary: Move bulk tns to sipper - tags: - - Move Tns /accounts/{accountId}/sites/{siteId}/sippeers/{sipPeerId}/products: get: description: A list of products associated with a Sip Peer @@ -38492,6 +38982,10 @@ paths: value: |- + + ( a link goes here ) + ( a link goes here ) + +12052160148 @@ -38527,7 +39021,7 @@ paths: - Tns /accounts/{accountId}/sites/{siteId}/sippeers/{sippeerId}/tns/{tn}: get: - description: Retrieve information about telephone number on Sip Peer + description: Retrieve information about telephone number on Sip Peer. operationId: ReadSipPeerTn parameters: - $ref: '#/components/parameters/AccountIdPathParam' @@ -38539,7 +39033,7 @@ paths: required: true schema: type: string - - description: A 10 Digit Telephone Number + - description: A E.164 Telephone Number example: '+15209072451' in: path name: tn @@ -38576,7 +39070,25 @@ paths: tags: - Tns put: - description: Update settings for a TN allocated to their account + description: >- + Update settings for a TN allocated to their account. + + + In this table are presented capabilities that are not universally + available. The following request body parameters are only allowed for + numbers from specific region/country: + + | Number Region | Request Query Parameter | + + |:--------------|:------------------------| + + |NANPA|TnAttributes| + + |NANPA|CallingNameDisplay| + + + When these request body parameters are provided, only North American + Numbering Plan phone numbers are allowed and updated. operationId: UpdateSipPeerTnSettings parameters: - $ref: '#/components/parameters/AccountIdPathParam' @@ -38588,7 +39100,7 @@ paths: required: true schema: type: string - - description: A 10 Digit Telephone Number to update + - description: A E.164 Telephone Number example: '+15209072451' in: path name: tn @@ -38604,7 +39116,6 @@ paths: +12052160156 - 10digit 10digit false +17042661720 @@ -38710,6 +39221,8 @@ paths: enum: - CNAM - LIDB + - DLDA + - DA type: string type: array responses: @@ -38722,9 +39235,11 @@ paths: - 4 - 4 - 0 + 10004 + 4 + 0 + 9999 + 0 schema: @@ -39757,72 +40272,203 @@ paths: tags: - Tn Option post: - description: >- - Create TN Option order to assign line features to the telephone - number.

    Attribute description:
    • for A2pSettings - attribute
      • Number - attributeAction valueDescription of - action
      LongCodesystemDefaultRemoves - the per-TN A2P attributes, and it reverts to the Location/SIP Peer - characteristics. Any values for Class or Campaign ID are not - valid
      LongCodeasSpecifiedSets - the message class and campaign ID - this is the default if - unspecified
      LongCodeoffWill - set the TN as a 'P' TN. Any values for Class or Campaign ID are not - valid
      LongCodedeleteWill - delete the campaign ID from TN. Any values for Class or Campaign ID are - not valid
      LongCodeunchangedDo - nothing with respect to - A2P
      TollFreesystemDefaultRemoves - the per-TN A2P attributes, and it reverts to the Location/SIP Peer - characteristics. Any values for Class or Campaign ID are not - valid
      TollFreeasSpecifiedSets - the message class and campaign ID - this is the default if - unspecified
      TollFreeoffIf the - Togglz value is set to 'on' this is invalid for Toll Free telephone - numbers. Any values for Class or Campaign ID in the payload are invalid. - If the Togglz value is set to off this behaves like and A2P TN, where - the characteristics of the TNs is set to - 'P'
      TollFreeunchangedDo - nothing with respect to A2P
    • for Origination - Route plan attribute
      • Action - valueDescription of - action
      asSpecifiedCreates/updates the - origination route plan for the TN with route plan details provided in - the request
      offRemoves the origination route - plan for the TN. Route list is the request must be - empty
      unchangedDoesn't update/create the - origination route plan, even when route plan details exist in the - request
      • Origination route plan is - validated against CallForward and RewriteUser
        • Route plan and CallForward cannot co-exist. Order is - accepted but will respond with error messages on GET.
        • Route plan and RewriteUser cannot co-exist. Order is - accepted but will respond with error messages on - GET.
    • for Pindrop Enabled attribute
      • Action valueDescription of - action
      trueEnables Pindrop integration on each - phone number in the option - group
      falseExplicitly disables Pindrop - integration on each phone number in the option - group
    • for Call Verification Enabled - attribute
      • Action - valueDescription of - action
      trueEnables Call Verification on each - phone number in the option - group
      falseExplicitly disables Call - Verification on each phone number in the option - group
    • for other attribute
      • systemDefault - implies that the element profile - value should be removed so that the TN changes back to the default - system behavior;
      • unchanged - the value - should remain unchanged - implies a read before write model.
      • Leaving the element out of the payload is equivalent to - unchanged.
    + description: > + Create TN Option order to assign line features to the telephone number. + + + The two data elements in the submission are - + +
      +
    • TnOptionGroups - A list of TnOptionGroup objects, which contain list of telephone numbers and set of TN options you want to assign to all TNs in the list.
      • +
    • CustomerOrderId - Optional value for Id set by customer. Only alphanumeric values, dashes and spaces are allowed. Max length is 40 characters.
      • +
    + + + In this table are presented valid attributes for TnOptionGroup object. + Some are applicable universally, and some are only applicable for + numbers of specific region. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeProductNumber Region
    TelephoneNumbers
    PortOutPasscodeNumbersNANPA
    ProtectedNumbersNANPA
    OriginationRoutePlanVoice
    NumberFormatVoice
    RPIDFormatVoice
    RewriteUserVoice
    CallForwardVoice
    FinalDestinationURIVoice
    PindropEnabledVoiceNANPA
    ESPIDVoiceNANPA
    CallingNameDisplayVoiceNANPA
    SmsMessaging
    A2pSettingsMessagingNANPA
    NNIDMessagingNANPA
    + + + When attributes tagged NANPA are passed in request body, only North + American Numbering Plan phone numbers are allowed and updated. + + + The values for each TnOptionGroup object attribute are: + +
      +
    • for TelephoneNumbers attribute
      • +
        +
      • A list of TelephoneNumber as Array of strings
        • +
          +
        • An E.164 formatted telephone number string. Assumes NANPA 10 digit format number if string is not E.164 formatted.
          • +
        +
      +
    • for PortOutPasscode attribute
      • +
        +
      • [ string | unchanged | systemDefault]
        • +
      +
    • for Protected attribute
      • +
        +
      • [ true | false | unchanged | systemDefault]
        • +
      +
    • for NumberFormat attribute
      • +
        +
      • [ 10digit | 11digit | e164 | unchanged | systemDefault ]
        • +
      +
    • for RPIDFormat attribute
      • +
        +
      • [ 10digit | 11digit | e164 | unchanged | systemDefault ]
        • +
      +
    • for RewriteUser attribute
      • +
        +
      • [ string | unchanged | systemDefault]
        • +
      +
    • for CallingNameDisplay attribute
      • +
        +
      • [ on | off | unchanged | systemDefault ]
        • +
      +
    • for Sms attribute
      • +
        +
      • [ on | off | unchanged]
        • +
      +
    • for NNID attribute
      • +
        +
      • [ integer | unchanged | systemDefault ]
        • +
      +
    • for ESPID attribute
      • +
        +
      • [ string | unchanged | systemDefault ]
        • +
      +
    • for CallForward attribute
      • +
        +
      • [ string | unchanged | systemDefault ]
        • +
          +
        • An E.164 formatted telephone number string. Assumes NANPA 10 digit format number if string is not E.164 formatted.
          • +
        +
      +
    • for FinalDestinationURI attribute
      • +
        +
      • [ string | unchanged | systemDefault]
        • +
          +
        • An E.164 formatted telephone number string. Assumes NANPA 10 digit format number if string is not E.164 formatted.
          • +
        • a SIP URI ( without the sip: prefix )
          • +
            +
          • in the form address-string@host IP:port, where
            • +
          • the host IP is an IPv4 address in the standard numerical n.n.n.n. form, and
            • +
          • the port is numeric, and optional
            • +
          • containing [a-z,A-Z,0-9], with ':', '.' and '@' to delimit the components of the overall string, and
            • +
          • less than 60 characters long.
            • +
          +
        +
      +
    • for all the above attribute
      • +
        +
      • systemDefault - implies that the element profile value should be removed so that the TN changes back to the default system behavior;
        • +
      • unchanged - the value should remain unchanged - implies a read before write model.
        • +
      • Leaving the element out of the payload is equivalent to unchanged.
        • +
      +
    • for A2pSettings attribute
      • +
      Number attributeAction valueDescription of action
      LongCodesystemDefaultRemoves the per-TN A2P attributes, and it reverts to the Location/SIP Peer characteristics. Any values for Class or Campaign ID are not valid
      LongCodeasSpecifiedSets the message class and campaign ID - this is the default if unspecified
      LongCodeoffWill set the TN as a ''P'' TN. Any values for Class or Campaign ID are not valid
      LongCodedeleteWill delete the campaign ID from TN. Any values for Class or Campaign ID are not valid
      LongCodeunchangedDo nothing with respect to A2P
      TollFreesystemDefaultRemoves the per-TN A2P attributes, and it reverts to the Location/SIP Peer characteristics. Any values for Class or Campaign ID are not valid
      TollFreeasSpecifiedSets the message class and campaign ID - this is the default if unspecified
      TollFreeoffIf the Togglz value is set to ''on'' this is invalid for Toll Free telephone numbers. Any values for Class or Campaign ID in the payload are invalid. If the Togglz value is set to off this behaves like and A2P TN, where the characteristics of the TNs is set to ''P''
      TollFreeunchangedDo nothing with respect to A2P
      +
    • for Origination Route plan attribute
      • +
      Action valueDescription of action
      asSpecifiedCreates/updates the origination route plan for the TN with route plan details provided in the request
      offRemoves the origination route plan for the TN. Route list is the request must be empty
      unchangedDoesn''t update/create the origination route plan, even when route plan details exist in the request
      +
        +
      • Origination route plan is validated against CallForward and RewriteUser
        • +
          +
        • Route plan and CallForward cannot co-exist. Order is accepted but will respond with error messages on GET.
          • +
        • Route plan and RewriteUser cannot co-exist. Order is accepted but will respond with error messages on GET.
          • +
        +
      +
    • for Pindrop Enabled attribute
      • +
      Action valueDescription of action
      trueEnables Pindrop integration on each phone number in the option group
      falseExplicitly disables Pindrop integration on each phone number in the option group
      +
    operationId: CreateTnOptionOrder parameters: - $ref: '#/components/parameters/AccountIdPathParam' @@ -41323,81 +41969,34 @@ paths: summary: Retrieve the total number of seats on account tags: - Account - /accounts/{accountId}/{orderType}/{orderId}/adminparameters: - delete: - description: Remove order admin parameters - operationId: RemoveOrderAdminParameters - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - $ref: '#/components/parameters/OrderTypePathParam' - - $ref: '#/components/parameters/OrderIdPathParam' - responses: - '200': - content: - application/xml: - schema: - $ref: '#/components/schemas/AdminParametersResponse' - description: Order admin parameters have been successfully deleted/cancelled - '400': - content: - application/xml: - schema: - $ref: '#/components/schemas/AdminParametersErrorResponse' - description: >- - Order id is invalid, order does not exist or the port-in order is - already processed, and therefore cannot be deleted - summary: Remove Order Admin Parameters - tags: - - Orders + /addresses/fields: get: - description: Get order admin parameters - operationId: GetOrderAdminParameters + description: >- + Get a list of address fields that is supported per country and feature + specific requirements. + operationId: getAddressFields parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - $ref: '#/components/parameters/OrderTypePathParam' - - $ref: '#/components/parameters/OrderIdPathParam' + - $ref: '#/components/parameters/countryCodeA3RequiredQueryParam' responses: '200': - content: - application/xml: - schema: - $ref: '#/components/schemas/AdminParametersResponse' - description: >- - The information has been successfully retrieved and displayed in the - payload - summary: Get Order Admin Parameters - tags: - - Orders - put: - description: Update order admin parameters - operationId: UpdateOrderAdminParameters - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - $ref: '#/components/parameters/OrderTypePathParam' - - $ref: '#/components/parameters/OrderIdPathParam' - requestBody: - content: - application/xml: - schema: - $ref: '#/components/schemas/AdminParametersRequest' - responses: - '200': - content: - application/xml: - schema: - $ref: '#/components/schemas/AdminParametersResponse' - description: >- - The information has been successfully retrieved and displayed in the - payload + $ref: '#/components/responses/getAddressFieldsResponse' '400': - content: - application/xml: - schema: - $ref: '#/components/schemas/AdminParametersErrorResponse' - description: Wrong input - summary: Update Order Admin Parameters + $ref: '#/components/responses/badRequestError' + '401': + $ref: '#/components/responses/unauthorizedError' + '403': + $ref: '#/components/responses/forbiddenError' + '404': + $ref: '#/components/responses/notFoundError' + '405': + $ref: '#/components/responses/notAllowedError' + '429': + $ref: '#/components/responses/tooManyRequestsError' + '500': + $ref: '#/components/responses/internalServerError' + summary: Get Address Fields tags: - - Orders + - Addresses /admin/data/a2pClasses: get: description: Retrieves A2P Classes. @@ -42350,9 +42949,98 @@ paths: Centers that serve those Cities. If 'available' is specified then the number of TNs available in that city / RC combination is also included. - summary: List Cities + summary: List Cities [NANPA] tags: - - Cities + - Coverage + /coverage/countries: + get: + description: >- + Get countries, number types and cities in Bandwidth's available phone + number inventory. This endpoint is only applicable for non-NANPA number + inventory. Please use `/cities` endpoint for Banwidth's NANPA available + phone number inventory coverage. + operationId: countryCoverage + parameters: + - $ref: '#/components/parameters/countryCodeA3QueryParam' + - $ref: '#/components/parameters/phoneNumberTypeQueryParam' + - $ref: '#/components/parameters/cityQueryParam' + - $ref: '#/components/parameters/areaCodeQueryParam' + responses: + '200': + content: + application/json: + examples: + example: + value: |- + { + "countryCoverages": [ + { + "countryCodeA3": "USA", + "phoneNumberType": "MOBILE", + "regions": [ + { + "city": "Woodinville", + "areaCode": "435" + } + ] + } + ] + } + schema: + $ref: '#/components/schemas/CountryCoverageResponseSuccess' + application/xml: + examples: + example: + value: |- + + + + + USA + MOBILE + + + Woodinville + 435 + + + + + + schema: + $ref: '#/components/schemas/CountryCoverageResponseSuccess' + description: Created + '400': + content: + application/json: + examples: + example: + value: |- + { + "responseStatus": { + "errorCode": 4010, + "description": "A supplied phoneNumberType within '[SPECIALLL]' is invalid." + } + } + schema: + $ref: '#/components/schemas/CountryCoverageResponseError' + application/xml: + examples: + example: + value: |- + + + + 4010 + A supplied phoneNumberType within '[SPECIALLL]' is invalid. + + + schema: + $ref: '#/components/schemas/CountryCoverageResponseError' + description: Bad Request + summary: List Country Coverage + tags: + - Coverage /coveredRateCenters: get: description: >- @@ -42693,23 +43381,22 @@ paths: /porting/losingCarriers: get: description: > -

    List losing carriers that a non-NANPA number can be ported from, - given a countryCodeA3 and optional areaCode and phoneNumberType - values.

    +

    List losing carriers that a number can be ported from. This endpoint + is only relevant for non-NANPA number portin orders, which require a + losing carrier to be specified.

    operationId: portingLosingCarriers parameters: - - $ref: '#/components/parameters/countryCodeA3QueryParameter' - - $ref: '#/components/parameters/phoneNumberTypeQueryParameter' - - $ref: '#/components/parameters/areaCodeQueryParameter' + - $ref: '#/components/parameters/countryCodeA3QueryParam_eq' + - $ref: '#/components/parameters/phoneNumberTypeQueryParam_eq' + - $ref: '#/components/parameters/areaCodeQueryParam_eq' responses: '200': $ref: '#/components/responses/listOfLosingCarriersResponse' '400': - $ref: >- - #/components/responses/badRequestLosingInvlaidCountryCodeCarriersResponse + $ref: '#/components/responses/badRequestError' '502': - $ref: '#/components/responses/noUpstreamServicesLosingCarriersResponse' - summary: List losing carriers for porting non-NANPA telephone numbers + $ref: '#/components/responses/internalServerError' + summary: List losing carriers tags: - Porting /rateCenters: @@ -42877,34 +43564,97 @@ paths: summary: List Rate Centers tags: - Rate Centers + /restrictions: + get: + description: >- + Information about how services work in various countries and which + restrictions and rules apply. Please consult this information before + buying and configuring your numbers. + operationId: ListRestrictions + parameters: + - $ref: '#/components/parameters/countryCodeA3QueryParam' + responses: + '200': + content: + application/xml: + examples: + example: + value: |- + + + + + BEL + LEGAL + Number portability + Lorem ipsum + + + BEL + PURCHASE + Address or identification requirements + Lorem ipsum + + + BEL + SERVICE + Compatibility issues + Lorem ipsum + + + + schema: + $ref: '#/components/schemas/RestrictionResponse' + description: >- + This response returns the list of cities, along with the Rate + Centers that serve those Restrictions. If 'available' is specified + then the number of TNs available in that city / RC combination is + also included. + summary: List Restrictions + tags: + - Compliance /tns: get: description: >- Retrieve information about one or more Telephone Numbers (TNs), where the TNs are chosen based on the search parameters provided in the API Call. + + + In this table are presented capabilities that are not universally + available. The following request query parameters are only allowed for + numbers from specific region/country: + + | Number Region | Request Query Parameter | + + |:--------------|:------------------------| + + |NANPA|city| + + |NANPA|tier| + + |NANPA|npaNxx| + + |NANPA|npaNxxx| + + |NANPA|lata| + + |NANPA|state| + + |NANPA|ratecenter| + + + When the query parameters listed in the table above are passed, only + North American Numbering Plan phone numbers from are returned. operationId: ListTnsByGet parameters: - - description: >- - An ID of the first element in a page. This value will indicate the - first value, not the count, of the initial entry in the page being - requested. Note in the example that the page is the TN that begins - the page. The initial page is tagged with the ID "1" - example: '5' - in: query - name: page - required: true - schema: - default: '1' - type: string - - description: The number of items to include in a page. - example: 250 - in: query - name: size - required: true - schema: - default: 500 - type: integer + - $ref: '#/components/parameters/pageQueryParam' + - $ref: '#/components/parameters/sizeQueryParam' + - $ref: '#/components/parameters/countryCodeA3QueryParam' + - $ref: '#/components/parameters/phoneNumberTypeQueryParam' + - $ref: '#/components/parameters/areaCodeQueryParam' + - $ref: '#/components/parameters/cityQueryParam' + - $ref: '#/components/parameters/tierQueryParam' - description: The internal account id assigned to the customer that "owns" the TN. example: 5000125 in: query @@ -42912,18 +43662,7 @@ paths: required: false schema: type: integer - - description: >- - The geographic city most likely to serve the Telephone Number. City - and other geographic data is determined statistically, and is not as - reliable as Rate Center information for pinpointing the service - location of a TN. - example: CARY - in: query - name: city - required: false - schema: - type: string - - description: A 10 Digit TN. + - description: A E.164 TN. example: '+19199918388' in: query name: fullNumber @@ -42939,75 +43678,69 @@ paths: required: false schema: type: string - - description: >- - The LATA (Local Access Transport Area) that the TN is served from, - typically 3 digits (5 in FLA). - example: 423 - in: query - name: lata - required: false - schema: - type: integer - - description: The first 3 digits of a 10 Digit NA Telephone Number, the Area Code. - example: '919' + - description: A service type value to filter the TNs returned in the payload. + example: E911 in: query - name: npa + name: service required: false schema: + enum: + - E911 + - Voice + - Hosted_E911 type: string - - description: The first 6 digits of a 10 Digit NA Telephone Number. - example: '919991' + - description: >- +

    The 6-digit prefix associated with the TN.

    • Allowed + number ranges for NPA are [2-9] for the first digit and [0-9] for + both the second and third digits.
    • Allowed number ranges for + NXX are [2-9] for the first digit and [0-9] for both the second and + third digits.
    + example: 919859 in: query name: npaNxx required: false schema: - type: string - - description: The first 7 digits of a 10 Digit NA Telephone Number. - example: '9199918' + type: integer + - description: >- +

    The 7-digit prefix associated with the TN.

    • Allowed + number ranges for NPA are [2-9] for the first digit and [0-9] for + both the second and third digits.
    • Allowed number ranges for + NXXX are [2-9] for the first digit and [0-9] the rest of the (X) + digits.
    in: query - name: npaNxxX + name: npaNxxx required: false schema: - type: string - - description: A service type value to filter the TNs returned in the payload. - example: E911 + type: integer + - description: >- + A Rate Center search filter - all returned TNs will be in the + entered Rate Center. Typically this is a 3 or 5 digit value. + example: 435 in: query - name: service + name: lata required: false schema: - enum: - - E911 - - Voice - - Hosted_E911 - type: string + type: integer - description: >- - The Rate Center designation that the number is served from. If not - combined with a State search the results will span states. - example: RALEIGH + A Rate Center search filter - all returned TNs will be in the + entered Rate Center. This `ratecenter` must be combined with a + `state` in the query. If State is not included in the query then + the query will fail. + example: PLANO in: query name: rateCenter required: false schema: type: string - description: >- - A 2 character State or Province designation - TX for Texas for - example. + A State search filter - all returned TNs will be in the entered + State. This is a 2-character State or Province abbreviation. example: TX in: query name: state required: false schema: type: string - - description: >- - A service tier indicating the the vendor class that the TN is - associated with. Tier indicates whether the TN is on-net, domestic - offnet, Canadian, etc. - example: 5 - in: query - name: tier - required: false - schema: - type: integer responses: '200': content: @@ -43099,10 +43832,8 @@ paths: $ref: '#/components/schemas/TelephoneNumbersHistoryResponse' description: >- The descriptive payload for the TNs query provides information about - the TN(s) that were found in the Query. Information about the City, - State, LATA, Rate Center, Tier, Vendor, Status, Owning Account and - Last Modified Date is provided for each TN in the payload. Links to - assist in pagination are also provided. + the TN(s) that were found in the Query. Links to assist in + pagination are also provided. '400': content: application/xml: @@ -43129,8 +43860,49 @@ paths: description: >- Retrieve information about one or more Telephone Numbers (TNs), where the TNs are specified in POST body. + + + In this table are presented capabilities that are not universally + available. The following request query parameters are only allowed for + numbers from specific region/country: + + | Number Region | Request Query Parameter | + + |:--------------|:------------------------| + + |NANPA|city| + + |NANPA|tier| + + |NANPA|npaNxx| + + |NANPA|npaNxxx| + + |NANPA|lata| + + |NANPA|state| + + |NANPA|ratecenter| + + + When the query parameters listed in the table above are passed, only + North American Numbering Plan phone numbers from are returned. operationId: ListTnsByPost - parameters: [] + parameters: + - description: A service type value to filter the TNs returned in the payload. + example: Voice + in: query + name: service + required: false + schema: + enum: + - Voice + - Hosted_Voice + - Messaging + - Hosted_Messaging + - E911 + - Hosted_E911 + type: string requestBody: content: application/xml: @@ -43253,13 +44025,10 @@ paths: $ref: '#/components/schemas/TelephoneNumbersHistoryResponse' description: >- The descriptive payload for the TNs query provides information about - the TN(s) that were found in the Query. Information about the City, - State, LATA, Rate Center, Tier, Vendor, Status, Owning Account and - Last Modified Date is provided for each TN in the payload. The - Payload also can contain where invalid or non-existing - on account(s) TNs are specified. Aging numbers will be displayed if - user has access to the previous accountId. Pagination doesn't work - in this case. + the TN(s) that were found in the Query. The Payload also can contain + where invalid or non-existing on account(s) TNs are + specified. Aging numbers will be displayed if user has access to the + previous accountId. Pagination doesn't work in this case. '400': content: application/xml: @@ -43323,12 +44092,14 @@ paths: is "protected" only the account owning the TN can order it, otherwise it should be generally available.
  • Aging: The TN is disconnected by the customer owning the TN. At this time, the TN - will go into aging for some period of time (typically 30 days) and - the customer owning the TN can order it again. If the allotted time - has passed and the TN is not ordered by the owning customer, the TN - will go back to Available.
  • PortInPendingFoc: TN is in FOC - and waiting for the FOC date.
  • Reserved: A TN is reserved by - a customer to order at a later time.
    • + will go into aging for some period of time and the customer owning + the TN can order it again. If the allotted time has passed and the + TN is not ordered by the owning customer, the TN will go back to + Available.
  • PortInPendingFoc: TN is in process of porting and + waiting for the porting completion date. The term FOC is short for + Firm Order Commitment and applies to NANPA number + ports.
  • Reserved: A TN is reserved by a customer to order at + a later time.
    • summary: Retrieve tn tags: - Tns @@ -43387,7 +44158,7 @@ paths: description: >- Bad Request - failed to get available NnRoutes information for the current phone number. - summary: Retrieve routes for that tn + summary: Retrieve routes for that tn [NANPA] tags: - Tns /tns/{tn}/e911: @@ -43428,7 +44199,7 @@ paths: schema: $ref: '#/components/schemas/TnE911AddressResponse' description: The e911 address have been successfully retrieved and displayed - summary: Retrieve e911 for that tn + summary: Retrieve e911 for that tn [NANPA] tags: - Tns /tns/{tn}/lata: @@ -43459,7 +44230,7 @@ paths: schema: $ref: '#/components/schemas/TelephoneNumberLataResponse' description: The lata have been successfully retrieved. - summary: Retrieve lata for that tn + summary: Retrieve lata for that tn [NANPA] tags: - Tns /tns/{tn}/lca: @@ -43508,7 +44279,7 @@ paths: schema: $ref: '#/components/schemas/NpaNxxRcLcaSearchResult' description: The LCAs have been successfully retrieved and displayed. - summary: Retrieve LCA for that tn + summary: Retrieve LCA for that tn [NANPA] tags: - Tns /tns/{tn}/ratecenter: @@ -43541,7 +44312,7 @@ paths: schema: $ref: '#/components/schemas/TelephoneNumberRateCenterResponse' description: The rate centers have been successfully retrieved and displayed. - summary: Retrieve rate center for that tn + summary: Retrieve rate center for that tn [NANPA] tags: - Tns /tns/{tn}/sippeers: @@ -43607,8 +44378,28 @@ paths: /tns/{tn}/tndetails: get: description: >- - Retrieves detailed information about the phone number. TnAttributes - - Does this telephone number is protected or not. + Retrieves detailed information about the phone number. + + + In this table are presented capabilities that are not universally + available. The following response body attributes are only returned for + numbers from specific region/country: + + | Number Region | Response Body Attributes | + + |:--------------|:------------------------| + + |NANPA|LATA| + + |NANPA|State| + + |NANPA|RateCenter| + + |NANPA|E911| + + + These parameters are only applicable and hence returned in response body + for North American Numbering Plan phone numbers. operationId: RetrieveTnDetails parameters: - description: '' @@ -43623,35 +44414,6 @@ paths: content: application/xml: examples: - Non-NANP details: - value: |- - - - - +33140289562 - FR - geographic - 49 - Bandwidth CLEC - true - Inservice - 12345678 - - 123 - site - - - 500001 - sippeer - false - - - Voice - - 2020-03-03T15:30:07.000Z - 2020-03-03T15:30:07.518Z - - Shared TN details: value: |- @@ -43985,8 +44747,7 @@ paths: $ref: '#/components/schemas/TelephoneNumberDetailHistoryResponse' description: >- OK - the detailed information about the phone number has been - successfully retrieved and displayed.
    TnAttributes is not - required in the response. + successfully retrieved and displayed. '400': content: application/xml: @@ -44058,7 +44819,8 @@ tags: url: /docs/numbers/porting/port-ins/bulkPortIns name: Bulk Port-In - name: Callbacks - - name: Cities + - name: Compliance + - name: Coverage - description: >- DLDA = Directory Listing and Directory Assistance. A DLDA resource associates a TN with a Street Address. This gets updated in a Network @@ -44089,7 +44851,6 @@ tags: description: Emergency notification guide url: /docs/emergency/dashboard/notifications/ name: Emergency Notification - - name: External Tn - name: Hosted Messaging - name: Hosted Voice - name: Import Tn to Account diff --git a/site/specs/phone-number-lookup.yml b/site/specs/phone-number-lookup.yml index 1ce596b32..ba3a07899 100644 --- a/site/specs/phone-number-lookup.yml +++ b/site/specs/phone-number-lookup.yml @@ -103,10 +103,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.PhoneNumberLookupApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -305,10 +305,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.PhoneNumberLookupApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); diff --git a/site/specs/voice.yml b/site/specs/voice.yml index 88702b30f..1ebc18a31 100644 --- a/site/specs/voice.yml +++ b/site/specs/voice.yml @@ -149,12 +149,13 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.CallsApi; - public class Example { + public class Sample { public static void main(String[] args) { - + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); // Configure HTTP basic authorization: Basic HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); @@ -457,10 +458,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.CallsApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -684,10 +685,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.CallsApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -875,10 +876,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.CallsApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -890,10 +891,7 @@ paths: CallsApi apiInstance = new CallsApi(defaultClient); String accountId = "9900000"; // String | Your Bandwidth Account ID. String callId = "c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85"; // String | Programmable Voice API Call ID. - String body = - - This is a test sentence. - ; // String | + String body = "This is a test sentence. "; // String | try { apiInstance.updateCallBxml(accountId, callId, body); } catch (ApiException e) { @@ -1011,10 +1009,12 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.ConferencesApi; - public class Example { + import java.util.List; + + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -1217,10 +1217,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.ConferencesApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -1447,10 +1447,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.ConferencesApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost"); @@ -1646,10 +1646,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.ConferencesApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -1661,10 +1661,7 @@ paths: ConferencesApi apiInstance = new ConferencesApi(defaultClient); String accountId = "9900000"; // String | Your Bandwidth Account ID. String conferenceId = "conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9"; // String | Programmable Voice API Conference ID. - String body = - - - ; // String | + String body = ""; // String | try { apiInstance.updateConferenceBxml(accountId, conferenceId, body); } catch (ApiException e) { @@ -1775,10 +1772,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.ConferencesApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -2009,34 +2006,36 @@ paths: } - lang: Java source: | - import com.bandwidth.BandwidthClient; - import com.bandwidth.http.response.ApiResponse; - import com.bandwidth.voice.models.*; - - import java.util.concurrent.CompletableFuture; - import java.util.concurrent.ExecutionException; + import com.bandwidth.sdk.ApiClient; + import com.bandwidth.sdk.ApiException; + import com.bandwidth.sdk.Configuration; + import com.bandwidth.sdk.auth.*; + import com.bandwidth.sdk.model.*; + import com.bandwidth.sdk.api.ConferencesApi; public class Sample { - public static final String USERNAME = "api-username"; - public static final String PASSWORD = "api-password"; - public static final String ACCOUNT_ID = "12345"; - public static void main(String[] args) { - String conferenceId = "conf-95ac8d8d-28e06798-2afe-434c-b0f4-666a79cd47f8"; - String callId = "c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d"; - - BandwidthClient client = new BandwidthClient.Builder() - .voiceBasicAuthCredentials(USERNAME, PASSWORD) - .build(); + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); - ConferenceMemberState conferenceMemberState = new ConferenceMemberState(); - conferenceMemberState.setMute(true); + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + ConferencesApi apiInstance = new ConferencesApi(defaultClient); + String accountId = "9900000"; // String | Your Bandwidth Account ID. + String conferenceId = "conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9"; // String | Programmable Voice API Conference ID. + String memberId = "c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85"; // String | Programmable Voice API Conference Member ID. + UpdateConferenceMember updateConferenceMember = new UpdateConferenceMember(); // UpdateConferenceMember | try { - CompletableFuture> completableFuture = client.getVoiceClient().getAPIController().modifyConferenceMemberAsync(ACCOUNT_ID, conferenceId, callId, conferenceMemberState); - System.out.println(completableFuture.get().getResult()); - } catch (InterruptedException | ExecutionException e) { - System.out.println(e.getMessage()); + apiInstance.updateConferenceMember(accountId, conferenceId, memberId, updateConferenceMember); + } catch (ApiException e) { + System.err.println("Exception when calling ConferencesApi#updateConferenceMember"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); } } } @@ -2254,10 +2253,12 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.ConferencesApi; - public class Example { + import java.util.List; + + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -2472,10 +2473,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.ConferencesApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost"); @@ -2694,10 +2695,12 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.ConferencesApi; - public class Example { + import java.io.File; + + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -2916,10 +2919,12 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.RecordingsApi; - public class Example { + import java.util.List; + + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost"); @@ -3134,10 +3139,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.RecordingsApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost"); @@ -3368,10 +3373,12 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.RecordingsApi; - public class Example { + import java.util.List; + + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost"); @@ -3579,10 +3586,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.RecordingsApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -3797,10 +3804,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.RecordingsApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -4005,10 +4012,12 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.RecordingsApi; - public class Example { + import java.io.File; + + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost"); @@ -4212,10 +4221,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.RecordingsApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -4434,10 +4443,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.RecordingsApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -4669,10 +4678,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.RecordingsApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); @@ -4907,10 +4916,10 @@ paths: import com.bandwidth.sdk.ApiException; import com.bandwidth.sdk.Configuration; import com.bandwidth.sdk.auth.*; - import com.bandwidth.sdk.models.*; + import com.bandwidth.sdk.model.*; import com.bandwidth.sdk.api.RecordingsApi; - public class Example { + public class Sample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient();