Business Talk Digital API enables Business Talk customers to manage the trunk configuration (voice sites, DID numbers, emergency zones, portability, ...).
Returns the country list supported by the service.
Returns one country list supported by the service.
Returns the list of number types available in the country.
Returns the list of dial zones available for a given number type.
Returns the list of dial zones available for a given number type.
Return the list of valid addresses in Netherlands according to the address given into query string.
Return the list of valid addresses in Denmark according to the address given into query string.
Return the list of valid addresses in Czech Republic according to the address given into query string.
Return the list of valid addresses in Australia according to the address given into query string.
Return the list of valid addresses in France+DROM according to the address given into query string.
Return the list of valid addresses in South Africa according to the address given into query string.
Check and normalize an address according to country specificities.
Return the list of valid publication categories, which contraint allowed values for nedExtInfo2 in voiceSite.directorySettings for voicesites in France+DROM.
Return the list of valid values for a2 (district), a3 (county) and a4 (municipality) in Portugal. Each returned entry correspond to a valid triplet a2/a3/a4 which can be used in a site address.
Return the list of valid values for pc (postal code), pcn (localilty). Each returned entry correspond to a valid pair pc/pcn which can be used in a site address.
Return the list of valid addresses in France+DROM according to the address given into query string.
Return the list of valid publication categories, which contraint allowed values for nedExtInfo2 in voiceSite.directorySettings for voicesites in France+DROM.
Return the list of valid addresses in France+DROM according to the address given into query string.
Return the list of valid addresses in France+DROM according to the address given into query string.
Return the list of valid addresses in France+DROM according to the address given into query string.
Return the list of valid publication categories, which contraint allowed values for nedExtInfo2 in voiceSite.directorySettings for voicesites in France+DROM.
Return the list of valid addresses in France+DROM according to the address given into query string.
Return the list of valid publication categories, which contraint allowed values for nedExtInfo2 in voiceSite.directorySettings for voicesites in France+DROM.
Return the list of valid addresses in France+DROM according to the address given into query string.
Return the list of valid publication categories, which contraint allowed values for nedExtInfo2 in voiceSite.directorySettings for voicesites in France+DROM.
Return the list of valid addresses in France+DROM according to the address given into query string.
Return the list of valid publication categories, which contraint allowed values for nedExtInfo2 in voiceSite.directorySettings for voicesites in France+DROM.
Return the list of valid publication categories, which contraint allowed values for nedExtInfo2 in voiceSite.directorySettings for voicesites in France+DROM.
Return the list of valid publication categories, which contraint allowed values for nedExtInfo2 in voiceSite.directorySettings for voicesites in France+DROM.
Returns the list of possible values of area1, area2, area3 or area4 for the geographical available, depending on the provided values: | no area param -> area1 are returned | area1 provided -> area2 are returned | area1 and area2 provided -> area3 are returned | area1 and area2 and area3 provided -> area4 are returned
Returns the list of possible values of area1 for the geographical available.
Returns the list of possible values of area2 for the geographical available, with a given area1.
Returns the list of possible values of area3 for the geographical available, with a given area1.
Returns the list of possible values of area4 for the geographical available, with a given area1.
Returns the list of address constraints of a country.
Returns the list of portability request constraints of a country.
Returns the list of portability out request constraints of a country.
Returns the list of legal information constraints of a country.
This operation allows viewing all the existing portability document templates.
This operation allows downloading one document template for portability.
This operation allows downloading one document for portability.
Returns the list of voice site parameters which can have a country specific default value.
Returns the configuration of the geographical (emergency and dial zone) selection constraints.
This operation allows viewing all the existing cca portability document templates.
This operation allows downloading one document template for cca portability.
Returns information of the authenticated customer.
Returns the customers managed by the authenticated users. For retail customers, only one entry is returned. For a reseller, reseller customer and all child customers are returned.
Returns the customer identified by his code.
Returns all the emergency plans for the given customer.
Create a new emergency plan for a customer that can target all or part of the customer's inventory
Create a new emergency plan for a customer voicesite scope
Get a specific emergency plan's details (either voicesite or inventory scope).
Update the name or description of an existing customer emergency plan
Delete an existing emergency plan
Update the numbersRerouting configuration of an existing emergency plan
Update the globalRerouting configuration of an existing emergency plan (voicesite scope only)
Activate or deactivate an existing emergency plan
This operation allows verifying if the numberRerouting and globalRerouting rules in the emergency plan are valid or not in regards to customer or site inventory and configuration.
Returns the customer disclaimers in the USA. To be used to consult customer status.
Updates customer. To be used to accept disclaimer.
Returns the list of voice VPNs of the customer.
Returns the administrators managing the customer.
Returns the administrator details.
Returns the list of existing group names used in voicesites.
The group name will be updated on all voicesites.
The group name will be removed from all voicesites.
Returns the list of existing black lists.
Create the black list.
Get the black list details.
Update the black list.
The black list will be removed from the system. If the black list is used, it cannot be removed.
Returns the list of existing white lists.
Create the white list.
Get the white list details.
Update the white list.
The white list will be removed from the system. If the white list is used, it cannot be removed.
Returns the list of existing CLI rules.
Get the CLI rules details.
Returns the detailed parameters of a voice site.
Updates the voice site group. This resource can be modified in a voicesite in any provisioning state (no impact on the voicesite provisioning)
Updates the voice site general settings. This resource can be modified in a voicesite in any provisioning state (no impact on the voicesite provisioning)
Updates the voice address.
Updates the voice site national enquiry publication settings.
Updates the voice site technical settings.
Updates the voice site options.
Updates the voice site network information.
Updates the voice site advanced parameters.
Updates the voice site SIP termination list.
Updates the voice site SIP termination list (offnet only).
Updates the voice site dial plan.
This operation enables to move the running state of the voice site to "closed". This operation is immediate and does not require to change the provisioningState.
Returns the result of all the checks performed before submitting a site.
Returns the full audit of dialplan overlapping checks.
Returns the inventory of configured did 911 numbers.
Returns the inventory the CCA Numbers created from a specific LVS range
This operation commits all modifications made to the site.
Returns the list of dialzones on which this voicesite has at least one DID number. This list is useful for the the dialzoneExtension geographical constraint is allowed.
Returns the report of the last provisioning request. In case of error, if the error is due to a configuration issue, the report gives extensive information.
Returns the constraints applicable to this site. The returned information is dynamically calculated according to the current configuration of the site.
Updates the list of customer contacts attached to the voicesite. These contacts will receive mail notification.
Updates the list of customer contacts attached to the voicesite. These contacts won't receive mail notification.
retrieve statistics about voiceSites
Updates the administrative address. See Geographical constraints to check the expected address for the country of the voicesite.
Updates the legal information. See Geographical constraints and legalinformation constraints to check the expected information for the country of the voicesite.
Check the voice site consistency with the hookah voice site. The consistency result contains hookah voice site differences.
Returns the list of all Voice Sites of the customer. Could be paginated in case of large number of results.
Returns the list of all billing accounts that can be used for the voicesite defined in the path.
Returns the list of all billing accounts of the customer.
Returns the list of all routers of the customer. Could be paginated in case of large number of results. Searching in the voicesite path allows to get routers usable for this site.
Returns the list of all access sites (sites with Orange WAN routers) of the customer. Could be paginated in case of large number of results. Searching in the voicesite path allows to get access sites usable for this site.
Returns the list of all routers of the customer. Could be paginated in case of large number of results.
Returns information of one router.
Returns an access site using its ID
Returns the list of all access sites (sites with Orange WAN routers) of the customer. Could be paginated in case of large number of results.
Create new access site for a specific voiceSite.
Returns a SIP termination using the ID (t1t7)
Updates the SIP termination
Returns the list of trial numbers for a customer
This operation allows to create on the fly a number for the customer trunk acceptance test. The trial number is available for a period of 15 days. The trial number can be cancelled befor the end of the trial period.
Returns a trial number for a customer
This operation allows updating the status of a trialnumber.
Returns the list of all SIP terminations of the customer. Could be paginated in case of large number of results.
Returns the list of all SIP terminations of the customer. Could be paginated in case of large number of results.
Updates the administrative information (billing account, core site, pricing approval)
Returns the list of all BTIP main attachment sites of the customer.
This operation allows searching among available numbers. This operation is meant to be used as a prerequisite to search a number/range that will be booked then. The option "local voice" is required to have access to this operation. NOTE: a site is mandatory (inherit geographic zone)
This operation allows consulting global inventory accross all sites.
This operation allows viewing the booked number as initially booked. The option "local voice" is required to have access to this operation.
This operation allows to assign DID numbers from datacenter to a virtual voicesite.
This operation allows to remove DID numbers from a virtual voicesite, to move it back to datacenter.
This operation allows viewing the allocation table of DID numbers in a datacenter voicesite. This operation is not available for virtual and corporate voicesites.
This operation allows unfreezing a range defined by firstNumber. The full range defined by firstNumber will be unfrozen, it is not possible to unfreeze part of the range.
Allocates an available number (in datacenter) to a virtual site. Available only for virtual voicesites.
This operation allows viewing details on one existing portability out request.
This operation allows updating a portability out request.
Updates the list of customer contacts attached to the portability OUT request. These contacts will receive mail notifications.
Updates the list of customer contacts attached to the portability OUT request. These contacts won't receive mail notifications.
This operation allows viewing all the existing portability out requests.
This operation allows consulting a DID number rerouting rule.
This operation allows updating a DID number rerouting rule.
This operation allows deleting a DID number rerouting rule.
This operation allows consulting all DID number rerouting rule.
This operation allows creating a DID number rerouting rule.
This operation allows consulting a DID number rerouting rule (rerouting to external number).
This operation allows updating a DID number rerouting rule (rerouting to external number).
This operation allows deleting a DID number rerouting rule (rerouting to external number).
This operation allows consulting all DID number rerouting rule (rerouting to external number).
This operation allows creating a DID number rerouting rule (rerouting to external number).
This operation allows consulting all customer contacts.
This operation allows creating a contact sheet.
This operation allows consulting one customer contacts.
This operation allows updating a contact.
This operation allows deleting one customer contact. If this contact is used in an object (voicesite, portability request, order) it will be removed.
Updates the list of internal contacts attached to the order.
This operation allows creating a DID number move request, to move DID numbers from one voicesite to another.
This operation allows consulting all number move request.
This operation allows consulting one number move request.
This operation allows updating a number move request.
This operation allows deleting a number move request. The remove is allowed only for request in draft state.
This operation allows checking if the move request is consistent and ready to be submitted.
This operation allows to view the dialplan which will be moved from donor site to recipient site.
This operation allows submitting the move request.
Returns the numbers owned by customer and verified by Orange. These numbers can be used as non-orange numbers in a site dialplan without country constraints.
Returns one entry of customer owned number.
Updates the customer owned number.
Delete an existing customer owned number
This operation allows viewing all the existing portability requests.
This operation allows creating a new portability request. The numbers will ported to CCA service.
This operation allows creating a new portability request. The numbers will be ported to a BTLVS voicesite.
This operation allows creating a new portability request. The numbers will be ported to a BTIP voicesite.
This operation allows viewing details on one existing portability request.
This operation allows updating a portability request.
This operation allows deleting an existing portability request. Only portability requests in draft status can be deleted.
This operation allows checking if the portability is consistent and ready to be submitted.
This operation provisiones all backends for portability.
This operation allows updating the state of a portability request.
This operation allows updating the address of a portability request.
Updates the list of customer contacts attached to the portability request. This contacts will receive mail notifications.
Updates the list of customer contacts attached to the portability request. This contacts won't receive mail notifications.
This operation allows updating a portability request.
This operation allows viewing all the existing portability documents.
This operation allows uploading documents for portability.
This operation allows downloading one document for portability.
This operation allows updating the ranges of portability request. The operation is allowed only in the draft state.
This operation allows updating the destination numbers of cca portability request. The operation is allowed only in the draft state.
Allows to customize the dialplan that will be setup for the ported numbers for a BTLVS portability. The dialplan must contain exclusively numbers compatible with the ported numbers.
This operation allows to view available documents related to Business Talk over Internet. It includes in particular the certificates.
This operation allows downloading one document.
This operation allows to view available guides related to Business Talk Digital.
This operation allows downloading one document.
This operation allows to view available news related to Business Talk Digital.
This operation allows downloading one document.
This operation allows to view Business Talk coverage documents (service coverage, country local areas, ...).
This operation allows downloading one document.
Returns the status
Returns information about API version
Returns the Swagger 2.0-compliant API documentation (JSON format)
Returns the activity logs
Applies a global change.
Get the list of all global change requests for siptermination and offsetsiptermination for a customer.
Applies a global change to either a list of voicesites or all compatible voicesites for a customer. Compatible voicesites are the one one the same VPN than the provided Sipterminations
Retrieve details on a particular global change requests for siptermination and offsetsiptermination
Request a new customer export. The export will be processed asynchronously.
View the exports jobs.
View one exports job.
Download export data.
Get quote details.
Update quote basic parameters.
Download the quote document. This is available only from the approval state (and next states).
Change order state. Available transition:
Create a new voicesite order.
Create a new vpn option order.
Create a new did number portability order.
Create a new continuity option order.
The order allows to activate / deactivate a list of DID Numbers.
Create a new black/white list option order.
Create a new did number order.
Create a new site voice channels order. DEPRECATED (use POST /customers/{customerCode}/orders/voicechannels instead).
Create a new site voice channels.
Create a new did number not in stock order.
Create a new GTR S1 option order.
Create a new CLI management option order.
Create a new business continuity number option order.
Create a new welcome number option order.
Create a new single number option order.
Returns an order
Updates an order (limited to common and generic information common to all orders)
This operation allows to cancel a pending order. It is available only for orders which can be pending, and which are allowed to be canceled. As of current version, only didnumberstock order are supported with this operation, while the order is in pending state.
Add comments to an existing order. Comments can be added to any order at any state.
Returns the customer orders.
Create a new Trunk order.
Create a new Trunk order.
Create a new Trunk change order.
Create a new Trunk change order.
Create a cancellation request for a complete voicesite. The cancellation request will be rejected if the voicesite has still active DID numbers, or pending orders, or pending portability requests. Warning: this operation is immediate and cannot be reverted.
Create a cancellation request to opt-out the vpn option. Once the cancellation request is initiated, the voicesites which holds the option needs to be re-committed with a configuration compliant with the deactivated option.
Create a cancellation request to opt-out the continuity option. Once the cancellation request is initiated, the voicesites which holds the option needs to be re-committed with a configuration compliant with the deactivated option.
Create a cancellation request to opt-out the customlist option. Once the cancellation request is initiated, the voicesites which holds the option needs to be re-committed with a configuration compliant with the deactivated option.
Create a cancellation request to cancel numbers. Once the cancellation request is initiated, the voicesites which holds the DID numbers needs to be re-committed with a configuration compliant with the cancelled numbers.
Create a cancellation request to opt-out the GTR S1 option. Once the cancellation request is initiated, the voicesites which holds the option needs to be re-committed with a configuration compliant with the deactivated option.
Create a cancellation request to opt-out the CLI management option. Once the cancellation request is initiated, the voicesites which holds the option needs to be re-committed with a configuration compliant with the deactivated option.
Create a cancellation request for a Trunk. Warning: this operation is immediate and cannot be reverted.
View price for new did number allocation order (wholesalers only).
View price for new did number activation order.
View price for new did number portability order.
View price for new did number order.
View price for new did number not in stock order.
View price for new voicesite order.
View price for new vpn option order.
View price for new continuity option order.
View price for new black/white list option order.
View price for new gtr S1 option order.
View price for new cli management option order.
View price for new welcome number option order.
View price for new single number option order.
View price for new business continuity number option order.
View price for new site voice channels order. DEPRECATED (use POST /customers/{customerCode}/orders/voicechannels instead).
View price for new voice channels order.
Get list of divisions.
Get list of divisions.
Returns the list of all customer options. Could be paginated in case of large number of results.
Returns the list of all customer options. Could be paginated in case of large number of results.
Allows to get available Purchase Order Number values. These values serves as helper for the portal. Note that the usasge of this API is totally optional as it won't be used as source of verification for orders.
Allows to declare a Purchase Order Number value. This value serves as helper for the portal. Note that the usasge of this API is totally optional as it won't be used as source of verification for orders.
Allows to delete a Purchase Order Number values.
get a list of owned CCA numbers
Update CCA number destination.
Update CCA number destination.
Update CCA number administrative (pricing, billing)
Returns the list of configured finalDestination labels
add a label to a finalDestination
Get the label associated with a specific final Destination.
This API allows to update the label associated with a final Destination
This operation allows deleting the label for a specific final Destination
This API allows to update the label associated with multiple final destinations
restore a canceled CCA Number
List available snapshots for a SAN.
Apply an advancedSetting snapshot to a Cca number.
get a list of available CCA numbers in stock
Get documents for a cca number order
Upload documents for a cca number order
Get a document for a cca number order
Delete a document for a cca number order
create a new cca numbers order (in stock)
create a new cca numbers order (out of stock)
get order price
get order price
Create order price
Get document templates
Get a document template
Get all shared call limiters for a particular customer.
create a new Shared Call Limiter
Get a specific Shared Call Limiter.
Update a specific Shared Call Limiter.
delete a specific Shared Call Limiter.
Get all calendars configured for this particular VPN.
Create a new Calendar
Get a specific calendar.
Update calendar for a particular VPN.
Delete existing Calendar for a particular VPN.
Get the list of all requests for active strategy for a customer.
change the active strategy for several CCA numbers
Retry a failed or pending request
Retrieve details on a particular requests for active strategy change
Update CCA number Advanced Settings (Ring Duration, call Limiters, black/white List, timezone, routing strategy)
Update CCA Number activation state
Update CCA Number active strategy
Update CCA Number Trunk Calling Site parameters
Get list of timezones managed by btd.
Updates the CCANumber group. This resource can be modified in a CCANumber in any provisioning state.
Returns the list of existing group names used in CCANumbers.
updates the group for a list of CCA Numbers. This resource can be modified in a CCA Number in any provisioning state
The group name will be updated on all CCANumber.
The group name will be removed from all CCANumber.
Returns the list of available Mobile prefixes for the requested Country.
Returns the list available tariff levels for the requested number type. Tariff levels are usually available for REVENUE SHARE and SHARED COST
This operation allows viewing the negotiated tariff sheet of the customer for call usage to domestic and international destinations for btlvs voice offer.
This operation allows viewing the negotiated tariff sheet of the customer for voice Site installation and options in a given country.
This operation allows viewing the negotiated tariff sheet of the customer for cca voice offer.
Returns the list of available flat fee packages for this country
Create a cancellation request to cancel numbers.
Create a new order.
Return the Voice Monitoring analytics for the customer
Return the calls analytics for a customer
Retrieve next calls
Get all shared call limiters for a particular customer.
Get a specific Shared Call Limiter.
Update a specific Shared Call Limiter.
Get all published numbers in Operator Connect Gateway.
Update the usage of published numbers in Operator Connect Gateway.
This API allows to publish number from an operator connect site toward OPC Gateway. Those numbers will be published then by the Gateway into the customer tenant.
This API allows to release numbers from an operator connect site that were aleady published in OPC Gateway. Those numbers will be released by the Gateway from the customer tenant.
This API allows to synchronize the OPC inventory of a voicesite with regards to the customer OPC tenant.
Get all Byon Contract for a customer.
This API allows to retrieve for a byon customer the usage of a particular private stock
This API allows to retrieve for a byon customer the usage of all private byon stocks
This operation allows viewing the list of addresses created for a customer.
This operation allows the creation of an addresse for a customer.
This operation allows retrieving an addresse created for a customer.
This operation allows modifying an addresses created for a customer.
This operation allows Deleting an addresse created for a customer.
This operation allows modifying the dialzone of an addresse created for a customer.
This operation allows modifying the label of an addresse created for a customer.
This operation allows viewing all the existing Customer Address documents.
This operation allows uploading documents for the validation of a Customer Address
This operation allows downloading one document for a Customer Address.
This operation allows deleting one document attached to a Customer Address
Update CCA number address
Get the list of all requests for address change for a customer
change the address for several CCA numbers.
Retrieve details of a previsouly started global change request
Download the status report generated for a global change request
1.18.4
OAS 2.0
[ Base URL: api.orange.com/btalk/v1 ]https://developer.orange.com/ope-contents/channels/87afd7365baec589/offers/ycxNl32449tlSzKj/products/Bb03D6HeL1pmBeQ1/contents/swagger/XDlhKH6lcx6DScw6/business-talk-digital-api_EXTERNAL_OD_PROD.json
Business Talk Digital API enables Business Talk customers to manage the trunk configuration (voice sites, DID numbers, emergency zones, portability, ...).
| HTTP status code | reason | response model |
|---|---|---|
| 400 | List of supported error codes: - 20: Invalid URL parameter value - 21: Missing body - 22: Invalid body - 23: Missing body field - 24: Invalid body field - 25: Missing header - 26: Invalid header value - 27: Missing query-string parameter - 28: Invalid query-string parameter value | {
"code": 28,
"message": "Invalid query-string parameter value",
"description": "One or more query-string parameters contain invalid values."
} |
| 401 | List of supported error codes: - 40: Missing credentials - 41: Invalid credentials - 42: Expired credentials | {
"code": 42,
"message": "Expired credentials",
"description": "The requested service needs credentials, and the ones provided were out-of-date."
} |
| 403 | List of supported error codes: - 50: Access denied - 51: Forbidden requester - 52: Forbidden user - 53: Too many requests | {
"code": 53,
"message": "Too many requests",
"description": "The application has made too many calls and has exceeded the rate limit for this service."
} |
| 404 | List of supported error codes: - 60: Resource not found | {
"code": 60,
"message": "Resource not found",
"description": "The requested URI or the requested resource does not exist."
} |
| 405 | List of supported error codes: - 61: Method not allowed | {
"code": 61,
"message": "Method not allowed",
"description": "The URI does not support the requested method. The available methods should be set in the response header 'Allow'"
} |
| 406 | List of supported error codes: - 62: Not acceptable | {
"code": 62,
"message": "Not acceptable",
"description": "The Accept incoming header does not match any available content-type."
} |
| 408 | List of supported error codes: - 63: Request time-out | {
"code": 63,
"message": "Request time-out",
"description": "The server timed out waiting for the incoming request."
} |
| 409 | List of supported error codes: - 69: Conflict | {
"code": 69,
"message": "Conflict",
"description": "The request could not be completed due to a conflict with the current state of the resource."
} |
| 411 | List of supported error codes: - 64: Length required | {
"code": 64,
"message": "Length required",
"description": "The request did not specify a Content-Length header, which is required by the requested resource."
} |
| 412 | List of supported error codes: - 65: Precondition failed | {
"code": 65,
"message": "Precondition failed",
"description": "One of the precondition request headers (aka. 'If-None-Match', 'If-Match', 'If-Modified-Since', and 'If-Unmodified-Since') failed to match."
} |
| 413 | List of supported error codes: - 66: Request entity too large | {
"code": 66,
"message": "Request entity too large",
"description": "The body of the request/response (PATCH, POST and PUT methods) is larger than the server is willing or able to process."
} |
| 414 | List of supported error codes: - 67: Request-URI too long | {
"code": 67,
"message": "Request-URI too long",
"description": "The URI provided was too long for the server to process."
} |
| 415 | List of supported error codes: - 68: Unsupported Media Type | {
"code": 68,
"message": "Unsupported Media Type",
"description": "The format of the posted body is not supported by the endpoint."
} |
| 429 | List of supported error codes: - 53: Too many requests | {
"code": 53,
"message": "Too many requests",
"description": "The application has made too many calls and has exceeded the rate limit for this service."
} |
| 500 | List of supported error codes: - 1: Internal error | {
"code": 1,
"message": "Internal error",
"description": "Generic failure message, used if no more precise code can be provided."
} |
| 502 | List of supported error codes: - 1: Internal error - 3: Bad gateway | {
"code": 1,
"message": "Bad gateway",
"description": "A runtime execution error occurs (RaiseFault)."
} |
| 503 | List of supported error codes: - 5: The service is temporarily unavailable - 6: Orange API is over capacity, retry later ! | {
"code": 6,
"message": "Orange API is over capacity, retry later !",
"description": "The service faces too much requests and can not handle the call."
} |
| 504 | List of supported error codes: - 6: Gateway timeout | {
"code": 6,
"message": "Gateway timeout",
"description": "No response was received in time from a backend server acting as gateway or proxy."
} |