Retrive extension groups
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.pagination
integer
required
The pagination of paging.pagesize
integer
optional
The pagesize of paging.sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.
Sample Request
https://example.com/api/extensions/group/list?access_token=196ACE20C6F34027895F7F95402BB164&pagesize=100&pagination=1&sort_by=DEFAULT
Response
pagination
integer
required
The pagination of paging.pagesize
integer
optional
The pagesize of paging.sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.page_count
integer
required
The total count of pages.count
integer
required
Current pagesize.groups
array
required
Show child attributesCollection of extension group objects.
Sample Response
{
"pagination": 1,
"pagesize": 100,
"sort_by": "DEFAULT",
"page_count": 100,
"count": 100,
"groups": [
{
"group_id": "5E7B5E37-4008-429C-85D3-183DD4D4A9D9",
"group_name": "Example extension group",
"members_count": 0
},
{
"group_id": "__DEFAULT_EXTENSION_GROUP__",
"group_name": "__DEFAULT_EXTENSION_GROUP__",
"members_count": 0
}
]
}
Reteive settings for extension group
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.group_id
string
required
Group ID.
Sample Request
https://example.com/api/extensions/group/show?access_token=196ACE20C6F34027895F7F95402BB164&group_id=Group+ID+1
Response
group_id
string
required
Group IDgroup_name
string
required
Name of extension group.group_description
string
required
Description for current extension group.enable_intercom
boolean
required
Indicates if extension group members are allowed for intercom.enable_external_call
boolean
required
Indicates if extension group members are allowed to call external numbersenable_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 secured.members
array
required
Show child attributesCollection of extensions.
Sample Response
{
"group_name": "Sample extension group",
"group_description": "Sample extension group",
"enable_intercom": true,
"enable_external_call": true,
"enable_management_console_access": true,
"members": [
"105",
"106",
"107"
]
}
Create an extension group
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.group_name
string
required
Name of extension group to be created.group_description
string
optional
Description for extension group to be created.enable_intercom
boolean
required
Indicates if extension group members are allowed for intercom.enable_external_call
boolean
required
Indicates if extension group members are allowed to call external numbers.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.members
array
optional
Show child attributesCollection of extensions.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"group_name": "Sample extension group",
"group_description": "Sample extension group",
"enable_intercom": true,
"enable_external_call": true,
"enable_management_console_access": true,
"members": [
"105",
"106",
"107"
]
}
Response
group_id
string
required
Group ID.group_name
string
required
Name of the group created.
Sample Response
{
"group_id": "12",
"group_name": "test"
}
Update extension group
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.group_id
string
required
Group ID for extension group to be modified.group_name
string
required
Name of extension group to be created.group_description
string
optional
Description for extension group to be created.enable_intercom
boolean
required
Indicates if extension group members are allowed for intercom.enable_external_call
boolean
required
Indicates if extension group members are allowed to call external numbers.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.members
array
optional
Show child attributesCollection of extensions.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"group_id": "12",
"group_name": "Sample extension group",
"group_description": "Sample extension group",
"enable_intercom": true,
"enable_external_call": true,
"enable_management_console_access": true,
"members": [
"105",
"106",
"107"
]
}
Response
Sample Response
Remove an extension group
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.group_id
string
required
Group ID.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"group_id": "Sample extension group"
}
Response
Sample Response
Retrive a list of extensions
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.pagination
integer
required
The pagination of paging.pagesize
integer
optional
The pagesize of paging.sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.
Sample Request
https://example.com/api/extensions/list?access_token=196ACE20C6F34027895F7F95402BB164&pagesize=100&pagination=1&sort_by=DEFAULT
Response
pagination
integer
required
The pagination of paging.pagesize
integer
optional
The pagesize of paging.sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.page_count
integer
required
The total count of pages.count
integer
required
Current pagesize.extensions
array
required
Show child attributesCollection of extension objects returned.
Sample Response
{
"pagination": 1,
"pagesize": 100,
"sort_by": "DEFAULT",
"page_count": 100,
"count": 100,
"extensions": [
{
"extension_number": "1001",
"first_name": "Sample name",
"last_name": "Sample name",
"email": "sample@sample.com",
"status": "OFFLINE",
"user_agent": "",
"phone_mac_address": "",
"phone_model": ""
}
]
}
Search a list of extensions
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.pagination
integer
required
The pagination of paging.pagesize
integer
optional
The pagesize of paging.condition
string
required
Search condition.
Sample Request
https://example.com/api/extensions/search?access_token=196ACE20C6F34027895F7F95402BB164&condition=100a&pagesize=100&pagination=1
Response
pagination
integer
required
The pagination of paging.pagesize
integer
optional
The pagesize of paging.page_count
integer
required
The total count of pages.count
integer
required
Current pagesize.extensions
array
required
Show child attributesCollection of extension objects returned.
Sample Response
{
"pagination": 1,
"pagesize": 100,
"page_count": 100,
"count": 100,
"extensions": {
"extension_number": "1001",
"first_name": "Sample name",
"last_name": "Sample name",
"email": "sample@sample.com",
"status": "OFFLINE",
"user_agent": "",
"phone_mac_address": "",
"phone_model": ""
}
}
Create a new extension
Request
extension_number
string
required
Number of extension to be created.password
string
required
Password of extension to be created.web_access_password
string
required
Access password of extension to be created.profile
object
optional
Show child attributesProfile settings for extension.voice_mail
object
optional
Show child attributesVoicemail settings for extension.forward_rules
object
optional
Show child attributesSettings for forwarding rules.options
object
optional
Show child attributesSettings in Options section.office_hours
object
optional
Show child attributesSettings for extension office hours.
Sample Request
{
"extension_number": "1000",
"password": "123456",
"web_access_password": "123456",
"profile": {
"first_name": "first name",
"last_name": "last name",
"gender": "MALE",
"email": "example@example.com",
"mobile_phone": "123456",
"work_phone": "123456",
"home_phone": "123456",
"twitter": "Placeholders",
"facebook": "Placeholders",
"linkedin": "Placeholders",
"instagram": "Placeholders",
"description": "Placeholders"
},
"options": {
"enable_audio_record_calls": false,
"enable_video_record_calls": false,
"enable_extension": true
},
"voice_mail": {
"enable_voicemail": true,
"prompt_language": "en-us",
"enable_vm_pin_auth": true,
"voicemail_pin": "123456",
"enable_play_caller_id": false,
"msg_read_out_datetime": "DO_NOT_READ"
},
"forward_rules": {
"available": {
"no_answer_timeval": 20,
"no_answer_action": "CONNECT_TO_VOICE_MAIL",
"no_answer_action_value": "",
"busy_action": "CONNECT_TO_VOICE",
"busy_action_value": ""
},
"offline": {
"office_hours_action": "CONNECT_TO_VOICE",
"office_hours_action_value": "",
"outside_office_hours_action": "CONNECT_TO_VOICE",
"outside_office_hours_action_value": ""
},
"dnd": {
"office_hours_action": "CONNECT_TO_VOICE",
"office_hours_action_value": "",
"outside_office_hours_action": "CONNECT_TO_VOICE",
"outside_office_hours_action_value": ""
},
"away": {
"office_hours_action": "CONNECT_TO_VOICE",
"office_hours_action_value": "",
"outside_office_hours_action": "CONNECT_TO_VOICE",
"outside_office_hours_action_value": ""
}
},
"office_hours": {
"office_hours_mode": "CUSTOM",
"monday_from": "09:00",
"monday_to": "17:00",
"tuesday_from": "09:00",
"tuesday_to": "17:00",
"wednesday_from": "09:00",
"wednesday_to": "17:00",
"thursday_from": "09:00",
"thursday_to": "17:00",
"friday_from": "09:00",
"friday_to": "17:00",
"saturday_from": "09:00",
"saturday_to": "17:00",
"sunday_from": "09:00",
"sunday_to": "17:00"
}
}
Response
Sample Response
Retrive settings for extension
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.extension_number
string
required
The count of extension.
Sample Request
https://example.com/api/extensions/show?access_token=196ACE20C6F34027895F7F95402BB164&extension_number=1000
Response
extension_number
string
required
Number of extension to be created.password
string
required
Password of extension to be created.web_access_password
string
required
Access password of extension to be created.profile
object
optional
Show child attributesProfile settings for extension.voice_mail
object
optional
Show child attributesVoicemail settings for extension.forward_rules
object
optional
Show child attributesSettings for forwarding rules.options
object
optional
Show child attributesSettings in Options section.office_hours
object
optional
Show child attributesSettings for extension office hours.belong_groups
array
optional
Show child attributesbelong_groups.
Sample Response
{
"extension_number": "1000",
"password": "123456",
"web_access_password": "123456",
"profile": {
"first_name": "first name",
"last_name": "last name",
"gender": "MALE",
"email": "example@example.com",
"mobile_phone": "123456",
"work_phone": "123456",
"home_phone": "123456",
"twitter": "Placeholders",
"facebook": "Placeholders",
"linkedin": "Placeholders",
"instagram": "Placeholders",
"description": "Placeholders"
},
"options": {
"enable_audio_record_calls": false,
"enable_video_record_calls": false,
"enable_extension": true
},
"voice_mail": {
"enable_voicemail": true,
"prompt_language": "en-us",
"enable_vm_pin_auth": true,
"voicemail_pin": "123456",
"enable_play_caller_id": false,
"msg_read_out_datetime": "DO_NOT_READ"
},
"forward_rules": {
"available": {
"no_answer_timeval": 20,
"no_answer_action": "CONNECT_TO_VOICE_MAIL",
"no_answer_action_value": "",
"busy_action": "CONNECT_TO_VOICE",
"busy_action_value": ""
},
"offline": {
"office_hours_action": "CONNECT_TO_VOICE",
"office_hours_action_value": "",
"outside_office_hours_action": "CONNECT_TO_VOICE",
"outside_office_hours_action_value": ""
},
"dnd": {
"office_hours_action": "CONNECT_TO_VOICE",
"office_hours_action_value": "",
"outside_office_hours_action": "CONNECT_TO_VOICE",
"outside_office_hours_action_value": ""
},
"away": {
"office_hours_action": "CONNECT_TO_VOICE",
"office_hours_action_value": "",
"outside_office_hours_action": "CONNECT_TO_VOICE",
"outside_office_hours_action_value": ""
}
},
"office_hours": {
"office_hours_mode": "CUSTOM",
"monday_from": "09:00",
"monday_to": "17:00",
"tuesday_from": "09:00",
"tuesday_to": "17:00",
"wednesday_from": "09:00",
"wednesday_to": "17:00",
"thursday_from": "09:00",
"thursday_to": "17:00",
"friday_from": "09:00",
"friday_to": "17:00",
"saturday_from": "09:00",
"saturday_to": "17:00",
"sunday_from": "09:00",
"sunday_to": "17:00"
}
}
Retrive status of extensions
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.extensions
array
required
Show child attributesExtension numbers array of which you want to get the status.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"extensions": [
"102"
]
}
Response
extension_status
array
required
Show child attributesExtension number.
Sample Response
{
"extension_status": [
{
"extension_number": "101",
"status": "ON_CALL",
"user_agent": ""
}
]
}
Call a certain extension.
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.extension
string
required
Extension number of which you want to call.auth
string
required
Password.to
string
required
Call to.domain
string
required
Domain.src
string
required
Source.
Sample Request
https://example.com/apiextensions/call?access_token=196ACE20C6F34027895F7F95402BB164&auth=example+password&domain=example+domain&extension=1000&src=example+source&to=1001
Response
Sample Response
Update an extension
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.extension_number
string
required
Extension number.profile
object
required
Show child attributesProfile settings for extension.options
object
required
Show child attributesOptions settings for extension.forward_rules
object
required
Show child attributesForward rules for extension.office_hours
object
required
Show child attributesOffice hours for extension.voice_mail
object
required
Show child attributesVoicemail for extension.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"extension_number": "102",
"profile": {
"first_name": "first name",
"last_name": "last name",
"gender": "MALE",
"email": "example@example.com",
"mobile_phone": "123456",
"work_phone": "123456",
"home_phone": "123456",
"twitter": "Placeholders",
"facebook": "Placeholders",
"linkedin": "Placeholders",
"instagram": "Placeholders",
"description": "Placeholders"
},
"options": {
"enable_audio_record_calls": false,
"enable_video_record_calls": false,
"enable_extension": true
},
"forward_rules": {
"available": {
"no_answer_timeval": 20,
"no_answer_action": "CONNECT_TO_VOICE_MAIL",
"no_answer_action_value": "",
"busy_action": "CONNECT_TO_VOICE",
"busy_action_value": ""
},
"offline": {
"office_hours_action": "CONNECT_TO_VOICE",
"office_hours_action_value": "",
"outside_office_hours_action": "CONNECT_TO_VOICE",
"outside_office_hours_action_value": ""
},
"dnd": {
"office_hours_action": "CONNECT_TO_VOICE",
"office_hours_action_value": "",
"outside_office_hours_action": "CONNECT_TO_VOICE",
"outside_office_hours_action_value": ""
},
"away": {
"office_hours_action": "CONNECT_TO_VOICE",
"office_hours_action_value": "",
"outside_office_hours_action": "CONNECT_TO_VOICE",
"outside_office_hours_action_value": ""
}
},
"office_hours": {
"office_hours_mode": "CUSTOM",
"monday_from": "09:00",
"monday_to": "17:00",
"tuesday_from": "09:00",
"tuesday_to": "17:00",
"wednesday_from": "09:00",
"wednesday_to": "17:00",
"thursday_from": "09:00",
"thursday_to": "17:00",
"friday_from": "09:00",
"friday_to": "17:00",
"saturday_from": "09:00",
"saturday_to": "17:00",
"sunday_from": "09:00",
"sunday_to": "17:00"
},
"voice_mail": {
"enable_voicemail": true,
"prompt_language": "en-us",
"enable_vm_pin_auth": true,
"voicemail_pin": "123456",
"enable_play_caller_id": false,
"msg_read_out_datetime": "DO_NOT_READ"
}
}
Response
Sample Response
Remove an extension
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.extension_number
string
required
Number of extension.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"extension_number": "1000"
}
Response
Sample Response
Add greeting file for voicemail
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.extension_number
string
required
Number of extension.filename
string
optional
Original name of uploaded file.url
string
optional
URL for download the greeting file.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"extension_number": "1000",
"filename": "some_filename.wav",
"url": "some_url"
}
Response
Sample Response
Add greeting file for voicemail by curl
Request
Sample Request
Response
Sample Response
Setup greeting file for extension
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.extension_number
string
required
Number of extension.filename
string
required
Name of uploaded file.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"extension_number": "1000",
"filename": "some_filename"
}
Response
Sample Response
Remove greeting file
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.extension_number
string
required
Number of extension.filename
string
required
Name of greeting file to be deleted.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"extension_number": "1000",
"filename": "some_filename"
}
Response
Sample Response
Retrive greeting files
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.pagination
integer
required
The pagination of paging.pagesize
integer
optional
The pagesize of paging.sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.extension_number
string
required
Number of extension.
Sample Request
https://example.com/api/extensions/greeting_file/list?access_token=196ACE20C6F34027895F7F95402BB164&extension_number=1000&pagesize=100&pagination=1&sort_by=DEFAULT
Response
pagination
integer
required
The pagination of paging.pagesize
integer
optional
The pagesize of paging.sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.page_count
integer
required
The total count of pages.count
integer
required
Current pagesize.greetings
array
required
Show child attributesCollection of greeting objects.
Sample Response
{
"pagination": 1,
"pagesize": 100,
"sort_by": "DEFAULT",
"page_count": 100,
"count": 100,
"default_file": "abcdfeg.wav",
"files": [
{
"filename": "default.wav,",
"enabled": true
},
{
"filename": "qweqwrer.wav",
"enabled": false
}
]
}