Update inbound rule

POST /update
Update inbound rule
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • number_mask

    string

    required

    Mask number for inbound rule.
  • office_hours

    object

    required

    Show child attributes
  • id

    integer

    required

    Inbound rule ID.

    format : int64

  • forward

    object

    required

    Show child attributes
  • type

    string

    required

    If it is set to DID, inbound rule will be configured based on the callee ID. If it is set to CID, inbound rule will be configured based on the caller ID.

    enum : ['DID', 'CID']

  • providers

    array

    required

  • enabled

    boolean

    required

    Enabled or not.

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/inbound_rules/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'
                      
                    

Responses

200
Successful operation

Sample Response

                      
                      
                    

Retrieve inbound rule

GET /show
Retrieve inbound rule
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • id

    integer

    required

    The tenant id of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only.

    format : int64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/inbound_rules/show \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                      
                    

Responses

200
Successful operation
application/json
  • number_mask

    string

    Mask number for inbound rule.
  • id

    integer

    Inbound rule ID.

    format : int64

  • forward

    object

    Show child attributes
  • providers

    array

    Show child attributes
  • office_hours

    object

    Show child attributes
  • name

    string

    Inbound rule name.
  • type

    string

    If it is set to DID, inbound rule will be configured based on the callee ID. If it is set to CID, inbound rule will be configured based on the caller ID.

    enum : ['DID', 'CID']

  • enabled

    boolean

    Enabled or not.

Sample Response

                      
{}
                      
                    

Retrieve a collection of inbound rules

GET /list
Retrieve a collection of inbound rules
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • pagination

    integer

    required

    The pagination of paging.

    format : int32

  • pagesize

    integer

    required

    The size of paging.
  • sort_by

    string

    optional

    Values include "DEFAULT" and "Optional". Default value will be used when user does not specify value for this field.

    enum : ['DEFAULT', 'OPTIONAL']

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/inbound_rules/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                      
                    

Responses

200
Successful operation
application/json
  • sort_by

    string

  • pagesize

    integer

  • pagination

    integer

  • rules

    array

    Show child attributes
  • count

    integer

Sample Response

                      
{
    "sort_by": "DEFAULT",
    "pagesize": 10,
    "pagination": 8,
    "count": 100
}
                      
                    

Destroy inbound rule

POST /destroy
Destroy inbound rule
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • id

    integer

    required

    Inbound rule ID.

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/inbound_rules/destroy \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'
                      
                    

Responses

200
Successful operation
400
Invalid inbound rule ID supplied

Sample Response

                      
                      
                    

Create inbound rule

POST /create
Add a new inbound rule. Please make sure you have at least one provider created before creating a new inbound rule.
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • number_mask

    string

    required

    Mask number for inbound rule.
  • office_hours

    object

    required

    Show child attributes
  • forward

    object

    required

    Show child attributes
  • type

    string

    required

    If it is set to DID, inbound rule will be configured based on the callee ID. If it is set to CID, inbound rule will be configured based on the caller ID.

    enum : ['DID', 'CID']

  • enabled

    boolean

    required

    Enabled or not.
  • providers

    array

    required

  • name

    string

    required

    Inbound rule name.

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/inbound_rules/create \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'
                      
                    

Responses

200
Created inbound rule
application/json
  • id

    integer

    Inbound rule ID.

    format : int64

Sample Response

                      
{}