Create User

Creates a new user and returns the created record.

When to use. Add a user to your account. If a user with the same username already exists, that existing user is returned and no new user is created.

Required fields. username, email and sip_option.

Notes. If you omit password, a temporary password is generated for the user. When sip_option is set to Custom URI, sip_uri is required. You can also assign roles and desks by passing their IDs. See the request schema for the full list of accepted fields.

Returns. 201 Created with { "users": [ { ... } ] }.

Example.

{
  "username": "demo",
  "email": "[email protected]",
  "sip_option": 0
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Dialer Name (subdomain)

Body Params
string
required

Username.

string
required

Email address.

Password for the user account.

integer
required

SIP option (0 - WebRTC, 2 - Custom URI (needs sip_uri), 3 - Built in PBX).

Whether the user is active (1/0).

Timestamp the user clocked in.

SIP URI (required when sip_option is Custom URI).

Auto-dial status (1/0).

Whether the user is deleted (1/0).

Use extended IP ACL (1 - yes, 0 - no).

Timestamp the user clocked in for predictive dialing.

Predictive dynamic extension.

Timezone ID.

First name.

Last name.

Virtual extension.

Default language (e.g. en_US, es_ES, pt_BR).

Maximum session time.

Maximum concurrent sessions.

Two-factor authentication type (default, disabled, email, google).

Member of all skill groups (1/0).

Member of all desks (1/0).

PBX region (0 - default).

array | null

IDs of desks associated with the user.

array | null

IDs of roles assigned to the user.

array | null

IDs of skill groups assigned to the user.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json