EXTENSION

Create extension voicemail greeting

POST /greeting_file/create

Create extension voicemail greeting

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

file_id

integer

required

format : int64
extension_id

integer

required

The id of the extension.

format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/extensions/greeting_file/create \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "file_id": 1234,
    "extension_id": 1234
}'

Responses

`404`

User not found

`200`

Successful operation

application/json

id

integer

format : int64

`400`

Invalid extension number supplied

Sample Response

List extension groups

GET /group/list

List extension groups

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64
pagination

integer

required

The pagination of paging.
pagesize

integer

required

The size of paging.
sort_by

string

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/extensions/group/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

`200`

Successful operation

application/json

pagesize

integer
count

integer
pagination

integer
groups

array

Show child attributes
- members_count
  
  integer
  
  format : uint64
- group_name
  
  string
  
  Name of extension group to be created.
- id
  
  integer
  
  Extension group unique ID.
  
  format : int64
sort_by

string

Sample Response

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

Retrieve extension group

GET /group/show

Retrieves the properties of an extension group.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64
id

integer

required

Extension group ID

format : int64

Sample Request

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

Responses

`200`

Successful operation

application/json

enable_management_console_access

boolean

Indicates if extension group members are allowed to access the PortSIP PBX Management Console. IMPORTANT NOTE: Make sure that the Access Password configured is secure.
group_name

string

Name of extension group to be created.
enable_call_cross_group

boolean

enable_call_cross_group
enable_intercom

boolean

Indicates if extension group members are allowed for intercom.
group_description

string

Description for extension group to be created.
enable_external_call

boolean

Indicates if extension group members are allowed to call external numbers.
members

array

Show child attributes
- first_name
  
  string
  
  First name of extension user.
- last_name
  
  string
  
  Last name of extension user.
- id
  
  integer
  
  The id of the extension.
  
  format : int64
- extension_number
  
  string
  
  Extension number
id

integer

Extension group unique ID.

format : int64

Sample Response

{}

Add a new extension group to the system.

POST /group/create

Create a new extension group.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

enable_management_console_access

boolean

required

Indicates if extension group members are allowed to access the PortSIP PBX Management Console. IMPORTANT NOTE: Make sure that the Access Password configured is secure.
group_name

string

required

Name of extension group to be created.
enable_call_cross_group

boolean

required

enable_call_cross_group
enable_intercom

boolean

required

Indicates if extension group members are allowed for intercom.
group_description

string

required

Description for extension group to be created.
enable_external_call

boolean

required

Indicates if extension group members are allowed to call external numbers.
members

array

required

Sample Request

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

Responses

`200`

Created extension group

application/json

group_name

string

Name of extension group to be created.
id

integer

Extension group unique ID.

format : int64

Sample Response

{}

List extensions

GET /list

List a collection of extension.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64
pagination

integer

required

The pagination of paging.
pagesize

integer

required

The size of paging.
sort_by

string

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/extensions/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

`200`

Successful operation

application/json

pagesize

integer
count

integer
extensions

array

Show child attributes
- user_agent
  
  string
  
  User agent of extension.
- status
  
  string
  
  Status of extension.
  
  enum : ['ONLINE', 'OFFLINE', 'ON_CALL']
- email
  
  string
- first_name
  
  string
  
  First name of extension user.
- last_name
  
  string
  
  Last name of extension user.
- id
  
  integer
  
  The id of the extension.
  
  format : int64
- extension_number
  
  string
  
  Extension number
pagination

integer
sort_by

string

Sample Response

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

Retrieve extension

GET /show

Retrieves the settings of an extension.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64
id

integer

required

The id of the extension.

format : int64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/extensions/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".
- 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".
- monday_to
  
  string
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
- sunday_to
  
  string
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
- saturday_to
  
  string
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
- monday_from
  
  string
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- friday_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".
- sunday_from
  
  string
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- saturday_from
  
  string
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- office_hours_mode
  
  string
  
  GLOBAL – Use Global Office Hours; CUSTOM – Use Specific Office Hours.
  
  enum : ['GLOBAL', 'CUSTOM']
- wednesday_from
  
  string
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- tuesday_from
  
  string
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
extension_number

string

Extension number
profile

object

Show child attributes
- description
  
  string
  
  Extension user's biography.
- gender
  
  string
  
  MALE or FEMALE.
  
  enum : ['MALE', 'FEMALE']
- last_name
  
  string
  
  Last name of extension user.
- facebook
  
  string
  
  Facebook homepage for extension user.
- company_name
  
  string
  
  extension company name
- linkedin
  
  string
  
  LinkedIn homepage for extension user.
- work_phone
  
  string
  
  Office number for extension user.
- email
  
  string
  
  Email address for extension user.
- first_name
  
  string
  
  First name of extension user.
- twitter
  
  string
  
  Twitter homepage for extension user.
- instagram
  
  string
  
  Instagram homepage for extension user.
- mobile_phone
  
  string
  
  Mobile number for extension user.
- home_phone
  
  string
  
  Home phone number for extension user.
- company_website
  
  string
  
  extension company website
password

string

Extension SIP password
forward_rules

object

Show child attributes
- available
  
  object
  
  Show child attributes
  - no_answer_external_number
    
    string
    
    no_answer_external_number
  - no_answer_timeval
    
    integer
    
    Duration that the call will remain ringing when no one answered, in seconds.
  - busy_fwdto_type
    
    string
    
    enum : ['CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'END_CALL', 'RING_ANYWAY', 'CONNECT_TO_CALL_QUEUE', 'CONNECT_TO_ANOTHER_VOICE_MAIL']
  - no_answer_fwdto_id
    
    integer
    
    no_answer_fwdto_id
    
    format : int64
  - busy_external_number
    
    string
    
    busy_external_number
  - no_answer_fwdto_type
    
    string
    
    enum : ['CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'END_CALL', 'RING_ANYWAY', 'CONNECT_TO_CALL_QUEUE', 'CONNECT_TO_ANOTHER_VOICE_MAIL']
  - busy_fwdto_id
    
    integer
    
    busy_fwdto_id
    
    format : int64
- offline
  
  object
  
  Show child attributes
  - office_hours_external_number
    
    string
    
    office_hours_external_number
  - office_hours_fwdto_type
    
    string
    
    enum : ['CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'END_CALL', 'RING_ANYWAY', 'CONNECT_TO_CALL_QUEUE', 'CONNECT_TO_ANOTHER_VOICE_MAIL']
  - outside_office_hours_external_number
    
    string
    
    outside_office_hours_external_number
  - outside_office_hours_fwdto_type
    
    string
    
    enum : ['CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'END_CALL', 'RING_ANYWAY', 'CONNECT_TO_CALL_QUEUE', 'CONNECT_TO_ANOTHER_VOICE_MAIL']
  - outside_office_hours_fwdto_id
    
    integer
    
    outside_office_hours_fwdto_id
    
    format : int64
  - office_hours_fwdto_id
    
    integer
    
    office_hours_fwdto_id
    
    format : int64
web_access_password

string

Extension independent password
options

object

Show child attributes
- enable_call_cross_group
  
  boolean
- emergency_call_outbound_caller_id
  
  string
  
  emergency Outbound caller id.
- enable_external_call
  
  boolean
- enable_audio_record_calls
  
  boolean
  
  Records all calls and saves audio recordings on server.
- enable_management_console_access
  
  boolean
- enable_extension
  
  boolean
  
  Allows temporarily disabling the extension.
- outbound_caller_id
  
  string
  
  Outbound caller id.
- enable_intercom
  
  boolean
- enable_video_record_calls
  
  boolean
  
  Records all calls and saves video recordings on server.
id

integer

The id of the extension.

format : int64
voice_mail

object

Show child attributes
- msg_read_out_datetime
  
  string
  
  Announces Date and Time of Message. Valid values include: DO_NOT_READ - Do not read; AM/PM - Read in AM/PM format; 24-HOUR - Read in 24-hour format.
  
  enum : ['DO_NOT_READ', 'AM/PM', '24-HOUR']
- prompt_language
  
  string
  
  Language of prompt.
  
  enum : ['zh_CN', 'en_US', 'pt_BR']
- enable_play_caller_id
  
  boolean
  
  Indicates if phone number of caller would be read.
- voicemail_pin
  
  string
  
  PIN used for accessing voicemail. If 'enable_vm_pin_auth' is disabled, this parameter is invalid.
- enable_vm_pin_auth
  
  boolean
  
  Indicates if PIN number is required to access Voicemail for this extension.
- enable_voicemail
  
  boolean
  
  Enable voicemail
blfs

array

Show child attributes
- blflast_name
  
  string
- key
  
  string
- value
  
  string
- blffirst_name
  
  string
belong_groups

array

Show child attributes
- name
  
  string
- id
  
  integer
  
  format : int64

Sample Response

                      
{
    "office_hours": {
        "friday_from": "09:00",
        "thursday_from": "09:00",
        "wednesday_to": "17:00",
        "tuesday_to": "17:00",
        "monday_to": "17:00",
        "sunday_to": "17:00",
        "saturday_to": "17:00",
        "monday_from": "09:00",
        "friday_to": "17:00",
        "thursday_to": "17:00",
        "sunday_from": "09:00",
        "saturday_from": "09:00",
        "office_hours_mode": "CUSTOM",
        "wednesday_from": "09:00",
        "tuesday_from": "09:00"
    },
    "id": 1234
}

Update extension group.

POST /group/update

Update extension group

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

enable_management_console_access

boolean

required

Indicates if extension group members are allowed to access the PortSIP PBX Management Console. IMPORTANT NOTE: Make sure that the Access Password configured is secure.
group_name

string

required

Name of extension group to be created.
enable_call_cross_group

boolean

required

enable_call_cross_group
enable_intercom

boolean

required

Indicates if extension group members are allowed for intercom.
group_description

string

required

Description for extension group to be created.
enable_external_call

boolean

required

Indicates if extension group members are allowed to call external numbers.
members

array

required
id

integer

required

Extension group unique ID.

format : int64

Sample Request

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

Responses

`200`

Created extension group

Sample Response

Retrieves status of extensions

POST /status

Retrieves the current status of given extensions.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

extensions

array

required

Extension numbers array

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/extensions/status \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "extensions": [
        1,
        2,
        3
    ]
}'

Responses

`200`

Successful operation

application/json

--

object

Show child attributes
- user_agent
  
  string
  
  User agent of extension.
- status
  
  string
  
  Status of extension.
  
  enum : ['ONLINE', 'OFFLINE', 'ON_CALL']
- extension_id
  
  string
  
  Extension ID.
- extension_number
  
  string
  
  Extension number.

Sample Response

{}

Udpate extension

POST /update

Modify the settings of an extension.

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".
- 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".
- monday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
- sunday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
- saturday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
- monday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- friday_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".
- sunday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- saturday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- office_hours_mode
  
  string
  
  required
  
  GLOBAL – Use Global Office Hours; CUSTOM – Use Specific Office Hours.
  
  enum : ['GLOBAL', 'CUSTOM']
- wednesday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- tuesday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
profile

object

required

Show child attributes
- linkedin
  
  string
  
  required
  
  LinkedIn homepage for extension user.
- last_name
  
  string
  
  required
  
  Last name of extension user.
- gender
  
  string
  
  required
  
  MALE or FEMALE.
  
  enum : ['MALE', 'FEMALE']
- work_phone
  
  string
  
  required
  
  Office number for extension user.
- description
  
  string
  
  required
  
  Extension user's biography.
- facebook
  
  string
  
  required
  
  Facebook homepage for extension user.
- email
  
  string
  
  required
  
  Email address for extension user.
- first_name
  
  string
  
  required
  
  First name of extension user.
- twitter
  
  string
  
  required
  
  Twitter homepage for extension user.
- instagram
  
  string
  
  required
  
  Instagram homepage for extension user.
- mobile_phone
  
  string
  
  required
  
  Mobile number for extension user.
- home_phone
  
  string
  
  required
  
  Home phone number for extension user.
password

string

required

Extension SIP password
forward_rules

object

required

Show child attributes
- available
  
  object
  
  required
  
  Show child attributes
  - no_answer_external_number
    
    string
    
    required
    
    no_answer_external_number
  - no_answer_timeval
    
    integer
    
    required
    
    Duration that the call will remain ringing when no one answered, in seconds.
  - busy_fwdto_type
    
    string
    
    required
    
    enum : ['CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'END_CALL', 'RING_ANYWAY', 'CONNECT_TO_CALL_QUEUE', 'CONNECT_TO_ANOTHER_VOICE_MAIL']
  - no_answer_fwdto_id
    
    integer
    
    required
    
    no_answer_fwdto_id
    
    format : int64
  - busy_external_number
    
    string
    
    required
    
    busy_external_number
  - no_answer_fwdto_type
    
    string
    
    required
    
    enum : ['CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'END_CALL', 'RING_ANYWAY', 'CONNECT_TO_CALL_QUEUE', 'CONNECT_TO_ANOTHER_VOICE_MAIL']
  - busy_fwdto_id
    
    integer
    
    required
    
    busy_fwdto_id
    
    format : int64
- offline
  
  object
  
  required
  
  Show child attributes
  - office_hours_external_number
    
    string
    
    required
    
    office_hours_external_number
  - office_hours_fwdto_type
    
    string
    
    required
    
    enum : ['CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'END_CALL', 'RING_ANYWAY', 'CONNECT_TO_CALL_QUEUE', 'CONNECT_TO_ANOTHER_VOICE_MAIL']
  - outside_office_hours_external_number
    
    string
    
    required
    
    outside_office_hours_external_number
  - outside_office_hours_fwdto_type
    
    string
    
    required
    
    enum : ['CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'END_CALL', 'RING_ANYWAY', 'CONNECT_TO_CALL_QUEUE', 'CONNECT_TO_ANOTHER_VOICE_MAIL']
  - outside_office_hours_fwdto_id
    
    integer
    
    required
    
    outside_office_hours_fwdto_id
    
    format : int64
  - office_hours_fwdto_id
    
    integer
    
    required
    
    office_hours_fwdto_id
    
    format : int64
web_access_password

string

required

Extension independent password
options

object

required

Show child attributes
- enable_audio_record_calls
  
  boolean
  
  required
  
  Records all calls and saves audio recordings on server.
- emergency_call_outbound_caller_id
  
  string
  
  required
  
  emergency Outbound caller id.
- enable_extension
  
  boolean
  
  required
  
  Allows temporarily disabling the extension.
- enable_video_record_calls
  
  boolean
  
  required
  
  Records all calls and saves video recordings on server.
- outbound_caller_id
  
  string
  
  required
  
  Outbound caller id.
voice_mail

object

required

Show child attributes
- msg_read_out_datetime
  
  string
  
  required
  
  Announces Date and Time of Message. Valid values include: DO_NOT_READ - Do not read; AM/PM - Read in AM/PM format; 24-HOUR - Read in 24-hour format.
  
  enum : ['DO_NOT_READ', 'AM/PM', '24-HOUR']
- prompt_language
  
  string
  
  required
  
  Language of prompt.
  
  enum : ['zh_CN', 'en_US', 'pt_BR']
- enable_play_caller_id
  
  boolean
  
  required
  
  Indicates if phone number of caller would be read.
- voicemail_pin
  
  string
  
  required
  
  PIN used for accessing voicemail. If 'enable_vm_pin_auth' is disabled, this parameter is invalid.
- enable_vm_pin_auth
  
  boolean
  
  required
  
  Indicates if PIN number is required to access Voicemail for this extension.
- enable_voicemail
  
  boolean
  
  required
  
  Enable voicemail
blfs

array

required
id

integer

required

The id of the extension.

format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/extensions/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "office_hours": {
        "friday_from": "09:00",
        "thursday_from": "09:00",
        "wednesday_to": "17:00",
        "tuesday_to": "17:00",
        "monday_to": "17:00",
        "sunday_to": "17:00",
        "saturday_to": "17:00",
        "monday_from": "09:00",
        "friday_to": "17:00",
        "thursday_to": "17:00",
        "sunday_from": "09:00",
        "saturday_from": "09:00",
        "office_hours_mode": "CUSTOM",
        "wednesday_from": "09:00",
        "tuesday_from": "09:00"
    },
    "id": 1234
}'

Responses

`200`

Udpate extension

Sample Response

Destroy an extension group

POST /group/destroy

Destroy a certain extension group.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

id

integer

required

Extension group unique ID.

format : int64

Sample Request

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

Responses

`404`

User not found

`200`

Successful operation

`400`

Invalid extension number supplied

Sample Response

Add a new extension to the system.

POST /create

Create a new extension. Only tenant or admin user has access to this API.

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".
- 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".
- monday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
- sunday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
- saturday_to
  
  string
  
  required
  
  End time for office hours on Monday. Format: 24-hour clock, such as "17:00".
- monday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- friday_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".
- sunday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- saturday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- office_hours_mode
  
  string
  
  required
  
  GLOBAL – Use Global Office Hours; CUSTOM – Use Specific Office Hours.
  
  enum : ['GLOBAL', 'CUSTOM']
- wednesday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
- tuesday_from
  
  string
  
  required
  
  Start time for office hours on Monday. Format: 24-hour clock, such as "09:00".
profile

object

required

Show child attributes
- linkedin
  
  string
  
  required
  
  LinkedIn homepage for extension user.
- last_name
  
  string
  
  required
  
  Last name of extension user.
- gender
  
  string
  
  required
  
  MALE or FEMALE.
  
  enum : ['MALE', 'FEMALE']
- work_phone
  
  string
  
  required
  
  Office number for extension user.
- description
  
  string
  
  required
  
  Extension user's biography.
- facebook
  
  string
  
  required
  
  Facebook homepage for extension user.
- email
  
  string
  
  required
  
  Email address for extension user.
- first_name
  
  string
  
  required
  
  First name of extension user.
- twitter
  
  string
  
  required
  
  Twitter homepage for extension user.
- instagram
  
  string
  
  required
  
  Instagram homepage for extension user.
- mobile_phone
  
  string
  
  required
  
  Mobile number for extension user.
- home_phone
  
  string
  
  required
  
  Home phone number for extension user.
password

string

required

Extension SIP password
forward_rules

object

required

Show child attributes
- available
  
  object
  
  required
  
  Show child attributes
  - no_answer_external_number
    
    string
    
    required
    
    no_answer_external_number
  - no_answer_timeval
    
    integer
    
    required
    
    Duration that the call will remain ringing when no one answered, in seconds.
  - busy_fwdto_type
    
    string
    
    required
    
    enum : ['CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'END_CALL', 'RING_ANYWAY', 'CONNECT_TO_CALL_QUEUE', 'CONNECT_TO_ANOTHER_VOICE_MAIL']
  - no_answer_fwdto_id
    
    integer
    
    required
    
    no_answer_fwdto_id
    
    format : int64
  - busy_external_number
    
    string
    
    required
    
    busy_external_number
  - no_answer_fwdto_type
    
    string
    
    required
    
    enum : ['CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'END_CALL', 'RING_ANYWAY', 'CONNECT_TO_CALL_QUEUE', 'CONNECT_TO_ANOTHER_VOICE_MAIL']
  - busy_fwdto_id
    
    integer
    
    required
    
    busy_fwdto_id
    
    format : int64
- offline
  
  object
  
  required
  
  Show child attributes
  - office_hours_external_number
    
    string
    
    required
    
    office_hours_external_number
  - office_hours_fwdto_type
    
    string
    
    required
    
    enum : ['CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'END_CALL', 'RING_ANYWAY', 'CONNECT_TO_CALL_QUEUE', 'CONNECT_TO_ANOTHER_VOICE_MAIL']
  - outside_office_hours_external_number
    
    string
    
    required
    
    outside_office_hours_external_number
  - outside_office_hours_fwdto_type
    
    string
    
    required
    
    enum : ['CONNECT_TO_VOICE_MAIL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'CONNECT_TO_EXTERNAL_NUMBER', 'CONNECT_TO_VIRTUAL_RECEPTIONIST', 'END_CALL', 'RING_ANYWAY', 'CONNECT_TO_CALL_QUEUE', 'CONNECT_TO_ANOTHER_VOICE_MAIL']
  - outside_office_hours_fwdto_id
    
    integer
    
    required
    
    outside_office_hours_fwdto_id
    
    format : int64
  - office_hours_fwdto_id
    
    integer
    
    required
    
    office_hours_fwdto_id
    
    format : int64
web_access_password

string

required

Extension independent password
options

object

required

Show child attributes
- enable_audio_record_calls
  
  boolean
  
  required
  
  Records all calls and saves audio recordings on server.
- emergency_call_outbound_caller_id
  
  string
  
  required
  
  emergency Outbound caller id.
- enable_extension
  
  boolean
  
  required
  
  Allows temporarily disabling the extension.
- enable_video_record_calls
  
  boolean
  
  required
  
  Records all calls and saves video recordings on server.
- outbound_caller_id
  
  string
  
  required
  
  Outbound caller id.
voice_mail

object

required

Show child attributes
- msg_read_out_datetime
  
  string
  
  required
  
  Announces Date and Time of Message. Valid values include: DO_NOT_READ - Do not read; AM/PM - Read in AM/PM format; 24-HOUR - Read in 24-hour format.
  
  enum : ['DO_NOT_READ', 'AM/PM', '24-HOUR']
- prompt_language
  
  string
  
  required
  
  Language of prompt.
  
  enum : ['zh_CN', 'en_US', 'pt_BR']
- enable_play_caller_id
  
  boolean
  
  required
  
  Indicates if phone number of caller would be read.
- voicemail_pin
  
  string
  
  required
  
  PIN used for accessing voicemail. If 'enable_vm_pin_auth' is disabled, this parameter is invalid.
- enable_vm_pin_auth
  
  boolean
  
  required
  
  Indicates if PIN number is required to access Voicemail for this extension.
- enable_voicemail
  
  boolean
  
  required
  
  Enable voicemail
blfs

array

required
extension_number

string

required

Extension number

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/extensions/create \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "office_hours": {
        "friday_from": "09:00",
        "thursday_from": "09:00",
        "wednesday_to": "17:00",
        "tuesday_to": "17:00",
        "monday_to": "17:00",
        "sunday_to": "17:00",
        "saturday_to": "17:00",
        "monday_from": "09:00",
        "friday_to": "17:00",
        "thursday_to": "17:00",
        "sunday_from": "09:00",
        "saturday_from": "09:00",
        "office_hours_mode": "CUSTOM",
        "wednesday_from": "09:00",
        "tuesday_from": "09:00"
    }
}'

Responses

`405`

Invalid input

`200`

Created extension object

application/json

id

integer

The id of the extension.

format : int64

Sample Response

search extensions

GET /search

search a collection of extension.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64
pagination

integer

required

The pagination of paging.
pagesize

integer

required

The size of paging.
sort_by

string

optional

Default value will be used when user does not specify value for this field.

enum : ['DEFAULT', 'OPTIONAL']
extension_number

string

optional

Extension number

Sample Request

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

Responses

`200`

Successful operation

application/json

pagesize

integer
count

integer
extensions

array

Show child attributes
- user_agent
  
  string
  
  User agent of extension.
- status
  
  string
  
  Status of extension.
  
  enum : ['ONLINE', 'OFFLINE', 'ON_CALL']
- email
  
  string
- first_name
  
  string
  
  First name of extension user.
- last_name
  
  string
  
  Last name of extension user.
- id
  
  integer
  
  The id of the extension.
  
  format : int64
- extension_number
  
  string
  
  Extension number
pagination

integer
sort_by

string

Sample Response

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

Set extension voicemail greeting activated or deactivated

POST /greeting_file/update

Set extension voicemail greeting activated or deactivated

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

extension_id

integer

required

The id of the extension.

format : int64
id

integer

required

format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/extensions/greeting_file/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "extension_id": 1234,
    "id": 1234
}'

Responses

`404`

User not found

`200`

Successful operation

`400`

Invalid extension number supplied

Sample Response

Delete an extension

POST /destroy

Delete a certain extension.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

id

integer

required

The id of the extension.

format : int64

Sample Request

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

Responses

`404`

User not found

`200`

Successful operation

`400`

Invalid extension id supplied

Sample Response

List extension voicemail greetings

GET /greeting_file/list

Retrieves a list of greeting files available to certain extension.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64
pagination

integer

required

The pagination of paging.
pagesize

integer

required

The size of paging.
sort_by

string

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/extensions/greeting_file/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
- filename
  
  string
  
  File name
  
  minLength: 64
  
  maxLength: 64
- file_id
  
  integer
  
  format : int64
- enabled
  
  boolean
- id
  
  integer
  
  format : int64
sort_by

string

Sample Response

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

Destroy extension voicemail greeting

POST /greeting_file/destroy

Destroy a extension voicemail greeting.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

extension_id

integer

required

The id of the extension.

format : int64
id

integer

required

format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/extensions/greeting_file/destroy \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "extension_id": 1234,
    "id": 1234
}'

Responses

`404`

User not found

`200`

Successful operation

`400`

Invalid extension number supplied

Sample Response

make call by extension

POST /call

make call by extension.

Request body

application/json

extension

string

required

Extension number
to

string

required

Extension number
auth

string

required

Extension independent password
src

string

required

Extension number
domain

string

required

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/extensions/call \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "domain": "abc.com"
}'

Responses

`200`

Created call

Sample Request

404

200

application/json

id

400

Sample Response

Sample Request

200

application/json

pagesize

count

pagination

groups

members_count

group_name

id

sort_by

Sample Response

Sample Request

200

application/json

enable_management_console_access

group_name

enable_call_cross_group

enable_intercom

group_description

enable_external_call

members

first_name

last_name

id

extension_number

id

Sample Response

Sample Request

200

application/json

group_name

id

Sample Response

Sample Request

200

application/json

pagesize

count

extensions

user_agent

status

email

first_name

last_name

id

extension_number

pagination

sort_by

Sample Response

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

extension_number

profile

description

gender

`404`

`200`

`id`

`400`

`200`

`pagesize`

`count`

`pagination`

`groups`

`members_count`

`group_name`

`id`

`sort_by`

`200`

`enable_management_console_access`

`group_name`

`enable_call_cross_group`

`enable_intercom`

`group_description`

`enable_external_call`

`members`

`first_name`

`last_name`

`id`

`extension_number`

`id`

`200`

`group_name`

`id`

`200`

`pagesize`

`count`

`extensions`

`user_agent`

`status`

`email`

`first_name`

`last_name`

`id`

`extension_number`

`pagination`

`sort_by`

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

`extension_number`

`profile`

`description`

`gender`

`last_name`

`facebook`

`company_name`

`linkedin`

`work_phone`

`email`

`first_name`

`twitter`

`instagram`

`mobile_phone`

`home_phone`

`company_website`

`password`

`forward_rules`

`available`

`no_answer_external_number`

`no_answer_timeval`