Create a YCM User

Create a YCM user.

Request URL

POST {base_url}/dm/open_api/v1/users

Request parameters

Headers


Parameter	Required	Type	Description
Authorization	Yes	String	Pass the access token in the header. Format: Bearer `{access_token}`.

Body


Parameter	Required	Type	Description
userType	Yes	String	Define the user type. Valid value: `My Colleague` `Hosting User`
company	No	String	Company name. Note: This parameter is required when creating a hosting user.
firstName	Yes	String	First name.
lastName	No	String	Last name.
email	Yes	String	Email.
phone	No	String	Phone number.
mobile	No	String	Mobile number.
address	No	String	Address.
remark	No	String	Remark.
Hosting Package
totalExtensions	Yes	Integer	The total number of extensions.
totalConcurrentCalls	Yes	Integer	The total number of concurrent calls.
totalRecordings	Yes	Integer	The total number of call recording minutes.
minimumExtPerPBX	Yes	Integer	The minimum number of extensions for each PBX.
highAvailability	No	String	Whether to enable the High Availability service or not. Valid value: `subscribed`: Enable `unsubscribed`: Disable
totalCustomDomains	No	Integer	The number of custom domains the user can set in each region.

Response parameters


Parameter	Type	Description
data	Object <Details>	The detailed information.
requestId	String	The unique ID of the request, which can be used to quickly locate the request.
status	String	Request result: `Success` `Failed`
time	Long	The response time. Note: The YCM API response returns a timestamp, you can convert the timestamp to detailed date and time as needed. For more information, see Convert Timestamp to Local Date and Time.

Details


Parameter	Type	Description
userId	Integer	The ID of the created YCM user.

Example

Request example

Create a user account for a colleague.

POST /dm/open_api/v1/users HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NzM0OSwidmVyc2lvbiI6MTYzODk1OTkwOSwicmVmcmVzaFZlcnNpb24iOjE2NjQ0MzYwNzV9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NDM3ODc1LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiIwZDM2NTI2Yi0yMTQ3LTRiMGQtYTg0MS1jMDFlMzVjYjE0ZmIiLCJjbGllbnRfaWQiOiJrcDl5eW50bXVlc3VrNWpvV3ZNa1RiQ0J4cU82TEtSaCJ9.yU-GTl59gDP_ayXebJ8EkoX5DtOqZH7QP5ygYOtrwyg
Content-Type: application/json
{
  "userType": "My Colleague",
  "firstName": "Malinda",
  "email": "malinda@example.com",  
  "mobile": 13811112222
}

Response example

HTTP/1.1 200 OK
{
    "data": {
        "userId": 13856
    },
    "requestId": "e8bf12d614215281aba0084545a605f0",
    "status": "Success",
    "time": 1666071768
}