This request will return the the id and name of the specified customer. This is typically used when a customer is directly referenced and we need to display the name of the customer and also know if we may access this customer.
| URL | https://api.telecomx.dk/customer/CUSTOMER_ID/name | |
|---|---|---|
| Method | GET | |
| Access level | PERSONAL, VIEWER, MANAGER or OWNER if user belongs to the customer (PERSONAL only for their own customer). RESELLER if customer belongs to the reseller or a sub reseller. RESELLER_ADMIN. ADMIN. |
|
| Param | CUSTOMER_ID | Id of the customer (24 hex-char string) |
https://api.telecomx.dk/customer/1234567890ABCDEF12345678/name
| Json object | ||
|---|---|---|
| _id | Id | Unique customer id |
| name | String | Name of the customer |
| parentReseller | Id | Id of reseller customer belongs to |
| features | Array | List of features the customer has access to: CUSTOMER, SIP, MVNO, PBX, DNS, INTERNET, IPTVPRIVATE, IPTVBUSINESS, FLEXCARE, ZEROTIER, EXTERNAL_LICENSES, NETWORK_MANAGEMENT, DIALOG, CHANGELOG, ORGANIZATION. |
| Integrations | ||
| integrations | Object | Contains information about 3rd party integrations |
| integrations.billing | Object | Contains billing integrations |
| integrations.billing.economic | Object | Integration for visma e-conomic |
| integrations.billing.economic.enabled | Boolean | True if the integration is enabled, default false. |
| integrations.billing.economic.agreementGrantToken | String | Agreement grant token. It's set when allowing the “Telecom X Billing Integration” e-conomic app to access the reseller's e-conomic account. |
| integrations.billing.economic.accrual | Boolean | Determines whether the reseller wants to use the accrual-module in e-conomic. Requires the module to be bought in e-conomic. |
| integrations.billing.rackbeat | Object | Integration for Rackbeat |
| integrations.billing.rackbeat.enabled | Boolean | True if the integration is enabled, defaults false |
| integrations.billing.rackbeat.bearerToken | String | Bearer token created from rackbeat, used to verify against their API |
| integrations.billing.uniconta | Object | Integration for Uniconta |
| integrations.billing.uniconta.enabled | Boolean | True if the integration is enabled, defaults false |
| integrations.billing.uniconta.username | String | Username for logging into Uniconta |
| integrations.billing.uniconta.password | String | Password for logging into Uniconta |
| integrations.billing.uniconta.companyId | String | Company Id the user is connected to, in Uniconta |
| integrations.criipto.enabled | Boolean | True if the integration is enabled, defaults false |
| integrations.criipto.clientId | String | UUID for creating signature orders with criipto |
| integrations.criipto.clientSecret | String | Client secret for creating signature orders with criipto |
| integrations.criipto.domain | String | Domain for redirection login |
| integrations.criipto.clientIdRealm | String | Client Id for domain |
| integrations.licenses | Object | Licenses from 3rd parties, e.g ALSO. |
| integrations.licenses.also | Object | ALSO licenses integration |
| integrations.licenses.also.enabled | Boolean | Whether this customer/reseller should have their licenses synchronized from ALSO, etc. |
| integrations.licenses.also.username | String | ALSO username |
| integrations.licenses.also.password | String | ALSO password |
| integrations.licenses.also.customerId | String | The customer's ID from ALSO. |
| integrations.licenses.also.tenantId | String | The Microsoft tenant ID of the customer, synchronized from ALSO. |
| integrations.ms365 | Object | Settings for integration with Microsoft 365 |
| integrations.ms365.enabled | Boolean | Whether this integration is enabled for this customer. |
| integrations.ms365.tenantId | String | Id of customers tenant in MS 365 |
| integrations.ms365.verified | Boolean | True if connection to tenant has been verified |
| integrations.ms365.calendarSync | Boolean | True to integrate users calendars |
| integrations.ms365.contactsSync | Boolean | True to integrate users contacts |
| integrations.ms365.orgContactsSync | Boolean | True to integrate the organisation contacts |
| integrations.ms365.presenceSync | Boolean | True to sync presence and/or Trams InAMeeting/InACall status |
| integrations.ms365.calendarShowAsMappings | Object | Calendar mappings |
| integrations.ms365.calendarShowAsMappings.free | String | Presence state to map free to: AVAILABLE, BUSY, OUT_OF_OFFICE, OFF_WORK, HOLIDAY or IGNORE to do nothing. |
| integrations.ms365.calendarShowAsMappings.tentative | String | Presence state to map tentative to: AVAILABLE, BUSY, OUT_OF_OFFICE, OFF_WORK, HOLIDAY or IGNORE to do nothing. |
| integrations.ms365.calendarShowAsMappings.busy | String | Presence state to map busy to: AVAILABLE, BUSY, OUT_OF_OFFICE, OFF_WORK, HOLIDAY or IGNORE to do nothing. |
| integrations.ms365.calendarShowAsMappings.oof | String | Presence state to map oof to: AVAILABLE, BUSY, OUT_OF_OFFICE, OFF_WORK, HOLIDAY or IGNORE to do nothing. |
| integrations.ms365.calendarShowAsMappings.workingElsewhere | String | Presence state to map workingElsewhere to: AVAILABLE, BUSY, OUT_OF_OFFICE, OFF_WORK, HOLIDAY or IGNORE to do nothing. |
| integrations.ms365.calendarCategoryMappings | Array | List of calendar category mappings |
| integrations.ms365.calendarCategoryMappings[].category | String | Category label to map to presence state. |
| integrations.ms365.calendarCategoryMappings[].presence | String | Presence state to map the category to: AVAILABLE, BUSY, OUT_OF_OFFICE, OFF_WORK or HOLIDAY. |
| integrations.mvnoPrivate | Object | Settings for integration with MVNO for private customers |
| integrations.mvnoPrivate.enabled | Boolean | True to enable the integration |
| integrations.mvnoPrivate.portal | String | The portal URL to redirect customers to |
{ "_id": "650000000000000000000101", "name": "Example Company", "parentReseller": "650000000000000000000201", "features": ["CUSTOMER", "SIP", "MVNO"], "integrations": { "billing": { "economic": { "enabled": true, "agreementGrantToken": "<AGREEMENT_GRANT_TOKEN>", "accrual": false }, "rackbeat": { "enabled": false }, "uniconta": { "enabled": false } }, "licenses": { "also": { "enabled": true, "username": "user@example.dk", "password": "<ALSO_PASSWORD>", "customerId": "1234567", "tenantId": "00000000-0000-0000-0000-000000000000" } }, "ms365": { "enabled": true, "tenantId": "00000000-0000-0000-0000-000000000000", "verified": true, "calendarSync": true, "contactsSync": true, "orgContactsSync": false, "presenceSync": true, "calendarShowAsMappings": { "free": "IGNORE", "tentative": "IGNORE", "busy": "BUSY", "oof": "HOLIDAY", "workingElsewhere": "OUT_OF_OFFICE" }, "calendarCategoryMappings": [ { "category": "Vacation", "presence": "HOLIDAY" } ] }, "mvnoPrivate": { "enabled": true, "portal": "https://mobile.example.dk" }, "criipto": { "enabled": false } } }
| Error code | Message | Description |
|---|---|---|
| 422 | id | Customer id is invalid |
| 404 | customer | Customer not found |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |