Query a Specific YMP User

HTTP method and endpoint

GET /api/v1/system/users/{user_id}

Request parameters

Parameter Importance Type Description
user_id Required Integer User ID.

Response parameters

Parameter Type Description
id Integer User ID.
name String Name.
externalId String External ID.
email String Email address.
phoneNumber String Phone number.
userMode String User mode.
  • regular: YMP regular user.
  • hosting: YMP hosting user.
extension Integer How many extensions the user owns.
concurrentCall Integer How many concurrent calls the user owns.
recordingCapacity Integer How many recording capacity the user owns.
instance Integer How many PBX instances the user owns.
minExtension Integer The minimum extensions the user owns.

Examples

Request example

GET /api/v1/system/users/198 HTTP/1.1
Host: ympapi.yeastarcloud.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9uYW1lIjoiY2VjaWxpYUB5ZWFzdGFyLmNvbSIsInNjb3BlIjpbInRydXN0Il0sImV4cCI6MTU0NjkzNTg1OCwiYXV0aG9yaXRpZXMiOlsiUk9MRV9hZG1pbiJdLCJqdGkiOiJlNzJkMjNlYi03NjdhLTRhZmItYjQ2Zi03YzYxNmJmN2EzYjgiLCJjbGllbnRfaWQiOiI5Nzg5OTNmMDk2YzQ0MTFmYTljYzgwZWUyZTYyZjFmMiJ9.1HyxxEGbGNDc9A4ihm-dXGoKRhFh_YKYeOrNgt1IhRc
Cache-Control: no-cache

Response example

HTTP/1.1 200 OK
{
    "status": "Success",
    "user": {
        "concurrentCall": 1,
        "email": "testqm2u@yeastar.com",
        "extension": 1,
        "id": 218,
        "instance": 1,
        "minExtension": 1,
        "name": "testqm2u",
        "phoneNumber": "123",
        "recordingCapacity": 0,
        "userMode": "hosting"
    }
}