This resource is designed to create and manage dealers of the system. Each PBX client belongs to a dealer who defines general settings for all his clients, such as routing rules, various limits, dialing rules, preferred media servers, and others.

1 Resource fields description
2 Allowed dealer domains
- 2.1 Description of the "Allowed Dealer Domains" resource fields
3 Resources of the "Admin" section

Resource fields description

Name	Type	Description	Required	Default value

Name	Type	Description	Required	Default value
`name`	`string`	Dealer name	Yes
`id`	`integer`	Unique dealer id. Read only.	-	-
`create_date`	`string`	Dealer creation date in the format: YYYY-MM-DD HH:MM:SS. Read only.	-	-
`sbc_mode`	`string("yes","no")`	Enable (value yes) or disable (value no) sbc mode for dealer clients. If SBC mode is enabled, media for client extensions will go through the same address as SIP messages. SBC mode can be used when the client's firewall only allows connection to one address.	No	no
`client_day_limit`	`integer`	The limit on the number of created clients per day. If null, there is no limit. Otherwise, if at the time of the API request to create a client with this dealer, the number of clients specified in the parameter has been created over the past day, the API request will return an error.	No	null
`routing_list_id`	`integer`	Identifier of the list of routing rules for outgoing calls of the dealer's clients. If null, the default routing list will be used. Can be overridden by a specific client parameter.	No	null
`dispatcher_list_id`	`integer`	Identifier of the list of preferred media servers of the dealer's clients. If the identifier is set, then the exchange of media data of the clients of this server will occur through media servers from the specified list when they are available. If set to null, the default list of media servers will be used. This parameter can be useful in the sending media data of the dealer's clients through the media servers that are closest to them geographically.	No	null
`client_calls_limit`	`integer`	The limit on the number of simultaneous client calls. If null, there is no limit. Can be overridden by a limit of a specific client.	No	null
`dial_rule_limit`	`integer`	The limit on the number of client dial rules. If null, the global limit is used.	No	null
`type`	`string`	Dealer type, information field. The value of F is an individual, the value of J is a legal entity.	No	F
`ambassadors`	`string`	Dealer contact persons, information field.	No	null
`contact_phones`	`string`	Dealer contact numbers, information field.	No	null
`contact_emails`	`string`	Dealer contact email addresses, information field.	No	null
`jur_address`	`string`	Dealer's legal address, information field.	No	null
`fact_address`	`string`	Dealer's actual address, information field.	No	null

Allowed dealer domains

Each dealer can create clients only in certain domains. The list of dealer allowed domains is configured by the "Dealer Allowed Domains" resource, which contains a list of domain identifiers in which the dealer can create clients.

Description of the "Allowed Dealer Domains" resource fields

Name	Type	Description	Required	Default value

Name	Type	Description	Required	Default value
`allowed_domains`	`array [integer]`	List of identifiers (id) of domains in which the dealer can create clients. The list may be empty. The domain identifier (id) cannot be removed from the list if the dealer already has clients in this domain.	Yes

Resources of the "Admin" section

`POST /admin/dealer/`

Create a new dealer

JSON parameters

Dealer fields

Response fields

Dealer fields

`GET /admin/dealer/`

Get a list of the dealers

Request parameters

Name	Type

Name	Type
`name`	`array [string]`
`id`	`array [integer]`

Response fields

Dealer fields

`PUT /admin/dealer/{dealer_id}`

Update a dealer

URL parameters

Name	Type

Name	Type
`dealer_id`	`integer`

JSON parameters

Dealer fields

Response fields

Dealer fields

`GET /admin/dealer/{dealer_id}`

Get a dealer by id

URL parameters

Name	Type

Name	Type
`dealer_id`	`integer`

Response fields

Dealer fields

`DELETE /admin/dealer/{dealer_id}`

Delete a dealer

URL parameters

Name	Type

Name	Type
`dealer_id`	`integer`

`PUT /admin/dealer/{dealer_id}/allowed_domains/`

Update a dealer allowed domains list

URL parameters

Name	Type

Name	Type
`dealer_id`	`integer`

JSON parameters

Resource fields "Allowed dealer domains"

Response fields

Resource fields "Allowed dealer domains"

`GET /admin/dealer/{dealer_id}/allowed_domains/`

Get an allowed dealer domains list

URL parameters

Name	Type

Name	Type
`dealer_id`	`integer`

Response fields

Resource fields "Allowed dealer domains"