Common parameters
Path parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | The Fusion platform can be used by multiple service providers to offer an MS Teams Direct Routing offering. This instance allows to connect to the right Fusion instance. If you don't know what to use, please contact your Netaxis support contact |
Query parameters
N/A
Body parameters
Owner
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
type | string | Can either be distributoror reseller | no |
uuid | string | Universal unique id of the owner | no |
name | string | Name the owner | no |
Markup
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
markup | float | Price markup to apply at the selected level (distributor, reseller, ...) | no |
startDate | string | Start date of application of this markup | no |
Suspension Profile
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | integer | Index of the suspension profile | no |
name | string | Name of the suspension profile | no |
description | string | Description of the suspension profile | yes |
barringProfileId | string | Barring profile ID of the suspension profile | yes |
License Type
Name of the license type.
Value in enumeration:
- msteams,
- sip-trunks.
Entitlement Type
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | integer | Index of the entitlement type | no |
name | string | Name of the entitlement type | no |
description | string | Description optionally providing more information | no |
externalReference | string | Reference (e.g. SKU in a product catalog) under which this entitlement type is known in an external system | no |
countryCode | string | Country code for which this entitlement is valid | no |
numberType | string | Number type for which this entitlement is valid | no |
serviceCapabilities | string | Not important in this context (can be ignored) | no |
vanityType | string | Vanity numbers are numbers that have a very nice/special format (e.g. end with 0000). Sometimes additional charges are accounted for this. | no |
Range
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | integer | Internal index of the entry | no |
countryCode | string | Name of the entitlement type | no |
rangeStart | integer | Start of the range | no |
rangeEnd | integer | End of the range | no |
region | integer | Geographical region to which this number range is assigned (only relevant for certain numberTypes) | yes |
numberType | string | Number type of the numbers in this range | no |
nbAvailable | integer | Amount of numbers still available for assignment in this range | no |
nbTotal | integer | Total amount of numbers in this range | no |
createdOn | DateTime | Timestamp when this entry was added in the backend | no |
updatedOn | DateTime | Timestamp when this entry was last updated in the backend | no |
Country code
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | integer | Internal index of the entry | no |
code | string | Country code as known in e.164 phone number formatting | no |
name | string | Country name | no |
createdOn | DateTime | Timestamp when this entry was added in the backend | no |
updatedOn | DateTime | Timestamp when this entry was last updated in the backend | no |
Country ISO code
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
isoCode | string | Country code in ISO 3166 alpha-2 format | no |
name | string | Country name | no |
Geographical region
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | integer | Internal index of the entry | no |
name | string | Country name | no |
createdOn | DateTime | Timestamp when this entry was added in the backend | no |
updatedOn | DateTime | Timestamp when this entry was last updated in the backend | no |
Postal code
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | integer | Internal index of the entry | no |
code | string | Postal code | no |
city | string | City associated to the postal code | no |
state | string | State where the city is located | no |
region | object | Region where the city is located, an object including database index and name | yes |
country | object | Country where the city is located, an object including database index, name and ISO code | yes |
Emergency Location
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | integer | Index of the emergency location | no |
name | string | Name of the emergency location | no |
Error handling
All errors returned by the platform have a specific code that is unique to the platform. Error codes are grouped as follows:
1xxx: defines an error while retrieving a resource2xxx: defines an error while creating a resource3xxx: defines an error while updating a resource4xxx: defines an error while deleting a resource9xxx: defines generic errorsgamma1xxx: are same as1xxxbut specific for Gamma errorsgamma2xxx: are same as2xxxbut specific for Gamma errorsgamma3xxx: are same as3xxxbut specific for Gamma errorsgamma4xxx: are same as4xxxbut specific for Gamma errorsgamma9xxx: are same as9xxxbut specific for Gamma errors
HTTP Error codes
Response body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
code | integer | Error code (see below for a complete error list) | no |
reason | string | Message providing more context to the error that occurred | no |
Example
json
{
"error": {
"code": 2001,
"reason": "An error occurred while creating the distributor"
}
}Error list
| Code | Reason |
|---|---|
| 1001 | An error occurred while retrieving the list of distributors |
| 1002 | An error occurred while retrieving a distributor |
| 1003 | An error occurred while retrieving a list of resellers |
| 1004 | An error occurred while retrieving a reseller |
| 1005 | An error occurred while retrieving a list of tenants |
| 1006 | An error occurred while retrieving a tenant |
| 1007 | An error occurred while retrieving the list of suspension profiles |
| 1008 | An error occurred while retrieving the list of subscriptions |
| 1009 | An error occurred while retrieving the list of license types |
| 1010 | An error occurred while retrieving the list of licenses |
| 1011 | An error occurred while counting the teams users |
| 1012 | An error occurred while retrieving entitlements |
| 1013 | An error occurred while retrieving entitlement types |
| 1014 | The requested object does not exist |
| 1015 | An error occurred while reading the list of MS Teams users |
| 1016 | An error occurred while reading the list of Fusion users |
| 1017 | This MS Teams user doesn't exist for this tenant |
| 1018 | An error occurred while reading porting requests list for this tenant |
| 1019 | You do not own this porting request |
| 1020 | An error occurred while reading the porting transaction |
| 1021 | An error occurred while reading the porting request |
| 1022 | An error occurred while retrieving documents for this porting request |
| 1023 | An error occurred while retrieving the list of operators allowed to issue porting requests |
| 1024 | An error occurred while retrieving routing info from local SRE |
| 1025 | An error occurred while retrieving destinations info from local SRE |
| 1026 | An error occurred while retrieving locations |
| 1027 | An error occurred while retrieving the list of postal codes |
| 1028 | An error occurred while retrieving the list of geo regions |
| 1029 | An error occurred while retrieving the list of emergency locations |
| 1030 | An error occurred while reading the list of MS Teams resource accounts |
| 1031 | An error occurred while reading the list of Fusion resource accounts |
| 1032 | An error occurred while reading the resource account types |
| 1033 | An error occurred while retrieving the civic addresses for Operator Connect |
| 1034 | An error occurred while reading the list of free numbers for this Operator Connect link |
| 1035 | The string you are searching for doesn't seem to match a valid international phone number |
| 1036 | An error occurred while reading the list of destinations for rate plan assignment |
| 1037 | An error occurred while reading the list of prices for a specific destination of rate plan |
| 1038 | An error has occurred while reading available items for product definition |
| 1039 | An error occurred while reading the list of products |
| 1040 | An error occurred while reading the order request |
| 1041 | An error occurred while reading the order requests list |
| 1042 | An error occurred while reading the access trunks list |
| 1043 | An error occurred while reading the list of prices for the specified rate plan |
| 1044 | Please provide a level for which you want to find potential owners |
| 1045 | An error occurred while reading a configuration key |
| 1046 | An error has occurred while retrieving the list of subsites for Anywhere 365 |
| 1047 | License assign error |
| 1048 | Create MS User error |
| 1049 | Delete MS User error |
| 1050 | An error occurred while retrieving this agent or supervisor |
| 1051 | An error occurred while retrieving the agents and supervisors list |
| 1052 | An error occurred while retrieving the list of free MS Teams users for agent or supervisor enrollment |
| 1053 | An error occurred while retrieving the list of skills for this subsite |
| 1054 | An error occurred while reading the voice routing policies |
| 1055 | An error occurred while reading the MS Teams groups |
| 1056 | An error occurred while reading the business hours |
| 1057 | An error occurred while reading the User's sip address |
| 1058 | The Group does not exist exist |
| 1059 | You already have onboarded this subscription to a MS Teams tenant |
| 1060 | An error occurred while reading the list of phone usages |
| 1061 | An error occurred while reading the list of product usages |
| 1062 | An error has occurred while reading the list of available templates |
| 1063 | The selected template ID does not exist |
| 1064 | An error occurred while reading the pstn usages |
| 1065 | An error occurred while reading the voice routes |
| 2000 | An error occurred while creating the price markup - Transaction rolled back |
| 2001 | An error occurred while creating the distributor |
| 2002 | An error occurred while creating the reseller |
| 2003 | An error occurred while creating the tenant |
| 2004 | An error occurred while creating the subscription |
| 2005 | An error occurred while creating the license |
| 2006 | The license can't be created because this license type doesn't exist |
| 2007 | The license can't be created because the subscription does not exist |
| 2008 | An error occurred while processing the number inventory management request - Transaction rolled back |
| 2009 | An error occurred while creating the entitlement |
| 2010 | An admin with this username already exists in the system |
| 2011 | An error occurred while creating the administrator (already exists) - Transaction rolled back |
| 2012 | An error occurred while preparing MS Tenant for provisioning |
| 2013 | It seems application rights have not been propagated yet through your Azure AD, please retry later |
| 2014 | An error occurred while creating the new sub-domain on MS Teams |
| 2015 | You do not have enough Office 365 E1, E3 or E5 license to complete setup. Please add one and retry |
| 2016 | An error occurred while validating new sub-domain by using an E5 license |
| 2017 | An error occurred while adding service DNS entries |
| 2018 | An error occurred while adding an SBC to your domain |
| 2019 | Wrong level for an admin |
| 2020 | An error occurred while creating the MS Teams administrator |
| 2021 | An error occurred while creating the porting request |
| 2022 | An error occurred while adding an attachment to the porting request |
| 2023 | An error occurred while creating a new location for this subscription |
| 2024 | An error occurred while creating the trunk group |
| 2025 | A trunk group with the same name already exists |
| 2026 | An error has occurred while adding numbers to your SIP trunk |
| 2027 | You have not subscribed yet to the list of numbers you want to add to your SIP trunk |
| 2028 | An error occurred while checking the prerequisites for the resource account |
| 2029 | You do not own the phone number you want to add to the resource account |
| 2030 | The phone number you want to add to the resource account is already linked to another resource |
| 2031 | An error occurred while creating the resource account |
| 2032 | An error occurred while onboarding the tenant to Operator Connect |
| 2033 | You have no valid consent to Operator Connect for provided data |
| 2034 | You already have onboarded to Operator Connect |
| 2035 | The code for confirming Operator Connect onboarding doesn't seem to be right |
| 2036 | You do not own the numbers you want to link to Operator Connect |
| 2037 | You do not own enough licenses to link these numbers |
| 2038 | An error occurred while activating your numbers in Operator Connect - Operation rolled back |
| 2039 | Some of the numbers you are trying to link to Operator Connect are already linked to other resources |
| 2040 | Your tenant seems to lack some pre-requisites to link these numbers, please check if onboarding is OK |
| 2041 | You have no license left to link a phone number to this resource account |
| 2042 | An error has occurred while adding a price to this rate plan |
| 2043 | The rate plan you have specified does not exist |
| 2044 | Start date for a price must be set in the future |
| 2045 | The numbers or ranges you have provided are not valid |
| 2046 | A distributor with this external ID already exists |
| 2047 | A reseller with this external ID already exists |
| 2048 | A tenant with this external ID already exists |
| 2049 | The list of items used to define the product contains not valid entries |
| 2050 | An error has occurred while creating the product |
| 2051 | A product with this SKU already exists |
| 2052 | You cannot put a value higher than the amount of trunking channels |
| 2053 | This combination tenant / subscription is not known by our system |
| 2054 | One or some of the requested products from your ordering request is disabled or doesn't exist in our system |
| 2055 | An error occurred while executing your ordering request |
| 2056 | User credentials have to be provided when authorisation is required |
| 2057 | Primary or secondary peer IP address is mandatory when no authorization is required |
| 2058 | An error occurred while creating the access trunk |
| 2059 | This MS Teams Tenant is already existing in our system |
| 2060 | A distributor has to be linked to a group, please specify one |
| 2061 | An error occurred while creating the group |
| 2062 | An error occurred while inserting a configuration key |
| 2063 | An error occurred while onboarding you Anywhere 365 site |
| 2064 | An error occurred while enrolling this user to this Anywhere 365 subsite |
| 2065 | This user is already assigned to this Anywhere 365 subsite with this role |
| 2066 | Create MS User error |
| 2067 | An error occurred while creating a business hour |
| 2068 | An error occurred while initiating the MS Graph gateway for this tenant |
| 2069 | You must provide the MS Teams tenant ID as we cannot find it back from our records |
| 2070 | The provided MS Teams already has a MS Graph integration. Please consider to link to this tenant if you want to modify this |
| 2071 | The subscription you want to link to doesn't exist |
| 2072 | You are not a direct owner or a group admin of the tenant you are trying to link to |
| 2073 | The tenant you are trying to link to doesn't have a MS Teams link yet |
| 2074 | The Voice Routing Policy for this template does not exist |
| 2075 | One or more MS Groups for this template does not exist |
| 2076 | One or more MS license does not exist for this template |
| 2077 | A template with the same SKU already exists for this subscription |
| 2078 | An error occurred while creating the template |
| 2079 | An error occurred while creating the pstn usage |
| 2080 | An error occurred while creating the voice route |
| 2081 | An error occurred while creating the voice routing policy |
| 2082 | An error occurred while creating the Anywhere 365 filter |
| 2083 | This pstn usage already exists |
| 2084 | This voice route already exists |
| 2085 | This voice routing policy already exists |
| 2086 | This Anywhere 365 filter already exists for your subscription |
| 2087 | An error occurred while sending the welcome email |
| 2088 | An error occurred while reading rate plans |
| 2089 | The query params parent and type are required |
| 2090 | An error occurred while updating voice routing configurations |
| 2091 | Not unique billingId in the Group |
| 2092 | You don't have enough licenses left |
| 3000 | An error occurred while modifying the price markup |
| 3001 | An error occurred while modifying the distributor |
| 3002 | An error occurred while modifying the reseller |
| 3003 | An error occurred while modifying the tenant |
| 3004 | An error occurred while modifying the suspension status |
| 3005 | An error occurred while modifying the subscription |
| 3006 | An error occurred while modifying the license |
| 3007 | An error occurred while modifying the entitlement |
| 3008 | NIMS error while assigning numbers |
| 3009 | An error has occurred while activating voice settings for this MS Teams user |
| 3010 | The number you've requested to activate voice service for this MS Teams user is already in use by another one |
| 3011 | You do not have enough Fusion licenses to onboard this MS Teams user |
| 3012 | This MS Teams user is not Voice Enabled. Please check assigned licenses in MS Office 365 |
| 3013 | The number you've requested to activate voice service for this MS Teams user does not exist in our system |
| 3014 | An error has occurred while removing voice settings for this MS Teams user |
| 3015 | An error has occurred while de-assigning existing phone number for this MS Teams user |
| 3016 | An error occurred while trying to cancel the porting request |
| 3017 | An error occurred while trying to activate the porting request |
| 3018 | The porting request has been cancelled but there were some errors while cleaning the Fusion database |
| 3019 | The porting request has been activated but there were some errors while updating the Fusion database |
| 3020 | You can't reduce this license at this level because it is still in use |
| 3021 | An error occurred while modifying the location |
| 3022 | An error occurred while modifying the SIP trunk |
| 3023 | The new name you have specified for this SIP trunk already exists |
| 3024 | This porting request cannot be activated anymore |
| 3025 | This porting request cannot be cancelled anymore |
| 3026 | The country code of the phone number doesn't match the country code of the user |
| 3027 | An error occurred while resetting the application credentials for MS Graph integration |
| 3028 | An error has occurred while modifying the product |
| 3029 | An error has occurred while modifying the access trunk |
| 3030 | The number you are trying to use is not assigned to Operator Connect |
| 3031 | The number you are trying to use is already assigned to another user |
| 3032 | An error occurred while trying to link the phone number to the user |
| 3033 | An error occurred while modifying the group |
| 3034 | An error occurred while modifying a configuration key |
| 3035 | An error occurred while modifying the trunk group |
| 3036 | An error has occurred while trying to modify an agent or supervisor for this Anywhere 365 subsite |
| 3037 | License assign error |
| 3038 | The skills could be partially assigned to the agent: some are not supported in the new subsite |
| 3039 | An error occurred while modifying the business hour |
| 3040 | An error occurred while modifying the pstn usage |
| 3041 | An error occurred while modifying the voice route |
| 3042 | An error occurred while modifying the voice routing policy |
| 3043 | The requested template template to apply to the user could not be found |
| 3044 | You are trying to apply a non-voice enabled template to a voice enabled user |
| 3045 | Your template tries to change location of a user that is already voice enabled in another country |
| 3046 | An error has occurred while assigning the country to the user |
| 3047 | An error has occurred while assigning the licenses to the user. Please check if you still have some available for assignment and retry |
| 3048 | An error has occurred while assigning the voice routing policy to the user. Please wait a minute and try to apply the template again |
| 3049 | An error has occurred while changing groups of the user. Please check that new groups from template still exist in your MS tenant |
| 3050 | A conflict occurred during the assignment of the licenses. Please check the combination and retry |
| 3051 | An error occurred while disabling password expiration from dummy user |
| 3052 | Not unique billingId in the Group |
| 4000 | An error occurred while deleting price markups |
| 4001 | An error occurred while deleting a distributor |
| 4002 | An error occurred while deleting a reseller |
| 4003 | An error occurred while deleting a tenant |
| 4004 | An error occurred while deleting a subscription |
| 4005 | An error occurred while deleting a license |
| 4006 | An error occurred while deleting the entitlement |
| 4007 | The requested object doesn't exist |
| 4008 | An error occurred while unlinking Direct Routing data in MS Teams |
| 4009 | An error occurred while unlinking dummy O365 user |
| 4010 | An error occurred while unlinking DNS entries |
| 4011 | An error occurred while unlinking MS O365 domain |
| 4012 | An error occurred while unlinking MS Azure AD application for Graph usage |
| 4013 | You cannot unlink this MS Teams tenant as it still has active users |
| 4014 | An error occurred while removing this attachment from the porting request |
| 4015 | An error occurred while deleting the location |
| 4016 | An error occurred while deleting the SIP trunk |
| 4017 | An error has occurred while removing numbers from your SIP trunk |
| 4018 | An error has occurred while removing the resource account |
| 4019 | An error has occurred while removing the link to Operator Connect |
| 4020 | There are still numbers linked to Operator Connect for this tenant. Please remove all numbers before retrying |
| 4021 | You do not own all numbers in the list you are trying to remove from Operator Connect |
| 4022 | Some of the number you want to remove from Operator Connect are still linked to users |
| 4023 | An error has occurred while trying to deassign numbers for this subscription |
| 4024 | An error occurred while trying to delete a price |
| 4025 | Yon are not allowed to delete a price that has a start date in the past |
| 4026 | You are trying to access or modify resources you don't control |
| 4027 | You cannot delete a trunkgroup that still has numbers connected to it |
| 4028 | An error occurred while trying to delete the access trunk |
| 4029 | Some of the numbers you try to add are not available |
| 4030 | The provided pilot is not connected to this trunk |
| 4031 | An error occurred while deleting a group |
| 4032 | An error occurred while unlinking your Anywhere 365 site |
| 4033 | An error has occurred while trying to remove these agents from this Anywhere 365 subsite |
| 4034 | Delete MS User error |
| 4035 | An error occurred while deleting the business hour |
| 4036 | An error occurred while deleting the template |
| 4037 | Cannot delete default template |
| 4038 | Cannot delete the pstn usage due to connections to voice routing or voice routing policies |
| 4039 | An error occurred while deleting the Anywhere 365 filter |
| 4040 | You cannot delete a reseller that still has tenants connected to it |
| 4041 | You cannot delete a tenant that still has subscriptions connected to it |
| 9000 | UUID lookup error |
| 9001 | An error has occurred while checking the owner for this record |
| 9002 | You don't have the appropriate rights to perform this action |
| 9003 | NIMS ID lookup error |
| 9004 | You have no license to start MS Tenant onboarding |
| 9005 | There seems to be some data inconsistency on your request, please contact an administrator before retrying |
| 9006 | This MS Teams tenant does not exist yet |
| 9007 | This MS Teams tenant is not fully onboarded yet |
| 9008 | Your Azure AD integration seems incomplete or broken. Please check it before trying again |
| 9009 | An error has occurred while reading data for performing this request |
| 9010 | This MS Teams tenant doesn't seem to wait for a valid registration code |
| 9011 | This MS Teams tenant is not onboarded to Operator Connect |
| 9012 | The group you have specified does not exist |
| 9013 | As a system admin, you can't perform this action without giving a direct or indirect relation to one of the existing groups |
| 9014 | Anywhere 365 feature is not enabled for this group |
| 9015 | The Anywhere 365 main site does not exist |