Skip to content
Snippets Groups Projects
endpt.md 20.3 KiB
Newer Older
# endpt Schema

```
https://www.iopsys.eu/endpt.json
```

| Custom Properties | Additional Properties |
| ----------------- | --------------------- |
| Forbidden         | Forbidden             |

# endpt

| List of Methods           |
| ------------------------- |
| [call](#call)             | Method | endpt (this schema) |
| [codecs](#codecs)         | Method | endpt (this schema) |
| [connection](#connection) | Method | endpt (this schema) |
| [count](#count)           | Method | endpt (this schema) |
| [rtp_stats](#rtp_stats)   | Method | endpt (this schema) |
| [signal](#signal)         | Method | endpt (this schema) |
| [status](#status)         | Method | endpt (this schema) |

## call

`call`

- type: `Method`

### call Type

`object` with following properties:

| Property | Type   | Required     |
| -------- | ------ | ------------ |
| `input`  | oneOf  | **Required** |
| `output` | object | **Required** |

#### input

`input`

- is **required**
- type: complex

##### input Type

**One** of the following _conditions_ need to be fulfilled.

#### Condition 1

`object` with following properties:

| Property   | Type    | Required     |
| ---------- | ------- | ------------ |
| `add`      | integer | **Required** |
| `cid`      | string  | Optional     |
| `pcm_id`   | integer | **Required** |
| `terminal` | integer | **Required** |

#### add

`add`

- is **required**
- type: `integer`

##### add Type

`integer`

- minimum value: `0`
- maximum value: `5`

#### cid

`cid`

- is optional
- type: `string`

##### cid Type

`string`

- maximum length: 32 characters All instances must conform to this regular expression (test examples
  [here](https://regexr.com/?expression=%5E%5B0-9%5D*%23)):

```regex
^[0-9]*#
```

#### pcm_id

`pcm_id`

- is **required**
- type: `integer`

##### pcm_id Type

`integer`

- minimum value: `0`
- maximum value: `5`

#### terminal

`terminal`

- is **required**
- type: `integer`

##### terminal Type

`integer`

- minimum value: `1`
- maximum value: `6`

#### Condition 2

`object` with following properties:

| Property   | Type    | Required     |
| ---------- | ------- | ------------ |
| `cid`      | string  | Optional     |
| `pcm_id`   | integer | **Required** |
| `release`  | integer | **Required** |
| `terminal` | integer | **Required** |

#### cid

`cid`

- is optional
- type: `string`

##### cid Type

`string`

- maximum length: 32 characters All instances must conform to this regular expression (test examples
  [here](https://regexr.com/?expression=%5E%5B0-9%5D*%23)):

```regex
^[0-9]*#
```

#### pcm_id

`pcm_id`

- is **required**
- type: `integer`

##### pcm_id Type

`integer`

- minimum value: `0`
- maximum value: `5`

#### release

`release`

- is **required**
- type: `integer`

##### release Type

`integer`

- minimum value: `0`
- maximum value: `5`

#### terminal

`terminal`

- is **required**
- type: `integer`

##### terminal Type

`integer`

- minimum value: `1`
- maximum value: `6`

### Ubus CLI Example

```
ubus call endpt call {"terminal":6,"add":1,"pcm_id":0,"cid":"018#"}
```

### JSONRPC Example

```json
{
Loading
Loading full blame...