GET /extension/registration/
Get extension registration status
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Extension id, multiple possible. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: False |
|
|
Extension id, multiple possible. |
|
|
Default: [] |
POST /extension/{extension_id}/agent/
Add new agent
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Agent status. One of 'logged_out', 'available'. Default: available |
|
|
|
|
|
Required. Agent name. |
|
|
If the agent is on do not disturb, we wait this defined time before trying him again. Default: 10 |
|
|
If the agent does not answer the call, we wait this defined time before trying him again. Default: 10 |
|
|
Agent call timeout. |
|
|
Allow an agent to have a delay when finishing a call before receiving another one. Default: 0 |
|
|
If the agent press the reject on their phone, we wait this defined time amount. Default: 10 |
|
|
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: 60 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
GET /extension/{extension_id}/agent/
Get agents list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: 60 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
PUT /extension/{extension_id}/agent/{agent_id
}
Update agent
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Agent status. One of 'logged_out', 'available'. |
|
|
|
|
|
Agent name. |
|
|
If the agent is on do not disturb, we wait this defined time before trying him again. |
|
|
If the agent does not answer the call, we wait this defined time before trying him again. |
|
|
Agent call timeout. |
|
|
Allow an agent to have a delay when finishing a call before receiving another one. |
|
|
If the agent press the reject on their phone, we wait this defined time amount. |
|
|
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: 60 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
GET /extension/{extension_id}/agent/{agent_id
}
Get agent by id
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: 60 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
DELETE /extension/{extension_id}/agent/{agent_id
}
Delete agent
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Default: True |
GET /extension/{extension_id}/alias/
Get alias list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Default: 1 |
|
|
|
|
|
|
|
|
|
|
|
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
PUT /extension/{extension_id}/ani/
Update extension ani
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. Ani . |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
GET /extension/{extension_id}/ani/
Get extension ani
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
POST /extension/{extension_id}/callback/
Create callback
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Restrict or permit transfer of a phone call made to a phone number external to the system. Default: False |
|
|
Will transfer src on number if other side hang up. |
|
|
Required. Source call number. |
|
|
Rate limits for callback to prevent all calls consist of callback. |
|
|
Total duration of the call, in seconds. |
|
|
Source caller id. |
|
|
Will transfer dst on number if other side hang up. |
|
|
The maximum number of seconds to wait until one of the phone numbers used picks up. |
|
|
Caller name. |
|
|
Required. Destination call number. |
|
|
Dst number identification on trunks. |
|
|
Source caller name. |
|
|
Caller id. |
|
|
Announce sound id, the sound that will hear src after answer. |
|
|
Announce sound id. the sound that will hear dst and src after dst answer. |
|
|
Src number identification on trunks. |
|
|
Dtmf digtis to send to destination . |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
PUT /extension/{extension_id}/chat/{chat_id}/messages/
Change chat messages
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
Resource id. |
DELETE /extension/{extension_id}/chat/{chat_id}/messages/
Delete all chat messages
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
PUT /extension/{extension_id}/conference/
Update conference configuration
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
|
|
|
Default: False |
|
|
Default: False |
GET /extension/{extension_id}/conference/
Get conference configuration
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
|
|
|
Default: False |
|
|
Default: False |
PUT /extension/{extension_id}/conference/status/
Manage conference
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /extension/{extension_id}/conference/status/
Get conference status
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. One of 'show_members', 'is_locked', 'max_members', 'count', 'run_time'. |
GET /extension/{extension_id}/current_calls/
Get active calls for extension type phone
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
PUT /extension/{extension_id}/current_calls/{call_api_id
}
Update call
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. One of 'eavesdrop', 'whisper', 'conference', 'transfer', 'attended_transfer', 'hold', 'offhold', 'park', 'pickup'. |
|
|
|
|
|
|
|
|
GET /extension/{extension_id}/current_calls/{call_api_id
}
Get active call for extension type phone by call_api_id
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Default: True |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
DELETE /extension/{extension_id}/current_calls/{call_api_id
}
Delete call
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
POST /extension/{extension_id}/event/
Add extension event
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. Request url. |
|
|
Required. Call event type. One of 'dial-in', 'dial-out', 'hangup', 'answer', 'message-in', 'message-out', 'message-out-status', 'voicemail'. |
|
|
Required. Http request method. One of 'GET', 'POST'. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
GET /extension/{extension_id}/event/
Get extension event list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
DELETE /extension/{extension_id}/event/
Delete all extension events
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
PUT /extension/{extension_id}/event/{id
}
Update extension event
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. Resource id. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Request url. |
|
|
Call event type. One of 'dial-in', 'dial-out', 'hangup', 'answer', 'message-in', 'message-out', 'message-out-status', 'voicemail'. |
|
|
Http request method. One of 'GET', 'POST'. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
GET /extension/{extension_id}/event/{id
}
Get extension event
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. Resource id. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
DELETE /extension/{extension_id}/event/{id
}
Delete extension event
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. Resource id. |
GET /extension/{extension_id}/extension/
Get extension
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
|
|
PUT /extension/{extension_id}/fax/
Update fax config
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: tiff |
|
|
|
|
|
|
|
|
GET /extension/{extension_id}/fax/
Get fax config
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: tiff |
|
|
|
|
|
|
|
|
GET /extension/{extension_id}/fax/in/{fax_uuid
}
Get incoming fax message
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
POST /extension/{extension_id}/fax/out/
Send fax message
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Form parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. Destination number. |
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
Destination number. |
|
|
Resource id. |
|
|
PUT /extension/{extension_id}/fax/out/{message_id
}
Change fax message
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. One of 'cancel', 'retry'. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
Resource id. |
|
|
POST /extension/{extension_id}/incom_rule/
Add extension incoming call rule
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Allow public called destinations to transfer calls. Default: False |
|
|
Extension call status. One of 'no_answer', 'busy', 'any'. Default: any |
|
|
Call status. One of 'no_answer', 'busy', 'any'. Default: any |
|
|
Transfer destination for transfer rule. multiple destinations divided by space. |
|
|
Enable call screening for transfer call. Default: False |
|
|
Rule is active. Default: True |
|
|
Time interval id. |
|
|
Caller id matching method. One of 'matches', 'not_matches', 'anonymous', 'any'. Default: any |
|
|
Rule control code. |
|
|
Caller id. |
|
|
While transfer play ring back tones instead of early media. Default: True |
|
|
Extension status. One of 'registered', 'unreachable', 'any'. Default: any |
|
|
Ring to transfer destination this count of seconds. Default: 60 |
|
|
Sound id for playfile rule. |
|
|
List of elements for cascade rule. |
|
|
Required. Rule type. One of 'busy', 'transfer', 'hangup', 'playfile', 'voicemail', 'cascade', 'simple_transfer', 'simple_cascade'. |
|
|
If rule is final, next rules will be not executed if call failed. Default: True |
|
|
Rule name. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: False |
|
|
One of 'no_answer', 'busy', 'any'. Default: any |
|
|
One of 'no_answer', 'busy', 'any'. Default: any |
|
|
|
|
|
Default: False |
|
|
Default: True |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
|
|
One of 'registered', 'unreachable', 'any'. Default: any |
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
Default: True |
|
|
GET /extension/{extension_id}/incom_rule/
Get extension incoming call rules list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: False |
|
|
One of 'no_answer', 'busy', 'any'. Default: any |
|
|
One of 'no_answer', 'busy', 'any'. Default: any |
|
|
|
|
|
Default: False |
|
|
Default: True |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
|
|
One of 'registered', 'unreachable', 'any'. Default: any |
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
Default: True |
|
|
PUT /extension/{extension_id}/incom_rule/order/
Update current rules order
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. All rules ids in needed order. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: [] |
GET /extension/{extension_id}/incom_rule/order/
Get current rules order
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: [] |
PUT /extension/{extension_id}/incom_rule/{rule_id
}
Update extension incoming call rule by id
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Allow public called destinations to transfer calls. |
|
|
Extension call status. One of 'no_answer', 'busy', 'any'. |
|
|
Call status. One of 'no_answer', 'busy', 'any'. |
|
|
Transfer destination for transfer rule. multiple destinations divided by space. |
|
|
Enable call screening for transfer call. |
|
|
Rule is active. |
|
|
Time interval id. |
|
|
Caller id matching method. One of 'matches', 'not_matches', 'anonymous', 'any'. |
|
|
Rule control code. |
|
|
Caller id. |
|
|
While transfer play ring back tones instead of early media. |
|
|
Extension status. One of 'registered', 'unreachable', 'any'. |
|
|
Ring to transfer destination this count of seconds. |
|
|
Sound id for playfile rule. |
|
|
List of elements for cascade rule. |
|
|
Rule type. One of 'busy', 'transfer', 'hangup', 'playfile', 'voicemail', 'cascade', 'simple_transfer', 'simple_cascade'. |
|
|
If rule is final, next rules will be not executed if call failed. |
|
|
Rule name. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: False |
|
|
One of 'no_answer', 'busy', 'any'. Default: any |
|
|
One of 'no_answer', 'busy', 'any'. Default: any |
|
|
|
|
|
Default: False |
|
|
Default: True |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
|
|
One of 'registered', 'unreachable', 'any'. Default: any |
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
Default: True |
|
|
GET /extension/{extension_id}/incom_rule/{rule_id
}
Get extension incoming call rule by id
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: False |
|
|
One of 'no_answer', 'busy', 'any'. Default: any |
|
|
One of 'no_answer', 'busy', 'any'. Default: any |
|
|
|
|
|
Default: False |
|
|
Default: True |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
|
|
One of 'registered', 'unreachable', 'any'. Default: any |
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
Default: True |
|
|
DELETE /extension/{extension_id}/incom_rule/{rule_id
}
Delete extension incoming call rule by id
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
POST /extension/{extension_id}/interval/
Add interval
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. Interval timezone. |
|
|
Required. Datetime conditions. |
|
|
Required. Interval name. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
GET /extension/{extension_id}/interval/
Get interval list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
PUT /extension/{extension_id}/interval/{interval_id
}
Update interval
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. Interval timezone. |
|
|
Required. Datetime conditions. |
|
|
Required. Interval name. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
GET /extension/{extension_id}/interval/{interval_id
}
Get interval
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
DELETE /extension/{extension_id}/interval/{interval_id
}
Delete interval
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
PUT /extension/{extension_id}/ivr/
Change ivr configuration
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Action after lifetime expires. One of 'hangup', 'transfer'. |
|
|
Context with starts when ivr called. |
|
|
Transfer destination while lifetime expires. |
|
|
Voicemail enabled. |
|
|
Voicemail greeting sound id. |
|
|
Voicemail configuration. One of 'default', 'record_silence'. |
|
|
Ivr call lifetime in seconds. |
|
|
Attach voicemail message to notification email. |
|
|
Milliseconds before entry context starts. |
|
|
Email address for voicemail notifications. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
|
|
|
Default: default |
|
|
|
|
|
Default: True |
|
|
|
|
|
GET /extension/{extension_id}/ivr/
Get ivr configuration
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
|
|
|
Default: default |
|
|
|
|
|
Default: True |
|
|
|
|
|
POST /extension/{extension_id}/ivr/context/
Add ivr context
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. Context name. |
|
|
Number of milliseconds to wait for a selection. Default: 2000 |
|
|
Number of milliseconds to wait conform entered digits. Default: 5000 |
|
|
|
|
|
Allow dial any extension. Default: False |
|
|
Maximum number of digits to collect before searching for a matching menu entry. |
|
|
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
|
|
|
|
|
Context name. |
GET /extension/{extension_id}/ivr/context/
Get ivr context list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
|
|
|
|
|
Context name. |
PUT /extension/{extension_id}/ivr/context/{context_id
}
Update ivr context
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Context name. |
|
|
Number of milliseconds to wait conform entered digits. |
|
|
Number of milliseconds to wait for a selection. |
|
|
|
|
|
Allow dial any extension. |
|
|
Maximum number of digits to collect before searching for a matching menu entry. |
|
|
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
|
|
|
|
|
Context name. |
GET /extension/{extension_id}/ivr/context/{context_id
}
Get ivr context
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
|
|
|
|
|
Context name. |
DELETE /extension/{extension_id}/ivr/context/{context_id
}
Delete ivr context
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
POST /extension/{extension_id}/ivr/context/{context_id}/options/
Add context option
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
GET /extension/{extension_id}/ivr/context/{context_id}/options/
Get context options list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
DELETE /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits
}
Delete context option
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
|
|
Required. |
POST /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/
Add context rule
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Variable name for transfer_from_variable. |
|
|
Call status. One of 'no_answer', 'busy', 'any'. Default: any |
|
|
Playing method to play digits. One of 'pronounced', 'iterated', 'None'. |
|
|
If true - classic ivr navigation from the keyboard will be enabled after recognition (if none of the matches were received earlier). |
|
|
Caller id. |
|
|
Variable value for variable-based condition. |
|
|
Variable name for play_digits_variable. |
|
|
Call interactive method. One of 'GET', 'POST', 'None'. Default: GET |
|
|
Timeout in milliseconds before stop listen voice and start recognize. |
|
|
Maximum digits amount for record_digits. |
|
|
If true - transfer to dst from variable will be simple, default false. Default: False |
|
|
Maximum digits to terminate listen voice and start recognize. |
|
|
Variable name for variable-based condition. |
|
|
Caller id matching method. One of 'matches', 'not_matches', 'anonymous', 'any'. Default: any |
|
|
Context option to jump. |
|
|
Silence duration in milliseconds. |
|
|
Variable name for set_variable. |
|
|
Caller_id_number. |
|
|
One of 'normal', 'busy'. Default: normal |
|
|
If rule is final, next rules will be not executed if call failed. Default: True |
|
|
Sound to play. |
|
|
Sound type. One of 'background', 'foreground', 'None'. |
|
|
|
|
|
Call interactive url. |
|
|
Insert new rule in position. |
|
|
Caller_id_name. |
|
|
List of elements for voice helper rule. |
|
|
Ring to transfer destination this count of seconds. |
|
|
Digits to play. |
|
|
Rule name. |
|
|
Variable name for record_digits. |
|
|
Check if sound in variable- if so - file from variable will be played instead other sound. |
|
|
Rule time interval. |
|
|
Record digits timeout in milliseconds. |
|
|
Transfer destination. |
|
|
Context to jump. |
|
|
Required. Rule action. One of 'transfer', 'hangup', 'play_sound', 'play_silence', 'jump_to_context', 'play_digits', 'call_interactive', 'transfer_from_variable', 'set_variable', 'voicemail', 'simple_transfer', 'set_caller_id_name', 'set_caller_id_number', 'record_digits', 'play_digits_from_variable', 'quality_rate', 'voice_helper', 'start_record'. |
|
|
Variable value for set_variable. |
|
|
Call interactive timout. |
|
|
Id of sound to play record_digits. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
Default: any |
|
|
|
|
|
Default: True |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: normal |
|
|
Default: True |
|
|
|
|
|
|
|
|
Default: 5 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/
Get context rules list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
Default: any |
|
|
|
|
|
Default: True |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: normal |
|
|
Default: True |
|
|
|
|
|
|
|
|
Default: 5 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
PUT /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/order/
Udpate context option rules order
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. All rules ids in needed order. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: [] |
GET /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/order/
Get context option rules order
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: [] |
PUT /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/{rule_id
}
Update context rule
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
|
|
Required. |
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Variable name for transfer_from_variable. |
|
|
Call status. One of 'no_answer', 'busy', 'any'. |
|
|
Playing method to play digits. One of 'pronounced', 'iterated', 'None'. |
|
|
If true - classic ivr navigation from the keyboard will be enabled after recognition (if none of the matches were received earlier). |
|
|
Caller id. |
|
|
Variable value for variable-based condition. |
|
|
Variable name for play_digits_variable. |
|
|
Call interactive method. One of 'GET', 'POST', 'None'. |
|
|
Timeout in milliseconds before stop listen voice and start recognize. |
|
|
Maximum digits amount for record_digits. |
|
|
If true - transfer to dst from variable will be simple, default false. Default: False |
|
|
Maximum digits to terminate listen voice and start recognize. |
|
|
Variable name for variable-based condition. |
|
|
Caller id matching method. One of 'matches', 'not_matches', 'anonymous', 'any'. |
|
|
Context option to jump. |
|
|
Silence duration in milliseconds. |
|
|
Variable name for set_variable. |
|
|
Caller_id_number. |
|
|
One of 'normal', 'busy'. |
|
|
If rule is final, next rules will be not executed if call failed. |
|
|
Sound to play. |
|
|
Sound type. One of 'background', 'foreground', 'None'. |
|
|
|
|
|
Call interactive url. |
|
|
Caller_id_name. |
|
|
List of elements for voice helper rule. |
|
|
Ring to transfer destination this count of seconds. |
|
|
Digits to play. |
|
|
Rule name. |
|
|
Variable name for record_digits. |
|
|
Check if sound in variable- if so - file from variable will be played instead other sound. |
|
|
Rule time interval. |
|
|
Record digits timeout in milliseconds. |
|
|
Transfer destination. |
|
|
Context to jump. |
|
|
Rule action. One of 'transfer', 'hangup', 'play_sound', 'play_silence', 'jump_to_context', 'play_digits', 'call_interactive', 'transfer_from_variable', 'set_variable', 'voicemail', 'simple_transfer', 'set_caller_id_name', 'set_caller_id_number', 'record_digits', 'play_digits_from_variable', 'quality_rate', 'voice_helper', 'start_record'. |
|
|
Variable value for set_variable. |
|
|
Call interactive timout. |
|
|
Id of sound to play record_digits. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
Default: any |
|
|
|
|
|
Default: True |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: normal |
|
|
Default: True |
|
|
|
|
|
|
|
|
Default: 5 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/{rule_id
}
Get context rule
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
|
|
Required. |
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
Default: any |
|
|
|
|
|
Default: True |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: normal |
|
|
Default: True |
|
|
|
|
|
|
|
|
Default: 5 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
DELETE /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/{rule_id
}
Delete context rule
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
|
|
Required. |
|
|
Required. |
GET /extension/{extension_id}/ivr/scheme/
Get full ivr scheme
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
Default: default |
|
|
|
|
|
Default: True |
|
|
|
|
|
POST /extension/{extension_id}/mail_notification/
Add extension notification
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. Email for notification. |
|
|
Required. Notification type. One of 'call_failed_mail'. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
Resource id. |
GET /extension/{extension_id}/mail_notification/
Get extension notification list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
Resource id. |
PUT /extension/{extension_id}/mail_notification/{id
}
Update extension notification
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. Resource id. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Email for notification. |
|
|
Notification type. One of 'call_failed_mail'. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
Resource id. |
GET /extension/{extension_id}/mail_notification/{id
}
Get extension notification
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. Resource id. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
Resource id. |
DELETE /extension/{extension_id}/mail_notification/{id
}
Delete extension notification
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. Resource id. |
PUT /extension/{extension_id}/phone/
Change phone configuration
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
One of 'digest', 'network', 'both'. Default: digest |
|
|
Voicemail enabled. |
|
|
Music on hold sound id. |
|
|
Preserve original caller id number on attended transfer. |
|
|
|
|
|
|
|
|
|
|
|
Append to cid name on transfer. |
|
|
One of 'yes', 'no', 'None'. |
|
|
Timeout in seconds before hangup if extension does not answer. |
|
|
|
|
|
Email address for voicemail notifications. |
|
|
|
|
|
Voicemail greeting sound id. |
|
|
Call record enabled. |
|
|
Attach voicemail message to notification email. |
|
|
|
|
|
|
|
|
|
|
|
Transfer caller id number. |
|
|
Ignore early media. |
|
|
Voicemail configuration. One of 'default', 'record_silence'. |
|
|
Static registration address:port. |
|
|
|
|
|
|
|
|
Call screening enabled. |
|
|
Ringback sound id. |
|
|
One of 'mp3', 'wav', 'None'. |
|
|
|
|
|
|
|
|
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
Default: False |
|
|
|
|
|
Default: False |
|
|
|
|
|
Default: True |
|
|
|
|
|
|
|
|
|
|
|
Default: 60 |
|
|
|
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
Default: False |
|
|
Default: True |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
Default: default |
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
GET /extension/{extension_id}/phone/
Get phone configuration
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
Default: False |
|
|
|
|
|
Default: False |
|
|
|
|
|
Default: True |
|
|
|
|
|
|
|
|
|
|
|
Default: 60 |
|
|
|
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
Default: False |
|
|
Default: True |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
Default: default |
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
PUT /extension/{extension_id}/queue/
Update queue by extension id
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Announce sound id. |
|
|
Sound id. plays before transfer to destination if no no agents available. |
|
|
Start sound id. |
|
|
Key for exit from queue. |
|
|
|
|
|
Agent announce sound id. |
|
|
Queue member position announce frequency. |
|
|
One of 'None', 'transfer', 'quality_rate'. |
|
|
Do not try to call busy agents. |
|
|
Email address for voicemail notifications. |
|
|
Transfer destination on no agent timeout. |
|
|
Report how long caller was in a queue. |
|
|
Voicemail enabled. |
|
|
|
|
|
Queue call strategy. One of 'ring-all', 'longest-idle-agent', 'round-robin', 'top-down', 'agent-with-least-talk-time', 'agent-with-fewest-calls', 'sequentially-by-agent-order', 'random'. Default: round-robin |
|
|
Try to connect caller to the same agent if connected in last try_same_agent_time seconds. |
|
|
Queue calls recording enabled. |
|
|
Attach voicemail message to notification email. |
|
|
If false, then once tier_rule_wait_second is passed, the caller is offered to all tiers in order (level/position). if true, the tier_rule_wait_second will be multiplied by the tier level. |
|
|
Sound type. One of 'ring', 'music'. Default: ring |
|
|
Sound id. plays before transfer to destination if timeout. |
|
|
Defines if we should apply tier rules. |
|
|
Disable answer in queue. |
|
|
Voicemail configuration. One of 'default', 'record_silence'. |
|
|
Voicemail greeting sound id. |
|
|
|
|
|
Announce_sound will play at intervals defined in this parameter (in seconds). |
|
|
Transfer destination on exit. |
|
|
The time in seconds that a caller is required to wait before advancing to the next tier. |
|
|
Queue main sound id. |
|
|
Do not put call into the queue if there is no agents available. |
|
|
Sound id. plays before transfer to destination on caller exit. |
|
|
|
|
|
Transfer destination on timeout. |
|
|
Define the delay before we quit queue if the member haven't been answered by an agent. |
|
|
Transfer on agent hangup destination. |
|
|
Maximum time in seconds with no agents in queue before exit. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
Default: False |
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
Default: True |
|
|
Default: False |
|
|
Default: music |
|
|
|
|
|
Default: False |
|
|
Default: False |
|
|
Default: default |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: 0 |
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /extension/{extension_id}/queue/
Get queue by extension id
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
Default: False |
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
Default: False |
|
|
Default: True |
|
|
Default: False |
|
|
Default: music |
|
|
|
|
|
Default: False |
|
|
Default: False |
|
|
Default: default |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Default: 0 |
|
|
|
|
|
Default: False |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
POST /extension/{extension_id}/queue/agents/local/
Add agent to queue
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Agent position. Default: 0 |
|
|
Required. Agent id. |
|
|
Agent level. Default: 0 |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: 1 |
|
|
Agent extension id. |
|
|
Default: 1 |
GET /extension/{extension_id}/queue/agents/local/
Get queue agents
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: 1 |
|
|
Agent extension id. |
|
|
Default: 1 |
PUT /extension/{extension_id}/queue/agents/local/{agent_id
}
Update agent in queue details
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Agent position. |
|
|
Agent level. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: 1 |
|
|
Agent extension id. |
|
|
Default: 1 |
GET /extension/{extension_id}/queue/agents/local/{agent_id
}
Get agent in queue details
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: 1 |
|
|
Agent extension id. |
|
|
Default: 1 |
DELETE /extension/{extension_id}/queue/agents/local/{agent_id
}
Delete agent from queue
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
POST /extension/{extension_id}/queue/agents/remote/
Add queue to agent
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Agent position. Default: 0 |
|
|
Required. Agent id. |
|
|
Agent level. Default: 0 |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: 1 |
|
|
Agent id. |
|
|
Default: 1 |
GET /extension/{extension_id}/queue/agents/remote/
Get queue agents
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: 1 |
|
|
Agent id. |
|
|
Default: 1 |
PUT /extension/{extension_id}/queue/agents/remote/{agent_id
}
Update agent in queue details
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Agent position. |
|
|
Agent level. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: 1 |
|
|
Agent id. |
|
|
Default: 1 |
GET /extension/{extension_id}/queue/agents/remote/{agent_id
}
Get agent in queue details
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: 1 |
|
|
Agent id. |
|
|
Default: 1 |
DELETE /extension/{extension_id}/queue/agents/remote/{agent_id
}
Delete agent from queue
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
GET /extension/{extension_id}/queue/status/
Get queue status
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: 0 |
|
|
Default: 0 |
|
|
Default: 0 |
GET /extension/{extension_id}/queue/status/agents/
Get queue agents status
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /extension/{extension_id}/queue/status/members/
Get queue members status
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /extension/{extension_id}/record/
Get record list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Default: 1 |
|
|
|
|
|
Required. Start datetime. |
|
|
Required. End datetime. |
|
|
Datetime sorting order. One of 'desc', 'asc'. Default: desc |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /extension/{extension_id}/record/stats/
Get record statistics list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. Start datetime. |
|
|
Required. End datetime. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
GET /extension/{extension_id}/record/{record_uuid
}
Get record
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
GET /extension/{extension_id}/record/{record_uuid}/download/
Get record with basic http authentication
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
GET /extension/{extension_id}/record/{record_uuid}/storage_url/
Get record storage url
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
GET /extension/{extension_id}/registration/
Get extension registration status
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Default: False |
|
|
|
|
|
Default: [] |
DELETE /extension/{extension_id}/registration/
Delete all extension registrations
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
DELETE /extension/{extension_id}/registration/{registration_id
}
Delete registration
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
GET /extension/{extension_id}/sound/
Get sound list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Default: 1 |
|
|
|
|
|
|
|
|
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
Resource id. |
|
|
|
|
|
GET /extension/{extension_id}/sound/{sound_id}/download/
Get sound file
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
PUT /extension/{extension_id}/speech_to_text/{call_api_id
}
Update call with speech to text
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. One of 'start', 'stop'. |
|
|
Url to get events with recognized text. |
|
|
Required. One of 'in', 'out'. |
POST /extension/{extension_id}/user/extension/
Add new user extension
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
User email. |
|
|
User status. One of 'active', 'blocked'. |
|
|
Required. User name. |
|
|
Send email with access data for new user. Default: False |
|
|
User access type. One of 'full', 'read_only'. |
|
|
User extra params. |
|
|
User timezone. |
|
|
Required. User login. |
|
|
Required. User password. |
|
|
User email. |
|
|
Required. User email. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
GET /extension/{extension_id}/user/extension/
Get user extension list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
PUT /extension/{extension_id}/user/extension/{user_id
}
Update user extension
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
User email. |
|
|
User status. One of 'active', 'blocked'. |
|
|
User name. |
|
|
User access type. One of 'full', 'read_only'. |
|
|
User extra params. |
|
|
User timezone. |
|
|
User password. |
|
|
User email. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
GET /extension/{extension_id}/user/extension/{user_id
}
Get user extension
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource id. |
DELETE /extension/{extension_id}/user/extension/{user_id
}
Delete user extension
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
PUT /extension/{extension_id}/valet_park/{call_api_id
}
Update call with valet_parking
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
JSON parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. One of 'park', 'bridge', 'slots'. |
|
|
GET /extension/{extension_id}/voicemail/{record_uuid
}
Get voicemail message file
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
GET /extension/{extension_id}/voicemail/{record_uuid}/storage_url/
Get voicemail storage url
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |