Skip to content
Snippets Groups Projects
Normal view Permalink
endpt.md 20.3 KiB
Newer Older
  • Learn to ignore specific revisions
    • Yalu Zhang's avatar
    Initial import from endptmngr
    Yalu Zhang committed
    1 2 3 
    # endpt Schema

```
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    4 
    https://www.iopsys.eu/endpt.json
    Yalu Zhang's avatar
    Initial import from endptmngr
    Yalu Zhang committed
    5 6 7 8 9 10 11 12 13 14 15 
    ```

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

# endpt

| List of Methods           |
| ------------------------- |
| [call](#call)             | Method | endpt (this schema) |
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    16 
    | [codecs](#codecs)         | Method | endpt (this schema) |
    Yalu Zhang's avatar
    Initial import from endptmngr
    Yalu Zhang committed
    17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 
    | [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     |
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    57 
    | `pcm_id`   | integer | **Required** |
    Yalu Zhang's avatar
    Initial import from endptmngr
    Yalu Zhang committed
    58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 
    | `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]*#
```
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    92 93 94 95 96 97 98 99 100 101 102 103 104 105 
    #### pcm_id

`pcm_id`

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

##### pcm_id Type

`integer`

- minimum value: `0`
- maximum value: `5`
    Yalu Zhang's avatar
    Initial import from endptmngr
    Yalu Zhang committed
    106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 
    #### 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     |
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    127 
    | `pcm_id`   | integer | **Required** |
    Yalu Zhang's avatar
    Initial import from endptmngr
    Yalu Zhang committed
    128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 
    | `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]*#
```
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    149 150 151 152 153 154 155 156 157 158 159 160 161 162 
    #### pcm_id

`pcm_id`

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

##### pcm_id Type

`integer`

- minimum value: `0`
- maximum value: `5`
    Yalu Zhang's avatar
    Initial import from endptmngr
    Yalu Zhang committed
    163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 
    #### 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

```
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    194 
    ubus call endpt call {"terminal":6,"add":1,"pcm_id":0,"cid":"018#"}
    Yalu Zhang's avatar
    Initial import from endptmngr
    Yalu Zhang committed
    195 196 197 198 199 200 201 202 203 
    ```

### JSONRPC Example

```json
{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "call",
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    204 
      "params": ["<SID>", "endpt", "call", { "terminal": 6, "add": 1, "pcm_id": 0, "cid": "018#" }]
    Yalu Zhang's avatar
    Initial import from endptmngr
    Yalu Zhang committed
    205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 
    }
```

#### output

`output`

- is **required**
- type: `object`

##### output Type

`object` with following properties:

| Property   | Type    | Required     |
| ---------- | ------- | ------------ |
| `errno`    | integer | **Required** |
| `pcm`      | integer | **Required** |
| `terminal` | integer | **Required** |

#### errno

`errno`

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

##### errno Type

`integer`

#### pcm

`pcm`

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

##### pcm Type

`integer`

#### terminal

`terminal`

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

##### terminal Type

`integer`

### Output Example

```json
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 
    { "terminal": 73262276, "pcm": -31145049, "errno": -61339135 }
```

## codecs

`codecs`

- type: `Method`

### codecs Type

`object` with following properties:

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

#### input

`input`

- is optional
- type: `object`

##### input Type

`object` with following properties:

| Property | Type | Required |
| -------- | ---- | -------- |
| None     | None | None     |

### Ubus CLI Example

```
ubus call endpt codecs {}
```

### JSONRPC Example

```json
{ "jsonrpc": "2.0", "id": 0, "method": "call", "params": ["<SID>", "endpt", "codecs", {}] }
```

#### output

`output`

- is **Required**
- type: `object`

##### output Type

`object` with following properties:

| Property    | Type   | Required     |
| ----------- | ------ | ------------ |
| `codec_key` | object | **Required** |

#### codec_key

`codec_key`

- is **Required**
- type: `object`

##### codec_key Type

`object` with following properties:

| Property          | Type    | Required     |
| ----------------- | ------- | ------------ |
| `bitrate`         | number  | **Required** |
| `name`            | string  | **Required** |
| `ptime_default`   | integer | **Required** |
| `ptime_increment` | integer | **Required** |
| `ptime_max`       | integer | **Required** |
| `ptime_min`       | integer | **Required** |
    Lukasz Kotasa's avatar
    Add rtp_payload for G726 in `ubus call endpt codecs`  
    Lukasz Kotasa committed
    340 
    | `rtp_payload`     | integer | **Optional** |
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 
    
#### bitrate

`bitrate`

- is **required**
- type: `number`

##### bitrate Type

`number`

- minimum value: `0`
- maximum value: `100`

#### name

`name`

- is **required**
- type: `enum`

##### name Type

`string`

The value of this property **must** be equal to one of the [known values below](#codecs-known-values).

##### name Known Values

| Value      |
| ---------- |
| G.711MuLaw |
| G.711ALaw  |
| G.729a     |
| G.723.1    |
| G.726      |
| G.728      |
| G.729      |
| G.729e     |
| GSM-FR     |
| GSM-EFR    |
| GSM-HR     |
    Yalu Zhang's avatar
    Module documentation: Replace GSM-AMR with AMR  
    Yalu Zhang committed
    384 
    | AMR        |
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 
    | iLBC       |

#### ptime_default

`ptime_default`

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

##### ptime_default Type

`integer`

- minimum value: `0`
- maximum value: `50`

#### ptime_increment

`ptime_increment`

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

##### ptime_increment Type

`integer`

- minimum value: `0`
- maximum value: `50`

#### ptime_max

`ptime_max`

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

##### ptime_max Type

`integer`

- minimum value: `0`
- maximum value: `300`

#### ptime_min

`ptime_min`

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

##### ptime_min Type

`integer`

- minimum value: `0`
- maximum value: `50`
    Lukasz Kotasa's avatar
    Add rtp_payload for G726 in `ubus call endpt codecs`  
    Lukasz Kotasa committed
    443 444 445 446 447 448 449 450 451 452 453 454 455 456 
    #### rtp_payload

`rtp_payload`

- is **optional**
- type: `integer`

##### rtp_payload Type

`integer`

- minimum value: `0`
- maximum value: `127`
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    457 458 459 460 461 462 463 464 465 466 
    ### Output Example

```json
{
  "codec_key": {
    "name": "G.729e",
    "ptime_min": 44,
    "ptime_max": 36,
    "ptime_default": 12,
    "ptime_increment": 38,
    Lukasz Kotasa's avatar
    Add rtp_payload for G726 in `ubus call endpt codecs`  
    Lukasz Kotasa committed
    467 468 
        "bitrate": 12.60194806517081,
    "rtp_payload": 80
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    469 470 
      }
}
    Yalu Zhang's avatar
    Initial import from endptmngr
    Yalu Zhang committed
    471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 
    ```

## connection

`connection`

- type: `Method`

### connection Type

`object` with following properties:

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

#### input

`input`

- is **required**
- type: `object`

##### input Type

`object` with following properties:

| Property | Type    | Required     |
| -------- | ------- | ------------ |
| `action` | string  | **Required** |
| `id`     | integer | **Required** |
| `line`   | integer | **Required** |

#### action

`action`

- is **required**
- type: `enum`

##### action Type

`string`

The value of this property **must** be equal to one of the [known values below](#connection-known-values).

##### action Known Values

| Value            |
| ---------------- |
| create           |
| destroy          |
| start_conference |
| stop_conference  |

#### id

`id`

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

##### id Type

`integer`

- minimum value: `0`

#### line

`line`

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

##### line Type

`integer`

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

### Ubus CLI Example

```
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    557 
    ubus call endpt connection {"line":3,"id":4989534,"action":"start_conference"}
    Yalu Zhang's avatar
    Initial import from endptmngr
    Yalu Zhang committed
    558 559 560 561 562 563 564 565 566 
    ```

### JSONRPC Example

```json
{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "call",
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    567 
      "params": ["<SID>", "endpt", "connection", { "line": 3, "id": 4989534, "action": "start_conference" }]
    Yalu Zhang's avatar
    Initial import from endptmngr
    Yalu Zhang committed
    568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 
    }
```

#### output

`output`

- is optional
- type: `object`

##### output Type

`object` with following properties:

| Property | Type | Required |
| -------- | ---- | -------- |
| None     | None | None     |

### Output Example

```json
{}
```

## count

`count`

- type: `Method`

### count Type

`object` with following properties:

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

#### input

`input`

- is **required**
- type: `object`

##### input Type

`object` with following properties:

| Property    | Type    | Required     |
| ----------- | ------- | ------------ |
| `effective` | boolean | **Required** |

#### effective

`effective`

- is **required**
- type: `boolean`

##### effective Type

`boolean`

### Ubus CLI Example

```
ubus call endpt count {"effective":true}
```

### JSONRPC Example

```json
{ "jsonrpc": "2.0", "id": 0, "method": "call", "params": ["<SID>", "endpt", "count", { "effective": true }] }
```

#### output

`output`

- is **required**
- type: `object`

##### output Type

`object` with following properties:

| Property             | Type    | Required     |
| -------------------- | ------- | ------------ |
| `num_dect_endpoints` | integer | **Required** |
| `num_endpoints`      | integer | **Required** |
| `num_fxo_endpoints`  | integer | **Required** |
| `num_fxs_endpoints`  | integer | **Required** |

#### num_dect_endpoints

`num_dect_endpoints`

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

##### num_dect_endpoints Type

`integer`

- minimum value: `0`

#### num_endpoints

`num_endpoints`

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

##### num_endpoints Type

`integer`

- minimum value: `0`

#### num_fxo_endpoints

`num_fxo_endpoints`

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

##### num_fxo_endpoints Type

`integer`

- minimum value: `0`

#### num_fxs_endpoints

`num_fxs_endpoints`

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

##### num_fxs_endpoints Type

`integer`

- minimum value: `0`

### Output Example

```json
{
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    719 720 721 722 
      "num_endpoints": 28959373,
  "num_fxo_endpoints": 16921710,
  "num_fxs_endpoints": 5497405,
  "num_dect_endpoints": 2393708
    Yalu Zhang's avatar
    Initial import from endptmngr
    Yalu Zhang committed
    723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 
    }
```

## rtp_stats

`rtp_stats`

- type: `Method`

### rtp_stats Type

`object` with following properties:

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

#### input

`input`

- is **required**
- type: `object`

##### input Type

`object` with following properties:

| Property | Type    | Required     |
| -------- | ------- | ------------ |
| `line`   | integer | **Required** |
| `reset`  | boolean | **Required** |

#### line

`line`

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

##### line Type

`integer`

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

#### reset

`reset`

- is **required**
- type: `boolean`

##### reset Type

`boolean`

### Ubus CLI Example

```
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    785 
    ubus call endpt rtp_stats {"line":0,"reset":true}
    Yalu Zhang's avatar
    Initial import from endptmngr
    Yalu Zhang committed
    786 787 788 789 790 791 792 793 794 
    ```

### JSONRPC Example

```json
{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "call",
    Grzegorz Sluja's avatar
    Update voicemngr with recent changes of endptmngr  
    Grzegorz Sluja committed
    795 
      "params": ["<SID>", "endpt", "rtp_stats", { "line": 0, "reset": true }]
    Yalu Zhang's avatar
    Initial import from endptmngr
    Yalu Zhang committed
    796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 
    }
```

#### output

`output`

- is **required**
- type: `object`

##### output Type

`object` with following properties:

| Property                | Type    | Required     |
| ----------------------- | ------- | ------------ |
| `discarded`             | integer | **Required** |
| `jbAvg`                 | integer | **Required** |
| `jitter`                | integer | **Required** |
| `lineId`                | integer | **Required** |
| `localBurstDensity`     | integer | **Required** |
| `localBurstDuration`    | integer | **Required** |
| `localGapDensity`       | integer | **Required** |
| `localGapDuration`      | integer | **Required** |
| `localJbAbsMax`         | integer | **Required** |
| `localJbMax`            | integer | **Required** |
| `localJbNominal`        | integer | **Required** |
| `localJbRate`           | integer | **Required** |
| `lost`                  | integer | **Required** |
| `maxJitter`             | integer | **Required** |
| `remoteBurstDensity`    | integer | **Required** |
| `remoteBurstDuration`   | integer | **Required** |
| `remoteGapDensity`      | integer | **Required** |
| `remoteGapDuration`     | integer | **Required** |
| `remoteJbAbsMax`        | integer | **Required** |
| `remoteJbMax`           | integer | **Required** |
| `remoteJbNominal`       | integer | **Required** |
| `remoteJbRate`          | integer | **Required** |
| `rxpkts`                | integer | **Required** |
| `txpkts`                | integer | **Required** |
| `uLossRate`             | integer | **Required** |

#### discarded

`discarded`

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

##### discarded Type

`integer`

- minimum value: `0`

#### jbAvg

`jbAvg`

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

##### jbAvg Type

`integer`

- minimum value: `0`

#### jitter

`jitter`

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

##### jitter Type

`integer`

- minimum value: `0`

#### lineId

`lineId`

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

##### lineId Type

`integer`

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

#### localBurstDensity

`localBurstDensity`

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

##### localBurstDensity Type

`integer`

- minimum value: `0`

#### localBurstDuration

`localBurstDuration`

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

##### localBurstDuration Type

`integer`

- minimum value: `0`

#### localGapDensity

`localGapDensity`

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

##### localGapDensity Type

`integer`

- minimum value: `0`

#### localGapDuration

`localGapDuration`

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

##### localGapDuration Type

`integer`

- minimum value: `0`

#### localJbAbsMax

`localJbAbsMax`

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

##### localJbAbsMax Type

`integer`

- minimum value: `0`

#### localJbMax

`localJbMax`

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

##### localJbMax Type

`integer`

- minimum value: `0`

#### localJbNominal

`localJbNominal`

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

##### localJbNominal Type

`integer`

- minimum value: `0`

#### localJbRate

`localJbRate`

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

##### localJbRate Type

`integer`

- minimum value: `0`

#### lost

`lost`

- is **required**
- type: `integer`
    Show full blame