INBOUND_RULE

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

string

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

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

string

required

id of rule.

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

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']
  - id
    
    string
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    format : int64
  - external_number
    
    string
    
    Setup how calls should be directed during office hours for the inbound rule.
- 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']
  - id
    
    string
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    format : int64
  - external_number
    
    string
    
    Setup how calls should be directed during office hours for the inbound rule.
did_number_mask

string

DID Mask number for inbound rule.
id

string

Inbound rule ID.

format : int64
provider_id

string

id of the provider.

format : int64
enabled

boolean

Enabled or not.
name

string

Inbound rule name.
cid_number_mask

string

CID Mask number for inbound rule.
office_hours

object

Show child attributes
- thursday_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
- saturday_to
  
  string
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17: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
- monday_from
  
  string
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09: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_from
  
  string
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- friday_from
  
  string
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- wednesday_to
  
  string
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
- thursday_to
  
  string
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- office_hours_mode
  
  string
  
  enum : ['GLOBAL', 'CUSTOM']
- sunday_to
  
  string
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17: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
- wednesday_from
  
  string
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- tuesday_to
  
  string
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64

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

string

required

id of extension.

format : int64

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
sort_by

string
rules

array

Show child attributes
- provider_id
  
  string
  
  id of the provider.
  
  format : int64
- enabled
  
  boolean
  
  Enabled or not.
- did_number_mask
  
  string
  
  DID Mask number for inbound rule.
- name
  
  string
  
  Inbound rule name.
- id
  
  string
  
  Inbound rule ID.
  
  format : int64
- cid_number_mask
  
  string
  
  CID Mask number for inbound rule.
pagination

integer
count

integer

Sample Response

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

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

provider_id

string

required

id of the provider.

format : int64
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']
  - id
    
    string
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    format : int64
  - external_number
    
    string
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
- 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']
  - id
    
    string
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    format : int64
  - external_number
    
    string
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
enabled

boolean

required

Enabled or not.
did_number_mask

string

required

DID Mask number for inbound rule.
name

string

required

Inbound rule name.
cid_number_mask

string

required

CID Mask number for inbound rule.
office_hours

object

required

Show child attributes
- thursday_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
- saturday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17: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
- monday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09: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_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- friday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- wednesday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
- thursday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- office_hours_mode
  
  string
  
  required
  
  enum : ['GLOBAL', 'CUSTOM']
- sunday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17: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
- wednesday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- tuesday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64

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

string

Inbound rule ID.

format : int64

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

provider_id

string

required

id of the provider.

format : int64
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']
  - id
    
    string
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    format : int64
  - external_number
    
    string
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
- 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']
  - id
    
    string
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
    
    format : int64
  - external_number
    
    string
    
    required
    
    Setup how calls should be directed during office hours for the inbound rule.
enabled

boolean

required

Enabled or not.
did_number_mask

string

required

DID Mask number for inbound rule.
id

string

required

Inbound rule ID.

format : int64
cid_number_mask

string

required

CID Mask number for inbound rule.
office_hours

object

required

Show child attributes
- thursday_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
- saturday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17: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
- monday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09: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_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- friday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- wednesday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
- thursday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64
- office_hours_mode
  
  string
  
  required
  
  enum : ['GLOBAL', 'CUSTOM']
- sunday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17: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
- wednesday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
  
  minLength: 6
  
  maxLength: 64
- tuesday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
  
  minLength: 6
  
  maxLength: 64

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 Request

200

400

Sample Response

Sample Request

200

application/json

forward

office_hours

type

id

external_number

break_time

type

id

external_number

did_number_mask

id

provider_id

enabled

name

cid_number_mask

office_hours

thursday_from

tuesday_from

saturday_to

saturday_from

monday_from

monday_to

sunday_from

friday_from

wednesday_to

thursday_to

office_hours_mode

sunday_to

friday_to

wednesday_from

tuesday_to

Sample Response

Sample Request

200

application/json

pagesize

sort_by

rules

provider_id

enabled

did_number_mask

name

id

cid_number_mask

pagination

count

Sample Response

Sample Request

200

application/json

id

Sample Response

`200`

`400`

`200`

`forward`

`office_hours`

`type`

`id`

`external_number`

`break_time`

`type`

`id`

`external_number`

`did_number_mask`

`id`

`provider_id`

`enabled`

`name`

`cid_number_mask`

`office_hours`

`thursday_from`

`tuesday_from`

`saturday_to`

`saturday_from`

`monday_from`

`monday_to`

`sunday_from`

`friday_from`

`wednesday_to`

`thursday_to`

`office_hours_mode`

`sunday_to`

`friday_to`

`wednesday_from`

`tuesday_to`

`200`

`pagesize`

`sort_by`

`rules`

`provider_id`

`enabled`

`did_number_mask`

`name`

`id`

`cid_number_mask`

`pagination`

`count`

`200`

`id`