OUTBOUND

Retrieve outbound rule

GET /show

Retrieve outbound rule

Path parameters

access_token

string

required

token to be passed as a header.

minLength: 64

maxLength: 64
id

integer

required

Outbound rule's ID.

format : int64

Sample Request

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

Responses

`200`

Successful operation

application/json

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
from_extension_groups

array

Extensions number of the specific groups will be applied this rule.

Show child attributes
- group_name
  
  string
  
  Extension group's name.
- id
  
  string
  
  Extension group's ID.
number_prefix

string

Prefix of callee ID. Calls started with this prefix will be applied this outbound rule.
enabled

boolean
number_length

integer

NOTE: It contains the length of number prefix. For example by inputting 15, calls with a caller ID of 15 digits will be applied this rule.
id

integer

Outbound rule's ID.

format : int64
name

string

Outbound rule's name.
routes

array

Show child attributes
- id
  
  integer
  
  provider id
  
  format : int64
- blocked
  
  boolean
  
  Block this route or not.
- provider
  
  string
  
  Once the rule is triggered, PBX will start external calling on the base of configured provider specified by route_provider_1.
- strip_digits
  
  integer
  
  Digits for striping number. Values: 0-9. For example if it is set to 2, the first two digits for caller ID of calling from route_provider_1 will be removed.
- prepend
  
  string
  
  Prefix number. If it is set to "0086", call ID for calling from route_provider_1 will be prefixed with "0086".
from_extension

string

Extension who starts the call. A comma-separated list of extensions allowed. For example by specifying "101-110, 199", extensions from 101 to 110 and 199 will be applied this rule.

Sample Response

{}

Destroy outbound rule

POST /destroy

Destroy media server

Path parameters

access_token

string

required

token to be passed as a header.

minLength: 64

maxLength: 64

Request body

application/json

id

integer

required

Outbound rule's ID.

format : int64

Sample Request

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

Responses

`200`

Successful operation.

`400`

Invalid username supplied.

Sample Response

Update outbound rule

POST /update

Update outbound rule

Path parameters

access_token

string

required

token to be passed as a header.

minLength: 64

maxLength: 64

Request body

application/json

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
from_extension_groups

array

required

Extensions number of the specific groups will be applied this rule.
number_prefix

string

required

Prefix of callee ID. Calls started with this prefix will be applied this outbound rule.
enabled

boolean

required
from_extension

string

required

Extension who starts the call. A comma-separated list of extensions allowed. For example by specifying "101-110, 199", extensions from 101 to 110 and 199 will be applied this rule.
id

integer

required

Outbound rule's ID.

format : int64
name

string

required

Outbound rule's name.
routes

array

required
number_length

integer

required

NOTE: It contains the length of number prefix. For example by inputting 15, calls with a caller ID of 15 digits will be applied this rule.

Sample Request

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

Responses

`200`

Successful operation

Sample Response

Create outbound rule

POST /create

Add a new outbound rule. Please make sure you have at least one provider created before creating a new outbound rule.

Path parameters

access_token

string

required

token to be passed as a header.

minLength: 64

maxLength: 64

Request body

application/json

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
from_extension_groups

array

required

Extensions number of the specific groups will be applied this rule.
number_prefix

string

required

Prefix of callee ID. Calls started with this prefix will be applied this outbound rule.
enabled

boolean

required
from_extension

string

required

Extension who starts the call. A comma-separated list of extensions allowed. For example by specifying "101-110, 199", extensions from 101 to 110 and 199 will be applied this rule.
name

string

required

Outbound rule's name.
routes

array

required
number_length

integer

required

NOTE: It contains the length of number prefix. For example by inputting 15, calls with a caller ID of 15 digits will be applied this rule.

Sample Request

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

Responses

`200`

Created outbound rule

application/json

id

integer

Outbound rule's ID.

format : int64

Sample Response

{}

Retrieve a collection of outbound rules.

GET /list

Retrieve a collection of outbound 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/outbound_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
- number_mask
  
  string
  
  Extension who starts the call. A comma-separated list of extensions allowed. For example by specifying "101-110, 199", extensions from 101 to 110 and 199 will be applied this rule.
- from_extension_groups
  
  array
  
  Extensions number of the specific groups will be applied this rule.
  
  Show child attributes
  - group_name
    
    string
    
    Extension group's name.
  - id
    
    string
    
    Extension group's ID.
- number_prefix
  
  string
  
  Prefix of callee ID. Calls started with this prefix will be applied this outbound rule.
- number_length
  
  integer
  
  NOTE: It contains the length of number prefix. For example by inputting 15, calls with a caller ID of 15 digits will be applied this rule.
- name
  
  string
  
  Outbound rule's name.
- routes
  
  array
  
  Show child attributes
  - id
    
    integer
    
    provider id
    
    format : int64
  - blocked
    
    boolean
    
    Block this route or not.
  - provider
    
    string
    
    Once the rule is triggered, PBX will start external calling on the base of configured provider specified by route_provider_1.
  - strip_digits
    
    integer
    
    Digits for striping number. Values: 0-9. For example if it is set to 2, the first two digits for caller ID of calling from route_provider_1 will be removed.
  - prepend
    
    string
    
    Prefix number. If it is set to "0086", call ID for calling from route_provider_1 will be prefixed with "0086".
- id
  
  integer
  
  Outbound rule's ID.
  
  format : int64
sort_by

string

Sample Response

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

Sample Request

200

application/json

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

from_extension_groups

group_name

id

number_prefix

enabled

number_length

id

name

routes

id

blocked

provider

strip_digits

prepend

from_extension

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

number_mask

from_extension_groups

group_name

id

number_prefix

number_length

name

routes

id

blocked

provider

strip_digits

prepend

id

sort_by

Sample Response

`200`

`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`

`from_extension_groups`

`group_name`

`id`

`number_prefix`

`enabled`

`number_length`

`id`

`name`

`routes`

`id`

`blocked`

`provider`

`strip_digits`

`prepend`

`from_extension`

`200`

`400`

`200`

`200`

`id`

`200`

`pagesize`

`count`

`pagination`

`rules`

`number_mask`

`from_extension_groups`

`group_name`

`id`

`number_prefix`

`number_length`

`name`

`routes`

`id`

`blocked`

`provider`

`strip_digits`

`prepend`

`id`

`sort_by`