INBOUND_RULE

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

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']
number_mask

string

Mask number for inbound rule.
enabled

boolean

Enabled or not.
name

string

Inbound rule name.
id

integer

Inbound rule ID.

format : int64
office_hours

object

Show child attributes
- friday_from
  
  string
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- thursday_from
  
  string
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- wednesday_to
  
  string
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
- tuesday_to
  
  string
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- monday_to
  
  string
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- sunday_to
  
  string
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- saturday_to
  
  string
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- monday_from
  
  string
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- friday_to
  
  string
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- thursday_to
  
  string
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- sunday_from
  
  string
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- saturday_from
  
  string
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- office_hours_mode
  
  string
  
  enum : ['GLOBAL', 'CUSTOM']
- wednesday_from
  
  string
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- tuesday_from
  
  string
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
forward

object

Show child attributes
- office_hours
  
  object
  
  Show child attributes
  - type
    
    string
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    enum : ['END_CALL', 'CONNECT_TO_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_CALL_QUEUE']
  - external_number
    
    string
    
    Setup how calls should be directed during office hours for the inbound rule.
  - id
    
    integer
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    format : int64
- break_time
  
  object
  
  Show child attributes
  - type
    
    string
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    enum : ['END_CALL', 'CONNECT_TO_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_CALL_QUEUE']
  - external_number
    
    string
    
    Setup how calls should be directed during office hours for the inbound rule.
  - id
    
    integer
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    format : int64
providers

array

Show child attributes
- name
  
  string
  
  Provider's name.
- id
  
  integer
  
  Provider's ID.
  
  format : int64

Sample Response

{}

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

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

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']
number_mask

string

required

Mask number for inbound rule.
enabled

boolean

required

Enabled or not.
forward

object

required

Show child attributes
- office_hours
  
  object
  
  required
  
  Show child attributes
  - type
    
    string
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    enum : ['END_CALL', 'CONNECT_TO_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_CALL_QUEUE']
  - external_number
    
    string
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
  - id
    
    integer
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    format : int64
- break_time
  
  object
  
  required
  
  Show child attributes
  - type
    
    string
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    enum : ['END_CALL', 'CONNECT_TO_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_CALL_QUEUE']
  - external_number
    
    string
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
  - id
    
    integer
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    format : int64
providers

array

required
office_hours

object

required

Show child attributes
- friday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- thursday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- wednesday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
- tuesday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- monday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- sunday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- saturday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- monday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- friday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- thursday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- sunday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- saturday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- office_hours_mode
  
  string
  
  required
  
  enum : ['GLOBAL', 'CUSTOM']
- wednesday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- tuesday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
id

integer

required

Inbound rule ID.

format : int64

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

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

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']
number_mask

string

required

Mask number for inbound rule.
forward

object

required

Show child attributes
- office_hours
  
  object
  
  required
  
  Show child attributes
  - type
    
    string
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    enum : ['END_CALL', 'CONNECT_TO_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_CALL_QUEUE']
  - external_number
    
    string
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
  - id
    
    integer
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    format : int64
- break_time
  
  object
  
  required
  
  Show child attributes
  - type
    
    string
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    enum : ['END_CALL', 'CONNECT_TO_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_CALL_QUEUE']
  - external_number
    
    string
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
  - id
    
    integer
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    format : int64
enabled

boolean

required

Enabled or not.
office_hours

object

required

Show child attributes
- friday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- thursday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- wednesday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
- tuesday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- monday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- sunday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- saturday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- monday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- friday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- thursday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- sunday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- saturday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- office_hours_mode
  
  string
  
  required
  
  enum : ['GLOBAL', 'CUSTOM']
- wednesday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- tuesday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
name

string

required

Inbound rule name.
providers

array

required

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

{}

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

pagesize

integer
count

integer
pagination

integer
rules

array

Show child attributes
- 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']
- number_mask
  
  string
  
  Mask number for inbound rule.
- enabled
  
  boolean
  
  Enabled or not.
- id
  
  integer
  
  Inbound rule ID.
  
  format : int64
- name
  
  string
  
  Inbound rule name.
- providers
  
  array
  
  Show child attributes
  - name
    
    string
    
    Provider's name.
  - id
    
    integer
    
    Provider's ID.
    
    format : int64
sort_by

string

Sample Response

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

Sample Request

200

application/json

type

number_mask

enabled

name

id

office_hours

friday_from

thursday_from

wednesday_to

tuesday_to

monday_to

sunday_to

saturday_to

monday_from

friday_to

thursday_to

sunday_from

saturday_from

office_hours_mode

wednesday_from

tuesday_from

forward

office_hours

type

external_number

id

break_time

type

external_number

id

providers

name

id

Sample Response

Sample Request

200

400

Sample Response

Sample Request

200

Sample Response

Sample Request

200

application/json

id

Sample Response

Sample Request

200

application/json

pagesize

count

pagination

rules

type

number_mask

enabled

`200`

`type`

`number_mask`

`enabled`

`name`

`id`

`office_hours`

`friday_from`

`thursday_from`

`wednesday_to`

`tuesday_to`

`monday_to`

`sunday_to`

`saturday_to`

`monday_from`

`friday_to`

`thursday_to`

`sunday_from`

`saturday_from`

`office_hours_mode`

`wednesday_from`

`tuesday_from`

`forward`

`office_hours`

`type`

`external_number`

`id`

`break_time`

`type`

`external_number`

`id`

`providers`

`name`

`id`

`200`

`400`

`200`

`200`

`id`

`200`

`pagesize`

`count`

`pagination`

`rules`

`type`

`number_mask`

`enabled`