api:customer:get-name
Table of Contents
API : Customer Get name
Introduction
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.
Request
| URL | https://api.telecomx.dk/customer/CUSTOMER_ID/name | |
|---|---|---|
| Method | GET | |
| Access level | VIEWER, MANAGER or OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller. ADMIN. |
|
| Param | CUSTOMER_ID | Id of the customer (24 hex-char string) |
Query example
https://api.telecomx.dk/customer/1234567890ABCDEF12345678/name
Response
| Json object | ||
|---|---|---|
| _id | Id | Unique customer id |
| name | String | Name of the customer |
| features | Array | List of features in the TelecomX platform that the customer has access to. Can only be set by ADMIN or RESELLER users. A reseller can only assign features that the reseller has to the resellers customers. The available features are: CUSTOMER - Basics, addresses, financial, usage limits, employees SIP - SIP trunks MVNO - Mobile phones PBX - Hosted PBX, SIP phones, music on hold, Webhooks (auto-enables SIP, MVNO, CUSTOMER) TCE - Telecom Call Enhancer DNS - Domain management INTERNET - Fiber & xDSL TV - TV |
Example
{ _id: '52f4fd7734697b28ccaf77ec', name: 'Anders And & Co', features: ['CUSTOMER','SIP','MVNO'] }
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | customer | Customer not found |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/customer/get-name.txt · Last modified: 2016/05/24 06:13 by Per Møller