Skip to content
Snippets Groups Projects
endpt.md 20.3 KiB
Newer Older
  • Learn to ignore specific revisions
  • 
    ##### lost Type
    
    `integer`
    
    - minimum value: `0`
    
    #### maxJitter
    
    `maxJitter`
    
    - is **required**
    - type: `integer`
    
    ##### maxJitter Type
    
    `integer`
    
    - minimum value: `0`
    
    #### remoteBurstDensity
    
    `remoteBurstDensity`
    
    - is **required**
    - type: `integer`
    
    ##### remoteBurstDensity Type
    
    `integer`
    
    - minimum value: `0`
    
    #### remoteBurstDuration
    
    `remoteBurstDuration`
    
    - is **required**
    - type: `integer`
    
    ##### remoteBurstDuration Type
    
    `integer`
    
    - minimum value: `0`
    
    #### remoteGapDensity
    
    `remoteGapDensity`
    
    - is **required**
    - type: `integer`
    
    ##### remoteGapDensity Type
    
    `integer`
    
    - minimum value: `0`
    
    #### remoteGapDuration
    
    `remoteGapDuration`
    
    - is **required**
    - type: `integer`
    
    ##### remoteGapDuration Type
    
    `integer`
    
    - minimum value: `0`
    
    #### remoteJbAbsMax
    
    `remoteJbAbsMax`
    
    - is **required**
    - type: `integer`
    
    ##### remoteJbAbsMax Type
    
    `integer`
    
    - minimum value: `0`
    
    #### remoteJbMax
    
    `remoteJbMax`
    
    - is **required**
    - type: `integer`
    
    ##### remoteJbMax Type
    
    `integer`
    
    - minimum value: `0`
    
    #### remoteJbNominal
    
    `remoteJbNominal`
    
    - is **required**
    - type: `integer`
    
    ##### remoteJbNominal Type
    
    `integer`
    
    - minimum value: `0`
    
    #### remoteJbRate
    
    `remoteJbRate`
    
    - is **required**
    - type: `integer`
    
    ##### remoteJbRate Type
    
    `integer`
    
    - minimum value: `0`
    
    #### rxpkts
    
    `rxpkts`
    
    - is **required**
    - type: `integer`
    
    ##### rxpkts Type
    
    `integer`
    
    - minimum value: `0`
    
    #### txpkts
    
    `txpkts`
    
    - is **required**
    - type: `integer`
    
    ##### txpkts Type
    
    `integer`
    
    - minimum value: `0`
    
    #### uLossRate
    
    `uLossRate`
    
    - is **required**
    - type: `integer`
    
    ##### uLossRate Type
    
    `integer`
    
    - minimum value: `0`
    
    ### Output Example
    
    ```json
    {
    
      "lineId": 3,
      "localBurstDensity": 72187314,
      "remoteBurstDensity": 57272242,
      "localBurstDuration": 550512,
      "remoteBurstDuration": 9577445,
      "localGapDensity": 31746248,
      "remoteGapDensity": 5373655,
      "localGapDuration": 93046060,
      "remoteGapDuration": 6028757,
      "localJbRate": 48187376,
      "remoteJbRate": 42684338,
      "localJbMax": 4617104,
      "remoteJbMax": 68868842,
      "localJbNominal": 97005535,
      "remoteJbNominal": 37554392,
      "localJbAbsMax": 15660701,
      "remoteJbAbsMax": 15370482,
      "discarded": 38026287,
      "lost": 73256347,
      "rxpkts": 77415865,
      "txpkts": 30316611,
      "jbAvg": 16648797,
      "jitter": 12286104,
      "uLossRate": 44899753,
      "maxJitter": 68636630,
    
    }
    ```
    
    ## signal
    
    `signal`
    
    - type: `Method`
    
    ### signal 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     |
    | -------- | ------- | ------------ |
    | `data`   | string  | Optional     |
    | `line`   | integer | **Required** |
    | `signal` | string  | **Required** |
    | `state`  | string  | **Required** |
    
    #### data
    
    `data`
    
    - is optional
    - type: `string`
    
    ##### data Type
    
    `string`
    
    #### line
    
    `line`
    
    - is **required**
    - type: `integer`
    
    ##### line Type
    
    `integer`
    
    - minimum value: `0`
    - maximum value: `5`
    
    #### signal
    
    `signal`
    
    - is **required**
    - type: `enum`
    
    ##### signal Type
    
    `string`
    
    The value of this property **must** be equal to one of the [known values below](#signal-known-values).
    
    ##### signal Known Values
    
    | Value          |
    | -------------- |
    | dial           |
    | ringback       |
    | stutter        |
    | unobtainable   |
    | callwt         |
    | busy           |
    | ringing        |
    | callid_ringing |
    | callid         |
    | congestion     |
    | dial2          |
    | dtmf0          |
    | dtmf1          |
    | dtmf2          |
    | dtmf3          |
    | dtmf4          |
    | dtmf5          |
    | dtmf6          |
    | dtmf7          |
    | dtmf8          |
    | dtmf9          |
    | dtmf\*         |
    | dtmf#          |
    
    #### state
    
    `state`
    
    - is **required**
    - type: `enum`
    
    ##### state Type
    
    `string`
    
    The value of this property **must** be equal to one of the [known values below](#signal-known-values).
    
    ##### state Known Values
    
    | Value |
    | ----- |
    | on    |
    | off   |
    
    ### Ubus CLI Example
    
    ```
    
    ubus call endpt signal {"line":0,"signal":"busy","state":"on","data":"dolor"}
    
    ```
    
    ### JSONRPC Example
    
    ```json
    {
      "jsonrpc": "2.0",
      "id": 0,
      "method": "call",
    
      "params": ["<SID>", "endpt", "signal", { "line": 0, "signal": "busy", "state": "on", "data": "dolor" }]
    
    }
    ```
    
    #### output
    
    `output`
    
    - is optional
    - type: `object`
    
    ##### output Type
    
    `object` with following properties:
    
    | Property | Type | Required |
    | -------- | ---- | -------- |
    | None     | None | None     |
    
    ### Output Example
    
    ```json
    {}
    ```
    
    ## status
    
    `status`
    
    - type: `Method`
    
    ### status 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** |
    
    #### line
    
    `line`
    
    - is **required**
    - type: `integer`
    
    ##### line Type
    
    `integer`
    
    - minimum value: `0`
    - maximum value: `5`
    
    ### Ubus CLI Example
    
    ```
    
    ubus call endpt status {"line":1}
    
    ```
    
    ### JSONRPC Example
    
    ```json
    
    { "jsonrpc": "2.0", "id": 0, "method": "call", "params": ["<SID>", "endpt", "status", { "line": 1 }] }
    
    ```
    
    #### output
    
    `output`
    
    - is **required**
    - type: `object`
    
    ##### output Type
    
    `object` with following properties:
    
    | Property  | Type    | Required     |
    | --------- | ------- | ------------ |
    | `line`    | integer | **Required** |
    | `offhook` | integer | **Required** |
    
    #### line
    
    `line`
    
    - is **required**
    - type: `integer`
    
    ##### line Type
    
    `integer`
    
    - minimum value: `0`
    - maximum value: `5`
    
    #### offhook
    
    `offhook`
    
    - is **required**
    - type: `enum`
    
    ##### offhook Type
    
    `integer`
    
    The value of this property **must** be equal to one of the [known values below](#status-known-values).
    
    ##### offhook Known Values
    
    | Value |
    | ----- |
    | 0     |
    | 1     |
    
    ### Output Example
    
    ```json
    
    { "line": 3, "offhook": 1 }