Zvanu Parvaldnieks (Preview)
Zvanu Parvaldnieks is a mobile virtual PBX service for LMT mobile subscribers. This connector lets users to easily send all the data and events about calls, voicemails, contacts and configuration to other services.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Latvijas Mobilais Telefons |
| URL | https://zvanuparvaldnieks.lmt.lv |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Latvijas Mobilais Telefons |
| Website | https://zvanuparvaldnieks.lmt.lv |
| Privacy policy | https://www.lmt.lv/en/data-processing |
| Categories | Communication;IT Operations |
Zvanu Parvaldnieks is a mobile virtual PBX service for LMT mobile subscribers. This connector lets users to easily send all the data and events about calls, voicemails, contacts and configuration to other services.
Prerequisites
You will need the following to proceed:
- A phone number with LMT Zvanu parvaldnieks subscription
- An API key, that can be generated at https://zvanuparvaldnieks.lmt.lv/integration
How to get credentials
Use your API key generated at https://zvanuparvaldnieks.lmt.lv/integration as a Bearer token:
Bearer OnYSrLTH3i2qiyb873au2LNdAajXjf5I
Get started with your connector
- Create a new api key
- Add IP ACL as
0.0.0.0/0as the IP can change - Add all the neccessary api methods that you're going to be using with Microsoft Power automate
Known issues and limitations
- There can be no more than 20 webhooks created at the same time, so if you run into any issues with triggers, please check how many webhooks are under API -> WEB HOOKS in Zvanu parvaldnieks panel
- Items are not gathered with
Get <anything>triggers - please note, that only newly created items are gathered with triggers. - Any authentication issues - please make sure to configure API key in following format:
Bearer <api_key>
Common errors and remedies
403 Webhook limit reached
There can be no more than 20 webhooks created at the same time, so if you run into any issues with triggers, please check how many webhooks are under API -> WEB HOOKS in Zvanu parvaldnieks panel
404 No items found
There are no items found based on the request. Please make sure that items exist and check the filter fields if they're filled correctly.
422 Unprocessable Entity
Please check if the filter values are filled out correctly.
FAQ
What are the benefits of using this connector?
Unlike a normal scenario, where you would develop yourself a solution that gathers data from an API, this connector already provides the middle step between source (being Zvanu parvaldnieks API) and destination, where the data is sent. For example, by configuring a flow with CallConnected trigger, we can send information about all answered calls directly to OneDrive Excel sheet.
What are the requirements to start using this connector?
You need to be LMT carrier subscriber as well as subscriber of the Zvanu parvaldnieks service.
What is the difference between webhook callbacks and regular Get operations?
Get operations maintain a list of particular type of items, for example calls with Get call History and every time gathers only newly created call history items. Webhook callbacks, however, get triggered automatically from Zvanu parvaldnieks service's side when a new event is received. For example, when a new voicemail message is left, Zvanu parvaldnieks sends an event to connector with data about the new voicemail message.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Dial |
Request the start of new call by sending a request to a device. |
| Get Audio Prompt By ID |
Retrieve a single audio prompt object by providing an ID. |
| Get Call History Item By ID |
Retrieve a single call history entry by providing an ID. |
| Get Call Recording by ID |
Retrieve a single call recording by providing an ID. |
| Get Contacts by ID |
Retrieve a single employee object by providing an ID. |
| Get Group By ID |
Retrieve a single employee group object by providing an ID. |
| Get lost calls |
Retrieve all lost call records from call history that have not been answered, have been called back or the caller has not reached the employee in repeated attempts within the same day. |
| Get Voicemail Box By ID |
Retrieve a single voicemail box object by providing an ID. |
| Get Voicemail By ID |
Retrieve a single voicemail object by providing an ID. |
| Get VoIP Endpoint By ID |
Retrieve a single VoIP endpoint object by providing an ID. |
Dial
Request the start of new call by sending a request to a device.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Destination
|
destination | True | string |
Destination number. |
|
contact ID
|
contactID | True | integer |
Unique ID of the employee |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
Get Audio Prompt By ID
Retrieve a single audio prompt object by providing an ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Audio prompt ID
|
prompt_id | True | integer |
Unique ID of the audio prompt. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
|
id
|
data.id | integer |
id |
|
name
|
data.name | string |
name |
|
type
|
data.type | integer |
type |
Get Call History Item By ID
Retrieve a single call history entry by providing an ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Call ID
|
call_id | True | integer |
Unique ID of the call. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
|
callID
|
data.callID | integer |
callID |
|
caller
|
data.caller | string |
caller |
|
destination
|
data.destination | string |
destination |
|
direction
|
data.direction | string |
direction |
|
status
|
data.status | integer |
status |
|
callStarted
|
data.callStarted | string |
callStarted |
|
callConnected
|
data.callConnected | string |
callConnected |
|
callEnded
|
data.callEnded | string |
callEnded |
|
connectionTime
|
data.connectionTime | integer |
connectionTime |
|
contactID
|
data.contactID | integer |
contactID |
|
recordingID
|
data.recordingID | integer |
recordingID |
Get Call Recording by ID
Retrieve a single call recording by providing an ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Record ID
|
record_id | True | integer |
Unique ID of the recording. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
|
recordingID
|
data.recordingID | integer |
recordingID |
|
callID
|
data.callID | integer |
callID |
|
caller
|
data.caller | string |
caller |
|
destination
|
data.destination | string |
destination |
|
direction
|
data.direction | string |
direction |
|
status
|
data.status | integer |
status |
|
callStarted
|
data.callStarted | string |
callStarted |
|
callConnected
|
data.callConnected | string |
callConnected |
|
callEnded
|
data.callEnded | string |
callEnded |
|
contactID
|
data.contactID | integer |
contactID |
|
recordingURL
|
data.recordingURL | string |
recordingURL |
Get Contacts by ID
Retrieve a single employee object by providing an ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contact ID
|
contact_id | True | integer |
Unique ID of the employee. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
|
current_callerid
|
data.current_callerid | string |
current_callerid |
|
archived
|
data.archived | integer |
archived |
|
firstname
|
data.firstname | string |
firstname |
|
lastname
|
data.lastname | string |
lastname |
|
created
|
data.created | string |
created |
|
number
|
data.number | string |
number |
|
contactID
|
data.contactID | integer |
contactID |
|
group_membership
|
data.group_membership | array of object |
group_membership |
|
created
|
data.group_membership.created | string |
created |
|
groupID
|
data.group_membership.groupID | integer |
groupID |
|
type
|
data.group_membership.type | integer |
type |
|
name
|
data.group_membership.name | string |
name |
|
members
|
data.group_membership.members | array of object |
members |
|
contactID
|
data.group_membership.members.contactID | integer |
contactID |
|
avatar
|
data.avatar | string |
avatar |
Get Group By ID
Retrieve a single employee group object by providing an ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Group ID
|
group_id | True | integer |
Unique ID of the employee group. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
|
Created
|
data.created | date-time |
created |
|
groupID
|
data.groupID | integer |
groupID |
|
type
|
data.type | integer |
type |
|
name
|
data.name | string |
name |
|
members
|
data.members | array of object |
members |
|
contactID
|
data.members.contactID | integer |
contactID |
Get lost calls
Retrieve all lost call records from call history that have not been answered, have been called back or the caller has not reached the employee in repeated attempts within the same day.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Limit how many results to retrieve. |
|
|
Offset
|
offset | integer |
Used to specify from which result we want the data to retrieve. |
|
|
Destination
|
destination | string |
The number which call was placed to. |
|
|
Date from
|
date_from | date-time |
Starting date in the filtered date range. |
|
|
Date to
|
date_to | date-time |
End date in the filtered date range. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
|
data
|
data | array of object |
data |
|
contact_name
|
data.contact_name | string |
contact_name |
|
destination
|
data.destination | string |
destination |
|
attempts
|
data.attempts | integer |
attempts |
|
callerid
|
data.callerid | string |
callerid |
|
Last contact
|
data.last_contact | date-time |
last_contact |
Get Voicemail Box By ID
Retrieve a single voicemail box object by providing an ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Voicemail box ID
|
box_id | True | integer |
Unique ID of the voicemail box. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
|
clientID
|
data.clientID | integer |
clientID |
|
boxName
|
data.boxName | string |
boxName |
|
created
|
data.created | string |
created |
|
voicemailBoxID
|
data.voicemailBoxID | integer |
voicemailBoxID |
Get Voicemail By ID
Retrieve a single voicemail object by providing an ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Voicemail ID
|
voicemail_id | True | integer |
Unique ID of the voicemail. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
|
sender
|
data.sender | string |
sender |
|
voicemailID
|
data.voicemailID | integer |
voicemailID |
|
length
|
data.length | integer |
length |
|
callStarted
|
data.callStarted | string |
callStarted |
|
voicemailBoxID
|
data.voicemailBoxID | integer |
voicemailBoxID |
|
voicemailBoxName
|
data.voicemailBoxName | string |
voicemailBoxName |
|
messageURL
|
data.messageURL | string |
messageURL |
Get VoIP Endpoint By ID
Retrieve a single VoIP endpoint object by providing an ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
VoIP endpoint ID
|
endpoint_id | True | integer |
Unique ID of the VoIP endpoint. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
|
id
|
data.id | integer |
id |
|
name
|
data.name | string |
name |
|
employee_id
|
data.employee_id | integer |
employee_id |
Triggers
|
Call |
Provides event with data payload about the call when event CallCompletedEvent is received during a moment when the call has ended. |
|
Call |
Provides event with data payload about the call when event CallConnectedEvent is received during a moment when the call is answered. |
|
Call |
Provides event with data payload about the call when CallRecorded event is received during a moment when call recording gets created. |
|
Call |
Provides event with data payload about the call when event CallStarted event is received during the start of the call. |
|
Call |
Provides event with data payload about the call when CallTransfered event is received during a moment when the call gets transferred to a third party either by a blind transfer of attended transfer. |
| Get Audio Prompts |
Retrieve audio prompt entries. |
| Get call History |
Retrieve Call history entries. Additionally API consumer may filter the returned records based on a specific number or employee involved in the call (source, destination, or contact_id), as well as direction to filter out only incoming or outgoing calls or only calls made within a specified date range (date_range). |
| Get Call Recordings |
Retrieve Call recordings. Additionally API consumer may filter the returned records based on a specific number or employee involved in the call (source, destination, or contact_id), as well as direction to filter out only incoming or outgoing calls or only calls made within a specified date range (date_range). |
| Get Contacts |
Triggers when a new employee is created |
| Get Groups |
Retrieve Employee groups data. Additionally API consumer may filter the returned records based on contact_id, to limit the result to only those groups, which have a particular Employee as a member. |
| Get Voicemail Boxes |
Retrieve a list of created voicemail boxes. |
| Get voicemails |
Retrieve Voicemail messages. Additionally API consumer may filter the returned records based on contact_id, source, box_id, or date_range to limit the result to only those messages that are left for a specific employee, voicemail box, from a specific number, or within a requested date range. |
| Get VoIP Endpoints |
Retrieve VoIP endpoint entries. |
|
Lost |
Provides event with data payload data about the call when LostCallerCreated event is received during a moment when the call does not get answered and gets registered as lost. |
|
Lost |
Provides event with data payload about the call when LostCallerDeleted event event is received during a moment when lost call gets called back from employee or gets answered later in repeated call from the same caller. |
|
Lost |
Provides event with data payload data about the call when LostCallerUpdated event is received during a moment when another unsuccessful call attempt is received from the same number, so lost call record attempts and last_contact fields get updated with a new number and timestamp. |
|
Voicemail |
Provides event with data payload about the voicemail when VoicemailCreated event is received during a moment when a caller has left a voicemail. |
|
Voicemail |
Provides event with data payload about the voicemail when VoicemailDeleted event is received during a moment when a user has deleted a voicemail message. |
CallCompleted webhook callback
Provides event with data payload about the call when event CallCompletedEvent is received during a moment when the call has ended.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
callID
|
data.callID | integer |
callID |
|
caller
|
data.caller | string |
caller |
|
destination
|
data.destination | string |
destination |
|
direction
|
data.direction | string |
direction |
|
status
|
data.status | integer |
status |
|
callStarted
|
data.callStarted | string |
callStarted |
|
callConnected
|
data.callConnected | string |
callConnected |
|
connectionTime
|
data.connectionTime | integer |
connectionTime |
|
contactID
|
data.contactID | integer |
contactID |
|
previous_contactID
|
data.previous_contactID | integer |
previous_contactID |
CallConnected webhook callback
Provides event with data payload about the call when event CallConnectedEvent is received during a moment when the call is answered.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
callID
|
data.callID | integer |
callID |
|
caller
|
data.caller | string |
caller |
|
destination
|
data.destination | string |
destination |
|
direction
|
data.direction | string |
direction |
|
status
|
data.status | integer |
status |
|
callStarted
|
data.callStarted | string |
callStarted |
|
callConnected
|
data.callConnected | string |
callConnected |
|
contactID
|
data.contactID | integer |
contactID |
CallRecorded webhook callback
Provides event with data payload about the call when CallRecorded event is received during a moment when call recording gets created.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
recordingID
|
data.recordingID | integer |
recordingID |
|
callID
|
data.callID | integer |
callID |
|
callStarted
|
data.callStarted | string |
callStarted |
|
recordingURL
|
data.recordingURL | string |
recordingURL |
|
direction
|
data.direction | string |
direction |
|
connectionTime
|
data.connectionTime | integer |
connectionTime |
CallStarted webhook callback
Provides event with data payload about the call when event CallStarted event is received during the start of the call.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
callID
|
data.callID | integer |
callID |
|
caller
|
data.caller | string |
caller |
|
destination
|
data.destination | string |
destination |
|
direction
|
data.direction | string |
direction |
|
status
|
data.status | integer |
status |
|
callStarted
|
data.callStarted | string |
callStarted |
|
contactID
|
data.contactID | integer |
contactID |
CallTransfered webhook callback
Provides event with data payload about the call when CallTransfered event is received during a moment when the call gets transferred to a third party either by a blind transfer of attended transfer.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
callID
|
data.callID | integer |
callID |
|
caller
|
data.caller | string |
caller |
|
destination
|
data.destination | string |
destination |
|
status
|
data.status | integer |
status |
|
callStarted
|
data.callStarted | string |
callStarted |
|
callConnected
|
data.callConnected | string |
callConnected |
|
connectionTime
|
data.connectionTime | integer |
connectionTime |
|
contactID
|
data.contactID | integer |
contactID |
|
previous_contactID
|
data.previous_contactID | integer |
previous_contactID |
|
direction
|
data.direction | string |
direction |
Get Audio Prompts
Retrieve audio prompt entries.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Audio prompt ID
|
prompt_id | integer |
Unique ID of the audio prompt. |
|
|
Limit
|
limit | integer |
Limit how many results to retrieve. |
|
|
Offset
|
offset | integer |
Used to specify from which result we want the data to retrieve. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
|
data
|
data | array of object |
data |
|
id
|
data.id | integer |
id |
|
name
|
data.name | string |
name |
|
type
|
data.type | integer |
type |
Get call History
Retrieve Call history entries. Additionally API consumer may filter the returned records based on a specific number or employee involved in the call (source, destination, or contact_id), as well as direction to filter out only incoming or outgoing calls or only calls made within a specified date range (date_range).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Call ID
|
call_id | integer |
Unique ID of the call. |
|
|
Limit
|
limit | integer |
Limit how many results to retrieve. |
|
|
Offset
|
offset | integer |
Used to specify from which result we want the data to retrieve. |
|
|
Destination number
|
destination | string |
The number which call was placed to. |
|
|
Source number
|
source | string |
The number of calling party. |
|
|
Direction
|
direction | string |
"in" or "out" to indicate if the call was incoming or outgoing. |
|
|
Contact ID
|
contact_id | integer |
Unique ID of the Employee involved in the call. |
|
|
Date from
|
date_from | date-time |
Starting date in the filtered date range. |
|
|
Date to
|
date_to | date-time |
End date in the filtered date range. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
|
data
|
data | array of object |
data |
|
callID
|
data.callID | integer |
callID |
|
caller
|
data.caller | string |
caller |
|
destination
|
data.destination | string |
destination |
|
direction
|
data.direction | string |
direction |
|
status
|
data.status | integer |
status |
|
callStarted
|
data.callStarted | string |
callStarted |
|
callConnected
|
data.callConnected | string |
callConnected |
|
callEnded
|
data.callEnded | string |
callEnded |
|
connectionTime
|
data.connectionTime | integer |
connectionTime |
|
contactID
|
data.contactID | integer |
contactID |
|
recordingID
|
data.recordingID | integer |
recordingID |
Get Call Recordings
Retrieve Call recordings. Additionally API consumer may filter the returned records based on a specific number or employee involved in the call (source, destination, or contact_id), as well as direction to filter out only incoming or outgoing calls or only calls made within a specified date range (date_range).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Record ID
|
record_id | integer |
Unique ID of the recording. |
|
|
Limit
|
limit | integer |
Limit how many results to retrieve. |
|
|
Offset
|
offset | integer |
Used to specify from which result we want the data to retrieve. |
|
|
Destination number
|
destination | string |
The number which call was placed to. |
|
|
Source number
|
source | string |
The number of calling party. |
|
|
Direction
|
direction | string |
"in" or "out" to indicate if the call was incoming or outgoing. |
|
|
Contact ID
|
contact_id | integer |
Unique ID of the Employee involved in the call. |
|
|
Date from
|
date_from | date-time |
Starting date in the filtered date range. |
|
|
Date to
|
date_to | date-time |
End date in the filtered date range. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
|
data
|
data | array of object |
data |
|
recordingID
|
data.recordingID | integer |
recordingID |
|
callID
|
data.callID | integer |
callID |
|
caller
|
data.caller | string |
caller |
|
destination
|
data.destination | string |
destination |
|
direction
|
data.direction | string |
direction |
|
status
|
data.status | integer |
status |
|
callStarted
|
data.callStarted | string |
callStarted |
|
callConnected
|
data.callConnected | string |
callConnected |
|
callEnded
|
data.callEnded | string |
callEnded |
|
contactID
|
data.contactID | integer |
contactID |
|
recordingURL
|
data.recordingURL | string |
recordingURL |
Get Contacts
Triggers when a new employee is created
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Limit how many results to retrieve. |
|
|
Offset
|
offset | integer |
Used to specify from which result we want the data to retrieve. |
|
|
Contact ID
|
contact_id | integer |
Unique ID of the Employee. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
|
data
|
data | array of object |
data |
|
current_callerid
|
data.current_callerid | string |
current_callerid |
|
archived
|
data.archived | integer |
archived |
|
firstname
|
data.firstname | string |
firstname |
|
lastname
|
data.lastname | string |
lastname |
|
created
|
data.created | string |
created |
|
number
|
data.number | string |
number |
|
contactID
|
data.contactID | integer |
contactID |
|
group_membership
|
data.group_membership | array of object |
group_membership |
|
created
|
data.group_membership.created | string |
created |
|
groupID
|
data.group_membership.groupID | integer |
groupID |
|
type
|
data.group_membership.type | integer |
type |
|
name
|
data.group_membership.name | string |
name |
|
members
|
data.group_membership.members | array of object |
members |
|
contactID
|
data.group_membership.members.contactID | integer |
contactID |
|
avatar
|
data.avatar | string |
avatar |
Get Groups
Retrieve Employee groups data. Additionally API consumer may filter the returned records based on contact_id, to limit the result to only those groups, which have a particular Employee as a member.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Group ID
|
group_id | integer |
Unique ID of the group. |
|
|
Contact ID
|
contact_id | integer |
Unique ID of the Employee. |
|
|
Limit
|
limit | integer |
Limit how many results to retrieve. |
|
|
Offset
|
offset | integer |
Used to specify from which result we want the data to retrieve. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
|
data
|
data | array of object |
data |
|
created
|
data.created | string |
created |
|
groupID
|
data.groupID | integer |
groupID |
|
type
|
data.type | integer |
type |
|
name
|
data.name | string |
name |
|
members
|
data.members | array of object |
members |
|
contactID
|
data.members.contactID | integer |
contactID |
Get Voicemail Boxes
Retrieve a list of created voicemail boxes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Voicemail box ID
|
box_id | integer |
Unique ID of the voicemail box. |
|
|
Limit
|
limit | integer |
Limit how many results to retrieve. |
|
|
Offset
|
offset | integer |
Used to specify from which result we want the data to retrieve. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
|
data
|
data | array of object |
data |
|
clientID
|
data.clientID | integer |
clientID |
|
boxName
|
data.boxName | string |
boxName |
|
created
|
data.created | string |
created |
|
voicemailBoxID
|
data.voicemailBoxID | integer |
voicemailBoxID |
Get voicemails
Retrieve Voicemail messages. Additionally API consumer may filter the returned records based on contact_id, source, box_id, or date_range to limit the result to only those messages that are left for a specific employee, voicemail box, from a specific number, or within a requested date range.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Voicemail ID
|
voicemail_id | integer |
Unique ID of the voicemail message. |
|
|
Limit
|
limit | integer |
Limit how many results to retrieve. |
|
|
Offset
|
offset | integer |
Used to specify from which result we want the data to retrieve. |
|
|
Source number
|
source | string |
The number of calling party. |
|
|
Contact ID
|
contact_id | integer |
Unique ID of the Employee. |
|
|
Voicemail box ID
|
box_id | integer |
Unique ID of the voicemail box. |
|
|
Date from
|
date_from | date-time |
Starting date in the filtered date range. |
|
|
Date to
|
date_to | date-time |
End date in the filtered date range. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
|
data
|
data | array of object |
data |
|
sender
|
data.sender | string |
sender |
|
voicemailID
|
data.voicemailID | integer |
voicemailID |
|
length
|
data.length | integer |
length |
|
callStarted
|
data.callStarted | string |
callStarted |
|
voicemailBoxID
|
data.voicemailBoxID | integer |
voicemailBoxID |
|
voicemailBoxName
|
data.voicemailBoxName | string |
voicemailBoxName |
|
messageURL
|
data.messageURL | string |
messageURL |
Get VoIP Endpoints
Retrieve VoIP endpoint entries.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
VoIP endpoint ID
|
endpoint_id | integer |
Unique ID of the VoIP endpoint. |
|
|
Limit
|
limit | integer |
Limit how many results to retrieve. |
|
|
Offset
|
offset | integer |
Used to specify from which result we want the data to retrieve. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
version
|
version | string |
version |
|
status
|
status | string |
status |
|
statusCode
|
statusCode | integer |
statusCode |
|
message
|
message | string |
message |
|
data
|
data | array of object |
data |
|
id
|
data.id | integer |
id |
|
name
|
data.name | string |
name |
|
employee_id
|
data.employee_id | integer |
employee_id |
LostCallerAdded webhook callback
Provides event with data payload data about the call when LostCallerCreated event is received during a moment when the call does not get answered and gets registered as lost.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
contact_name
|
data.contact_name | string |
contact_name |
|
destination
|
data.destination | string |
destination |
|
attempts
|
data.attempts | integer |
attempts |
|
callerid
|
data.callerid | string |
callerid |
|
last_contact
|
data.last_contact | string |
last_contact |
LostCallerRemoved webhook callback
Provides event with data payload about the call when LostCallerDeleted event event is received during a moment when lost call gets called back from employee or gets answered later in repeated call from the same caller.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
destination
|
data.destination | string |
destination |
|
callerid
|
data.callerid | string |
callerid |
LostCallerUpdated webhook callback
Provides event with data payload data about the call when LostCallerUpdated event is received during a moment when another unsuccessful call attempt is received from the same number, so lost call record attempts and last_contact fields get updated with a new number and timestamp.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
contact_name
|
data.contact_name | string |
contact_name |
|
destination
|
data.destination | string |
destination |
|
attempts
|
data.attempts | integer |
attempts |
|
callerid
|
data.callerid | string |
callerid |
|
last_contact
|
data.last_contact | string |
last_contact |
VoicemailCreated webhook callback
Provides event with data payload about the voicemail when VoicemailCreated event is received during a moment when a caller has left a voicemail.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
sender
|
data.sender | string |
sender |
|
voicemailID
|
data.voicemailID | integer |
voicemailID |
|
length
|
data.length | integer |
length |
|
callStarted
|
data.callStarted | string |
callStarted |
|
voicemailBoxID
|
data.voicemailBoxID | integer |
voicemailBoxID |
|
voicemailBoxName
|
data.voicemailBoxName | string |
voicemailBoxName |
|
messageURL
|
data.messageURL | string |
messageURL |
VoicemailDeleted webhook callback
Provides event with data payload about the voicemail when VoicemailDeleted event is received during a moment when a user has deleted a voicemail message.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
sender
|
data.sender | string |
sender |
|
voicemailID
|
data.voicemailID | integer |
voicemailID |