Create a Hosting User

HTTP method and endpoint

POST /api/v1/system/users

Request parameters

Parameter Importance Type Description Restriction
name Required String Name.
  • Maximum 63 characters.
  • The following characters are NOT allowed:

    :!$()\/#;,[]"=<>&'^%@{}`|
password Required String The password of YMP web login.
  • Minimum 6 characters.
  • Maximum 63 characters.
  • At least 1 letter.
  • At least 1 number.
externalId Optional String External ID.
  • Maximum 63 characters.
  • The following characters are NOT allowed:

    &\"$<>'`|
email Required String Email address. Maximum 63 characters.
phoneNumber Required String Phone number. Maximum 31 characters.
extension Required Integer How many extensions for the user. Minimum value: 1
concurrentCall Required Integer How many concurrent calls for the user. Minimum value: 1
recordingCapacity Required Integer How many recording capacity for the user. Minimum value: 0
instance Required Integer How many PBX instances for the user. Minimum value: 1
minExtension Required Integer The minimum extensions for the user.
  • Minimum value: 1
  • The value should be less than the extension.

Response parameters

Parameter Type Description
id Integer User ID.

Examples

Request example

POST /api/v1/system/users HTTP/1.1
Host: ympapi.yeastarcloud.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9uYW1lIjoiY2VjaWxpYUB5ZWFzdGFyLmNvbSIsInNjb3BlIjpbInRydXN0Il0sImV4cCI6MTU0NjkzNzY5MSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9hZG1pbiJdLCJqdGkiOiJlMjQ5YmFmOC0yYWIwLTQ5ZjAtYjdkYS01ZTYzMjk3OGMyZWMiLCJjbGllbnRfaWQiOiI5Nzg5OTNmMDk2YzQ0MTFmYTljYzgwZWUyZTYyZjFmMiJ9.JIXt3d6KduQAowmBAHQmGKvC7nS45f6rqyC5bTMKl58
Cache-Control: no-cache
Postman-Token: 9705623f-a8ab-a965-53df-02aa90f8cadc

{
	"name": "carol",
	"password": "Carol918sjs82xj2",
	"externalId": null,
	"email": "carol@yeastar.com",
	"phoneNumber": "123913883883",
	"extension": 10,
	"minExtension": 1,
	"concurrentCall": 2,
	"recordingCapacity": 1,
	"instance": 3
}

Response example

HTTP/1.1 200 OK
{
    "status": "Success",
    "user": {
        "id": 218
    }
}